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