~elementary-os/elementaryos/os-patch-at-spi2-core-xenial

« back to all changes in this revision

Viewing changes to doc/libatspi/html/AtspiAccessible.html

  • Committer: RabbitBot
  • Date: 2016-11-16 09:38:52 UTC
  • Revision ID: rabbitbot@elementary.io-20161116093852-xn6hcgpg5y25xooo
Initial import, version 2.18.3-4ubuntu1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>AtspiAccessible: 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="AtspiObject.html" title="AtspiObject">
 
10
<link rel="next" href="AtspiDeviceListener.html" title="atspi-devicelistener">
 
11
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
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="#AtspiAccessible.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
 
19
                  <a href="#AtspiAccessible.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
 
20
                  <a href="#AtspiAccessible.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
 
21
</td>
 
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
23
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
24
<td><a accesskey="p" href="AtspiObject.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
25
<td><a accesskey="n" href="AtspiDeviceListener.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
26
</tr></table>
 
27
<div class="refentry">
 
28
<a name="AtspiAccessible"></a><div class="titlepage"></div>
 
29
<div class="refnamediv"><table width="100%"><tr>
 
30
<td valign="top">
 
31
<h2><span class="refentrytitle"><a name="AtspiAccessible.top_of_page"></a>AtspiAccessible</span></h2>
 
32
<p>AtspiAccessible — The base interface which is implemented by all accessible objects.</p>
 
33
</td>
 
34
<td class="gallery_image" valign="top" align="right"></td>
 
35
</tr></table></div>
 
36
<div class="refsect1">
 
37
<a name="AtspiAccessible.functions"></a><h2>Functions</h2>
 
38
<div class="informaltable"><table width="100%" border="0">
 
39
<colgroup>
 
40
<col width="150px" class="functions_return">
 
41
<col class="functions_name">
 
42
</colgroup>
 
43
<tbody>
 
44
<tr>
 
45
<td class="function_type">
 
46
<span class="returnvalue">gchar</span> *
 
47
</td>
 
48
<td class="function_name">
 
49
<a class="link" href="AtspiAccessible.html#atspi-role-get-name" title="atspi_role_get_name ()">atspi_role_get_name</a> <span class="c_punctuation">()</span>
 
50
</td>
 
51
</tr>
 
52
<tr>
 
53
<td class="function_type">
 
54
<span class="returnvalue">gchar</span> *
 
55
</td>
 
56
<td class="function_name">
 
57
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-name" title="atspi_accessible_get_name ()">atspi_accessible_get_name</a> <span class="c_punctuation">()</span>
 
58
</td>
 
59
</tr>
 
60
<tr>
 
61
<td class="function_type">
 
62
<span class="returnvalue">gchar</span> *
 
63
</td>
 
64
<td class="function_name">
 
65
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-description" title="atspi_accessible_get_description ()">atspi_accessible_get_description</a> <span class="c_punctuation">()</span>
 
66
</td>
 
67
</tr>
 
68
<tr>
 
69
<td class="function_type">
 
70
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
 
71
</td>
 
72
<td class="function_name">
 
73
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-parent" title="atspi_accessible_get_parent ()">atspi_accessible_get_parent</a> <span class="c_punctuation">()</span>
 
74
</td>
 
75
</tr>
 
76
<tr>
 
77
<td class="function_type">
 
78
<span class="returnvalue">gint</span>
 
79
</td>
 
80
<td class="function_name">
 
81
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-child-count" title="atspi_accessible_get_child_count ()">atspi_accessible_get_child_count</a> <span class="c_punctuation">()</span>
 
82
</td>
 
83
</tr>
 
84
<tr>
 
85
<td class="function_type">
 
86
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
 
87
</td>
 
88
<td class="function_name">
 
89
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-child-at-index" title="atspi_accessible_get_child_at_index ()">atspi_accessible_get_child_at_index</a> <span class="c_punctuation">()</span>
 
90
</td>
 
91
</tr>
 
92
<tr>
 
93
<td class="function_type">
 
94
<span class="returnvalue">gint</span>
 
95
</td>
 
96
<td class="function_name">
 
97
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-index-in-parent" title="atspi_accessible_get_index_in_parent ()">atspi_accessible_get_index_in_parent</a> <span class="c_punctuation">()</span>
 
98
</td>
 
99
</tr>
 
100
<tr>
 
101
<td class="function_type">
 
102
<span class="returnvalue">GArray</span> *
 
103
</td>
 
104
<td class="function_name">
 
105
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-relation-set" title="atspi_accessible_get_relation_set ()">atspi_accessible_get_relation_set</a> <span class="c_punctuation">()</span>
 
106
</td>
 
107
</tr>
 
108
<tr>
 
109
<td class="function_type">
 
110
<a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole"><span class="returnvalue">AtspiRole</span></a>
 
111
</td>
 
112
<td class="function_name">
 
113
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-role" title="atspi_accessible_get_role ()">atspi_accessible_get_role</a> <span class="c_punctuation">()</span>
 
114
</td>
 
115
</tr>
 
116
<tr>
 
117
<td class="function_type">
 
118
<span class="returnvalue">gchar</span> *
 
119
</td>
 
120
<td class="function_name">
 
121
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-role-name" title="atspi_accessible_get_role_name ()">atspi_accessible_get_role_name</a> <span class="c_punctuation">()</span>
 
122
</td>
 
123
</tr>
 
124
<tr>
 
125
<td class="function_type">
 
126
<span class="returnvalue">gchar</span> *
 
127
</td>
 
128
<td class="function_name">
 
129
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-localized-role-name" title="atspi_accessible_get_localized_role_name ()">atspi_accessible_get_localized_role_name</a> <span class="c_punctuation">()</span>
 
130
</td>
 
131
</tr>
 
132
<tr>
 
133
<td class="function_type">
 
134
<a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="returnvalue">AtspiStateSet</span></a> *
 
135
</td>
 
136
<td class="function_name">
 
137
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-state-set" title="atspi_accessible_get_state_set ()">atspi_accessible_get_state_set</a> <span class="c_punctuation">()</span>
 
138
</td>
 
139
</tr>
 
140
<tr>
 
141
<td class="function_type">
 
142
<span class="returnvalue">GHashTable</span> *
 
143
</td>
 
144
<td class="function_name">
 
145
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-attributes" title="atspi_accessible_get_attributes ()">atspi_accessible_get_attributes</a> <span class="c_punctuation">()</span>
 
146
</td>
 
147
</tr>
 
148
<tr>
 
149
<td class="function_type">
 
150
<span class="returnvalue">GArray</span> *
 
151
</td>
 
152
<td class="function_name">
 
153
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-attributes-as-array" title="atspi_accessible_get_attributes_as_array ()">atspi_accessible_get_attributes_as_array</a> <span class="c_punctuation">()</span>
 
154
</td>
 
155
</tr>
 
156
<tr>
 
157
<td class="function_type">
 
158
<span class="returnvalue">gchar</span> *
 
159
</td>
 
160
<td class="function_name">
 
161
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-toolkit-name" title="atspi_accessible_get_toolkit_name ()">atspi_accessible_get_toolkit_name</a> <span class="c_punctuation">()</span>
 
162
</td>
 
163
</tr>
 
164
<tr>
 
165
<td class="function_type">
 
166
<span class="returnvalue">gchar</span> *
 
167
</td>
 
168
<td class="function_name">
 
169
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-toolkit-version" title="atspi_accessible_get_toolkit_version ()">atspi_accessible_get_toolkit_version</a> <span class="c_punctuation">()</span>
 
170
</td>
 
171
</tr>
 
172
<tr>
 
173
<td class="function_type">
 
174
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
 
175
</td>
 
176
<td class="function_name">
 
177
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-application" title="atspi_accessible_get_application ()">atspi_accessible_get_application</a> <span class="c_punctuation">()</span>
 
178
</td>
 
179
</tr>
 
180
<tr>
 
181
<td class="function_type">
 
182
<a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="returnvalue">AtspiAction</span></a> *
 
183
</td>
 
184
<td class="function_name">
 
185
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-action" title="atspi_accessible_get_action ()">atspi_accessible_get_action</a> <span class="c_punctuation">()</span>
 
186
</td>
 
187
</tr>
 
188
<tr>
 
189
<td class="function_type">
 
190
<a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="returnvalue">AtspiCollection</span></a> *
 
191
</td>
 
192
<td class="function_name">
 
193
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-collection" title="atspi_accessible_get_collection ()">atspi_accessible_get_collection</a> <span class="c_punctuation">()</span>
 
194
</td>
 
195
</tr>
 
196
<tr>
 
197
<td class="function_type">
 
198
<a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="returnvalue">AtspiComponent</span></a> *
 
199
</td>
 
200
<td class="function_name">
 
201
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-component" title="atspi_accessible_get_component ()">atspi_accessible_get_component</a> <span class="c_punctuation">()</span>
 
202
</td>
 
203
</tr>
 
204
<tr>
 
205
<td class="function_type">
 
206
<a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="returnvalue">AtspiDocument</span></a> *
 
207
</td>
 
208
<td class="function_name">
 
209
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-document" title="atspi_accessible_get_document ()">atspi_accessible_get_document</a> <span class="c_punctuation">()</span>
 
210
</td>
 
211
</tr>
 
212
<tr>
 
213
<td class="function_type">
 
214
<a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="returnvalue">AtspiEditableText</span></a> *
 
215
</td>
 
216
<td class="function_name">
 
217
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-editable-text" title="atspi_accessible_get_editable_text ()">atspi_accessible_get_editable_text</a> <span class="c_punctuation">()</span>
 
218
</td>
 
219
</tr>
 
220
<tr>
 
221
<td class="function_type">
 
222
<a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="returnvalue">AtspiHyperlink</span></a> *
 
223
</td>
 
224
<td class="function_name">
 
225
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-hyperlink" title="atspi_accessible_get_hyperlink ()">atspi_accessible_get_hyperlink</a> <span class="c_punctuation">()</span>
 
226
</td>
 
227
</tr>
 
228
<tr>
 
229
<td class="function_type">
 
230
<a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="returnvalue">AtspiHypertext</span></a> *
 
231
</td>
 
232
<td class="function_name">
 
233
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-hypertext" title="atspi_accessible_get_hypertext ()">atspi_accessible_get_hypertext</a> <span class="c_punctuation">()</span>
 
234
</td>
 
235
</tr>
 
236
<tr>
 
237
<td class="function_type">
 
238
<a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="returnvalue">AtspiImage</span></a> *
 
239
</td>
 
240
<td class="function_name">
 
241
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-image" title="atspi_accessible_get_image ()">atspi_accessible_get_image</a> <span class="c_punctuation">()</span>
 
242
</td>
 
243
</tr>
 
244
<tr>
 
245
<td class="function_type">
 
246
<a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="returnvalue">AtspiSelection</span></a> *
 
247
</td>
 
248
<td class="function_name">
 
249
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-selection" title="atspi_accessible_get_selection ()">atspi_accessible_get_selection</a> <span class="c_punctuation">()</span>
 
250
</td>
 
251
</tr>
 
252
<tr>
 
253
<td class="function_type">
 
254
<a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="returnvalue">AtspiTable</span></a> *
 
255
</td>
 
256
<td class="function_name">
 
257
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-table" title="atspi_accessible_get_table ()">atspi_accessible_get_table</a> <span class="c_punctuation">()</span>
 
258
</td>
 
259
</tr>
 
260
<tr>
 
261
<td class="function_type">
 
262
<a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="returnvalue">AtspiText</span></a> *
 
263
</td>
 
264
<td class="function_name">
 
265
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-text" title="atspi_accessible_get_text ()">atspi_accessible_get_text</a> <span class="c_punctuation">()</span>
 
266
</td>
 
267
</tr>
 
268
<tr>
 
269
<td class="function_type">
 
270
<a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="returnvalue">AtspiValue</span></a> *
 
271
</td>
 
272
<td class="function_name">
 
273
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-value" title="atspi_accessible_get_value ()">atspi_accessible_get_value</a> <span class="c_punctuation">()</span>
 
274
</td>
 
275
</tr>
 
276
<tr>
 
277
<td class="function_type">
 
278
<span class="returnvalue">GArray</span> *
 
279
</td>
 
280
<td class="function_name">
 
281
<a class="link" href="AtspiAccessible.html#atspi-accessible-get-interfaces" title="atspi_accessible_get_interfaces ()">atspi_accessible_get_interfaces</a> <span class="c_punctuation">()</span>
 
282
</td>
 
283
</tr>
 
284
</tbody>
 
285
</table></div>
 
286
</div>
 
287
<div class="refsect1">
 
288
<a name="AtspiAccessible.other"></a><h2>Types and Values</h2>
 
289
<div class="informaltable"><table width="100%" border="0">
 
290
<colgroup>
 
291
<col width="150px" class="name">
 
292
<col class="description">
 
293
</colgroup>
 
294
<tbody>
 
295
<tr>
 
296
<td class="datatype_keyword"> </td>
 
297
<td class="function_name"><a class="link" href="AtspiAccessible.html#AtspiAccessible-struct" title="AtspiAccessible">AtspiAccessible</a></td>
 
298
</tr>
 
299
<tr>
 
300
<td class="datatype_keyword">struct</td>
 
301
<td class="function_name"><a class="link" href="AtspiAccessible.html#AtspiAccessibleClass" title="struct AtspiAccessibleClass">AtspiAccessibleClass</a></td>
 
302
</tr>
 
303
</tbody>
 
304
</table></div>
 
305
</div>
 
306
<div class="refsect1">
 
307
<a name="AtspiAccessible.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
308
<pre class="screen">    GObject
 
309
    <span class="lineart">╰──</span> <a class="link" href="AtspiObject.html" title="AtspiObject">AtspiObject</a>
 
310
        <span class="lineart">╰──</span> AtspiAccessible
 
311
</pre>
 
312
</div>
 
313
<div class="refsect1">
 
314
<a name="AtspiAccessible.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
315
<p>
 
316
AtspiAccessible implements
 
317
 <a class="link" href="libatspi-atspi-action.html#AtspiAction">AtspiAction</a>,  <a class="link" href="libatspi-atspi-collection.html#AtspiCollection">AtspiCollection</a>,  <a class="link" href="libatspi-atspi-component.html#AtspiComponent">AtspiComponent</a>,  <a class="link" href="libatspi-atspi-document.html#AtspiDocument">AtspiDocument</a>,  <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText">AtspiEditableText</a>,  <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext">AtspiHypertext</a>,  <a class="link" href="libatspi-atspi-image.html#AtspiImage">AtspiImage</a>,  <a class="link" href="libatspi-atspi-selection.html#AtspiSelection">AtspiSelection</a>,  <a class="link" href="libatspi-atspi-table.html#AtspiTable">AtspiTable</a>,  <a class="link" href="libatspi-atspi-table-cell.html#AtspiTableCell">AtspiTableCell</a>,  <a class="link" href="libatspi-atspi-text.html#AtspiText">AtspiText</a> and  <a class="link" href="libatspi-atspi-value.html#AtspiValue">AtspiValue</a>.</p>
 
318
</div>
 
319
<div class="refsect1">
 
320
<a name="AtspiAccessible.description"></a><h2>Description</h2>
 
321
<p>
 
322
The base interface which is implemented by all accessible objects.
 
323
All objects support interfaces for querying their contained 'children'
 
324
and position in the accessible-object hierarchy, whether or not they
 
325
actually have children.
 
326
</p>
 
327
</div>
 
328
<div class="refsect1">
 
329
<a name="AtspiAccessible.functions_details"></a><h2>Functions</h2>
 
330
<div class="refsect2">
 
331
<a name="atspi-role-get-name"></a><h3>atspi_role_get_name ()</h3>
 
332
<pre class="programlisting"><span class="returnvalue">gchar</span> *
 
333
atspi_role_get_name (<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole"><span class="type">AtspiRole</span></a> role</code></em>);</pre>
 
334
<p>Gets a localizable string that indicates the name of an <a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole"><span class="type">AtspiRole</span></a>.</p>
 
335
<span style="color: red">&lt;em&gt;DEPRECATED.&lt;/em&gt;</span><div class="refsect3">
 
336
<a name="id-1.2.12.8.2.6"></a><h4>Parameters</h4>
 
337
<div class="informaltable"><table width="100%" border="0">
 
338
<colgroup>
 
339
<col width="150px" class="parameters_name">
 
340
<col class="parameters_description">
 
341
<col width="200px" class="parameters_annotations">
 
342
</colgroup>
 
343
<tbody><tr>
 
344
<td class="parameter_name"><p>role</p></td>
 
345
<td class="parameter_description"><p>an <a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole"><span class="type">AtspiRole</span></a> object to query.</p></td>
 
346
<td class="parameter_annotations"> </td>
 
347
</tr></tbody>
 
348
</table></div>
 
349
</div>
 
350
<div class="refsect3">
 
351
<a name="id-1.2.12.8.2.7"></a><h4>Returns</h4>
 
352
<p> a localizable string name for an <a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole"><span class="type">AtspiRole</span></a> enumerated type.</p>
 
353
</div>
 
354
</div>
 
355
<hr>
 
356
<div class="refsect2">
 
357
<a name="atspi-accessible-get-name"></a><h3>atspi_accessible_get_name ()</h3>
 
358
<pre class="programlisting"><span class="returnvalue">gchar</span> *
 
359
atspi_accessible_get_name (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
360
                           <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
361
<p>Gets the name of an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.</p>
 
362
<div class="refsect3">
 
363
<a name="id-1.2.12.8.3.5"></a><h4>Parameters</h4>
 
364
<div class="informaltable"><table width="100%" border="0">
 
365
<colgroup>
 
366
<col width="150px" class="parameters_name">
 
367
<col class="parameters_description">
 
368
<col width="200px" class="parameters_annotations">
 
369
</colgroup>
 
370
<tbody><tr>
 
371
<td class="parameter_name"><p>obj</p></td>
 
372
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
373
<td class="parameter_annotations"> </td>
 
374
</tr></tbody>
 
375
</table></div>
 
376
</div>
 
377
<div class="refsect3">
 
378
<a name="id-1.2.12.8.3.6"></a><h4>Returns</h4>
 
379
<p> a UTF-8 string indicating the name of the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object
 
380
or NULL on exception.</p>
 
381
</div>
 
382
</div>
 
383
<hr>
 
384
<div class="refsect2">
 
385
<a name="atspi-accessible-get-description"></a><h3>atspi_accessible_get_description ()</h3>
 
386
<pre class="programlisting"><span class="returnvalue">gchar</span> *
 
387
atspi_accessible_get_description (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
388
                                  <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
389
<p>Gets the description of an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.</p>
 
390
<div class="refsect3">
 
391
<a name="id-1.2.12.8.4.5"></a><h4>Parameters</h4>
 
392
<div class="informaltable"><table width="100%" border="0">
 
393
<colgroup>
 
394
<col width="150px" class="parameters_name">
 
395
<col class="parameters_description">
 
396
<col width="200px" class="parameters_annotations">
 
397
</colgroup>
 
398
<tbody><tr>
 
399
<td class="parameter_name"><p>obj</p></td>
 
400
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
401
<td class="parameter_annotations"> </td>
 
402
</tr></tbody>
 
403
</table></div>
 
404
</div>
 
405
<div class="refsect3">
 
406
<a name="id-1.2.12.8.4.6"></a><h4>Returns</h4>
 
407
<p> a UTF-8 string describing the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object
 
408
or NULL on exception.</p>
 
409
</div>
 
410
</div>
 
411
<hr>
 
412
<div class="refsect2">
 
413
<a name="atspi-accessible-get-parent"></a><h3>atspi_accessible_get_parent ()</h3>
 
414
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
 
415
atspi_accessible_get_parent (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
416
                             <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
417
<p>Gets an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object's parent container.</p>
 
418
<div class="refsect3">
 
419
<a name="id-1.2.12.8.5.5"></a><h4>Parameters</h4>
 
420
<div class="informaltable"><table width="100%" border="0">
 
421
<colgroup>
 
422
<col width="150px" class="parameters_name">
 
423
<col class="parameters_description">
 
424
<col width="200px" class="parameters_annotations">
 
425
</colgroup>
 
426
<tbody><tr>
 
427
<td class="parameter_name"><p>obj</p></td>
 
428
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object to query.</p></td>
 
429
<td class="parameter_annotations"> </td>
 
430
</tr></tbody>
 
431
</table></div>
 
432
</div>
 
433
<div class="refsect3">
 
434
<a name="id-1.2.12.8.5.6"></a><h4>Returns</h4>
 
435
<p> a pointer to the
 
436
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object which contains the given
 
437
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance, or NULL if the <em class="parameter"><code>obj</code></em>
 
438
has no
 
439
parent container. </p>
 
440
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
441
</div>
 
442
</div>
 
443
<hr>
 
444
<div class="refsect2">
 
445
<a name="atspi-accessible-get-child-count"></a><h3>atspi_accessible_get_child_count ()</h3>
 
446
<pre class="programlisting"><span class="returnvalue">gint</span>
 
447
atspi_accessible_get_child_count (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
448
                                  <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
449
<p>Gets the number of children contained by an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.</p>
 
450
<div class="refsect3">
 
451
<a name="id-1.2.12.8.6.5"></a><h4>Parameters</h4>
 
452
<div class="informaltable"><table width="100%" border="0">
 
453
<colgroup>
 
454
<col width="150px" class="parameters_name">
 
455
<col class="parameters_description">
 
456
<col width="200px" class="parameters_annotations">
 
457
</colgroup>
 
458
<tbody><tr>
 
459
<td class="parameter_name"><p>obj</p></td>
 
460
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
461
<td class="parameter_annotations"> </td>
 
462
</tr></tbody>
 
463
</table></div>
 
464
</div>
 
465
<div class="refsect3">
 
466
<a name="id-1.2.12.8.6.6"></a><h4>Returns</h4>
 
467
<p> a <span class="type">long</span> indicating the number of <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> children
 
468
contained by an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object or -1 on exception.</p>
 
469
</div>
 
470
</div>
 
471
<hr>
 
472
<div class="refsect2">
 
473
<a name="atspi-accessible-get-child-at-index"></a><h3>atspi_accessible_get_child_at_index ()</h3>
 
474
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
 
475
atspi_accessible_get_child_at_index (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
476
                                     <em class="parameter"><code><span class="type">gint</span> child_index</code></em>,
 
477
                                     <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
478
<p>Gets the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> child of an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object at a given index.</p>
 
479
<div class="refsect3">
 
480
<a name="id-1.2.12.8.7.5"></a><h4>Parameters</h4>
 
481
<div class="informaltable"><table width="100%" border="0">
 
482
<colgroup>
 
483
<col width="150px" class="parameters_name">
 
484
<col class="parameters_description">
 
485
<col width="200px" class="parameters_annotations">
 
486
</colgroup>
 
487
<tbody>
 
488
<tr>
 
489
<td class="parameter_name"><p>obj</p></td>
 
490
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
491
<td class="parameter_annotations"> </td>
 
492
</tr>
 
493
<tr>
 
494
<td class="parameter_name"><p>child_index</p></td>
 
495
<td class="parameter_description"><p>a <span class="type">long</span> indicating which child is specified.</p></td>
 
496
<td class="parameter_annotations"> </td>
 
497
</tr>
 
498
</tbody>
 
499
</table></div>
 
500
</div>
 
501
<div class="refsect3">
 
502
<a name="id-1.2.12.8.7.6"></a><h4>Returns</h4>
 
503
<p> a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> child object at
 
504
index <em class="parameter"><code>child_index</code></em>
 
505
or NULL on exception. </p>
 
506
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
507
</div>
 
508
</div>
 
509
<hr>
 
510
<div class="refsect2">
 
511
<a name="atspi-accessible-get-index-in-parent"></a><h3>atspi_accessible_get_index_in_parent ()</h3>
 
512
<pre class="programlisting"><span class="returnvalue">gint</span>
 
513
atspi_accessible_get_index_in_parent (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
514
                                      <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
515
<p>Gets the index of an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object within its parent's 
 
516
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> children list.</p>
 
517
<div class="refsect3">
 
518
<a name="id-1.2.12.8.8.5"></a><h4>Parameters</h4>
 
519
<div class="informaltable"><table width="100%" border="0">
 
520
<colgroup>
 
521
<col width="150px" class="parameters_name">
 
522
<col class="parameters_description">
 
523
<col width="200px" class="parameters_annotations">
 
524
</colgroup>
 
525
<tbody><tr>
 
526
<td class="parameter_name"><p>obj</p></td>
 
527
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
528
<td class="parameter_annotations"> </td>
 
529
</tr></tbody>
 
530
</table></div>
 
531
</div>
 
532
<div class="refsect3">
 
533
<a name="id-1.2.12.8.8.6"></a><h4>Returns</h4>
 
534
<p> a <span class="type">glong</span> indicating the index of the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object
 
535
in its parent,
 
536
or -1 if <em class="parameter"><code>obj</code></em>
 
537
has no containing parent or on exception.</p>
 
538
</div>
 
539
</div>
 
540
<hr>
 
541
<div class="refsect2">
 
542
<a name="atspi-accessible-get-relation-set"></a><h3>atspi_accessible_get_relation_set ()</h3>
 
543
<pre class="programlisting"><span class="returnvalue">GArray</span> *
 
544
atspi_accessible_get_relation_set (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
545
                                   <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
546
<p>Gets the set of <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> objects which describes this <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object's
 
547
relationships with other <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects.</p>
 
548
<div class="refsect3">
 
549
<a name="id-1.2.12.8.9.5"></a><h4>Parameters</h4>
 
550
<div class="informaltable"><table width="100%" border="0">
 
551
<colgroup>
 
552
<col width="150px" class="parameters_name">
 
553
<col class="parameters_description">
 
554
<col width="200px" class="parameters_annotations">
 
555
</colgroup>
 
556
<tbody><tr>
 
557
<td class="parameter_name"><p>obj</p></td>
 
558
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
559
<td class="parameter_annotations"> </td>
 
560
</tr></tbody>
 
561
</table></div>
 
562
</div>
 
563
<div class="refsect3">
 
564
<a name="id-1.2.12.8.9.6"></a><h4>Returns</h4>
 
565
<p> a <span class="type">GArray</span> of
 
566
<a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> pointers or NULL on exception. </p>
 
567
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiRelation*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
568
</div>
 
569
</div>
 
570
<hr>
 
571
<div class="refsect2">
 
572
<a name="atspi-accessible-get-role"></a><h3>atspi_accessible_get_role ()</h3>
 
573
<pre class="programlisting"><a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole"><span class="returnvalue">AtspiRole</span></a>
 
574
atspi_accessible_get_role (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
575
                           <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
576
<p>Gets the UI role played by an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.
 
577
This role's name can be obtained via <a class="link" href="AtspiAccessible.html#atspi-accessible-get-role-name" title="atspi_accessible_get_role_name ()"><code class="function">atspi_accessible_get_role_name()</code></a>.</p>
 
578
<div class="refsect3">
 
579
<a name="id-1.2.12.8.10.5"></a><h4>Parameters</h4>
 
580
<div class="informaltable"><table width="100%" border="0">
 
581
<colgroup>
 
582
<col width="150px" class="parameters_name">
 
583
<col class="parameters_description">
 
584
<col width="200px" class="parameters_annotations">
 
585
</colgroup>
 
586
<tbody><tr>
 
587
<td class="parameter_name"><p>obj</p></td>
 
588
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
589
<td class="parameter_annotations"> </td>
 
590
</tr></tbody>
 
591
</table></div>
 
592
</div>
 
593
<div class="refsect3">
 
594
<a name="id-1.2.12.8.10.6"></a><h4>Returns</h4>
 
595
<p> the <a class="link" href="libatspi-atspi-constants.html#AtspiRole" title="enum AtspiRole"><span class="type">AtspiRole</span></a> of an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.</p>
 
596
</div>
 
597
</div>
 
598
<hr>
 
599
<div class="refsect2">
 
600
<a name="atspi-accessible-get-role-name"></a><h3>atspi_accessible_get_role_name ()</h3>
 
601
<pre class="programlisting"><span class="returnvalue">gchar</span> *
 
602
atspi_accessible_get_role_name (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
603
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
604
<p>Gets a UTF-8 string corresponding to the name of the role played by an object.
 
605
This method will return useful values for roles that fall outside the
 
606
enumeration used in <a class="link" href="AtspiAccessible.html#atspi-accessible-get-role" title="atspi_accessible_get_role ()"><code class="function">atspi_accessible_get_role()</code></a>.</p>
 
607
<div class="refsect3">
 
608
<a name="id-1.2.12.8.11.5"></a><h4>Parameters</h4>
 
609
<div class="informaltable"><table width="100%" border="0">
 
610
<colgroup>
 
611
<col width="150px" class="parameters_name">
 
612
<col class="parameters_description">
 
613
<col width="200px" class="parameters_annotations">
 
614
</colgroup>
 
615
<tbody><tr>
 
616
<td class="parameter_name"><p>obj</p></td>
 
617
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
618
<td class="parameter_annotations"> </td>
 
619
</tr></tbody>
 
620
</table></div>
 
621
</div>
 
622
<div class="refsect3">
 
623
<a name="id-1.2.12.8.11.6"></a><h4>Returns</h4>
 
624
<p> a UTF-8 string specifying the type of UI role played by an
 
625
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.</p>
 
626
</div>
 
627
</div>
 
628
<hr>
 
629
<div class="refsect2">
 
630
<a name="atspi-accessible-get-localized-role-name"></a><h3>atspi_accessible_get_localized_role_name ()</h3>
 
631
<pre class="programlisting"><span class="returnvalue">gchar</span> *
 
632
atspi_accessible_get_localized_role_name
 
633
                               (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
634
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
635
<p>Gets a UTF-8 string corresponding to the name of the role played by an 
 
636
object, translated to the current locale.
 
637
This method will return useful values for roles that fall outside the
 
638
enumeration used in <code class="function">atspi_accessible_getRole()</code>.</p>
 
639
<div class="refsect3">
 
640
<a name="id-1.2.12.8.12.5"></a><h4>Parameters</h4>
 
641
<div class="informaltable"><table width="100%" border="0">
 
642
<colgroup>
 
643
<col width="150px" class="parameters_name">
 
644
<col class="parameters_description">
 
645
<col width="200px" class="parameters_annotations">
 
646
</colgroup>
 
647
<tbody><tr>
 
648
<td class="parameter_name"><p>obj</p></td>
 
649
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
650
<td class="parameter_annotations"> </td>
 
651
</tr></tbody>
 
652
</table></div>
 
653
</div>
 
654
<div class="refsect3">
 
655
<a name="id-1.2.12.8.12.6"></a><h4>Returns</h4>
 
656
<p> a localized, UTF-8 string specifying the type of UI role played
 
657
by an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.</p>
 
658
</div>
 
659
</div>
 
660
<hr>
 
661
<div class="refsect2">
 
662
<a name="atspi-accessible-get-state-set"></a><h3>atspi_accessible_get_state_set ()</h3>
 
663
<pre class="programlisting"><a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="returnvalue">AtspiStateSet</span></a> *
 
664
atspi_accessible_get_state_set (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
665
<p>Gets the states currently held by an object.</p>
 
666
<div class="refsect3">
 
667
<a name="id-1.2.12.8.13.5"></a><h4>Parameters</h4>
 
668
<div class="informaltable"><table width="100%" border="0">
 
669
<colgroup>
 
670
<col width="150px" class="parameters_name">
 
671
<col class="parameters_description">
 
672
<col width="200px" class="parameters_annotations">
 
673
</colgroup>
 
674
<tbody><tr>
 
675
<td class="parameter_name"><p>obj</p></td>
 
676
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
677
<td class="parameter_annotations"> </td>
 
678
</tr></tbody>
 
679
</table></div>
 
680
</div>
 
681
<div class="refsect3">
 
682
<a name="id-1.2.12.8.13.6"></a><h4>Returns</h4>
 
683
<p> a pointer to an <a class="link" href="AtspiStateSet.html" title="atspi-stateset"><span class="type">AtspiStateSet</span></a> representing an
 
684
object's current state set. </p>
 
685
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
686
</div>
 
687
</div>
 
688
<hr>
 
689
<div class="refsect2">
 
690
<a name="atspi-accessible-get-attributes"></a><h3>atspi_accessible_get_attributes ()</h3>
 
691
<pre class="programlisting"><span class="returnvalue">GHashTable</span> *
 
692
atspi_accessible_get_attributes (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
693
                                 <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
694
<p>Gets the <span class="type">AttributeSet</span> representing any assigned 
 
695
name-value pair attributes or annotations for this object.
 
696
For typographic, textual, or textually-semantic attributes, see
 
697
atspi_text_get_attributes instead.</p>
 
698
<div class="refsect3">
 
699
<a name="id-1.2.12.8.14.5"></a><h4>Parameters</h4>
 
700
<div class="informaltable"><table width="100%" border="0">
 
701
<colgroup>
 
702
<col width="150px" class="parameters_name">
 
703
<col class="parameters_description">
 
704
<col width="200px" class="parameters_annotations">
 
705
</colgroup>
 
706
<tbody><tr>
 
707
<td class="parameter_name"><p>obj</p></td>
 
708
<td class="parameter_description"><p>The <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> being queried.</p></td>
 
709
<td class="parameter_annotations"> </td>
 
710
</tr></tbody>
 
711
</table></div>
 
712
</div>
 
713
<div class="refsect3">
 
714
<a name="id-1.2.12.8.14.6"></a><h4>Returns</h4>
 
715
<p> The name-value-pair
 
716
attributes assigned to this object. </p>
 
717
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar* gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
718
</div>
 
719
</div>
 
720
<hr>
 
721
<div class="refsect2">
 
722
<a name="atspi-accessible-get-attributes-as-array"></a><h3>atspi_accessible_get_attributes_as_array ()</h3>
 
723
<pre class="programlisting"><span class="returnvalue">GArray</span> *
 
724
atspi_accessible_get_attributes_as_array
 
725
                               (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
726
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
727
<p>Gets a <span class="type">GArray</span> representing any assigned 
 
728
name-value pair attributes or annotations for this object.
 
729
For typographic, textual, or textually-semantic attributes, see
 
730
atspi_text_get_attributes_as_array instead.</p>
 
731
<div class="refsect3">
 
732
<a name="id-1.2.12.8.15.5"></a><h4>Parameters</h4>
 
733
<div class="informaltable"><table width="100%" border="0">
 
734
<colgroup>
 
735
<col width="150px" class="parameters_name">
 
736
<col class="parameters_description">
 
737
<col width="200px" class="parameters_annotations">
 
738
</colgroup>
 
739
<tbody><tr>
 
740
<td class="parameter_name"><p>obj</p></td>
 
741
<td class="parameter_description"><p>The <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> being queried.</p></td>
 
742
<td class="parameter_annotations"> </td>
 
743
</tr></tbody>
 
744
</table></div>
 
745
</div>
 
746
<div class="refsect3">
 
747
<a name="id-1.2.12.8.15.6"></a><h4>Returns</h4>
 
748
<p> The name-value-pair
 
749
attributes assigned to this object. </p>
 
750
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
751
</div>
 
752
</div>
 
753
<hr>
 
754
<div class="refsect2">
 
755
<a name="atspi-accessible-get-toolkit-name"></a><h3>atspi_accessible_get_toolkit_name ()</h3>
 
756
<pre class="programlisting"><span class="returnvalue">gchar</span> *
 
757
atspi_accessible_get_toolkit_name (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
758
                                   <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
759
<p>Gets the toolkit name for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.
 
760
Only works on application root objects.</p>
 
761
<div class="refsect3">
 
762
<a name="id-1.2.12.8.16.5"></a><h4>Parameters</h4>
 
763
<div class="informaltable"><table width="100%" border="0">
 
764
<colgroup>
 
765
<col width="150px" class="parameters_name">
 
766
<col class="parameters_description">
 
767
<col width="200px" class="parameters_annotations">
 
768
</colgroup>
 
769
<tbody><tr>
 
770
<td class="parameter_name"><p>obj</p></td>
 
771
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
772
<td class="parameter_annotations"> </td>
 
773
</tr></tbody>
 
774
</table></div>
 
775
</div>
 
776
<div class="refsect3">
 
777
<a name="id-1.2.12.8.16.6"></a><h4>Returns</h4>
 
778
<p> a UTF-8 string indicating the toolkit name for the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object or NULL on exception.</p>
 
779
</div>
 
780
</div>
 
781
<hr>
 
782
<div class="refsect2">
 
783
<a name="atspi-accessible-get-toolkit-version"></a><h3>atspi_accessible_get_toolkit_version ()</h3>
 
784
<pre class="programlisting"><span class="returnvalue">gchar</span> *
 
785
atspi_accessible_get_toolkit_version (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
786
                                      <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
787
<p>Gets the toolkit version for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object.
 
788
Only works on application root objects.</p>
 
789
<div class="refsect3">
 
790
<a name="id-1.2.12.8.17.5"></a><h4>Parameters</h4>
 
791
<div class="informaltable"><table width="100%" border="0">
 
792
<colgroup>
 
793
<col width="150px" class="parameters_name">
 
794
<col class="parameters_description">
 
795
<col width="200px" class="parameters_annotations">
 
796
</colgroup>
 
797
<tbody><tr>
 
798
<td class="parameter_name"><p>obj</p></td>
 
799
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
800
<td class="parameter_annotations"> </td>
 
801
</tr></tbody>
 
802
</table></div>
 
803
</div>
 
804
<div class="refsect3">
 
805
<a name="id-1.2.12.8.17.6"></a><h4>Returns</h4>
 
806
<p> a UTF-8 string indicating the toolkit version for the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object or NULL on exception.</p>
 
807
</div>
 
808
</div>
 
809
<hr>
 
810
<div class="refsect2">
 
811
<a name="atspi-accessible-get-application"></a><h3>atspi_accessible_get_application ()</h3>
 
812
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
 
813
atspi_accessible_get_application (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>,
 
814
                                  <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
815
<p>Gets the containing <a class="link" href="libatspi-AtspiApplication.html#AtspiApplication" title="struct AtspiApplication"><span class="type">AtspiApplication</span></a> for an object.</p>
 
816
<div class="refsect3">
 
817
<a name="id-1.2.12.8.18.5"></a><h4>Parameters</h4>
 
818
<div class="informaltable"><table width="100%" border="0">
 
819
<colgroup>
 
820
<col width="150px" class="parameters_name">
 
821
<col class="parameters_description">
 
822
<col width="200px" class="parameters_annotations">
 
823
</colgroup>
 
824
<tbody><tr>
 
825
<td class="parameter_name"><p>obj</p></td>
 
826
<td class="parameter_description"><p>The <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> being queried.</p></td>
 
827
<td class="parameter_annotations"> </td>
 
828
</tr></tbody>
 
829
</table></div>
 
830
</div>
 
831
<div class="refsect3">
 
832
<a name="id-1.2.12.8.18.6"></a><h4>Returns</h4>
 
833
<p> the containing <a class="link" href="libatspi-AtspiApplication.html#AtspiApplication" title="struct AtspiApplication"><span class="type">AtspiApplication</span></a> instance for
 
834
this object. </p>
 
835
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
836
</div>
 
837
</div>
 
838
<hr>
 
839
<div class="refsect2">
 
840
<a name="atspi-accessible-get-action"></a><h3>atspi_accessible_get_action ()</h3>
 
841
<pre class="programlisting"><a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="returnvalue">AtspiAction</span></a> *
 
842
atspi_accessible_get_action (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
843
<div class="warning">
 
844
<p><code class="literal">atspi_accessible_get_action</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
845
<p>Use atspi_accessible_get_action_iface instead.</p>
 
846
</div>
 
847
<p>Gets the <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
848
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_action_iface]</span></p>
 
849
<div class="refsect3">
 
850
<a name="id-1.2.12.8.19.7"></a><h4>Parameters</h4>
 
851
<div class="informaltable"><table width="100%" border="0">
 
852
<colgroup>
 
853
<col width="150px" class="parameters_name">
 
854
<col class="parameters_description">
 
855
<col width="200px" class="parameters_annotations">
 
856
</colgroup>
 
857
<tbody><tr>
 
858
<td class="parameter_name"><p>obj</p></td>
 
859
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
860
<td class="parameter_annotations"> </td>
 
861
</tr></tbody>
 
862
</table></div>
 
863
</div>
 
864
<div class="refsect3">
 
865
<a name="id-1.2.12.8.19.8"></a><h4>Returns</h4>
 
866
<p> a pointer to an <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a> interface
 
867
instance, or NULL if <em class="parameter"><code>obj</code></em>
 
868
does not implement <a class="link" href="libatspi-atspi-action.html#AtspiAction"><span class="type">AtspiAction</span></a>. </p>
 
869
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
870
</div>
 
871
</div>
 
872
<hr>
 
873
<div class="refsect2">
 
874
<a name="atspi-accessible-get-collection"></a><h3>atspi_accessible_get_collection ()</h3>
 
875
<pre class="programlisting"><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="returnvalue">AtspiCollection</span></a> *
 
876
atspi_accessible_get_collection (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
877
<div class="warning">
 
878
<p><code class="literal">atspi_accessible_get_collection</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
879
<p>Use atspi_accessible_get_collection_iface instead.</p>
 
880
</div>
 
881
<p>Gets the <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
882
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_collection_iface]</span></p>
 
883
<div class="refsect3">
 
884
<a name="id-1.2.12.8.20.7"></a><h4>Parameters</h4>
 
885
<div class="informaltable"><table width="100%" border="0">
 
886
<colgroup>
 
887
<col width="150px" class="parameters_name">
 
888
<col class="parameters_description">
 
889
<col width="200px" class="parameters_annotations">
 
890
</colgroup>
 
891
<tbody><tr>
 
892
<td class="parameter_name"><p>obj</p></td>
 
893
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
894
<td class="parameter_annotations"> </td>
 
895
</tr></tbody>
 
896
</table></div>
 
897
</div>
 
898
<div class="refsect3">
 
899
<a name="id-1.2.12.8.20.8"></a><h4>Returns</h4>
 
900
<p> a pointer to an <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> interface
 
901
instance, or NULL if <em class="parameter"><code>obj</code></em>
 
902
does not implement <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a>. </p>
 
903
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
904
</div>
 
905
</div>
 
906
<hr>
 
907
<div class="refsect2">
 
908
<a name="atspi-accessible-get-component"></a><h3>atspi_accessible_get_component ()</h3>
 
909
<pre class="programlisting"><a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="returnvalue">AtspiComponent</span></a> *
 
910
atspi_accessible_get_component (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
911
<div class="warning">
 
912
<p><code class="literal">atspi_accessible_get_component</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
913
<p>Use atspi_accessible_get_component_iface instead.</p>
 
914
</div>
 
915
<p>Gets the <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
916
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_component_iface]</span></p>
 
917
<div class="refsect3">
 
918
<a name="id-1.2.12.8.21.7"></a><h4>Parameters</h4>
 
919
<div class="informaltable"><table width="100%" border="0">
 
920
<colgroup>
 
921
<col width="150px" class="parameters_name">
 
922
<col class="parameters_description">
 
923
<col width="200px" class="parameters_annotations">
 
924
</colgroup>
 
925
<tbody><tr>
 
926
<td class="parameter_name"><p>obj</p></td>
 
927
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
928
<td class="parameter_annotations"> </td>
 
929
</tr></tbody>
 
930
</table></div>
 
931
</div>
 
932
<div class="refsect3">
 
933
<a name="id-1.2.12.8.21.8"></a><h4>Returns</h4>
 
934
<p> a pointer to an <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a> interface
 
935
instance, or NULL if <em class="parameter"><code>obj</code></em>
 
936
does not implement <a class="link" href="libatspi-atspi-component.html#AtspiComponent"><span class="type">AtspiComponent</span></a>. </p>
 
937
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
938
</div>
 
939
</div>
 
940
<hr>
 
941
<div class="refsect2">
 
942
<a name="atspi-accessible-get-document"></a><h3>atspi_accessible_get_document ()</h3>
 
943
<pre class="programlisting"><a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="returnvalue">AtspiDocument</span></a> *
 
944
atspi_accessible_get_document (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
945
<div class="warning">
 
946
<p><code class="literal">atspi_accessible_get_document</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
947
<p>Use atspi_accessible_get_document_iface instead.</p>
 
948
</div>
 
949
<p>Gets the <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
950
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_document_iface]</span></p>
 
951
<div class="refsect3">
 
952
<a name="id-1.2.12.8.22.7"></a><h4>Parameters</h4>
 
953
<div class="informaltable"><table width="100%" border="0">
 
954
<colgroup>
 
955
<col width="150px" class="parameters_name">
 
956
<col class="parameters_description">
 
957
<col width="200px" class="parameters_annotations">
 
958
</colgroup>
 
959
<tbody><tr>
 
960
<td class="parameter_name"><p>obj</p></td>
 
961
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
962
<td class="parameter_annotations"> </td>
 
963
</tr></tbody>
 
964
</table></div>
 
965
</div>
 
966
<div class="refsect3">
 
967
<a name="id-1.2.12.8.22.8"></a><h4>Returns</h4>
 
968
<p> a pointer to an <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a> interface
 
969
instance, or NULL if <em class="parameter"><code>obj</code></em>
 
970
does not implement <a class="link" href="libatspi-atspi-document.html#AtspiDocument"><span class="type">AtspiDocument</span></a>. </p>
 
971
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
972
</div>
 
973
</div>
 
974
<hr>
 
975
<div class="refsect2">
 
976
<a name="atspi-accessible-get-editable-text"></a><h3>atspi_accessible_get_editable_text ()</h3>
 
977
<pre class="programlisting"><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="returnvalue">AtspiEditableText</span></a> *
 
978
atspi_accessible_get_editable_text (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
979
<div class="warning">
 
980
<p><code class="literal">atspi_accessible_get_editable_text</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
981
<p>Use atspi_accessible_get_editable_text_iface instead.</p>
 
982
</div>
 
983
<p>Gets the <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
984
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_editable_text_iface]</span></p>
 
985
<div class="refsect3">
 
986
<a name="id-1.2.12.8.23.7"></a><h4>Parameters</h4>
 
987
<div class="informaltable"><table width="100%" border="0">
 
988
<colgroup>
 
989
<col width="150px" class="parameters_name">
 
990
<col class="parameters_description">
 
991
<col width="200px" class="parameters_annotations">
 
992
</colgroup>
 
993
<tbody><tr>
 
994
<td class="parameter_name"><p>obj</p></td>
 
995
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
996
<td class="parameter_annotations"> </td>
 
997
</tr></tbody>
 
998
</table></div>
 
999
</div>
 
1000
<div class="refsect3">
 
1001
<a name="id-1.2.12.8.23.8"></a><h4>Returns</h4>
 
1002
<p> a pointer to an <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> interface
 
1003
instance, or NULL if <em class="parameter"><code>obj</code></em>
 
1004
does not implement <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a>. </p>
 
1005
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
1006
</div>
 
1007
</div>
 
1008
<hr>
 
1009
<div class="refsect2">
 
1010
<a name="atspi-accessible-get-hyperlink"></a><h3>atspi_accessible_get_hyperlink ()</h3>
 
1011
<pre class="programlisting"><a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="returnvalue">AtspiHyperlink</span></a> *
 
1012
atspi_accessible_get_hyperlink (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
1013
<p>Gets the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
1014
<div class="refsect3">
 
1015
<a name="id-1.2.12.8.24.5"></a><h4>Parameters</h4>
 
1016
<div class="informaltable"><table width="100%" border="0">
 
1017
<colgroup>
 
1018
<col width="150px" class="parameters_name">
 
1019
<col class="parameters_description">
 
1020
<col width="200px" class="parameters_annotations">
 
1021
</colgroup>
 
1022
<tbody><tr>
 
1023
<td class="parameter_name"><p>obj</p></td>
 
1024
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object on which to operate.</p></td>
 
1025
<td class="parameter_annotations"> </td>
 
1026
</tr></tbody>
 
1027
</table></div>
 
1028
</div>
 
1029
<div class="refsect3">
 
1030
<a name="id-1.2.12.8.24.6"></a><h4>Returns</h4>
 
1031
<p> the <a class="link" href="AtspiHyperlink.html" title="atspi-hyperlink"><span class="type">AtspiHyperlink</span></a> object associated with
 
1032
the given <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>, or NULL if not supported. </p>
 
1033
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
1034
</div>
 
1035
</div>
 
1036
<hr>
 
1037
<div class="refsect2">
 
1038
<a name="atspi-accessible-get-hypertext"></a><h3>atspi_accessible_get_hypertext ()</h3>
 
1039
<pre class="programlisting"><a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="returnvalue">AtspiHypertext</span></a> *
 
1040
atspi_accessible_get_hypertext (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
1041
<div class="warning">
 
1042
<p><code class="literal">atspi_accessible_get_hypertext</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
1043
<p>Use atspi_accessible_get_hypertext_iface instead.</p>
 
1044
</div>
 
1045
<p>Gets the <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
1046
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_hypertext_iface]</span></p>
 
1047
<div class="refsect3">
 
1048
<a name="id-1.2.12.8.25.7"></a><h4>Parameters</h4>
 
1049
<div class="informaltable"><table width="100%" border="0">
 
1050
<colgroup>
 
1051
<col width="150px" class="parameters_name">
 
1052
<col class="parameters_description">
 
1053
<col width="200px" class="parameters_annotations">
 
1054
</colgroup>
 
1055
<tbody><tr>
 
1056
<td class="parameter_name"><p>obj</p></td>
 
1057
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
1058
<td class="parameter_annotations"> </td>
 
1059
</tr></tbody>
 
1060
</table></div>
 
1061
</div>
 
1062
<div class="refsect3">
 
1063
<a name="id-1.2.12.8.25.8"></a><h4>Returns</h4>
 
1064
<p> a pointer to an <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a> interface
 
1065
instance, or NULL if <em class="parameter"><code>obj</code></em>
 
1066
does not implement <a class="link" href="libatspi-atspi-hypertext.html#AtspiHypertext"><span class="type">AtspiHypertext</span></a>. </p>
 
1067
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
1068
</div>
 
1069
</div>
 
1070
<hr>
 
1071
<div class="refsect2">
 
1072
<a name="atspi-accessible-get-image"></a><h3>atspi_accessible_get_image ()</h3>
 
1073
<pre class="programlisting"><a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="returnvalue">AtspiImage</span></a> *
 
1074
atspi_accessible_get_image (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
1075
<div class="warning">
 
1076
<p><code class="literal">atspi_accessible_get_image</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
1077
<p>Use atspi_accessible_get_image_iface instead.</p>
 
1078
</div>
 
1079
<p>Gets the <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
1080
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_image_iface]</span></p>
 
1081
<div class="refsect3">
 
1082
<a name="id-1.2.12.8.26.7"></a><h4>Parameters</h4>
 
1083
<div class="informaltable"><table width="100%" border="0">
 
1084
<colgroup>
 
1085
<col width="150px" class="parameters_name">
 
1086
<col class="parameters_description">
 
1087
<col width="200px" class="parameters_annotations">
 
1088
</colgroup>
 
1089
<tbody><tr>
 
1090
<td class="parameter_name"><p>obj</p></td>
 
1091
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
1092
<td class="parameter_annotations"> </td>
 
1093
</tr></tbody>
 
1094
</table></div>
 
1095
</div>
 
1096
<div class="refsect3">
 
1097
<a name="id-1.2.12.8.26.8"></a><h4>Returns</h4>
 
1098
<p> a pointer to an <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a> interface instance, or
 
1099
NULL if <em class="parameter"><code>obj</code></em>
 
1100
does not implement <a class="link" href="libatspi-atspi-image.html#AtspiImage"><span class="type">AtspiImage</span></a>. </p>
 
1101
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
1102
</div>
 
1103
</div>
 
1104
<hr>
 
1105
<div class="refsect2">
 
1106
<a name="atspi-accessible-get-selection"></a><h3>atspi_accessible_get_selection ()</h3>
 
1107
<pre class="programlisting"><a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="returnvalue">AtspiSelection</span></a> *
 
1108
atspi_accessible_get_selection (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
1109
<div class="warning">
 
1110
<p><code class="literal">atspi_accessible_get_selection</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
1111
<p>Use atspi_accessible_get_selection_iface instead.</p>
 
1112
</div>
 
1113
<p>Gets the <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
1114
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_selection_iface]</span></p>
 
1115
<div class="refsect3">
 
1116
<a name="id-1.2.12.8.27.7"></a><h4>Parameters</h4>
 
1117
<div class="informaltable"><table width="100%" border="0">
 
1118
<colgroup>
 
1119
<col width="150px" class="parameters_name">
 
1120
<col class="parameters_description">
 
1121
<col width="200px" class="parameters_annotations">
 
1122
</colgroup>
 
1123
<tbody><tr>
 
1124
<td class="parameter_name"><p>obj</p></td>
 
1125
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
1126
<td class="parameter_annotations"> </td>
 
1127
</tr></tbody>
 
1128
</table></div>
 
1129
</div>
 
1130
<div class="refsect3">
 
1131
<a name="id-1.2.12.8.27.8"></a><h4>Returns</h4>
 
1132
<p> a pointer to an <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a> interface
 
1133
instance, or NULL if <em class="parameter"><code>obj</code></em>
 
1134
does not implement <a class="link" href="libatspi-atspi-selection.html#AtspiSelection"><span class="type">AtspiSelection</span></a>. </p>
 
1135
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
1136
</div>
 
1137
</div>
 
1138
<hr>
 
1139
<div class="refsect2">
 
1140
<a name="atspi-accessible-get-table"></a><h3>atspi_accessible_get_table ()</h3>
 
1141
<pre class="programlisting"><a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="returnvalue">AtspiTable</span></a> *
 
1142
atspi_accessible_get_table (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
1143
<div class="warning">
 
1144
<p><code class="literal">atspi_accessible_get_table</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
1145
<p>Use atspi_accessible_get_table_iface instead.</p>
 
1146
</div>
 
1147
<p>Gets the <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
1148
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_table_iface]</span></p>
 
1149
<div class="refsect3">
 
1150
<a name="id-1.2.12.8.28.7"></a><h4>Parameters</h4>
 
1151
<div class="informaltable"><table width="100%" border="0">
 
1152
<colgroup>
 
1153
<col width="150px" class="parameters_name">
 
1154
<col class="parameters_description">
 
1155
<col width="200px" class="parameters_annotations">
 
1156
</colgroup>
 
1157
<tbody><tr>
 
1158
<td class="parameter_name"><p>obj</p></td>
 
1159
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
1160
<td class="parameter_annotations"> </td>
 
1161
</tr></tbody>
 
1162
</table></div>
 
1163
</div>
 
1164
<div class="refsect3">
 
1165
<a name="id-1.2.12.8.28.8"></a><h4>Returns</h4>
 
1166
<p> a pointer to an <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a> interface instance, or
 
1167
NULL if <em class="parameter"><code>obj</code></em>
 
1168
does not implement <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a>. </p>
 
1169
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
1170
</div>
 
1171
</div>
 
1172
<hr>
 
1173
<div class="refsect2">
 
1174
<a name="atspi-accessible-get-text"></a><h3>atspi_accessible_get_text ()</h3>
 
1175
<pre class="programlisting"><a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="returnvalue">AtspiText</span></a> *
 
1176
atspi_accessible_get_text (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
1177
<div class="warning">
 
1178
<p><code class="literal">atspi_accessible_get_text</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
1179
<p>Use atspi_accessible_get_text_iface instead.</p>
 
1180
</div>
 
1181
<p>Gets the <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
1182
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_text_iface]</span></p>
 
1183
<div class="refsect3">
 
1184
<a name="id-1.2.12.8.29.7"></a><h4>Parameters</h4>
 
1185
<div class="informaltable"><table width="100%" border="0">
 
1186
<colgroup>
 
1187
<col width="150px" class="parameters_name">
 
1188
<col class="parameters_description">
 
1189
<col width="200px" class="parameters_annotations">
 
1190
</colgroup>
 
1191
<tbody><tr>
 
1192
<td class="parameter_name"><p>obj</p></td>
 
1193
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
1194
<td class="parameter_annotations"> </td>
 
1195
</tr></tbody>
 
1196
</table></div>
 
1197
</div>
 
1198
<div class="refsect3">
 
1199
<a name="id-1.2.12.8.29.8"></a><h4>Returns</h4>
 
1200
<p> a pointer to an <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a> interface instance, or
 
1201
NULL if <em class="parameter"><code>obj</code></em>
 
1202
does not implement <a class="link" href="libatspi-atspi-text.html#AtspiText"><span class="type">AtspiText</span></a>. </p>
 
1203
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
1204
</div>
 
1205
</div>
 
1206
<hr>
 
1207
<div class="refsect2">
 
1208
<a name="atspi-accessible-get-value"></a><h3>atspi_accessible_get_value ()</h3>
 
1209
<pre class="programlisting"><a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="returnvalue">AtspiValue</span></a> *
 
1210
atspi_accessible_get_value (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
1211
<div class="warning">
 
1212
<p><code class="literal">atspi_accessible_get_value</code> has been deprecated since version 2.10 and should not be used in newly-written code.</p>
 
1213
<p>Use atspi_accessible_get_value_iface instead.</p>
 
1214
</div>
 
1215
<p>Gets the <a class="link" href="libatspi-atspi-table.html#AtspiTable"><span class="type">AtspiTable</span></a> interface for an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
1216
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> atspi_accessible_get_value_iface]</span></p>
 
1217
<div class="refsect3">
 
1218
<a name="id-1.2.12.8.30.7"></a><h4>Parameters</h4>
 
1219
<div class="informaltable"><table width="100%" border="0">
 
1220
<colgroup>
 
1221
<col width="150px" class="parameters_name">
 
1222
<col class="parameters_description">
 
1223
<col width="200px" class="parameters_annotations">
 
1224
</colgroup>
 
1225
<tbody><tr>
 
1226
<td class="parameter_name"><p>obj</p></td>
 
1227
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> instance to query.</p></td>
 
1228
<td class="parameter_annotations"> </td>
 
1229
</tr></tbody>
 
1230
</table></div>
 
1231
</div>
 
1232
<div class="refsect3">
 
1233
<a name="id-1.2.12.8.30.8"></a><h4>Returns</h4>
 
1234
<p> a pointer to an <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a> interface instance, or
 
1235
NULL if <em class="parameter"><code>obj</code></em>
 
1236
does not implement <a class="link" href="libatspi-atspi-value.html#AtspiValue"><span class="type">AtspiValue</span></a>. </p>
 
1237
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
1238
</div>
 
1239
</div>
 
1240
<hr>
 
1241
<div class="refsect2">
 
1242
<a name="atspi-accessible-get-interfaces"></a><h3>atspi_accessible_get_interfaces ()</h3>
 
1243
<pre class="programlisting"><span class="returnvalue">GArray</span> *
 
1244
atspi_accessible_get_interfaces (<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *obj</code></em>);</pre>
 
1245
<p>A set of pointers to all interfaces supported by an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a>.</p>
 
1246
<div class="refsect3">
 
1247
<a name="id-1.2.12.8.31.5"></a><h4>Parameters</h4>
 
1248
<div class="informaltable"><table width="100%" border="0">
 
1249
<colgroup>
 
1250
<col width="150px" class="parameters_name">
 
1251
<col class="parameters_description">
 
1252
<col width="200px" class="parameters_annotations">
 
1253
</colgroup>
 
1254
<tbody><tr>
 
1255
<td class="parameter_name"><p>obj</p></td>
 
1256
<td class="parameter_description"><p>The <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> to query.</p></td>
 
1257
<td class="parameter_annotations"> </td>
 
1258
</tr></tbody>
 
1259
</table></div>
 
1260
</div>
 
1261
<div class="refsect3">
 
1262
<a name="id-1.2.12.8.31.6"></a><h4>Returns</h4>
 
1263
<p> A <span class="type">GArray</span> of strings
 
1264
describing the interfaces supported by the object.  Interfaces are
 
1265
denoted in short-hand (i.e. "Component", "Text" etc.). </p>
 
1266
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> gchar*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
1267
</div>
 
1268
</div>
 
1269
</div>
 
1270
<div class="refsect1">
 
1271
<a name="AtspiAccessible.other_details"></a><h2>Types and Values</h2>
 
1272
<div class="refsect2">
 
1273
<a name="AtspiAccessible-struct"></a><h3>AtspiAccessible</h3>
 
1274
<pre class="programlisting">typedef struct _AtspiAccessible AtspiAccessible;</pre>
 
1275
<p>
 
1276
</p>
 
1277
</div>
 
1278
<hr>
 
1279
<div class="refsect2">
 
1280
<a name="AtspiAccessibleClass"></a><h3>struct AtspiAccessibleClass</h3>
 
1281
<pre class="programlisting">struct AtspiAccessibleClass {
 
1282
  AtspiObjectClass parent_class;
 
1283
};
 
1284
</pre>
 
1285
<p>
 
1286
</p>
 
1287
</div>
 
1288
</div>
 
1289
</div>
 
1290
<div class="footer">
 
1291
<hr>Generated by GTK-Doc V1.24.1</div>
 
1292
</body>
 
1293
</html>
 
 
b'\\ No newline at end of file'