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