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>
31 * AtkObject represents the minimum information all accessible objects
32 * return. This information includes accessible name, accessible
33 * description, role and state of the object, as well information about
34 * its parent and children. It is also possible to obtain more specific
35 * accessibility information about a component if it supports one or more
36 * of the following interfaces:
42 *@ATK_ROLE_INVALID: Invalid role
43 *@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
44 *@ATK_ROLE_ALERT: An object which is an alert to the user
45 *@ATK_ROLE_ANIMATION: An object which is an animated image
46 *@ATK_ROLE_ARROW: An arrow in one of the four cardinal directions
47 *@ATK_ROLE_CALENDAR: An object that displays a calendar and allows the user to select a date
48 *@ATK_ROLE_CANVAS: An object that can be drawn into and is used to trap events
49 *@ATK_ROLE_CHECK_BOX: A choice that can be checked or unchecked and provides a separate indicator for the current state
50 *@ATK_ROLE_CHECK_MENU_ITEM: A menu item with a check box
51 *@ATK_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color
52 *@ATK_ROLE_COLUMN_HEADER: The header for a column of data
53 *@ATK_ROLE_COMBO_BOX: A list of choices the user can select from
54 *@ATK_ROLE_DATE_EDITOR: An object whose purpose is to allow a user to edit a date
55 *@ATK_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
56 *@ATK_ROLE_DESKTOP_FRAME: A pane that supports internal frames and iconified versions of those internal frames
57 *@ATK_ROLE_DIAL: An object whose purpose is to allow a user to set a value
58 *@ATK_ROLE_DIALOG: A top level window with title bar and a border
59 *@ATK_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through and select the contents of a directory
60 *@ATK_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
61 *@ATK_ROLE_FILE_CHOOSER: A specialized dialog that lets the user choose a file
62 *@ATK_ROLE_FILLER: A object that fills up space in a user interface
63 *@ATK_ROLE_FONT_CHOOSER: A specialized dialog that lets the user choose a font
64 *@ATK_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
65 *@ATK_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all panes beneath it
66 *@ATK_ROLE_HTML_CONTAINER: A document container for HTML, whose children represent the document content
67 *@ATK_ROLE_ICON: A small fixed size picture, typically used to decorate components
68 *@ATK_ROLE_IMAGE: An object whose primary purpose is to display an image
69 *@ATK_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane
70 *@ATK_ROLE_LABEL: An object used to present an icon or short string in an interface
71 *@ATK_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
72 *@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
73 *@ATK_ROLE_LIST_ITEM: An object that represents an element of a list
74 *@ATK_ROLE_MENU: An object usually found inside a menu bar that contains a list of actions the user can choose from
75 *@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
76 *@ATK_ROLE_MENU_ITEM: An object usually contained in a menu that presents an action the user can choose
77 *@ATK_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
78 *@ATK_ROLE_PAGE_TAB: An object that is a child of a page tab list
79 *@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
80 *@ATK_ROLE_PANEL: A generic container that is often used to group objects
81 *@ATK_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where the text content is not shown visibly to the user
82 *@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
83 *@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
84 *@ATK_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the application to do something
85 *@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
86 *@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
87 *@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
88 *@ATK_ROLE_ROW_HEADER: The header for a row of data
89 *@ATK_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally view a large amount of data.
90 *@ATK_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount of information
91 *@ATK_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
92 *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
93 *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
94 *@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
95 *@ATK_ROLE_STATUSBAR: An object which reports messages of minor importance to the user
96 *@ATK_ROLE_TABLE: An object used to represent information in terms of rows and columns
97 *@ATK_ROLE_TABLE_CELL: A cell in a table
98 *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
99 *@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
100 *@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu
101 *@ATK_ROLE_TERMINAL: An object that represents an accessible terminal
102 *@ATK_ROLE_TEXT: An object that presents text to the user
103 *@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
104 *@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
105 *@ATK_ROLE_TOOL_TIP: An object that provides information about another object
106 *@ATK_ROLE_TREE: An object used to represent hierarchical information to the user
107 *@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
108 *@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane
109 *@ATK_ROLE_WINDOW: A top level window with no title or border
110 *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of enumeration
112 *Describes the role of an object
117 ATK_ROLE_ACCEL_LABEL,
124 ATK_ROLE_CHECK_MENU_ITEM,
125 ATK_ROLE_COLOR_CHOOSER,
126 ATK_ROLE_COLUMN_HEADER,
128 ATK_ROLE_DATE_EDITOR,
129 ATK_ROLE_DESKTOP_ICON,
130 ATK_ROLE_DESKTOP_FRAME,
133 ATK_ROLE_DIRECTORY_PANE,
134 ATK_ROLE_DRAWING_AREA,
135 ATK_ROLE_FILE_CHOOSER,
137 ATK_ROLE_FONT_CHOOSER,
140 ATK_ROLE_HTML_CONTAINER,
143 ATK_ROLE_INTERNAL_FRAME,
145 ATK_ROLE_LAYERED_PANE,
151 ATK_ROLE_OPTION_PANE,
153 ATK_ROLE_PAGE_TAB_LIST,
155 ATK_ROLE_PASSWORD_TEXT,
157 ATK_ROLE_PROGRESS_BAR,
158 ATK_ROLE_PUSH_BUTTON,
159 ATK_ROLE_RADIO_BUTTON,
160 ATK_ROLE_RADIO_MENU_ITEM,
164 ATK_ROLE_SCROLL_PANE,
168 ATK_ROLE_SPIN_BUTTON,
172 ATK_ROLE_TABLE_COLUMN_HEADER,
173 ATK_ROLE_TABLE_ROW_HEADER,
174 ATK_ROLE_TEAR_OFF_MENU_ITEM,
177 ATK_ROLE_TOGGLE_BUTTON,
184 ATK_ROLE_LAST_DEFINED
187 AtkRole atk_role_register (const gchar *name);
190 #define ATK_TYPE_OBJECT (atk_object_get_type ())
191 #define ATK_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
192 #define ATK_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
193 #define ATK_IS_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
194 #define ATK_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
195 #define ATK_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
197 #define ATK_TYPE_IMPLEMENTOR (atk_implementor_get_type ())
198 #define ATK_IS_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
199 #define ATK_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
200 #define ATK_IMPLEMENTOR_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
203 typedef struct _AtkImplementor AtkImplementor; /* dummy typedef */
204 typedef struct _AtkImplementorIface AtkImplementorIface;
207 typedef struct _AtkObject AtkObject;
208 typedef struct _AtkObjectClass AtkObjectClass;
209 typedef struct _AtkRelationSet AtkRelationSet;
210 typedef struct _AtkStateSet AtkStateSet;
212 struct _AtkPropertyValues
214 const gchar *property_name;
219 typedef struct _AtkPropertyValues AtkPropertyValues;
222 * For most properties the old_value field of AtkPropertyValues will
223 * not contain a valid value.
225 * Currently, the only property for which old_value is used is
226 * accessible-state; for instance if there is a focus state the
227 * property change handler will be called for the object which lost the focus
228 * with the old_value containing an AtkState value corresponding to focused
229 * and the property change handler will be called for the object which
230 * received the focus with the new_value containing an AtkState value
231 * corresponding to focused.
233 typedef void (*AtkPropertyChangeHandler) (AtkObject*, AtkPropertyValues*);
242 AtkObject *accessible_parent;
244 AtkRelationSet *relation_set;
247 struct _AtkObjectClass
252 * Gets the accessible name of the object
254 G_CONST_RETURN gchar* (* get_name) (AtkObject *accessible);
256 * Gets the accessible description of the object
258 G_CONST_RETURN gchar* (* get_description) (AtkObject *accessible);
260 * Gets the accessible parent of the object
262 AtkObject* (*get_parent) (AtkObject *accessible);
265 * Gets the number of accessible children of the object
267 gint (* get_n_children) (AtkObject *accessible);
269 * Returns a reference to the specified accessible child of the object.
270 * The accessible children are 0-based so the first accessible child is
271 * at index 0, the second at index 1 and so on.
273 AtkObject* (* ref_child) (AtkObject *accessible,
276 * Gets the 0-based index of this object in its parent; returns -1 if the
277 * object does not have an accessible parent.
279 gint (* get_index_in_parent) (AtkObject *accessible);
281 * Gets the RelationSet associated with the object
283 AtkRelationSet* (* ref_relation_set) (AtkObject *accessible);
285 * Gets the role of the object
287 AtkRole (* get_role) (AtkObject *accessible);
289 * Gets the state set of the object
291 AtkStateSet* (* ref_state_set) (AtkObject *accessible);
293 * Sets the accessible name of the object
295 void (* set_name) (AtkObject *accessible,
298 * Sets the accessible description of the object
300 void (* set_description) (AtkObject *accessible,
301 const gchar *description);
303 * Sets the accessible parent of the object
305 void (* set_parent) (AtkObject *accessible,
308 * Sets the accessible role of the object
310 void (* set_role) (AtkObject *accessible,
313 * Specifies a function to be called when a property changes value
315 guint (* connect_property_change_handler) (AtkObject
317 AtkPropertyChangeHandler *handler);
319 * Removes a property change handler which was specified using
320 * connect_property_change_handler
322 void (* remove_property_change_handler) (AtkObject
327 * The signal handler which is executed when there is a change in the
328 * children of the object
330 void (* children_changed) (AtkObject *accessible,
332 AtkObject *changed_child);
334 * The signal handler which is executed when there is a focus event
337 void (*focus_event) (AtkObject *accessible,
340 * The signal handler which is executed when there is a model change
343 void (*model_changed) (AtkObject *accessible);
345 * The signal handler which is executed when there is a property_change
346 * signal for an object.
348 gint (*property_change) (AtkObject *accessible,
349 AtkPropertyValues *values);
351 * The signal handler which is executed when there is a selection change
354 void (*selection_changed) (AtkObject *accessible);
356 * The signal handler which is executed when there is a change in the
357 * visible data for an object
359 void (*visible_data_changed) (AtkObject *accessible);
363 GType atk_object_get_type (void);
365 struct _AtkImplementorIface
367 GTypeInterface parent;
369 AtkObject* (*ref_accessible) (AtkImplementor *implementor);
371 GType atk_implementor_get_type (void);
374 * This method uses the ref_accessible method in AtkImplementorIface,
375 * if the object's class implements AtkImplementorIface.
376 * Otherwise it returns %NULL.
379 * Note also that because this method may return flyweight objects,
380 * it increments the returned AtkObject's reference count.
381 * Therefore it is the responsibility of the calling
382 * program to unreference the object when no longer needed.
383 * (c.f. gtk_widget_get_accessible() where this is not the case).
385 AtkObject* atk_implementor_ref_accessible (AtkImplementor *implementor);
388 * Properties directly supported by AtkObject
391 G_CONST_RETURN gchar* atk_object_get_name (AtkObject *accessible);
392 G_CONST_RETURN gchar* atk_object_get_description (AtkObject *accessible);
393 AtkObject* atk_object_get_parent (AtkObject *accessible);
394 gint atk_object_get_n_accessible_children (AtkObject *accessible);
395 AtkObject* atk_object_ref_accessible_child (AtkObject *accessible,
397 AtkRelationSet* atk_object_ref_relation_set (AtkObject *accessible);
398 AtkRole atk_object_get_role (AtkObject *accessible);
399 AtkStateSet* atk_object_ref_state_set (AtkObject *accessible);
400 gint atk_object_get_index_in_parent (AtkObject *accessible);
401 void atk_object_set_name (AtkObject *accessible,
403 void atk_object_set_description (AtkObject *accessible,
404 const gchar *description);
405 void atk_object_set_parent (AtkObject *accessible,
407 void atk_object_set_role (AtkObject *accessible,
412 * to install property change listener, one must
413 * install signal handler for gobject "properties_changed" signal.
414 * (for single notifications of multiple changes).
415 * We could use the "notify" signal instead.
418 guint atk_object_connect_property_change_handler (AtkObject *accessible,
419 AtkPropertyChangeHandler *handler);
420 void atk_object_remove_property_change_handler (AtkObject *accessible,
423 void atk_object_notify_state_change (AtkObject *accessible,
428 * Note: the properties which are registered with the GType
429 * property registry, for type ATK_TYPE_OBJECT, are as follows:
432 * "accessible-description"
433 * "accessible-parent"
437 * "accessible-parent"
440 * "accessible-selection"
442 * "accessible-visible-data"
443 * "accessible-table-caption"
444 * "accessible-table-column-header"
445 * "accessible-table-row-heaer"
446 * "accessible-table-summary"
449 * accessibility property change listeners should use the
450 * normal GObject property interfaces and "properties_changed"
451 * signal handler semantics to interpret the property change
452 * information relayed from AtkObject.
453 * (AtkObject instances will connect to the "properties_changed"
454 * signal in their host objects, and relay the signals when appropriate).
457 /* For other signals, see related interfaces
468 * The usage model for obtaining these interface instances is:
469 * ATK_<interfacename>_GET_IFACE(GObject *accessible),
470 * where accessible, though specified as a GObject, is
471 * the AtkObject instance being queried.
472 * More usually, the interface will be used via a cast to the
473 * interface's corresponding "type":
475 * AtkText textImpl = ATK_TEXT(accessible);
478 * cpos = atk_text_get_caret_position(textImpl);
481 * If it's known in advance that accessible implements AtkTextIface,
482 * this is shortened to:
484 * cpos = atk_text_get_caret_position (ATK_TEXT (accessible));
489 #endif /* __cplusplus */
492 #endif /* __ATK_OBJECT_H__ */