1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>atspi-registry: libatspi Reference Manual</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
<link rel="home" href="index.html" title="libatspi Reference Manual">
8
<link rel="up" href="ch01.html" title="API reference">
9
<link rel="prev" href="libatspi-atspi-component.html" title="atspi-component">
10
<link rel="next" href="libatspi-atspi-types.html" title="atspi-types">
11
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
18
<a href="#libatspi-atspi-registry.description" class="shortcut">Description</a></span>
20
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22
<td><a accesskey="p" href="libatspi-atspi-component.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23
<td><a accesskey="n" href="libatspi-atspi-types.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25
<div class="refentry">
26
<a name="libatspi-atspi-registry"></a><div class="titlepage"></div>
27
<div class="refnamediv"><table width="100%"><tr>
29
<h2><span class="refentrytitle"><a name="libatspi-atspi-registry.top_of_page"></a>atspi-registry</span></h2>
30
<p>atspi-registry — A service through which applications providing accessibility services
31
can rendezvous with consumers of those services.</p>
33
<td class="gallery_image" valign="top" align="right"></td>
35
<div class="refsect1">
36
<a name="libatspi-atspi-registry.functions"></a><h2>Functions</h2>
37
<div class="informaltable"><table width="100%" border="0">
39
<col width="150px" class="functions_return">
40
<col class="functions_name">
44
<td class="function_type">
45
<span class="returnvalue">GType</span>
47
<td class="function_name">
48
<a class="link" href="libatspi-atspi-registry.html#atspi-key-definition-get-type" title="atspi_key_definition_get_type ()">atspi_key_definition_get_type</a> <span class="c_punctuation">()</span>
52
<td class="function_type">
53
<span class="returnvalue">gint</span>
55
<td class="function_name">
56
<a class="link" href="libatspi-atspi-registry.html#atspi-get-desktop-count" title="atspi_get_desktop_count ()">atspi_get_desktop_count</a> <span class="c_punctuation">()</span>
60
<td class="function_type">
61
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
63
<td class="function_name">
64
<a class="link" href="libatspi-atspi-registry.html#atspi-get-desktop" title="atspi_get_desktop ()">atspi_get_desktop</a> <span class="c_punctuation">()</span>
68
<td class="function_type">
69
<span class="returnvalue">GArray</span> *
71
<td class="function_name">
72
<a class="link" href="libatspi-atspi-registry.html#atspi-get-desktop-list" title="atspi_get_desktop_list ()">atspi_get_desktop_list</a> <span class="c_punctuation">()</span>
76
<td class="function_type">
77
<span class="returnvalue">gboolean</span>
79
<td class="function_name">
80
<a class="link" href="libatspi-atspi-registry.html#atspi-register-keystroke-listener" title="atspi_register_keystroke_listener ()">atspi_register_keystroke_listener</a> <span class="c_punctuation">()</span>
84
<td class="function_type">
85
<span class="returnvalue">gboolean</span>
87
<td class="function_name">
88
<a class="link" href="libatspi-atspi-registry.html#atspi-deregister-keystroke-listener" title="atspi_deregister_keystroke_listener ()">atspi_deregister_keystroke_listener</a> <span class="c_punctuation">()</span>
92
<td class="function_type">
93
<span class="returnvalue">gboolean</span>
95
<td class="function_name">
96
<a class="link" href="libatspi-atspi-registry.html#atspi-register-device-event-listener" title="atspi_register_device_event_listener ()">atspi_register_device_event_listener</a> <span class="c_punctuation">()</span>
100
<td class="function_type">
101
<span class="returnvalue">gboolean</span>
103
<td class="function_name">
104
<a class="link" href="libatspi-atspi-registry.html#atspi-deregister-device-event-listener" title="atspi_deregister_device_event_listener ()">atspi_deregister_device_event_listener</a> <span class="c_punctuation">()</span>
108
<td class="function_type">
109
<span class="returnvalue">gboolean</span>
111
<td class="function_name">
112
<a class="link" href="libatspi-atspi-registry.html#atspi-generate-keyboard-event" title="atspi_generate_keyboard_event ()">atspi_generate_keyboard_event</a> <span class="c_punctuation">()</span>
116
<td class="function_type">
117
<span class="returnvalue">gboolean</span>
119
<td class="function_name">
120
<a class="link" href="libatspi-atspi-registry.html#atspi-generate-mouse-event" title="atspi_generate_mouse_event ()">atspi_generate_mouse_event</a> <span class="c_punctuation">()</span>
126
<div class="refsect1">
127
<a name="libatspi-atspi-registry.description"></a><h2>Description</h2>
129
A service through which applications providing accessibility services (servers)
130
can rendezvous with consumers of those services (Assistive Technologies). The
131
atspi-registry is the first "port of call" for accessible applications and for
132
assistive technologies wishing to query and interact with those applications.
135
<div class="refsect1">
136
<a name="libatspi-atspi-registry.functions_details"></a><h2>Functions</h2>
137
<div class="refsect2">
138
<a name="atspi-key-definition-get-type"></a><h3>atspi_key_definition_get_type ()</h3>
139
<pre class="programlisting"><span class="returnvalue">GType</span>
140
atspi_key_definition_get_type ();</pre>
145
<div class="refsect2">
146
<a name="atspi-get-desktop-count"></a><h3>atspi_get_desktop_count ()</h3>
147
<pre class="programlisting"><span class="returnvalue">gint</span>
148
atspi_get_desktop_count ();</pre>
149
<p>Gets the number of virtual desktops.
150
NOTE: multiple virtual desktops are not implemented yet; as a
151
consequence, this function always returns 1.</p>
152
<div class="refsect3">
153
<a name="id-1.2.23.5.3.5"></a><h4>Returns</h4>
154
<p> a <span class="type">gint</span> indicating the number of active virtual desktops.</p>
158
<div class="refsect2">
159
<a name="atspi-get-desktop"></a><h3>atspi_get_desktop ()</h3>
160
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
161
atspi_get_desktop (<em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
162
<p>Gets the virtual desktop indicated by index <em class="parameter"><code>i</code></em>
164
NOTE: currently multiple virtual desktops are not implemented;
165
as a consequence, any <em class="parameter"><code>i</code></em>
166
value different from 0 will not return a
167
virtual desktop - instead it will return NULL.</p>
168
<div class="refsect3">
169
<a name="id-1.2.23.5.4.5"></a><h4>Parameters</h4>
170
<div class="informaltable"><table width="100%" border="0">
172
<col width="150px" class="parameters_name">
173
<col class="parameters_description">
174
<col width="200px" class="parameters_annotations">
177
<td class="parameter_name"><p>i</p></td>
178
<td class="parameter_description"><p>a <span class="type">gint</span> indicating which of the accessible desktops is to be returned.</p></td>
179
<td class="parameter_annotations"> </td>
183
<div class="refsect3">
184
<a name="id-1.2.23.5.4.6"></a><h4>Returns</h4>
185
<p> a pointer to the <em class="parameter"><code>i</code></em>
186
-th virtual desktop's
187
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> representation. </p>
188
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
192
<div class="refsect2">
193
<a name="atspi-get-desktop-list"></a><h3>atspi_get_desktop_list ()</h3>
194
<pre class="programlisting"><span class="returnvalue">GArray</span> *
195
atspi_get_desktop_list ();</pre>
196
<p>Gets the list of virtual desktops. On return, <em class="parameter"><code>list</code></em>
198
to a newly-created, NULL terminated array of virtual desktop
200
It is the responsibility of the caller to free this array when
201
it is no longer needed.
202
NOTE: currently multiple virtual desktops are not implemented;
203
this implementation always returns a <span class="type">Garray</span> with a single
204
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> desktop.</p>
205
<div class="refsect3">
206
<a name="id-1.2.23.5.5.5"></a><h4>Returns</h4>
207
<p> a <span class="type">GArray</span> of
209
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiAccessible*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
213
<div class="refsect2">
214
<a name="atspi-register-keystroke-listener"></a><h3>atspi_register_keystroke_listener ()</h3>
215
<pre class="programlisting"><span class="returnvalue">gboolean</span>
216
atspi_register_keystroke_listener (<em class="parameter"><code><a class="link" href="AtspiDeviceListener.html" title="atspi-devicelistener"><span class="type">AtspiDeviceListener</span></a> *listener</code></em>,
217
<em class="parameter"><code><span class="type">GArray</span> *key_set</code></em>,
218
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a> modmask</code></em>,
219
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiKeyEventMask" title="AtspiKeyEventMask"><span class="type">AtspiKeyEventMask</span></a> event_types</code></em>,
220
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiKeyListenerSyncType" title="enum AtspiKeyListenerSyncType"><span class="type">AtspiKeyListenerSyncType</span></a> sync_type</code></em>,
221
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
222
<p>Registers a listener for keystroke events, either pre-emptively for
223
all windows (<a class="link" href="libatspi-atspi-types.html#ATSPI-KEYLISTENER-ALL-WINDOWS:CAPS"><code class="literal">ATSPI_KEYLISTENER_ALL_WINDOWS</code></a>),
224
non-preemptively (<a class="link" href="libatspi-atspi-types.html#ATSPI-KEYLISTENER-NOSYNC:CAPS"><code class="literal">ATSPI_KEYLISTENER_NOSYNC</code></a>), or
225
pre-emptively at the toolkit level (<a class="link" href="libatspi-atspi-types.html#ATSPI-KEYLISTENER-CANCONSUME:CAPS"><code class="literal">ATSPI_KEYLISTENER_CANCONSUME</code></a>).
226
If ALL_WINDOWS or CANCONSUME are used, the event is consumed
227
upon receipt if one of <em class="parameter"><code>listener</code></em>
228
's callbacks returns <code class="literal">TRUE</code>
229
(other sync_type values may be available in the future).</p>
230
<div class="refsect3">
231
<a name="id-1.2.23.5.6.5"></a><h4>Parameters</h4>
232
<div class="informaltable"><table width="100%" border="0">
234
<col width="150px" class="parameters_name">
235
<col class="parameters_description">
236
<col width="200px" class="parameters_annotations">
240
<td class="parameter_name"><p>listener</p></td>
241
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiDeviceListener.html" title="atspi-devicelistener"><span class="type">AtspiDeviceListener</span></a> for which
242
keystroke events are requested.</p></td>
243
<td class="parameter_annotations"> </td>
246
<td class="parameter_name"><p>key_set</p></td>
247
<td class="parameter_description"><p> a pointer to the
248
<a class="link" href="libatspi-atspi-types.html#AtspiKeyDefinition"><span class="type">AtspiKeyDefinition</span></a> array indicating which keystroke events are
250
to indicate that all keycodes and keyvals for the specified
251
modifier set are to be included. </p></td>
252
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiKeyDefinition][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
255
<td class="parameter_name"><p>modmask</p></td>
256
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a> mask indicating which
257
key event modifiers must be set in combination with <em class="parameter"><code>keys</code></em>
259
events will only be reported for key events for which all
260
modifiers in <em class="parameter"><code>modmask</code></em>
261
are set. If you wish to listen for
262
events with multiple modifier combinations, you must call
263
<a class="link" href="libatspi-atspi-registry.html#atspi-register-keystroke-listener" title="atspi_register_keystroke_listener ()"><span class="type">atspi_register_keystroke_listener</span></a> once for each
264
combination.</p></td>
265
<td class="parameter_annotations"> </td>
268
<td class="parameter_name"><p>event_types</p></td>
269
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a> mask indicating which
270
types of key events are requested (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-PRESSED:CAPS"><code class="literal">ATSPI_KEY_PRESSED</code></a> etc.).</p></td>
271
<td class="parameter_annotations"> </td>
274
<td class="parameter_name"><p>sync_type</p></td>
275
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-types.html#AtspiKeyListenerSyncType" title="enum AtspiKeyListenerSyncType"><span class="type">AtspiKeyListenerSyncType</span></a> parameter indicating
276
the behavior of the notification/listener transaction.</p></td>
277
<td class="parameter_annotations"> </td>
280
<td class="parameter_name"><p>error</p></td>
281
<td class="parameter_description"><p> a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
282
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
287
<div class="refsect3">
288
<a name="id-1.2.23.5.6.6"></a><h4>Returns</h4>
289
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
293
<div class="refsect2">
294
<a name="atspi-deregister-keystroke-listener"></a><h3>atspi_deregister_keystroke_listener ()</h3>
295
<pre class="programlisting"><span class="returnvalue">gboolean</span>
296
atspi_deregister_keystroke_listener (<em class="parameter"><code><a class="link" href="AtspiDeviceListener.html" title="atspi-devicelistener"><span class="type">AtspiDeviceListener</span></a> *listener</code></em>,
297
<em class="parameter"><code><span class="type">GArray</span> *key_set</code></em>,
298
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a> modmask</code></em>,
299
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiKeyEventMask" title="AtspiKeyEventMask"><span class="type">AtspiKeyEventMask</span></a> event_types</code></em>,
300
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
301
<p>Removes a keystroke event listener from the registry's listener queue,
302
ceasing notification of events with modifiers matching <em class="parameter"><code>modmask</code></em>
304
<div class="refsect3">
305
<a name="id-1.2.23.5.7.5"></a><h4>Parameters</h4>
306
<div class="informaltable"><table width="100%" border="0">
308
<col width="150px" class="parameters_name">
309
<col class="parameters_description">
310
<col width="200px" class="parameters_annotations">
314
<td class="parameter_name"><p>listener</p></td>
315
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiDeviceListener.html" title="atspi-devicelistener"><span class="type">AtspiDeviceListener</span></a> for which
316
keystroke events are requested.</p></td>
317
<td class="parameter_annotations"> </td>
320
<td class="parameter_name"><p>key_set</p></td>
321
<td class="parameter_description"><p> a pointer to the
322
<a class="link" href="libatspi-atspi-types.html#AtspiKeyDefinition"><span class="type">AtspiKeyDefinition</span></a> array indicating which keystroke events are
323
requested, or <code class="literal">NULL</code>
324
to indicate that all keycodes and keyvals for the specified
325
modifier set are to be included. </p></td>
326
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiKeyDefinition][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
329
<td class="parameter_name"><p>modmask</p></td>
330
<td class="parameter_description"><p>the key modifier mask for which this listener is to be
331
'deregistered' (of type <a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a>).</p></td>
332
<td class="parameter_annotations"> </td>
335
<td class="parameter_name"><p>event_types</p></td>
336
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-types.html#AtspiKeyMaskType" title="AtspiKeyMaskType"><span class="type">AtspiKeyMaskType</span></a> mask indicating which
337
types of key events were requested (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-PRESSED:CAPS"><code class="literal">ATSPI_KEY_PRESSED</code></a>, etc.).</p></td>
338
<td class="parameter_annotations"> </td>
341
<td class="parameter_name"><p>error</p></td>
342
<td class="parameter_description"><p> a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
343
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
348
<div class="refsect3">
349
<a name="id-1.2.23.5.7.6"></a><h4>Returns</h4>
350
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
354
<div class="refsect2">
355
<a name="atspi-register-device-event-listener"></a><h3>atspi_register_device_event_listener ()</h3>
356
<pre class="programlisting"><span class="returnvalue">gboolean</span>
357
atspi_register_device_event_listener (<em class="parameter"><code><a class="link" href="AtspiDeviceListener.html" title="atspi-devicelistener"><span class="type">AtspiDeviceListener</span></a> *listener</code></em>,
358
<em class="parameter"><code><a class="link" href="libatspi-atspi-types.html#AtspiDeviceEventMask" title="AtspiDeviceEventMask"><span class="type">AtspiDeviceEventMask</span></a> event_types</code></em>,
359
<em class="parameter"><code><span class="type">void</span> *filter</code></em>,
360
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
361
<p>Registers a listener for device events, for instance button events.</p>
362
<div class="refsect3">
363
<a name="id-1.2.23.5.8.5"></a><h4>Parameters</h4>
364
<div class="informaltable"><table width="100%" border="0">
366
<col width="150px" class="parameters_name">
367
<col class="parameters_description">
368
<col width="200px" class="parameters_annotations">
372
<td class="parameter_name"><p>listener</p></td>
373
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiDeviceListener.html" title="atspi-devicelistener"><span class="type">AtspiDeviceListener</span></a> which requests
375
<td class="parameter_annotations"> </td>
378
<td class="parameter_name"><p>event_types</p></td>
379
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-types.html#AtspiDeviceEventMask" title="AtspiDeviceEventMask"><span class="type">AtspiDeviceEventMask</span></a> mask indicating which
380
types of key events are requested (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-PRESSED:CAPS"><code class="literal">ATSPI_KEY_PRESSED</code></a>, etc.).</p></td>
381
<td class="parameter_annotations"> </td>
384
<td class="parameter_name"><p>filter</p></td>
385
<td class="parameter_description"><p> Unused parameter. </p></td>
386
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
389
<td class="parameter_name"><p>error</p></td>
390
<td class="parameter_description"><p> a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
391
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
396
<div class="refsect3">
397
<a name="id-1.2.23.5.8.6"></a><h4>Returns</h4>
398
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
402
<div class="refsect2">
403
<a name="atspi-deregister-device-event-listener"></a><h3>atspi_deregister_device_event_listener ()</h3>
404
<pre class="programlisting"><span class="returnvalue">gboolean</span>
405
atspi_deregister_device_event_listener
406
(<em class="parameter"><code><a class="link" href="AtspiDeviceListener.html" title="atspi-devicelistener"><span class="type">AtspiDeviceListener</span></a> *listener</code></em>,
407
<em class="parameter"><code><span class="type">void</span> *filter</code></em>,
408
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
409
<p>Removes a device event listener from the registry's listener queue,
410
ceasing notification of events of the specified type.</p>
411
<div class="refsect3">
412
<a name="id-1.2.23.5.9.5"></a><h4>Parameters</h4>
413
<div class="informaltable"><table width="100%" border="0">
415
<col width="150px" class="parameters_name">
416
<col class="parameters_description">
417
<col width="200px" class="parameters_annotations">
421
<td class="parameter_name"><p>listener</p></td>
422
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiDeviceListener.html" title="atspi-devicelistener"><span class="type">AtspiDeviceListener</span></a> for which
423
device events are requested.</p></td>
424
<td class="parameter_annotations"> </td>
427
<td class="parameter_name"><p>filter</p></td>
428
<td class="parameter_description"><p> Unused parameter. </p></td>
429
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
432
<td class="parameter_name"><p>error</p></td>
433
<td class="parameter_description"><p> a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
434
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
439
<div class="refsect3">
440
<a name="id-1.2.23.5.9.6"></a><h4>Returns</h4>
441
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
445
<div class="refsect2">
446
<a name="atspi-generate-keyboard-event"></a><h3>atspi_generate_keyboard_event ()</h3>
447
<pre class="programlisting"><span class="returnvalue">gboolean</span>
448
atspi_generate_keyboard_event (<em class="parameter"><code><span class="type">glong</span> keyval</code></em>,
449
<em class="parameter"><code>const <span class="type">gchar</span> *keystring</code></em>,
450
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiKeySynthType" title="enum AtspiKeySynthType"><span class="type">AtspiKeySynthType</span></a> synth_type</code></em>,
451
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
452
<p>Synthesizes a keyboard event (as if a hardware keyboard event occurred in the
453
current UI context).</p>
454
<div class="refsect3">
455
<a name="id-1.2.23.5.10.5"></a><h4>Parameters</h4>
456
<div class="informaltable"><table width="100%" border="0">
458
<col width="150px" class="parameters_name">
459
<col class="parameters_description">
460
<col width="200px" class="parameters_annotations">
464
<td class="parameter_name"><p>keyval</p></td>
465
<td class="parameter_description"><p>a <span class="type">gint</span> indicating the keycode or keysym of the key event
466
being synthesized.</p></td>
467
<td class="parameter_annotations"> </td>
470
<td class="parameter_name"><p>keystring</p></td>
471
<td class="parameter_description"><p> an (optional) UTF-8 string which, if
472
<em class="parameter"><code>synth_type</code></em>
473
is <a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-STRING:CAPS"><code class="literal">ATSPI_KEY_STRING</code></a>, indicates a 'composed'
474
keyboard input string being synthesized; this type of
475
keyboard event synthesis does not emulate hardware
476
keypresses but injects the string as though a composing
477
input method (such as XIM) were used. </p></td>
478
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
481
<td class="parameter_name"><p>synth_type</p></td>
482
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-constants.html#AtspiKeySynthType" title="enum AtspiKeySynthType"><span class="type">AtspiKeySynthType</span></a> flag indicating whether <em class="parameter"><code>keyval</code></em>
483
is to be interpreted as a keysym rather than a keycode
484
(<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-SYM:CAPS"><code class="literal">ATSPI_KEY_SYM</code></a>) or a string (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-STRING:CAPS"><code class="literal">ATSPI_KEY_STRING</code></a>), or
485
whether to synthesize <a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-PRESS:CAPS"><code class="literal">ATSPI_KEY_PRESS</code></a>,
486
<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-RELEASE:CAPS"><code class="literal">ATSPI_KEY_RELEASE</code></a>, or both (<a class="link" href="libatspi-atspi-constants.html#ATSPI-KEY-PRESSRELEASE:CAPS"><code class="literal">ATSPI_KEY_PRESSRELEASE</code></a>).</p></td>
487
<td class="parameter_annotations"> </td>
490
<td class="parameter_name"><p>error</p></td>
491
<td class="parameter_description"><p> a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
492
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
497
<div class="refsect3">
498
<a name="id-1.2.23.5.10.6"></a><h4>Returns</h4>
499
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
503
<div class="refsect2">
504
<a name="atspi-generate-mouse-event"></a><h3>atspi_generate_mouse_event ()</h3>
505
<pre class="programlisting"><span class="returnvalue">gboolean</span>
506
atspi_generate_mouse_event (<em class="parameter"><code><span class="type">glong</span> x</code></em>,
507
<em class="parameter"><code><span class="type">glong</span> y</code></em>,
508
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
509
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
510
<p>Synthesizes a mouse event at a specific screen coordinate.
511
Most AT clients should use the <span class="type">AccessibleAction</span> interface when
512
tempted to generate mouse events, rather than this method.
513
Event names: b1p = button 1 press; b2r = button 2 release;
514
b3c = button 3 click; b2d = button 2 double-click;
515
abs = absolute motion; rel = relative motion.</p>
516
<div class="refsect3">
517
<a name="id-1.2.23.5.11.5"></a><h4>Parameters</h4>
518
<div class="informaltable"><table width="100%" border="0">
520
<col width="150px" class="parameters_name">
521
<col class="parameters_description">
522
<col width="200px" class="parameters_annotations">
526
<td class="parameter_name"><p>x</p></td>
527
<td class="parameter_description"><p>a <span class="type">glong</span> indicating the screen x coordinate of the mouse event.</p></td>
528
<td class="parameter_annotations"> </td>
531
<td class="parameter_name"><p>y</p></td>
532
<td class="parameter_description"><p>a <span class="type">glong</span> indicating the screen y coordinate of the mouse event.</p></td>
533
<td class="parameter_annotations"> </td>
536
<td class="parameter_name"><p>name</p></td>
537
<td class="parameter_description"><p>a string indicating which mouse event to be synthesized
538
(e.g. "b1p", "b1c", "b2r", "rel", "abs").</p></td>
539
<td class="parameter_annotations"> </td>
542
<td class="parameter_name"><p>error</p></td>
543
<td class="parameter_description"><p> a pointer to a <code class="literal">NULL</code> <span class="type">GError</span> pointer, or <code class="literal">NULL</code>. </p></td>
544
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
549
<div class="refsect3">
550
<a name="id-1.2.23.5.11.6"></a><h4>Returns</h4>
551
<p> <code class="literal">TRUE</code> if successful, otherwise <code class="literal">FALSE</code>.</p>
555
<div class="refsect1">
556
<a name="libatspi-atspi-registry.other_details"></a><h2>Types and Values</h2>
560
<hr>Generated by GTK-Doc V1.24.1</div>
b'\\ No newline at end of file'
added
removed
doc/libatspi/html/libatspi-atspi-registry.html
