5b3c8ea6e59a5845daa8bfb059760ea7f4d5ebdc
[platform/upstream/at-spi2-core.git] / doc / libatspi / tmpl / atspi-accessible.sgml
1 <!-- ##### SECTION Title ##### -->
2 AtspiAccessible
3
4 <!-- ##### SECTION Short_Description ##### -->
5 The base interface which is implemented by all accessible objects.
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 The base interface which is implemented by all accessible objects. 
10 All objects support interfaces for querying their contained 'children'
11 and position in the accessible-object hierarchy, whether or not they
12 actually have children.
13 </para>
14
15 <!-- ##### SECTION See_Also ##### -->
16 <para>
17
18 </para>
19
20 <!-- ##### SECTION Stability_Level ##### -->
21
22
23 <!-- ##### SECTION Image ##### -->
24
25
26 <!-- ##### STRUCT AtspiAccessible ##### -->
27 <para>
28
29 </para>
30
31
32 <!-- ##### STRUCT AtspiAccessibleClass ##### -->
33 <para>
34
35 </para>
36
37 @parent_class: 
38
39 <!-- ##### FUNCTION atspi_role_get_name ##### -->
40 <para>
41
42 </para>
43
44 @role: 
45 @Returns: 
46
47
48 <!-- ##### FUNCTION atspi_accessible_get_name ##### -->
49 <para>
50
51 </para>
52
53 @obj: 
54 @error: 
55 @Returns: 
56
57
58 <!-- ##### FUNCTION atspi_accessible_get_description ##### -->
59 <para>
60
61 </para>
62
63 @obj: 
64 @error: 
65 @Returns: 
66
67
68 <!-- ##### FUNCTION atspi_accessible_get_parent ##### -->
69 <para>
70
71 </para>
72
73 @obj: 
74 @error: 
75 @Returns: 
76
77
78 <!-- ##### FUNCTION atspi_accessible_get_child_count ##### -->
79 <para>
80
81 </para>
82
83 @obj: 
84 @error: 
85 @Returns: 
86
87
88 <!-- ##### FUNCTION atspi_accessible_get_child_at_index ##### -->
89 <para>
90
91 </para>
92
93 @obj: 
94 @child_index: 
95 @error: 
96 @Returns: 
97
98
99 <!-- ##### FUNCTION atspi_accessible_get_index_in_parent ##### -->
100 <para>
101
102 </para>
103
104 @obj: 
105 @error: 
106 @Returns: 
107
108
109 <!-- ##### FUNCTION atspi_accessible_get_relation_set ##### -->
110 <para>
111
112 </para>
113
114 @obj: 
115 @error: 
116 @Returns: 
117
118
119 <!-- ##### FUNCTION atspi_accessible_get_role ##### -->
120 <para>
121
122 </para>
123
124 @obj: 
125 @error: 
126 @Returns: 
127
128
129 <!-- ##### FUNCTION atspi_accessible_get_role_name ##### -->
130 <para>
131
132 </para>
133
134 @obj: 
135 @error: 
136 @Returns: 
137
138
139 <!-- ##### FUNCTION atspi_accessible_get_localized_role_name ##### -->
140 <para>
141
142 </para>
143
144 @obj: 
145 @error: 
146 @Returns: 
147
148
149 <!-- ##### FUNCTION atspi_accessible_get_state_set ##### -->
150 <para>
151
152 </para>
153
154 @obj: 
155 @Returns: 
156
157
158 <!-- ##### FUNCTION atspi_accessible_get_attributes ##### -->
159 <para>
160
161 </para>
162
163 @obj: 
164 @error: 
165 @Returns: 
166
167
168 <!-- ##### FUNCTION atspi_accessible_get_attributes_as_array ##### -->
169 <para>
170
171 </para>
172
173 @obj: 
174 @error: 
175 @Returns: 
176
177
178 <!-- ##### FUNCTION atspi_accessible_get_toolkit_name ##### -->
179 <para>
180
181 </para>
182
183 @obj: 
184 @error: 
185 @Returns: 
186
187
188 <!-- ##### FUNCTION atspi_accessible_get_toolkit_version ##### -->
189 <para>
190
191 </para>
192
193 @obj: 
194 @error: 
195 @Returns: 
196
197
198 <!-- ##### FUNCTION atspi_accessible_get_application ##### -->
199 <para>
200
201 </para>
202
203 @obj: 
204 @error: 
205 @Returns: 
206
207
208 <!-- ##### FUNCTION atspi_accessible_get_action ##### -->
209 <para>
210
211 </para>
212
213 @obj: 
214 @Returns: 
215
216
217 <!-- ##### FUNCTION atspi_accessible_get_collection ##### -->
218 <para>
219
220 </para>
221
222 @obj: 
223 @Returns: 
224
225
226 <!-- ##### FUNCTION atspi_accessible_get_component ##### -->
227 <para>
228
229 </para>
230
231 @obj: 
232 @Returns: 
233
234
235 <!-- ##### FUNCTION atspi_accessible_get_document ##### -->
236 <para>
237
238 </para>
239
240 @obj: 
241 @Returns: 
242
243
244 <!-- ##### FUNCTION atspi_accessible_get_editable_text ##### -->
245 <para>
246
247 </para>
248
249 @obj: 
250 @Returns: 
251
252
253 <!-- ##### FUNCTION atspi_accessible_get_hyperlink ##### -->
254 <para>
255
256 </para>
257
258 @obj: 
259 @Returns: 
260
261
262 <!-- ##### FUNCTION atspi_accessible_get_hypertext ##### -->
263 <para>
264
265 </para>
266
267 @obj: 
268 @Returns: 
269
270
271 <!-- ##### FUNCTION atspi_accessible_get_image ##### -->
272 <para>
273
274 </para>
275
276 @obj: 
277 @Returns: 
278
279
280 <!-- ##### FUNCTION atspi_accessible_get_selection ##### -->
281 <para>
282
283 </para>
284
285 @obj: 
286 @Returns: 
287
288
289 <!-- ##### FUNCTION atspi_accessible_get_table ##### -->
290 <para>
291
292 </para>
293
294 @obj: 
295 @Returns: 
296
297
298 <!-- ##### FUNCTION atspi_accessible_get_text ##### -->
299 <para>
300
301 </para>
302
303 @obj: 
304 @Returns: 
305
306
307 <!-- ##### FUNCTION atspi_accessible_get_value ##### -->
308 <para>
309
310 </para>
311
312 @obj: 
313 @Returns: 
314
315
316 <!-- ##### FUNCTION atspi_accessible_get_interfaces ##### -->
317 <para>
318
319 </para>
320
321 @obj: 
322 @Returns: 
323
324