sync docs
[platform/upstream/atk.git] / docs / tmpl / atkobject.sgml
1 <!-- ##### SECTION Title ##### -->
2 AtkObject
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 <!-- ##### STRUCT AtkObject ##### -->
18 <para>
19
20 </para>
21
22 @parent: 
23 @description: 
24 @name: 
25 @accessible_parent: 
26 @role: 
27 @relation_set: 
28
29 <!-- ##### ENUM AtkRole ##### -->
30 <para>
31
32 </para>
33
34 @ATK_ROLE_INVALID: 
35 @ATK_ROLE_ACCEL_LABEL: 
36 @ATK_ROLE_ALERT: 
37 @ATK_ROLE_ANIMATION: 
38 @ATK_ROLE_ARROW: 
39 @ATK_ROLE_CALENDAR: 
40 @ATK_ROLE_CANVAS: 
41 @ATK_ROLE_CHECK_BOX: 
42 @ATK_ROLE_CHECK_MENU_ITEM: 
43 @ATK_ROLE_COLOR_CHOOSER: 
44 @ATK_ROLE_COLUMN_HEADER: 
45 @ATK_ROLE_COMBO_BOX: 
46 @ATK_ROLE_DATE_EDITOR: 
47 @ATK_ROLE_DESKTOP_ICON: 
48 @ATK_ROLE_DESKTOP_FRAME: 
49 @ATK_ROLE_DIAL: 
50 @ATK_ROLE_DIALOG: 
51 @ATK_ROLE_DIRECTORY_PANE: 
52 @ATK_ROLE_DRAWING_AREA: 
53 @ATK_ROLE_FILE_CHOOSER: 
54 @ATK_ROLE_FILLER: 
55 @ATK_ROLE_FONT_CHOOSER: 
56 @ATK_ROLE_FRAME: 
57 @ATK_ROLE_GLASS_PANE: 
58 @ATK_ROLE_HTML_CONTAINER: 
59 @ATK_ROLE_ICON: 
60 @ATK_ROLE_IMAGE: 
61 @ATK_ROLE_INTERNAL_FRAME: 
62 @ATK_ROLE_LABEL: 
63 @ATK_ROLE_LAYERED_PANE: 
64 @ATK_ROLE_LIST: 
65 @ATK_ROLE_LIST_ITEM: 
66 @ATK_ROLE_MENU: 
67 @ATK_ROLE_MENU_BAR: 
68 @ATK_ROLE_MENU_ITEM: 
69 @ATK_ROLE_OPTION_PANE: 
70 @ATK_ROLE_PAGE_TAB: 
71 @ATK_ROLE_PAGE_TAB_LIST: 
72 @ATK_ROLE_PANEL: 
73 @ATK_ROLE_PASSWORD_TEXT: 
74 @ATK_ROLE_POPUP_MENU: 
75 @ATK_ROLE_PROGRESS_BAR: 
76 @ATK_ROLE_PUSH_BUTTON: 
77 @ATK_ROLE_RADIO_BUTTON: 
78 @ATK_ROLE_RADIO_MENU_ITEM: 
79 @ATK_ROLE_ROOT_PANE: 
80 @ATK_ROLE_ROW_HEADER: 
81 @ATK_ROLE_SCROLL_BAR: 
82 @ATK_ROLE_SCROLL_PANE: 
83 @ATK_ROLE_SEPARATOR: 
84 @ATK_ROLE_SLIDER: 
85 @ATK_ROLE_SPLIT_PANE: 
86 @ATK_ROLE_SPIN_BUTTON: 
87 @ATK_ROLE_STATUSBAR: 
88 @ATK_ROLE_TABLE: 
89 @ATK_ROLE_TABLE_CELL: 
90 @ATK_ROLE_TABLE_COLUMN_HEADER: 
91 @ATK_ROLE_TABLE_ROW_HEADER: 
92 @ATK_ROLE_TEAR_OFF_MENU_ITEM: 
93 @ATK_ROLE_TEXT: 
94 @ATK_ROLE_TOGGLE_BUTTON: 
95 @ATK_ROLE_TOOL_BAR: 
96 @ATK_ROLE_TOOL_TIP: 
97 @ATK_ROLE_TREE: 
98 @ATK_ROLE_UNKNOWN: 
99 @ATK_ROLE_VIEWPORT: 
100 @ATK_ROLE_WINDOW: 
101 @ATK_ROLE_LAST_DEFINED: 
102
103 <!-- ##### FUNCTION atk_role_register ##### -->
104 <para>
105
106 </para>
107
108 @name: 
109 @Returns: 
110
111
112 <!-- ##### STRUCT AtkImplementor ##### -->
113 <para>
114
115 </para>
116
117
118 <!-- ##### STRUCT AtkImplementorIface ##### -->
119 <para>
120
121 </para>
122
123 @parent: 
124 @ref_accessible: 
125
126 <!-- ##### STRUCT AtkRelationSet ##### -->
127 <para>
128
129 </para>
130
131 @parent: 
132 @relations: 
133
134 <!-- ##### STRUCT AtkPropertyValues ##### -->
135 <para>
136
137 </para>
138
139 @property_name: 
140 @old_value: 
141 @new_value: 
142
143 <!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### -->
144 <para>
145
146 </para>
147
148 @Param1: 
149 @Param2: 
150
151
152 <!-- ##### FUNCTION atk_implementor_ref_accessible ##### -->
153 <para>
154
155 </para>
156
157 @implementor: 
158 @Returns: 
159
160
161 <!-- ##### FUNCTION atk_object_get_name ##### -->
162 <para>
163
164 </para>
165
166 @accessible: 
167 @Returns: 
168
169
170 <!-- ##### FUNCTION atk_object_get_description ##### -->
171 <para>
172
173 </para>
174
175 @accessible: 
176 @Returns: 
177
178
179 <!-- ##### FUNCTION atk_object_get_parent ##### -->
180 <para>
181
182 </para>
183
184 @accessible: 
185 @Returns: 
186
187
188 <!-- ##### FUNCTION atk_object_get_n_accessible_children ##### -->
189 <para>
190
191 </para>
192
193 @accessible: 
194 @Returns: 
195
196
197 <!-- ##### FUNCTION atk_object_ref_accessible_child ##### -->
198 <para>
199
200 </para>
201
202 @accessible: 
203 @i: 
204 @Returns: 
205
206
207 <!-- ##### FUNCTION atk_object_ref_relation_set ##### -->
208 <para>
209
210 </para>
211
212 @accessible: 
213 @Returns: 
214
215
216 <!-- ##### FUNCTION atk_object_get_role ##### -->
217 <para>
218
219 </para>
220
221 @accessible: 
222 @Returns: 
223
224
225 <!-- ##### FUNCTION atk_object_ref_state_set ##### -->
226 <para>
227
228 </para>
229
230 @accessible: 
231 @Returns: 
232
233
234 <!-- ##### FUNCTION atk_object_get_index_in_parent ##### -->
235 <para>
236
237 </para>
238
239 @accessible: 
240 @Returns: 
241
242
243 <!-- ##### FUNCTION atk_object_set_name ##### -->
244 <para>
245
246 </para>
247
248 @accessible: 
249 @name: 
250
251
252 <!-- ##### FUNCTION atk_object_set_description ##### -->
253 <para>
254
255 </para>
256
257 @accessible: 
258 @description: 
259
260
261 <!-- ##### FUNCTION atk_object_set_parent ##### -->
262 <para>
263
264 </para>
265
266 @accessible: 
267 @parent: 
268
269
270 <!-- ##### FUNCTION atk_object_set_role ##### -->
271 <para>
272
273 </para>
274
275 @accessible: 
276 @role: 
277
278
279 <!-- ##### FUNCTION atk_object_connect_property_change_handler ##### -->
280 <para>
281
282 </para>
283
284 @accessible: 
285 @handler: 
286 @Returns: 
287
288
289 <!-- ##### FUNCTION atk_object_remove_property_change_handler ##### -->
290 <para>
291
292 </para>
293
294 @accessible: 
295 @handler_id: 
296
297