Chromium Code Reviews| Index: ppapi/api/dev/ppb_cursor_control_dev.idl |
| diff --git a/ppapi/api/dev/ppb_cursor_control_dev.idl b/ppapi/api/dev/ppb_cursor_control_dev.idl |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..e3f50272cc159feaa51baa8452d9f34cfeb7e338 |
| --- /dev/null |
| +++ b/ppapi/api/dev/ppb_cursor_control_dev.idl |
| @@ -0,0 +1,69 @@ |
| +/* Copyright (c) 2011 The Chromium Authors. All rights reserved. |
| + * Use of this source code is governed by a BSD-style license that can be |
| + * found in the LICENSE file. |
| + */ |
| + |
| +/** |
| + * This file defines the <code>PPB_CursorControl_Dev</code> interface |
| + * implemented by the browser for controlling the cursor. |
| + */ |
| + |
| +label Chrome { |
| + M14 = 0.4 |
| +}; |
| + |
| +interface PPB_CursorControl_Dev { |
| + /** |
| + * Set a cursor. If "type" is PP_CURSORTYPE_CUSTOM, then "custom_image" |
| + * must be an ImageData resource containing the cursor and "hot_spot" must |
| + * contain the offset within that image that refers to the cursor's position. |
| + */ |
| + PP_Bool SetCursor( |
| + [in] PP_Instance instance, |
| + [in] PP_CursorType_Dev type, |
| + [in] PP_Resource custom_image, |
| + [in] PP_Point hot_spot); |
|
dmichael (off chromium)
2011/11/17 19:04:41
nit: Why not use C++-style indentation?
(I saw so
jvoung - send to chromium...
2011/11/17 20:51:34
Oh, I guess I got lucky and picked an example IDL
dmichael (off chromium)
2011/11/17 21:05:49
If we're ~50-50, and there's no good reason to do
jvoung - send to chromium...
2011/11/17 22:00:09
Ok, done =)
|
| + |
| + /** |
| + * This method causes the cursor to be moved to the center of the |
| + * instance and be locked, preventing the user from moving it. |
| + * The cursor is implicitly hidden from the user while locked. |
| + * Cursor lock may only be requested in response to a |
| + * PP_InputEvent_MouseDown, and then only if the event was generated via |
| + * user gesture. |
| + * |
| + * While the cursor is locked, any movement of the mouse will |
| + * generate a PP_InputEvent_Type_MouseMove, whose x and y values |
| + * indicate the position the cursor would have been moved to had |
| + * the cursor not been locked, and had the screen been infinite in size. |
| + * |
| + * The browser may revoke cursor lock for reasons including but not |
| + * limited to the user pressing the ESC key, the user activating |
| + * another program via a reserved keystroke (e.g., ALT+TAB), or |
| + * some other system event. |
| + * |
| + * Returns PP_TRUE if the cursor could be locked, PP_FALSE otherwise. |
| + */ |
| + PP_Bool LockCursor( |
| + [in] PP_Instance instance); |
| + |
| + /** |
| + * Causes the cursor to be unlocked, allowing it to track user |
| + * movement again. |
| + */ |
| + PP_Bool UnlockCursor( |
| + [in] PP_Instance instance); |
| + |
| + /** |
| + * Returns PP_TRUE if the cursor is locked, PP_FALSE otherwise. |
| + */ |
| + PP_Bool HasCursorLock( |
| + [in] PP_Instance instance); |
| + |
| + /** |
| + * Returns PP_TRUE if the cursor can be locked, PP_FALSE otherwise. |
| + */ |
| + PP_Bool CanLockCursor( |
| + [in] PP_Instance instance); |
| +}; |
| + |