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