-<interface name="org.freedesktop.atspi.DeviceEventController">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>The interface via which clients request notification of device events, and
- through which device events may be simulated.</p>
- </tp:docstring>
- <method name="registerKeystrokeListener">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Register to intercept keyboard events, and either pass them on or
- consume them. </p>
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
- <tp:docstring>
- a DeviceEventListener which will intercept key events.
- </tp:docstring>
- </arg>
- <arg direction="in" name="keys" type="a(iisi)" tp:type="KeySet">
- <tp:docstring>
- a KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
- </tp:docstring>
- </arg>
- <arg direction="in" name="mask" type="u" tp:type="ControllerEventMask">
- <tp:docstring>
- a ControllerEventMask filtering the intercepted key events.
- </tp:docstring>
- </arg>
- <arg direction="in" name="type" type="au" tp:type="KeyEventTypeSeq">
- <tp:docstring>
- a KeyEventTypeSeq that may created by ORing event types together.
- </tp:docstring>
- </arg>
- <arg direction="in" name="mode" type="(bbb)" tp:type="EventListenerMode">
- <tp:docstring>
- 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.
- </tp:docstring>
- </arg>
- <arg direction="out" type="b" tp:type="boolean">
- <tp:docstring>
- \c True if the DeviceEventListener was successfully registeredfor the requested KeySet, ControllerEventMask, event types, and EventListenerMode; otherwise returns \c False.
- </tp:docstring>
- </arg>
- </method>
- <method name="deregisterKeystrokeListener">
- <tp:docstring>
- De-register a previously registered keyboard eventlistener.
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
- <tp:docstring>
- a DeviceEventListener which will intercept key events.
- </tp:docstring>
- </arg>
- <arg direction="in" name="keys" type="a(iisi)" tp:type="KeySet">
- <tp:docstring>
- a KeySet indicating which keys to intercept, or KEYSET_ALL_KEYS.
- </tp:docstring>
- </arg>
- <arg direction="in" name="mask" type="u" tp:type="ControllerEventMask">
- <tp:docstring>
- a ControllerEventMask filtering the intercepted key events.
- </tp:docstring>
- </arg>
- <arg direction="in" name="type" type="au" tp:type="KeyEventTypeSeq">
- <tp:docstring>
- an EventType mask that may created by ORing event types together.
- </tp:docstring>
- </arg>
- </method>
- <method name="registerDeviceEventListener">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Register to intercept events, and either pass them on or
- consume them. To listen to keyboard events use registerKeystrokeListener
- instead.</p>
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
- <tp:docstring>
- a DeviceEventListener which will intercept events.
- </tp:docstring>
- </arg>
- <arg direction="in" name="types" type="u" tp:type="EventTypeSeq">
- <tp:docstring>
- an EventTypeSeq indicating which event types to listen for.
- </tp:docstring>
- </arg>
- <arg direction="out" type="b" tp:type="boolean">
- <tp:docstring>
- \c True if successful, \c False if not
- </tp:docstring>
- </arg>
- </method>
- <method name="deregisterDeviceEventListener">
- <tp:docstring>
- De-register a previously registered keyboard eventlistener.
- </tp:docstring>
- <arg direction="in" name="listener" type="o" tp:type="DeviceEventListener">
- <tp:docstring>
- a DeviceEventListener which will intercept events.
- </tp:docstring>
- </arg>
- <arg direction="in" name="types" type="u" tp:type="EventTypeSeq">
- <tp:docstring>
- an EventTypeSeq indicating which event types to stoplistening for.
- </tp:docstring>
- </arg>
- </method>
- <method name="notifyListenersSync">
- <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
- <p>Notify the Registry instance that a device event has taken place, and
- allow pre-emptive listeners the opportunity to 'consume' the event
- and thus prevent its further issuance/forwarding. This is the
- method used by accessibility bridges to forward "toolkit dependent"
- device events to the Registry from the application's process space. </p>