1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
6 The base object class for the Accessibility Toolkit API.
8 <!-- ##### SECTION Long_Description ##### -->
10 This class is the primary class for accessibility support via
11 the Accessibility ToolKit (ATK). Objects which are instances
12 of #AtkObject (or instances of AtkObject-derived types) are
13 queried for properties which relate basic (and generic) properties of a
14 UI component such as name and description. Instances of #AtkObject
15 may also be queried as to whether they implement other ATK interfaces
16 (e.g. #AtkAction, #AtkComponent, etc.), as appropriate to the role
17 which a given UI component plays in a user interface.
19 <para>All UI components in an application which provide useful
20 information or services to the user must provide corresponding
21 #AtkObject instances on request (in GTK+, for instance, usually
22 on a call to #gtk_widget_get_accessible ()), either via ATK support
23 built into the toolkit for the widget class or ancestor class, or in
24 the case of custom widgets, if the inherited #AtkObject implementation
25 is insufficient, via instances of a new #AtkObject subclass.
28 <!-- ##### SECTION See_Also ##### -->
30 See also: #AtkObjectFactory, #AtkRegistry.
31 ( GTK+ users see also #GtkAccessible).
34 <!-- ##### STRUCT AtkObject ##### -->
36 The AtkObject structure should not be accessed directly.
41 <!-- ##### ENUM AtkRole ##### -->
46 @ATK_ROLE_ACCEL_LABEL:
53 @ATK_ROLE_CHECK_MENU_ITEM:
54 @ATK_ROLE_COLOR_CHOOSER:
55 @ATK_ROLE_COLUMN_HEADER:
57 @ATK_ROLE_DATE_EDITOR:
58 @ATK_ROLE_DESKTOP_ICON:
59 @ATK_ROLE_DESKTOP_FRAME:
62 @ATK_ROLE_DIRECTORY_PANE:
63 @ATK_ROLE_DRAWING_AREA:
64 @ATK_ROLE_FILE_CHOOSER:
66 @ATK_ROLE_FONT_CHOOSER:
69 @ATK_ROLE_HTML_CONTAINER:
72 @ATK_ROLE_INTERNAL_FRAME:
74 @ATK_ROLE_LAYERED_PANE:
80 @ATK_ROLE_OPTION_PANE:
82 @ATK_ROLE_PAGE_TAB_LIST:
84 @ATK_ROLE_PASSWORD_TEXT:
86 @ATK_ROLE_PROGRESS_BAR:
87 @ATK_ROLE_PUSH_BUTTON:
88 @ATK_ROLE_RADIO_BUTTON:
89 @ATK_ROLE_RADIO_MENU_ITEM:
93 @ATK_ROLE_SCROLL_PANE:
97 @ATK_ROLE_SPIN_BUTTON:
100 @ATK_ROLE_TABLE_CELL:
101 @ATK_ROLE_TABLE_COLUMN_HEADER:
102 @ATK_ROLE_TABLE_ROW_HEADER:
103 @ATK_ROLE_TEAR_OFF_MENU_ITEM:
106 @ATK_ROLE_TOGGLE_BUTTON:
110 @ATK_ROLE_TREE_TABLE:
118 @ATK_ROLE_APPLICATION:
119 @ATK_ROLE_AUTOCOMPLETE:
122 @ATK_ROLE_LAST_DEFINED:
124 <!-- ##### FUNCTION atk_role_register ##### -->
133 <!-- ##### ENUM AtkLayer ##### -->
138 @ATK_LAYER_BACKGROUND:
146 <!-- ##### STRUCT AtkImplementor ##### -->
148 The AtkImplementor structure does not contain any fields.
153 <!-- ##### STRUCT AtkPropertyValues ##### -->
155 The Atk PropertyValue structure is used when notifying a change in property.
156 Currently, the only property for which old_value is used is
157 accessible-state; for instance if there is a focus change the
158 property change handler will be called for the object which lost the focus
159 with the old_value containing the AtkState value corresponding to focused
160 and the property change handler will be called for the object which
161 received the focus with the new_value containing the AtkState value
162 corresponding to focused.
170 <!-- ##### USER_FUNCTION AtkFunction ##### -->
172 An AtkFunction is a function definition used for padding which has been added
173 to class and interface structures to allow for expansion in the future.
181 <!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### -->
183 An AtkPropertyChangeHandler is a function which is executed when an AtkObject's property changes value. It is specified in a call to
184 atk_object_connect_property_change_handler().
191 <!-- ##### FUNCTION atk_implementor_ref_accessible ##### -->
200 <!-- ##### FUNCTION atk_object_get_name ##### -->
209 <!-- ##### FUNCTION atk_object_get_description ##### -->
218 <!-- ##### FUNCTION atk_object_get_parent ##### -->
227 <!-- ##### FUNCTION atk_object_get_n_accessible_children ##### -->
236 <!-- ##### FUNCTION atk_object_ref_accessible_child ##### -->
246 <!-- ##### FUNCTION atk_object_ref_relation_set ##### -->
255 <!-- ##### FUNCTION atk_object_get_layer ##### -->
264 <!-- ##### FUNCTION atk_object_get_mdi_zorder ##### -->
273 <!-- ##### FUNCTION atk_object_get_role ##### -->
282 <!-- ##### FUNCTION atk_object_ref_state_set ##### -->
291 <!-- ##### FUNCTION atk_object_get_index_in_parent ##### -->
300 <!-- ##### FUNCTION atk_object_set_name ##### -->
309 <!-- ##### FUNCTION atk_object_set_description ##### -->
318 <!-- ##### FUNCTION atk_object_set_parent ##### -->
327 <!-- ##### FUNCTION atk_object_set_role ##### -->
336 <!-- ##### FUNCTION atk_object_connect_property_change_handler ##### -->
346 <!-- ##### FUNCTION atk_object_remove_property_change_handler ##### -->
355 <!-- ##### FUNCTION atk_object_notify_state_change ##### -->
365 <!-- ##### FUNCTION atk_object_initialize ##### -->
374 <!-- ##### FUNCTION atk_object_add_relationship ##### -->
385 <!-- ##### FUNCTION atk_object_remove_relationship ##### -->
396 <!-- ##### FUNCTION atk_role_get_name ##### -->
405 <!-- ##### FUNCTION atk_role_get_localized_name ##### -->
414 <!-- ##### FUNCTION atk_role_for_name ##### -->
423 <!-- ##### SIGNAL AtkObject::active-descendant-changed ##### -->
425 The "active-descendant-changed" signal is emitted by an object which has
426 the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the
427 object changes. For instance, a table will emit the signal when the cell
428 in the table which has focus changes.
431 @atkobject: the object which received the signal.
432 @arg1: the newly focused object.
434 <!-- ##### SIGNAL AtkObject::children-changed ##### -->
436 The signal "children-changed" is emitted when a child is added or
437 removed form an object. It supports two details: "add" and "remove"
440 @atkobject: the object which received the signal.
441 @arg1: The index of the added or removed child
442 @arg2: The child which was added or removed
444 <!-- ##### SIGNAL AtkObject::focus-event ##### -->
446 The signal "focus-event" is emitted when an object gains or loses focus.
449 @atkobject: the object which received the signal.
450 @arg1: A boolean value which indicates whether the object gained or lost focus.
452 <!-- ##### SIGNAL AtkObject::property-change ##### -->
454 The signal "property-change" is emitted when an object's property
455 value changes. The detail identifies the name of the property whose
459 @atkobject: the object which received the signal.
460 @arg1: The new value of the property which changed.
462 <!-- ##### SIGNAL AtkObject::state-change ##### -->
464 The "state-change" signal is emitted when an object's state changes.
465 The detail value identifies the state type which has changed.
468 @atkobject: the object which received the signal.
469 @arg1: The name of the state which has changed
470 @arg2: A boolean which indicates whether the state has been set or unset.
472 <!-- ##### SIGNAL AtkObject::visible-data-changed ##### -->
474 The "visible-data-changed" signal is emitted when the visual appearance of
478 @atkobject: the object which received the signal.
480 <!-- ##### ARG AtkObject:accessible-component-layer ##### -->
485 <!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### -->
490 <!-- ##### ARG AtkObject:accessible-description ##### -->
495 <!-- ##### ARG AtkObject:accessible-hypertext-nlinks ##### -->
500 <!-- ##### ARG AtkObject:accessible-name ##### -->
505 <!-- ##### ARG AtkObject:accessible-parent ##### -->
510 <!-- ##### ARG AtkObject:accessible-role ##### -->
515 <!-- ##### ARG AtkObject:accessible-table-caption ##### -->
520 <!-- ##### ARG AtkObject:accessible-table-caption-object ##### -->
525 <!-- ##### ARG AtkObject:accessible-table-column-description ##### -->
530 <!-- ##### ARG AtkObject:accessible-table-column-header ##### -->
535 <!-- ##### ARG AtkObject:accessible-table-row-description ##### -->
540 <!-- ##### ARG AtkObject:accessible-table-row-header ##### -->
545 <!-- ##### ARG AtkObject:accessible-table-summary ##### -->
550 <!-- ##### ARG AtkObject:accessible-value ##### -->