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