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