15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* From ppb_mouse_cursor.idl modified Thu Mar 28 10:11:32 2013. */ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef PPAPI_C_PPB_MOUSE_CURSOR_H_ 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PPAPI_C_PPB_MOUSE_CURSOR_H_ 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_bool.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_instance.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_macros.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_point.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_resource.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/c/pp_stdint.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PPB_MOUSECURSOR_INTERFACE_1_0 "PPB_MouseCursor;1.0" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define PPB_MOUSECURSOR_INTERFACE PPB_MOUSECURSOR_INTERFACE_1_0 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @file 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This file defines the <code>PPB_MouseCursor</code> interface for setting 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the mouse cursor. 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @addtogroup Enums 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @{ 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The <code>PP_MouseCursor_Type</code> enumeration lists the available stock 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * cursor types. 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum PP_MouseCursor_Type { 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_CUSTOM = -1, 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_POINTER = 0, 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_CROSS = 1, 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_HAND = 2, 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_IBEAM = 3, 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_WAIT = 4, 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_HELP = 5, 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_EASTRESIZE = 6, 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NORTHRESIZE = 7, 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NORTHEASTRESIZE = 8, 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NORTHWESTRESIZE = 9, 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_SOUTHRESIZE = 10, 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_SOUTHEASTRESIZE = 11, 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_SOUTHWESTRESIZE = 12, 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_WESTRESIZE = 13, 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NORTHSOUTHRESIZE = 14, 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_EASTWESTRESIZE = 15, 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NORTHEASTSOUTHWESTRESIZE = 16, 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NORTHWESTSOUTHEASTRESIZE = 17, 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_COLUMNRESIZE = 18, 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_ROWRESIZE = 19, 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_MIDDLEPANNING = 20, 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_EASTPANNING = 21, 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NORTHPANNING = 22, 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NORTHEASTPANNING = 23, 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NORTHWESTPANNING = 24, 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_SOUTHPANNING = 25, 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_SOUTHEASTPANNING = 26, 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_SOUTHWESTPANNING = 27, 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_WESTPANNING = 28, 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_MOVE = 29, 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_VERTICALTEXT = 30, 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_CELL = 31, 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_CONTEXTMENU = 32, 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_ALIAS = 33, 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_PROGRESS = 34, 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NODROP = 35, 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_COPY = 36, 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NONE = 37, 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_NOTALLOWED = 38, 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_ZOOMIN = 39, 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_ZOOMOUT = 40, 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_GRAB = 41, 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_MOUSECURSOR_TYPE_GRABBING = 42 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)PP_COMPILE_ASSERT_ENUM_SIZE_IN_BYTES(PP_MouseCursor_Type, 4); 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @} 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @addtogroup Interfaces 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @{ 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The <code>PPB_MouseCursor</code> allows setting the mouse cursor. 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct PPB_MouseCursor_1_0 { 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Sets the given mouse cursor. The mouse cursor will be in effect whenever 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the mouse is over the given instance until it is set again by another 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * call. Note that you can hide the mouse cursor by setting it to the 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * <code>PP_MOUSECURSOR_TYPE_NONE</code> type. 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This function allows setting both system defined mouse cursors and 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * custom cursors. To set a system-defined cursor, pass the type you want 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * and set the custom image to 0 and the hot spot to NULL. To set a custom 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * cursor, set the type to <code>PP_MOUSECURSOR_TYPE_CUSTOM</code> and 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * specify your image and hot spot. 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 107c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[in] instance A <code>PP_Instance</code> identifying the instance 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * that the mouse cursor will affect. 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @param[in] type A <code>PP_MouseCursor_Type</code> identifying the type of 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * mouse cursor to show. 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @param[in] image A <code>PPB_ImageData</code> resource identifying the 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * custom image to set when the type is 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * <code>PP_MOUSECURSOR_TYPE_CUSTOM</code>. The image must be less than 32 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * pixels in each direction and must be of the system's native image format. 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * When you are specifying a predefined cursor, this parameter must be 0. 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 119c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * @param[in] hot_spot When setting a custom cursor, this identifies the 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * pixel position within the given image of the "hot spot" of the cursor. 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * When specifying a stock cursor, this parameter is ignored. 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @return PP_TRUE on success, or PP_FALSE if the instance or cursor type 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * is invalid, or if the image is too large. 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Bool (*SetCursor)(PP_Instance instance, 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum PP_MouseCursor_Type type, 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PP_Resource image, 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct PP_Point* hot_spot); 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef struct PPB_MouseCursor_1_0 PPB_MouseCursor; 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * @} 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif /* PPAPI_C_PPB_MOUSE_CURSOR_H_ */ 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 139