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