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