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>
30 * AtkObject represents the minimum information all accessible objects
31 * return. This information includes accessible name, accessible
32 * description, role and state of the object, as well information about
33 * its parent and children. It is also possible to obtain more specific
34 * accessibility information about a component if it supports one or more
35 * of the following interfaces:
38 /* AtkAttributeSet & AtkAttribute are needed by atktext and atkeditable text */
39 /* so I am putting them here until a better place for them to be defined is */
41 typedef GSList AtkAttributeSet;
43 typedef struct _AtkAttribute {
50 *@ATK_ROLE_INVALID: Invalid role
51 *@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
52 *@ATK_ROLE_ALERT: An object which is an alert to the user
53 *@ATK_ROLE_ANIMATION: An object which is an animated image
54 *@ATK_ROLE_ARROW: An arrow in one of the four cardinal directions
55 *@ATK_ROLE_CALENDAR: An object that displays a calendar and allows the user to select a date
56 *@ATK_ROLE_CANVAS: An object that can be drawn into and is used to trap events
57 *@ATK_ROLE_CHECK_BOX: A choice that can be checked or unchecked and provides a separate indicator for the current state
58 *@ATK_ROLE_CHECK_MENU_ITEM: A menu item with a check box
59 *@ATK_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color
60 *@ATK_ROLE_COLUMN_HEADER: The header for a column of data
61 *@ATK_ROLE_COMBO_BOX: A list of choices the user can select from
62 *@ATK_ROLE_DATE_EDITOR: An object whose purpose is to allow a user to edit a date
63 *@ATK_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
64 *@ATK_ROLE_DESKTOP_FRAME: A pane that supports internal frames and iconified versions of those internal frames
65 *@ATK_ROLE_DIAL: An object whose purpose is to allow a user to set a value
66 *@ATK_ROLE_DIALOG: A top level window with title bar and a border
67 *@ATK_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through and select the contents of a directory
68 *@ATK_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
69 *@ATK_ROLE_FILE_CHOOSER: A specialized dialog that lets the user choose a file
70 *@ATK_ROLE_FILLER: A object that fills up space in a user interface
71 *@ATK_ROLE_FONT_CHOOSER: A specialized dialog that lets the user choose a font
72 *@ATK_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
73 *@ATK_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all panes beneath it
74 *@ATK_ROLE_HTML_CONTAINER: A document container for HTML, whose children represent the document content
75 *@ATK_ROLE_ICON: A small fixed size picture, typically used to decorate components
76 *@ATK_ROLE_IMAGE: An object whose primary purpose is to display an image
77 *@ATK_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane
78 *@ATK_ROLE_LABEL: An object used to present an icon or short string in an interface
79 *@ATK_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
80 *@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
81 *@ATK_ROLE_LIST_ITEM: An object that represents an element of a list
82 *@ATK_ROLE_MENU: An object usually found inside a menu bar that contains a list of actions the user can choose from
83 *@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
84 *@ATK_ROLE_MENU_ITEM: An object usually contained in a menu that presents an action the user can choose
85 *@ATK_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
86 *@ATK_ROLE_PAGE_TAB: An object that is a child of a page tab list
87 *@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
88 *@ATK_ROLE_PANEL: A generic container that is often used to group objects
89 *@ATK_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where the text content is not shown visibly to the user
90 *@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
91 *@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
92 *@ATK_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the application to do something
93 *@ATK_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the same group to become uncghecked when this one is checked
94 *@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
95 *@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
96 *@ATK_ROLE_ROW_HEADER: The header for a row of data
97 *@ATK_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally view a large amount of data.
98 *@ATK_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount of information
99 *@ATK_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
100 *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
101 *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
102 *@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
103 *@ATK_ROLE_STATUSBAR: An object which reports messages of minor importance to the user
104 *@ATK_ROLE_TABLE: An object used to rpesent information in terms of rows and columns
105 *@ATK_ROLE_TABLE_CELL: A cell in a table
106 *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
107 *@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
108 *@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu
109 *@ATK_ROLE_TEXT: An object that presents text to the user
110 *@ATK_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or unchecked, but does not procide a separate indicator for the current state
111 *@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
112 *@ATK_ROLE_TOOL_TIP: An object that provides information about another object
113 *@ATK_ROLE_TREE: An object used to repsent hierarchical information to the user
114 *@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
115 *@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane
116 *@ATK_ROLE_WINDOW: A top level window with no title or border
117 *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of enumeration
119 *Describes the role of an object
124 ATK_ROLE_ACCEL_LABEL,
131 ATK_ROLE_CHECK_MENU_ITEM,
132 ATK_ROLE_COLOR_CHOOSER,
133 ATK_ROLE_COLUMN_HEADER,
135 ATK_ROLE_DATE_EDITOR,
136 ATK_ROLE_DESKTOP_ICON,
137 ATK_ROLE_DESKTOP_FRAME,
140 ATK_ROLE_DIRECTORY_PANE,
141 ATK_ROLE_DRAWING_AREA,
142 ATK_ROLE_FILE_CHOOSER,
144 ATK_ROLE_FONT_CHOOSER,
147 ATK_ROLE_HTML_CONTAINER,
150 ATK_ROLE_INTERNAL_FRAME,
152 ATK_ROLE_LAYERED_PANE,
158 ATK_ROLE_OPTION_PANE,
160 ATK_ROLE_PAGE_TAB_LIST,
162 ATK_ROLE_PASSWORD_TEXT,
164 ATK_ROLE_PROGRESS_BAR,
165 ATK_ROLE_PUSH_BUTTON,
166 ATK_ROLE_RADIO_BUTTON,
167 ATK_ROLE_RADIO_MENU_ITEM,
171 ATK_ROLE_SCROLL_PANE,
175 ATK_ROLE_SPIN_BUTTON,
179 ATK_ROLE_TABLE_COLUMN_HEADER,
180 ATK_ROLE_TABLE_ROW_HEADER,
181 ATK_ROLE_TEAR_OFF_MENU_ITEM,
183 ATK_ROLE_TOGGLE_BUTTON,
190 ATK_ROLE_LAST_DEFINED
193 AtkRole atk_role_register (const gchar *name);
196 #define ATK_TYPE_OBJECT (atk_object_get_type ())
197 #define ATK_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
198 #define ATK_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
199 #define ATK_IS_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
200 #define ATK_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
201 #define ATK_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
203 #define ATK_TYPE_IMPLEMENTOR (atk_implementor_get_type ())
204 #define ATK_IS_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
205 #define ATK_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
206 #define ATK_IMPLEMENTOR_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
209 typedef struct _AtkImplementor AtkImplementor; /* dummy typedef */
210 typedef struct _AtkImplementorIface AtkImplementorIface;
213 typedef struct _AtkObject AtkObject;
214 typedef struct _AtkObjectClass AtkObjectClass;
215 typedef struct _AtkRelationSet AtkRelationSet;
216 typedef struct _AtkStateSet AtkStateSet;
218 struct _AtkPropertyValues
220 gchar *property_name;
225 typedef struct _AtkPropertyValues AtkPropertyValues;
228 * For most properties the old_value field of AtkPropertyValues will
229 * not contain a valid value.
231 * Currently, the only property for which old_value is used is
232 * accessible-state; for instance if there is a focus state the
233 * property change handler will be called for the object which lost the focus
234 * with the old_value containing an AtkState value corresponding to focused
235 * and the property change handler will be called for the object which
236 * received the focus with the new_value containing an AtkState value
237 * corresponding to focused.
239 typedef void (*AtkPropertyChangeHandler) (AtkObject*, AtkPropertyValues*);
248 AtkObject *accessible_parent;
250 AtkRelationSet *relation_set;
253 struct _AtkObjectClass
258 * Gets the accessible name of the object
260 G_CONST_RETURN gchar* (* get_name) (AtkObject *accessible);
262 * Gets the accessible description of the object
264 G_CONST_RETURN gchar* (* get_description) (AtkObject *accessible);
266 * Gets the accessible parent of the object
268 AtkObject* (*get_parent) (AtkObject *accessible);
271 * Gets the number of accessible children of the object
273 gint (* get_n_children) (AtkObject *accessible);
275 * Returns a reference to the specified accessible child of the object.
276 * The accessible children are 0-based so the first accessible child is
277 * at index 0, the second at index 1 and so on.
279 AtkObject* (* ref_child) (AtkObject *accessible,
282 * Gets the 0-based index of this object in its parent; returns -1 if the
283 * object does not have an accessible parent.
285 gint (* get_index_in_parent) (AtkObject *accessible);
287 * Gets the RelationSet associated with the object
289 AtkRelationSet* (* ref_relation_set) (AtkObject *accessible);
291 * Gets the role of the object
293 AtkRole (* get_role) (AtkObject *accessible);
295 * Gets the state set of the object
297 AtkStateSet* (* ref_state_set) (AtkObject *accessible);
299 * Sets the accessible name of the object
301 void (* set_name) (AtkObject *accessible,
304 * Sets the accessible description of the object
306 void (* set_description) (AtkObject *accessible,
307 const gchar *description);
309 * Sets the accessible parent of the object
311 void (* set_parent) (AtkObject *accessible,
314 * Sets the accessible role of the object
316 void (* set_role) (AtkObject *accessible,
319 * Specifies a function to be called when a property changes value
321 guint (* connect_property_change_handler) (AtkObject
323 AtkPropertyChangeHandler *handler);
325 * Removes a property change handler which was specified using
326 * connect_property_change_handler
328 void (* remove_property_change_handler) (AtkObject
333 * The signal handler which is executed when there is a change in the
334 * children of the object
336 void (* children_changed) (AtkObject *accessible,
338 AtkObject *changed_child);
340 * The signal handler which is executed when there is a focus event
343 void (*focus_event) (AtkObject *accessible,
347 GType atk_object_get_type (void);
349 struct _AtkImplementorIface
351 GTypeInterface parent;
353 AtkObject* (*ref_accessible) (AtkImplementor *implementor);
355 GType atk_implementor_get_type (void);
358 * This method uses the ref_accessible method in AtkImplementorIface,
359 * if the object's class implements AtkImplementorIface.
360 * Otherwise it returns %NULL.
363 * Note also that because this method may return flyweight objects,
364 * it increments the returned AtkObject's reference count.
365 * Therefore it is the responsibility of the calling
366 * program to unreference the object when no longer needed.
367 * (c.f. gtk_widget_get_accessible() where this is not the case).
369 AtkObject* atk_implementor_ref_accessible (AtkImplementor *implementor);
372 * Properties directly supported by AtkObject
375 G_CONST_RETURN gchar* atk_object_get_name (AtkObject *accessible);
376 G_CONST_RETURN gchar* atk_object_get_description (AtkObject *accessible);
377 AtkObject* atk_object_get_parent (AtkObject *accessible);
378 gint atk_object_get_n_accessible_children (AtkObject *accessible);
379 AtkObject* atk_object_ref_accessible_child (AtkObject *accessible,
381 AtkRelationSet* atk_object_ref_relation_set (AtkObject *accessible);
382 AtkRole atk_object_get_role (AtkObject *accessible);
383 AtkStateSet* atk_object_ref_state_set (AtkObject *accessible);
384 gint atk_object_get_index_in_parent (AtkObject *accessible);
385 void atk_object_set_name (AtkObject *accessible,
387 void atk_object_set_description (AtkObject *accessible,
388 const gchar *description);
389 void atk_object_set_parent (AtkObject *accessible,
391 void atk_object_set_role (AtkObject *accessible,
396 * to install property change listener, one must
397 * install signal handler for gobject "properties_changed" signal.
398 * (for single notifications of multiple changes).
399 * We could use the "notify" signal instead.
402 guint atk_object_connect_property_change_handler (AtkObject *accessible,
403 AtkPropertyChangeHandler *handler);
404 void atk_object_remove_property_change_handler (AtkObject *accessible,
408 * Note: the properties which are registered with the GType
409 * property registry, for type ATK_TYPE_OBJECT, are as follows:
412 * "accessible-description"
413 * "accessible-parent"
418 * accessibility property change listeners should use the
419 * normal GObject property interfaces and "properties_changed"
420 * signal handler semantics to interpret the property change
421 * information relayed from AtkObject.
422 * (AtkObject instances will connect to the "properties_changed"
423 * signal in their host objects, and relay the signals when appropriate).
426 /* For other signals, see related interfaces
437 * The usage model for obtaining these interface instances is:
438 * ATK_<interfacename>_GET_IFACE(GObject *accessible),
439 * where accessible, though specified as a GObject, is
440 * the AtkObject instance being queried.
441 * More usually, the interface will be used via a cast to the
442 * interface's corresponding "type":
444 * AtkText textImpl = ATK_TEXT(accessible);
447 * cpos = atk_text_get_caret_position(textImpl);
450 * If it's known in advance that accessible implements AtkTextIface,
451 * this is shortened to:
453 * cpos = atk_text_get_caret_position (ATK_TEXT (accessible));
458 #endif /* __cplusplus */
461 #endif /* __ATK_OBJECT_H__ */