diff options
Diffstat (limited to 'ppapi/api/ppp_input_event.idl')
-rw-r--r-- | ppapi/api/ppp_input_event.idl | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/ppapi/api/ppp_input_event.idl b/ppapi/api/ppp_input_event.idl new file mode 100644 index 0000000..cfaf398 --- /dev/null +++ b/ppapi/api/ppp_input_event.idl @@ -0,0 +1,40 @@ +/* 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 API for receiving input events form the browser. + */ + +label Chrome { + M14 = 0.1 +}; + +[version=0.1, macro="PPP_INPUT_EVENT_INTERFACE"] +interface PPP_InputEvent { + /** + * Function for receiving input events from the browser. + * + * In order to receive input events, you must register for them by calling + * PPB_InputEvent.RequestInputEvents() or RequestFilteringInputEvents(). By + * default, no events are delivered. + * + * In general, you should try to keep input event handling short. Especially + * for filtered input events, the browser or page may be blocked waiting for + * you to respond. + * + * The caller of this function will maintain a reference to the input event + * resource during this call. Unless you take a reference to the resource + * to hold it for later, you don't need to release it. + * + * @return PP_TRUE if the event was handled, PP_FALSE if not. If you have + * registered to filter this class of events by calling + * RequestFilteringInputEvents, and you return PP_FALSE, the event will + * be forwarded to the page (and eventually the browser) for the default + * handling. For non-filtered events, the return value will be ignored. + */ + PP_Bool HandleInputEvent([in] PP_Instance instance, + [in] PP_Resource input_event); +}; + |