Adding descriptions to atspiaccessible
[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_accessible_new ##### -->
40 <para>
41
42 </para>
43
44 @app: 
45 @path: 
46 @Returns: 
47
48
49 <!-- ##### FUNCTION atspi_role_get_name ##### -->
50 <para>
51
52 </para>
53
54 @role: 
55 @Returns: 
56
57
58 <!-- ##### FUNCTION atspi_accessible_get_name ##### -->
59 <para>
60
61 </para>
62
63 @obj: 
64 @error: 
65 @Returns: 
66
67
68 <!-- ##### FUNCTION atspi_accessible_get_description ##### -->
69 <para>
70
71 </para>
72
73 @obj: 
74 @error: 
75 @Returns: 
76
77
78 <!-- ##### FUNCTION atspi_accessible_get_parent ##### -->
79 <para>
80
81 </para>
82
83 @obj: 
84 @error: 
85 @Returns: 
86
87
88 <!-- ##### FUNCTION atspi_accessible_get_child_count ##### -->
89 <para>
90
91 </para>
92
93 @obj: 
94 @error: 
95 @Returns: 
96
97
98 <!-- ##### FUNCTION atspi_accessible_get_child_at_index ##### -->
99 <para>
100
101 </para>
102
103 @obj: 
104 @child_index: 
105 @error: 
106 @Returns: 
107
108
109 <!-- ##### FUNCTION atspi_accessible_get_index_in_parent ##### -->
110 <para>
111
112 </para>
113
114 @obj: 
115 @error: 
116 @Returns: 
117
118
119 <!-- ##### FUNCTION atspi_accessible_get_relation_set ##### -->
120 <para>
121
122 </para>
123
124 @obj: 
125 @error: 
126 @Returns: 
127
128
129 <!-- ##### FUNCTION atspi_accessible_get_role ##### -->
130 <para>
131
132 </para>
133
134 @obj: 
135 @error: 
136 @Returns: 
137
138
139 <!-- ##### FUNCTION atspi_accessible_get_role_name ##### -->
140 <para>
141
142 </para>
143
144 @obj: 
145 @error: 
146 @Returns: 
147
148
149 <!-- ##### FUNCTION atspi_accessible_get_localized_role_name ##### -->
150 <para>
151
152 </para>
153
154 @obj: 
155 @error: 
156 @Returns: 
157
158
159 <!-- ##### FUNCTION atspi_accessible_get_state_set ##### -->
160 <para>
161
162 </para>
163
164 @obj: 
165 @Returns: 
166
167
168 <!-- ##### FUNCTION atspi_accessible_get_attributes ##### -->
169 <para>
170
171 </para>
172
173 @obj: 
174 @error: 
175 @Returns: 
176
177
178 <!-- ##### FUNCTION atspi_accessible_get_attributes_as_array ##### -->
179 <para>
180
181 </para>
182
183 @obj: 
184 @error: 
185 @Returns: 
186
187
188 <!-- ##### FUNCTION atspi_accessible_get_toolkit_name ##### -->
189 <para>
190
191 </para>
192
193 @obj: 
194 @error: 
195 @Returns: 
196
197
198 <!-- ##### FUNCTION atspi_accessible_get_toolkit_version ##### -->
199 <para>
200
201 </para>
202
203 @obj: 
204 @error: 
205 @Returns: 
206
207
208 <!-- ##### FUNCTION atspi_accessible_get_application ##### -->
209 <para>
210
211 </para>
212
213 @obj: 
214 @error: 
215 @Returns: 
216
217
218 <!-- ##### FUNCTION atspi_accessible_get_action ##### -->
219 <para>
220
221 </para>
222
223 @obj: 
224 @Returns: 
225
226
227 <!-- ##### FUNCTION atspi_accessible_get_collection ##### -->
228 <para>
229
230 </para>
231
232 @obj: 
233 @Returns: 
234
235
236 <!-- ##### FUNCTION atspi_accessible_get_component ##### -->
237 <para>
238
239 </para>
240
241 @obj: 
242 @Returns: 
243
244
245 <!-- ##### FUNCTION atspi_accessible_get_document ##### -->
246 <para>
247
248 </para>
249
250 @obj: 
251 @Returns: 
252
253
254 <!-- ##### FUNCTION atspi_accessible_get_editable_text ##### -->
255 <para>
256
257 </para>
258
259 @obj: 
260 @Returns: 
261
262
263 <!-- ##### FUNCTION atspi_accessible_get_hyperlink ##### -->
264 <para>
265
266 </para>
267
268 @obj: 
269 @Returns: 
270
271
272 <!-- ##### FUNCTION atspi_accessible_get_hypertext ##### -->
273 <para>
274
275 </para>
276
277 @obj: 
278 @Returns: 
279
280
281 <!-- ##### FUNCTION atspi_accessible_get_image ##### -->
282 <para>
283
284 </para>
285
286 @obj: 
287 @Returns: 
288
289
290 <!-- ##### FUNCTION atspi_accessible_get_selection ##### -->
291 <para>
292
293 </para>
294
295 @obj: 
296 @Returns: 
297
298
299 <!-- ##### FUNCTION atspi_accessible_get_table ##### -->
300 <para>
301
302 </para>
303
304 @obj: 
305 @Returns: 
306
307
308 <!-- ##### FUNCTION atspi_accessible_get_text ##### -->
309 <para>
310
311 </para>
312
313 @obj: 
314 @Returns: 
315
316
317 <!-- ##### FUNCTION atspi_accessible_get_value ##### -->
318 <para>
319
320 </para>
321
322 @obj: 
323 @Returns: 
324
325
326 <!-- ##### FUNCTION atspi_accessible_get_interfaces ##### -->
327 <para>
328
329 </para>
330
331 @obj: 
332 @Returns: 
333
334