diff options
| author | brettw@chromium.org <brettw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-06-25 17:05:44 +0000 |
|---|---|---|
| committer | brettw@chromium.org <brettw@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-06-25 17:05:44 +0000 |
| commit | f8b57189b43716dc81cffac74e1f15616ca43cf8 (patch) | |
| tree | 0cd3adb26faa94f4023cd4fb6515a611873fb36c /ppapi/c/ppb_input_event.h | |
| parent | 42e411ead0a16002bb6f8ad32f9637055e019951 (diff) | |
| download | chromium_src-f8b57189b43716dc81cffac74e1f15616ca43cf8.zip chromium_src-f8b57189b43716dc81cffac74e1f15616ca43cf8.tar.gz chromium_src-f8b57189b43716dc81cffac74e1f15616ca43cf8.tar.bz2 | |
Add documentation for the context menu Pepper event.
Review URL: https://chromiumcodereview.appspot.com/10665005
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@143924 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/c/ppb_input_event.h')
| -rw-r--r-- | ppapi/c/ppb_input_event.h | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/ppapi/c/ppb_input_event.h b/ppapi/c/ppb_input_event.h index d4637fb..382ba20 100644 --- a/ppapi/c/ppb_input_event.h +++ b/ppapi/c/ppb_input_event.h @@ -3,7 +3,7 @@ * found in the LICENSE file. */ -/* From ppb_input_event.idl modified Thu Jun 21 17:17:39 2012. */ +/* From ppb_input_event.idl modified Fri Jun 22 15:22:14 2012. */ #ifndef PPAPI_C_PPB_INPUT_EVENT_H_ #define PPAPI_C_PPB_INPUT_EVENT_H_ @@ -119,11 +119,27 @@ typedef enum { */ PP_INPUTEVENT_TYPE_CHAR = 9, /** + * Notification that a context menu should be shown. + * + * This message will be sent when the user right-clicks or performs another + * OS-specific mouse command that should open a context menu. When this event + * is delivered depends on the system, on some systems (Mac) it will + * delivered after the mouse down event, and on others (Windows) it will be + * delivered after the mouse up event. + * + * You will always get the normal mouse events. For example, you may see + * MOUSEDOWN,CONTEXTMENU,MOUSEUP or MOUSEDOWN,MOUSEUP,CONTEXTMENU. + * + * The return value from the event handler determines if the context menu + * event will be passed to the page when you are using filtered input events + * (via RequestFilteringInputEvents()). In non-filtering mode the event will + * never be propagated and no context menu will be displayed. If you are + * handling mouse events in filtering mode, you may want to return true from + * this event even if you do not support a context menu to suppress the + * default one. + * * Register for this event using the PP_INPUTEVENT_CLASS_MOUSE class. */ - /* - * TODO(brettw) when is this used? - */ PP_INPUTEVENT_TYPE_CONTEXTMENU = 10, /** * Notification that an input method composition process has just started. |