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
  29 /*
  30  * AtkObject represents the minimum information all accessible objects
  31  * return. This information includes accessible name, accessible
  32  * description, role and state of the object, as well information about
  33  * its parent and children. It is also possible to obtain more specific
  34  * accessibility information about a component if it supports one or more
  35  * of the following interfaces:
  36  */
  37
  38 /**
  39  *AtkRole:
  40  *@ATK_ROLE_INVALID: Invalid role
  41  *@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
  42  *@ATK_ROLE_ALERT: An object which is an alert to the user
  43  *@ATK_ROLE_ANIMATION: An object which is an animated image
  44  *@ATK_ROLE_ARROW: An arrow in one of the four cardinal directions
  45  *@ATK_ROLE_CALENDAR:  An object that displays a calendar and allows the user to select a date
  46  *@ATK_ROLE_CANVAS: An object that can be drawn into and is used to trap events
  47  *@ATK_ROLE_CHECK_BOX: A choice that can be checked or unchecked and provides a separate indicator for the current state
  48  *@ATK_ROLE_CHECK_MENU_ITEM: A menu item with a check box
  49  *@ATK_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color
  50  *@ATK_ROLE_COLUMN_HEADER: The header for a column of data
  51  *@ATK_ROLE_COMBO_BOX: A list of choices the user can select from
  52  *@ATK_ROLE_DATE_EDITOR: An object whose purpose is to allow a user to edit a date
  53  *@ATK_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
  54  *@ATK_ROLE_DESKTOP_FRAME: A pane that supports internal frames and iconified versions of those internal frames
  55  *@ATK_ROLE_DIAL: An object whose purpose is to allow a user to set a value
  56  *@ATK_ROLE_DIALOG: A top level window with title bar and a border
  57  *@ATK_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through and select the contents of a directory
  58  *@ATK_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
  59  *@ATK_ROLE_FILE_CHOOSER: A specialized dialog that lets the user choose a file
  60  *@ATK_ROLE_FILLER: A object that fills up space in a user interface
  61  *@ATK_ROLE_FONT_CHOOSER: A specialized dialog that lets the user choose a font
  62  *@ATK_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
  63  *@ATK_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all panes beneath it
  64  *@ATK_ROLE_HTML_CONTAINER: A document container for HTML, whose children represent the document content
  65  *@ATK_ROLE_ICON: A small fixed size picture, typically used to decorate components
  66  *@ATK_ROLE_IMAGE: An object whose primary purpose is to display an image
  67  *@ATK_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane
  68  *@ATK_ROLE_LABEL: An object used to present an icon or short string in an interface
  69  *@ATK_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
  70  *@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
  71  *@ATK_ROLE_LIST_ITEM: An object that represents an element of a list
  72  *@ATK_ROLE_MENU: An object usually found inside a menu bar that contains a list of actions the user can choose from
  73  *@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
  74  *@ATK_ROLE_MENU_ITEM: An object usually contained in a menu that presents an action the user can choose
  75  *@ATK_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
  76  *@ATK_ROLE_PAGE_TAB: An object that is a child of a page tab list
  77  *@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
  78  *@ATK_ROLE_PANEL: A generic container that is often used to group objects
  79  *@ATK_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where the text content is not shown visibly to the user
  80  *@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
  81  *@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
  82  *@ATK_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the application to do something
  83  *@ATK_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the same group to become uncghecked when this one is checked
  84  *@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
  85  *@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
  86  *@ATK_ROLE_ROW_HEADER: The header for a row of data
  87  *@ATK_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally view a large amount of data.
  88  *@ATK_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount of information
  89  *@ATK_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
  90  *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
  91  *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
  92  *@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
  93  *@ATK_ROLE_STATUS_BAR: An object which reports messages of minor importance to the user
  94  *@ATK_ROLE_TABLE: An object used to rpesent information in terms of rows and columns
  95  *@ATK_ROLE_TABLE_CELL: A cell in a table
  96  *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
  97  *@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
  98  *@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu
  99  *@ATK_ROLE_TEXT: An object that presents text to the user
 100  *@ATK_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or unchecked, but does not procide a separate indicator for the current state
 101  *@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
 102  *@ATK_ROLE_TOOL_TIP: An object that provides information about another object
 103  *@ATK_ROLE_TREE: An object used to repsent hierarchical information to the user
 104  *@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
 105  *@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane
 106  *@ATK_ROLE_WINDOW: A top level window with no title or border
 107  *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of enumeration
 108  *
 109  *Describes the role of an object
 110  **/
 111 typedef enum
 112 {
 113   ATK_ROLE_INVALID,
 114   ATK_ROLE_ACCEL_LABEL,
 115   ATK_ROLE_ALERT,
 116   ATK_ROLE_ANIMATION,
 117   ATK_ROLE_ARROW,
 118   ATK_ROLE_CALENDAR,
 119   ATK_ROLE_CANVAS,
 120   ATK_ROLE_CHECK_BOX,
 121   ATK_ROLE_CHECK_MENU_ITEM,
 122   ATK_ROLE_COLOR_CHOOSER,
 123   ATK_ROLE_COLUMN_HEADER,
 124   ATK_ROLE_COMBO_BOX,
 125   ATK_ROLE_DATE_EDITOR,
 126   ATK_ROLE_DESKTOP_ICON,
 127   ATK_ROLE_DESKTOP_FRAME,
 128   ATK_ROLE_DIAL,
 129   ATK_ROLE_DIALOG,
 130   ATK_ROLE_DIRECTORY_PANE,
 131   ATK_ROLE_DRAWING_AREA,
 132   ATK_ROLE_FILE_CHOOSER,
 133   ATK_ROLE_FILLER,
 134   ATK_ROLE_FONT_CHOOSER,
 135   ATK_ROLE_FRAME,
 136   ATK_ROLE_GLASS_PANE,
 137   ATK_ROLE_HTML_CONTAINER,
 138   ATK_ROLE_ICON,
 139   ATK_ROLE_IMAGE,
 140   ATK_ROLE_INTERNAL_FRAME,
 141   ATK_ROLE_LABEL,
 142   ATK_ROLE_LAYERED_PANE,
 143   ATK_ROLE_LIST,
 144   ATK_ROLE_LIST_ITEM,
 145   ATK_ROLE_MENU,
 146   ATK_ROLE_MENU_BAR,
 147   ATK_ROLE_MENU_ITEM,
 148   ATK_ROLE_OPTION_PANE,
 149   ATK_ROLE_PAGE_TAB,
 150   ATK_ROLE_PAGE_TAB_LIST,
 151   ATK_ROLE_PANEL,
 152   ATK_ROLE_PASSWORD_TEXT,
 153   ATK_ROLE_POPUP_MENU,
 154   ATK_ROLE_PROGRESS_BAR,
 155   ATK_ROLE_PUSH_BUTTON,
 156   ATK_ROLE_RADIO_BUTTON,
 157   ATK_ROLE_RADIO_MENU_ITEM,
 158   ATK_ROLE_ROOT_PANE,
 159   ATK_ROLE_ROW_HEADER,
 160   ATK_ROLE_SCROLL_BAR,
 161   ATK_ROLE_SCROLL_PANE,
 162   ATK_ROLE_SEPARATOR,
 163   ATK_ROLE_SLIDER,
 164   ATK_ROLE_SPLIT_PANE,
 165   ATK_ROLE_SPIN_BUTTON,
 166   ATK_ROLE_STATUS_BAR,
 167   ATK_ROLE_TABLE,
 168   ATK_ROLE_TABLE_CELL,
 169   ATK_ROLE_TABLE_COLUMN_HEADER,
 170   ATK_ROLE_TABLE_ROW_HEADER,
 171   ATK_ROLE_TEAR_OFF_MENU_ITEM,
 172   ATK_ROLE_TEXT,
 173   ATK_ROLE_TOGGLE_BUTTON,
 174   ATK_ROLE_TOOL_BAR,
 175   ATK_ROLE_TOOL_TIP,
 176   ATK_ROLE_TREE,
 177   ATK_ROLE_UNKNOWN,
 178   ATK_ROLE_VIEWPORT,
 179   ATK_ROLE_WINDOW,
 180   ATK_ROLE_LAST_DEFINED
 181 } AtkRole;
 182
 183 AtkRole                  atk_role_register        (const gchar *name);
 184
 185
 186 #define ATK_TYPE_OBJECT                           (atk_object_get_type ())
 187 #define ATK_OBJECT(obj)                           (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
 188 #define ATK_OBJECT_CLASS(klass)                   (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
 189 #define ATK_IS_OBJECT(obj)                        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
 190 #define ATK_IS_OBJECT_CLASS(klass)                (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
 191 #define ATK_OBJECT_GET_CLASS(obj)                 (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
 192
 193 #define ATK_TYPE_IMPLEMENTOR                      (atk_implementor_get_type ())
 194 #define ATK_IS_IMPLEMENTOR(obj)                   G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
 195 #define ATK_IMPLEMENTOR(obj)                      G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
 196 #define ATK_IMPLEMENTOR_GET_IFACE(obj)            (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
 197
 198
 199 typedef struct _AtkImplementor            AtkImplementor; /* dummy typedef */
 200 typedef struct _AtkImplementorIface       AtkImplementorIface;
 201
 202
 203 typedef struct _AtkObject                 AtkObject;
 204 typedef struct _AtkObjectClass            AtkObjectClass;
 205 typedef struct _AtkRelationSet            AtkRelationSet;
 206 typedef struct _AtkStateSet               AtkStateSet;
 207
 208 struct _AtkPropertyValues
 209 {
 210   gchar  *property_name;
 211   GValue old_value;
 212   GValue new_value;
 213 };
 214
 215 typedef struct _AtkPropertyValues        AtkPropertyValues;
 216
 217 /*
 218  * For most properties the old_value field of AtkPropertyValues will
 219  * not contain a valid value.
 220  *
 221  * Currently, the only property for which old_value is used is
 222  * accessible-state; for instance if there is a focus state the
 223  * property change handler will be called for the object which lost the focus
 224  * with the old_value containing an AtkState value corresponding to focused
 225  * and the property change handler will be called for the object which
 226  * received the focus with the new_value containing an AtkState value
 227  * corresponding to focused.
 228  */
 229 typedef void (*AtkPropertyChangeHandler) (AtkObject*, AtkPropertyValues*);
 230
 231
 232 struct _AtkObject
 233 {
 234   GObject parent;
 235
 236   gchar *description;
 237   gchar *name;
 238   AtkObject *accessible_parent;
 239   AtkRole role;
 240   AtkRelationSet *relation_set;
 241 };
 242
 243 struct _AtkObjectClass
 244 {
 245   GObjectClass parent;
 246
 247   /*
 248    * Gets the accessible name of the object
 249    */
 250   G_CONST_RETURN gchar*    (* get_name)            (AtkObject                *accessible);
 251   /*
 252    * Gets the accessible description of the object
 253    */
 254   G_CONST_RETURN gchar*    (* get_description)     (AtkObject                *accessible);
 255   /*
 256    * Gets the accessible parent of the object
 257    */
 258   AtkObject*               (*get_parent)           (AtkObject                *accessible);
 259
 260   /*
 261    * Gets the number of accessible children of the object
 262    */
 263   gint                    (* get_n_children)       (AtkObject                *accessible);
 264   /*
 265    * Returns a reference to the specified accessible child of the object.
 266    * The accessible children are 0-based so the first accessible child is
 267    * at index 0, the second at index 1 and so on.
 268    */
 269   AtkObject*              (* ref_child)            (AtkObject                *accessible,
 270                                                     gint                      i);
 271   /*
 272    * Gets the 0-based index of this object in its parent; returns -1 if the
 273    * object does not have an accessible parent.
 274    */
 275   gint                    (* get_index_in_parent) (AtkObject                 *accessible);
 276   /*
 277    * Gets the RelationSet associated with the object
 278    */
 279   AtkRelationSet*         (* ref_relation_set)    (AtkObject                 *accessible);
 280   /*
 281    * Gets the role of the object
 282    */
 283   AtkRole                 (* get_role)            (AtkObject                 *accessible);
 284   /*
 285    * Gets the state set of the object
 286    */
 287   AtkStateSet*            (* ref_state_set)       (AtkObject                 *accessible);
 288   /*
 289    * Sets the accessible name of the object
 290    */
 291   void                    (* set_name)            (AtkObject                 *accessible,
 292                                                    const gchar               *name);
 293   /*
 294    * Sets the accessible description of the object
 295    */
 296   void                    (* set_description)     (AtkObject                 *accessible,
 297                                                    const gchar               *description);
 298   /*
 299    * Sets the accessible parent of the object
 300    */
 301   void                    (* set_parent)          (AtkObject                 *accessible,
 302                                                    AtkObject                 *parent);
 303   /*
 304    * Sets the accessible role of the object
 305    */
 306   void                    (* set_role)            (AtkObject                 *accessible,
 307                                                    AtkRole                   role);
 308   /*
 309    * Specifies a function to be called when a property changes value
 310    */
 311 guint                     (* connect_property_change_handler)    (AtkObject
 312                  *accessible,
 313                                                                   AtkPropertyChangeHandler       *handler);
 314   /*
 315    * Removes a property change handler which was specified using
 316    * connect_property_change_handler
 317    */
 318 void                      (* remove_property_change_handler)     (AtkObject
 319                 *accessible,
 320                                                                   guint
 321                 handler_id);
 322   /*
 323    * The signal handler which is executed when there is a change in the
 324    * children of the object
 325    */
 326   void                    (* children_changed)    (AtkObject                  *accessible,
 327                                                    gint                       change_index,
 328                                                    AtkObject                  *changed_child);
 329   /*
 330    * The signal handler which is executed  when there is a focus event
 331    * for an object.
 332    */
 333   void                    (*focus_event)          (AtkObject                  *accessible,
 334                                                    gboolean                   focus_in);
 335 };
 336
 337 GType            atk_object_get_type   (void);
 338
 339 struct _AtkImplementorIface
 340 {
 341   GTypeInterface parent;
 342
 343   AtkObject*   (*ref_accessible) (AtkImplementor *implementor);
 344 };
 345 GType atk_implementor_get_type (void);
 346
 347 /*
 348  * This method uses the ref_accessible method in AtkImplementorIface,
 349  * if the object's class implements AtkImplementorIface.
 350  * Otherwise it returns %NULL.
 351  *
 352  * IMPORTANT:
 353  * Note also that because this method may return flyweight objects,
 354  * it increments the returned AtkObject's reference count.
 355  * Therefore it is the responsibility of the calling
 356  * program to unreference the object when no longer needed.
 357  * (c.f. gtk_widget_get_accessible() where this is not the case).
 358  */
 359 AtkObject*              atk_implementor_ref_accessible            (AtkImplementor *implementor);
 360
 361 /*
 362  * Properties directly supported by AtkObject
 363  */
 364
 365 G_CONST_RETURN gchar*   atk_object_get_name                       (AtkObject *accessible);
 366 G_CONST_RETURN gchar*   atk_object_get_description                (AtkObject *accessible);
 367 AtkObject*              atk_object_get_parent                     (AtkObject *accessible);
 368 gint                    atk_object_get_n_accessible_children      (AtkObject *accessible);
 369 AtkObject*              atk_object_ref_accessible_child           (AtkObject *accessible,
 370                                                                    gint        i);
 371 AtkRelationSet*         atk_object_ref_relation_set               (AtkObject *accessible);
 372 AtkRole                 atk_object_get_role                       (AtkObject *accessible);
 373 AtkStateSet*            atk_object_ref_state_set                  (AtkObject *accessible);
 374 gint                    atk_object_get_index_in_parent            (AtkObject *accessible);
 375 void                    atk_object_set_name                       (AtkObject *accessible,
 376                                                                    const gchar *name);
 377 void                    atk_object_set_description                (AtkObject *accessible,
 378                                                                    const gchar *description);
 379 void                    atk_object_set_parent                     (AtkObject *accessible,
 380                                                                    AtkObject *parent);
 381 void                    atk_object_set_role                       (AtkObject *accessible,
 382                                                                    AtkRole   role);
 383
 384
 385 /*
 386  * to install property change listener, one must
 387  * install signal handler for gobject "properties_changed" signal.
 388  * (for single notifications of multiple changes).
 389  * We could use the "notify" signal instead.
 390  *
 391  */
 392 guint                atk_object_connect_property_change_handler  (AtkObject                      *accessible,
 393                                                                   AtkPropertyChangeHandler       *handler);
 394 void                 atk_object_remove_property_change_handler  (AtkObject                      *accessible,
 395                                                                   guint                         handler_id);
 396
 397 /*
 398  * Note: the properties which are registered with the GType
 399  *   property registry, for type ATK_TYPE_OBJECT, are as follows:
 400  *
 401  *   "accessible-name"
 402  *   "accessible-description"
 403  *   "accessible-parent"
 404  *   "accessible-child"
 405  *   "accessible-role"
 406  *   "accessible-state"
 407  *
 408  * accessibility property change listeners should use the
 409  *   normal GObject property interfaces and "properties_changed"
 410  *   signal handler semantics to interpret the property change
 411  *   information relayed from AtkObject.
 412  *   (AtkObject instances will connect to the "properties_changed"
 413  *   signal in their host objects, and relay the signals when appropriate).
 414  */
 415
 416 /* For other signals, see related interfaces
 417  *
 418  *    AtkActionIface,
 419  *    AtkComponentIface,
 420  *    AtkHypertextIface,
 421  *    AtkImageIface,
 422  *    AtkSelectionIface,
 423  *    AtkTableIface,
 424  *    AtkTextIface,
 425  *    AtkValueIface.
 426  *
 427  *  The usage model for obtaining these interface instances is:
 428  *    ATK_<interfacename>_GET_IFACE(GObject *accessible),
 429  *    where accessible, though specified as a GObject, is
 430  *    the AtkObject instance being queried.
 431  *  More usually, the interface will be used via a cast to the
 432  *    interface's corresponding "type":
 433  *
 434  *    AtkText textImpl = ATK_TEXT(accessible);
 435  *    if (textImpl)
 436  *      {
 437  *        cpos = atk_text_get_caret_position(textImpl);
 438  *      }
 439  *
 440  *  If it's known in advance that accessible implements AtkTextIface,
 441  *    this is shortened to:
 442  *
 443  *    cpos = atk_text_get_caret_position (ATK_TEXT (accessible));
 444  */
 445
 446 #ifdef __cplusplus
 447 }
 448 #endif /* __cplusplus */
 449
 450
 451 #endif /* __ATK_OBJECT_H__ */