docs/reference/cspi/tmpl/spi_registry.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Registry queries
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### SECTION Stability_Level ##### -->
  18
  19
  20 <!-- ##### ENUM AccessibleKeySynthType ##### -->
  21 <para>
  22
  23 </para>
  24
  25 @SPI_KEY_PRESS:
  26 @SPI_KEY_RELEASE:
  27 @SPI_KEY_PRESSRELEASE:
  28 @SPI_KEY_SYM:
  29 @SPI_KEY_STRING:
  30
  31 <!-- ##### FUNCTION SPI_getDesktopCount ##### -->
  32 <para>
  33
  34 </para>
  35
  36 @Returns:
  37
  38
  39 <!-- ##### FUNCTION SPI_getDesktop ##### -->
  40 <para>
  41
  42 </para>
  43
  44 @i:
  45 @Returns:
  46
  47
  48 <!-- ##### FUNCTION SPI_getDesktopList ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @desktop_list:
  54 @Returns:
  55
  56
  57 <!-- ##### FUNCTION SPI_freeDesktopList ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @desktop_list:
  63
  64
  65 <!-- ##### USER_FUNCTION AccessibleKeystrokeListenerCB ##### -->
  66 <para>
  67 This is a function which is specified when creating a KeystrokeListener.
  68 It is called when an event being listened for occurs.
  69 If it returns TRUE, this indicates that the event should be consumed
  70 rather than passed through; only callbacks whose listeners are
  71 registered with the SPI_KEYLISTENER_ALL_WINDOWS or
  72 SPI_KEYLISTENER_CANCONSUME flags can be consumed.
  73 </para>
  74
  75 @stroke:
  76 @user_data:
  77 @Returns:
  78
  79
  80 <!-- ##### TYPEDEF AccessibleKeyEventMask ##### -->
  81 <para>
  82 AccessibleKeyEventMask is a set of types of key events. It is used
  83 in SPI_registerAccessibleKeystroketListener to specify the events to be
  84 listener for.
  85 </para>
  86
  87
  88 <!-- ##### TYPEDEF AccessibleModifierMaskType ##### -->
  89 <para>
  90 AccessibleModifierMaskType is a synonym for AccessibleKeymaskType.
  91 The defined values for AccessibleModifierMaskType can be found in
  92 libspi/keymasks.h.
  93 </para>
  94
  95
  96 <!-- ##### TYPEDEF AccessibleKeyMaskType ##### -->
  97 <para>
  98
  99 </para>
 100
 101
 102 <!-- ##### TYPEDEF AccessibleKeyEventType ##### -->
 103 <para>
 104
 105 </para>
 106
 107
 108 <!-- ##### ENUM AccessibleKeyListenerSyncType ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @SPI_KEYLISTENER_NOSYNC:
 114 @SPI_KEYLISTENER_SYNCHRONOUS:
 115 @SPI_KEYLISTENER_CANCONSUME:
 116 @SPI_KEYLISTENER_ALL_WINDOWS:
 117
 118 <!-- ##### TYPEDEF AccessibleKeystroke ##### -->
 119 <para>
 120 This is a synonym for AccessibleDeviceEvent.
 121 </para>
 122
 123
 124 <!-- ##### FUNCTION SPI_createAccessibleKeySet ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @len:
 130 @keysyms:
 131 @keycodes:
 132 @keystrings:
 133 @Returns:
 134
 135
 136 <!-- ##### FUNCTION SPI_freeAccessibleKeySet ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @keyset:
 142
 143
 144 <!-- ##### FUNCTION SPI_createAccessibleKeystrokeListener ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @callback:
 150 @user_data:
 151 @Returns:
 152
 153
 154 <!-- ##### FUNCTION SPI_registerGlobalEventListener ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @listener:
 160 @eventType:
 161 @Returns:
 162
 163
 164 <!-- ##### FUNCTION SPI_deregisterGlobalEventListener ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @listener:
 170 @eventType:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION SPI_deregisterGlobalEventListenerAll ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @listener:
 180 @Returns:
 181
 182
 183 <!-- ##### FUNCTION SPI_registerAccessibleKeystrokeListener ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @listener:
 189 @keys:
 190 @modmask:
 191 @eventmask:
 192 @sync_type:
 193 @Returns:
 194
 195
 196 <!-- ##### FUNCTION SPI_deregisterAccessibleKeystrokeListener ##### -->
 197 <para>
 198
 199 </para>
 200
 201 @listener:
 202 @modmask:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION AccessibleKeystrokeListener_unref ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @listener:
 212
 213
 214 <!-- ##### FUNCTION AccessibleKeystrokeListener_removeCallback ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @listener:
 220 @callback:
 221 @Returns:
 222
 223
 224 <!-- ##### FUNCTION AccessibleKeystrokeListener_addCallback ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @listener:
 230 @callback:
 231 @user_data:
 232 @Returns:
 233
 234
 235 <!-- ##### FUNCTION SPI_generateKeyboardEvent ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @keyval:
 241 @keystring:
 242 @synth_type:
 243 @Returns:
 244
 245
 246 <!-- ##### FUNCTION SPI_generateMouseEvent ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @x:
 252 @y:
 253 @name:
 254 @Returns:
 255
 256
 257 <!-- ##### STRUCT AccessibleDeviceEvent ##### -->
 258 <para>
 259 AccessibleDeviceEvent is a struct which encapsulates a device event.
 260 </para>
 261
 262 @keystring:
 263 @type:
 264 @is_text:
 265
 266 <!-- ##### TYPEDEF AccessibleDeviceEventMask ##### -->
 267 <para>
 268 AccessibleDeviceEventMask is a set of types of key events. It is used
 269 in SPI_registerDeviceEventListener to specify the events to be listener for.
 270 </para>
 271
 272
 273 <!-- ##### ENUM AccessibleDeviceEventType ##### -->
 274 <para>
 275
 276 </para>
 277
 278 @SPI_KEY_PRESSED:
 279 @SPI_KEY_RELEASED:
 280 @SPI_BUTTON_PRESSED:
 281 @SPI_BUTTON_RELEASED:
 282
 283 <!-- ##### USER_FUNCTION AccessibleDeviceListenerCB ##### -->
 284 <para>
 285 This is a function which is specified when creating a DeviceListener.
 286 It is called when an event being listened for occurs.
 287 </para>
 288
 289 @stroke:
 290 @user_data:
 291 @Returns:
 292
 293
 294 <!-- ##### FUNCTION SPI_createAccessibleDeviceListener ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @callback:
 300 @user_data:
 301 @Returns:
 302
 303
 304 <!-- ##### FUNCTION SPI_registerDeviceEventListener ##### -->
 305 <para>
 306
 307 </para>
 308
 309 @listener:
 310 @eventmask:
 311 @filter:
 312 @Returns:
 313
 314
 315 <!-- ##### FUNCTION SPI_deregisterDeviceEventListener ##### -->
 316 <para>
 317
 318 </para>
 319
 320 @listener:
 321 @filter:
 322 @Returns:
 323
 324
 325 <!-- ##### FUNCTION AccessibleDeviceListener_addCallback ##### -->
 326 <para>
 327
 328 </para>
 329
 330 @listener:
 331 @callback:
 332 @user_data:
 333 @Returns:
 334
 335
 336 <!-- ##### FUNCTION AccessibleDeviceListener_removeCallback ##### -->
 337 <para>
 338
 339 </para>
 340
 341 @listener:
 342 @callback:
 343 @Returns:
 344
 345
 346 <!-- ##### FUNCTION AccessibleDeviceListener_unref ##### -->
 347 <para>
 348
 349 </para>
 350
 351 @listener:
 352
 353