Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(50)

Side by Side Diff: ppapi/c/ppb_input_event.h

Issue 9600025: Fixed some TODO comments so they wouldn't show up in the docs. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: Created 8 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « ppapi/c/pp_input_event.h ('k') | ppapi/cpp/module.h » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 /* From ppb_input_event.idl modified Tue Feb 14 10:47:45 2012. */ 6 /* From ppb_input_event.idl modified Mon Mar 5 10:11:05 2012. */
7 7
8 #ifndef PPAPI_C_PPB_INPUT_EVENT_H_ 8 #ifndef PPAPI_C_PPB_INPUT_EVENT_H_
9 #define PPAPI_C_PPB_INPUT_EVENT_H_ 9 #define PPAPI_C_PPB_INPUT_EVENT_H_
10 10
11 #include "ppapi/c/pp_bool.h" 11 #include "ppapi/c/pp_bool.h"
12 #include "ppapi/c/pp_instance.h" 12 #include "ppapi/c/pp_instance.h"
13 #include "ppapi/c/pp_macros.h" 13 #include "ppapi/c/pp_macros.h"
14 #include "ppapi/c/pp_point.h" 14 #include "ppapi/c/pp_point.h"
15 #include "ppapi/c/pp_resource.h" 15 #include "ppapi/c/pp_resource.h"
16 #include "ppapi/c/pp_stdint.h" 16 #include "ppapi/c/pp_stdint.h"
(...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after
78 */ 78 */
79 PP_INPUTEVENT_TYPE_MOUSELEAVE = 4, 79 PP_INPUTEVENT_TYPE_MOUSELEAVE = 4,
80 /** 80 /**
81 * Notification that the scroll wheel was used. 81 * Notification that the scroll wheel was used.
82 * 82 *
83 * Register for this event using the PP_INPUTEVENT_CLASS_WHEEL class. 83 * Register for this event using the PP_INPUTEVENT_CLASS_WHEEL class.
84 */ 84 */
85 PP_INPUTEVENT_TYPE_WHEEL = 5, 85 PP_INPUTEVENT_TYPE_WHEEL = 5,
86 /** 86 /**
87 * Notification that a key transitioned from "up" to "down". 87 * Notification that a key transitioned from "up" to "down".
88 * TODO(brettw) differentiate from KEYDOWN.
89 * 88 *
90 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class. 89 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class.
91 */ 90 */
91 /*
92 * TODO(brettw) differentiate from KEYDOWN.
93 */
92 PP_INPUTEVENT_TYPE_RAWKEYDOWN = 6, 94 PP_INPUTEVENT_TYPE_RAWKEYDOWN = 6,
93 /** 95 /**
94 * Notification that a key was pressed. This does not necessarily correspond 96 * Notification that a key was pressed. This does not necessarily correspond
95 * to a character depending on the key and language. Use the 97 * to a character depending on the key and language. Use the
96 * PP_INPUTEVENT_TYPE_CHAR for character input. 98 * PP_INPUTEVENT_TYPE_CHAR for character input.
97 * 99 *
98 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class. 100 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class.
99 */ 101 */
100 PP_INPUTEVENT_TYPE_KEYDOWN = 7, 102 PP_INPUTEVENT_TYPE_KEYDOWN = 7,
101 /** 103 /**
102 * Notification that a key was released. 104 * Notification that a key was released.
103 * 105 *
104 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class. 106 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class.
105 */ 107 */
106 PP_INPUTEVENT_TYPE_KEYUP = 8, 108 PP_INPUTEVENT_TYPE_KEYUP = 8,
107 /** 109 /**
108 * Notification that a character was typed. Use this for text input. Key 110 * Notification that a character was typed. Use this for text input. Key
109 * down events may generate 0, 1, or more than one character event depending 111 * down events may generate 0, 1, or more than one character event depending
110 * on the key, locale, and operating system. 112 * on the key, locale, and operating system.
111 * 113 *
112 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class. 114 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class.
113 */ 115 */
114 PP_INPUTEVENT_TYPE_CHAR = 9, 116 PP_INPUTEVENT_TYPE_CHAR = 9,
115 /** 117 /**
118 * Register for this event using the PP_INPUTEVENT_CLASS_MOUSE class.
119 */
120 /*
116 * TODO(brettw) when is this used? 121 * TODO(brettw) when is this used?
117 *
118 * Register for this event using the PP_INPUTEVENT_CLASS_MOUSE class.
119 */ 122 */
120 PP_INPUTEVENT_TYPE_CONTEXTMENU = 10, 123 PP_INPUTEVENT_TYPE_CONTEXTMENU = 10,
121 /** 124 /**
122 * Notification that an input method composition process has just started. 125 * Notification that an input method composition process has just started.
123 * 126 *
124 * Register for this event using the PP_INPUTEVENT_CLASS_IME class. 127 * Register for this event using the PP_INPUTEVENT_CLASS_IME class.
125 */ 128 */
126 PP_INPUTEVENT_TYPE_IME_COMPOSITION_START = 11, 129 PP_INPUTEVENT_TYPE_IME_COMPOSITION_START = 11,
127 /** 130 /**
128 * Notification that the input method composition string is updated. 131 * Notification that the input method composition string is updated.
(...skipping 350 matching lines...) Expand 10 before | Expand all | Expand 10 after
479 * mouse lock was entered. 482 * mouse lock was entered.
480 * 483 *
481 * @param[in] mouse_event A <code>PP_Resource</code> corresponding to a 484 * @param[in] mouse_event A <code>PP_Resource</code> corresponding to a
482 * mouse event. 485 * mouse event.
483 * 486 *
484 * @return The point associated with the mouse event, relative to the upper- 487 * @return The point associated with the mouse event, relative to the upper-
485 * left of the instance receiving the event. These values can be negative for 488 * left of the instance receiving the event. These values can be negative for
486 * mouse drags. The return value will be (0, 0) for non-mouse events. 489 * mouse drags. The return value will be (0, 0) for non-mouse events.
487 */ 490 */
488 struct PP_Point (*GetPosition)(PP_Resource mouse_event); 491 struct PP_Point (*GetPosition)(PP_Resource mouse_event);
489 /** 492 /*
490 * TODO(brettw) figure out exactly what this means. 493 * TODO(brettw) figure out exactly what this means.
491 */ 494 */
492 int32_t (*GetClickCount)(PP_Resource mouse_event); 495 int32_t (*GetClickCount)(PP_Resource mouse_event);
493 /** 496 /**
494 * Returns the change in position of the mouse. When the mouse is locked, 497 * Returns the change in position of the mouse. When the mouse is locked,
495 * although the mouse position doesn't actually change, this function 498 * although the mouse position doesn't actually change, this function
496 * still provides movement information, which indicates what the change in 499 * still provides movement information, which indicates what the change in
497 * position would be had the mouse not been locked. 500 * position would be had the mouse not been locked.
498 * 501 *
499 * @param[in] mouse_event A <code>PP_Resource</code> corresponding to a 502 * @param[in] mouse_event A <code>PP_Resource</code> corresponding to a
(...skipping 201 matching lines...) Expand 10 before | Expand all | Expand 10 after
701 struct PP_Var (*GetCharacterText)(PP_Resource character_event); 704 struct PP_Var (*GetCharacterText)(PP_Resource character_event);
702 }; 705 };
703 706
704 typedef struct PPB_KeyboardInputEvent_1_0 PPB_KeyboardInputEvent; 707 typedef struct PPB_KeyboardInputEvent_1_0 PPB_KeyboardInputEvent;
705 /** 708 /**
706 * @} 709 * @}
707 */ 710 */
708 711
709 #endif /* PPAPI_C_PPB_INPUT_EVENT_H_ */ 712 #endif /* PPAPI_C_PPB_INPUT_EVENT_H_ */
710 713
OLDNEW
« no previous file with comments | « ppapi/c/pp_input_event.h ('k') | ppapi/cpp/module.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698