roles: add roles names on source file in order to be translated
[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_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>
20
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>
51
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>
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 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_peek_parent
175 atk_object_get_n_accessible_children
176 atk_object_ref_accessible_child
177 atk_object_ref_relation_set
178 atk_object_get_layer
179 atk_object_get_mdi_zorder
180 atk_object_get_role
181 atk_object_ref_state_set
182 atk_object_get_index_in_parent
183 atk_object_set_name
184 atk_object_set_description
185 atk_object_set_parent
186 atk_object_set_role
187 atk_object_connect_property_change_handler
188 atk_object_remove_property_change_handler
189 atk_object_notify_state_change
190 atk_object_initialize
191 atk_object_add_relationship
192 atk_object_remove_relationship
193 atk_object_get_attributes
194 atk_object_get_object_locale
195 atk_role_get_name
196 atk_role_get_localized_name
197 atk_role_for_name
198 <SUBSECTION Standard>
199 AtkImplementorIface
200 ATK_OBJECT
201 ATK_IS_OBJECT
202 ATK_TYPE_OBJECT
203 ATK_IMPLEMENTOR_GET_IFACE
204 ATK_OBJECT_CLASS
205 ATK_IS_OBJECT_CLASS
206 ATK_OBJECT_GET_CLASS
207 ATK_TYPE_IMPLEMENTOR
208 ATK_IS_IMPLEMENTOR
209 ATK_IMPLEMENTOR
210 ATK_TYPE_ROLE
211 ATK_TYPE_LAYER
212 AtkStateSet
213 atk_implementor_get_type
214 atk_object_get_type
215 atk_role_get_type
216 atk_layer_get_type
217 AtkObjectClass
218 </SECTION>
219
220 <SECTION>
221 <FILE>atkobjectfactory</FILE>
222 <TITLE>AtkObjectFactory</TITLE>
223 AtkObjectFactory
224 atk_object_factory_create_accessible
225 atk_object_factory_get_accessible_type
226 atk_object_factory_invalidate
227 <SUBSECTION Standard>
228 ATK_OBJECT_FACTORY
229 ATK_IS_OBJECT_FACTORY
230 ATK_TYPE_OBJECT_FACTORY
231 atk_object_factory_get_type
232 ATK_OBJECT_FACTORY_CLASS
233 ATK_IS_OBJECT_FACTORY_CLASS
234 ATK_OBJECT_FACTORY_GET_CLASS
235 AtkObjectFactoryClass
236 </SECTION>
237
238 <SECTION>
239 <FILE>atkregistry</FILE>
240 <TITLE>AtkRegistry</TITLE>
241 AtkRegistry
242 atk_registry_set_factory_type
243 atk_registry_get_factory_type
244 atk_registry_get_factory
245 atk_get_default_registry
246 <SUBSECTION Standard>
247 ATK_REGISTRY
248 ATK_IS_REGISTRY
249 ATK_TYPE_REGISTRY
250 atk_registry_get_type
251 ATK_REGISTRY_CLASS
252 ATK_IS_REGISTRY_CLASS
253 ATK_REGISTRY_GET_CLASS
254 AtkRegistryClass
255 </SECTION>
256
257 <SECTION>
258 <FILE>atkrelation</FILE>
259 <TITLE>AtkRelation</TITLE>
260 AtkRelation
261 AtkRelationType
262 atk_relation_type_register
263 atk_relation_type_get_name
264 atk_relation_type_for_name
265 atk_relation_new
266 atk_relation_get_relation_type
267 atk_relation_get_target
268 atk_relation_add_target
269 atk_relation_remove_target
270 <SUBSECTION Standard>
271 ATK_RELATION
272 ATK_IS_RELATION
273 ATK_TYPE_RELATION
274 ATK_TYPE_RELATION_TYPE
275 atk_relation_get_type
276 atk_relation_type_get_type
277 ATK_RELATION_CLASS
278 ATK_IS_RELATION_CLASS
279 ATK_RELATION_GET_CLASS
280 AtkRelationClass
281 </SECTION>
282
283 <SECTION>
284 <FILE>atkrelationset</FILE>
285 <TITLE>AtkRelationSet</TITLE>
286 AtkRelationSet
287 atk_relation_set_new
288 atk_relation_set_contains
289 atk_relation_set_remove
290 atk_relation_set_add
291 atk_relation_set_get_n_relations
292 atk_relation_set_get_relation
293 atk_relation_set_get_relation_by_type
294 atk_relation_set_add_relation_by_type
295 <SUBSECTION Standard>
296 ATK_RELATION_SET
297 ATK_IS_RELATION_SET
298 ATK_TYPE_RELATION_SET
299 atk_relation_set_get_type
300 ATK_RELATION_SET_CLASS
301 ATK_IS_RELATION_SET_CLASS
302 ATK_RELATION_SET_GET_CLASS
303 AtkRelationSetClass
304 </SECTION>
305
306 <SECTION>
307 <FILE>atkselection</FILE>
308 <TITLE>AtkSelection</TITLE>
309 AtkSelection
310 atk_selection_add_selection
311 atk_selection_clear_selection
312 atk_selection_ref_selection
313 atk_selection_get_selection_count
314 atk_selection_is_child_selected
315 atk_selection_remove_selection
316 atk_selection_select_all_selection
317 <SUBSECTION Standard>
318 AtkSelectionIface
319 ATK_SELECTION
320 ATK_IS_SELECTION
321 ATK_TYPE_SELECTION
322 ATK_SELECTION_GET_IFACE
323 atk_selection_get_type
324 </SECTION>
325
326 <SECTION>
327 <FILE>atkstateset</FILE>
328 <TITLE>AtkStateSet</TITLE>
329 AtkStateSet
330 atk_state_set_new
331 atk_state_set_is_empty
332 atk_state_set_add_state
333 atk_state_set_add_states
334 atk_state_set_clear_states
335 atk_state_set_contains_state
336 atk_state_set_contains_states
337 atk_state_set_remove_state
338 atk_state_set_and_sets
339 atk_state_set_or_sets
340 atk_state_set_xor_sets
341 <SUBSECTION Standard>
342 ATK_STATE_SET
343 ATK_IS_STATE_SET
344 ATK_TYPE_STATE_SET
345 atk_state_set_get_type
346 ATK_STATE_SET_CLASS
347 ATK_IS_STATE_SET_CLASS
348 ATK_STATE_SET_GET_CLASS
349 AtkStateSetClass
350 </SECTION>
351
352 <SECTION>
353 <FILE>atktable</FILE>
354 <TITLE>AtkTable</TITLE>
355 AtkTable
356 atk_table_ref_at
357 atk_table_get_index_at
358 atk_table_get_column_at_index
359 atk_table_get_row_at_index
360 atk_table_get_n_columns
361 atk_table_get_n_rows
362 atk_table_get_column_extent_at
363 atk_table_get_row_extent_at
364 atk_table_get_caption
365 atk_table_get_column_description
366 atk_table_get_row_description
367 atk_table_get_column_header
368 atk_table_get_row_header
369 atk_table_get_summary
370 atk_table_set_caption
371 atk_table_set_row_description
372 atk_table_set_column_description
373 atk_table_set_row_header
374 atk_table_set_column_header
375 atk_table_set_summary
376 atk_table_get_selected_columns
377 atk_table_get_selected_rows
378 atk_table_is_column_selected
379 atk_table_is_row_selected
380 atk_table_is_selected
381 atk_table_add_column_selection
382 atk_table_add_row_selection
383 atk_table_remove_column_selection
384 atk_table_remove_row_selection
385 <SUBSECTION Standard>
386 AtkTableIface
387 ATK_TABLE
388 ATK_IS_TABLE
389 ATK_TYPE_TABLE
390 ATK_TABLE_GET_IFACE
391 atk_table_get_type
392 </SECTION>
393
394 <SECTION>
395 <FILE>atktext</FILE>
396 <TITLE>AtkText</TITLE>
397 AtkText
398 AtkTextIface
399 AtkTextBoundary
400 AtkTextGranularity
401 AtkTextClipType
402 AtkTextRange
403 AtkTextRectangle
404 AtkTextAttribute
405 atk_text_get_text
406 atk_text_get_character_at_offset
407 atk_text_get_text_after_offset
408 atk_text_get_text_at_offset
409 atk_text_get_text_before_offset
410 atk_text_get_string_at_offset
411 atk_text_get_caret_offset
412 atk_text_get_character_extents
413 atk_text_get_run_attributes
414 atk_text_get_default_attributes
415 atk_text_get_character_count
416 atk_text_get_offset_at_point
417 atk_text_get_bounded_ranges
418 atk_text_get_range_extents
419 atk_text_free_ranges
420 atk_text_get_n_selections
421 atk_text_get_selection
422 atk_text_add_selection
423 atk_text_remove_selection
424 atk_text_set_selection
425 atk_text_set_caret_offset
426 atk_attribute_set_free
427 atk_text_attribute_register
428 atk_text_attribute_get_name
429 atk_text_attribute_for_name
430 atk_text_attribute_get_value
431 <SUBSECTION Standard>
432 ATK_TEXT
433 ATK_IS_TEXT
434 ATK_TYPE_TEXT
435 ATK_TEXT_GET_IFACE
436 ATK_TYPE_TEXT_ATTRIBUTE
437 ATK_TYPE_TEXT_BOUNDARY
438 ATK_TYPE_TEXT_GRANULARITY
439 ATK_TYPE_TEXT_CLIP_TYPE
440 atk_text_get_type
441 atk_text_attribute_get_type
442 atk_text_boundary_get_type
443 atk_text_granularity_get_type
444 atk_text_clip_type_get_type
445 </SECTION>
446
447 <SECTION>
448 <FILE>atkvalue</FILE>
449 <TITLE>AtkValue</TITLE>
450 AtkValue
451 atk_value_get_current_value
452 atk_value_get_maximum_value
453 atk_value_get_minimum_value
454 atk_value_set_current_value
455 atk_value_get_minimum_increment
456 <SUBSECTION Standard>
457 AtkValueIface
458 ATK_VALUE
459 ATK_IS_VALUE
460 ATK_TYPE_VALUE
461 ATK_VALUE_GET_IFACE
462 atk_value_get_type
463 </SECTION>
464
465 <SECTION>
466 <FILE>atkhyperlink</FILE>
467 <TITLE>AtkHyperlink</TITLE>
468 AtkHyperlink
469 AtkHyperlinkStateFlags
470 atk_hyperlink_get_uri
471 atk_hyperlink_get_object
472 atk_hyperlink_get_end_index
473 atk_hyperlink_get_start_index
474 atk_hyperlink_is_valid
475 atk_hyperlink_is_inline
476 atk_hyperlink_get_n_anchors
477 atk_hyperlink_is_selected_link
478 <SUBSECTION Standard>
479 ATK_HYPERLINK
480 ATK_IS_HYPERLINK
481 ATK_TYPE_HYPERLINK
482 atk_hyperlink_get_type
483 ATK_HYPERLINK_CLASS
484 ATK_IS_HYPERLINK_CLASS
485 ATK_HYPERLINK_GET_CLASS
486 atk_hyperlink_state_flags_get_type
487 ATK_TYPE_HYPERLINK_STATE_FLAGS
488 AtkHyperlinkClass
489 </SECTION>
490
491 <SECTION>
492 <FILE>atkhyperlinkimpl</FILE>
493 <TITLE>AtkHyperlinkImpl</TITLE>
494 AtkHyperlinkImpl
495 atk_hyperlink_impl_get_hyperlink
496 <SUBSECTION Standard>
497 AtkHyperlinkImplIface
498 ATK_HYPERLINK_IMPL
499 ATK_IS_HYPERLINK_IMPL
500 ATK_TYPE_HYPERLINK_IMPL
501 atk_hyperlink_impl_get_type
502 ATK_HYPERLINK_IMPL_GET_IFACE
503 </SECTION>
504
505 <SECTION>
506 <FILE>atkstate</FILE>
507 <TITLE>AtkState</TITLE>
508 AtkStateType
509 AtkState
510 atk_state_type_register
511 atk_state_type_get_name
512 atk_state_type_for_name
513 <SUBSECTION Standard>
514 ATK_TYPE_STATE_TYPE
515 atk_state_type_get_type
516 </SECTION>
517
518 <SECTION>
519 <FILE>atkstreamablecontent</FILE>
520 <TITLE>AtkStreamableContent</TITLE>
521 AtkStreamableContent
522 atk_streamable_content_get_n_mime_types
523 atk_streamable_content_get_mime_type
524 atk_streamable_content_get_stream       
525 atk_streamable_content_get_uri
526 <SUBSECTION Standard>
527 AtkStreamableContentIface
528 ATK_STREAMABLE_CONTENT
529 ATK_IS_STREAMABLE_CONTENT
530 ATK_TYPE_STREAMABLE_CONTENT
531 atk_streamable_content_get_type
532 ATK_STREAMABLE_CONTENT_GET_IFACE
533 </SECTION>
534
535 <SECTION>
536 <FILE>atkutil</FILE>
537 <TITLE>AtkUtil</TITLE>
538 AtkUtil
539 AtkCoordType
540 atk_add_focus_tracker
541 atk_remove_focus_tracker
542 atk_focus_tracker_init
543 atk_focus_tracker_notify
544 AtkEventListener
545 AtkEventListenerInit
546 atk_add_global_event_listener
547 atk_remove_global_event_listener
548 AtkKeyEventStruct
549 AtkKeyEventType
550 AtkKeySnoopFunc
551 atk_add_key_event_listener
552 atk_remove_key_event_listener
553 atk_get_root
554 atk_get_focus_object
555 atk_get_toolkit_name
556 atk_get_toolkit_version
557 atk_get_version
558 ATK_DEFINE_TYPE
559 ATK_DEFINE_TYPE_EXTENDED
560 ATK_DEFINE_TYPE_WITH_CODE
561 ATK_DEFINE_ABSTRACT_TYPE
562 ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE
563 <SUBSECTION Standard>
564 ATK_UTIL
565 ATK_IS_UTIL
566 ATK_TYPE_UTIL
567 ATK_TYPE_KEY_EVENT_TYPE
568 ATK_TYPE_COORD_TYPE
569 atk_util_get_type
570 atk_key_event_type_get_type
571 atk_coord_type_get_type
572 ATK_UTIL_CLASS
573 ATK_IS_UTIL_CLASS
574 ATK_UTIL_GET_CLASS
575 AtkUtilClass
576 </SECTION>
577
578 <SECTION>
579 <FILE>atkmisc</FILE>
580 <TITLE>AtkMisc</TITLE>
581 AtkMisc
582 atk_misc_threads_enter
583 atk_misc_threads_leave
584 atk_misc_get_instance
585 <SUBSECTION Standard>
586 ATK_MISC
587 ATK_IS_MISC
588 ATK_TYPE_MISC
589 ATK_MISC_CLASS
590 ATK_IS_MISC_CLASS
591 ATK_MISC_GET_CLASS
592 AtkMiscClass
593 atk_misc_get_type
594 atk_misc_instance
595 </SECTION>
596
597 <SECTION>
598 <FILE>atkgobjectaccessible</FILE>
599 <TITLE>AtkGObjectAccessible</TITLE>
600 AtkGObjectAccessible
601 atk_gobject_accessible_for_object
602 atk_gobject_accessible_get_object
603 <SUBSECTION Standard>
604 ATK_GOBJECT_ACCESSIBLE
605 ATK_IS_GOBJECT_ACCESSIBLE
606 ATK_TYPE_GOBJECT_ACCESSIBLE
607 atk_gobject_accessible_get_type
608 ATK_GOBJECT_ACCESSIBLE_CLASS
609 ATK_IS_GOBJECT_ACCESSIBLE_CLASS
610 ATK_GOBJECT_ACCESSIBLE_GET_CLASS
611 AtkGObjectAccessibleClass
612 </SECTION>
613
614 <SECTION>
615 <FILE>atkplug</FILE>
616 <TITLE>AtkPlug</TITLE>
617 AtkPlug
618 atk_plug_new
619 atk_plug_get_id
620 <SUBSECTION Standard>
621 ATK_IS_PLUG
622 ATK_IS_PLUG_CLASS
623 ATK_PLUG
624 ATK_PLUG_CLASS
625 ATK_PLUG_GET_CLASS
626 ATK_TYPE_PLUG
627 AtkPlugClass
628 atk_plug_get_type
629 </SECTION>
630
631 <SECTION>
632 <FILE>atksocket</FILE>
633 <TITLE>AtkSocket</TITLE>
634 AtkSocket
635 atk_socket_new
636 atk_socket_embed
637 atk_socket_is_occupied
638 <SUBSECTION Standard>
639 ATK_IS_SOCKET
640 ATK_IS_SOCKET_CLASS
641 ATK_SOCKET
642 ATK_SOCKET_CLASS
643 ATK_SOCKET_GET_CLASS
644 ATK_TYPE_SOCKET
645 AtkSocketClass
646 atk_socket_get_type
647 </SECTION>
648
649 <SECTION>
650 <FILE>atkwindow</FILE>
651 <TITLE>AtkWindow</TITLE>
652 AtkWindow
653 <SUBSECTION Standard>
654 ATK_IS_WINDOW
655 ATK_IS_WINDOW_CLASS
656 ATK_WINDOW
657 ATK_WINDOW_CLASS
658 ATK_WINDOW_GET_CLASS
659 ATK_TYPE_WINDOW
660 AtkWindowClass
661 atk_window_get_type
662 </SECTION>
663
664 <SECTION>
665 <FILE>atkversion</FILE>
666 <TITLE>Versioning Utilities</TITLE>
667 atk_get_major_version
668 atk_get_minor_version
669 atk_get_micro_version
670 atk_get_binary_age
671 atk_get_interface_age
672 ATK_MAJOR_VERSION
673 ATK_MINOR_VERSION
674 ATK_MICRO_VERSION
675 ATK_CHECK_VERSION
676 </SECTION>