summaryrefslogtreecommitdiff
path: root/docs/reference/cspi/tmpl/spi_registry.sgml
blob: 458a96171a3d19154d25a03abcfb964dae5f713f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
<!-- ##### SECTION Title ##### -->
Registry queries

<!-- ##### SECTION Short_Description ##### -->


<!-- ##### SECTION Long_Description ##### -->
<para>

</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### ENUM AccessibleKeySynthType ##### -->
<para>

</para>

@SPI_KEY_PRESS: 
@SPI_KEY_RELEASE: 
@SPI_KEY_PRESSRELEASE: 
@SPI_KEY_SYM: 
@SPI_KEY_STRING: 

<!-- ##### FUNCTION SPI_getDesktopCount ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION SPI_getDesktop ##### -->
<para>

</para>

@i: 
@Returns: 


<!-- ##### FUNCTION SPI_getDesktopList ##### -->
<para>

</para>

@desktop_list: 
@Returns: 


<!-- ##### FUNCTION SPI_freeDesktopList ##### -->
<para>

</para>

@desktop_list: 


<!-- ##### USER_FUNCTION AccessibleKeystrokeListenerCB ##### -->
<para>
This is a function which is specified when creating a KeystrokeListener.
It is called when an event being listened for occurs. 
If it returns TRUE, this indicates that the event should be consumed 
rather than passed through; only callbacks whose listeners are
registered with the SPI_KEYLISTENER_ALL_WINDOWS or 
SPI_KEYLISTENER_CANCONSUME flags can be consumed.
</para>

@stroke: 
@user_data: 
@Returns: 


<!-- ##### TYPEDEF AccessibleKeyEventMask ##### -->
<para>
AccessibleKeyEventMask is a set of types of key events. It is used 
in SPI_registerAccessibleKeystroketListener to specify the events to be 
listener for.
</para>


<!-- ##### TYPEDEF AccessibleModifierMaskType ##### -->
<para>
AccessibleModifierMaskType is a synonym for AccessibleKeymaskType.
The defined values for AccessibleModifierMaskType can be found in
libspi/keymasks.h.
</para>


<!-- ##### TYPEDEF AccessibleKeyMaskType ##### -->
<para>

</para>


<!-- ##### TYPEDEF AccessibleKeyEventType ##### -->
<para>

</para>


<!-- ##### ENUM AccessibleKeyListenerSyncType ##### -->
<para>

</para>

@SPI_KEYLISTENER_NOSYNC: 
@SPI_KEYLISTENER_SYNCHRONOUS: 
@SPI_KEYLISTENER_CANCONSUME: 
@SPI_KEYLISTENER_ALL_WINDOWS: 

<!-- ##### TYPEDEF AccessibleKeystroke ##### -->
<para>
This is a synonym for AccessibleDeviceEvent.
</para>


<!-- ##### FUNCTION SPI_createAccessibleKeySet ##### -->
<para>

</para>

@len: 
@keysyms: 
@keycodes: 
@keystrings: 
@Returns: 


<!-- ##### FUNCTION SPI_freeAccessibleKeySet ##### -->
<para>

</para>

@keyset: 


<!-- ##### FUNCTION SPI_createAccessibleKeystrokeListener ##### -->
<para>

</para>

@callback: 
@user_data: 
@Returns: 


<!-- ##### FUNCTION SPI_registerGlobalEventListener ##### -->
<para>

</para>

@listener: 
@eventType: 
@Returns: 


<!-- ##### FUNCTION SPI_deregisterGlobalEventListener ##### -->
<para>

</para>

@listener: 
@eventType: 
@Returns: 


<!-- ##### FUNCTION SPI_deregisterGlobalEventListenerAll ##### -->
<para>

</para>

@listener: 
@Returns: 


<!-- ##### FUNCTION SPI_registerAccessibleKeystrokeListener ##### -->
<para>

</para>

@listener: 
@keys: 
@modmask: 
@eventmask: 
@sync_type: 
@Returns: 


<!-- ##### FUNCTION SPI_deregisterAccessibleKeystrokeListener ##### -->
<para>

</para>

@listener: 
@modmask: 
@Returns: 


<!-- ##### FUNCTION AccessibleKeystrokeListener_unref ##### -->
<para>

</para>

@listener: 


<!-- ##### FUNCTION AccessibleKeystrokeListener_removeCallback ##### -->
<para>

</para>

@listener: 
@callback: 
@Returns: 


<!-- ##### FUNCTION AccessibleKeystrokeListener_addCallback ##### -->
<para>

</para>

@listener: 
@callback: 
@user_data: 
@Returns: 


<!-- ##### FUNCTION SPI_generateKeyboardEvent ##### -->
<para>

</para>

@keyval: 
@keystring: 
@synth_type: 
@Returns: 


<!-- ##### FUNCTION SPI_generateMouseEvent ##### -->
<para>

</para>

@x: 
@y: 
@name: 
@Returns: 


<!-- ##### STRUCT AccessibleDeviceEvent ##### -->
<para>
AccessibleDeviceEvent is a struct which encapsulates a device event.
</para>

@keystring: 
@type: 
@is_text: 

<!-- ##### TYPEDEF AccessibleDeviceEventMask ##### -->
<para>
AccessibleDeviceEventMask is a set of types of key events. It is used 
in SPI_registerDeviceEventListener to specify the events to be listener for.
</para>


<!-- ##### ENUM AccessibleDeviceEventType ##### -->
<para>

</para>

@SPI_KEY_PRESSED: 
@SPI_KEY_RELEASED: 
@SPI_BUTTON_PRESSED: 
@SPI_BUTTON_RELEASED: 

<!-- ##### USER_FUNCTION AccessibleDeviceListenerCB ##### -->
<para>
This is a function which is specified when creating a DeviceListener.
It is called when an event being listened for occurs. 
</para>

@stroke: 
@user_data: 
@Returns: 


<!-- ##### FUNCTION SPI_createAccessibleDeviceListener ##### -->
<para>

</para>

@callback: 
@user_data: 
@Returns: 


<!-- ##### FUNCTION SPI_registerDeviceEventListener ##### -->
<para>

</para>

@listener: 
@eventmask: 
@filter: 
@Returns: 


<!-- ##### FUNCTION SPI_deregisterDeviceEventListener ##### -->
<para>

</para>

@listener: 
@filter: 
@Returns: 


<!-- ##### FUNCTION AccessibleDeviceListener_addCallback ##### -->
<para>

</para>

@listener: 
@callback: 
@user_data: 
@Returns: 


<!-- ##### FUNCTION AccessibleDeviceListener_removeCallback ##### -->
<para>

</para>

@listener: 
@callback: 
@Returns: 


<!-- ##### FUNCTION AccessibleDeviceListener_unref ##### -->
<para>

</para>

@listener: