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_LAST_DEFINED: not a valid role, used for finding end of enumeration
 117  *
 118  *Describes the role of an object
 119  **/
 120 typedef enum
 121 {
 122   ATK_ROLE_INVALID = 0,
 123   ATK_ROLE_ACCEL_LABEL,
 124   ATK_ROLE_ALERT,
 125   ATK_ROLE_ANIMATION,
 126   ATK_ROLE_ARROW,
 127   ATK_ROLE_CALENDAR,
 128   ATK_ROLE_CANVAS,
 129   ATK_ROLE_CHECK_BOX,
 130   ATK_ROLE_CHECK_MENU_ITEM,
 131   ATK_ROLE_COLOR_CHOOSER,
 132   ATK_ROLE_COLUMN_HEADER,
 133   ATK_ROLE_COMBO_BOX,
 134   ATK_ROLE_DATE_EDITOR,
 135   ATK_ROLE_DESKTOP_ICON,
 136   ATK_ROLE_DESKTOP_FRAME,
 137   ATK_ROLE_DIAL,
 138   ATK_ROLE_DIALOG,
 139   ATK_ROLE_DIRECTORY_PANE,
 140   ATK_ROLE_DRAWING_AREA,
 141   ATK_ROLE_FILE_CHOOSER,
 142   ATK_ROLE_FILLER,
 143   ATK_ROLE_FONT_CHOOSER,
 144   ATK_ROLE_FRAME,
 145   ATK_ROLE_GLASS_PANE,
 146   ATK_ROLE_HTML_CONTAINER,
 147   ATK_ROLE_ICON,
 148   ATK_ROLE_IMAGE,
 149   ATK_ROLE_INTERNAL_FRAME,
 150   ATK_ROLE_LABEL,
 151   ATK_ROLE_LAYERED_PANE,
 152   ATK_ROLE_LIST,
 153   ATK_ROLE_LIST_ITEM,
 154   ATK_ROLE_MENU,
 155   ATK_ROLE_MENU_BAR,
 156   ATK_ROLE_MENU_ITEM,
 157   ATK_ROLE_OPTION_PANE,
 158   ATK_ROLE_PAGE_TAB,
 159   ATK_ROLE_PAGE_TAB_LIST,
 160   ATK_ROLE_PANEL,
 161   ATK_ROLE_PASSWORD_TEXT,
 162   ATK_ROLE_POPUP_MENU,
 163   ATK_ROLE_PROGRESS_BAR,
 164   ATK_ROLE_PUSH_BUTTON,
 165   ATK_ROLE_RADIO_BUTTON,
 166   ATK_ROLE_RADIO_MENU_ITEM,
 167   ATK_ROLE_ROOT_PANE,
 168   ATK_ROLE_ROW_HEADER,
 169   ATK_ROLE_SCROLL_BAR,
 170   ATK_ROLE_SCROLL_PANE,
 171   ATK_ROLE_SEPARATOR,
 172   ATK_ROLE_SLIDER,
 173   ATK_ROLE_SPLIT_PANE,
 174   ATK_ROLE_SPIN_BUTTON,
 175   ATK_ROLE_STATUSBAR,
 176   ATK_ROLE_TABLE,
 177   ATK_ROLE_TABLE_CELL,
 178   ATK_ROLE_TABLE_COLUMN_HEADER,
 179   ATK_ROLE_TABLE_ROW_HEADER,
 180   ATK_ROLE_TEAR_OFF_MENU_ITEM,
 181   ATK_ROLE_TERMINAL,
 182   ATK_ROLE_TEXT,
 183   ATK_ROLE_TOGGLE_BUTTON,
 184   ATK_ROLE_TOOL_BAR,
 185   ATK_ROLE_TOOL_TIP,
 186   ATK_ROLE_TREE,
 187   ATK_ROLE_TREE_TABLE,
 188   ATK_ROLE_UNKNOWN,
 189   ATK_ROLE_VIEWPORT,
 190   ATK_ROLE_WINDOW,
 191   ATK_ROLE_HEADER,
 192   ATK_ROLE_FOOTER,
 193   ATK_ROLE_PARAGRAPH,
 194   ATK_ROLE_RULER,
 195   ATK_ROLE_LAST_DEFINED
 196 } AtkRole;
 197
 198 AtkRole                  atk_role_register        (const gchar *name);
 199
 200 /**
 201  *AtkLayer:
 202  *@ATK_LAYER_INVALID: The object does not have a layer
 203  *@ATK_LAYER_BACKGROUND: This layer is reserved for the desktop background
 204  *@ATK_LAYER_CANVAS: This layer is used for Canvas components
 205  *@ATK_LAYER_WIDGET: This layer is normally used for components
 206  *@ATK_LAYER_MDI: This layer is used for layered components
 207  *@ATK_LAYER_POPUP: This layer is used for popup components, such as menus
 208  *@ATK_LAYER_OVERLAY: This layer is reserved for future use.
 209  *@ATK_LAYER_WINDOW: This layer is used for toplevel windows.
 210  *
 211  * Describes the layer of a component
 212  **/
 213 typedef enum
 214 {
 215   ATK_LAYER_INVALID,
 216   ATK_LAYER_BACKGROUND,
 217   ATK_LAYER_CANVAS,
 218   ATK_LAYER_WIDGET,
 219   ATK_LAYER_MDI,
 220   ATK_LAYER_POPUP,
 221   ATK_LAYER_OVERLAY,
 222   ATK_LAYER_WINDOW
 223 } AtkLayer;
 224
 225 #define ATK_TYPE_OBJECT                           (atk_object_get_type ())
 226 #define ATK_OBJECT(obj)                           (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
 227 #define ATK_OBJECT_CLASS(klass)                   (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
 228 #define ATK_IS_OBJECT(obj)                        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
 229 #define ATK_IS_OBJECT_CLASS(klass)                (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
 230 #define ATK_OBJECT_GET_CLASS(obj)                 (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
 231
 232 #define ATK_TYPE_IMPLEMENTOR                      (atk_implementor_get_type ())
 233 #define ATK_IS_IMPLEMENTOR(obj)                   G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
 234 #define ATK_IMPLEMENTOR(obj)                      G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
 235 #define ATK_IMPLEMENTOR_GET_IFACE(obj)            (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
 236
 237
 238 typedef struct _AtkImplementor            AtkImplementor; /* dummy typedef */
 239 typedef struct _AtkImplementorIface       AtkImplementorIface;
 240
 241
 242 typedef struct _AtkObject                 AtkObject;
 243 typedef struct _AtkObjectClass            AtkObjectClass;
 244 typedef struct _AtkRelationSet            AtkRelationSet;
 245 typedef struct _AtkStateSet               AtkStateSet;
 246
 247 struct _AtkPropertyValues
 248 {
 249   const gchar  *property_name;
 250   GValue old_value;
 251   GValue new_value;
 252 };
 253
 254 typedef struct _AtkPropertyValues        AtkPropertyValues;
 255
 256 typedef gboolean (*AtkFunction)          (gpointer data);
 257 /*
 258  * For most properties the old_value field of AtkPropertyValues will
 259  * not contain a valid value.
 260  *
 261  * Currently, the only property for which old_value is used is
 262  * accessible-state; for instance if there is a focus state the
 263  * property change handler will be called for the object which lost the focus
 264  * with the old_value containing an AtkState value corresponding to focused
 265  * and the property change handler will be called for the object which
 266  * received the focus with the new_value containing an AtkState value
 267  * corresponding to focused.
 268  */
 269 typedef void (*AtkPropertyChangeHandler) (AtkObject*, AtkPropertyValues*);
 270
 271
 272 struct _AtkObject
 273 {
 274   GObject parent;
 275
 276   gchar *description;
 277   gchar *name;
 278   AtkObject *accessible_parent;
 279   AtkRole role;
 280   AtkRelationSet *relation_set;
 281   AtkLayer layer;
 282 };
 283
 284 struct _AtkObjectClass
 285 {
 286   GObjectClass parent;
 287
 288   /*
 289    * Gets the accessible name of the object
 290    */
 291   G_CONST_RETURN gchar*    (* get_name)            (AtkObject                *accessible);
 292   /*
 293    * Gets the accessible description of the object
 294    */
 295   G_CONST_RETURN gchar*    (* get_description)     (AtkObject                *accessible);
 296   /*
 297    * Gets the accessible parent of the object
 298    */
 299   AtkObject*               (*get_parent)           (AtkObject                *accessible);
 300
 301   /*
 302    * Gets the number of accessible children of the object
 303    */
 304   gint                    (* get_n_children)       (AtkObject                *accessible);
 305   /*
 306    * Returns a reference to the specified accessible child of the object.
 307    * The accessible children are 0-based so the first accessible child is
 308    * at index 0, the second at index 1 and so on.
 309    */
 310   AtkObject*              (* ref_child)            (AtkObject                *accessible,
 311                                                     gint                      i);
 312   /*
 313    * Gets the 0-based index of this object in its parent; returns -1 if the
 314    * object does not have an accessible parent.
 315    */
 316   gint                    (* get_index_in_parent) (AtkObject                 *accessible);
 317   /*
 318    * Gets the RelationSet associated with the object
 319    */
 320   AtkRelationSet*         (* ref_relation_set)    (AtkObject                 *accessible);
 321   /*
 322    * Gets the role of the object
 323    */
 324   AtkRole                 (* get_role)            (AtkObject                 *accessible);
 325   AtkLayer                (* get_layer)           (AtkObject                 *accessible);
 326   gint                    (* get_mdi_zorder)      (AtkObject                 *accessible);
 327   /*
 328    * Gets the state set of the object
 329    */
 330   AtkStateSet*            (* ref_state_set)       (AtkObject                 *accessible);
 331   /*
 332    * Sets the accessible name of the object
 333    */
 334   void                    (* set_name)            (AtkObject                 *accessible,
 335                                                    const gchar               *name);
 336   /*
 337    * Sets the accessible description of the object
 338    */
 339   void                    (* set_description)     (AtkObject                 *accessible,
 340                                                    const gchar               *description);
 341   /*
 342    * Sets the accessible parent of the object
 343    */
 344   void                    (* set_parent)          (AtkObject                 *accessible,
 345                                                    AtkObject                 *parent);
 346   /*
 347    * Sets the accessible role of the object
 348    */
 349   void                    (* set_role)            (AtkObject                 *accessible,
 350                                                    AtkRole                   role);
 351   /*
 352    * Specifies a function to be called when a property changes value
 353    */
 354 guint                     (* connect_property_change_handler)    (AtkObject
 355                  *accessible,
 356                                                                   AtkPropertyChangeHandler       *handler);
 357   /*
 358    * Removes a property change handler which was specified using
 359    * connect_property_change_handler
 360    */
 361 void                      (* remove_property_change_handler)     (AtkObject
 362                 *accessible,
 363                                                                   guint
 364                 handler_id);
 365 void                      (* initialize)                         (AtkObject                     *accessible,
 366                                                                   gpointer                      data);
 367   /*
 368    * The signal handler which is executed when there is a change in the
 369    * children of the object
 370    */
 371   void                    (* children_changed)    (AtkObject                  *accessible,
 372                                                    guint                      change_index,
 373                                                    gpointer                   changed_child);
 374   /*
 375    * The signal handler which is executed  when there is a focus event
 376    * for an object.
 377    */
 378   void                    (* focus_event)         (AtkObject                  *accessible,
 379                                                    gboolean                   focus_in);
 380   /*
 381    * The signal handler which is executed  when there is a property_change
 382    * signal for an object.
 383    */
 384   void                    (* property_change)     (AtkObject                  *accessible,
 385                                                    AtkPropertyValues          *values);
 386   /*
 387    * The signal handler which is executed  when there is a state_change
 388    * signal for an object.
 389    */
 390   void                    (* state_change)        (AtkObject                  *accessible,
 391                                                    const gchar                *name,
 392                                                    gboolean                   state_set);
 393   /*
 394    * The signal handler which is executed when there is a change in the
 395    * visible data for an object
 396    */
 397   void                    (*visible_data_changed) (AtkObject                  *accessible);
 398
 399   AtkFunction             pad1;
 400   AtkFunction             pad2;
 401   AtkFunction             pad3;
 402   AtkFunction             pad4;
 403 };
 404
 405 GType            atk_object_get_type   (void);
 406
 407 struct _AtkImplementorIface
 408 {
 409   GTypeInterface parent;
 410
 411   AtkObject*   (*ref_accessible) (AtkImplementor *implementor);
 412 };
 413 GType atk_implementor_get_type (void);
 414
 415 /*
 416  * This method uses the ref_accessible method in AtkImplementorIface,
 417  * if the object's class implements AtkImplementorIface.
 418  * Otherwise it returns %NULL.
 419  *
 420  * IMPORTANT:
 421  * Note also that because this method may return flyweight objects,
 422  * it increments the returned AtkObject's reference count.
 423  * Therefore it is the responsibility of the calling
 424  * program to unreference the object when no longer needed.
 425  * (c.f. gtk_widget_get_accessible() where this is not the case).
 426  */
 427 AtkObject*              atk_implementor_ref_accessible            (AtkImplementor *implementor);
 428
 429 /*
 430  * Properties directly supported by AtkObject
 431  */
 432
 433 G_CONST_RETURN gchar*   atk_object_get_name                       (AtkObject *accessible);
 434 G_CONST_RETURN gchar*   atk_object_get_description                (AtkObject *accessible);
 435 AtkObject*              atk_object_get_parent                     (AtkObject *accessible);
 436 gint                    atk_object_get_n_accessible_children      (AtkObject *accessible);
 437 AtkObject*              atk_object_ref_accessible_child           (AtkObject *accessible,
 438                                                                    gint        i);
 439 AtkRelationSet*         atk_object_ref_relation_set               (AtkObject *accessible);
 440 AtkRole                 atk_object_get_role                       (AtkObject *accessible);
 441 AtkLayer                atk_object_get_layer                      (AtkObject *accessible);
 442 gint                    atk_object_get_mdi_zorder                 (AtkObject *accessible);
 443 AtkStateSet*            atk_object_ref_state_set                  (AtkObject *accessible);
 444 gint                    atk_object_get_index_in_parent            (AtkObject *accessible);
 445 void                    atk_object_set_name                       (AtkObject *accessible,
 446                                                                    const gchar *name);
 447 void                    atk_object_set_description                (AtkObject *accessible,
 448                                                                    const gchar *description);
 449 void                    atk_object_set_parent                     (AtkObject *accessible,
 450                                                                    AtkObject *parent);
 451 void                    atk_object_set_role                       (AtkObject *accessible,
 452                                                                    AtkRole   role);
 453
 454
 455 guint                atk_object_connect_property_change_handler  (AtkObject                      *accessible,
 456                                                                   AtkPropertyChangeHandler       *handler);
 457 void                 atk_object_remove_property_change_handler   (AtkObject                      *accessible,
 458                                                                   guint                          handler_id);
 459
 460 void                 atk_object_notify_state_change              (AtkObject                      *accessible,
 461                                                                   AtkState                       state,
 462                                                                   gboolean                       value);
 463 void                 atk_object_initialize                       (AtkObject                     *accessible,
 464                                                                   gpointer                      data);
 465
 466 G_CONST_RETURN gchar* atk_role_get_name      (AtkRole         role);
 467 AtkRole               atk_role_for_name      (const gchar     *name);
 468
 469
 470 /* NEW in 1.1: convenience API */
 471 gboolean              atk_object_add_relationship              (AtkObject      *object,
 472                                                                 AtkRelationType relationship,
 473                                                                 AtkObject      *target);
 474 gboolean              atk_object_remove_relationship           (AtkObject      *object,
 475                                                                 AtkRelationType relationship,
 476                                                                 AtkObject      *target);
 477 G_CONST_RETURN gchar* atk_role_get_localized_name              (AtkRole     role);
 478
 479
 480 /*
 481  * Note: the properties which are registered with the GType
 482  *   property registry, for type ATK_TYPE_OBJECT, are as follows:
 483  *
 484  *   "accessible-name"
 485  *   "accessible-description"
 486  *   "accessible-parent"
 487  *   "accessible-role"
 488  *   "accessible-value"
 489  *   "accessible-component-layer"
 490  *   "accessible-component-zorder"
 491  *   "accessible-table-caption"
 492  *   "accessible-table-column-description"
 493  *   "accessible-table-column-header"
 494  *   "accessible-table-row-description"
 495  *   "accessible-table-row-header"
 496  *   "accessible-table-summary"
 497  *   "accessible-model"
 498  *
 499  * accessibility property change listeners should use the
 500  *   normal GObject property interfaces and "property-change"
 501  *   signal handler semantics to interpret the property change
 502  *   information relayed from AtkObject.
 503  *   (AtkObject instances will connect to the "notify"
 504  *   signal in their host objects, and relay the signals when appropriate).
 505  */
 506
 507 /* For other signals, see related interfaces
 508  *
 509  *    AtkActionIface,
 510  *    AtkComponentIface,
 511  *    AtkHypertextIface,
 512  *    AtkImageIface,
 513  *    AtkSelectionIface,
 514  *    AtkTableIface,
 515  *    AtkTextIface,
 516  *    AtkValueIface.
 517  *
 518  *  The usage model for obtaining these interface instances is:
 519  *    ATK_<interfacename>_GET_IFACE(GObject *accessible),
 520  *    where accessible, though specified as a GObject, is
 521  *    the AtkObject instance being queried.
 522  *  More usually, the interface will be used via a cast to the
 523  *    interface's corresponding "type":
 524  *
 525  *    AtkText textImpl = ATK_TEXT(accessible);
 526  *    if (textImpl)
 527  *      {
 528  *        cpos = atk_text_get_caret_position(textImpl);
 529  *      }
 530  *
 531  *  If it's known in advance that accessible implements AtkTextIface,
 532  *    this is shortened to:
 533  *
 534  *    cpos = atk_text_get_caret_position (ATK_TEXT (accessible));
 535  */
 536
 537 #ifdef __cplusplus
 538 }
 539 #endif /* __cplusplus */
 540
 541
 542 #endif /* __ATK_OBJECT_H__ */