xml/org.freedesktop.atspi.Registry.Common.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
   3
   4
   5
   6
   7
   8 <tp:enum name="KeyEventType" type="u">
   9   <tp:docstring>
  10     Deprecated, DO NOT USE!
  11   </tp:docstring>
  12   <tp:enumvalue suffix="KEY_PRESSED"/>
  13   <tp:enumvalue suffix="KEY_RELEASED" value="1"/>
  14 </tp:enum>
  15 <tp:enum name="EventType" type="u">
  16   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  17     <p>Used to specify the event types of interest to an EventListener, or
  18       to identify the type of an event for which notification has been sent.
  19       @see EventTypeSeq, DeviceEvent::type</p>
  20   </tp:docstring>
  21   <tp:enumvalue suffix="KEY_PRESSED_EVENT">
  22   <tp:docstring>
  23     &lt; key on a keyboard device was pressed.
  24   </tp:docstring>
  25   </tp:enumvalue>
  26   <tp:enumvalue suffix="KEY_RELEASED_EVENT" value="1">
  27   <tp:docstring>
  28     &lt; key on a keyboard device was released.
  29   </tp:docstring>
  30   </tp:enumvalue>
  31   <tp:enumvalue suffix="BUTTON_PRESSED_EVENT" value="2">
  32   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  33     <p>&lt; button on a non-keyboard human interface device
  34       (HID) was pressed </p>
  35   </tp:docstring>
  36   </tp:enumvalue>
  37   <tp:enumvalue suffix="BUTTON_RELEASED_EVENT" value="3">
  38   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  39     <p>&lt; button on a non-keyboard human interface device
  40       (HID) was pressed </p>
  41   </tp:docstring>
  42   </tp:enumvalue>
  43 </tp:enum>
  44 <tp:enum name="KeySynthType" type="u">
  45   <tp:docstring>
  46     Used when synthesizing keyboard input via DeviceEventController:generateKeyboardEvent.
  47   </tp:docstring>
  48   <tp:enumvalue suffix="KEY_PRESS">
  49   <tp:docstring>
  50     emulate the pressing of a hardware keyboard key.
  51   </tp:docstring>
  52   </tp:enumvalue>
  53   <tp:enumvalue suffix="KEY_RELEASE" value="1">
  54   <tp:docstring>
  55     emulate the release of a hardware keyboard key.
  56   </tp:docstring>
  57   </tp:enumvalue>
  58   <tp:enumvalue suffix="KEY_PRESSRELEASE" value="2">
  59   <tp:docstring>
  60     a hardware keyboard key is pressed and immediately released.
  61   </tp:docstring>
  62   </tp:enumvalue>
  63   <tp:enumvalue suffix="KEY_SYM" value="3">
  64   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  65     <p>a symbolic key event is generated, without specifying a hardware key.
  66       @note if the keysym is not present in the current keyboard map,
  67       the DeviceEventController instance has a limited ability to generate
  68       such keysyms on-the-fly.  Reliability of generateKeyboardEvent calls
  69       using out-of-keymap keysyms will vary from system to system, and on the
  70       number of different out-of-keymap being generated in quick succession.
  71       In practice this is rarely significant, since the keysyms of interest to
  72       AT clients and keyboard emulators are usually part of the current keymap, i.e.
  73       present on the system keyboard for the current locale (even if a physical
  74       hardware keyboard is not connected.</p>
  75   </tp:docstring>
  76   </tp:enumvalue>
  77   <tp:enumvalue suffix="KEY_STRING" value="4">
  78   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  79     <p>a string is converted to its equivalent keyboard events and emitted.
  80       If the string consists of complex character or composed characters
  81       which are not in the current keymap, string emission is subject to the
  82       out-of-keymap limitations described for KeySynthType::KEY_SYM.
  83       In practice this limitation primarily effects Chinese and Japanese locales.</p>
  84   </tp:docstring>
  85   </tp:enumvalue>
  86 </tp:enum>
  87 <tp:enum name="ModifierType" type="u">
  88   <tp:enumvalue suffix="MODIFIER_SHIFT">
  89   <tp:docstring>
  90     The left or right 'Shift' key
  91   </tp:docstring>
  92   </tp:enumvalue>
  93   <tp:enumvalue suffix="MODIFIER_SHIFTLOCK" value="1">
  94   <tp:docstring>
  95     The ShiftLock or CapsLock key
  96   </tp:docstring>
  97   </tp:enumvalue>
  98   <tp:enumvalue suffix="MODIFIER_CONTROL" value="2">
  99   <tp:docstring>
 100     'Control'/'Ctrl'
 101   </tp:docstring>
 102   </tp:enumvalue>
 103   <tp:enumvalue suffix="MODIFIER_ALT" value="3">
 104   <tp:docstring>
 105     The Alt key (as opposed to AltGr)
 106   </tp:docstring>
 107   </tp:enumvalue>
 108   <tp:enumvalue suffix="MODIFIER_META" value="4">
 109   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 110     <p>depending on the platform this may map to 'Window', 'Function', 'Meta',
 111       'Menu', or 'NumLock'.
 112       Such 'Meta keys' will map to one of META, META2, META3.
 113       On X Windows platforms these META values map to
 114       the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an event having
 115       ModifierType::MODIFIER_META2 means that the 'Mod2Mask' bit is
 116       set in the corresponding XEvent.</p>
 117   </tp:docstring>
 118   </tp:enumvalue>
 119   <tp:enumvalue suffix="MODIFIER_META2" value="5"/>
 120   <tp:enumvalue suffix="MODIFIER_META3" value="6"/>
 121   <tp:enumvalue suffix="MODIFIER_NUMLOCK" value="7">
 122   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 123     <p>A symbolic meta key name that is mapped by AT-SPI to the
 124       appropriate META value, for the convenience of the client.</p>
 125   </tp:docstring>
 126   </tp:enumvalue>
 127 </tp:enum>
 128 <tp:struct name="EventListenerMode">
 129   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 130     <p>A structure that encapsulates the characteristics of the event notifications
 131       that should be sent to an EventListener in response to a call to
 132       DeviceEventController::registerKeystrokeListener or
 133       DeviceEventController::registerDeviceEventListener. </p>
 134   </tp:docstring>
 135   <tp:member type="b" tp:name="synchronous">
 136   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 137     <p>&lt; If \c True, specifies that
 138       DeviceEventController should block while waiting
 139       for client to process the requested event notifications;
 140       ordinarily should be used only when client needs to perform
 141       operations synchronously with event delivery. Note that because
 142       of the architecture of device event systems in general,
 143       use of this flag may not block delivery of the event to
 144       the currently focussed application unless it is used in
 145       conjunction with the preemptive flag. </p>
 146   </tp:docstring>
 147   </tp:member>
 148   <tp:member type="b" tp:name="preemptive">
 149   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 150     <p>&lt; If \c True, specifies that
 151       Listener is allowed to pre-empt the delivery of the event,
 152       effectively "consuming" it such that it is not delivered
 153       to the currently focussed desktop application.
 154       Key events consumed via this API will not be
 155       available for use by other applications or services, so this
 156       option should be used sparingly. </p>
 157   </tp:docstring>
 158   </tp:member>
 159   <tp:member type="b" tp:name="global">
 160   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 161     <p>&lt; If \c True, specifies that
 162       Event notifications should be sent regardless of whether the
 163       currently focussed application participates in the AT-SPI
 164       infrastructure.  On systems with the XEvIE X extension, this flag
 165       also allows access to events which are already subject to
 166       interception via a "system keygrab" (as described in the X Window System
 167       documentation for XGrabKey).  The 'global' and 'preemptive' flags
 168       should only be used together for the purposes of registering
 169       "system global key shortcuts" i.e. command keys for use by the
 170       assistive technology. </p>
 171   </tp:docstring>
 172   </tp:member>
 173 </tp:struct>
 174 <tp:struct name="DeviceEvent">
 175   <tp:docstring>
 176     A structure which encapsulates information about a device event.
 177   </tp:docstring>
 178   <tp:member type="u" tp:name="type">
 179   <tp:docstring>
 180     &lt; Identifies the type of the containing DeviceEvent.
 181   </tp:docstring>
 182   </tp:member>
 183   <tp:member type="i" tp:name="id">
 184   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 185     <p>&lt; an identifier which identifies this event in the event stream.
 186       On X Window systems this corresponds to the XEvent serial number.</p>
 187   </tp:docstring>
 188   </tp:member>
 189   <tp:member type="n" tp:name="hw_code">
 190   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 191     <p>&lt; a numeric code which is hardware and system-dependent, identifying the
 192       specific hardware button or key on the device for which the event has
 193       occurred. On X Window systems, for global key notifications and for most
 194       non-global key notifications as well, this code corresponds to the
 195       XKeycode.  For switch and button events it indicates the switch
 196       or button number.
 197       @note
 198       For technical reasons, this code may differ from the XKeycode
 199       when generated by Java applications for consumption by non-global
 200       key listeners.  This is subject to change in future versions of the
 201       DeviceEventController implementation.</p>
 202   </tp:docstring>
 203   </tp:member>
 204   <tp:member type="n" tp:name="modifiers">
 205   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 206     <p>&lt; an unsigned short int consisting of zero or more of the following
 207       values OR'ed together:
 208       \li \c 1&lt;&lt;::MODIFIER_SHIFT   (=1, corresponds to Xlib's ShiftMask)
 209       \li \c 1&lt;&lt;::MODIFIER_SHIFTLOCK    (=2, corresponds to Xlib's LockMask)
 210       \li \c 1&lt;&lt;::MODIFIER_CONTROL (=4, corresponds to Xlib's ControlMask)
 211       \li \c 1&lt;&lt;::MODIFIER_ALT    (=8, corresponds to Xlib's Mod1Mask)
 212       \li \c 1&lt;&lt;::MODIFIER_META    (=16, corresponds to Xlib's Mod2Mask)
 213       \li \c 1&lt;&lt;::MODIFIER_META2    (=32, corresponds to Xlib's Mod3Mask)
 214       \li \c 1&lt;&lt;::MODIFIER_META3    (=64, corresponds to Xlib's Mod4Mask)</p>
 215   </tp:docstring>
 216   </tp:member>
 217   <tp:member type="i" tp:name="timestamp">
 218   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 219     <p>&lt; an unsigned integer representing the time that the
 220       event occurred.  On X Window systems this event is
 221       a time in milliseconds from some arbitrary starting
 222       point; it therefore has a cycle time of approximately
 223       50 days.</p>
 224   </tp:docstring>
 225   </tp:member>
 226   <tp:member type="s" tp:name="event_string">
 227   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 228     <p>&lt; A string representation of the event.  If is_text is
 229       \c True, then this string represents the character or typographic
 230       sequence that would be received by a focussed text input field.
 231       event_string is in general suitable for exposure to the
 232       end-user for purposes of keyboard echo.</p>
 233   </tp:docstring>
 234   </tp:member>
 235   <tp:member type="b" tp:name="is_text">
 236   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 237     <p>&lt; \c True if the event results in the insertion of characters
 238       into an input text buffer, or would do so if delivered to a focussed
 239       text input field. ¨Typographical¨ key events have this field set to
 240       \c True, whereas ¨control¨ key events generally do not.</p>
 241   </tp:docstring>
 242   </tp:member>
 243 </tp:struct>
 244 <tp:struct name="KeyDefinition">
 245   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 246     <p>A structure which defines the identity of a key for which notifications
 247       are to be requested.  The data in the members of a ::KeyDefinition are used to
 248       determine which keyboard events 'match' the notification request filed by a client.  </p>
 249
 250     <p>@note Ordinarily a KeyDefinition specifies one and only one of the criteria below;
 251       the result of using a KeyDefinition with multiple members defined as nonzero is
 252       undefined.  </p>
 253
 254     <p>@param keycode if nonzero, the numeric, system-dependent value corresponding to a
 255       physical key on the keyboard.  Keycode values have no semantic meaning to the end-user,
 256       and may depend on the user's hardware and operating environment.  They therefore are
 257       rarely useful "as-is" to AT clients, unless the client has used operating system
 258       services to identify the hardward keycode associated with a particular key symbol.
 259       Notifications for key events requested by keycode are less dependent on modifier state
 260       than \c keysym based notifications, but some hardware (notably many laptops) may generate
 261       more than one keycode for the same physical key, depending on the state of physical
 262       shift/modifier keys.
 263       @param keysym if nonzero, the numeric value corresponding to the X Keysym of the key for which
 264       notification is requested.  Note that the presence of active modifiers will affect
 265       whether notification for key events requested via "keysym" specification takes place,
 266       since the keysym depends on the modifier state for most keys.
 267       @param keystring if non-NULL, the string value of the inserted characters if the corresponding
 268       key event has ::KeyEvent:is_text set to \c True, or the string representing the
 269       'name' of the key.  On X11 systems, the string 'name' of non-printing keysyms corresponds
 270       to the values in "keysymdef.h" as provided by Xlib, with the leading "XK_" stripped off.</p>
 271   </tp:docstring>
 272   <tp:member type="i" tp:name="keycode"/>
 273   <tp:member type="i" tp:name="keysym"/>
 274   <tp:member type="s" tp:name="keystring"/>
 275   <tp:member type="i" tp:name="unused"/>
 276 </tp:struct>
 277 </node>