Add convenience function atk_object_notify_state_change() to generate
[platform/upstream/atk.git] / docs / atk-sections.txt
1 <SECTION>
2 <FILE>atkaction</FILE>
3 <TITLE>AtkAction</TITLE>
4 AtkAction
5 AtkActionIface
6 atk_action_do_action
7 atk_action_get_n_actions
8 atk_action_get_description
9 atk_action_get_name
10 atk_action_get_keybinding
11 atk_action_set_description
12 <SUBSECTION Standard>
13 ATK_ACTION
14 ATK_IS_ACTION
15 ATK_TYPE_ACTION
16 ATK_ACTION_GET_IFACE
17 atk_action_get_type
18 </SECTION>
19
20 <SECTION>
21 <FILE>atkcomponent</FILE>
22 <TITLE>AtkComponent</TITLE>
23 AtkComponent
24 AtkComponentIface
25 atk_component_add_focus_handler
26 atk_component_contains
27 atk_component_get_extents
28 atk_component_get_position
29 atk_component_get_size
30 atk_component_grab_focus
31 atk_component_ref_accessible_at_point
32 atk_component_remove_focus_handler
33 atk_component_set_extents
34 atk_component_set_position
35 atk_component_set_size
36 <SUBSECTION Standard>
37 ATK_COMPONENT
38 ATK_IS_COMPONENT
39 ATK_TYPE_COMPONENT
40 ATK_COMPONENT_GET_IFACE
41 AtkFocusHandler
42 atk_component_get_type
43 </SECTION>
44
45 <SECTION>
46 <FILE>atkdocument</FILE>
47 <TITLE>AtkDocument</TITLE>
48 AtkDocument
49 AtkDocumentIface
50 atk_document_get_document_type
51 atk_document_get_document
52 <SUBSECTION Standard>
53 ATK_DOCUMENT
54 ATK_IS_DOCUMENT
55 ATK_TYPE_DOCUMENT
56 ATK_DOCUMENT_GET_IFACE
57 atk_document_get_type
58 </SECTION>
59
60 <SECTION>
61 <FILE>atkeditabletext</FILE>
62 <TITLE>AtkEditableText</TITLE>
63 AtkEditableText
64 AtkEditableTextIface
65 atk_editable_text_set_run_attributes
66 atk_editable_text_set_text_contents
67 atk_editable_text_insert_text
68 atk_editable_text_copy_text
69 atk_editable_text_cut_text
70 atk_editable_text_delete_text
71 atk_editable_text_paste_text
72 <SUBSECTION Standard>
73 ATK_EDITABLE_TEXT
74 ATK_IS_EDITABLE_TEXT
75 ATK_TYPE_EDITABLE_TEXT
76 ATK_EDITABLE_TEXT_GET_IFACE
77 atk_editable_text_get_type
78 </SECTION>
79
80 <SECTION>
81 <FILE>atkhypertext</FILE>
82 <TITLE>AtkHypertext</TITLE>
83 AtkHypertext
84 AtkHypertextIface
85 atk_hypertext_get_link
86 atk_hypertext_get_n_links
87 atk_hypertext_get_link_index
88 <SUBSECTION Standard>
89 ATK_HYPERTEXT
90 ATK_IS_HYPERTEXT
91 ATK_TYPE_HYPERTEXT
92 ATK_HYPERTEXT_GET_IFACE
93 atk_hypertext_get_type
94 </SECTION>
95
96 <SECTION>
97 <FILE>atkimage</FILE>
98 <TITLE>AtkImage</TITLE>
99 AtkImage
100 AtkImageIface
101 atk_image_get_image_position
102 atk_image_get_image_description
103 atk_image_set_image_description
104 atk_image_get_image_size
105 <SUBSECTION Standard>
106 ATK_IMAGE
107 ATK_IS_IMAGE
108 ATK_TYPE_IMAGE
109 ATK_IMAGE_GET_IFACE
110 atk_image_get_type
111 </SECTION>
112
113 <SECTION>
114 <FILE>atknoopobject</FILE>
115 <TITLE>AtkNoOpObject</TITLE>
116 atk_no_op_object_new
117 <SUBSECTION Standard>
118 ATK_NO_OP_OBJECT
119 ATK_IS_NO_OP_OBJECT
120 ATK_TYPE_NO_OP_OBJECT
121 atk_no_op_object_get_type
122 ATK_NO_OP_OBJECT_CLASS
123 ATK_IS_NO_OP_OBJECT_CLASS
124 ATK_NO_OP_OBJECT_GET_CLASS
125 </SECTION>
126
127 <SECTION>
128 <FILE>atknoopobjectfactory</FILE>
129 <TITLE>AtkNoOpObjectFactory</TITLE>
130 atk_no_op_object_factory_new
131 <SUBSECTION Standard>
132 ATK_NO_OP_OBJECT_FACTORY
133 ATK_IS_NO_OP_OBJECT_FACTORY
134 ATK_TYPE_NO_OP_OBJECT_FACTORY
135 atk_no_op_object_factory_get_type
136 ATK_NO_OP_OBJECT_FACTORY_CLASS
137 ATK_IS_NO_OP_OBJECT_FACTORY_CLASS
138 ATK_NO_OP_OBJECT_FACTORY_GET_CLASS
139 </SECTION>
140
141 <SECTION>
142 <FILE>atkobject</FILE>
143 <TITLE>AtkObject</TITLE>
144 AtkRole
145 atk_role_register
146 AtkImplementor
147 AtkImplementorIface
148 AtkRelationSet
149 AtkPropertyValues
150 AtkPropertyChangeHandler
151 atk_implementor_ref_accessible
152 atk_object_get_name
153 atk_object_get_description
154 atk_object_get_parent
155 atk_object_get_n_accessible_children
156 atk_object_ref_accessible_child
157 atk_object_ref_relation_set
158 atk_object_get_role
159 atk_object_ref_state_set
160 atk_object_get_index_in_parent
161 atk_object_set_name
162 atk_object_set_description
163 atk_object_set_parent
164 atk_object_set_role
165 atk_object_connect_property_change_handler
166 atk_object_remove_property_change_handler
167 atk_object_notify_state_change
168 <SUBSECTION Standard>
169 ATK_OBJECT
170 ATK_IS_OBJECT
171 ATK_TYPE_OBJECT
172 ATK_IMPLEMENTOR_GET_IFACE
173 ATK_OBJECT_CLASS
174 ATK_IS_OBJECT_CLASS
175 ATK_OBJECT_GET_CLASS
176 ATK_TYPE_IMPLEMENTOR
177 ATK_IS_IMPLEMENTOR
178 ATK_IMPLEMENTOR
179 AtkStateSet
180 atk_implementor_get_type
181 atk_object_get_type
182 </SECTION>
183
184 <SECTION>
185 <FILE>atkobjectfactory</FILE>
186 <TITLE>AtkObjectFactory</TITLE>
187 atk_object_factory_create_accessible
188 atk_object_factory_invalidate
189 <SUBSECTION Standard>
190 ATK_OBJECT_FACTORY
191 ATK_IS_OBJECT_FACTORY
192 ATK_TYPE_OBJECT_FACTORY
193 atk_object_factory_get_type
194 ATK_OBJECT_FACTORY_CLASS
195 ATK_IS_OBJECT_FACTORY_CLASS
196 ATK_OBJECT_FACTORY_GET_CLASS
197 </SECTION>
198
199 <SECTION>
200 <FILE>atkregistry</FILE>
201 <TITLE>AtkRegistry</TITLE>
202 atk_registry_set_factory_type
203 atk_registry_get_factory_type
204 atk_registry_get_factory
205 atk_get_default_registry
206 <SUBSECTION Standard>
207 ATK_REGISTRY
208 ATK_IS_REGISTRY
209 ATK_TYPE_REGISTRY
210 ATK_REGISTRY_CLASS
211 ATK_IS_REGISTRY_CLASS
212 ATK_REGISTRY_GET_CLASS
213 </SECTION>
214
215 <SECTION>
216 <FILE>atkrelation</FILE>
217 <TITLE>AtkRelation</TITLE>
218 AtkRelationType
219 atk_relation_type_register
220 atk_relation_new
221 atk_relation_get_relation_type
222 atk_relation_get_target
223 <SUBSECTION Standard>
224 ATK_RELATION
225 ATK_IS_RELATION
226 ATK_TYPE_RELATION
227 atk_relation_get_type
228 ATK_RELATION_CLASS
229 ATK_IS_RELATION_CLASS
230 ATK_RELATION_GET_CLASS
231 </SECTION>
232
233 <SECTION>
234 <FILE>atkrelationset</FILE>
235 <TITLE>AtkRelationSet</TITLE>
236 atk_relation_set_new
237 atk_relation_set_contains
238 atk_relation_set_remove
239 atk_relation_set_add
240 atk_relation_set_get_n_relations
241 atk_relation_set_get_relation
242 atk_relation_set_get_relation_by_type
243 <SUBSECTION Standard>
244 ATK_RELATION_SET
245 ATK_IS_RELATION_SET
246 ATK_TYPE_RELATION_SET
247 atk_relation_set_get_type
248 ATK_RELATION_SET_CLASS
249 ATK_IS_RELATION_SET_CLASS
250 ATK_RELATION_SET_GET_CLASS
251 </SECTION>
252
253 <SECTION>
254 <FILE>atkselection</FILE>
255 <TITLE>AtkSelection</TITLE>
256 AtkSelection
257 AtkSelectionIface
258 atk_selection_add_selection
259 atk_selection_clear_selection
260 atk_selection_ref_selection
261 atk_selection_get_selection_count
262 atk_selection_is_child_selected
263 atk_selection_remove_selection
264 atk_selection_select_all_selection
265 <SUBSECTION Standard>
266 ATK_SELECTION
267 ATK_IS_SELECTION
268 ATK_TYPE_SELECTION
269 ATK_SELECTION_GET_IFACE
270 atk_selection_get_type
271 </SECTION>
272
273 <SECTION>
274 <FILE>atkstateset</FILE>
275 <TITLE>AtkStateSet</TITLE>
276 atk_state_set_new
277 atk_state_set_is_empty
278 atk_state_set_add_state
279 atk_state_set_add_states
280 atk_state_set_clear_states
281 atk_state_set_contains_state
282 atk_state_set_contains_states
283 atk_state_set_remove_state
284 atk_state_set_and_sets
285 atk_state_set_or_sets
286 atk_state_set_xor_sets
287 <SUBSECTION Standard>
288 ATK_STATE_SET
289 ATK_IS_STATE_SET
290 ATK_TYPE_STATE_SET
291 atk_state_set_get_type
292 ATK_STATE_SET_CLASS
293 ATK_IS_STATE_SET_CLASS
294 ATK_STATE_SET_GET_CLASS
295 </SECTION>
296
297 <SECTION>
298 <FILE>atktable</FILE>
299 <TITLE>AtkTable</TITLE>
300 AtkTable
301 AtkTableIface
302 atk_table_ref_at
303 atk_table_get_index_at
304 atk_table_get_column_at_index
305 atk_table_get_row_at_index
306 atk_table_get_n_columns
307 atk_table_get_n_rows
308 atk_table_get_column_extent_at
309 atk_table_get_row_extent_at
310 atk_table_get_caption
311 atk_table_get_column_description
312 atk_table_get_row_description
313 atk_table_get_column_header
314 atk_table_get_row_header
315 atk_table_get_summary
316 atk_table_set_caption
317 atk_table_set_row_description
318 atk_table_set_column_description
319 atk_table_set_row_header
320 atk_table_set_column_header
321 atk_table_set_summary
322 atk_table_get_selected_columns
323 atk_table_get_selected_rows
324 atk_table_is_column_selected
325 atk_table_is_row_selected
326 atk_table_is_selected
327 atk_table_add_column_selection
328 atk_table_add_row_selection
329 atk_table_remove_column_selection
330 atk_table_remove_row_selection
331 <SUBSECTION Standard>
332 ATK_TABLE
333 ATK_IS_TABLE
334 ATK_TYPE_TABLE
335 ATK_TABLE_GET_IFACE
336 atk_table_get_type
337 </SECTION>
338
339 <SECTION>
340 <FILE>atktext</FILE>
341 <TITLE>AtkText</TITLE>
342 AtkText
343 AtkTextIface
344 AtkTextBoundary
345 AtkAttribute
346 AtkAttributeSet
347 AtkTextAttribute
348 atk_text_get_text
349 atk_text_get_character_at_offset
350 atk_text_get_text_after_offset
351 atk_text_get_text_at_offset
352 atk_text_get_text_before_offset
353 atk_text_get_caret_offset
354 atk_text_get_character_extents
355 atk_text_get_run_attributes
356 atk_text_get_default_attributes
357 atk_text_get_character_count
358 atk_text_get_offset_at_point
359 atk_text_get_n_selections
360 atk_text_get_selection
361 atk_text_add_selection
362 atk_text_remove_selection
363 atk_text_set_selection
364 atk_text_set_caret_offset
365 atk_attribute_set_free
366 atk_attribute_get_name
367 atk_attribute_get_value
368 <SUBSECTION Standard>
369 ATK_TEXT
370 ATK_IS_TEXT
371 ATK_TYPE_TEXT
372 ATK_TEXT_GET_IFACE
373 atk_text_get_type
374 </SECTION>
375
376 <SECTION>
377 <FILE>atkvalue</FILE>
378 <TITLE>AtkValue</TITLE>
379 AtkValue
380 AtkValueIface
381 atk_value_get_current_value
382 atk_value_get_maximum_value
383 atk_value_get_minimum_value
384 atk_value_set_current_value
385 <SUBSECTION Standard>
386 ATK_VALUE
387 ATK_IS_VALUE
388 ATK_TYPE_VALUE
389 ATK_VALUE_GET_IFACE
390 atk_value_get_type
391 </SECTION>
392
393 <SECTION>
394 <FILE>atkhyperlink</FILE>
395 <TITLE>AtkHyperlink</TITLE>
396 atk_hyperlink_get_uri
397 atk_hyperlink_get_object
398 atk_hyperlink_get_end_index
399 atk_hyperlink_get_start_index
400 atk_hyperlink_is_valid
401 atk_hyperlink_get_n_anchors
402 <SUBSECTION Standard>
403 ATK_HYPERLINK
404 ATK_IS_HYPERLINK
405 ATK_TYPE_HYPERLINK
406 atk_hyperlink_get_type
407 ATK_HYPERLINK_CLASS
408 ATK_IS_HYPERLINK_CLASS
409 ATK_HYPERLINK_GET_CLASS
410 </SECTION>
411
412 <SECTION>
413 <FILE>atkstate</FILE>
414 <TITLE>AtkState</TITLE>
415 AtkStateType
416 AtkState
417 atk_state_type_register
418 atk_state_type_get_name
419 atk_state_type_for_name
420 </SECTION>
421
422 <SECTION>
423 <FILE>atkstreamablecontent</FILE>
424 <TITLE>AtkStreamableContent</TITLE>
425 atk_streamable_content_get_n_mime_types
426 atk_streamable_content_get_mime_type
427 atk_streamable_content_get_stream       
428 <SUBSECTION Standard>
429 atk_streamable_content_get_type
430 </SECTION>
431
432 <SECTION>
433 <FILE>atkutil</FILE>
434 <TITLE>AtkUtil</TITLE>
435 AtkCoordType
436 atk_add_focus_tracker
437 atk_remove_focus_tracker
438 atk_focus_tracker_init
439 atk_focus_tracker_notify
440 atk_add_global_event_listener
441 atk_remove_global_event_listener
442 atk_get_root
443 atk_get_toolkit_name
444 atk_get_toolkit_version
445 <SUBSECTION Standard>
446 AtkEventListener
447 AtkEventListenerInit
448 </SECTION>
449