docs: Add AtkSocket and AtkPlug to the docs
[platform/upstream/atk.git] / docs / atk-sections.txt
1 <SECTION>
2 <FILE>atkaction</FILE>
3 <TITLE>AtkAction</TITLE>
4 AtkAction
5 atk_action_do_action
6 atk_action_get_n_actions
7 atk_action_get_description
8 atk_action_get_name
9 atk_action_get_localized_name
10 atk_action_get_keybinding
11 atk_action_set_description
12 <SUBSECTION Standard>
13 AtkActionIface
14 ATK_ACTION
15 ATK_IS_ACTION
16 ATK_TYPE_ACTION
17 ATK_ACTION_GET_IFACE
18 atk_action_get_type
19 </SECTION>
20
21 <SECTION>
22 <FILE>atkcomponent</FILE>
23 <TITLE>AtkComponent</TITLE>
24 AtkComponent
25 atk_component_add_focus_handler
26 atk_component_contains
27 atk_component_get_extents
28 atk_component_get_layer
29 atk_component_get_mdi_zorder
30 atk_component_get_position
31 atk_component_get_size
32 atk_component_grab_focus
33 atk_component_ref_accessible_at_point
34 atk_component_remove_focus_handler
35 atk_component_set_extents
36 atk_component_set_position
37 atk_component_set_size
38 atk_component_get_alpha
39 <SUBSECTION Standard>
40 AtkComponentIface
41 ATK_COMPONENT
42 ATK_IS_COMPONENT
43 ATK_TYPE_COMPONENT
44 ATK_TYPE_RECTANGLE
45 ATK_COMPONENT_GET_IFACE
46 AtkFocusHandler
47 AtkRectangle
48 atk_component_get_type
49 atk_rectangle_get_type
50 </SECTION>
51
52 <SECTION>
53 <FILE>atkdocument</FILE>
54 <TITLE>AtkDocument</TITLE>
55 AtkDocument
56 atk_document_get_document_type
57 atk_document_get_document
58 atk_document_get_attribute_value
59 atk_document_set_attribute_value
60 atk_document_get_attributes
61 atk_document_get_locale
62 <SUBSECTION Standard>
63 AtkDocumentIface
64 ATK_DOCUMENT
65 ATK_IS_DOCUMENT
66 ATK_TYPE_DOCUMENT
67 ATK_DOCUMENT_GET_IFACE
68 atk_document_get_type
69 </SECTION>
70
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>
90
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>
106
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>
124
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>
140
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>
156
157 <SECTION>
158 <FILE>atkobject</FILE>
159 <TITLE>AtkObject</TITLE>
160 AtkObject
161 AtkRole
162 atk_role_register
163 AtkLayer
164 AtkImplementor
165 AtkPropertyValues
166 AtkFunction
167 AtkPropertyChangeHandler
168 atk_implementor_ref_accessible
169 atk_object_get_name
170 atk_object_get_description
171 atk_object_get_parent
172 atk_object_get_n_accessible_children
173 atk_object_ref_accessible_child
174 atk_object_ref_relation_set
175 atk_object_get_layer
176 atk_object_get_mdi_zorder
177 atk_object_get_role
178 atk_object_ref_state_set
179 atk_object_get_index_in_parent
180 atk_object_set_name
181 atk_object_set_description
182 atk_object_set_parent
183 atk_object_set_role
184 atk_object_connect_property_change_handler
185 atk_object_remove_property_change_handler
186 atk_object_notify_state_change
187 atk_object_initialize
188 atk_object_add_relationship
189 atk_object_remove_relationship
190 atk_object_get_attributes
191 atk_role_get_name
192 atk_role_get_localized_name
193 atk_role_for_name
194 <SUBSECTION Standard>
195 AtkImplementorIface
196 ATK_OBJECT
197 ATK_IS_OBJECT
198 ATK_TYPE_OBJECT
199 ATK_IMPLEMENTOR_GET_IFACE
200 ATK_OBJECT_CLASS
201 ATK_IS_OBJECT_CLASS
202 ATK_OBJECT_GET_CLASS
203 ATK_TYPE_IMPLEMENTOR
204 ATK_IS_IMPLEMENTOR
205 ATK_IMPLEMENTOR
206 ATK_TYPE_ROLE
207 ATK_TYPE_LAYER
208 AtkStateSet
209 atk_implementor_get_type
210 atk_object_get_type
211 atk_role_get_type
212 atk_layer_get_type
213 AtkObjectClass
214 </SECTION>
215
216 <SECTION>
217 <FILE>atkobjectfactory</FILE>
218 <TITLE>AtkObjectFactory</TITLE>
219 AtkObjectFactory
220 atk_object_factory_create_accessible
221 atk_object_factory_get_accessible_type
222 atk_object_factory_invalidate
223 <SUBSECTION Standard>
224 ATK_OBJECT_FACTORY
225 ATK_IS_OBJECT_FACTORY
226 ATK_TYPE_OBJECT_FACTORY
227 atk_object_factory_get_type
228 ATK_OBJECT_FACTORY_CLASS
229 ATK_IS_OBJECT_FACTORY_CLASS
230 ATK_OBJECT_FACTORY_GET_CLASS
231 AtkObjectFactoryClass
232 </SECTION>
233
234 <SECTION>
235 <FILE>atkregistry</FILE>
236 <TITLE>AtkRegistry</TITLE>
237 AtkRegistry
238 atk_registry_set_factory_type
239 atk_registry_get_factory_type
240 atk_registry_get_factory
241 atk_get_default_registry
242 <SUBSECTION Standard>
243 ATK_REGISTRY
244 ATK_IS_REGISTRY
245 ATK_TYPE_REGISTRY
246 atk_registry_get_type
247 ATK_REGISTRY_CLASS
248 ATK_IS_REGISTRY_CLASS
249 ATK_REGISTRY_GET_CLASS
250 AtkRegistryClass
251 </SECTION>
252
253 <SECTION>
254 <FILE>atkrelation</FILE>
255 <TITLE>AtkRelation</TITLE>
256 AtkRelation
257 AtkRelationType
258 atk_relation_type_register
259 atk_relation_type_get_name
260 atk_relation_type_for_name
261 atk_relation_new
262 atk_relation_get_relation_type
263 atk_relation_get_target
264 atk_relation_add_target
265 <SUBSECTION Standard>
266 ATK_RELATION
267 ATK_IS_RELATION
268 ATK_TYPE_RELATION
269 ATK_TYPE_RELATION_TYPE
270 atk_relation_get_type
271 atk_relation_type_get_type
272 ATK_RELATION_CLASS
273 ATK_IS_RELATION_CLASS
274 ATK_RELATION_GET_CLASS
275 AtkRelationClass
276 </SECTION>
277
278 <SECTION>
279 <FILE>atkrelationset</FILE>
280 <TITLE>AtkRelationSet</TITLE>
281 AtkRelationSet
282 atk_relation_set_new
283 atk_relation_set_contains
284 atk_relation_set_remove
285 atk_relation_set_add
286 atk_relation_set_get_n_relations
287 atk_relation_set_get_relation
288 atk_relation_set_get_relation_by_type
289 atk_relation_set_add_relation_by_type
290 <SUBSECTION Standard>
291 ATK_RELATION_SET
292 ATK_IS_RELATION_SET
293 ATK_TYPE_RELATION_SET
294 atk_relation_set_get_type
295 ATK_RELATION_SET_CLASS
296 ATK_IS_RELATION_SET_CLASS
297 ATK_RELATION_SET_GET_CLASS
298 AtkRelationSetClass
299 </SECTION>
300
301 <SECTION>
302 <FILE>atkselection</FILE>
303 <TITLE>AtkSelection</TITLE>
304 AtkSelection
305 atk_selection_add_selection
306 atk_selection_clear_selection
307 atk_selection_ref_selection
308 atk_selection_get_selection_count
309 atk_selection_is_child_selected
310 atk_selection_remove_selection
311 atk_selection_select_all_selection
312 <SUBSECTION Standard>
313 AtkSelectionIface
314 ATK_SELECTION
315 ATK_IS_SELECTION
316 ATK_TYPE_SELECTION
317 ATK_SELECTION_GET_IFACE
318 atk_selection_get_type
319 </SECTION>
320
321 <SECTION>
322 <FILE>atkstateset</FILE>
323 <TITLE>AtkStateSet</TITLE>
324 AtkStateSet
325 atk_state_set_new
326 atk_state_set_is_empty
327 atk_state_set_add_state
328 atk_state_set_add_states
329 atk_state_set_clear_states
330 atk_state_set_contains_state
331 atk_state_set_contains_states
332 atk_state_set_remove_state
333 atk_state_set_and_sets
334 atk_state_set_or_sets
335 atk_state_set_xor_sets
336 <SUBSECTION Standard>
337 ATK_STATE_SET
338 ATK_IS_STATE_SET
339 ATK_TYPE_STATE_SET
340 atk_state_set_get_type
341 ATK_STATE_SET_CLASS
342 ATK_IS_STATE_SET_CLASS
343 ATK_STATE_SET_GET_CLASS
344 AtkStateSetClass
345 </SECTION>
346
347 <SECTION>
348 <FILE>atktable</FILE>
349 <TITLE>AtkTable</TITLE>
350 AtkTable
351 atk_table_ref_at
352 atk_table_get_index_at
353 atk_table_get_column_at_index
354 atk_table_get_row_at_index
355 atk_table_get_n_columns
356 atk_table_get_n_rows
357 atk_table_get_column_extent_at
358 atk_table_get_row_extent_at
359 atk_table_get_caption
360 atk_table_get_column_description
361 atk_table_get_row_description
362 atk_table_get_column_header
363 atk_table_get_row_header
364 atk_table_get_summary
365 atk_table_set_caption
366 atk_table_set_row_description
367 atk_table_set_column_description
368 atk_table_set_row_header
369 atk_table_set_column_header
370 atk_table_set_summary
371 atk_table_get_selected_columns
372 atk_table_get_selected_rows
373 atk_table_is_column_selected
374 atk_table_is_row_selected
375 atk_table_is_selected
376 atk_table_add_column_selection
377 atk_table_add_row_selection
378 atk_table_remove_column_selection
379 atk_table_remove_row_selection
380 <SUBSECTION Standard>
381 AtkTableIface
382 ATK_TABLE
383 ATK_IS_TABLE
384 ATK_TYPE_TABLE
385 ATK_TABLE_GET_IFACE
386 atk_table_get_type
387 </SECTION>
388
389 <SECTION>
390 <FILE>atktext</FILE>
391 <TITLE>AtkText</TITLE>
392 AtkText
393 AtkTextBoundary
394 AtkTextClipType
395 AtkTextRange
396 AtkTextRectangle
397 AtkAttribute
398 AtkAttributeSet
399 AtkTextAttribute
400 atk_text_get_text
401 atk_text_get_character_at_offset
402 atk_text_get_text_after_offset
403 atk_text_get_text_at_offset
404 atk_text_get_text_before_offset
405 atk_text_get_caret_offset
406 atk_text_get_character_extents
407 atk_text_get_run_attributes
408 atk_text_get_default_attributes
409 atk_text_get_character_count
410 atk_text_get_offset_at_point
411 atk_text_get_bounded_ranges
412 atk_text_get_range_extents
413 atk_text_free_ranges
414 atk_text_get_n_selections
415 atk_text_get_selection
416 atk_text_add_selection
417 atk_text_remove_selection
418 atk_text_set_selection
419 atk_text_set_caret_offset
420 atk_attribute_set_free
421 atk_text_attribute_register
422 atk_text_attribute_get_name
423 atk_text_attribute_for_name
424 atk_text_attribute_get_value
425 <SUBSECTION Standard>
426 AtkTextIface
427 ATK_TEXT
428 ATK_IS_TEXT
429 ATK_TYPE_TEXT
430 ATK_TEXT_GET_IFACE
431 ATK_TYPE_TEXT_ATTRIBUTE
432 ATK_TYPE_TEXT_BOUNDARY
433 ATK_TYPE_TEXT_CLIP_TYPE
434 atk_text_get_type
435 atk_text_attribute_get_type
436 atk_text_boundary_get_type
437 atk_text_clip_type_get_type
438 </SECTION>
439
440 <SECTION>
441 <FILE>atkvalue</FILE>
442 <TITLE>AtkValue</TITLE>
443 AtkValue
444 atk_value_get_current_value
445 atk_value_get_maximum_value
446 atk_value_get_minimum_value
447 atk_value_set_current_value
448 atk_value_get_minimum_increment
449 <SUBSECTION Standard>
450 AtkValueIface
451 ATK_VALUE
452 ATK_IS_VALUE
453 ATK_TYPE_VALUE
454 ATK_VALUE_GET_IFACE
455 atk_value_get_type
456 </SECTION>
457
458 <SECTION>
459 <FILE>atkhyperlink</FILE>
460 <TITLE>AtkHyperlink</TITLE>
461 AtkHyperlink
462 AtkHyperlinkStateFlags
463 atk_hyperlink_get_uri
464 atk_hyperlink_get_object
465 atk_hyperlink_get_end_index
466 atk_hyperlink_get_start_index
467 atk_hyperlink_is_valid
468 atk_hyperlink_is_inline
469 atk_hyperlink_get_n_anchors
470 atk_hyperlink_is_selected_link
471 <SUBSECTION Standard>
472 ATK_HYPERLINK
473 ATK_IS_HYPERLINK
474 ATK_TYPE_HYPERLINK
475 atk_hyperlink_get_type
476 ATK_HYPERLINK_CLASS
477 ATK_IS_HYPERLINK_CLASS
478 ATK_HYPERLINK_GET_CLASS
479 atk_hyperlink_state_flags_get_type
480 ATK_TYPE_HYPERLINK_STATE_FLAGS
481 AtkHyperlinkClass
482 </SECTION>
483
484 <SECTION>
485 <FILE>atkhyperlinkimpl</FILE>
486 <TITLE>AtkHyperlinkImpl</TITLE>
487 AtkHyperlinkImpl
488 atk_hyperlink_impl_get_hyperlink
489 <SUBSECTION Standard>
490 AtkHyperlinkImplIface
491 ATK_HYPERLINK_IMPL
492 ATK_IS_HYPERLINK_IMPL
493 ATK_TYPE_HYPERLINK_IMPL
494 atk_hyperlink_impl_get_type
495 ATK_HYPERLINK_IMPL_GET_IFACE
496 </SECTION>
497
498 <SECTION>
499 <FILE>atkstate</FILE>
500 <TITLE>AtkState</TITLE>
501 AtkStateType
502 AtkState
503 atk_state_type_register
504 atk_state_type_get_name
505 atk_state_type_for_name
506 <SUBSECTION Standard>
507 ATK_TYPE_STATE_TYPE
508 atk_state_type_get_type
509 </SECTION>
510
511 <SECTION>
512 <FILE>atkstreamablecontent</FILE>
513 <TITLE>AtkStreamableContent</TITLE>
514 AtkStreamableContent
515 atk_streamable_content_get_n_mime_types
516 atk_streamable_content_get_mime_type
517 atk_streamable_content_get_stream       
518 atk_streamable_content_get_uri
519 <SUBSECTION Standard>
520 AtkStreamableContentIface
521 ATK_STREAMABLE_CONTENT
522 ATK_IS_STREAMABLE_CONTENT
523 ATK_TYPE_STREAMABLE_CONTENT
524 atk_streamable_content_get_type
525 ATK_STREAMABLE_CONTENT_GET_IFACE
526 </SECTION>
527
528 <SECTION>
529 <FILE>atkutil</FILE>
530 <TITLE>AtkUtil</TITLE>
531 AtkUtil
532 AtkCoordType
533 atk_add_focus_tracker
534 atk_remove_focus_tracker
535 atk_focus_tracker_init
536 atk_focus_tracker_notify
537 AtkEventListener
538 AtkEventListenerInit
539 atk_add_global_event_listener
540 atk_remove_global_event_listener
541 AtkKeyEventStruct
542 AtkKeyEventType
543 AtkKeySnoopFunc
544 atk_add_key_event_listener
545 atk_remove_key_event_listener
546 atk_get_root
547 atk_get_focus_object
548 atk_get_toolkit_name
549 atk_get_toolkit_version
550 <SUBSECTION Standard>
551 ATK_UTIL
552 ATK_IS_UTIL
553 ATK_TYPE_UTIL
554 ATK_TYPE_KEY_EVENT_TYPE
555 ATK_TYPE_COORD_TYPE
556 atk_util_get_type
557 atk_key_event_type_get_type
558 atk_coord_type_get_type
559 ATK_UTIL_CLASS
560 ATK_IS_UTIL_CLASS
561 ATK_UTIL_GET_CLASS
562 AtkUtilClass
563 </SECTION>
564
565 <SECTION>
566 <FILE>atkmisc</FILE>
567 <TITLE>AtkMisc</TITLE>
568 AtkMisc
569 atk_misc_threads_enter
570 atk_misc_threads_leave
571 atk_misc_get_instance
572 <SUBSECTION Standard>
573 ATK_MISC
574 ATK_IS_MISC
575 ATK_TYPE_MISC
576 ATK_MISC_CLASS
577 ATK_IS_MISC_CLASS
578 ATK_MISC_GET_CLASS
579 AtkMiscClass
580 </SECTION>
581
582 <SECTION>
583 <FILE>atkgobjectaccessible</FILE>
584 <TITLE>AtkGObjectAccessible</TITLE>
585 AtkGObjectAccessible
586 atk_gobject_accessible_for_object
587 atk_gobject_accessible_get_object
588 <SUBSECTION Standard>
589 ATK_GOBJECT_ACCESSIBLE
590 ATK_IS_GOBJECT_ACCESSIBLE
591 ATK_TYPE_GOBJECT_ACCESSIBLE
592 atk_gobject_accessible_get_type
593 ATK_GOBJECT_ACCESSIBLE_CLASS
594 ATK_IS_GOBJECT_ACCESSIBLE_CLASS
595 ATK_GOBJECT_ACCESSIBLE_GET_CLASS
596 AtkGObjectAccessibleClass
597 </SECTION>
598
599 <SECTION>
600 <FILE>atkplug</FILE>
601 <TITLE>AtkPlug</TITLE>
602 AtkPlug
603 atk_plug_new
604 atk_plug_get_id
605 <SUBSECTION Standard>
606 ATK_IS_PLUG
607 ATK_IS_PLUG_CLASS
608 ATK_PLUG
609 ATK_PLUG_CLASS
610 ATK_PLUG_GET_CLASS
611 ATK_TYPE_PLUG
612 AtkPlugClass
613 atk_plug_get_type
614 </SECTION>
615
616 <SECTION>
617 <FILE>atksocket</FILE>
618 <TITLE>AtkSocket</TITLE>
619 AtkSocket
620 atk_socket_new
621 atk_socket_embed
622 atk_socket_is_occupied
623 <SUBSECTION Standard>
624 ATK_IS_SOCKET
625 ATK_IS_SOCKET_CLASS
626 ATK_SOCKET
627 ATK_SOCKET_CLASS
628 ATK_SOCKET_GET_CLASS
629 ATK_TYPE_SOCKET
630 AtkSocketClass
631 atk_socket_get_type
632 </SECTION>