Documentation fixes for ref/unref methods that no longer return ints.
[platform/core/uifw/at-spi2-atk.git] / docs / reference / cspi / tmpl / spi_accessible.sgml
1 <!-- ##### SECTION Title ##### -->
2 Accessible Objects
3
4 <!-- ##### SECTION Short_Description ##### -->
5
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9
10 </para>
11
12 <!-- ##### SECTION See_Also ##### -->
13 <para>
14
15 </para>
16
17 <!-- ##### FUNCTION Accessible_ref ##### -->
18 <para>
19
20 </para>
21
22 @obj: 
23 <!-- # Unused Parameters # -->
24 @Returns: 
25
26
27 <!-- ##### FUNCTION Accessible_unref ##### -->
28 <para>
29
30 </para>
31
32 @obj: 
33 <!-- # Unused Parameters # -->
34 @Returns: 
35
36
37 <!-- ##### FUNCTION Accessible_getName ##### -->
38 <para>
39
40 </para>
41
42 @obj: 
43 @Returns: 
44
45
46 <!-- ##### FUNCTION Accessible_getDescription ##### -->
47 <para>
48
49 </para>
50
51 @obj: 
52 @Returns: 
53
54
55 <!-- ##### FUNCTION Accessible_getParent ##### -->
56 <para>
57
58 </para>
59
60 @obj: 
61 @Returns: 
62
63
64 <!-- ##### FUNCTION Accessible_getChildCount ##### -->
65 <para>
66
67 </para>
68
69 @obj: 
70 @Returns: 
71
72
73 <!-- ##### FUNCTION Accessible_getChildAtIndex ##### -->
74 <para>
75
76 </para>
77
78 @obj: 
79 @childIndex: 
80 @Returns: 
81
82
83 <!-- ##### FUNCTION Accessible_getIndexInParent ##### -->
84 <para>
85
86 </para>
87
88 @obj: 
89 @Returns: 
90
91
92 <!-- ##### FUNCTION Accessible_getRelationSet ##### -->
93 <para>
94
95 </para>
96
97 @obj: 
98 @Returns: 
99
100
101 <!-- ##### FUNCTION Accessible_getRole ##### -->
102 <para>
103
104 </para>
105
106 @obj: 
107 @Returns: 
108
109
110 <!-- ##### FUNCTION Accessible_getStateSet ##### -->
111 <para>
112
113 </para>
114
115 @obj: 
116 @Returns: 
117
118
119 <!-- ##### FUNCTION Accessible_isAction ##### -->
120 <para>
121
122 </para>
123
124 @obj: 
125 @Returns: 
126
127
128 <!-- ##### FUNCTION Accessible_isComponent ##### -->
129 <para>
130
131 </para>
132
133 @obj: 
134 @Returns: 
135
136
137 <!-- ##### FUNCTION Accessible_isEditableText ##### -->
138 <para>
139
140 </para>
141
142 @obj: 
143 @Returns: 
144
145
146 <!-- ##### FUNCTION Accessible_isHypertext ##### -->
147 <para>
148
149 </para>
150
151 @obj: 
152 @Returns: 
153
154
155 <!-- ##### FUNCTION Accessible_isImage ##### -->
156 <para>
157
158 </para>
159
160 @obj: 
161 @Returns: 
162
163
164 <!-- ##### FUNCTION Accessible_isSelection ##### -->
165 <para>
166
167 </para>
168
169 @obj: 
170 @Returns: 
171
172
173 <!-- ##### FUNCTION Accessible_isTable ##### -->
174 <para>
175
176 </para>
177
178 @obj: 
179 @Returns: 
180
181
182 <!-- ##### FUNCTION Accessible_isText ##### -->
183 <para>
184
185 </para>
186
187 @obj: 
188 @Returns: 
189
190
191 <!-- ##### FUNCTION Accessible_getAction ##### -->
192 <para>
193
194 </para>
195
196 @obj: 
197 @Returns: 
198
199
200 <!-- ##### FUNCTION Accessible_getComponent ##### -->
201 <para>
202
203 </para>
204
205 @obj: 
206 @Returns: 
207
208
209 <!-- ##### FUNCTION Accessible_getEditableText ##### -->
210 <para>
211
212 </para>
213
214 @obj: 
215 @Returns: 
216
217
218 <!-- ##### FUNCTION Accessible_getHypertext ##### -->
219 <para>
220
221 </para>
222
223 @obj: 
224 @Returns: 
225
226
227 <!-- ##### FUNCTION Accessible_getImage ##### -->
228 <para>
229
230 </para>
231
232 @obj: 
233 @Returns: 
234
235
236 <!-- ##### FUNCTION Accessible_getSelection ##### -->
237 <para>
238
239 </para>
240
241 @obj: 
242 @Returns: 
243
244
245 <!-- ##### FUNCTION Accessible_getTable ##### -->
246 <para>
247
248 </para>
249
250 @obj: 
251 @Returns: 
252
253
254 <!-- ##### FUNCTION Accessible_getText ##### -->
255 <para>
256
257 </para>
258
259 @obj: 
260 @Returns: 
261
262
263 <!-- ##### FUNCTION Accessible_queryInterface ##### -->
264 <para>
265
266 </para>
267
268 @obj: 
269 @interface_name: 
270 @Returns: 
271
272
273 <!-- ##### ENUM AccessibleRole ##### -->
274 <para>
275
276 </para>
277
278 @SPI_ROLE_INVALID: 
279 @SPI_ROLE_ALERT: 
280 @SPI_ROLE_CANVAS: 
281 @SPI_ROLE_CHECK_BOX: 
282 @SPI_ROLE_COLOR_CHOOSER: 
283 @SPI_ROLE_COLUMN_HEADER: 
284 @SPI_ROLE_COMBO_BOX: 
285 @SPI_ROLE_SPI_DESKTOP_ICON: 
286 @SPI_ROLE_SPI_DESKTOP_FRAME: 
287 @SPI_ROLE_DIALOG: 
288 @SPI_ROLE_DIRECTORY_PANE: 
289 @SPI_ROLE_FILE_CHOOSER: 
290 @SPI_ROLE_FILLER: 
291 @SPI_ROLE_FOCUS_TRAVERSABLE: 
292 @SPI_ROLE_FRAME: 
293 @SPI_ROLE_GLASS_PANE: 
294 @SPI_ROLE_HTML_CONTAINER: 
295 @SPI_ROLE_ICON: 
296 @SPI_ROLE_INTERNAL_FRAME: 
297 @SPI_ROLE_LABEL: 
298 @SPI_ROLE_LAYERED_PANE: 
299 @SPI_ROLE_LIST: 
300 @SPI_ROLE_LIST_ITEM: 
301 @SPI_ROLE_MENU: 
302 @SPI_ROLE_MENU_BAR: 
303 @SPI_ROLE_MENU_ITEM: 
304 @SPI_ROLE_OPTION_PANE: 
305 @SPI_ROLE_PAGE_TAB: 
306 @SPI_ROLE_PAGE_TAB_LIST: 
307 @SPI_ROLE_PANEL: 
308 @SPI_ROLE_PASSWORD_TEXT: 
309 @SPI_ROLE_POPUP_MENU: 
310 @SPI_ROLE_PROGRESS_BAR: 
311 @SPI_ROLE_PUSH_BUTTON: 
312 @SPI_ROLE_RADIO_BUTTON: 
313 @SPI_ROLE_ROOT_PANE: 
314 @SPI_ROLE_ROW_HEADER: 
315 @SPI_ROLE_SCROLL_BAR: 
316 @SPI_ROLE_SCROLL_PANE: 
317 @SPI_ROLE_SEPARATOR: 
318 @SPI_ROLE_SLIDER: 
319 @SPI_ROLE_SPLIT_PANE: 
320 @SPI_ROLE_TABLE: 
321 @SPI_ROLE_TABLE_CELL: 
322 @SPI_ROLE_TABLE_COLUMN_HEADER: 
323 @SPI_ROLE_TABLE_ROW_HEADER: 
324 @SPI_ROLE_TEXT: 
325 @SPI_ROLE_TOGGLE_BUTTON: 
326 @SPI_ROLE_TOOL_BAR: 
327 @SPI_ROLE_TOOL_TIP: 
328 @SPI_ROLE_TREE: 
329 @SPI_ROLE_UNKNOWN: 
330 @SPI_ROLE_VIEWPORT: 
331 @SPI_ROLE_WINDOW: 
332 @SPI_ROLE_LAST_DEFINED: 
333
334 <!-- ##### FUNCTION AccessibleRole_getName ##### -->
335 <para>
336
337 </para>
338
339 @role: 
340 @Returns: 
341
342