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 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  21 #error "Only <atk/atk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __ATK_OBJECT_H__
  25 #define __ATK_OBJECT_H__
  26
  27 #include <glib-object.h>
  28 #include <atk/atkstate.h>
  29 #include <atk/atkrelationtype.h>
  30
  31 G_BEGIN_DECLS
  32
  33 /*
  34  * AtkObject represents the minimum information all accessible objects
  35  * return. This information includes accessible name, accessible
  36  * description, role and state of the object, as well information about
  37  * its parent and children. It is also possible to obtain more specific
  38  * accessibility information about a component if it supports one or more
  39  * of the following interfaces:
  40  */
  41
  42
  43 /**
  44  *AtkRole:
  45  *@ATK_ROLE_INVALID: Invalid role
  46  *@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
  47  *@ATK_ROLE_ALERT: An object which is an alert to the user. Assistive Technologies typically respond to ATK_ROLE_ALERT by reading the entire onscreen contents of containers advertising this role.  Should be used for warning dialogs, etc.
  48  *@ATK_ROLE_ANIMATION: An object which is an animated image
  49  *@ATK_ROLE_ARROW: An arrow in one of the four cardinal directions
  50  *@ATK_ROLE_CALENDAR:  An object that displays a calendar and allows the user to select a date
  51  *@ATK_ROLE_CANVAS: An object that can be drawn into and is used to trap events
  52  *@ATK_ROLE_CHECK_BOX: A choice that can be checked or unchecked and provides a separate indicator for the current state
  53  *@ATK_ROLE_CHECK_MENU_ITEM: A menu item with a check box
  54  *@ATK_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color
  55  *@ATK_ROLE_COLUMN_HEADER: The header for a column of data
  56  *@ATK_ROLE_COMBO_BOX: A collapsible list of choices the user can select from
  57  *@ATK_ROLE_DATE_EDITOR: An object whose purpose is to allow a user to edit a date
  58  *@ATK_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
  59  *@ATK_ROLE_DESKTOP_FRAME: A pane that supports internal frames and iconified versions of those internal frames
  60  *@ATK_ROLE_DIAL: An object whose purpose is to allow a user to set a value
  61  *@ATK_ROLE_DIALOG: A top level window with title bar and a border
  62  *@ATK_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through and select the contents of a directory
  63  *@ATK_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
  64  *@ATK_ROLE_FILE_CHOOSER: A specialized dialog that lets the user choose a file
  65  *@ATK_ROLE_FILLER: A object that fills up space in a user interface
  66  *@ATK_ROLE_FONT_CHOOSER: A specialized dialog that lets the user choose a font
  67  *@ATK_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
  68  *@ATK_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all panes beneath it
  69  *@ATK_ROLE_HTML_CONTAINER: A document container for HTML, whose children represent the document content
  70  *@ATK_ROLE_ICON: A small fixed size picture, typically used to decorate components
  71  *@ATK_ROLE_IMAGE: An object whose primary purpose is to display an image
  72  *@ATK_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane
  73  *@ATK_ROLE_LABEL: An object used to present an icon or short string in an interface
  74  *@ATK_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
  75  *@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
  76  *@ATK_ROLE_LIST_ITEM: An object that represents an element of a list
  77  *@ATK_ROLE_MENU: An object usually found inside a menu bar that contains a list of actions the user can choose from
  78  *@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
  79  *@ATK_ROLE_MENU_ITEM: An object usually contained in a menu that presents an action the user can choose
  80  *@ATK_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
  81  *@ATK_ROLE_PAGE_TAB: An object that is a child of a page tab list
  82  *@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
  83  *@ATK_ROLE_PANEL: A generic container that is often used to group objects
  84  *@ATK_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where the text content is not shown visibly to the user
  85  *@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
  86  *@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
  87  *@ATK_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the application to do something
  88  *@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
  89  *@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
  90  *@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
  91  *@ATK_ROLE_ROW_HEADER: The header for a row of data
  92  *@ATK_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally view a large amount of data.
  93  *@ATK_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount of information
  94  *@ATK_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
  95  *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
  96  *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
  97  *@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
  98  *@ATK_ROLE_STATUSBAR: An object which reports messages of minor importance to the user
  99  *@ATK_ROLE_TABLE: An object used to represent information in terms of rows and columns
 100  *@ATK_ROLE_TABLE_CELL: A cell in a table
 101  *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
 102  *@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
 103  *@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu
 104  *@ATK_ROLE_TERMINAL: An object that represents an accessible terminal.  @Since: ATK-0.6
 105  *@ATK_ROLE_TEXT: An object that presents text to the user
 106  *@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
 107  *@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
 108  *@ATK_ROLE_TOOL_TIP: An object that provides information about another object
 109  *@ATK_ROLE_TREE: An object used to represent hierarchical information to the user
 110  *@ATK_ROLE_TREE_TABLE: An object capable of expanding and collapsing rows as well as showing multiple columns of data.   @Since: ATK-0.7
 111  *@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
 112  *@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane
 113  *@ATK_ROLE_WINDOW: A top level window with no title or border.
 114  *@ATK_ROLE_HEADER: An object that serves as a document header. @Since: ATK-1.1.1
 115  *@ATK_ROLE_FOOTER: An object that serves as a document footer.  @Since: ATK-1.1.1
 116  *@ATK_ROLE_PARAGRAPH: An object which is contains a paragraph of text content.   @Since: ATK-1.1.1
 117  *@ATK_ROLE_RULER: An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such).   @Since: ATK-1.1.1
 118  *@ATK_ROLE_APPLICATION: The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles.  The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION.   @Since: ATK-1.1.4
 119  *@ATK_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry.   @Since: ATK-1.3
 120  *@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar.  @Since: ATK-1.5
 121  *@ATK_ROLE_EMBEDDED: The object is an embedded container within a document or panel.  This role is a grouping "hint" indicating that the contained objects share a context.  @Since: ATK-1.7.2
 122  *@ATK_ROLE_ENTRY: The object is a component whose textual content may be entered or modified by the user, provided @ATK_STATE_EDITABLE is present.   @Since: ATK-1.11
 123  *@ATK_ROLE_CHART: The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property.  @Since: ATK-1.11
 124  *@ATK_ROLE_CAPTION: The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image.  @Since: ATK-1.11
 125  *@ATK_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface.  @Since: ATK-1.11
 126  *@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.
 127  *@ATK_ROLE_PAGE: The object is a containing instance which encapsulates a page of information. @ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model.  @Since: ATK-1.11
 128  *@ATK_ROLE_SECTION: The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. @Since: ATK-1.11
 129  *@ATK_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons.  Objects of this role should normally be ignored by clients. @Since: ATK-1.11
 130  *@ATK_ROLE_FORM: The object is a container for form controls, for instance as part of a
 131  * web form or user-input form within a document.  This role is primarily a tag/convenience for
 132  * clients when navigating complex documents, it is not expected that ordinary GUI containers will
 133  * always have ATK_ROLE_FORM. @Since: ATK-1.12.0
 134  *@ATK_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a
 135  * hypertext document.  Such objects are distinct from 'inline'
 136  * content which may also use the Hypertext/Hyperlink interfaces
 137  * to indicate the range/location within a text object where
 138  * an inline or embedded object lies.  @Since: ATK-1.12.1
 139  *@ATK_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
 140  * which is used to allow composition or input of a 'complex character',
 141  * in other words it is an "input method window." @Since: ATK-1.12.1
 142  *@ATK_ROLE_TABLE_ROW: A row in a table.  @Since: ATK-2.1.0
 143  *@ATK_ROLE_TREE_ITEM: An object that represents an element of a tree.  @Since: ATK-2.1.0
 144  *@ATK_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a spreadsheet.  @Since: ATK-2.1.0
 145  *@ATK_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a presentation or slide content.  @Since: ATK-2.1.0
 146  *@ATK_ROLE_DOCUMENT_TEXT: A document frame which contains textual content, such as found in a word processing application.  @Since: ATK-2.1.0
 147  *@ATK_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other markup suitable for display in a web browser.  @Since: ATK-2.1.0
 148  *@ATK_ROLE_DOCUMENT_EMAIL: A document frame which contains email content to be displayed or composed either in plain text or HTML.  @Since: ATK-2.1.0
 149  *@ATK_ROLE_COMMENT: An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated.  @Since: ATK-2.1.0
 150  *@ATK_ROLE_LIST_BOX: A non-collapsible list of choices the user can select from. @Since: ATK-2.1.0
 151  *@ATK_ROLE_GROUPING: A group of related widgets. This group typically has a label. @Since: ATK-2.1.0
 152  *@ATK_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. @Since: ATK-2.1.0
 153  *@ATK_ROLE_NOTIFICATION: A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application.  @Since: ATK-2.1.0
 154  *@ATK_ROLE_INFO_BAR: An object designed to present a message to the user within an existing window. @Since: ATK-2.1.0
 155  *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration
 156  *
 157  * Describes the role of an object
 158  *
 159  * These are the built-in enumerated roles that UI components can have in
 160  * ATK.  Other roles may be added at runtime, so an AtkRole >=
 161  * ATK_ROLE_LAST_DEFINED is not necessarily an error.
 162  **/
 163 typedef enum
 164 {
 165   ATK_ROLE_INVALID = 0,
 166   ATK_ROLE_ACCEL_LABEL,
 167   ATK_ROLE_ALERT,
 168   ATK_ROLE_ANIMATION,
 169   ATK_ROLE_ARROW,
 170   ATK_ROLE_CALENDAR,
 171   ATK_ROLE_CANVAS,
 172   ATK_ROLE_CHECK_BOX,
 173   ATK_ROLE_CHECK_MENU_ITEM,
 174   ATK_ROLE_COLOR_CHOOSER,
 175   ATK_ROLE_COLUMN_HEADER,
 176   ATK_ROLE_COMBO_BOX,
 177   ATK_ROLE_DATE_EDITOR,
 178   ATK_ROLE_DESKTOP_ICON,
 179   ATK_ROLE_DESKTOP_FRAME,
 180   ATK_ROLE_DIAL,
 181   ATK_ROLE_DIALOG,
 182   ATK_ROLE_DIRECTORY_PANE,
 183   ATK_ROLE_DRAWING_AREA,
 184   ATK_ROLE_FILE_CHOOSER,
 185   ATK_ROLE_FILLER,
 186   ATK_ROLE_FONT_CHOOSER,
 187   ATK_ROLE_FRAME,
 188   ATK_ROLE_GLASS_PANE,
 189   ATK_ROLE_HTML_CONTAINER,
 190   ATK_ROLE_ICON,
 191   ATK_ROLE_IMAGE,
 192   ATK_ROLE_INTERNAL_FRAME,
 193   ATK_ROLE_LABEL,
 194   ATK_ROLE_LAYERED_PANE,
 195   ATK_ROLE_LIST,
 196   ATK_ROLE_LIST_ITEM,
 197   ATK_ROLE_MENU,
 198   ATK_ROLE_MENU_BAR,
 199   ATK_ROLE_MENU_ITEM,
 200   ATK_ROLE_OPTION_PANE,
 201   ATK_ROLE_PAGE_TAB,
 202   ATK_ROLE_PAGE_TAB_LIST,
 203   ATK_ROLE_PANEL,
 204   ATK_ROLE_PASSWORD_TEXT,
 205   ATK_ROLE_POPUP_MENU,
 206   ATK_ROLE_PROGRESS_BAR,
 207   ATK_ROLE_PUSH_BUTTON,
 208   ATK_ROLE_RADIO_BUTTON,
 209   ATK_ROLE_RADIO_MENU_ITEM,
 210   ATK_ROLE_ROOT_PANE,
 211   ATK_ROLE_ROW_HEADER,
 212   ATK_ROLE_SCROLL_BAR,
 213   ATK_ROLE_SCROLL_PANE,
 214   ATK_ROLE_SEPARATOR,
 215   ATK_ROLE_SLIDER,
 216   ATK_ROLE_SPLIT_PANE,
 217   ATK_ROLE_SPIN_BUTTON,
 218   ATK_ROLE_STATUSBAR,
 219   ATK_ROLE_TABLE,
 220   ATK_ROLE_TABLE_CELL,
 221   ATK_ROLE_TABLE_COLUMN_HEADER,
 222   ATK_ROLE_TABLE_ROW_HEADER,
 223   ATK_ROLE_TEAR_OFF_MENU_ITEM,
 224   ATK_ROLE_TERMINAL,
 225   ATK_ROLE_TEXT,
 226   ATK_ROLE_TOGGLE_BUTTON,
 227   ATK_ROLE_TOOL_BAR,
 228   ATK_ROLE_TOOL_TIP,
 229   ATK_ROLE_TREE,
 230   ATK_ROLE_TREE_TABLE,
 231   ATK_ROLE_UNKNOWN,
 232   ATK_ROLE_VIEWPORT,
 233   ATK_ROLE_WINDOW,
 234   ATK_ROLE_HEADER,
 235   ATK_ROLE_FOOTER,
 236   ATK_ROLE_PARAGRAPH,
 237   ATK_ROLE_RULER,
 238   ATK_ROLE_APPLICATION,
 239   ATK_ROLE_AUTOCOMPLETE,
 240   ATK_ROLE_EDITBAR,
 241   ATK_ROLE_EMBEDDED,
 242   ATK_ROLE_ENTRY,
 243   ATK_ROLE_CHART,
 244   ATK_ROLE_CAPTION,
 245   ATK_ROLE_DOCUMENT_FRAME,
 246   ATK_ROLE_HEADING,
 247   ATK_ROLE_PAGE,
 248   ATK_ROLE_SECTION,
 249   ATK_ROLE_REDUNDANT_OBJECT,
 250   ATK_ROLE_FORM,
 251   ATK_ROLE_LINK,
 252   ATK_ROLE_INPUT_METHOD_WINDOW,
 253   ATK_ROLE_TABLE_ROW,
 254   ATK_ROLE_TREE_ITEM,
 255   ATK_ROLE_DOCUMENT_SPREADSHEET,
 256   ATK_ROLE_DOCUMENT_PRESENTATION,
 257   ATK_ROLE_DOCUMENT_TEXT,
 258   ATK_ROLE_DOCUMENT_WEB,
 259   ATK_ROLE_DOCUMENT_EMAIL,
 260   ATK_ROLE_COMMENT,
 261   ATK_ROLE_LIST_BOX,
 262   ATK_ROLE_GROUPING,
 263   ATK_ROLE_IMAGE_MAP,
 264   ATK_ROLE_NOTIFICATION,
 265   ATK_ROLE_INFO_BAR,
 266   ATK_ROLE_LAST_DEFINED
 267 } AtkRole;
 268
 269 AtkRole                  atk_role_register        (const gchar *name);
 270
 271 /**
 272  *AtkLayer:
 273  *@ATK_LAYER_INVALID: The object does not have a layer
 274  *@ATK_LAYER_BACKGROUND: This layer is reserved for the desktop background
 275  *@ATK_LAYER_CANVAS: This layer is used for Canvas components
 276  *@ATK_LAYER_WIDGET: This layer is normally used for components
 277  *@ATK_LAYER_MDI: This layer is used for layered components
 278  *@ATK_LAYER_POPUP: This layer is used for popup components, such as menus
 279  *@ATK_LAYER_OVERLAY: This layer is reserved for future use.
 280  *@ATK_LAYER_WINDOW: This layer is used for toplevel windows.
 281  *
 282  * Describes the layer of a component
 283  *
 284  * These enumerated "layer values" are used when determining which UI
 285  * rendering layer a component is drawn into, which can help in making
 286  * determinations of when components occlude one another.
 287  **/
 288 typedef enum
 289 {
 290   ATK_LAYER_INVALID,
 291   ATK_LAYER_BACKGROUND,
 292   ATK_LAYER_CANVAS,
 293   ATK_LAYER_WIDGET,
 294   ATK_LAYER_MDI,
 295   ATK_LAYER_POPUP,
 296   ATK_LAYER_OVERLAY,
 297   ATK_LAYER_WINDOW
 298 } AtkLayer;
 299
 300 /**
 301  * AtkAttributeSet:
 302  *
 303  * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
 304  * used by atk_text_get_run_attributes(), atk_text_get_default_attributes()
 305  * and atk_editable_text_set_run_attributes()
 306  **/
 307 typedef GSList AtkAttributeSet;
 308
 309 /**
 310  * AtkAttribute:
 311  * @name: The attribute name. Call atk_text_attr_get_name()
 312  * @value: the value of the attribute, represented as a string.
 313  * Call atk_text_attr_get_value() for those which are strings.
 314  * For values which are numbers, the string representation of the number
 315  * is in value.
 316  *
 317  * A string name/value pair representing a text attribute.
 318  **/
 319 typedef struct _AtkAttribute AtkAttribute;
 320
 321 struct _AtkAttribute {
 322   gchar* name;
 323   gchar* value;
 324 };
 325
 326 #define ATK_TYPE_OBJECT                           (atk_object_get_type ())
 327 #define ATK_OBJECT(obj)                           (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
 328 #define ATK_OBJECT_CLASS(klass)                   (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
 329 #define ATK_IS_OBJECT(obj)                        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
 330 #define ATK_IS_OBJECT_CLASS(klass)                (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
 331 #define ATK_OBJECT_GET_CLASS(obj)                 (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
 332
 333 #define ATK_TYPE_IMPLEMENTOR                      (atk_implementor_get_type ())
 334 #define ATK_IS_IMPLEMENTOR(obj)                   G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
 335 #define ATK_IMPLEMENTOR(obj)                      G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
 336 #define ATK_IMPLEMENTOR_GET_IFACE(obj)            (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
 337
 338
 339 typedef struct _AtkImplementor            AtkImplementor; /* dummy typedef */
 340 typedef struct _AtkImplementorIface       AtkImplementorIface;
 341
 342
 343 typedef struct _AtkObject                 AtkObject;
 344 typedef struct _AtkObjectClass            AtkObjectClass;
 345 typedef struct _AtkRelationSet            AtkRelationSet;
 346 typedef struct _AtkStateSet               AtkStateSet;
 347
 348 /**
 349  * AtkPropertyValues:
 350  * @property_name: The name of the ATK property which is being presented or which has been changed.
 351  * @old_value: The old property value, NULL; in some contexts this value is undefined (see note below).
 352  * @new_value: The new value of the named property.
 353  *
 354  * @note: For most properties the old_value field of AtkPropertyValues will
 355  * not contain a valid value.
 356  *
 357  * Currently, the only property for which old_value is used is
 358  * accessible-state; for instance if there is a focus state the
 359  * property change handler will be called for the object which lost the focus
 360  * with the old_value containing an AtkState value corresponding to focused
 361  * and the property change handler will be called for the object which
 362  * received the focus with the new_value containing an AtkState value
 363  * corresponding to focused.
 364  *
 365  **/
 366 struct _AtkPropertyValues
 367 {
 368   const gchar  *property_name;
 369   GValue old_value;
 370   GValue new_value;
 371 };
 372
 373 typedef struct _AtkPropertyValues        AtkPropertyValues;
 374
 375 typedef gboolean (*AtkFunction)          (gpointer data);
 376 /*
 377  * For most properties the old_value field of AtkPropertyValues will
 378  * not contain a valid value.
 379  *
 380  * Currently, the only property for which old_value is used is
 381  * accessible-state; for instance if there is a focus state the
 382  * property change handler will be called for the object which lost the focus
 383  * with the old_value containing an AtkState value corresponding to focused
 384  * and the property change handler will be called for the object which
 385  * received the focus with the new_value containing an AtkState value
 386  * corresponding to focused.
 387  */
 388 typedef void (*AtkPropertyChangeHandler) (AtkObject*, AtkPropertyValues*);
 389
 390
 391 struct _AtkObject
 392 {
 393   GObject parent;
 394
 395   gchar *description;
 396   gchar *name;
 397   AtkObject *accessible_parent;
 398   AtkRole role;
 399   AtkRelationSet *relation_set;
 400   AtkLayer layer;
 401 };
 402
 403 struct _AtkObjectClass
 404 {
 405   GObjectClass parent;
 406
 407   /*
 408    * Gets the accessible name of the object
 409    */
 410   const gchar*             (* get_name)            (AtkObject                *accessible);
 411   /*
 412    * Gets the accessible description of the object
 413    */
 414   const gchar*             (* get_description)     (AtkObject                *accessible);
 415   /*
 416    * Gets the accessible parent of the object
 417    */
 418   AtkObject*               (*get_parent)           (AtkObject                *accessible);
 419
 420   /*
 421    * Gets the number of accessible children of the object
 422    */
 423   gint                    (* get_n_children)       (AtkObject                *accessible);
 424   /*
 425    * Returns a reference to the specified accessible child of the object.
 426    * The accessible children are 0-based so the first accessible child is
 427    * at index 0, the second at index 1 and so on.
 428    */
 429   AtkObject*              (* ref_child)            (AtkObject                *accessible,
 430                                                     gint                      i);
 431   /*
 432    * Gets the 0-based index of this object in its parent; returns -1 if the
 433    * object does not have an accessible parent.
 434    */
 435   gint                    (* get_index_in_parent) (AtkObject                 *accessible);
 436   /*
 437    * Gets the RelationSet associated with the object
 438    */
 439   AtkRelationSet*         (* ref_relation_set)    (AtkObject                 *accessible);
 440   /*
 441    * Gets the role of the object
 442    */
 443   AtkRole                 (* get_role)            (AtkObject                 *accessible);
 444   AtkLayer                (* get_layer)           (AtkObject                 *accessible);
 445   gint                    (* get_mdi_zorder)      (AtkObject                 *accessible);
 446   /*
 447    * Gets the state set of the object
 448    */
 449   AtkStateSet*            (* ref_state_set)       (AtkObject                 *accessible);
 450   /*
 451    * Sets the accessible name of the object
 452    */
 453   void                    (* set_name)            (AtkObject                 *accessible,
 454                                                    const gchar               *name);
 455   /*
 456    * Sets the accessible description of the object
 457    */
 458   void                    (* set_description)     (AtkObject                 *accessible,
 459                                                    const gchar               *description);
 460   /*
 461    * Sets the accessible parent of the object
 462    */
 463   void                    (* set_parent)          (AtkObject                 *accessible,
 464                                                    AtkObject                 *parent);
 465   /*
 466    * Sets the accessible role of the object
 467    */
 468   void                    (* set_role)            (AtkObject                 *accessible,
 469                                                    AtkRole                   role);
 470   /*
 471    * Specifies a function to be called when a property changes value
 472    */
 473 guint                     (* connect_property_change_handler)    (AtkObject
 474                  *accessible,
 475                                                                   AtkPropertyChangeHandler       *handler);
 476   /*
 477    * Removes a property change handler which was specified using
 478    * connect_property_change_handler
 479    */
 480 void                      (* remove_property_change_handler)     (AtkObject
 481                 *accessible,
 482                                                                   guint
 483                 handler_id);
 484 void                      (* initialize)                         (AtkObject                     *accessible,
 485                                                                   gpointer                      data);
 486   /*
 487    * The signal handler which is executed when there is a change in the
 488    * children of the object
 489    */
 490   void                    (* children_changed)    (AtkObject                  *accessible,
 491                                                    guint                      change_index,
 492                                                    gpointer                   changed_child);
 493   /*
 494    * The signal handler which is executed  when there is a focus event
 495    * for an object.
 496    */
 497   void                    (* focus_event)         (AtkObject                  *accessible,
 498                                                    gboolean                   focus_in);
 499   /*
 500    * The signal handler which is executed  when there is a property_change
 501    * signal for an object.
 502    */
 503   void                    (* property_change)     (AtkObject                  *accessible,
 504                                                    AtkPropertyValues          *values);
 505   /*
 506    * The signal handler which is executed  when there is a state_change
 507    * signal for an object.
 508    */
 509   void                    (* state_change)        (AtkObject                  *accessible,
 510                                                    const gchar                *name,
 511                                                    gboolean                   state_set);
 512   /*
 513    * The signal handler which is executed when there is a change in the
 514    * visible data for an object
 515    */
 516   void                    (*visible_data_changed) (AtkObject                  *accessible);
 517
 518   /*
 519    * The signal handler which is executed when there is a change in the
 520    * 'active' child or children of the object, for instance when
 521    * interior focus changes in a table or list.  This signal should be emitted
 522    * by objects whose state includes ATK_STATE_MANAGES_DESCENDANTS.
 523    */
 524   void                    (*active_descendant_changed) (AtkObject                  *accessible,
 525                                                         gpointer                   *child);
 526
 527   /*
 528    * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs.
 529    * Since ATK 1.12
 530    */
 531   AtkAttributeSet*        (*get_attributes)            (AtkObject                  *accessible);
 532   AtkFunction             pad1;
 533   AtkFunction             pad2;
 534 };
 535
 536 GType            atk_object_get_type   (void);
 537
 538 struct _AtkImplementorIface
 539 {
 540   GTypeInterface parent;
 541
 542   AtkObject*   (*ref_accessible) (AtkImplementor *implementor);
 543 };
 544 GType atk_implementor_get_type (void);
 545
 546 /*
 547  * This method uses the ref_accessible method in AtkImplementorIface,
 548  * if the object's class implements AtkImplementorIface.
 549  * Otherwise it returns %NULL.
 550  *
 551  * IMPORTANT:
 552  * Note also that because this method may return flyweight objects,
 553  * it increments the returned AtkObject's reference count.
 554  * Therefore it is the responsibility of the calling
 555  * program to unreference the object when no longer needed.
 556  * (c.f. gtk_widget_get_accessible() where this is not the case).
 557  */
 558 AtkObject*              atk_implementor_ref_accessible            (AtkImplementor *implementor);
 559
 560 /*
 561  * Properties directly supported by AtkObject
 562  */
 563
 564 const gchar*            atk_object_get_name                       (AtkObject *accessible);
 565 const gchar*            atk_object_get_description                (AtkObject *accessible);
 566 AtkObject*              atk_object_get_parent                     (AtkObject *accessible);
 567 gint                    atk_object_get_n_accessible_children      (AtkObject *accessible);
 568 AtkObject*              atk_object_ref_accessible_child           (AtkObject *accessible,
 569                                                                    gint        i);
 570 AtkRelationSet*         atk_object_ref_relation_set               (AtkObject *accessible);
 571 AtkRole                 atk_object_get_role                       (AtkObject *accessible);
 572 #ifndef ATK_DISABLE_DEPRECATED
 573 AtkLayer                atk_object_get_layer                      (AtkObject *accessible);
 574 gint                    atk_object_get_mdi_zorder                 (AtkObject *accessible);
 575 #endif /* ATK_DISABLE_DEPRECATED */
 576 AtkAttributeSet*        atk_object_get_attributes                 (AtkObject *accessible);
 577 AtkStateSet*            atk_object_ref_state_set                  (AtkObject *accessible);
 578 gint                    atk_object_get_index_in_parent            (AtkObject *accessible);
 579 void                    atk_object_set_name                       (AtkObject *accessible,
 580                                                                    const gchar *name);
 581 void                    atk_object_set_description                (AtkObject *accessible,
 582                                                                    const gchar *description);
 583 void                    atk_object_set_parent                     (AtkObject *accessible,
 584                                                                    AtkObject *parent);
 585 void                    atk_object_set_role                       (AtkObject *accessible,
 586                                                                    AtkRole   role);
 587
 588
 589 guint                atk_object_connect_property_change_handler  (AtkObject                      *accessible,
 590                                                                   AtkPropertyChangeHandler       *handler);
 591 void                 atk_object_remove_property_change_handler   (AtkObject                      *accessible,
 592                                                                   guint                          handler_id);
 593
 594 void                 atk_object_notify_state_change              (AtkObject                      *accessible,
 595                                                                   AtkState                       state,
 596                                                                   gboolean                       value);
 597 void                 atk_object_initialize                       (AtkObject                     *accessible,
 598                                                                   gpointer                      data);
 599
 600 const gchar*          atk_role_get_name      (AtkRole         role);
 601 AtkRole               atk_role_for_name      (const gchar     *name);
 602
 603
 604 /* NEW in 1.1: convenience API */
 605 gboolean              atk_object_add_relationship              (AtkObject      *object,
 606                                                                 AtkRelationType relationship,
 607                                                                 AtkObject      *target);
 608 gboolean              atk_object_remove_relationship           (AtkObject      *object,
 609                                                                 AtkRelationType relationship,
 610                                                                 AtkObject      *target);
 611 const gchar*          atk_role_get_localized_name              (AtkRole     role);
 612
 613 /* */
 614
 615
 616 /*
 617  * Note: the properties which are registered with the GType
 618  *   property registry, for type ATK_TYPE_OBJECT, are as follows:
 619  *
 620  *   "accessible-name"
 621  *   "accessible-description"
 622  *   "accessible-parent"
 623  *   "accessible-role"
 624  *   "accessible-value"
 625  *   "accessible-component-layer"
 626  *   "accessible-component-zorder"
 627  *   "accessible-table-caption"
 628  *   "accessible-table-column-description"
 629  *   "accessible-table-column-header"
 630  *   "accessible-table-row-description"
 631  *   "accessible-table-row-header"
 632  *   "accessible-table-summary"
 633  *   "accessible-model"
 634  *
 635  * accessibility property change listeners should use the
 636  *   normal GObject property interfaces and "property-change"
 637  *   signal handler semantics to interpret the property change
 638  *   information relayed from AtkObject.
 639  *   (AtkObject instances will connect to the "notify"
 640  *   signal in their host objects, and relay the signals when appropriate).
 641  */
 642
 643 /* For other signals, see related interfaces
 644  *
 645  *    AtkActionIface,
 646  *    AtkComponentIface,
 647  *    AtkHypertextIface,
 648  *    AtkImageIface,
 649  *    AtkSelectionIface,
 650  *    AtkTableIface,
 651  *    AtkTextIface,
 652  *    AtkValueIface.
 653  *
 654  *  The usage model for obtaining these interface instances is:
 655  *    ATK_<interfacename>_GET_IFACE(GObject *accessible),
 656  *    where accessible, though specified as a GObject, is
 657  *    the AtkObject instance being queried.
 658  *  More usually, the interface will be used via a cast to the
 659  *    interface's corresponding "type":
 660  *
 661  *    AtkText textImpl = ATK_TEXT(accessible);
 662  *    if (textImpl)
 663  *      {
 664  *        cpos = atk_text_get_caret_position(textImpl);
 665  *      }
 666  *
 667  *  If it's known in advance that accessible implements AtkTextIface,
 668  *    this is shortened to:
 669  *
 670  *    cpos = atk_text_get_caret_position (ATK_TEXT (accessible));
 671  */
 672
 673 G_END_DECLS
 674
 675 #endif /* __ATK_OBJECT_H__ */