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

Side by Side Diff: ppapi/api/ppb_input_event.idl

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/api/pp_input_event.idl ('k') | ppapi/c/pp_input_event.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 /** 6 /**
7 * This file defines the Input Event interfaces. 7 * This file defines the Input Event interfaces.
8 */ 8 */
9 9
10 label Chrome { 10 label Chrome {
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after
57 57
58 /** 58 /**
59 * Notification that the scroll wheel was used. 59 * Notification that the scroll wheel was used.
60 * 60 *
61 * Register for this event using the PP_INPUTEVENT_CLASS_WHEEL class. 61 * Register for this event using the PP_INPUTEVENT_CLASS_WHEEL class.
62 */ 62 */
63 PP_INPUTEVENT_TYPE_WHEEL = 5, 63 PP_INPUTEVENT_TYPE_WHEEL = 5,
64 64
65 /** 65 /**
66 * Notification that a key transitioned from "up" to "down". 66 * Notification that a key transitioned from "up" to "down".
67 * TODO(brettw) differentiate from KEYDOWN.
68 * 67 *
69 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class. 68 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class.
70 */ 69 */
70
71 /*
72 * TODO(brettw) differentiate from KEYDOWN.
73 */
71 PP_INPUTEVENT_TYPE_RAWKEYDOWN = 6, 74 PP_INPUTEVENT_TYPE_RAWKEYDOWN = 6,
72 75
73 /** 76 /**
74 * Notification that a key was pressed. This does not necessarily correspond 77 * Notification that a key was pressed. This does not necessarily correspond
75 * to a character depending on the key and language. Use the 78 * to a character depending on the key and language. Use the
76 * PP_INPUTEVENT_TYPE_CHAR for character input. 79 * PP_INPUTEVENT_TYPE_CHAR for character input.
77 * 80 *
78 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class. 81 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class.
79 */ 82 */
80 PP_INPUTEVENT_TYPE_KEYDOWN = 7, 83 PP_INPUTEVENT_TYPE_KEYDOWN = 7,
81 84
82 /** 85 /**
83 * Notification that a key was released. 86 * Notification that a key was released.
84 * 87 *
85 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class. 88 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class.
86 */ 89 */
87 PP_INPUTEVENT_TYPE_KEYUP = 8, 90 PP_INPUTEVENT_TYPE_KEYUP = 8,
88 91
89 /** 92 /**
90 * Notification that a character was typed. Use this for text input. Key 93 * Notification that a character was typed. Use this for text input. Key
91 * down events may generate 0, 1, or more than one character event depending 94 * down events may generate 0, 1, or more than one character event depending
92 * on the key, locale, and operating system. 95 * on the key, locale, and operating system.
93 * 96 *
94 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class. 97 * Register for this event using the PP_INPUTEVENT_CLASS_KEYBOARD class.
95 */ 98 */
96 PP_INPUTEVENT_TYPE_CHAR = 9, 99 PP_INPUTEVENT_TYPE_CHAR = 9,
97 100
98 /** 101 /**
102 * Register for this event using the PP_INPUTEVENT_CLASS_MOUSE class.
103 */
104
105 /*
99 * TODO(brettw) when is this used? 106 * TODO(brettw) when is this used?
100 *
101 * Register for this event using the PP_INPUTEVENT_CLASS_MOUSE class.
102 */ 107 */
103 PP_INPUTEVENT_TYPE_CONTEXTMENU = 10, 108 PP_INPUTEVENT_TYPE_CONTEXTMENU = 10,
104 109
105 /** 110 /**
106 * Notification that an input method composition process has just started. 111 * Notification that an input method composition process has just started.
107 * 112 *
108 * Register for this event using the PP_INPUTEVENT_CLASS_IME class. 113 * Register for this event using the PP_INPUTEVENT_CLASS_IME class.
109 */ 114 */
110 PP_INPUTEVENT_TYPE_IME_COMPOSITION_START = 11, 115 PP_INPUTEVENT_TYPE_IME_COMPOSITION_START = 11,
111 116
(...skipping 397 matching lines...) Expand 10 before | Expand all | Expand 10 after
509 * 514 *
510 * @param[in] mouse_event A <code>PP_Resource</code> corresponding to a 515 * @param[in] mouse_event A <code>PP_Resource</code> corresponding to a
511 * mouse event. 516 * mouse event.
512 * 517 *
513 * @return The point associated with the mouse event, relative to the upper- 518 * @return The point associated with the mouse event, relative to the upper-
514 * left of the instance receiving the event. These values can be negative for 519 * left of the instance receiving the event. These values can be negative for
515 * mouse drags. The return value will be (0, 0) for non-mouse events. 520 * mouse drags. The return value will be (0, 0) for non-mouse events.
516 */ 521 */
517 [returnByValue] PP_Point GetPosition([in] PP_Resource mouse_event); 522 [returnByValue] PP_Point GetPosition([in] PP_Resource mouse_event);
518 523
519 /** 524 /*
520 * TODO(brettw) figure out exactly what this means. 525 * TODO(brettw) figure out exactly what this means.
521 */ 526 */
522 int32_t GetClickCount([in] PP_Resource mouse_event); 527 int32_t GetClickCount([in] PP_Resource mouse_event);
523 528
524 /** 529 /**
525 * Returns the change in position of the mouse. When the mouse is locked, 530 * Returns the change in position of the mouse. When the mouse is locked,
526 * although the mouse position doesn't actually change, this function 531 * although the mouse position doesn't actually change, this function
527 * still provides movement information, which indicates what the change in 532 * still provides movement information, which indicates what the change in
528 * position would be had the mouse not been locked. 533 * position would be had the mouse not been locked.
529 * 534 *
(...skipping 188 matching lines...) Expand 10 before | Expand all | Expand 10 after
718 * @param[in] character_event A <code>PP_Resource</code> corresponding to a 723 * @param[in] character_event A <code>PP_Resource</code> corresponding to a
719 * keyboard event. 724 * keyboard event.
720 * 725 *
721 * @return A string var representing a single typed character for character 726 * @return A string var representing a single typed character for character
722 * input events. For non-character input events the return value will be an 727 * input events. For non-character input events the return value will be an
723 * undefined var. 728 * undefined var.
724 */ 729 */
725 PP_Var GetCharacterText([in] PP_Resource character_event); 730 PP_Var GetCharacterText([in] PP_Resource character_event);
726 }; 731 };
727 732
OLDNEW
« no previous file with comments | « ppapi/api/pp_input_event.idl ('k') | ppapi/c/pp_input_event.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698