X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=xml%2Forg.freedesktop.atspi.DeviceEventController.xml;h=e044f6a92ecc67de52f99191fa12cb0ae4966823;hb=bca89c781e97d81b7bdca3741eeb901d48f98a7a;hp=89dd3d75ef609641e5d4bb9dce0787d1eac50661;hpb=c21124faa3a36efbd3300f08861f974de9d866aa;p=platform%2Fupstream%2Fat-spi2-core.git diff --git a/xml/org.freedesktop.atspi.DeviceEventController.xml b/xml/org.freedesktop.atspi.DeviceEventController.xml index 89dd3d7..e044f6a 100644 --- a/xml/org.freedesktop.atspi.DeviceEventController.xml +++ b/xml/org.freedesktop.atspi.DeviceEventController.xml @@ -1,10 +1,5 @@ - - - - -

The interface via which clients request notification of device events, and @@ -17,32 +12,32 @@ - a DeviceEventListener which will intercept key events. + A DeviceEventListener which will intercept key events. - a KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS. + A KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS. - a ControllerEventMask filtering the intercepted key events. + A ControllerEventMask filtering the intercepted key events. - a KeyEventTypeSeq that may created by ORing event types together. + A KeyEventTypeSeq that may created by ORing event types together. - an EventListenerMode indicating whether the listener should receive the events synchronously, potentially consuming them,or just be notified asynchronously of those events that havebeen generated.@note Some platforms have limited support for global, preemptive EventListenerMode.Such a registration may fail if another client already has priority for preemptiveaccess to one or more of the members of the KeySet. AT consumers have the optionof re-trying the request without the global flag, or without the preemptive flag,or of re-trying with a different KeySet. The best support for pre-emptiveglobal keyboard listeners is provided on platforms whose Xserver implementationprovides the XEvIE extension. + An EventListenerMode indicating whether the listener should receive the events synchronously, potentially consuming them,or just be notified asynchronously of those events that havebeen generated.@note Some platforms have limited support for global, preemptive EventListenerMode.Such a registration may fail if another client already has priority for preemptiveaccess to one or more of the members of the KeySet. AT consumers have the optionof re-trying the request without the global flag, or without the preemptive flag,or of re-trying with a different KeySet. The best support for pre-emptiveglobal keyboard listeners is provided on platforms whose Xserver implementationprovides the XEvIE extension. - \c True if the DeviceEventListener was successfully registeredfor the requested KeySet, ControllerEventMask, event types, and EventListenerMode; otherwise returns \c False. + True if the DeviceEventListener was successfully registeredfor the requested KeySet, ControllerEventMask, event types, and EventListenerMode; otherwise returns False. @@ -52,22 +47,22 @@ - a DeviceEventListener which will intercept key events. + A DeviceEventListener which will intercept key events. - a KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS. + A KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS. - a ControllerEventMask filtering the intercepted key events. + A ControllerEventMask filtering the intercepted key events. - an EventType mask that may created by ORing event types together. + An EventType mask that may created by ORing event types together. @@ -79,17 +74,17 @@ - a DeviceEventListener which will intercept events. + A DeviceEventListener which will intercept events. - an EventTypeSeq indicating which event types to listen for. + An EventTypeSeq indicating which event types to listen for. - \c True if successful, \c False if not + True if successful, False if not. @@ -104,7 +99,7 @@ - an EventTypeSeq indicating which event types to stoplistening for. + An EventTypeSeq indicating which event types to stoplistening for. @@ -116,13 +111,13 @@ method used by accessibility bridges to forward "toolkit dependent" device events to the Registry from the application's process space.

-

@note AT clients do not normally need to use this method, it is intended for use +

AT clients do not normally need to use this method, it is intended for use by toolkit bridges and special-purpose applications.

- \c True if the event was consumed by a (pre-emptive) listener,\c False if not (in which case the device event will be forwardedas normal to any application which would normally receive it, e.g.the currently active application in the case of mouse or keyboard events). + True if the event was consumed by a (pre-emptive) listener, False if not (in which case the device event will be forwardedas normal to any application which would normally receive it, e.g.the currently active application in the case of mouse or keyboard events). @@ -133,9 +128,9 @@ method used by accessibility bridges to forward "toolkit dependent" device events to the Registry from the application's process space. If the event in question is potentially pre-emptible. - ::notifyListenersSync should be used instead.

+ notifyListenersSync should be used instead.

-

@note AT clients do not normally need to use this method, it is intended for use +

AT clients do not normally need to use this method, it is intended for use by toolkit bridges and special-purpose applications.

@@ -146,17 +141,19 @@ - a long integer indicating the keycode ofthe keypress to be synthesized. + A long integer indicating the keycode ofthe keypress to be synthesized. - an optional UTF-8 string indicating a complexkeyboard input event. + An optional UTF-8 string indicating a complexkeyboard input event. - a KeySynthType indicating the type of event(s) to be synthesized: a key press, release, press-release pair,or a complex input string (for instance from aninternationalized or complex text input method, ora composed character).@note keycode may be truncated before beingprocessed, as keycode length may be platform-dependentand keycode ranges are generally much smaller thanCORBA_long. One or the other of keycode or keystring are generally NULL, (but not both), depending on the value of \c type. +

A KeySynthType indicating the type of event(s) to be synthesized: a key press, release, press-release pair,or a complex input string (for instance from aninternationalized or complex text input method, ora composed character).

+ +

Keycode may be truncated before beingprocessed, as keycode length may be platform-dependentand keycode ranges are generally much smaller thanCORBA_long. One or the other of keycode or keystring are generally NULL, (but not both), depending on the value of type.

 @@ -166,17 +163,17 @@ - a long integer indicating the screen x coord for the mouse event. + A long integer indicating the screen x coord for the mouse event. - a long integer indicating the screen y coord for the mouse event. + A long integer indicating the screen y coord for the mouse event. - a string indicating the type of mouse event, e.g. "button1up" + A string indicating the type of mouse event, e.g. "button1up"