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 3 * found in the LICENSE file. 4 */ 5 6/** 7 * This file defines the <code>PPB_MouseCursor</code> interface for setting 8 * the mouse cursor. 9 */ 10 11[generate_thunk] 12 13label Chrome { 14 M19 = 1.0 15}; 16 17/** 18 * The <code>PP_MouseCursor_Type</code> enumeration lists the available stock 19 * cursor types. 20 */ 21[assert_size(4), notypedef] 22enum PP_MouseCursor_Type { 23 PP_MOUSECURSOR_TYPE_CUSTOM = -1, 24 PP_MOUSECURSOR_TYPE_POINTER = 0, 25 PP_MOUSECURSOR_TYPE_CROSS = 1, 26 PP_MOUSECURSOR_TYPE_HAND = 2, 27 PP_MOUSECURSOR_TYPE_IBEAM = 3, 28 PP_MOUSECURSOR_TYPE_WAIT = 4, 29 PP_MOUSECURSOR_TYPE_HELP = 5, 30 PP_MOUSECURSOR_TYPE_EASTRESIZE = 6, 31 PP_MOUSECURSOR_TYPE_NORTHRESIZE = 7, 32 PP_MOUSECURSOR_TYPE_NORTHEASTRESIZE = 8, 33 PP_MOUSECURSOR_TYPE_NORTHWESTRESIZE = 9, 34 PP_MOUSECURSOR_TYPE_SOUTHRESIZE = 10, 35 PP_MOUSECURSOR_TYPE_SOUTHEASTRESIZE = 11, 36 PP_MOUSECURSOR_TYPE_SOUTHWESTRESIZE = 12, 37 PP_MOUSECURSOR_TYPE_WESTRESIZE = 13, 38 PP_MOUSECURSOR_TYPE_NORTHSOUTHRESIZE = 14, 39 PP_MOUSECURSOR_TYPE_EASTWESTRESIZE = 15, 40 PP_MOUSECURSOR_TYPE_NORTHEASTSOUTHWESTRESIZE = 16, 41 PP_MOUSECURSOR_TYPE_NORTHWESTSOUTHEASTRESIZE = 17, 42 PP_MOUSECURSOR_TYPE_COLUMNRESIZE = 18, 43 PP_MOUSECURSOR_TYPE_ROWRESIZE = 19, 44 PP_MOUSECURSOR_TYPE_MIDDLEPANNING = 20, 45 PP_MOUSECURSOR_TYPE_EASTPANNING = 21, 46 PP_MOUSECURSOR_TYPE_NORTHPANNING = 22, 47 PP_MOUSECURSOR_TYPE_NORTHEASTPANNING = 23, 48 PP_MOUSECURSOR_TYPE_NORTHWESTPANNING = 24, 49 PP_MOUSECURSOR_TYPE_SOUTHPANNING = 25, 50 PP_MOUSECURSOR_TYPE_SOUTHEASTPANNING = 26, 51 PP_MOUSECURSOR_TYPE_SOUTHWESTPANNING = 27, 52 PP_MOUSECURSOR_TYPE_WESTPANNING = 28, 53 PP_MOUSECURSOR_TYPE_MOVE = 29, 54 PP_MOUSECURSOR_TYPE_VERTICALTEXT = 30, 55 PP_MOUSECURSOR_TYPE_CELL = 31, 56 PP_MOUSECURSOR_TYPE_CONTEXTMENU = 32, 57 PP_MOUSECURSOR_TYPE_ALIAS = 33, 58 PP_MOUSECURSOR_TYPE_PROGRESS = 34, 59 PP_MOUSECURSOR_TYPE_NODROP = 35, 60 PP_MOUSECURSOR_TYPE_COPY = 36, 61 PP_MOUSECURSOR_TYPE_NONE = 37, 62 PP_MOUSECURSOR_TYPE_NOTALLOWED = 38, 63 PP_MOUSECURSOR_TYPE_ZOOMIN = 39, 64 PP_MOUSECURSOR_TYPE_ZOOMOUT = 40, 65 PP_MOUSECURSOR_TYPE_GRAB = 41, 66 PP_MOUSECURSOR_TYPE_GRABBING = 42 67}; 68 69/** 70 * The <code>PPB_MouseCursor</code> allows setting the mouse cursor. 71 */ 72interface PPB_MouseCursor { 73 /** 74 * Sets the given mouse cursor. The mouse cursor will be in effect whenever 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 77 * <code>PP_MOUSECURSOR_TYPE_NONE</code> type. 78 * 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 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 83 * specify your image and hot spot. 84 * 85 * @param[in] instance A <code>PP_Instance</code> identifying the instance 86 * that the mouse cursor will affect. 87 * 88 * @param[in] type A <code>PP_MouseCursor_Type</code> identifying the type of 89 * mouse cursor to show. 90 * 91 * @param[in] image A <code>PPB_ImageData</code> resource identifying the 92 * custom image to set when the type is 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. 95 * When you are specifying a predefined cursor, this parameter must be 0. 96 * 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. 99 * When specifying a stock cursor, this parameter is ignored. 100 * 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. 103 */ 104 PP_Bool SetCursor([in] PP_Instance instance, 105 [in] PP_MouseCursor_Type type, 106 [in] PP_Resource image, 107 [in] PP_Point hot_spot); 108}; 109