atk/atkobject.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 #ifndef __ATK_OBJECT_H__
  21 #define __ATK_OBJECT_H__
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif /* __cplusplus */
  26
  27 #include <glib-object.h>
  28 #include <atk/atkstate.h>
  29 #include <atk/atkrelationtype.h>
  30
  31 /*
  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:
  38  */
  39
  40
  41 /**
  42  *AtkRole:
  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. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role.  Should be used for warning dialogs, etc.
  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.  @Since: ATK-0.6
 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.   @Since: ATK-0.7
 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. @Since:ATK 1.1.1
 113  *@ATK_ROLE_FOOTER: An object that serves as a document footer.  @Since: ATK-1.1.1
 114  *@ATK_ROLE_PARAGRAPH: An object which is contains a paragraph of text content.   @Since: ATK-1.1.1
 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).   @Since: ATK-1.1.1
 116  *@ATK_ROLE_APPLICATION: The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles.  The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION.   @Since: ATK-1.1.4
 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.   @Since: ATK-1.3
 118  *@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar.  @Since: ATK-1.5
 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.  @Since: ATK-1.7.2
 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.   @Since: ATK-1.11
 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.  @Since: ATK-1.11
 122  *@ATK_ROLE_CAPTION: The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.  @Since: ATK-1.11
 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.  @Since: ATK-1.11
 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.  @Since: ATK-1.11
 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. @Since: ATK-1.11
 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. @Since: ATK-1.11
 128  *@ATK_ROLE_FORM: The object is a container for form controls, for instance as part of a
 129  * web form or user-input form within a document.  This role is primarily a tag/convenience for
 130  * clients when navigating complex documents, it is not expected that ordinary GUI containers will
 131  * always have ATK_ROLE_FORM. @Since: ATK-1.12.0
 132  *@ATK_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a
 133  * hypertext document.  Such objects are distinct from 'inline'
 134  * content which may also use the Hypertext/Hyperlink interfaces
 135  * to indicate the range/location within a text object where
 136  * an inline or embedded object lies.  @Since: ATK-1.12.1
 137  *@ATK_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
 138  * which is used to allow composition or input of a 'complex character',
 139  * in other words it is an "input method window." @Since: ATK-1.12.1
 140  *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration
 141  *
 142  * Describes the role of an object
 143  *
 144  * These are the built-in enumerated roles that UI components can have in
 145  * ATK.  Other roles may be added at runtime, so an AtkRole >=
 146  * ATK_ROLE_LAST_DEFINED is not necessarily an error.
 147  **/
 148 typedef enum
 149 {
 150   ATK_ROLE_INVALID = 0,
 151   ATK_ROLE_ACCEL_LABEL,
 152   ATK_ROLE_ALERT,
 153   ATK_ROLE_ANIMATION,
 154   ATK_ROLE_ARROW,
 155   ATK_ROLE_CALENDAR,
 156   ATK_ROLE_CANVAS,
 157   ATK_ROLE_CHECK_BOX,
 158   ATK_ROLE_CHECK_MENU_ITEM,
 159   ATK_ROLE_COLOR_CHOOSER,
 160   ATK_ROLE_COLUMN_HEADER,
 161   ATK_ROLE_COMBO_BOX,
 162   ATK_ROLE_DATE_EDITOR,
 163   ATK_ROLE_DESKTOP_ICON,
 164   ATK_ROLE_DESKTOP_FRAME,
 165   ATK_ROLE_DIAL,
 166   ATK_ROLE_DIALOG,
 167   ATK_ROLE_DIRECTORY_PANE,
 168   ATK_ROLE_DRAWING_AREA,
 169   ATK_ROLE_FILE_CHOOSER,
 170   ATK_ROLE_FILLER,
 171   ATK_ROLE_FONT_CHOOSER,
 172   ATK_ROLE_FRAME,
 173   ATK_ROLE_GLASS_PANE,
 174   ATK_ROLE_HTML_CONTAINER,
 175   ATK_ROLE_ICON,
 176   ATK_ROLE_IMAGE,
 177   ATK_ROLE_INTERNAL_FRAME,
 178   ATK_ROLE_LABEL,
 179   ATK_ROLE_LAYERED_PANE,
 180   ATK_ROLE_LIST,
 181   ATK_ROLE_LIST_ITEM,
 182   ATK_ROLE_MENU,
 183   ATK_ROLE_MENU_BAR,
 184   ATK_ROLE_MENU_ITEM,
 185   ATK_ROLE_OPTION_PANE,
 186   ATK_ROLE_PAGE_TAB,
 187   ATK_ROLE_PAGE_TAB_LIST,
 188   ATK_ROLE_PANEL,
 189   ATK_ROLE_PASSWORD_TEXT,
 190   ATK_ROLE_POPUP_MENU,
 191   ATK_ROLE_PROGRESS_BAR,
 192   ATK_ROLE_PUSH_BUTTON,
 193   ATK_ROLE_RADIO_BUTTON,
 194   ATK_ROLE_RADIO_MENU_ITEM,
 195   ATK_ROLE_ROOT_PANE,
 196   ATK_ROLE_ROW_HEADER,
 197   ATK_ROLE_SCROLL_BAR,
 198   ATK_ROLE_SCROLL_PANE,
 199   ATK_ROLE_SEPARATOR,
 200   ATK_ROLE_SLIDER,
 201   ATK_ROLE_SPLIT_PANE,
 202   ATK_ROLE_SPIN_BUTTON,
 203   ATK_ROLE_STATUSBAR,
 204   ATK_ROLE_TABLE,
 205   ATK_ROLE_TABLE_CELL,
 206   ATK_ROLE_TABLE_COLUMN_HEADER,
 207   ATK_ROLE_TABLE_ROW_HEADER,
 208   ATK_ROLE_TEAR_OFF_MENU_ITEM,
 209   ATK_ROLE_TERMINAL,
 210   ATK_ROLE_TEXT,
 211   ATK_ROLE_TOGGLE_BUTTON,
 212   ATK_ROLE_TOOL_BAR,
 213   ATK_ROLE_TOOL_TIP,
 214   ATK_ROLE_TREE,
 215   ATK_ROLE_TREE_TABLE,
 216   ATK_ROLE_UNKNOWN,
 217   ATK_ROLE_VIEWPORT,
 218   ATK_ROLE_WINDOW,
 219   ATK_ROLE_HEADER,
 220   ATK_ROLE_FOOTER,
 221   ATK_ROLE_PARAGRAPH,
 222   ATK_ROLE_RULER,
 223   ATK_ROLE_APPLICATION,
 224   ATK_ROLE_AUTOCOMPLETE,
 225   ATK_ROLE_EDITBAR,
 226   ATK_ROLE_EMBEDDED,
 227   ATK_ROLE_ENTRY,
 228   ATK_ROLE_CHART,
 229   ATK_ROLE_CAPTION,
 230   ATK_ROLE_DOCUMENT_FRAME,
 231   ATK_ROLE_HEADING,
 232   ATK_ROLE_PAGE,
 233   ATK_ROLE_SECTION,
 234   ATK_ROLE_REDUNDANT_OBJECT,
 235   ATK_ROLE_FORM,
 236   ATK_ROLE_LINK,
 237   ATK_ROLE_INPUT_METHOD_WINDOW,
 238   ATK_ROLE_LAST_DEFINED
 239 } AtkRole;
 240
 241 AtkRole                  atk_role_register        (const gchar *name);
 242
 243 /**
 244  *AtkLayer:
 245  *@ATK_LAYER_INVALID: The object does not have a layer
 246  *@ATK_LAYER_BACKGROUND: This layer is reserved for the desktop background
 247  *@ATK_LAYER_CANVAS: This layer is used for Canvas components
 248  *@ATK_LAYER_WIDGET: This layer is normally used for components
 249  *@ATK_LAYER_MDI: This layer is used for layered components
 250  *@ATK_LAYER_POPUP: This layer is used for popup components, such as menus
 251  *@ATK_LAYER_OVERLAY: This layer is reserved for future use.
 252  *@ATK_LAYER_WINDOW: This layer is used for toplevel windows.
 253  *
 254  * Describes the layer of a component
 255  *
 256  * These enumerated "layer values" are used when determining which UI
 257  * rendering layer a component is drawn into, which can help in making
 258  * determinations of when components occlude one another.
 259  **/
 260 typedef enum
 261 {
 262   ATK_LAYER_INVALID,
 263   ATK_LAYER_BACKGROUND,
 264   ATK_LAYER_CANVAS,
 265   ATK_LAYER_WIDGET,
 266   ATK_LAYER_MDI,
 267   ATK_LAYER_POPUP,
 268   ATK_LAYER_OVERLAY,
 269   ATK_LAYER_WINDOW
 270 } AtkLayer;
 271
 272 /**
 273  * AtkAttributeSet:
 274  *
 275  * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
 276  * used by atk_text_get_run_attributes(), atk_text_get_default_attributes()
 277  * and atk_editable_text_set_run_attributes()
 278  **/
 279 typedef GSList AtkAttributeSet;
 280
 281 /**
 282  * AtkAttribute:
 283  * @name: The attribute name. Call atk_text_attr_get_name()
 284  * @value: the value of the attribute, represented as a string.
 285  * Call atk_text_attr_get_value() for those which are strings.
 286  * For values which are numbers, the string representation of the number
 287  * is in value.
 288  *
 289  * A string name/value pair representing a text attribute.
 290  **/
 291 typedef struct _AtkAttribute AtkAttribute;
 292
 293 struct _AtkAttribute {
 294   gchar* name;
 295   gchar* value;
 296 };
 297
 298 #define ATK_TYPE_OBJECT                           (atk_object_get_type ())
 299 #define ATK_OBJECT(obj)                           (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
 300 #define ATK_OBJECT_CLASS(klass)                   (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
 301 #define ATK_IS_OBJECT(obj)                        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
 302 #define ATK_IS_OBJECT_CLASS(klass)                (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
 303 #define ATK_OBJECT_GET_CLASS(obj)                 (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
 304
 305 #define ATK_TYPE_IMPLEMENTOR                      (atk_implementor_get_type ())
 306 #define ATK_IS_IMPLEMENTOR(obj)                   G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
 307 #define ATK_IMPLEMENTOR(obj)                      G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
 308 #define ATK_IMPLEMENTOR_GET_IFACE(obj)            (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
 309
 310
 311 typedef struct _AtkImplementor            AtkImplementor; /* dummy typedef */
 312 typedef struct _AtkImplementorIface       AtkImplementorIface;
 313
 314
 315 typedef struct _AtkObject                 AtkObject;
 316 typedef struct _AtkObjectClass            AtkObjectClass;
 317 typedef struct _AtkRelationSet            AtkRelationSet;
 318 typedef struct _AtkStateSet               AtkStateSet;
 319
 320 /**
 321  * AtkPropertyValues:
 322  * @property_name: The name of the ATK property which is being presented or which has been changed.
 323  * @old_value: The old property value, NULL; in some contexts this value is undefined (see note below).
 324  * @new_value: The new value of the named property.
 325  *
 326  * @note: For most properties the old_value field of AtkPropertyValues will
 327  * not contain a valid value.
 328  *
 329  * Currently, the only property for which old_value is used is
 330  * accessible-state; for instance if there is a focus state the
 331  * property change handler will be called for the object which lost the focus
 332  * with the old_value containing an AtkState value corresponding to focused
 333  * and the property change handler will be called for the object which
 334  * received the focus with the new_value containing an AtkState value
 335  * corresponding to focused.
 336  *
 337  **/
 338 struct _AtkPropertyValues
 339 {
 340   const gchar  *property_name;
 341   GValue old_value;
 342   GValue new_value;
 343 };
 344
 345 typedef struct _AtkPropertyValues        AtkPropertyValues;
 346
 347 typedef gboolean (*AtkFunction)          (gpointer data);
 348 /*
 349  * For most properties the old_value field of AtkPropertyValues will
 350  * not contain a valid value.
 351  *
 352  * Currently, the only property for which old_value is used is
 353  * accessible-state; for instance if there is a focus state the
 354  * property change handler will be called for the object which lost the focus
 355  * with the old_value containing an AtkState value corresponding to focused
 356  * and the property change handler will be called for the object which
 357  * received the focus with the new_value containing an AtkState value
 358  * corresponding to focused.
 359  */
 360 typedef void (*AtkPropertyChangeHandler) (AtkObject*, AtkPropertyValues*);
 361
 362
 363 struct _AtkObject
 364 {
 365   GObject parent;
 366
 367   gchar *description;
 368   gchar *name;
 369   AtkObject *accessible_parent;
 370   AtkRole role;
 371   AtkRelationSet *relation_set;
 372   AtkLayer layer;
 373 };
 374
 375 struct _AtkObjectClass
 376 {
 377   GObjectClass parent;
 378
 379   /*
 380    * Gets the accessible name of the object
 381    */
 382   G_CONST_RETURN gchar*    (* get_name)            (AtkObject                *accessible);
 383   /*
 384    * Gets the accessible description of the object
 385    */
 386   G_CONST_RETURN gchar*    (* get_description)     (AtkObject                *accessible);
 387   /*
 388    * Gets the accessible parent of the object
 389    */
 390   AtkObject*               (*get_parent)           (AtkObject                *accessible);
 391
 392   /*
 393    * Gets the number of accessible children of the object
 394    */
 395   gint                    (* get_n_children)       (AtkObject                *accessible);
 396   /*
 397    * Returns a reference to the specified accessible child of the object.
 398    * The accessible children are 0-based so the first accessible child is
 399    * at index 0, the second at index 1 and so on.
 400    */
 401   AtkObject*              (* ref_child)            (AtkObject                *accessible,
 402                                                     gint                      i);
 403   /*
 404    * Gets the 0-based index of this object in its parent; returns -1 if the
 405    * object does not have an accessible parent.
 406    */
 407   gint                    (* get_index_in_parent) (AtkObject                 *accessible);
 408   /*
 409    * Gets the RelationSet associated with the object
 410    */
 411   AtkRelationSet*         (* ref_relation_set)    (AtkObject                 *accessible);
 412   /*
 413    * Gets the role of the object
 414    */
 415   AtkRole                 (* get_role)            (AtkObject                 *accessible);
 416   AtkLayer                (* get_layer)           (AtkObject                 *accessible);
 417   gint                    (* get_mdi_zorder)      (AtkObject                 *accessible);
 418   /*
 419    * Gets the state set of the object
 420    */
 421   AtkStateSet*            (* ref_state_set)       (AtkObject                 *accessible);
 422   /*
 423    * Sets the accessible name of the object
 424    */
 425   void                    (* set_name)            (AtkObject                 *accessible,
 426                                                    const gchar               *name);
 427   /*
 428    * Sets the accessible description of the object
 429    */
 430   void                    (* set_description)     (AtkObject                 *accessible,
 431                                                    const gchar               *description);
 432   /*
 433    * Sets the accessible parent of the object
 434    */
 435   void                    (* set_parent)          (AtkObject                 *accessible,
 436                                                    AtkObject                 *parent);
 437   /*
 438    * Sets the accessible role of the object
 439    */
 440   void                    (* set_role)            (AtkObject                 *accessible,
 441                                                    AtkRole                   role);
 442   /*
 443    * Specifies a function to be called when a property changes value
 444    */
 445 guint                     (* connect_property_change_handler)    (AtkObject
 446                  *accessible,
 447                                                                   AtkPropertyChangeHandler       *handler);
 448   /*
 449    * Removes a property change handler which was specified using
 450    * connect_property_change_handler
 451    */
 452 void                      (* remove_property_change_handler)     (AtkObject
 453                 *accessible,
 454                                                                   guint
 455                 handler_id);
 456 void                      (* initialize)                         (AtkObject                     *accessible,
 457                                                                   gpointer                      data);
 458   /*
 459    * The signal handler which is executed when there is a change in the
 460    * children of the object
 461    */
 462   void                    (* children_changed)    (AtkObject                  *accessible,
 463                                                    guint                      change_index,
 464                                                    gpointer                   changed_child);
 465   /*
 466    * The signal handler which is executed  when there is a focus event
 467    * for an object.
 468    */
 469   void                    (* focus_event)         (AtkObject                  *accessible,
 470                                                    gboolean                   focus_in);
 471   /*
 472    * The signal handler which is executed  when there is a property_change
 473    * signal for an object.
 474    */
 475   void                    (* property_change)     (AtkObject                  *accessible,
 476                                                    AtkPropertyValues          *values);
 477   /*
 478    * The signal handler which is executed  when there is a state_change
 479    * signal for an object.
 480    */
 481   void                    (* state_change)        (AtkObject                  *accessible,
 482                                                    const gchar                *name,
 483                                                    gboolean                   state_set);
 484   /*
 485    * The signal handler which is executed when there is a change in the
 486    * visible data for an object
 487    */
 488   void                    (*visible_data_changed) (AtkObject                  *accessible);
 489
 490   /*
 491    * The signal handler which is executed when there is a change in the
 492    * 'active' child or children of the object, for instance when
 493    * interior focus changes in a table or list.  This signal should be emitted
 494    * by objects whose state includes ATK_STATE_MANAGES_DESCENDANTS.
 495    */
 496   void                    (*active_descendant_changed) (AtkObject                  *accessible,
 497                                                         gpointer                   *child);
 498
 499   /*
 500    * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs.
 501    * Since ATK 1.12
 502    */
 503   AtkAttributeSet*        (*get_attributes)            (AtkObject                  *accessible);
 504   AtkFunction             pad1;
 505   AtkFunction             pad2;
 506 };
 507
 508 GType            atk_object_get_type   (void);
 509
 510 struct _AtkImplementorIface
 511 {
 512   GTypeInterface parent;
 513
 514   AtkObject*   (*ref_accessible) (AtkImplementor *implementor);
 515 };
 516 GType atk_implementor_get_type (void);
 517
 518 /*
 519  * This method uses the ref_accessible method in AtkImplementorIface,
 520  * if the object's class implements AtkImplementorIface.
 521  * Otherwise it returns %NULL.
 522  *
 523  * IMPORTANT:
 524  * Note also that because this method may return flyweight objects,
 525  * it increments the returned AtkObject's reference count.
 526  * Therefore it is the responsibility of the calling
 527  * program to unreference the object when no longer needed.
 528  * (c.f. gtk_widget_get_accessible() where this is not the case).
 529  */
 530 AtkObject*              atk_implementor_ref_accessible            (AtkImplementor *implementor);
 531
 532 /*
 533  * Properties directly supported by AtkObject
 534  */
 535
 536 G_CONST_RETURN gchar*   atk_object_get_name                       (AtkObject *accessible);
 537 G_CONST_RETURN gchar*   atk_object_get_description                (AtkObject *accessible);
 538 AtkObject*              atk_object_get_parent                     (AtkObject *accessible);
 539 gint                    atk_object_get_n_accessible_children      (AtkObject *accessible);
 540 AtkObject*              atk_object_ref_accessible_child           (AtkObject *accessible,
 541                                                                    gint        i);
 542 AtkRelationSet*         atk_object_ref_relation_set               (AtkObject *accessible);
 543 AtkRole                 atk_object_get_role                       (AtkObject *accessible);
 544 AtkLayer                atk_object_get_layer                      (AtkObject *accessible);
 545 gint                    atk_object_get_mdi_zorder                 (AtkObject *accessible);
 546 AtkAttributeSet*        atk_object_get_attributes                 (AtkObject *accessible);
 547 AtkStateSet*            atk_object_ref_state_set                  (AtkObject *accessible);
 548 gint                    atk_object_get_index_in_parent            (AtkObject *accessible);
 549 void                    atk_object_set_name                       (AtkObject *accessible,
 550                                                                    const gchar *name);
 551 void                    atk_object_set_description                (AtkObject *accessible,
 552                                                                    const gchar *description);
 553 void                    atk_object_set_parent                     (AtkObject *accessible,
 554                                                                    AtkObject *parent);
 555 void                    atk_object_set_role                       (AtkObject *accessible,
 556                                                                    AtkRole   role);
 557
 558
 559 guint                atk_object_connect_property_change_handler  (AtkObject                      *accessible,
 560                                                                   AtkPropertyChangeHandler       *handler);
 561 void                 atk_object_remove_property_change_handler   (AtkObject                      *accessible,
 562                                                                   guint                          handler_id);
 563
 564 void                 atk_object_notify_state_change              (AtkObject                      *accessible,
 565                                                                   AtkState                       state,
 566                                                                   gboolean                       value);
 567 void                 atk_object_initialize                       (AtkObject                     *accessible,
 568                                                                   gpointer                      data);
 569
 570 G_CONST_RETURN gchar* atk_role_get_name      (AtkRole         role);
 571 AtkRole               atk_role_for_name      (const gchar     *name);
 572
 573
 574 /* NEW in 1.1: convenience API */
 575 gboolean              atk_object_add_relationship              (AtkObject      *object,
 576                                                                 AtkRelationType relationship,
 577                                                                 AtkObject      *target);
 578 gboolean              atk_object_remove_relationship           (AtkObject      *object,
 579                                                                 AtkRelationType relationship,
 580                                                                 AtkObject      *target);
 581 G_CONST_RETURN gchar* atk_role_get_localized_name              (AtkRole     role);
 582
 583 /* */
 584
 585
 586 /*
 587  * Note: the properties which are registered with the GType
 588  *   property registry, for type ATK_TYPE_OBJECT, are as follows:
 589  *
 590  *   "accessible-name"
 591  *   "accessible-description"
 592  *   "accessible-parent"
 593  *   "accessible-role"
 594  *   "accessible-value"
 595  *   "accessible-component-layer"
 596  *   "accessible-component-zorder"
 597  *   "accessible-table-caption"
 598  *   "accessible-table-column-description"
 599  *   "accessible-table-column-header"
 600  *   "accessible-table-row-description"
 601  *   "accessible-table-row-header"
 602  *   "accessible-table-summary"
 603  *   "accessible-model"
 604  *
 605  * accessibility property change listeners should use the
 606  *   normal GObject property interfaces and "property-change"
 607  *   signal handler semantics to interpret the property change
 608  *   information relayed from AtkObject.
 609  *   (AtkObject instances will connect to the "notify"
 610  *   signal in their host objects, and relay the signals when appropriate).
 611  */
 612
 613 /* For other signals, see related interfaces
 614  *
 615  *    AtkActionIface,
 616  *    AtkComponentIface,
 617  *    AtkHypertextIface,
 618  *    AtkImageIface,
 619  *    AtkSelectionIface,
 620  *    AtkTableIface,
 621  *    AtkTextIface,
 622  *    AtkValueIface.
 623  *
 624  *  The usage model for obtaining these interface instances is:
 625  *    ATK_<interfacename>_GET_IFACE(GObject *accessible),
 626  *    where accessible, though specified as a GObject, is
 627  *    the AtkObject instance being queried.
 628  *  More usually, the interface will be used via a cast to the
 629  *    interface's corresponding "type":
 630  *
 631  *    AtkText textImpl = ATK_TEXT(accessible);
 632  *    if (textImpl)
 633  *      {
 634  *        cpos = atk_text_get_caret_position(textImpl);
 635  *      }
 636  *
 637  *  If it's known in advance that accessible implements AtkTextIface,
 638  *    this is shortened to:
 639  *
 640  *    cpos = atk_text_get_caret_position (ATK_TEXT (accessible));
 641  */
 642
 643 #ifdef __cplusplus
 644 }
 645 #endif /* __cplusplus */
 646
 647
 648 #endif /* __ATK_OBJECT_H__ */