1 /* ATK - Accessibility Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #ifndef __ATK_OBJECT_H__
21 #define __ATK_OBJECT_H__
25 #endif /* __cplusplus */
27 #include <glib-object.h>
28 #include <atk/atkstate.h>
29 #include <atk/atkrelationtype.h>
32 * AtkObject represents the minimum information all accessible objects
33 * return. This information includes accessible name, accessible
34 * description, role and state of the object, as well information about
35 * its parent and children. It is also possible to obtain more specific
36 * accessibility information about a component if it supports one or more
37 * of the following interfaces:
43 *@ATK_ROLE_INVALID: Invalid role
44 *@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
45 *@ATK_ROLE_ALERT: An object which is an alert to the user
46 *@ATK_ROLE_ANIMATION: An object which is an animated image
47 *@ATK_ROLE_ARROW: An arrow in one of the four cardinal directions
48 *@ATK_ROLE_CALENDAR: An object that displays a calendar and allows the user to select a date
49 *@ATK_ROLE_CANVAS: An object that can be drawn into and is used to trap events
50 *@ATK_ROLE_CHECK_BOX: A choice that can be checked or unchecked and provides a separate indicator for the current state
51 *@ATK_ROLE_CHECK_MENU_ITEM: A menu item with a check box
52 *@ATK_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color
53 *@ATK_ROLE_COLUMN_HEADER: The header for a column of data
54 *@ATK_ROLE_COMBO_BOX: A list of choices the user can select from
55 *@ATK_ROLE_DATE_EDITOR: An object whose purpose is to allow a user to edit a date
56 *@ATK_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
57 *@ATK_ROLE_DESKTOP_FRAME: A pane that supports internal frames and iconified versions of those internal frames
58 *@ATK_ROLE_DIAL: An object whose purpose is to allow a user to set a value
59 *@ATK_ROLE_DIALOG: A top level window with title bar and a border
60 *@ATK_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through and select the contents of a directory
61 *@ATK_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
62 *@ATK_ROLE_FILE_CHOOSER: A specialized dialog that lets the user choose a file
63 *@ATK_ROLE_FILLER: A object that fills up space in a user interface
64 *@ATK_ROLE_FONT_CHOOSER: A specialized dialog that lets the user choose a font
65 *@ATK_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
66 *@ATK_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all panes beneath it
67 *@ATK_ROLE_HTML_CONTAINER: A document container for HTML, whose children represent the document content
68 *@ATK_ROLE_ICON: A small fixed size picture, typically used to decorate components
69 *@ATK_ROLE_IMAGE: An object whose primary purpose is to display an image
70 *@ATK_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane
71 *@ATK_ROLE_LABEL: An object used to present an icon or short string in an interface
72 *@ATK_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
73 *@ATK_ROLE_LIST: An object that presents a list of objects to the user and allows the user to select one or more of them
74 *@ATK_ROLE_LIST_ITEM: An object that represents an element of a list
75 *@ATK_ROLE_MENU: An object usually found inside a menu bar that contains a list of actions the user can choose from
76 *@ATK_ROLE_MENU_BAR: An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from
77 *@ATK_ROLE_MENU_ITEM: An object usually contained in a menu that presents an action the user can choose
78 *@ATK_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
79 *@ATK_ROLE_PAGE_TAB: An object that is a child of a page tab list
80 *@ATK_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object
81 *@ATK_ROLE_PANEL: A generic container that is often used to group objects
82 *@ATK_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where the text content is not shown visibly to the user
83 *@ATK_ROLE_POPUP_MENU: A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices
84 *@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
85 *@ATK_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the application to do something
86 *@ATK_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked
87 *@ATK_ROLE_RADIO_MENU_ITEM: A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected
88 *@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
89 *@ATK_ROLE_ROW_HEADER: The header for a row of data
90 *@ATK_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally view a large amount of data.
91 *@ATK_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount of information
92 *@ATK_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
93 *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
94 *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
95 *@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
96 *@ATK_ROLE_STATUSBAR: An object which reports messages of minor importance to the user
97 *@ATK_ROLE_TABLE: An object used to represent information in terms of rows and columns
98 *@ATK_ROLE_TABLE_CELL: A cell in a table
99 *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
100 *@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
101 *@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu
102 *@ATK_ROLE_TERMINAL: An object that represents an accessible terminal
103 *@ATK_ROLE_TEXT: An object that presents text to the user
104 *@ATK_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state
105 *@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
106 *@ATK_ROLE_TOOL_TIP: An object that provides information about another object
107 *@ATK_ROLE_TREE: An object used to represent hierarchical information to the user
108 *@ATK_ROLE_TREE_TABLE: An object capable of expanding and collapsing rows as well as showing multiple columns of data
109 *@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
110 *@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane
111 *@ATK_ROLE_WINDOW: A top level window with no title or border.
112 *@ATK_ROLE_HEADER: An object that serves as a document header.
113 *@ATK_ROLE_FOOTER: An object that serves as a document footer.
114 *@ATK_ROLE_PARAGRAPH: An object which is contains a paragraph of text content.
115 *@ATK_ROLE_RULER: An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such).
116 *@ATK_ROLE_APPLICATION: The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles.
117 *@ATK_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry.
118 *@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar
119 *@ATK_ROLE_EMBEDDED: The object is an embedded container within a document or panel. This role is a grouping "hint" indicating that the contained objects share a context.
120 *@ATK_ROLE_ENTRY: The object is a component whose textual content may be entered or modified by the user, provided @ATK_STATE_EDITABLE is present.
121 *@ATK_ROLE_CHART: The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property.
122 *@ATK_ROLE_CAPTION: The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.
123 *@ATK_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface.
124 *@ATK_ROLE_HEADING: The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes.
125 *@ATK_ROLE_PAGE: The object is a containing instance which encapsulates a page of information. @ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model.
126 *@ATK_ROLE_SECTION: The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested.
127 *@ATK_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should normally be ignored by clients.
128 *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration
130 * Describes the role of an object
132 * These are the built-in enumerated roles that UI components can have in
133 * ATK. Other roles may be added at runtime, so an AtkRole >=
134 * ATK_ROLE_LAST_DEFINED is not necessarily an error.
138 ATK_ROLE_INVALID = 0,
139 ATK_ROLE_ACCEL_LABEL,
146 ATK_ROLE_CHECK_MENU_ITEM,
147 ATK_ROLE_COLOR_CHOOSER,
148 ATK_ROLE_COLUMN_HEADER,
150 ATK_ROLE_DATE_EDITOR,
151 ATK_ROLE_DESKTOP_ICON,
152 ATK_ROLE_DESKTOP_FRAME,
155 ATK_ROLE_DIRECTORY_PANE,
156 ATK_ROLE_DRAWING_AREA,
157 ATK_ROLE_FILE_CHOOSER,
159 ATK_ROLE_FONT_CHOOSER,
162 ATK_ROLE_HTML_CONTAINER,
165 ATK_ROLE_INTERNAL_FRAME,
167 ATK_ROLE_LAYERED_PANE,
173 ATK_ROLE_OPTION_PANE,
175 ATK_ROLE_PAGE_TAB_LIST,
177 ATK_ROLE_PASSWORD_TEXT,
179 ATK_ROLE_PROGRESS_BAR,
180 ATK_ROLE_PUSH_BUTTON,
181 ATK_ROLE_RADIO_BUTTON,
182 ATK_ROLE_RADIO_MENU_ITEM,
186 ATK_ROLE_SCROLL_PANE,
190 ATK_ROLE_SPIN_BUTTON,
194 ATK_ROLE_TABLE_COLUMN_HEADER,
195 ATK_ROLE_TABLE_ROW_HEADER,
196 ATK_ROLE_TEAR_OFF_MENU_ITEM,
199 ATK_ROLE_TOGGLE_BUTTON,
211 ATK_ROLE_APPLICATION,
212 ATK_ROLE_AUTOCOMPLETE,
218 ATK_ROLE_DOCUMENT_FRAME,
222 ATK_ROLE_REDUNDANT_OBJECT,
223 ATK_ROLE_LAST_DEFINED
226 AtkRole atk_role_register (const gchar *name);
230 *@ATK_LAYER_INVALID: The object does not have a layer
231 *@ATK_LAYER_BACKGROUND: This layer is reserved for the desktop background
232 *@ATK_LAYER_CANVAS: This layer is used for Canvas components
233 *@ATK_LAYER_WIDGET: This layer is normally used for components
234 *@ATK_LAYER_MDI: This layer is used for layered components
235 *@ATK_LAYER_POPUP: This layer is used for popup components, such as menus
236 *@ATK_LAYER_OVERLAY: This layer is reserved for future use.
237 *@ATK_LAYER_WINDOW: This layer is used for toplevel windows.
239 * Describes the layer of a component
241 * These enumerated "layer values" are used when determining which UI
242 * rendering layer a component is drawn into, which can help in making
243 * determinations of when components occlude one another.
248 ATK_LAYER_BACKGROUND,
260 * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
261 * used by atk_text_get_run_attributes(), atk_text_get_default_attributes()
262 * and atk_editable_text_set_run_attributes()
264 typedef GSList AtkAttributeSet;
268 * @name: The attribute name. Call atk_text_attr_get_name()
269 * @value: the value of the attribute, represented as a string.
270 * Call atk_text_attr_get_value() for those which are strings.
271 * For values which are numbers, the string representation of the number
274 * A string name/value pair representing a text attribute.
276 typedef struct _AtkAttribute AtkAttribute;
278 struct _AtkAttribute {
283 #define ATK_TYPE_OBJECT (atk_object_get_type ())
284 #define ATK_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
285 #define ATK_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
286 #define ATK_IS_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
287 #define ATK_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
288 #define ATK_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
290 #define ATK_TYPE_IMPLEMENTOR (atk_implementor_get_type ())
291 #define ATK_IS_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
292 #define ATK_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
293 #define ATK_IMPLEMENTOR_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
296 typedef struct _AtkImplementor AtkImplementor; /* dummy typedef */
297 typedef struct _AtkImplementorIface AtkImplementorIface;
300 typedef struct _AtkObject AtkObject;
301 typedef struct _AtkObjectClass AtkObjectClass;
302 typedef struct _AtkRelationSet AtkRelationSet;
303 typedef struct _AtkStateSet AtkStateSet;
305 struct _AtkPropertyValues
307 const gchar *property_name;
312 typedef struct _AtkPropertyValues AtkPropertyValues;
314 typedef gboolean (*AtkFunction) (gpointer data);
316 * For most properties the old_value field of AtkPropertyValues will
317 * not contain a valid value.
319 * Currently, the only property for which old_value is used is
320 * accessible-state; for instance if there is a focus state the
321 * property change handler will be called for the object which lost the focus
322 * with the old_value containing an AtkState value corresponding to focused
323 * and the property change handler will be called for the object which
324 * received the focus with the new_value containing an AtkState value
325 * corresponding to focused.
327 typedef void (*AtkPropertyChangeHandler) (AtkObject*, AtkPropertyValues*);
336 AtkObject *accessible_parent;
338 AtkRelationSet *relation_set;
342 struct _AtkObjectClass
347 * Gets the accessible name of the object
349 G_CONST_RETURN gchar* (* get_name) (AtkObject *accessible);
351 * Gets the accessible description of the object
353 G_CONST_RETURN gchar* (* get_description) (AtkObject *accessible);
355 * Gets the accessible parent of the object
357 AtkObject* (*get_parent) (AtkObject *accessible);
360 * Gets the number of accessible children of the object
362 gint (* get_n_children) (AtkObject *accessible);
364 * Returns a reference to the specified accessible child of the object.
365 * The accessible children are 0-based so the first accessible child is
366 * at index 0, the second at index 1 and so on.
368 AtkObject* (* ref_child) (AtkObject *accessible,
371 * Gets the 0-based index of this object in its parent; returns -1 if the
372 * object does not have an accessible parent.
374 gint (* get_index_in_parent) (AtkObject *accessible);
376 * Gets the RelationSet associated with the object
378 AtkRelationSet* (* ref_relation_set) (AtkObject *accessible);
380 * Gets the role of the object
382 AtkRole (* get_role) (AtkObject *accessible);
383 AtkLayer (* get_layer) (AtkObject *accessible);
384 gint (* get_mdi_zorder) (AtkObject *accessible);
386 * Gets the state set of the object
388 AtkStateSet* (* ref_state_set) (AtkObject *accessible);
390 * Sets the accessible name of the object
392 void (* set_name) (AtkObject *accessible,
395 * Sets the accessible description of the object
397 void (* set_description) (AtkObject *accessible,
398 const gchar *description);
400 * Sets the accessible parent of the object
402 void (* set_parent) (AtkObject *accessible,
405 * Sets the accessible role of the object
407 void (* set_role) (AtkObject *accessible,
410 * Specifies a function to be called when a property changes value
412 guint (* connect_property_change_handler) (AtkObject
414 AtkPropertyChangeHandler *handler);
416 * Removes a property change handler which was specified using
417 * connect_property_change_handler
419 void (* remove_property_change_handler) (AtkObject
423 void (* initialize) (AtkObject *accessible,
426 * The signal handler which is executed when there is a change in the
427 * children of the object
429 void (* children_changed) (AtkObject *accessible,
431 gpointer changed_child);
433 * The signal handler which is executed when there is a focus event
436 void (* focus_event) (AtkObject *accessible,
439 * The signal handler which is executed when there is a property_change
440 * signal for an object.
442 void (* property_change) (AtkObject *accessible,
443 AtkPropertyValues *values);
445 * The signal handler which is executed when there is a state_change
446 * signal for an object.
448 void (* state_change) (AtkObject *accessible,
452 * The signal handler which is executed when there is a change in the
453 * visible data for an object
455 void (*visible_data_changed) (AtkObject *accessible);
458 * The signal handler which is executed when there is a change in the
459 * 'active' child or children of the object, for instance when
460 * interior focus changes in a table or list. This signal should be emitted
461 * by objects whose state includes ATK_STATE_MANAGES_DESCENDANTS.
463 void (*active_descendant_changed) (AtkObject *accessible,
467 * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs.
470 AtkAttributeSet* (*get_attributes) (AtkObject *accessible);
475 GType atk_object_get_type (void);
477 struct _AtkImplementorIface
479 GTypeInterface parent;
481 AtkObject* (*ref_accessible) (AtkImplementor *implementor);
483 GType atk_implementor_get_type (void);
486 * This method uses the ref_accessible method in AtkImplementorIface,
487 * if the object's class implements AtkImplementorIface.
488 * Otherwise it returns %NULL.
491 * Note also that because this method may return flyweight objects,
492 * it increments the returned AtkObject's reference count.
493 * Therefore it is the responsibility of the calling
494 * program to unreference the object when no longer needed.
495 * (c.f. gtk_widget_get_accessible() where this is not the case).
497 AtkObject* atk_implementor_ref_accessible (AtkImplementor *implementor);
500 * Properties directly supported by AtkObject
503 G_CONST_RETURN gchar* atk_object_get_name (AtkObject *accessible);
504 G_CONST_RETURN gchar* atk_object_get_description (AtkObject *accessible);
505 AtkObject* atk_object_get_parent (AtkObject *accessible);
506 gint atk_object_get_n_accessible_children (AtkObject *accessible);
507 AtkObject* atk_object_ref_accessible_child (AtkObject *accessible,
509 AtkRelationSet* atk_object_ref_relation_set (AtkObject *accessible);
510 AtkRole atk_object_get_role (AtkObject *accessible);
511 AtkLayer atk_object_get_layer (AtkObject *accessible);
512 gint atk_object_get_mdi_zorder (AtkObject *accessible);
513 AtkAttributeSet* atk_object_get_attributes (AtkObject *accessible);
514 AtkStateSet* atk_object_ref_state_set (AtkObject *accessible);
515 gint atk_object_get_index_in_parent (AtkObject *accessible);
516 void atk_object_set_name (AtkObject *accessible,
518 void atk_object_set_description (AtkObject *accessible,
519 const gchar *description);
520 void atk_object_set_parent (AtkObject *accessible,
522 void atk_object_set_role (AtkObject *accessible,
526 guint atk_object_connect_property_change_handler (AtkObject *accessible,
527 AtkPropertyChangeHandler *handler);
528 void atk_object_remove_property_change_handler (AtkObject *accessible,
531 void atk_object_notify_state_change (AtkObject *accessible,
534 void atk_object_initialize (AtkObject *accessible,
537 G_CONST_RETURN gchar* atk_role_get_name (AtkRole role);
538 AtkRole atk_role_for_name (const gchar *name);
541 /* NEW in 1.1: convenience API */
542 gboolean atk_object_add_relationship (AtkObject *object,
543 AtkRelationType relationship,
545 gboolean atk_object_remove_relationship (AtkObject *object,
546 AtkRelationType relationship,
548 G_CONST_RETURN gchar* atk_role_get_localized_name (AtkRole role);
554 * Note: the properties which are registered with the GType
555 * property registry, for type ATK_TYPE_OBJECT, are as follows:
558 * "accessible-description"
559 * "accessible-parent"
562 * "accessible-component-layer"
563 * "accessible-component-zorder"
564 * "accessible-table-caption"
565 * "accessible-table-column-description"
566 * "accessible-table-column-header"
567 * "accessible-table-row-description"
568 * "accessible-table-row-header"
569 * "accessible-table-summary"
572 * accessibility property change listeners should use the
573 * normal GObject property interfaces and "property-change"
574 * signal handler semantics to interpret the property change
575 * information relayed from AtkObject.
576 * (AtkObject instances will connect to the "notify"
577 * signal in their host objects, and relay the signals when appropriate).
580 /* For other signals, see related interfaces
591 * The usage model for obtaining these interface instances is:
592 * ATK_<interfacename>_GET_IFACE(GObject *accessible),
593 * where accessible, though specified as a GObject, is
594 * the AtkObject instance being queried.
595 * More usually, the interface will be used via a cast to the
596 * interface's corresponding "type":
598 * AtkText textImpl = ATK_TEXT(accessible);
601 * cpos = atk_text_get_caret_position(textImpl);
604 * If it's known in advance that accessible implements AtkTextIface,
605 * this is shortened to:
607 * cpos = atk_text_get_caret_position (ATK_TEXT (accessible));
612 #endif /* __cplusplus */
615 #endif /* __ATK_OBJECT_H__ */