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_LAST_DEFINED: not a valid role, used for finding end of enumeration
119 *Describes the role of an object
123 ATK_ROLE_INVALID
= 0,
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
,
184 ATK_ROLE_TOGGLE_BUTTON
,
196 ATK_ROLE_APPLICATION
,
197 ATK_ROLE_LAST_DEFINED
200 AtkRole
atk_role_register (const gchar
*name
);
204 *@ATK_LAYER_INVALID: The object does not have a layer
205 *@ATK_LAYER_BACKGROUND: This layer is reserved for the desktop background
206 *@ATK_LAYER_CANVAS: This layer is used for Canvas components
207 *@ATK_LAYER_WIDGET: This layer is normally used for components
208 *@ATK_LAYER_MDI: This layer is used for layered components
209 *@ATK_LAYER_POPUP: This layer is used for popup components, such as menus
210 *@ATK_LAYER_OVERLAY: This layer is reserved for future use.
211 *@ATK_LAYER_WINDOW: This layer is used for toplevel windows.
213 * Describes the layer of a component
218 ATK_LAYER_BACKGROUND
,
227 #define ATK_TYPE_OBJECT (atk_object_get_type ())
228 #define ATK_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
229 #define ATK_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
230 #define ATK_IS_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
231 #define ATK_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
232 #define ATK_OBJECT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
234 #define ATK_TYPE_IMPLEMENTOR (atk_implementor_get_type ())
235 #define ATK_IS_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
236 #define ATK_IMPLEMENTOR(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
237 #define ATK_IMPLEMENTOR_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
240 typedef struct _AtkImplementor AtkImplementor
; /* dummy typedef */
241 typedef struct _AtkImplementorIface AtkImplementorIface
;
244 typedef struct _AtkObject AtkObject
;
245 typedef struct _AtkObjectClass AtkObjectClass
;
246 typedef struct _AtkRelationSet AtkRelationSet
;
247 typedef struct _AtkStateSet AtkStateSet
;
249 struct _AtkPropertyValues
251 const gchar
*property_name
;
256 typedef struct _AtkPropertyValues AtkPropertyValues
;
258 typedef gboolean (*AtkFunction
) (gpointer data
);
260 * For most properties the old_value field of AtkPropertyValues will
261 * not contain a valid value.
263 * Currently, the only property for which old_value is used is
264 * accessible-state; for instance if there is a focus state the
265 * property change handler will be called for the object which lost the focus
266 * with the old_value containing an AtkState value corresponding to focused
267 * and the property change handler will be called for the object which
268 * received the focus with the new_value containing an AtkState value
269 * corresponding to focused.
271 typedef void (*AtkPropertyChangeHandler
) (AtkObject
*, AtkPropertyValues
*);
280 AtkObject
*accessible_parent
;
282 AtkRelationSet
*relation_set
;
286 struct _AtkObjectClass
291 * Gets the accessible name of the object
293 G_CONST_RETURN gchar
* (* get_name
) (AtkObject
*accessible
);
295 * Gets the accessible description of the object
297 G_CONST_RETURN gchar
* (* get_description
) (AtkObject
*accessible
);
299 * Gets the accessible parent of the object
301 AtkObject
* (*get_parent
) (AtkObject
*accessible
);
304 * Gets the number of accessible children of the object
306 gint (* get_n_children
) (AtkObject
*accessible
);
308 * Returns a reference to the specified accessible child of the object.
309 * The accessible children are 0-based so the first accessible child is
310 * at index 0, the second at index 1 and so on.
312 AtkObject
* (* ref_child
) (AtkObject
*accessible
,
315 * Gets the 0-based index of this object in its parent; returns -1 if the
316 * object does not have an accessible parent.
318 gint (* get_index_in_parent
) (AtkObject
*accessible
);
320 * Gets the RelationSet associated with the object
322 AtkRelationSet
* (* ref_relation_set
) (AtkObject
*accessible
);
324 * Gets the role of the object
326 AtkRole (* get_role
) (AtkObject
*accessible
);
327 AtkLayer (* get_layer
) (AtkObject
*accessible
);
328 gint (* get_mdi_zorder
) (AtkObject
*accessible
);
330 * Gets the state set of the object
332 AtkStateSet
* (* ref_state_set
) (AtkObject
*accessible
);
334 * Sets the accessible name of the object
336 void (* set_name
) (AtkObject
*accessible
,
339 * Sets the accessible description of the object
341 void (* set_description
) (AtkObject
*accessible
,
342 const gchar
*description
);
344 * Sets the accessible parent of the object
346 void (* set_parent
) (AtkObject
*accessible
,
349 * Sets the accessible role of the object
351 void (* set_role
) (AtkObject
*accessible
,
354 * Specifies a function to be called when a property changes value
356 guint (* connect_property_change_handler
) (AtkObject
358 AtkPropertyChangeHandler
*handler
);
360 * Removes a property change handler which was specified using
361 * connect_property_change_handler
363 void (* remove_property_change_handler
) (AtkObject
367 void (* initialize
) (AtkObject
*accessible
,
370 * The signal handler which is executed when there is a change in the
371 * children of the object
373 void (* children_changed
) (AtkObject
*accessible
,
375 gpointer changed_child
);
377 * The signal handler which is executed when there is a focus event
380 void (* focus_event
) (AtkObject
*accessible
,
383 * The signal handler which is executed when there is a property_change
384 * signal for an object.
386 void (* property_change
) (AtkObject
*accessible
,
387 AtkPropertyValues
*values
);
389 * The signal handler which is executed when there is a state_change
390 * signal for an object.
392 void (* state_change
) (AtkObject
*accessible
,
396 * The signal handler which is executed when there is a change in the
397 * visible data for an object
399 void (*visible_data_changed
) (AtkObject
*accessible
);
402 * The signal handler which is executed when there is a change in the
403 * 'active' child or children of the object, for instance when
404 * interior focus changes in a table or list. This signal should be emitted
405 * by objects whose state includes ATK_STATE_MANAGES_DESCENDANTS.
407 void (*active_descendant_changed
) (AtkObject
*accessible
,
416 GType
atk_object_get_type (void);
418 struct _AtkImplementorIface
420 GTypeInterface parent
;
422 AtkObject
* (*ref_accessible
) (AtkImplementor
*implementor
);
424 GType
atk_implementor_get_type (void);
427 * This method uses the ref_accessible method in AtkImplementorIface,
428 * if the object's class implements AtkImplementorIface.
429 * Otherwise it returns %NULL.
432 * Note also that because this method may return flyweight objects,
433 * it increments the returned AtkObject's reference count.
434 * Therefore it is the responsibility of the calling
435 * program to unreference the object when no longer needed.
436 * (c.f. gtk_widget_get_accessible() where this is not the case).
438 AtkObject
* atk_implementor_ref_accessible (AtkImplementor
*implementor
);
441 * Properties directly supported by AtkObject
444 G_CONST_RETURN gchar
* atk_object_get_name (AtkObject
*accessible
);
445 G_CONST_RETURN gchar
* atk_object_get_description (AtkObject
*accessible
);
446 AtkObject
* atk_object_get_parent (AtkObject
*accessible
);
447 gint
atk_object_get_n_accessible_children (AtkObject
*accessible
);
448 AtkObject
* atk_object_ref_accessible_child (AtkObject
*accessible
,
450 AtkRelationSet
* atk_object_ref_relation_set (AtkObject
*accessible
);
451 AtkRole
atk_object_get_role (AtkObject
*accessible
);
452 AtkLayer
atk_object_get_layer (AtkObject
*accessible
);
453 gint
atk_object_get_mdi_zorder (AtkObject
*accessible
);
454 AtkStateSet
* atk_object_ref_state_set (AtkObject
*accessible
);
455 gint
atk_object_get_index_in_parent (AtkObject
*accessible
);
456 void atk_object_set_name (AtkObject
*accessible
,
458 void atk_object_set_description (AtkObject
*accessible
,
459 const gchar
*description
);
460 void atk_object_set_parent (AtkObject
*accessible
,
462 void atk_object_set_role (AtkObject
*accessible
,
466 guint
atk_object_connect_property_change_handler (AtkObject
*accessible
,
467 AtkPropertyChangeHandler
*handler
);
468 void atk_object_remove_property_change_handler (AtkObject
*accessible
,
471 void atk_object_notify_state_change (AtkObject
*accessible
,
474 void atk_object_initialize (AtkObject
*accessible
,
477 G_CONST_RETURN gchar
* atk_role_get_name (AtkRole role
);
478 AtkRole
atk_role_for_name (const gchar
*name
);
481 /* NEW in 1.1: convenience API */
482 gboolean
atk_object_add_relationship (AtkObject
*object
,
483 AtkRelationType relationship
,
485 gboolean
atk_object_remove_relationship (AtkObject
*object
,
486 AtkRelationType relationship
,
488 G_CONST_RETURN gchar
* atk_role_get_localized_name (AtkRole role
);
492 * Note: the properties which are registered with the GType
493 * property registry, for type ATK_TYPE_OBJECT, are as follows:
496 * "accessible-description"
497 * "accessible-parent"
500 * "accessible-component-layer"
501 * "accessible-component-zorder"
502 * "accessible-table-caption"
503 * "accessible-table-column-description"
504 * "accessible-table-column-header"
505 * "accessible-table-row-description"
506 * "accessible-table-row-header"
507 * "accessible-table-summary"
510 * accessibility property change listeners should use the
511 * normal GObject property interfaces and "property-change"
512 * signal handler semantics to interpret the property change
513 * information relayed from AtkObject.
514 * (AtkObject instances will connect to the "notify"
515 * signal in their host objects, and relay the signals when appropriate).
518 /* For other signals, see related interfaces
529 * The usage model for obtaining these interface instances is:
530 * ATK_<interfacename>_GET_IFACE(GObject *accessible),
531 * where accessible, though specified as a GObject, is
532 * the AtkObject instance being queried.
533 * More usually, the interface will be used via a cast to the
534 * interface's corresponding "type":
536 * AtkText textImpl = ATK_TEXT(accessible);
539 * cpos = atk_text_get_caret_position(textImpl);
542 * If it's known in advance that accessible implements AtkTextIface,
543 * this is shortened to:
545 * cpos = atk_text_get_caret_position (ATK_TEXT (accessible));
550 #endif /* __cplusplus */
553 #endif /* __ATK_OBJECT_H__ */