OLD | NEW |
1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 * Use of this source code is governed by a BSD-style license that can be | 2 * Use of this source code is governed by a BSD-style license that can be |
3 * found in the LICENSE file. | 3 * found in the LICENSE file. |
4 */ | 4 */ |
5 | 5 |
6 /** | 6 /** |
7 * This file defines the <code>PPB_MouseCursor</code> interface for setting | 7 * This file defines the <code>PPB_MouseCursor</code> interface for setting |
8 * the mouse cursor. | 8 * the mouse cursor. |
9 */ | 9 */ |
10 | 10 |
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
75 * the mouse is over the given instance until it is set again by another | 75 * the mouse is over the given instance until it is set again by another |
76 * call. Note that you can hide the mouse cursor by setting it to the | 76 * call. Note that you can hide the mouse cursor by setting it to the |
77 * <code>PP_MOUSECURSOR_TYPE_NONE</code> type. | 77 * <code>PP_MOUSECURSOR_TYPE_NONE</code> type. |
78 * | 78 * |
79 * This function allows setting both system defined mouse cursors and | 79 * This function allows setting both system defined mouse cursors and |
80 * custom cursors. To set a system-defined cursor, pass the type you want | 80 * custom cursors. To set a system-defined cursor, pass the type you want |
81 * and set the custom image to 0 and the hot spot to NULL. To set a custom | 81 * and set the custom image to 0 and the hot spot to NULL. To set a custom |
82 * cursor, set the type to <code>PP_MOUSECURSOR_TYPE_CUSTOM</code> and | 82 * cursor, set the type to <code>PP_MOUSECURSOR_TYPE_CUSTOM</code> and |
83 * specify your image and hot spot. | 83 * specify your image and hot spot. |
84 * | 84 * |
85 * @param[in] instance A <code>PP_Instance</code> indentifying the instance | 85 * @param[in] instance A <code>PP_Instance</code> identifying the instance |
86 * that the mouse cursor will affect. | 86 * that the mouse cursor will affect. |
87 * | 87 * |
88 * @param[in] type A <code>PP_MouseCursor_Type</code> identifying the type of | 88 * @param[in] type A <code>PP_MouseCursor_Type</code> identifying the type of |
89 * mouse cursor to show. | 89 * mouse cursor to show. |
90 * | 90 * |
91 * @param[in] image A <code>PPB_ImageData</code> resource identifying the | 91 * @param[in] image A <code>PPB_ImageData</code> resource identifying the |
92 * custom image to set when the type is | 92 * custom image to set when the type is |
93 * <code>PP_MOUSECURSOR_TYPE_CUSTOM</code>. The image must be less than 32 | 93 * <code>PP_MOUSECURSOR_TYPE_CUSTOM</code>. The image must be less than 32 |
94 * pixels in each direction and must be of the system's native image format. | 94 * pixels in each direction and must be of the system's native image format. |
95 * When you are specifying a predefined cursor, this parameter must be 0. | 95 * When you are specifying a predefined cursor, this parameter must be 0. |
96 * | 96 * |
97 * @param[in] hot_spot When setting a custom cursor, this idenfifies the | 97 * @param[in] hot_spot When setting a custom cursor, this identifies the |
98 * pixel position within the given image of the "hot spot" of the cursor. | 98 * pixel position within the given image of the "hot spot" of the cursor. |
99 * When specifying a stock cursor, this parameter is ignored. | 99 * When specifying a stock cursor, this parameter is ignored. |
100 * | 100 * |
101 * @return PP_TRUE on success, or PP_FALSE if the instance or cursor type | 101 * @return PP_TRUE on success, or PP_FALSE if the instance or cursor type |
102 * is invalid, or if the image is too large. | 102 * is invalid, or if the image is too large. |
103 */ | 103 */ |
104 PP_Bool SetCursor([in] PP_Instance instance, | 104 PP_Bool SetCursor([in] PP_Instance instance, |
105 [in] PP_MouseCursor_Type type, | 105 [in] PP_MouseCursor_Type type, |
106 [in] PP_Resource image, | 106 [in] PP_Resource image, |
107 [in] PP_Point hot_spot); | 107 [in] PP_Point hot_spot); |
108 }; | 108 }; |
OLD | NEW |