doc: improve documentation of AtkAttribute and AtkAttributeSet
[atk.git] / docs / atk-sections.txt
blob881ad608a6f42976821d96d921cae9af6065a30d
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_localized_name
11 atk_action_get_keybinding
12 atk_action_set_description
13 <SUBSECTION Standard>
14 ATK_ACTION
15 ATK_IS_ACTION
16 ATK_TYPE_ACTION
17 ATK_ACTION_GET_IFACE
18 atk_action_get_type
19 </SECTION>
21 <SECTION>
22 <FILE>atkcomponent</FILE>
23 <TITLE>AtkComponent</TITLE>
24 AtkComponent
25 AtkComponentIface
26 AtkFocusHandler
27 AtkRectangle
28 atk_component_add_focus_handler
29 atk_component_contains
30 atk_component_get_extents
31 atk_component_get_layer
32 atk_component_get_mdi_zorder
33 atk_component_get_position
34 atk_component_get_size
35 atk_component_grab_focus
36 atk_component_ref_accessible_at_point
37 atk_component_remove_focus_handler
38 atk_component_set_extents
39 atk_component_set_position
40 atk_component_set_size
41 atk_component_get_alpha
42 <SUBSECTION Standard>
43 ATK_COMPONENT
44 ATK_IS_COMPONENT
45 ATK_TYPE_COMPONENT
46 ATK_TYPE_RECTANGLE
47 ATK_COMPONENT_GET_IFACE
48 atk_component_get_type
49 atk_rectangle_get_type
50 </SECTION>
52 <SECTION>
53 <FILE>atkdocument</FILE>
54 <TITLE>AtkDocument</TITLE>
55 AtkDocument
56 AtkDocumentIface
57 atk_document_get_document_type
58 atk_document_get_document
59 atk_document_get_attribute_value
60 atk_document_set_attribute_value
61 atk_document_get_attributes
62 atk_document_get_locale
63 <SUBSECTION Standard>
64 ATK_DOCUMENT
65 ATK_IS_DOCUMENT
66 ATK_TYPE_DOCUMENT
67 ATK_DOCUMENT_GET_IFACE
68 atk_document_get_type
69 </SECTION>
71 <SECTION>
72 <FILE>atkeditabletext</FILE>
73 <TITLE>AtkEditableText</TITLE>
74 AtkEditableText
75 atk_editable_text_set_run_attributes
76 atk_editable_text_set_text_contents
77 atk_editable_text_insert_text
78 atk_editable_text_copy_text
79 atk_editable_text_cut_text
80 atk_editable_text_delete_text
81 atk_editable_text_paste_text
82 <SUBSECTION Standard>
83 AtkEditableTextIface
84 ATK_EDITABLE_TEXT
85 ATK_IS_EDITABLE_TEXT
86 ATK_TYPE_EDITABLE_TEXT
87 ATK_EDITABLE_TEXT_GET_IFACE
88 atk_editable_text_get_type
89 </SECTION>
91 <SECTION>
92 <FILE>atkhypertext</FILE>
93 <TITLE>AtkHypertext</TITLE>
94 AtkHypertext
95 atk_hypertext_get_link
96 atk_hypertext_get_n_links
97 atk_hypertext_get_link_index
98 <SUBSECTION Standard>
99 AtkHypertextIface
100 ATK_HYPERTEXT
101 ATK_IS_HYPERTEXT
102 ATK_TYPE_HYPERTEXT
103 ATK_HYPERTEXT_GET_IFACE
104 atk_hypertext_get_type
105 </SECTION>
107 <SECTION>
108 <FILE>atkimage</FILE>
109 <TITLE>AtkImage</TITLE>
110 AtkImage
111 atk_image_get_image_position
112 atk_image_get_image_description
113 atk_image_set_image_description
114 atk_image_get_image_size
115 atk_image_get_image_locale
116 <SUBSECTION Standard>
117 AtkImageIface
118 ATK_IMAGE
119 ATK_IS_IMAGE
120 ATK_TYPE_IMAGE
121 ATK_IMAGE_GET_IFACE
122 atk_image_get_type
123 </SECTION>
125 <SECTION>
126 <FILE>atknoopobject</FILE>
127 <TITLE>AtkNoOpObject</TITLE>
128 AtkNoOpObject
129 atk_no_op_object_new
130 <SUBSECTION Standard>
131 ATK_NO_OP_OBJECT
132 ATK_IS_NO_OP_OBJECT
133 ATK_TYPE_NO_OP_OBJECT
134 atk_no_op_object_get_type
135 ATK_NO_OP_OBJECT_CLASS
136 ATK_IS_NO_OP_OBJECT_CLASS
137 ATK_NO_OP_OBJECT_GET_CLASS
138 AtkNoOpObjectClass
139 </SECTION>
141 <SECTION>
142 <FILE>atknoopobjectfactory</FILE>
143 <TITLE>AtkNoOpObjectFactory</TITLE>
144 AtkNoOpObjectFactory
145 atk_no_op_object_factory_new
146 <SUBSECTION Standard>
147 ATK_NO_OP_OBJECT_FACTORY
148 ATK_IS_NO_OP_OBJECT_FACTORY
149 ATK_TYPE_NO_OP_OBJECT_FACTORY
150 atk_no_op_object_factory_get_type
151 ATK_NO_OP_OBJECT_FACTORY_CLASS
152 ATK_IS_NO_OP_OBJECT_FACTORY_CLASS
153 ATK_NO_OP_OBJECT_FACTORY_GET_CLASS
154 AtkNoOpObjectFactoryClass
155 </SECTION>
157 <SECTION>
158 <FILE>atkobject</FILE>
159 <TITLE>AtkObject</TITLE>
160 AtkObject
161 AtkRole
162 atk_role_register
163 AtkLayer
164 AtkImplementor
165 AtkAttribute
166 AtkAttributeSet
167 AtkPropertyValues
168 AtkFunction
169 AtkPropertyChangeHandler
170 atk_implementor_ref_accessible
171 atk_object_get_name
172 atk_object_get_description
173 atk_object_get_parent
174 atk_object_get_n_accessible_children
175 atk_object_ref_accessible_child
176 atk_object_ref_relation_set
177 atk_object_get_layer
178 atk_object_get_mdi_zorder
179 atk_object_get_role
180 atk_object_ref_state_set
181 atk_object_get_index_in_parent
182 atk_object_set_name
183 atk_object_set_description
184 atk_object_set_parent
185 atk_object_set_role
186 atk_object_connect_property_change_handler
187 atk_object_remove_property_change_handler
188 atk_object_notify_state_change
189 atk_object_initialize
190 atk_object_add_relationship
191 atk_object_remove_relationship
192 atk_object_get_attributes
193 atk_object_get_object_locale
194 atk_role_get_name
195 atk_role_get_localized_name
196 atk_role_for_name
197 <SUBSECTION Standard>
198 AtkImplementorIface
199 ATK_OBJECT
200 ATK_IS_OBJECT
201 ATK_TYPE_OBJECT
202 ATK_IMPLEMENTOR_GET_IFACE
203 ATK_OBJECT_CLASS
204 ATK_IS_OBJECT_CLASS
205 ATK_OBJECT_GET_CLASS
206 ATK_TYPE_IMPLEMENTOR
207 ATK_IS_IMPLEMENTOR
208 ATK_IMPLEMENTOR
209 ATK_TYPE_ROLE
210 ATK_TYPE_LAYER
211 AtkStateSet
212 atk_implementor_get_type
213 atk_object_get_type
214 atk_role_get_type
215 atk_layer_get_type
216 AtkObjectClass
217 </SECTION>
219 <SECTION>
220 <FILE>atkobjectfactory</FILE>
221 <TITLE>AtkObjectFactory</TITLE>
222 AtkObjectFactory
223 atk_object_factory_create_accessible
224 atk_object_factory_get_accessible_type
225 atk_object_factory_invalidate
226 <SUBSECTION Standard>
227 ATK_OBJECT_FACTORY
228 ATK_IS_OBJECT_FACTORY
229 ATK_TYPE_OBJECT_FACTORY
230 atk_object_factory_get_type
231 ATK_OBJECT_FACTORY_CLASS
232 ATK_IS_OBJECT_FACTORY_CLASS
233 ATK_OBJECT_FACTORY_GET_CLASS
234 AtkObjectFactoryClass
235 </SECTION>
237 <SECTION>
238 <FILE>atkregistry</FILE>
239 <TITLE>AtkRegistry</TITLE>
240 AtkRegistry
241 atk_registry_set_factory_type
242 atk_registry_get_factory_type
243 atk_registry_get_factory
244 atk_get_default_registry
245 <SUBSECTION Standard>
246 ATK_REGISTRY
247 ATK_IS_REGISTRY
248 ATK_TYPE_REGISTRY
249 atk_registry_get_type
250 ATK_REGISTRY_CLASS
251 ATK_IS_REGISTRY_CLASS
252 ATK_REGISTRY_GET_CLASS
253 AtkRegistryClass
254 </SECTION>
256 <SECTION>
257 <FILE>atkrelation</FILE>
258 <TITLE>AtkRelation</TITLE>
259 AtkRelation
260 AtkRelationType
261 atk_relation_type_register
262 atk_relation_type_get_name
263 atk_relation_type_for_name
264 atk_relation_new
265 atk_relation_get_relation_type
266 atk_relation_get_target
267 atk_relation_add_target
268 atk_relation_remove_target
269 <SUBSECTION Standard>
270 ATK_RELATION
271 ATK_IS_RELATION
272 ATK_TYPE_RELATION
273 ATK_TYPE_RELATION_TYPE
274 atk_relation_get_type
275 atk_relation_type_get_type
276 ATK_RELATION_CLASS
277 ATK_IS_RELATION_CLASS
278 ATK_RELATION_GET_CLASS
279 AtkRelationClass
280 </SECTION>
282 <SECTION>
283 <FILE>atkrelationset</FILE>
284 <TITLE>AtkRelationSet</TITLE>
285 AtkRelationSet
286 atk_relation_set_new
287 atk_relation_set_contains
288 atk_relation_set_remove
289 atk_relation_set_add
290 atk_relation_set_get_n_relations
291 atk_relation_set_get_relation
292 atk_relation_set_get_relation_by_type
293 atk_relation_set_add_relation_by_type
294 <SUBSECTION Standard>
295 ATK_RELATION_SET
296 ATK_IS_RELATION_SET
297 ATK_TYPE_RELATION_SET
298 atk_relation_set_get_type
299 ATK_RELATION_SET_CLASS
300 ATK_IS_RELATION_SET_CLASS
301 ATK_RELATION_SET_GET_CLASS
302 AtkRelationSetClass
303 </SECTION>
305 <SECTION>
306 <FILE>atkselection</FILE>
307 <TITLE>AtkSelection</TITLE>
308 AtkSelection
309 atk_selection_add_selection
310 atk_selection_clear_selection
311 atk_selection_ref_selection
312 atk_selection_get_selection_count
313 atk_selection_is_child_selected
314 atk_selection_remove_selection
315 atk_selection_select_all_selection
316 <SUBSECTION Standard>
317 AtkSelectionIface
318 ATK_SELECTION
319 ATK_IS_SELECTION
320 ATK_TYPE_SELECTION
321 ATK_SELECTION_GET_IFACE
322 atk_selection_get_type
323 </SECTION>
325 <SECTION>
326 <FILE>atkstateset</FILE>
327 <TITLE>AtkStateSet</TITLE>
328 AtkStateSet
329 atk_state_set_new
330 atk_state_set_is_empty
331 atk_state_set_add_state
332 atk_state_set_add_states
333 atk_state_set_clear_states
334 atk_state_set_contains_state
335 atk_state_set_contains_states
336 atk_state_set_remove_state
337 atk_state_set_and_sets
338 atk_state_set_or_sets
339 atk_state_set_xor_sets
340 <SUBSECTION Standard>
341 ATK_STATE_SET
342 ATK_IS_STATE_SET
343 ATK_TYPE_STATE_SET
344 atk_state_set_get_type
345 ATK_STATE_SET_CLASS
346 ATK_IS_STATE_SET_CLASS
347 ATK_STATE_SET_GET_CLASS
348 AtkStateSetClass
349 </SECTION>
351 <SECTION>
352 <FILE>atktable</FILE>
353 <TITLE>AtkTable</TITLE>
354 AtkTable
355 atk_table_ref_at
356 atk_table_get_index_at
357 atk_table_get_column_at_index
358 atk_table_get_row_at_index
359 atk_table_get_n_columns
360 atk_table_get_n_rows
361 atk_table_get_column_extent_at
362 atk_table_get_row_extent_at
363 atk_table_get_caption
364 atk_table_get_column_description
365 atk_table_get_row_description
366 atk_table_get_column_header
367 atk_table_get_row_header
368 atk_table_get_summary
369 atk_table_set_caption
370 atk_table_set_row_description
371 atk_table_set_column_description
372 atk_table_set_row_header
373 atk_table_set_column_header
374 atk_table_set_summary
375 atk_table_get_selected_columns
376 atk_table_get_selected_rows
377 atk_table_is_column_selected
378 atk_table_is_row_selected
379 atk_table_is_selected
380 atk_table_add_column_selection
381 atk_table_add_row_selection
382 atk_table_remove_column_selection
383 atk_table_remove_row_selection
384 <SUBSECTION Standard>
385 AtkTableIface
386 ATK_TABLE
387 ATK_IS_TABLE
388 ATK_TYPE_TABLE
389 ATK_TABLE_GET_IFACE
390 atk_table_get_type
391 </SECTION>
393 <SECTION>
394 <FILE>atktext</FILE>
395 <TITLE>AtkText</TITLE>
396 AtkText
397 AtkTextIface
398 AtkTextBoundary
399 AtkTextGranularity
400 AtkTextClipType
401 AtkTextRange
402 AtkTextRectangle
403 AtkTextAttribute
404 atk_text_get_text
405 atk_text_get_character_at_offset
406 atk_text_get_text_after_offset
407 atk_text_get_text_at_offset
408 atk_text_get_text_before_offset
409 atk_text_get_string_at_offset
410 atk_text_get_caret_offset
411 atk_text_get_character_extents
412 atk_text_get_run_attributes
413 atk_text_get_default_attributes
414 atk_text_get_character_count
415 atk_text_get_offset_at_point
416 atk_text_get_bounded_ranges
417 atk_text_get_range_extents
418 atk_text_free_ranges
419 atk_text_get_n_selections
420 atk_text_get_selection
421 atk_text_add_selection
422 atk_text_remove_selection
423 atk_text_set_selection
424 atk_text_set_caret_offset
425 atk_attribute_set_free
426 atk_text_attribute_register
427 atk_text_attribute_get_name
428 atk_text_attribute_for_name
429 atk_text_attribute_get_value
430 <SUBSECTION Standard>
431 ATK_TEXT
432 ATK_IS_TEXT
433 ATK_TYPE_TEXT
434 ATK_TEXT_GET_IFACE
435 ATK_TYPE_TEXT_ATTRIBUTE
436 ATK_TYPE_TEXT_BOUNDARY
437 ATK_TYPE_TEXT_GRANULARITY
438 ATK_TYPE_TEXT_CLIP_TYPE
439 atk_text_get_type
440 atk_text_attribute_get_type
441 atk_text_boundary_get_type
442 atk_text_granularity_get_type
443 atk_text_clip_type_get_type
444 </SECTION>
446 <SECTION>
447 <FILE>atkvalue</FILE>
448 <TITLE>AtkValue</TITLE>
449 AtkValue
450 atk_value_get_current_value
451 atk_value_get_maximum_value
452 atk_value_get_minimum_value
453 atk_value_set_current_value
454 atk_value_get_minimum_increment
455 <SUBSECTION Standard>
456 AtkValueIface
457 ATK_VALUE
458 ATK_IS_VALUE
459 ATK_TYPE_VALUE
460 ATK_VALUE_GET_IFACE
461 atk_value_get_type
462 </SECTION>
464 <SECTION>
465 <FILE>atkhyperlink</FILE>
466 <TITLE>AtkHyperlink</TITLE>
467 AtkHyperlink
468 AtkHyperlinkStateFlags
469 atk_hyperlink_get_uri
470 atk_hyperlink_get_object
471 atk_hyperlink_get_end_index
472 atk_hyperlink_get_start_index
473 atk_hyperlink_is_valid
474 atk_hyperlink_is_inline
475 atk_hyperlink_get_n_anchors
476 atk_hyperlink_is_selected_link
477 <SUBSECTION Standard>
478 ATK_HYPERLINK
479 ATK_IS_HYPERLINK
480 ATK_TYPE_HYPERLINK
481 atk_hyperlink_get_type
482 ATK_HYPERLINK_CLASS
483 ATK_IS_HYPERLINK_CLASS
484 ATK_HYPERLINK_GET_CLASS
485 atk_hyperlink_state_flags_get_type
486 ATK_TYPE_HYPERLINK_STATE_FLAGS
487 AtkHyperlinkClass
488 </SECTION>
490 <SECTION>
491 <FILE>atkhyperlinkimpl</FILE>
492 <TITLE>AtkHyperlinkImpl</TITLE>
493 AtkHyperlinkImpl
494 atk_hyperlink_impl_get_hyperlink
495 <SUBSECTION Standard>
496 AtkHyperlinkImplIface
497 ATK_HYPERLINK_IMPL
498 ATK_IS_HYPERLINK_IMPL
499 ATK_TYPE_HYPERLINK_IMPL
500 atk_hyperlink_impl_get_type
501 ATK_HYPERLINK_IMPL_GET_IFACE
502 </SECTION>
504 <SECTION>
505 <FILE>atkstate</FILE>
506 <TITLE>AtkState</TITLE>
507 AtkStateType
508 AtkState
509 atk_state_type_register
510 atk_state_type_get_name
511 atk_state_type_for_name
512 <SUBSECTION Standard>
513 ATK_TYPE_STATE_TYPE
514 atk_state_type_get_type
515 </SECTION>
517 <SECTION>
518 <FILE>atkstreamablecontent</FILE>
519 <TITLE>AtkStreamableContent</TITLE>
520 AtkStreamableContent
521 atk_streamable_content_get_n_mime_types
522 atk_streamable_content_get_mime_type
523 atk_streamable_content_get_stream       
524 atk_streamable_content_get_uri
525 <SUBSECTION Standard>
526 AtkStreamableContentIface
527 ATK_STREAMABLE_CONTENT
528 ATK_IS_STREAMABLE_CONTENT
529 ATK_TYPE_STREAMABLE_CONTENT
530 atk_streamable_content_get_type
531 ATK_STREAMABLE_CONTENT_GET_IFACE
532 </SECTION>
534 <SECTION>
535 <FILE>atkutil</FILE>
536 <TITLE>AtkUtil</TITLE>
537 AtkUtil
538 AtkCoordType
539 atk_add_focus_tracker
540 atk_remove_focus_tracker
541 atk_focus_tracker_init
542 atk_focus_tracker_notify
543 AtkEventListener
544 AtkEventListenerInit
545 atk_add_global_event_listener
546 atk_remove_global_event_listener
547 AtkKeyEventStruct
548 AtkKeyEventType
549 AtkKeySnoopFunc
550 atk_add_key_event_listener
551 atk_remove_key_event_listener
552 atk_get_root
553 atk_get_focus_object
554 atk_get_toolkit_name
555 atk_get_toolkit_version
556 atk_get_version
557 ATK_DEFINE_TYPE
558 ATK_DEFINE_TYPE_EXTENDED
559 ATK_DEFINE_TYPE_WITH_CODE
560 ATK_DEFINE_ABSTRACT_TYPE
561 ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE
562 <SUBSECTION Standard>
563 ATK_UTIL
564 ATK_IS_UTIL
565 ATK_TYPE_UTIL
566 ATK_TYPE_KEY_EVENT_TYPE
567 ATK_TYPE_COORD_TYPE
568 atk_util_get_type
569 atk_key_event_type_get_type
570 atk_coord_type_get_type
571 ATK_UTIL_CLASS
572 ATK_IS_UTIL_CLASS
573 ATK_UTIL_GET_CLASS
574 AtkUtilClass
575 </SECTION>
577 <SECTION>
578 <FILE>atkmisc</FILE>
579 <TITLE>AtkMisc</TITLE>
580 AtkMisc
581 atk_misc_threads_enter
582 atk_misc_threads_leave
583 atk_misc_get_instance
584 <SUBSECTION Standard>
585 ATK_MISC
586 ATK_IS_MISC
587 ATK_TYPE_MISC
588 ATK_MISC_CLASS
589 ATK_IS_MISC_CLASS
590 ATK_MISC_GET_CLASS
591 AtkMiscClass
592 atk_misc_get_type
593 atk_misc_instance
594 </SECTION>
596 <SECTION>
597 <FILE>atkgobjectaccessible</FILE>
598 <TITLE>AtkGObjectAccessible</TITLE>
599 AtkGObjectAccessible
600 atk_gobject_accessible_for_object
601 atk_gobject_accessible_get_object
602 <SUBSECTION Standard>
603 ATK_GOBJECT_ACCESSIBLE
604 ATK_IS_GOBJECT_ACCESSIBLE
605 ATK_TYPE_GOBJECT_ACCESSIBLE
606 atk_gobject_accessible_get_type
607 ATK_GOBJECT_ACCESSIBLE_CLASS
608 ATK_IS_GOBJECT_ACCESSIBLE_CLASS
609 ATK_GOBJECT_ACCESSIBLE_GET_CLASS
610 AtkGObjectAccessibleClass
611 </SECTION>
613 <SECTION>
614 <FILE>atkplug</FILE>
615 <TITLE>AtkPlug</TITLE>
616 AtkPlug
617 atk_plug_new
618 atk_plug_get_id
619 <SUBSECTION Standard>
620 ATK_IS_PLUG
621 ATK_IS_PLUG_CLASS
622 ATK_PLUG
623 ATK_PLUG_CLASS
624 ATK_PLUG_GET_CLASS
625 ATK_TYPE_PLUG
626 AtkPlugClass
627 atk_plug_get_type
628 </SECTION>
630 <SECTION>
631 <FILE>atksocket</FILE>
632 <TITLE>AtkSocket</TITLE>
633 AtkSocket
634 atk_socket_new
635 atk_socket_embed
636 atk_socket_is_occupied
637 <SUBSECTION Standard>
638 ATK_IS_SOCKET
639 ATK_IS_SOCKET_CLASS
640 ATK_SOCKET
641 ATK_SOCKET_CLASS
642 ATK_SOCKET_GET_CLASS
643 ATK_TYPE_SOCKET
644 AtkSocketClass
645 atk_socket_get_type
646 </SECTION>
648 <SECTION>
649 <FILE>atkwindow</FILE>
650 <TITLE>AtkWindow</TITLE>
651 AtkWindow
652 <SUBSECTION Standard>
653 ATK_IS_WINDOW
654 ATK_IS_WINDOW_CLASS
655 ATK_WINDOW
656 ATK_WINDOW_CLASS
657 ATK_WINDOW_GET_CLASS
658 ATK_TYPE_WINDOW
659 AtkWindowClass
660 atk_window_get_type
661 </SECTION>
663 <SECTION>
664 <FILE>atkversion</FILE>
665 <TITLE>Versioning Utilities</TITLE>
666 atk_get_major_version
667 atk_get_minor_version
668 atk_get_micro_version
669 atk_get_binary_age
670 atk_get_interface_age
671 ATK_MAJOR_VERSION
672 ATK_MINOR_VERSION
673 ATK_MICRO_VERSION
674 ATK_CHECK_VERSION
675 </SECTION>