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