summaryrefslogtreecommitdiff
path: root/docs/tmpl/atkobject.sgml
blob: 5c895d77843a312f79f0cb374bdf8574aa08b9f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
<!-- ##### SECTION Title ##### -->
AtkObject

<!-- ##### SECTION Short_Description ##### -->
represents the minimum information all accessible objects return

<!-- ##### SECTION Long_Description ##### -->
<para>
AtkObject represents the minimum information all accessible objects
return. This information includes accessible name, accessible
description, role and state of the object, as well information about
its parent and children. It is also possible to obtain more specific
accessibility information about a component if it supports one or more
of the other ATK interfaces:
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### STRUCT AtkObject ##### -->
<para>

</para>

@parent: 
@description: 
@name: 
@accessible_parent: 
@role: 
@relation_set: 
@layer: 

<!-- ##### ENUM AtkRole ##### -->
<para>

</para>

@ATK_ROLE_INVALID: 
@ATK_ROLE_ACCEL_LABEL: 
@ATK_ROLE_ALERT: 
@ATK_ROLE_ANIMATION: 
@ATK_ROLE_ARROW: 
@ATK_ROLE_CALENDAR: 
@ATK_ROLE_CANVAS: 
@ATK_ROLE_CHECK_BOX: 
@ATK_ROLE_CHECK_MENU_ITEM: 
@ATK_ROLE_COLOR_CHOOSER: 
@ATK_ROLE_COLUMN_HEADER: 
@ATK_ROLE_COMBO_BOX: 
@ATK_ROLE_DATE_EDITOR: 
@ATK_ROLE_DESKTOP_ICON: 
@ATK_ROLE_DESKTOP_FRAME: 
@ATK_ROLE_DIAL: 
@ATK_ROLE_DIALOG: 
@ATK_ROLE_DIRECTORY_PANE: 
@ATK_ROLE_DRAWING_AREA: 
@ATK_ROLE_FILE_CHOOSER: 
@ATK_ROLE_FILLER: 
@ATK_ROLE_FONT_CHOOSER: 
@ATK_ROLE_FRAME: 
@ATK_ROLE_GLASS_PANE: 
@ATK_ROLE_HTML_CONTAINER: 
@ATK_ROLE_ICON: 
@ATK_ROLE_IMAGE: 
@ATK_ROLE_INTERNAL_FRAME: 
@ATK_ROLE_LABEL: 
@ATK_ROLE_LAYERED_PANE: 
@ATK_ROLE_LIST: 
@ATK_ROLE_LIST_ITEM: 
@ATK_ROLE_MENU: 
@ATK_ROLE_MENU_BAR: 
@ATK_ROLE_MENU_ITEM: 
@ATK_ROLE_OPTION_PANE: 
@ATK_ROLE_PAGE_TAB: 
@ATK_ROLE_PAGE_TAB_LIST: 
@ATK_ROLE_PANEL: 
@ATK_ROLE_PASSWORD_TEXT: 
@ATK_ROLE_POPUP_MENU: 
@ATK_ROLE_PROGRESS_BAR: 
@ATK_ROLE_PUSH_BUTTON: 
@ATK_ROLE_RADIO_BUTTON: 
@ATK_ROLE_RADIO_MENU_ITEM: 
@ATK_ROLE_ROOT_PANE: 
@ATK_ROLE_ROW_HEADER: 
@ATK_ROLE_SCROLL_BAR: 
@ATK_ROLE_SCROLL_PANE: 
@ATK_ROLE_SEPARATOR: 
@ATK_ROLE_SLIDER: 
@ATK_ROLE_SPLIT_PANE: 
@ATK_ROLE_SPIN_BUTTON: 
@ATK_ROLE_STATUSBAR: 
@ATK_ROLE_TABLE: 
@ATK_ROLE_TABLE_CELL: 
@ATK_ROLE_TABLE_COLUMN_HEADER: 
@ATK_ROLE_TABLE_ROW_HEADER: 
@ATK_ROLE_TEAR_OFF_MENU_ITEM: 
@ATK_ROLE_TERMINAL: 
@ATK_ROLE_TEXT: 
@ATK_ROLE_TOGGLE_BUTTON: 
@ATK_ROLE_TOOL_BAR: 
@ATK_ROLE_TOOL_TIP: 
@ATK_ROLE_TREE: 
@ATK_ROLE_TREE_TABLE: 
@ATK_ROLE_UNKNOWN: 
@ATK_ROLE_VIEWPORT: 
@ATK_ROLE_WINDOW: 
@ATK_ROLE_LAST_DEFINED: 

<!-- ##### FUNCTION atk_role_register ##### -->
<para>

</para>

@name: 
@Returns: 


<!-- ##### ENUM AtkLayer ##### -->
<para>

</para>

@ATK_LAYER_INVALID: 
@ATK_LAYER_BACKGROUND: 
@ATK_LAYER_CANVAS: 
@ATK_LAYER_WIDGET: 
@ATK_LAYER_MDI: 
@ATK_LAYER_POPUP: 
@ATK_LAYER_OVERLAY: 

<!-- ##### STRUCT AtkImplementor ##### -->
<para>

</para>


<!-- ##### STRUCT AtkImplementorIface ##### -->
<para>

</para>

@parent: 
@ref_accessible: 

<!-- ##### STRUCT AtkRelationSet ##### -->
<para>

</para>

@parent: 
@relations: 

<!-- ##### STRUCT AtkPropertyValues ##### -->
<para>

</para>

@property_name: 
@old_value: 
@new_value: 

<!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### -->
<para>

</para>

@Param1: 
@Param2: 


<!-- ##### FUNCTION atk_implementor_ref_accessible ##### -->
<para>

</para>

@implementor: 
@Returns: 


<!-- ##### FUNCTION atk_object_get_name ##### -->
<para>

</para>

@accessible: 
@Returns: 


<!-- ##### FUNCTION atk_object_get_description ##### -->
<para>

</para>

@accessible: 
@Returns: 


<!-- ##### FUNCTION atk_object_get_parent ##### -->
<para>

</para>

@accessible: 
@Returns: 


<!-- ##### FUNCTION atk_object_get_n_accessible_children ##### -->
<para>

</para>

@accessible: 
@Returns: 


<!-- ##### FUNCTION atk_object_ref_accessible_child ##### -->
<para>

</para>

@accessible: 
@i: 
@Returns: 


<!-- ##### FUNCTION atk_object_ref_relation_set ##### -->
<para>

</para>

@accessible: 
@Returns: 


<!-- ##### FUNCTION atk_object_get_layer ##### -->
<para>

</para>

@accessible: 
@Returns: 


<!-- ##### FUNCTION atk_object_get_mdi_zorder ##### -->
<para>

</para>

@accessible: 
@Returns: 
<!-- # Unused Parameters # -->
@acessible: 


<!-- ##### FUNCTION atk_object_get_role ##### -->
<para>

</para>

@accessible: 
@Returns: 


<!-- ##### FUNCTION atk_object_ref_state_set ##### -->
<para>

</para>

@accessible: 
@Returns: 


<!-- ##### FUNCTION atk_object_get_index_in_parent ##### -->
<para>

</para>

@accessible: 
@Returns: 


<!-- ##### FUNCTION atk_object_set_name ##### -->
<para>

</para>

@accessible: 
@name: 


<!-- ##### FUNCTION atk_object_set_description ##### -->
<para>

</para>

@accessible: 
@description: 


<!-- ##### FUNCTION atk_object_set_parent ##### -->
<para>

</para>

@accessible: 
@parent: 


<!-- ##### FUNCTION atk_object_set_role ##### -->
<para>

</para>

@accessible: 
@role: 


<!-- ##### FUNCTION atk_object_connect_property_change_handler ##### -->
<para>

</para>

@accessible: 
@handler: 
@Returns: 


<!-- ##### FUNCTION atk_object_remove_property_change_handler ##### -->
<para>

</para>

@accessible: 
@handler_id: 


<!-- ##### FUNCTION atk_object_notify_state_change ##### -->
<para>

</para>

@accessible: 
@state: 
@value: