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 </para>
  69
  70 @stroke:
  71 @user_data:
  72 @Returns:
  73
  74
  75 <!-- ##### TYPEDEF AccessibleKeyEventMask ##### -->
  76 <para>
  77 AccessibleKeyEventMask is a set of types of key events. It is used
  78 in SPI_registerAccessibleKeystroketListener to specify the events to be
  79 listener for.
  80 </para>
  81
  82
  83 <!-- ##### TYPEDEF AccessibleModifierMaskType ##### -->
  84 <para>
  85 AccessibleModifierMaskType is a synonym for AccessibleKeymaskType.
  86 </para>
  87
  88
  89 <!-- ##### TYPEDEF AccessibleKeyMaskType ##### -->
  90 <para>
  91
  92 </para>
  93
  94
  95 <!-- ##### TYPEDEF AccessibleKeyEventType ##### -->
  96 <para>
  97
  98 </para>
  99
 100
 101 <!-- ##### ENUM AccessibleKeyListenerSyncType ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @SPI_KEYLISTENER_NOSYNC:
 107 @SPI_KEYLISTENER_SYNCHRONOUS:
 108 @SPI_KEYLISTENER_CANCONSUME:
 109 @SPI_KEYLISTENER_ALL_WINDOWS:
 110
 111 <!-- ##### TYPEDEF AccessibleKeystroke ##### -->
 112 <para>
 113 This is a synonym for AccessibleDeviceEvent.
 114 </para>
 115
 116
 117 <!-- ##### FUNCTION SPI_createAccessibleKeySet ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @len:
 123 @keysyms:
 124 @keycodes:
 125 @keystrings:
 126 @Returns:
 127
 128
 129 <!-- ##### FUNCTION SPI_freeAccessibleKeySet ##### -->
 130 <para>
 131
 132 </para>
 133
 134 @keyset:
 135
 136
 137 <!-- ##### FUNCTION SPI_createAccessibleKeystrokeListener ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @callback:
 143 @user_data:
 144 @Returns:
 145
 146
 147 <!-- ##### FUNCTION SPI_registerGlobalEventListener ##### -->
 148 <para>
 149
 150 </para>
 151
 152 @listener:
 153 @eventType:
 154 @Returns:
 155
 156
 157 <!-- ##### FUNCTION SPI_deregisterGlobalEventListener ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @listener:
 163 @eventType:
 164 @Returns:
 165
 166
 167 <!-- ##### FUNCTION SPI_deregisterGlobalEventListenerAll ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @listener:
 173 @Returns:
 174
 175
 176 <!-- ##### FUNCTION SPI_registerAccessibleKeystrokeListener ##### -->
 177 <para>
 178
 179 </para>
 180
 181 @listener:
 182 @keys:
 183 @modmask:
 184 @eventmask:
 185 @sync_type:
 186 @Returns:
 187
 188
 189 <!-- ##### FUNCTION SPI_deregisterAccessibleKeystrokeListener ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @listener:
 195 @modmask:
 196 @Returns:
 197
 198
 199 <!-- ##### FUNCTION AccessibleKeystrokeListener_unref ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @listener:
 205
 206
 207 <!-- ##### FUNCTION AccessibleKeystrokeListener_removeCallback ##### -->
 208 <para>
 209
 210 </para>
 211
 212 @listener:
 213 @callback:
 214 @Returns:
 215
 216
 217 <!-- ##### FUNCTION AccessibleKeystrokeListener_addCallback ##### -->
 218 <para>
 219
 220 </para>
 221
 222 @listener:
 223 @callback:
 224 @user_data:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION SPI_generateKeyboardEvent ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @keyval:
 234 @keystring:
 235 @synth_type:
 236 @Returns:
 237
 238
 239 <!-- ##### FUNCTION SPI_generateMouseEvent ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @x:
 245 @y:
 246 @name:
 247 @Returns:
 248
 249
 250 <!-- ##### TYPEDEF AccessibleDeviceEvent ##### -->
 251 <para>
 252 AccessibleDeviceEvent is a struct which encapsulates a device event.
 253 </para>
 254
 255
 256 <!-- ##### TYPEDEF AccessibleDeviceEventMask ##### -->
 257 <para>
 258 AccessibleDeviceEventMask is a set of types of key events. It is used
 259 in SPI_registerDeviceEventListener to specify the events to be listener for.
 260 </para>
 261
 262
 263 <!-- ##### ENUM AccessibleDeviceEventType ##### -->
 264 <para>
 265
 266 </para>
 267
 268 @SPI_KEY_PRESSED:
 269 @SPI_KEY_RELEASED:
 270 @SPI_BUTTON_PRESSED:
 271 @SPI_BUTTON_RELEASED:
 272
 273 <!-- ##### USER_FUNCTION AccessibleDeviceListenerCB ##### -->
 274 <para>
 275 This is a function which is specified when creating a DeviceListener.
 276 It is called when an event being listened for occurs.
 277 </para>
 278
 279 @stroke:
 280 @user_data:
 281 @Returns:
 282
 283
 284 <!-- ##### FUNCTION SPI_createAccessibleDeviceListener ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @callback:
 290 @user_data:
 291 @Returns:
 292
 293
 294 <!-- ##### FUNCTION SPI_registerDeviceEventListener ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @listener:
 300 @eventmask:
 301 @filter:
 302 @Returns:
 303
 304
 305 <!-- ##### FUNCTION SPI_deregisterDeviceEventListener ##### -->
 306 <para>
 307
 308 </para>
 309
 310 @listener:
 311 @filter:
 312 @Returns:
 313
 314
 315 <!-- ##### FUNCTION AccessibleDeviceListener_addCallback ##### -->
 316 <para>
 317
 318 </para>
 319
 320 @listener:
 321 @callback:
 322 @user_data:
 323 @Returns:
 324
 325
 326 <!-- ##### FUNCTION AccessibleDeviceListener_removeCallback ##### -->
 327 <para>
 328
 329 </para>
 330
 331 @listener:
 332 @callback:
 333 @Returns:
 334
 335
 336 <!-- ##### FUNCTION AccessibleDeviceListener_unref ##### -->
 337 <para>
 338
 339 </para>
 340
 341 @listener:
 342
 343