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
  29 #include <atk/atkversion.h>
  30 #include <atk/atkstate.h>
  31 #include <atk/atkrelationtype.h>
  32
  33 G_BEGIN_DECLS
  34
  35 /*
  36  * AtkObject represents the minimum information all accessible objects
  37  * return. This information includes accessible name, accessible
  38  * description, role and state of the object, as well information about
  39  * its parent and children. It is also possible to obtain more specific
  40  * accessibility information about a component if it supports one or more
  41  * of the following interfaces:
  42  */
  43
  44
  45 /**
  46  *AtkRole:
  47  *@ATK_ROLE_INVALID: Invalid role
  48  *@ATK_ROLE_ACCEL_LABEL: A label which represents an accelerator
  49  *@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.
  50  *@ATK_ROLE_ANIMATION: An object which is an animated image
  51  *@ATK_ROLE_ARROW: An arrow in one of the four cardinal directions
  52  *@ATK_ROLE_CALENDAR:  An object that displays a calendar and allows the user to select a date
  53  *@ATK_ROLE_CANVAS: An object that can be drawn into and is used to trap events
  54  *@ATK_ROLE_CHECK_BOX: A choice that can be checked or unchecked and provides a separate indicator for the current state
  55  *@ATK_ROLE_CHECK_MENU_ITEM: A menu item with a check box
  56  *@ATK_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a color
  57  *@ATK_ROLE_COLUMN_HEADER: The header for a column of data
  58  *@ATK_ROLE_COMBO_BOX: A collapsible list of choices the user can select from
  59  *@ATK_ROLE_DATE_EDITOR: An object whose purpose is to allow a user to edit a date
  60  *@ATK_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE
  61  *@ATK_ROLE_DESKTOP_FRAME: A pane that supports internal frames and iconified versions of those internal frames
  62  *@ATK_ROLE_DIAL: An object whose purpose is to allow a user to set a value
  63  *@ATK_ROLE_DIALOG: A top level window with title bar and a border
  64  *@ATK_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through and select the contents of a directory
  65  *@ATK_ROLE_DRAWING_AREA: An object used for drawing custom user interface elements
  66  *@ATK_ROLE_FILE_CHOOSER: A specialized dialog that lets the user choose a file
  67  *@ATK_ROLE_FILLER: A object that fills up space in a user interface
  68  *@ATK_ROLE_FONT_CHOOSER: A specialized dialog that lets the user choose a font
  69  *@ATK_ROLE_FRAME: A top level window with a title bar, border, menubar, etc.
  70  *@ATK_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of all panes beneath it
  71  *@ATK_ROLE_HTML_CONTAINER: A document container for HTML, whose children represent the document content
  72  *@ATK_ROLE_ICON: A small fixed size picture, typically used to decorate components
  73  *@ATK_ROLE_IMAGE: An object whose primary purpose is to display an image
  74  *@ATK_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop pane
  75  *@ATK_ROLE_LABEL: An object used to present an icon or short string in an interface
  76  *@ATK_ROLE_LAYERED_PANE: A specialized pane that allows its children to be drawn in layers, providing a form of stacking order
  77  *@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
  78  *@ATK_ROLE_LIST_ITEM: An object that represents an element of a list
  79  *@ATK_ROLE_MENU: An object usually found inside a menu bar that contains a list of actions the user can choose from
  80  *@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
  81  *@ATK_ROLE_MENU_ITEM: An object usually contained in a menu that presents an action the user can choose
  82  *@ATK_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a DIALOG
  83  *@ATK_ROLE_PAGE_TAB: An object that is a child of a page tab list
  84  *@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
  85  *@ATK_ROLE_PANEL: A generic container that is often used to group objects
  86  *@ATK_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places where the text content is not shown visibly to the user
  87  *@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
  88  *@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
  89  *@ATK_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the application to do something
  90  *@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
  91  *@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
  92  *@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
  93  *@ATK_ROLE_ROW_HEADER: The header for a row of data
  94  *@ATK_ROLE_SCROLL_BAR: An object usually used to allow a user to incrementally view a large amount of data.
  95  *@ATK_ROLE_SCROLL_PANE: An object that allows a user to incrementally view a large amount of information
  96  *@ATK_ROLE_SEPARATOR: An object usually contained in a menu to provide a visible and logical separation of the contents in a menu
  97  *@ATK_ROLE_SLIDER: An object that allows the user to select from a bounded range
  98  *@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
  99  *@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
 100  *@ATK_ROLE_STATUSBAR: An object which reports messages of minor importance to the user
 101  *@ATK_ROLE_TABLE: An object used to represent information in terms of rows and columns
 102  *@ATK_ROLE_TABLE_CELL: A cell in a table
 103  *@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
 104  *@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
 105  *@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu
 106  *@ATK_ROLE_TERMINAL: An object that represents an accessible terminal.  @Since: ATK-0.6
 107  *@ATK_ROLE_TEXT: An object that presents text to the user
 108  *@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
 109  *@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
 110  *@ATK_ROLE_TOOL_TIP: An object that provides information about another object
 111  *@ATK_ROLE_TREE: An object used to represent hierarchical information to the user
 112  *@ATK_ROLE_TREE_TABLE: An object capable of expanding and collapsing rows as well as showing multiple columns of data.   @Since: ATK-0.7
 113  *@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
 114  *@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane
 115  *@ATK_ROLE_WINDOW: A top level window with no title or border.
 116  *@ATK_ROLE_HEADER: An object that serves as a document header. @Since: ATK-1.1.1
 117  *@ATK_ROLE_FOOTER: An object that serves as a document footer.  @Since: ATK-1.1.1
 118  *@ATK_ROLE_PARAGRAPH: An object which is contains a paragraph of text content.   @Since: ATK-1.1.1
 119  *@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
 120  *@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
 121  *@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
 122  *@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar.  @Since: ATK-1.5
 123  *@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
 124  *@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
 125  *@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
 126  *@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
 127  *@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
 128  *@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.
 129  *@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
 130  *@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
 131  *@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
 132  *@ATK_ROLE_FORM: The object is a container for form controls, for instance as part of a
 133  * web form or user-input form within a document.  This role is primarily a tag/convenience for
 134  * clients when navigating complex documents, it is not expected that ordinary GUI containers will
 135  * always have ATK_ROLE_FORM. @Since: ATK-1.12.0
 136  *@ATK_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a
 137  * hypertext document.  Such objects are distinct from 'inline'
 138  * content which may also use the Hypertext/Hyperlink interfaces
 139  * to indicate the range/location within a text object where
 140  * an inline or embedded object lies.  @Since: ATK-1.12.1
 141  *@ATK_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
 142  * which is used to allow composition or input of a 'complex character',
 143  * in other words it is an "input method window." @Since: ATK-1.12.1
 144  *@ATK_ROLE_TABLE_ROW: A row in a table.  @Since: ATK-2.1.0
 145  *@ATK_ROLE_TREE_ITEM: An object that represents an element of a tree.  @Since: ATK-2.1.0
 146  *@ATK_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a spreadsheet.  @Since: ATK-2.1.0
 147  *@ATK_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a presentation or slide content.  @Since: ATK-2.1.0
 148  *@ATK_ROLE_DOCUMENT_TEXT: A document frame which contains textual content, such as found in a word processing application.  @Since: ATK-2.1.0
 149  *@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
 150  *@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
 151  *@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
 152  *@ATK_ROLE_LIST_BOX: A non-collapsible list of choices the user can select from. @Since: ATK-2.1.0
 153  *@ATK_ROLE_GROUPING: A group of related widgets. This group typically has a label. @Since: ATK-2.1.0
 154  *@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
 155  *@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
 156  *@ATK_ROLE_INFO_BAR: An object designed to present a message to the user within an existing window. @Since: ATK-2.1.0
 157  *@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
 158  *@ATK_ROLE_TITLE_BAR: A bar that serves as the title of a window or a
 159  * dialog. @Since: ATK-2.12
 160  *@ATK_ROLE_BLOCK_QUOTE: An object which contains a text section
 161  * that is quoted from another source. @Since: ATK-2.12
 162  *@ATK_ROLE_AUDIO: An object which represents an audio element. @Since: ATK-2.12
 163  *@ATK_ROLE_VIDEO: An object which represents a video element. @Since: ATK-2.12
 164  *@ATK_ROLE_DEFINITION: A definition of a term or concept. @Since: ATK-2.12
 165  *@ATK_ROLE_ARTICLE: A section of a page that consists of a
 166  * composition that forms an independent part of a document, page, or
 167  * site. Examples: A blog entry, a news story, a forum post. @Since:
 168  * ATK-2.12
 169  *@ATK_ROLE_LANDMARK: A region of a web page intended as a
 170  * navigational landmark. This is designed to allow Assistive
 171  * Technologies to provide quick navigation among key regions within a
 172  * document. @Since: ATK-2.12
 173  *@ATK_ROLE_LOG: A text widget or container holding log content, such
 174  * as chat history and error logs. In this role there is a
 175  * relationship between the arrival of new items in the log and the
 176  * reading order. The log contains a meaningful sequence and new
 177  * information is added only to the end of the log, not at arbitrary
 178  * points. @Since: ATK-2.12
 179  *@ATK_ROLE_MARQUEE: A container where non-essential information
 180  * changes frequently. Common usages of marquee include stock tickers
 181  * and ad banners. The primary difference between a marquee and a log
 182  * is that logs usually have a meaningful order or sequence of
 183  * important content changes. @Since: ATK-2.12
 184  *@ATK_ROLE_MATH: A text widget or container that holds a mathematical
 185  * expression. @Since: ATK-2.12
 186  *@ATK_ROLE_RATING: A widget whose purpose is to display a rating,
 187  * such as the number of stars associated with a song in a media
 188  * player. Objects of this role should also implement
 189  * AtkValue. @Since: ATK-2.12
 190  *@ATK_ROLE_TIMER: An object containing a numerical counter which
 191  * indicates an amount of elapsed time from a start point, or the time
 192  * remaining until an end point. @Since: ATK-2.12
 193  *@ATK_ROLE_DESCRIPTION_LIST: An object that represents a list of
 194  * term-value groups. A term-value group represents a individual
 195  * description and consist of one or more names
 196  * (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values
 197  * (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be
 198  * more than one group with the same term name. @Since: ATK-2.12
 199  *@ATK_ROLE_DESCRIPTION_TERM: An object that represents the term, or
 200  * name, part of a term-description group in a description
 201  * list. @Since: ATK-2.12
 202  *@ATK_ROLE_DESCRIPTION_VALUE: An object that represents the
 203  * description, definition or value of a term-description group in a
 204  * description list. The values within a group are alternatives,
 205  * meaning that you can have several ATK_ROLE_DESCRIPTION_VALUE for a
 206  * given ATK_ROLE_DESCRIPTION_TERM. @Since: ATK-2.12
 207  *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration
 208  *
 209  * Describes the role of an object
 210  *
 211  * These are the built-in enumerated roles that UI components can have in
 212  * ATK.  Other roles may be added at runtime, so an AtkRole >=
 213  * ATK_ROLE_LAST_DEFINED is not necessarily an error.
 214  **/
 215 typedef enum
 216 {
 217   ATK_ROLE_INVALID = 0,
 218   ATK_ROLE_ACCEL_LABEL,      /*<nick=accelerator-label>*/
 219   ATK_ROLE_ALERT,
 220   ATK_ROLE_ANIMATION,
 221   ATK_ROLE_ARROW,
 222   ATK_ROLE_CALENDAR,
 223   ATK_ROLE_CANVAS,
 224   ATK_ROLE_CHECK_BOX,
 225   ATK_ROLE_CHECK_MENU_ITEM,
 226   ATK_ROLE_COLOR_CHOOSER,
 227   ATK_ROLE_COLUMN_HEADER,
 228   ATK_ROLE_COMBO_BOX,
 229   ATK_ROLE_DATE_EDITOR,
 230   ATK_ROLE_DESKTOP_ICON,
 231   ATK_ROLE_DESKTOP_FRAME,
 232   ATK_ROLE_DIAL,
 233   ATK_ROLE_DIALOG,
 234   ATK_ROLE_DIRECTORY_PANE,
 235   ATK_ROLE_DRAWING_AREA,
 236   ATK_ROLE_FILE_CHOOSER,
 237   ATK_ROLE_FILLER,
 238   ATK_ROLE_FONT_CHOOSER,
 239   ATK_ROLE_FRAME,
 240   ATK_ROLE_GLASS_PANE,
 241   ATK_ROLE_HTML_CONTAINER,
 242   ATK_ROLE_ICON,
 243   ATK_ROLE_IMAGE,
 244   ATK_ROLE_INTERNAL_FRAME,
 245   ATK_ROLE_LABEL,
 246   ATK_ROLE_LAYERED_PANE,
 247   ATK_ROLE_LIST,
 248   ATK_ROLE_LIST_ITEM,
 249   ATK_ROLE_MENU,
 250   ATK_ROLE_MENU_BAR,
 251   ATK_ROLE_MENU_ITEM,
 252   ATK_ROLE_OPTION_PANE,
 253   ATK_ROLE_PAGE_TAB,
 254   ATK_ROLE_PAGE_TAB_LIST,
 255   ATK_ROLE_PANEL,
 256   ATK_ROLE_PASSWORD_TEXT,
 257   ATK_ROLE_POPUP_MENU,
 258   ATK_ROLE_PROGRESS_BAR,
 259   ATK_ROLE_PUSH_BUTTON,
 260   ATK_ROLE_RADIO_BUTTON,
 261   ATK_ROLE_RADIO_MENU_ITEM,
 262   ATK_ROLE_ROOT_PANE,
 263   ATK_ROLE_ROW_HEADER,
 264   ATK_ROLE_SCROLL_BAR,
 265   ATK_ROLE_SCROLL_PANE,
 266   ATK_ROLE_SEPARATOR,
 267   ATK_ROLE_SLIDER,
 268   ATK_ROLE_SPLIT_PANE,
 269   ATK_ROLE_SPIN_BUTTON,
 270   ATK_ROLE_STATUSBAR,
 271   ATK_ROLE_TABLE,
 272   ATK_ROLE_TABLE_CELL,
 273   ATK_ROLE_TABLE_COLUMN_HEADER,
 274   ATK_ROLE_TABLE_ROW_HEADER,
 275   ATK_ROLE_TEAR_OFF_MENU_ITEM,
 276   ATK_ROLE_TERMINAL,
 277   ATK_ROLE_TEXT,
 278   ATK_ROLE_TOGGLE_BUTTON,
 279   ATK_ROLE_TOOL_BAR,
 280   ATK_ROLE_TOOL_TIP,
 281   ATK_ROLE_TREE,
 282   ATK_ROLE_TREE_TABLE,
 283   ATK_ROLE_UNKNOWN,
 284   ATK_ROLE_VIEWPORT,
 285   ATK_ROLE_WINDOW,
 286   ATK_ROLE_HEADER,
 287   ATK_ROLE_FOOTER,
 288   ATK_ROLE_PARAGRAPH,
 289   ATK_ROLE_RULER,
 290   ATK_ROLE_APPLICATION,
 291   ATK_ROLE_AUTOCOMPLETE,
 292   ATK_ROLE_EDITBAR,          /*<nick=edit-bar>*/
 293   ATK_ROLE_EMBEDDED,
 294   ATK_ROLE_ENTRY,
 295   ATK_ROLE_CHART,
 296   ATK_ROLE_CAPTION,
 297   ATK_ROLE_DOCUMENT_FRAME,
 298   ATK_ROLE_HEADING,
 299   ATK_ROLE_PAGE,
 300   ATK_ROLE_SECTION,
 301   ATK_ROLE_REDUNDANT_OBJECT,
 302   ATK_ROLE_FORM,
 303   ATK_ROLE_LINK,
 304   ATK_ROLE_INPUT_METHOD_WINDOW,
 305   ATK_ROLE_TABLE_ROW,
 306   ATK_ROLE_TREE_ITEM,
 307   ATK_ROLE_DOCUMENT_SPREADSHEET,
 308   ATK_ROLE_DOCUMENT_PRESENTATION,
 309   ATK_ROLE_DOCUMENT_TEXT,
 310   ATK_ROLE_DOCUMENT_WEB,
 311   ATK_ROLE_DOCUMENT_EMAIL,
 312   ATK_ROLE_COMMENT,
 313   ATK_ROLE_LIST_BOX,
 314   ATK_ROLE_GROUPING,
 315   ATK_ROLE_IMAGE_MAP,
 316   ATK_ROLE_NOTIFICATION,
 317   ATK_ROLE_INFO_BAR,
 318   ATK_ROLE_LEVEL_BAR,
 319   ATK_ROLE_TITLE_BAR,
 320   ATK_ROLE_BLOCK_QUOTE,
 321   ATK_ROLE_AUDIO,
 322   ATK_ROLE_VIDEO,
 323   ATK_ROLE_DEFINITION,
 324   ATK_ROLE_ARTICLE,
 325   ATK_ROLE_LANDMARK,
 326   ATK_ROLE_LOG,
 327   ATK_ROLE_MARQUEE,
 328   ATK_ROLE_MATH,
 329   ATK_ROLE_RATING,
 330   ATK_ROLE_TIMER,
 331   ATK_ROLE_DESCRIPTION_LIST,
 332   ATK_ROLE_DESCRIPTION_TERM,
 333   ATK_ROLE_DESCRIPTION_VALUE,
 334   ATK_ROLE_LAST_DEFINED
 335 } AtkRole;
 336
 337 /**
 338  *AtkLayer:
 339  *@ATK_LAYER_INVALID: The object does not have a layer
 340  *@ATK_LAYER_BACKGROUND: This layer is reserved for the desktop background
 341  *@ATK_LAYER_CANVAS: This layer is used for Canvas components
 342  *@ATK_LAYER_WIDGET: This layer is normally used for components
 343  *@ATK_LAYER_MDI: This layer is used for layered components
 344  *@ATK_LAYER_POPUP: This layer is used for popup components, such as menus
 345  *@ATK_LAYER_OVERLAY: This layer is reserved for future use.
 346  *@ATK_LAYER_WINDOW: This layer is used for toplevel windows.
 347  *
 348  * Describes the layer of a component
 349  *
 350  * These enumerated "layer values" are used when determining which UI
 351  * rendering layer a component is drawn into, which can help in making
 352  * determinations of when components occlude one another.
 353  **/
 354 typedef enum
 355 {
 356   ATK_LAYER_INVALID,
 357   ATK_LAYER_BACKGROUND,
 358   ATK_LAYER_CANVAS,
 359   ATK_LAYER_WIDGET,
 360   ATK_LAYER_MDI,
 361   ATK_LAYER_POPUP,
 362   ATK_LAYER_OVERLAY,
 363   ATK_LAYER_WINDOW
 364 } AtkLayer;
 365
 366 /**
 367  * AtkAttributeSet:
 368  *
 369  * This is a singly-linked list (a #GSList) of #AtkAttribute. It is
 370  * used by atk_text_get_run_attributes(),
 371  * atk_text_get_default_attributes(),
 372  * atk_editable_text_set_run_attributes(),
 373  * atk_document_get_attributes() and atk_object_get_attributes()
 374  **/
 375 typedef GSList AtkAttributeSet;
 376
 377 /**
 378  * AtkAttribute:
 379  * @name: The attribute name.
 380  * @value: the value of the attribute, represented as a string.
 381  *
 382  * AtkAttribute is a string name/value pair representing a generic
 383  * attribute. This can be used to expose additional information from
 384  * an accessible object as a whole (see atk_object_get_attributes())
 385  * or an document (see atk_document_get_attributes()). In the case of
 386  * text attributes (see atk_text_get_default_attributes()),
 387  * #AtkTextAttribute enum defines all the possible text attribute
 388  * names. You can use atk_text_attribute_get_name() to get the string
 389  * name from the enum value. See also atk_text_attribute_for_name()
 390  * and atk_text_attribute_get_value() for more information.
 391  *
 392  * A string name/value pair representing a generic attribute.
 393  **/
 394 typedef struct _AtkAttribute AtkAttribute;
 395
 396 struct _AtkAttribute {
 397   gchar* name;
 398   gchar* value;
 399 };
 400
 401 #define ATK_TYPE_OBJECT                           (atk_object_get_type ())
 402 #define ATK_OBJECT(obj)                           (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_OBJECT, AtkObject))
 403 #define ATK_OBJECT_CLASS(klass)                   (G_TYPE_CHECK_CLASS_CAST ((klass), ATK_TYPE_OBJECT, AtkObjectClass))
 404 #define ATK_IS_OBJECT(obj)                        (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_OBJECT))
 405 #define ATK_IS_OBJECT_CLASS(klass)                (G_TYPE_CHECK_CLASS_TYPE ((klass), ATK_TYPE_OBJECT))
 406 #define ATK_OBJECT_GET_CLASS(obj)                 (G_TYPE_INSTANCE_GET_CLASS ((obj), ATK_TYPE_OBJECT, AtkObjectClass))
 407
 408 #define ATK_TYPE_IMPLEMENTOR                      (atk_implementor_get_type ())
 409 #define ATK_IS_IMPLEMENTOR(obj)                   G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_IMPLEMENTOR)
 410 #define ATK_IMPLEMENTOR(obj)                      G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementor)
 411 #define ATK_IMPLEMENTOR_GET_IFACE(obj)            (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_IMPLEMENTOR, AtkImplementorIface))
 412
 413
 414 typedef struct _AtkImplementor            AtkImplementor; /* dummy typedef */
 415 typedef struct _AtkImplementorIface       AtkImplementorIface;
 416
 417
 418 typedef struct _AtkObject                 AtkObject;
 419 typedef struct _AtkObjectClass            AtkObjectClass;
 420 typedef struct _AtkRelationSet            AtkRelationSet;
 421 typedef struct _AtkStateSet               AtkStateSet;
 422
 423 /**
 424  * AtkPropertyValues:
 425  * @property_name: The name of the ATK property which has changed.
 426  * @old_value: NULL. This field is not used anymore.
 427  * @new_value: The new value of the named property.
 428  *
 429  * Note: @old_value field of #AtkPropertyValues will not contain a
 430  * valid value. This is a field defined with the purpose of contain
 431  * the previous value of the property, but is not used anymore.
 432  *
 433  **/
 434 struct _AtkPropertyValues
 435 {
 436   const gchar  *property_name;
 437   GValue old_value;
 438   GValue new_value;
 439 };
 440
 441 typedef struct _AtkPropertyValues        AtkPropertyValues;
 442
 443 /**
 444  * AtkFunction:
 445  * @user_data: custom data defined by the user
 446  *
 447  * An AtkFunction is a function definition used for padding which has
 448  * been added to class and interface structures to allow for expansion
 449  * in the future.
 450  *
 451  * Returns: not used
 452  */
 453 typedef gboolean (*AtkFunction)          (gpointer user_data);
 454 /*
 455  * For most properties the old_value field of AtkPropertyValues will
 456  * not contain a valid value.
 457  *
 458  * Currently, the only property for which old_value is used is
 459  * accessible-state; for instance if there is a focus state the
 460  * property change handler will be called for the object which lost the focus
 461  * with the old_value containing an AtkState value corresponding to focused
 462  * and the property change handler will be called for the object which
 463  * received the focus with the new_value containing an AtkState value
 464  * corresponding to focused.
 465  */
 466
 467 /**
 468  * AtkPropertyChangeHandler:
 469  * @obj: atkobject which property changes
 470  * @vals: values changed
 471  *
 472  * An AtkPropertyChangeHandler is a function which is executed when an
 473  * AtkObject's property changes value. It is specified in a call to
 474  * atk_object_connect_property_change_handler().
 475  *
 476  * Deprecated: Since 2.12.
 477  */
 478 typedef void (*AtkPropertyChangeHandler) (AtkObject* obj, AtkPropertyValues* vals);
 479
 480
 481 struct _AtkObject
 482 {
 483   GObject parent;
 484
 485   gchar *description;
 486   gchar *name;
 487   AtkObject *accessible_parent;
 488   AtkRole role;
 489   AtkRelationSet *relation_set;
 490   AtkLayer layer;
 491 };
 492
 493
 494 /**
 495  * AtkObjectClass:
 496  * @connect_property_change_handler: specifies a function to be called
 497  *   when a property changes value. This virtual function is
 498  *   deprecated since 2.12 and it should not be overriden. Connect
 499  *   directly to property-change or notify signal instead.
 500  * @remove_property_change_handler: removes a property changed handler
 501  *   as returned by @connect_property_change_handler. This virtual
 502  *   function is deprecated sice 2.12 and it should not be overriden.
 503  * @focus_event: The signal handler which is executed when there is a
 504  *   focus event for an object. This virtual function is deprecated
 505  *   since 2.9.4 and it should not be overriden. Use
 506  *   state-changed:focused signal instead.
 507  */
 508 struct _AtkObjectClass
 509 {
 510   GObjectClass parent;
 511
 512   /*
 513    * Gets the accessible name of the object
 514    */
 515   const gchar*             (* get_name)            (AtkObject                *accessible);
 516   /*
 517    * Gets the accessible description of the object
 518    */
 519   const gchar*             (* get_description)     (AtkObject                *accessible);
 520   /*
 521    * Gets the accessible parent of the object
 522    */
 523   AtkObject*               (*get_parent)           (AtkObject                *accessible);
 524
 525   /*
 526    * Gets the number of accessible children of the object
 527    */
 528   gint                    (* get_n_children)       (AtkObject                *accessible);
 529   /*
 530    * Returns a reference to the specified accessible child of the object.
 531    * The accessible children are 0-based so the first accessible child is
 532    * at index 0, the second at index 1 and so on.
 533    */
 534   AtkObject*              (* ref_child)            (AtkObject                *accessible,
 535                                                     gint                      i);
 536   /*
 537    * Gets the 0-based index of this object in its parent; returns -1 if the
 538    * object does not have an accessible parent.
 539    */
 540   gint                    (* get_index_in_parent) (AtkObject                 *accessible);
 541   /*
 542    * Gets the RelationSet associated with the object
 543    */
 544   AtkRelationSet*         (* ref_relation_set)    (AtkObject                 *accessible);
 545   /*
 546    * Gets the role of the object
 547    */
 548   AtkRole                 (* get_role)            (AtkObject                 *accessible);
 549   AtkLayer                (* get_layer)           (AtkObject                 *accessible);
 550   gint                    (* get_mdi_zorder)      (AtkObject                 *accessible);
 551   /*
 552    * Gets the state set of the object
 553    */
 554   AtkStateSet*            (* ref_state_set)       (AtkObject                 *accessible);
 555   /*
 556    * Sets the accessible name of the object
 557    */
 558   void                    (* set_name)            (AtkObject                 *accessible,
 559                                                    const gchar               *name);
 560   /*
 561    * Sets the accessible description of the object
 562    */
 563   void                    (* set_description)     (AtkObject                 *accessible,
 564                                                    const gchar               *description);
 565   /*
 566    * Sets the accessible parent of the object
 567    */
 568   void                    (* set_parent)          (AtkObject                 *accessible,
 569                                                    AtkObject                 *parent);
 570   /*
 571    * Sets the accessible role of the object
 572    */
 573   void                    (* set_role)            (AtkObject                 *accessible,
 574                                                    AtkRole                   role);
 575   /*
 576    * Specifies a function to be called when a property changes value
 577    */
 578 guint                     (* connect_property_change_handler)    (AtkObject
 579                  *accessible,
 580                                                                   AtkPropertyChangeHandler       *handler);
 581   /*
 582    * Removes a property change handler which was specified using
 583    * connect_property_change_handler
 584    */
 585 void                      (* remove_property_change_handler)     (AtkObject
 586                 *accessible,
 587                                                                   guint
 588                 handler_id);
 589 void                      (* initialize)                         (AtkObject                     *accessible,
 590                                                                   gpointer                      data);
 591   /*
 592    * The signal handler which is executed when there is a change in the
 593    * children of the object
 594    */
 595   void                    (* children_changed)    (AtkObject                  *accessible,
 596                                                    guint                      change_index,
 597                                                    gpointer                   changed_child);
 598   /*
 599    * The signal handler which is executed  when there is a focus event
 600    * for an object.
 601    */
 602   void                    (* focus_event)         (AtkObject                  *accessible,
 603                                                    gboolean                   focus_in);
 604   /*
 605    * The signal handler which is executed  when there is a property_change
 606    * signal for an object.
 607    */
 608   void                    (* property_change)     (AtkObject                  *accessible,
 609                                                    AtkPropertyValues          *values);
 610   /*
 611    * The signal handler which is executed  when there is a state_change
 612    * signal for an object.
 613    */
 614   void                    (* state_change)        (AtkObject                  *accessible,
 615                                                    const gchar                *name,
 616                                                    gboolean                   state_set);
 617   /*
 618    * The signal handler which is executed when there is a change in the
 619    * visible data for an object
 620    */
 621   void                    (*visible_data_changed) (AtkObject                  *accessible);
 622
 623   /*
 624    * The signal handler which is executed when there is a change in the
 625    * 'active' child or children of the object, for instance when
 626    * interior focus changes in a table or list.  This signal should be emitted
 627    * by objects whose state includes ATK_STATE_MANAGES_DESCENDANTS.
 628    */
 629   void                    (*active_descendant_changed) (AtkObject                  *accessible,
 630                                                         gpointer                   *child);
 631
 632   /*
 633    * Gets a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of name-value pairs.
 634    * Since ATK 1.12
 635    */
 636   AtkAttributeSet*        (*get_attributes)            (AtkObject                  *accessible);
 637
 638   const gchar*            (*get_object_locale)         (AtkObject                  *accessible);
 639
 640   AtkFunction             pad1;
 641 };
 642
 643 ATK_AVAILABLE_IN_ALL
 644 GType            atk_object_get_type   (void);
 645
 646 /**
 647  * AtkImplementorIface:
 648  *
 649  * The AtkImplementor interface is implemented by objects for which
 650  * AtkObject peers may be obtained via calls to
 651  * iface->(ref_accessible)(implementor);
 652  */
 653 struct _AtkImplementorIface
 654 {
 655   GTypeInterface parent;
 656
 657   AtkObject*   (*ref_accessible) (AtkImplementor *implementor);
 658 };
 659
 660 ATK_AVAILABLE_IN_ALL
 661 GType atk_implementor_get_type (void);
 662 ATK_AVAILABLE_IN_ALL
 663 AtkObject*              atk_implementor_ref_accessible            (AtkImplementor *implementor);
 664
 665 /*
 666  * Properties directly supported by AtkObject
 667  */
 668
 669 ATK_AVAILABLE_IN_ALL
 670 const gchar*            atk_object_get_name                       (AtkObject *accessible);
 671 ATK_AVAILABLE_IN_ALL
 672 const gchar*            atk_object_get_description                (AtkObject *accessible);
 673 ATK_AVAILABLE_IN_ALL
 674 AtkObject*              atk_object_get_parent                     (AtkObject *accessible);
 675 ATK_AVAILABLE_IN_ALL
 676 AtkObject*              atk_object_peek_parent                    (AtkObject *accessible);
 677 ATK_AVAILABLE_IN_ALL
 678 gint                    atk_object_get_n_accessible_children      (AtkObject *accessible);
 679 ATK_AVAILABLE_IN_ALL
 680 AtkObject*              atk_object_ref_accessible_child           (AtkObject *accessible,
 681                                                                    gint        i);
 682 ATK_AVAILABLE_IN_ALL
 683 AtkRelationSet*         atk_object_ref_relation_set               (AtkObject *accessible);
 684 ATK_AVAILABLE_IN_ALL
 685 AtkRole                 atk_object_get_role                       (AtkObject *accessible);
 686
 687 ATK_DEPRECATED_FOR(atk_component_get_layer)
 688 AtkLayer                atk_object_get_layer                      (AtkObject *accessible);
 689 ATK_DEPRECATED_FOR(atk_component_get_mdi_zorder)
 690 gint                    atk_object_get_mdi_zorder                 (AtkObject *accessible);
 691
 692 ATK_AVAILABLE_IN_ALL
 693 AtkAttributeSet*        atk_object_get_attributes                 (AtkObject *accessible);
 694 ATK_AVAILABLE_IN_ALL
 695 AtkStateSet*            atk_object_ref_state_set                  (AtkObject *accessible);
 696 ATK_AVAILABLE_IN_ALL
 697 gint                    atk_object_get_index_in_parent            (AtkObject *accessible);
 698 ATK_AVAILABLE_IN_ALL
 699 void                    atk_object_set_name                       (AtkObject *accessible,
 700                                                                    const gchar *name);
 701 ATK_AVAILABLE_IN_ALL
 702 void                    atk_object_set_description                (AtkObject *accessible,
 703                                                                    const gchar *description);
 704 ATK_AVAILABLE_IN_ALL
 705 void                    atk_object_set_parent                     (AtkObject *accessible,
 706                                                                    AtkObject *parent);
 707 ATK_AVAILABLE_IN_ALL
 708 void                    atk_object_set_role                       (AtkObject *accessible,
 709                                                                    AtkRole   role);
 710
 711
 712 ATK_DEPRECATED_IN_2_12
 713 guint                atk_object_connect_property_change_handler  (AtkObject                      *accessible,
 714                                                                   AtkPropertyChangeHandler       *handler);
 715 ATK_DEPRECATED_IN_2_12
 716 void                 atk_object_remove_property_change_handler   (AtkObject                      *accessible,
 717                                                                   guint                          handler_id);
 718
 719 ATK_AVAILABLE_IN_ALL
 720 void                 atk_object_notify_state_change              (AtkObject                      *accessible,
 721                                                                   AtkState                       state,
 722                                                                   gboolean                       value);
 723 ATK_AVAILABLE_IN_ALL
 724 void                 atk_object_initialize                       (AtkObject                     *accessible,
 725                                                                   gpointer                      data);
 726
 727 ATK_AVAILABLE_IN_ALL
 728 const gchar*          atk_role_get_name      (AtkRole         role);
 729 ATK_AVAILABLE_IN_ALL
 730 AtkRole               atk_role_for_name      (const gchar     *name);
 731
 732
 733 /* NEW in 1.1: convenience API */
 734 ATK_AVAILABLE_IN_ALL
 735 gboolean              atk_object_add_relationship              (AtkObject      *object,
 736                                                                 AtkRelationType relationship,
 737                                                                 AtkObject      *target);
 738 ATK_AVAILABLE_IN_ALL
 739 gboolean              atk_object_remove_relationship           (AtkObject      *object,
 740                                                                 AtkRelationType relationship,
 741                                                                 AtkObject      *target);
 742 ATK_AVAILABLE_IN_ALL
 743 const gchar*          atk_role_get_localized_name              (AtkRole     role);
 744 ATK_DEPRECATED_IN_2_12
 745 AtkRole               atk_role_register                        (const gchar *name);
 746 ATK_AVAILABLE_IN_2_8
 747 const gchar*          atk_object_get_object_locale             (AtkObject   *accessible);
 748
 749 G_END_DECLS
 750
 751 #endif /* __ATK_OBJECT_H__ */