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
  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
 129  *
 130  * Describes the role of an object
 131  *
 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.
 135  **/
 136 typedef enum
 137 {
 138   ATK_ROLE_INVALID = 0,
 139   ATK_ROLE_ACCEL_LABEL,
 140   ATK_ROLE_ALERT,
 141   ATK_ROLE_ANIMATION,
 142   ATK_ROLE_ARROW,
 143   ATK_ROLE_CALENDAR,
 144   ATK_ROLE_CANVAS,
 145   ATK_ROLE_CHECK_BOX,
 146   ATK_ROLE_CHECK_MENU_ITEM,
 147   ATK_ROLE_COLOR_CHOOSER,
 148   ATK_ROLE_COLUMN_HEADER,
 149   ATK_ROLE_COMBO_BOX,
 150   ATK_ROLE_DATE_EDITOR,
 151   ATK_ROLE_DESKTOP_ICON,
 152   ATK_ROLE_DESKTOP_FRAME,
 153   ATK_ROLE_DIAL,
 154   ATK_ROLE_DIALOG,
 155   ATK_ROLE_DIRECTORY_PANE,
 156   ATK_ROLE_DRAWING_AREA,
 157   ATK_ROLE_FILE_CHOOSER,
 158   ATK_ROLE_FILLER,
 159   ATK_ROLE_FONT_CHOOSER,
 160   ATK_ROLE_FRAME,
 161   ATK_ROLE_GLASS_PANE,
 162   ATK_ROLE_HTML_CONTAINER,
 163   ATK_ROLE_ICON,
 164   ATK_ROLE_IMAGE,
 165   ATK_ROLE_INTERNAL_FRAME,
 166   ATK_ROLE_LABEL,
 167   ATK_ROLE_LAYERED_PANE,
 168   ATK_ROLE_LIST,
 169   ATK_ROLE_LIST_ITEM,
 170   ATK_ROLE_MENU,
 171   ATK_ROLE_MENU_BAR,
 172   ATK_ROLE_MENU_ITEM,
 173   ATK_ROLE_OPTION_PANE,
 174   ATK_ROLE_PAGE_TAB,
 175   ATK_ROLE_PAGE_TAB_LIST,
 176   ATK_ROLE_PANEL,
 177   ATK_ROLE_PASSWORD_TEXT,
 178   ATK_ROLE_POPUP_MENU,
 179   ATK_ROLE_PROGRESS_BAR,
 180   ATK_ROLE_PUSH_BUTTON,
 181   ATK_ROLE_RADIO_BUTTON,
 182   ATK_ROLE_RADIO_MENU_ITEM,
 183   ATK_ROLE_ROOT_PANE,
 184   ATK_ROLE_ROW_HEADER,
 185   ATK_ROLE_SCROLL_BAR,
 186   ATK_ROLE_SCROLL_PANE,
 187   ATK_ROLE_SEPARATOR,
 188   ATK_ROLE_SLIDER,
 189   ATK_ROLE_SPLIT_PANE,
 190   ATK_ROLE_SPIN_BUTTON,
 191   ATK_ROLE_STATUSBAR,
 192   ATK_ROLE_TABLE,
 193   ATK_ROLE_TABLE_CELL,
 194   ATK_ROLE_TABLE_COLUMN_HEADER,
 195   ATK_ROLE_TABLE_ROW_HEADER,
 196   ATK_ROLE_TEAR_OFF_MENU_ITEM,
 197   ATK_ROLE_TERMINAL,
 198   ATK_ROLE_TEXT,
 199   ATK_ROLE_TOGGLE_BUTTON,
 200   ATK_ROLE_TOOL_BAR,
 201   ATK_ROLE_TOOL_TIP,
 202   ATK_ROLE_TREE,
 203   ATK_ROLE_TREE_TABLE,
 204   ATK_ROLE_UNKNOWN,
 205   ATK_ROLE_VIEWPORT,
 206   ATK_ROLE_WINDOW,
 207   ATK_ROLE_HEADER,
 208   ATK_ROLE_FOOTER,
 209   ATK_ROLE_PARAGRAPH,
 210   ATK_ROLE_RULER,
 211   ATK_ROLE_APPLICATION,
 212   ATK_ROLE_AUTOCOMPLETE,
 213   ATK_ROLE_EDITBAR,
 214   ATK_ROLE_EMBEDDED,
 215   ATK_ROLE_ENTRY,
 216   ATK_ROLE_CHART,
 217   ATK_ROLE_CAPTION,
 218   ATK_ROLE_DOCUMENT_FRAME,
 219   ATK_ROLE_HEADING,
 220   ATK_ROLE_PAGE,
 221   ATK_ROLE_SECTION,
 222   ATK_ROLE_REDUNDANT_OBJECT,
 223   ATK_ROLE_LAST_DEFINED
 224 } AtkRole;
 225
 226 AtkRole                  atk_role_register        (const gchar *name);
 227
 228 /**
 229  *AtkLayer:
 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.
 238  *
 239  * Describes the layer of a component
 240  *
 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.
 244  **/
 245 typedef enum
 246 {
 247   ATK_LAYER_INVALID,
 248   ATK_LAYER_BACKGROUND,
 249   ATK_LAYER_CANVAS,
 250   ATK_LAYER_WIDGET,
 251   ATK_LAYER_MDI,
 252   ATK_LAYER_POPUP,
 253   ATK_LAYER_OVERLAY,
 254   ATK_LAYER_WINDOW
 255 } AtkLayer;
 256
 257 /**
 258  * AtkAttributeSet:
 259  *
 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()
 263  **/
 264 typedef GSList AtkAttributeSet;
 265
 266 /**
 267  * AtkAttribute:
 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
 272  * is in value.
 273  *
 274  * A string name/value pair representing a text attribute.
 275  **/
 276 typedef struct _AtkAttribute AtkAttribute;
 277
 278 struct _AtkAttribute {
 279   gchar* name;
 280   gchar* value;
 281 };
 282
 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))
 289
 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))
 294
 295
 296 typedef struct _AtkImplementor            AtkImplementor; /* dummy typedef */
 297 typedef struct _AtkImplementorIface       AtkImplementorIface;
 298
 299
 300 typedef struct _AtkObject                 AtkObject;
 301 typedef struct _AtkObjectClass            AtkObjectClass;
 302 typedef struct _AtkRelationSet            AtkRelationSet;
 303 typedef struct _AtkStateSet               AtkStateSet;
 304
 305 /**
 306  * AtkPropertyValues:
 307  * @property_name: The name of the ATK property which is being presented or which has been changed.
 308  * @old_value: The old property value, NULL; in some contexts this value is undefined (see note below).
 309  * @new_value: The new value of the named property.
 310  *
 311  * @note: For most properties the old_value field of AtkPropertyValues will
 312  * not contain a valid value.
 313  *
 314  * Currently, the only property for which old_value is used is
 315  * accessible-state; for instance if there is a focus state the
 316  * property change handler will be called for the object which lost the focus
 317  * with the old_value containing an AtkState value corresponding to focused
 318  * and the property change handler will be called for the object which
 319  * received the focus with the new_value containing an AtkState value
 320  * corresponding to focused.
 321  *
 322  **/
 323 struct _AtkPropertyValues
 324 {
 325   const gchar  *property_name;
 326   GValue old_value;
 327   GValue new_value;
 328 };
 329
 330 typedef struct _AtkPropertyValues        AtkPropertyValues;
 331
 332 typedef gboolean (*AtkFunction)          (gpointer data);
 333 /*
 334  * For most properties the old_value field of AtkPropertyValues will
 335  * not contain a valid value.
 336  *
 337  * Currently, the only property for which old_value is used is
 338  * accessible-state; for instance if there is a focus state the
 339  * property change handler will be called for the object which lost the focus
 340  * with the old_value containing an AtkState value corresponding to focused
 341  * and the property change handler will be called for the object which
 342  * received the focus with the new_value containing an AtkState value
 343  * corresponding to focused.
 344  */
 345 typedef void (*AtkPropertyChangeHandler) (AtkObject*, AtkPropertyValues*);
 346
 347
 348 struct _AtkObject
 349 {
 350   GObject parent;
 351
 352   gchar *description;
 353   gchar *name;
 354   AtkObject *accessible_parent;
 355   AtkRole role;
 356   AtkRelationSet *relation_set;
 357   AtkLayer layer;
 358 };
 359
 360 struct _AtkObjectClass
 361 {
 362   GObjectClass parent;
 363
 364   /*
 365    * Gets the accessible name of the object
 366    */
 367   G_CONST_RETURN gchar*    (* get_name)            (AtkObject                *accessible);
 368   /*
 369    * Gets the accessible description of the object
 370    */
 371   G_CONST_RETURN gchar*    (* get_description)     (AtkObject                *accessible);
 372   /*
 373    * Gets the accessible parent of the object
 374    */
 375   AtkObject*               (*get_parent)           (AtkObject                *accessible);
 376
 377   /*
 378    * Gets the number of accessible children of the object
 379    */
 380   gint                    (* get_n_children)       (AtkObject                *accessible);
 381   /*
 382    * Returns a reference to the specified accessible child of the object.
 383    * The accessible children are 0-based so the first accessible child is
 384    * at index 0, the second at index 1 and so on.
 385    */
 386   AtkObject*              (* ref_child)            (AtkObject                *accessible,
 387                                                     gint                      i);
 388   /*
 389    * Gets the 0-based index of this object in its parent; returns -1 if the
 390    * object does not have an accessible parent.
 391    */
 392   gint                    (* get_index_in_parent) (AtkObject                 *accessible);
 393   /*
 394    * Gets the RelationSet associated with the object
 395    */
 396   AtkRelationSet*         (* ref_relation_set)    (AtkObject                 *accessible);
 397   /*
 398    * Gets the role of the object
 399    */
 400   AtkRole                 (* get_role)            (AtkObject                 *accessible);
 401   AtkLayer                (* get_layer)           (AtkObject                 *accessible);
 402   gint                    (* get_mdi_zorder)      (AtkObject                 *accessible);
 403   /*
 404    * Gets the state set of the object
 405    */
 406   AtkStateSet*            (* ref_state_set)       (AtkObject                 *accessible);
 407   /*
 408    * Sets the accessible name of the object
 409    */
 410   void                    (* set_name)            (AtkObject                 *accessible,
 411                                                    const gchar               *name);
 412   /*
 413    * Sets the accessible description of the object
 414    */
 415   void                    (* set_description)     (AtkObject                 *accessible,
 416                                                    const gchar               *description);
 417   /*
 418    * Sets the accessible parent of the object
 419    */
 420   void                    (* set_parent)          (AtkObject                 *accessible,
 421                                                    AtkObject                 *parent);
 422   /*
 423    * Sets the accessible role of the object
 424    */
 425   void                    (* set_role)            (AtkObject                 *accessible,
 426                                                    AtkRole                   role);
 427   /*
 428    * Specifies a function to be called when a property changes value
 429    */
 430 guint                     (* connect_property_change_handler)    (AtkObject
 431                  *accessible,
 432                                                                   AtkPropertyChangeHandler       *handler);
 433   /*
 434    * Removes a property change handler which was specified using
 435    * connect_property_change_handler
 436    */
 437 void                      (* remove_property_change_handler)     (AtkObject
 438                 *accessible,
 439                                                                   guint
 440                 handler_id);
 441 void                      (* initialize)                         (AtkObject                     *accessible,
 442                                                                   gpointer                      data);
 443   /*
 444    * The signal handler which is executed when there is a change in the
 445    * children of the object
 446    */
 447   void                    (* children_changed)    (AtkObject                  *accessible,
 448                                                    guint                      change_index,
 449                                                    gpointer                   changed_child);
 450   /*
 451    * The signal handler which is executed  when there is a focus event
 452    * for an object.
 453    */
 454   void                    (* focus_event)         (AtkObject                  *accessible,
 455                                                    gboolean                   focus_in);
 456   /*
 457    * The signal handler which is executed  when there is a property_change
 458    * signal for an object.
 459    */
 460   void                    (* property_change)     (AtkObject                  *accessible,
 461                                                    AtkPropertyValues          *values);
 462   /*
 463    * The signal handler which is executed  when there is a state_change
 464    * signal for an object.
 465    */
 466   void                    (* state_change)        (AtkObject                  *accessible,
 467                                                    const gchar                *name,
 468                                                    gboolean                   state_set);
 469   /*
 470    * The signal handler which is executed when there is a change in the
 471    * visible data for an object
 472    */
 473   void                    (*visible_data_changed) (AtkObject                  *accessible);
 474
 475   /*
 476    * The signal handler which is executed when there is a change in the
 477    * 'active' child or children of the object, for instance when
 478    * interior focus changes in a table or list.  This signal should be emitted
 479    * by objects whose state includes ATK_STATE_MANAGES_DESCENDANTS.
 480    */
 481   void                    (*active_descendant_changed) (AtkObject                  *accessible,
 482                                                         gpointer                   *child);
 483
 484   /*
 485    * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs.
 486    * @since ATK 1.12
 487    */
 488   AtkAttributeSet*        (*get_attributes)            (AtkObject                  *accessible);
 489   AtkFunction             pad1;
 490   AtkFunction             pad2;
 491 };
 492
 493 GType            atk_object_get_type   (void);
 494
 495 struct _AtkImplementorIface
 496 {
 497   GTypeInterface parent;
 498
 499   AtkObject*   (*ref_accessible) (AtkImplementor *implementor);
 500 };
 501 GType atk_implementor_get_type (void);
 502
 503 /*
 504  * This method uses the ref_accessible method in AtkImplementorIface,
 505  * if the object's class implements AtkImplementorIface.
 506  * Otherwise it returns %NULL.
 507  *
 508  * IMPORTANT:
 509  * Note also that because this method may return flyweight objects,
 510  * it increments the returned AtkObject's reference count.
 511  * Therefore it is the responsibility of the calling
 512  * program to unreference the object when no longer needed.
 513  * (c.f. gtk_widget_get_accessible() where this is not the case).
 514  */
 515 AtkObject*              atk_implementor_ref_accessible            (AtkImplementor *implementor);
 516
 517 /*
 518  * Properties directly supported by AtkObject
 519  */
 520
 521 G_CONST_RETURN gchar*   atk_object_get_name                       (AtkObject *accessible);
 522 G_CONST_RETURN gchar*   atk_object_get_description                (AtkObject *accessible);
 523 AtkObject*              atk_object_get_parent                     (AtkObject *accessible);
 524 gint                    atk_object_get_n_accessible_children      (AtkObject *accessible);
 525 AtkObject*              atk_object_ref_accessible_child           (AtkObject *accessible,
 526                                                                    gint        i);
 527 AtkRelationSet*         atk_object_ref_relation_set               (AtkObject *accessible);
 528 AtkRole                 atk_object_get_role                       (AtkObject *accessible);
 529 AtkLayer                atk_object_get_layer                      (AtkObject *accessible);
 530 gint                    atk_object_get_mdi_zorder                 (AtkObject *accessible);
 531 AtkAttributeSet*        atk_object_get_attributes                 (AtkObject *accessible);
 532 AtkStateSet*            atk_object_ref_state_set                  (AtkObject *accessible);
 533 gint                    atk_object_get_index_in_parent            (AtkObject *accessible);
 534 void                    atk_object_set_name                       (AtkObject *accessible,
 535                                                                    const gchar *name);
 536 void                    atk_object_set_description                (AtkObject *accessible,
 537                                                                    const gchar *description);
 538 void                    atk_object_set_parent                     (AtkObject *accessible,
 539                                                                    AtkObject *parent);
 540 void                    atk_object_set_role                       (AtkObject *accessible,
 541                                                                    AtkRole   role);
 542
 543
 544 guint                atk_object_connect_property_change_handler  (AtkObject                      *accessible,
 545                                                                   AtkPropertyChangeHandler       *handler);
 546 void                 atk_object_remove_property_change_handler   (AtkObject                      *accessible,
 547                                                                   guint                          handler_id);
 548
 549 void                 atk_object_notify_state_change              (AtkObject                      *accessible,
 550                                                                   AtkState                       state,
 551                                                                   gboolean                       value);
 552 void                 atk_object_initialize                       (AtkObject                     *accessible,
 553                                                                   gpointer                      data);
 554
 555 G_CONST_RETURN gchar* atk_role_get_name      (AtkRole         role);
 556 AtkRole               atk_role_for_name      (const gchar     *name);
 557
 558
 559 /* NEW in 1.1: convenience API */
 560 gboolean              atk_object_add_relationship              (AtkObject      *object,
 561                                                                 AtkRelationType relationship,
 562                                                                 AtkObject      *target);
 563 gboolean              atk_object_remove_relationship           (AtkObject      *object,
 564                                                                 AtkRelationType relationship,
 565                                                                 AtkObject      *target);
 566 G_CONST_RETURN gchar* atk_role_get_localized_name              (AtkRole     role);
 567
 568 /* */
 569
 570
 571 /*
 572  * Note: the properties which are registered with the GType
 573  *   property registry, for type ATK_TYPE_OBJECT, are as follows:
 574  *
 575  *   "accessible-name"
 576  *   "accessible-description"
 577  *   "accessible-parent"
 578  *   "accessible-role"
 579  *   "accessible-value"
 580  *   "accessible-component-layer"
 581  *   "accessible-component-zorder"
 582  *   "accessible-table-caption"
 583  *   "accessible-table-column-description"
 584  *   "accessible-table-column-header"
 585  *   "accessible-table-row-description"
 586  *   "accessible-table-row-header"
 587  *   "accessible-table-summary"
 588  *   "accessible-model"
 589  *
 590  * accessibility property change listeners should use the
 591  *   normal GObject property interfaces and "property-change"
 592  *   signal handler semantics to interpret the property change
 593  *   information relayed from AtkObject.
 594  *   (AtkObject instances will connect to the "notify"
 595  *   signal in their host objects, and relay the signals when appropriate).
 596  */
 597
 598 /* For other signals, see related interfaces
 599  *
 600  *    AtkActionIface,
 601  *    AtkComponentIface,
 602  *    AtkHypertextIface,
 603  *    AtkImageIface,
 604  *    AtkSelectionIface,
 605  *    AtkTableIface,
 606  *    AtkTextIface,
 607  *    AtkValueIface.
 608  *
 609  *  The usage model for obtaining these interface instances is:
 610  *    ATK_<interfacename>_GET_IFACE(GObject *accessible),
 611  *    where accessible, though specified as a GObject, is
 612  *    the AtkObject instance being queried.
 613  *  More usually, the interface will be used via a cast to the
 614  *    interface's corresponding "type":
 615  *
 616  *    AtkText textImpl = ATK_TEXT(accessible);
 617  *    if (textImpl)
 618  *      {
 619  *        cpos = atk_text_get_caret_position(textImpl);
 620  *      }
 621  *
 622  *  If it's known in advance that accessible implements AtkTextIface,
 623  *    this is shortened to:
 624  *
 625  *    cpos = atk_text_get_caret_position (ATK_TEXT (accessible));
 626  */
 627
 628 #ifdef __cplusplus
 629 }
 630 #endif /* __cplusplus */
 631
 632
 633 #endif /* __ATK_OBJECT_H__ */