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 <!-- ##### SECTION Stability_Level ##### -->
37 <!-- ##### STRUCT AtkObject ##### -->
39 The AtkObject structure should not be accessed directly.
44 <!-- ##### SIGNAL AtkObject::active-descendant-changed ##### -->
46 The "active-descendant-changed" signal is emitted by an object which has
47 the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the
48 object changes. For instance, a table will emit the signal when the cell
49 in the table which has focus changes.
52 @atkobject: the object which received the signal.
53 @arg1: the newly focused object.
55 <!-- ##### SIGNAL AtkObject::children-changed ##### -->
57 The signal "children-changed" is emitted when a child is added or
58 removed form an object. It supports two details: "add" and "remove"
61 @atkobject: the object which received the signal.
62 @arg1: The index of the added or removed child
63 @arg2: A gpointer to the child AtkObject which was added or removed
65 <!-- ##### SIGNAL AtkObject::focus-event ##### -->
67 The signal "focus-event" is emitted when an object gains or loses focus.
70 @atkobject: the object which received the signal.
71 @arg1: A boolean value which indicates whether the object gained or lost focus.
73 <!-- ##### SIGNAL AtkObject::property-change ##### -->
75 The signal "property-change" is emitted when an object's property
76 value changes. The detail identifies the name of the property whose
80 @atkobject: the object which received the signal.
81 @arg1: The new value of the property which changed.
83 <!-- ##### SIGNAL AtkObject::state-change ##### -->
85 The "state-change" signal is emitted when an object's state changes.
86 The detail value identifies the state type which has changed.
89 @atkobject: the object which received the signal.
90 @arg1: The name of the state which has changed
91 @arg2: A boolean which indicates whether the state has been set or unset.
93 <!-- ##### SIGNAL AtkObject::visible-data-changed ##### -->
95 The "visible-data-changed" signal is emitted when the visual appearance of
99 @atkobject: the object which received the signal.
101 <!-- ##### ARG AtkObject:accessible-component-layer ##### -->
106 <!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### -->
111 <!-- ##### ARG AtkObject:accessible-description ##### -->
116 <!-- ##### ARG AtkObject:accessible-hypertext-nlinks ##### -->
121 <!-- ##### ARG AtkObject:accessible-name ##### -->
126 <!-- ##### ARG AtkObject:accessible-parent ##### -->
131 <!-- ##### ARG AtkObject:accessible-role ##### -->
136 <!-- ##### ARG AtkObject:accessible-table-caption ##### -->
141 <!-- ##### ARG AtkObject:accessible-table-caption-object ##### -->
146 <!-- ##### ARG AtkObject:accessible-table-column-description ##### -->
151 <!-- ##### ARG AtkObject:accessible-table-column-header ##### -->
156 <!-- ##### ARG AtkObject:accessible-table-row-description ##### -->
161 <!-- ##### ARG AtkObject:accessible-table-row-header ##### -->
166 <!-- ##### ARG AtkObject:accessible-table-summary ##### -->
171 <!-- ##### ARG AtkObject:accessible-value ##### -->
176 <!-- ##### ENUM AtkRole ##### -->
181 @ATK_ROLE_ACCEL_LABEL:
188 @ATK_ROLE_CHECK_MENU_ITEM:
189 @ATK_ROLE_COLOR_CHOOSER:
190 @ATK_ROLE_COLUMN_HEADER:
192 @ATK_ROLE_DATE_EDITOR:
193 @ATK_ROLE_DESKTOP_ICON:
194 @ATK_ROLE_DESKTOP_FRAME:
197 @ATK_ROLE_DIRECTORY_PANE:
198 @ATK_ROLE_DRAWING_AREA:
199 @ATK_ROLE_FILE_CHOOSER:
201 @ATK_ROLE_FONT_CHOOSER:
203 @ATK_ROLE_GLASS_PANE:
204 @ATK_ROLE_HTML_CONTAINER:
207 @ATK_ROLE_INTERNAL_FRAME:
209 @ATK_ROLE_LAYERED_PANE:
215 @ATK_ROLE_OPTION_PANE:
217 @ATK_ROLE_PAGE_TAB_LIST:
219 @ATK_ROLE_PASSWORD_TEXT:
220 @ATK_ROLE_POPUP_MENU:
221 @ATK_ROLE_PROGRESS_BAR:
222 @ATK_ROLE_PUSH_BUTTON:
223 @ATK_ROLE_RADIO_BUTTON:
224 @ATK_ROLE_RADIO_MENU_ITEM:
226 @ATK_ROLE_ROW_HEADER:
227 @ATK_ROLE_SCROLL_BAR:
228 @ATK_ROLE_SCROLL_PANE:
231 @ATK_ROLE_SPLIT_PANE:
232 @ATK_ROLE_SPIN_BUTTON:
235 @ATK_ROLE_TABLE_CELL:
236 @ATK_ROLE_TABLE_COLUMN_HEADER:
237 @ATK_ROLE_TABLE_ROW_HEADER:
238 @ATK_ROLE_TEAR_OFF_MENU_ITEM:
241 @ATK_ROLE_TOGGLE_BUTTON:
245 @ATK_ROLE_TREE_TABLE:
253 @ATK_ROLE_APPLICATION:
254 @ATK_ROLE_AUTOCOMPLETE:
260 @ATK_ROLE_DOCUMENT_FRAME:
264 @ATK_ROLE_REDUNDANT_OBJECT:
267 @ATK_ROLE_INPUT_METHOD_WINDOW:
268 @ATK_ROLE_LAST_DEFINED:
270 <!-- ##### FUNCTION atk_role_register ##### -->
279 <!-- ##### ENUM AtkLayer ##### -->
284 @ATK_LAYER_BACKGROUND:
292 <!-- ##### STRUCT AtkImplementor ##### -->
294 The AtkImplementor interface is implemented by objects for which AtkObject peers may be obtained via calls to iface->(ref_accessible)(implementor);
298 <!-- ##### STRUCT AtkPropertyValues ##### -->
300 The Atk PropertyValue structure is used when notifying a change in property.
301 Currently, the only property for which old_value is used is
302 accessible-state; for instance if there is a focus change the
303 property change handler will be called for the object which lost the focus
304 with the old_value containing the AtkState value corresponding to focused
305 and the property change handler will be called for the object which
306 received the focus with the new_value containing the AtkState value
307 corresponding to focused.
315 <!-- ##### USER_FUNCTION AtkFunction ##### -->
317 An AtkFunction is a function definition used for padding which has been added
318 to class and interface structures to allow for expansion in the future.
322 @data: a gpointer to parameter data.
323 @Returns: Nothing useful, this is only a dummy prototype.
326 <!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### -->
328 An AtkPropertyChangeHandler is a function which is executed when an AtkObject's property changes value. It is specified in a call to
329 atk_object_connect_property_change_handler().
332 @Param1: an #AtkObject
333 @Param2: an #AtkPropertyValues
336 <!-- ##### FUNCTION atk_implementor_ref_accessible ##### -->
345 <!-- ##### FUNCTION atk_object_get_name ##### -->
354 <!-- ##### FUNCTION atk_object_get_description ##### -->
363 <!-- ##### FUNCTION atk_object_get_parent ##### -->
372 <!-- ##### FUNCTION atk_object_get_n_accessible_children ##### -->
381 <!-- ##### FUNCTION atk_object_ref_accessible_child ##### -->
391 <!-- ##### FUNCTION atk_object_ref_relation_set ##### -->
400 <!-- ##### FUNCTION atk_object_get_layer ##### -->
407 @Deprecated: Use atk_component_get_layer instead.
410 <!-- ##### FUNCTION atk_object_get_mdi_zorder ##### -->
417 @Deprecated: Use atk_component_get_mdi_zorder instead.
420 <!-- ##### FUNCTION atk_object_get_role ##### -->
429 <!-- ##### FUNCTION atk_object_ref_state_set ##### -->
438 <!-- ##### FUNCTION atk_object_get_index_in_parent ##### -->
447 <!-- ##### FUNCTION atk_object_set_name ##### -->
456 <!-- ##### FUNCTION atk_object_set_description ##### -->
465 <!-- ##### FUNCTION atk_object_set_parent ##### -->
474 <!-- ##### FUNCTION atk_object_set_role ##### -->
483 <!-- ##### FUNCTION atk_object_connect_property_change_handler ##### -->
493 <!-- ##### FUNCTION atk_object_remove_property_change_handler ##### -->
502 <!-- ##### FUNCTION atk_object_notify_state_change ##### -->
512 <!-- ##### FUNCTION atk_object_initialize ##### -->
521 <!-- ##### FUNCTION atk_object_add_relationship ##### -->
532 <!-- ##### FUNCTION atk_object_remove_relationship ##### -->
543 <!-- ##### FUNCTION atk_object_get_attributes ##### -->
552 <!-- ##### FUNCTION atk_role_get_name ##### -->
561 <!-- ##### FUNCTION atk_role_get_localized_name ##### -->
570 <!-- ##### FUNCTION atk_role_for_name ##### -->