atspi/atspi-constants.h

   1 /* TODO: Auto-generate this file again
   2
   3
   4
   5  !\mainpage AT-SPI Interfaces and Subinterfaces
   6
   7   This is the main documentation page for the
   8   Assistive Technology Service Provider Interface (AT-SPI).
   9
  10   \section apps Applications and Interface Components
  11   Namespace Accessibility includes service APIs implemented by
  12   participating applications and their user interface components:\n\n
  13   Accessibility::Accessible\n
  14   Accessibility::Application\n
  15   Accessibility::Desktop\n
  16   Accessibility::Collecgtion\n
  17   Accessibility::Component\n
  18   Accessibility::Hypertext\n
  19   Accessibility::Image\n
  20   Accessibility::Selection\n
  21   Accessibility::Table\n
  22   Accessibility::Text\n
  23   Accessibility::EditableText\n
  24   Accessibility::Value
  25
  26   \section types Enumerated Types
  27   Accessibility defines a number of key enumerated types, including:\n\n
  28   Accessibility::RelationType\n
  29   Accessibility::Role\n
  30   Accessibility::StateType\n
  31   Accessibility::Event\n
  32   Accessibility::EventDetails \n
  33
  34   \section Registry
  35   Accessibility also includes Accessibility::Registry,
  36   which is the service used by assistive technologies and related
  37   AT-SPI clients to register interest in certain classes of events,
  38   enumerate the currently available desktop and application list,
  39   and to synthesize certain kinds of device events.
  40
  41   \section listeners Event Listener Interfaces
  42   Accessibility::EventListener\n
  43   Accessibility::DeviceEventListener
  44
  45   \section helpers Helper Interfaces
  46
  47   The following interfaces may be implemented by assistive technologies
  48   themselves, in order to export their services in a consistent manner or
  49   in order to interoperate with other applications or desktop services.\n
  50
  51   Accessibility::LoginHelper : Implemented by adaptive technologies which
  52   need to participate in user-authentication or login activities, and which
  53   therefore may need negotiation with authentication agents or processes.\n
  54
  55   Accessibility::Selector [NEW]: Implemented by user agents or assistive
  56   technologies which export lists of choices from which the end-user is
  57   expected to make selections.  Useful for various types of remote
  58   activation or intercommunication between multiple ATs.
  59
  60  */
  61
  62 #ifndef _ATSPI_CONSTANTS_H_
  63 #define _ATSPI_CONSTANTS_H_
  64 #ifdef __cplusplus
  65 extern "C" {
  66 #endif
  67
  68 /**
  69  * AtspiLocaleType:
  70  * @ATSPI_LOCALE_TYPE_MESSAGES: For localizable natural-language messages.
  71  * @ATSPI_LOCALE_TYPE_COLLATE: For regular expression matching and string
  72  * collation.
  73  * @ATSPI_LOCALE_TYPE_CTYPE: For regular expression matching, character
  74  * classification, conversion, case-sensitive comparison, and wide character
  75  * functions.
  76  * @ATSPI_LOCALE_TYPE_MONETARY: For monetary formatting.
  77  * @ATSPI_LOCALE_TYPE_NUMERIC: For number formatting (such as the decimal
  78  * point and the thousands separator).
  79  * @ATSPI_LOCALE_TYPE_TIME: For time and date formatting.
  80  *
  81  * Used by interfaces #AtspiText and #AtspiDocument, this
  82  * enumeration corresponds to the POSIX 'setlocale' enum values.
  83  *
  84  * Bitfield/set of flags generated from the AT-SPI specification.
  85  **/
  86 typedef enum {
  87     ATSPI_LOCALE_TYPE_MESSAGES,
  88     ATSPI_LOCALE_TYPE_COLLATE,
  89     ATSPI_LOCALE_TYPE_CTYPE,
  90     ATSPI_LOCALE_TYPE_MONETARY,
  91     ATSPI_LOCALE_TYPE_NUMERIC,
  92     ATSPI_LOCALE_TYPE_TIME,
  93 } AtspiLocaleType;
  94
  95 /**
  96  * ATSPI_LOCALE_TYPE_COUNT:
  97  *
  98  * One higher than the highest valid value of #AtspiLocaleType.
  99  **/
 100 #define ATSPI_LOCALE_TYPE _COUNT(5+1)
 101
 102 /**
 103  * AtspiCoordType:
 104  * @ATSPI_COORD_TYPE_SCREEN: Specifies xy coordinates relative to the screen.
 105  * @ATSPI_COORD_TYPE_WINDOW: Specifies xy coordinates relative to the widget's
 106  * top-level window.
 107  *
 108  * Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces
 109  * to specify whether coordinates are relative to the window or the screen.
 110  *
 111  * Bitfield/set of flags generated from the AT-SPI specification.
 112  **/
 113 typedef enum {
 114     ATSPI_COORD_TYPE_SCREEN,
 115     ATSPI_COORD_TYPE_WINDOW,
 116 } AtspiCoordType;
 117
 118 /**
 119  * ATSPI_COORD_TYPE_COUNT:
 120  *
 121  * One higher than the highest valid value of #AtspiCoordType.
 122  **/
 123 #define ATSPI_COORD_TYPE_COUNT (1+1)
 124
 125 /**
 126  * AtspiCollectionSortOrder:
 127  * @ATSPI_Collection_SORT_ORDER_INVALID:
 128  * @ATSPI_Collection_SORT_ORDER_CANONICAL:
 129  * @ATSPI_Collection_SORT_ORDER_FLOW:
 130  * @ATSPI_Collection_SORT_ORDER_TAB:
 131  * @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL:
 132  * @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW:
 133  * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB:
 134  * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED:
 135  *
 136  * Enumeration used by interface #AtspiCollection to specify
 137  * the way #AtspiAccesible objects should be sorted.
 138  *
 139  * Bitfield/set of flags generated from the AT-SPI specification.
 140  **/
 141 typedef enum {
 142     ATSPI_Collection_SORT_ORDER_INVALID,
 143     ATSPI_Collection_SORT_ORDER_CANONICAL,
 144     ATSPI_Collection_SORT_ORDER_FLOW,
 145     ATSPI_Collection_SORT_ORDER_TAB,
 146     ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL,
 147     ATSPI_Collection_SORT_ORDER_REVERSE_FLOW,
 148     ATSPI_Collection_SORT_ORDER_REVERSE_TAB,
 149     ATSPI_Collection_SORT_ORDER_LAST_DEFINED,
 150 } AtspiCollectionSortOrder;
 151
 152 /**
 153  * ATSPI_SORTORDER_COUNT:
 154  *
 155  * One higher than the highest valid value of #AtspiCollectionSortOrder.
 156  */
 157 #define ATSPI_SORTORDER_COUNT (7+1)
 158
 159 /**
 160  * AtspiCollectionMatchType:
 161  * @ATSPI_Collection_MATCH_INVALID:
 162  * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met.
 163  * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met.
 164  * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met.
 165  * @ATSPI_Collection_MATCH_EMPTY: Same as @ATSPI_Collection_MATCH_ALL if
 166  * the criteria is non-empty; for empty criteria this rule requires returned
 167  * value to also have empty set.
 168  * @ATSPI_Collection_MATCH_LAST_DEFINED: Used only to determine the end of the
 169  * enumeration.
 170  *
 171  * Enumeration used by #AtspiMatchRule to specify
 172  * how to interpret #AtspiAccesible objects.
 173  *
 174  * Bitfield/set of flags generated from the AT-SPI specification.
 175  **/
 176 typedef enum {
 177     ATSPI_Collection_MATCH_INVALID,
 178     ATSPI_Collection_MATCH_ALL,
 179     ATSPI_Collection_MATCH_ANY,
 180     ATSPI_Collection_MATCH_NONE,
 181     ATSPI_Collection_MATCH_EMPTY,
 182     ATSPI_Collection_MATCH_LAST_DEFINED,
 183 } AtspiCollectionMatchType;
 184
 185 /**
 186  * ATSPI_MATCHTYPE_COUNT:
 187  *
 188  * One higher than the highest valid value of #AtspiCollectionMatchType.
 189  **/
 190 #define ATSPI_MATCHTYPES_COUNT (5+1)
 191
 192 /**
 193  * AtspiCollectionTreeTraversalType:
 194  * @ATSPI_Collection_TREE_RESTRICT_CHILDREN:
 195  * @ATSPI_Collection_TREE_RESTRICT_SIBLING:
 196  * @ATSPI_Collection_TREE_INORDER:
 197  * @ATSPI_Collection_TREE_LAST_DEFINED:
 198  *
 199  * Enumeration used by interface #AtspiCollection to specify
 200  * restrictions on #AtspiAccesible objects to be traversed.
 201  *
 202  * Bitfield/set of flags generated from the AT-SPI specification.
 203  **/
 204 typedef enum {
 205     ATSPI_Collection_TREE_RESTRICT_CHILDREN,
 206     ATSPI_Collection_TREE_RESTRICT_SIBLING,
 207     ATSPI_Collection_TREE_INORDER,
 208     ATSPI_Collection_TREE_LAST_DEFINED,
 209 } AtspiCollectionTreeTraversalType;
 210
 211 /**
 212  * ATSPI_TREETRAVERSALTYPE_COUNT:
 213  *
 214  * One higher than the highest valid value of
 215  * #AtspiCollection_TreeTraversalType.
 216  */
 217 #define ATSPI_TREETRAVERSALTYPE _COUNT(3+1)
 218
 219 /**
 220  * AtspiComponentLayer:
 221  * @ATSPI_LAYER_INVALID: Indicates an error condition or uninitialized value.
 222  * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything else
 223  * is painted.        The 'desktop background' is generally in this layer.
 224  * @ATSPI_LAYER_CANVAS: The 'background' layer for most content renderers and
 225  * UI #AtspiComponent containers.
 226  * @ATSPI_LAYER_WIDGET: The layer in which the majority of ordinary
 227  * 'foreground' widgets reside.
 228  * @ATSPI_LAYER_MDI: A special layer between @ATSPI_LAYER_CANVAS and
 229  * @ATSPI_LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames)
 230  * reside. See #atspi_component_get_mdi_z_order.
 231  * @ATSPI_LAYER_POPUP: A layer for popup window content, above
 232  * @ATSPI_LAYER_WIDGET.
 233  * @ATSPI_LAYER_OVERLAY: The topmost layer.
 234  * @ATSPI_LAYER_WINDOW: The layer in which a toplevel window background usually
 235  * resides.
 236  * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the
 237  * enumeration.
 238  *
 239  * The #AtspiComponentLayer of an #AtspiComponent instance indicates its
 240  * relative stacking order with respect to the onscreen visual representation
 241  * of the UI. #AtspiComponentLayer, in combination with #AtspiComponent bounds
 242  * information, can be used to compute the visibility of all or part of a
 243  * component.  This is important in programmatic determination of
 244  * region-of-interest for magnification, and in
 245  * flat screen review models of the screen, as well as
 246  * for other uses. Objects residing in two of the #AtspiComponentLayer
 247  * categories support further z-ordering information, with respect to their
 248  * peers in the same layer: namely, @ATSPI_LAYER_WINDOW and
 249  * @ATSPI_LAYER_MDI.  Relative stacking order for other objects within the
 250  * same layer is not available; the recommended heuristic is
 251  * first child paints first. In other words, assume that the
 252  * first siblings in the child list are subject to being overpainted by later
 253  * siblings if their bounds intersect. The order of layers, from bottom to top,
 254  *  is: @ATSPI_LAYER_BACKGROUND, @ATSPI_LAYER_WINDOW, @ATSPI_LAYER_MDI,
 255  * @ATSPI_LAYER_CANVAS, @ATSPI_LAYER_WIDGET, @ATSPI_LAYER_POPUP, and
 256  * @ATSPI_LAYER_OVERLAY.
 257  *
 258  * Bitfield/set of flags generated from the AT-SPI specification.
 259  */
 260 typedef enum {
 261     ATSPI_LAYER_INVALID,
 262     ATSPI_LAYER_BACKGROUND,
 263     ATSPI_LAYER_CANVAS,
 264     ATSPI_LAYER_WIDGET,
 265     ATSPI_LAYER_MDI,
 266     ATSPI_LAYER_POPUP,
 267     ATSPI_LAYER_OVERLAY,
 268     ATSPI_LAYER_WINDOW,
 269     ATSPI_LAYER_LAST_DEFINED,
 270 } AtspiComponentLayer;
 271
 272 /**
 273  * ATSPI_COMPONENTLAYER_COUNT:
 274  *
 275  * One higher than the highest valid value of #AtspiComponentLayer.
 276  **/
 277 #define ATSPI_COMPONENTLAYER_COUNT (8+1)
 278
 279 /**
 280  * AtspiTextBoundaryType:
 281  * @ATSPI_TEXT_BOUNDARY_CHAR: An #AtspiText instance is bounded by this
 282  * character only. Start and end offsets differ by one, by definition,
 283  * for this value.
 284  * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word; i.e.
 285  * range is from start of one word to the start of another word.
 286  * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word; i.e.
 287  * range is from the end of one word to the end of another. Some locales
 288  * may not distinguish between words and characters or glyphs. In particular,
 289  * those locales which use wholly or partially ideographic character sets.
 290  * In these cases, characters may be returned in lieu of multi-character
 291  * substrings.
 292  * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: Boundary condition is start of a
 293  * sentence, as determined by the application. Some locales or
 294  * character sets may not include explicit sentence delimiters, so this
 295  * boundary type can not always be honored. Some locales will return lines
 296  * of text instead of grammatical sentences.
 297  * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: Boundary condition is end of a sentence,
 298  * as determined by the application, including the sentence-delimiting
 299  * character, for instance '.' Some locales or character sets may not
 300  * include explicit sentence delimiters, so this boundary type can not
 301  * always be honored. Some locales will return lines of text instead of
 302  * grammatical sentences.
 303  * @ATSPI_TEXT_BOUNDARY_LINE_START: Boundary condition is the start of a line;
 304  * i.e. range is from start of one line to the start of another.  This
 305  * generally means that an end-of-line character will appear at the end of
 306  * the range.
 307  * @ATSPI_TEXT_BOUNDARY_LINE_END: Boundary condition is the end of a line; i.e.
 308  * range is from start of one line to the start of another.  This generally
 309  * means that an end-of-line character will be the first character of the
 310  * range.
 311  *
 312  * Specifies the boundary conditions determining a run of text as returned from
 313  * #atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, and
 314  * #atspi_text_get_text_before_offset.
 315  *
 316  * Bitfield/set of flags generated from the AT-SPI specification.
 317  **/
 318 typedef enum {
 319     ATSPI_TEXT_BOUNDARY_CHAR,
 320     ATSPI_TEXT_BOUNDARY_WORD_START,
 321     ATSPI_TEXT_BOUNDARY_WORD_END,
 322     ATSPI_TEXT_BOUNDARY_SENTENCE_START,
 323     ATSPI_TEXT_BOUNDARY_SENTENCE_END,
 324     ATSPI_TEXT_BOUNDARY_LINE_START,
 325     ATSPI_TEXT_BOUNDARY_LINE_END,
 326 } AtspiTextBoundaryType;
 327
 328 /**
 329  * ATSPI_TEXT_BOUNDARY_TYPE_COUNT:
 330  *
 331  * One higher than the highest valid value of #AtspiTextBoundaryType.
 332  */
 333 #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)
 334
 335 /**
 336  * AtspiTextClipType:
 337  * @ATSPI_TEXT_CLIP_NONE: No characters/glyphs are omitted.
 338  * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinate
 339  * are omitted.
 340  * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum
 341  * coordinate are omitted.
 342  * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region
 343  * bounded by min and max are retained.
 344  *
 345  * Enumeration used by interface #AtspiText to indicate
 346  * how to treat characters intersecting bounding boxes.
 347  *
 348  * Bitfield/set of flags generated from the AT-SPI specification.
 349  **/
 350 typedef enum {
 351     ATSPI_TEXT_CLIP_NONE,
 352     ATSPI_TEXT_CLIP_MIN,
 353     ATSPI_TEXT_CLIP_MAX,
 354     ATSPI_TEXT_CLIP_BOTH,
 355 } AtspiTextClipType;
 356
 357 /**
 358  * ATSPI_TEXT_CLIP_TYPE_COUNT:
 359  *
 360  * One higher than the highest valid value of #AtspiTextClipType.
 361  */
 362 #define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1)
 363
 364 /**
 365  * AtspiStateType:
 366  * @ATSPI_STATE_INVALID: Indicates an invalid state - probably an error
 367  * condition.
 368  * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, or
 369  * is an active subelement within a container or table.
 370  * @ATSPI_STATE_ARMED: Indicates that the object is armed.
 371  * @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen
 372  * representation is in the process of changing, or       the object is
 373  * temporarily unavailable for interaction due to activity already in progress.
 374  * @ATSPI_STATE_CHECKED: Indicates this object is currently checked.
 375  * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed.
 376  * @ATSPI_STATE_DEFUNCT: Indicates that this object no longer has a valid
 377  * backing widget        (for instance, if its peer object has been destroyed).
 378  * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of this
 379  * object.
 380  * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that it
 381  * currently reflects some application state. Objects that are "greyed out"
 382  * may lack this state, and may lack the @ATSPI_STATE_SENSITIVE if direct
 383  * user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED.
 384  * See @ATSPI_STATE_SENSITIVE.
 385  * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive
 386  * disclosure of its children.
 387  * @ATSPI_STATE_EXPANDED: Indicates this object is expanded.
 388  * @ATSPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus,
 389  * which means all       events resulting from typing on the keyboard will
 390  * normally be passed       to it when it has focus.
 391  * @ATSPI_STATE_FOCUSED: Indicates this object currently has the keyboard
 392  * focus.
 393  * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated
 394  * tooltip.
 395  * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of this object is
 396  * horizontal.
 397  * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is
 398  * represented only by an icon.
 399  * @ATSPI_STATE_MODAL: Indicates something must be done with this object
 400  * before the user can interact with an object in a different window.
 401  * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multiple
 402  * lines of text.
 403  * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one of
 404  * its children to be selected at the same time, or in the case of text
 405  * objects, that the object supports non-contiguous text selections.
 406  * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its
 407  * rectangular region. It also indicates an alpha value of unity, if it
 408  * supports alpha blending.
 409  * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed.
 410  * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not
 411  * fixed.
 412  * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object
 413  * that allows its children to be selected and that this child is one of
 414  * those children       that can be selected.
 415  * @ATSPI_STATE_SELECTED: Indicates this object is the child of an object that
 416  * allows its children to be selected and that this child is one of those
 417  * children that has been selected.
 418  * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user
 419  * interaction. @ATSPI_STATE_SENSITIVE usually accompanies.
 420  * @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the
 421  * absence of @ATSPI_STATE_ENABLED if the current visible state of the control
 422  * is "disconnected" from the application state.  In such cases, direct user
 423  * interaction can often result in the object gaining @ATSPI_STATE_SENSITIVE,
 424  * for instance if a user makes an explicit selection using an object whose
 425  * current state is ambiguous or undefined. See @ATSPI_STATE_ENABLED,
 426  * @ATSPI_STATE_INDETERMINATE.
 427  * @ATSPI_STATE_SHOWING: Indicates this object, the object's parent, the
 428  * object's parent's parent, and so on, are all 'shown' to the end-user,
 429  * i.e. subject to "exposure" if blocking or obscuring objects do not
 430  * interpose between this object and the top of the window stack.
 431  * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only a
 432  * single line of text.
 433  * @ATSPI_STATE_STALE: Indicates that the information returned for this object
 434  * may no longer be synchronized with the application state.  This can occur
 435  * if the object has @ATSPI_STATE_TRANSIENT, and can also occur towards the
 436  * end of the object peer's lifecycle.
 437  * @ATSPI_STATE_TRANSIENT: Indicates this object is transient.
 438  * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is vertical;
 439  * for example this state may appear on such objects as scrollbars, text
 440  * objects (with vertical text flow), separators, etc.
 441  * @ATSPI_STATE_VISIBLE: Indicates this object is visible, e.g. has been
 442  * explicitly marked for exposure to the user. @ATSPI_STATE_VISIBLE is no
 443  * guarantee that the object is actually unobscured on the screen, only that
 444  * it is 'potentially' visible, barring obstruction, being scrolled or clipped
 445  * out of the field of view, or having an ancestor container that has not yet
 446  * made visible. A widget is potentially onscreen if it has both
 447  * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING. The absence of
 448  * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING is
 449  * semantically equivalent to saying that an object is 'hidden'.
 450  * @ATSPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed"
 451  * event is sent when children become 'active' (i.e. are selected or
 452  * navigated to onscreen).  Used to prevent need to enumerate all children
 453  * in very large containers, like tables. The presence of
 454  * @ATSPI_STATE_MANAGES_DESCENDANTS is an indication to the client that the
 455  * children should not, and need not, be enumerated by the client.
 456  * Objects implementing this state are expected to provide relevant state
 457  * notifications to listening clients, for instance notifications of
 458  * visibility changes and activation of their contained child objects, without
 459  * the client having previously requested references to those children.
 460  * @ATSPI_STATE_INDETERMINATE: Indicates that a check box or other boolean
 461  * indicator is in a state other than checked or not checked.  This
 462  * usually means that the boolean value reflected or controlled by the
 463  * object does not apply consistently to the entire current context.
 464  * For example, a checkbox for the "Bold" attribute of text may have
 465  * @ATSPI_STATE_INDETERMINATE if the currently selected text contains a mixture
 466  * of weight attributes. In many cases interacting with a
 467  * @ATSPI_STATE_INDETERMINATE object will cause the context's corresponding
 468  * boolean attribute to be homogenized, whereupon the object will lose
 469  * @ATSPI_STATE_INDETERMINATE and a corresponding state-changed event will be
 470  * fired.
 471  * @ATSPI_STATE_REQUIRED: Indicates that user interaction with this object is
 472  * 'required' from the user, for instance before completing the
 473  * processing of a form.
 474  * @ATSPI_STATE_TRUNCATED:        Indicates that an object's onscreen content
 475  * is truncated, e.g. a text value in a spreadsheet cell.
 476  * @ATSPI_STATE_ANIMATED: Indicates this object's visual representation is
 477  * dynamic, not static. This state may be applied to an object during an
 478  * animated 'effect' and be removed from the object once its visual
 479  * representation becomes static. Some applications, notably content viewers,
 480  * may not be able to detect all kinds of animated content.  Therefore the
 481  * absence of this state should not be taken as
 482  * definitive evidence that the object's visual representation is
 483  * static; this state is advisory.
 484  * @ATSPI_STATE_INVALID_ENTRY: This object has indicated an error condition
 485  * due to failure of input validation.  For instance, a form control may
 486  * acquire this state in response to invalid or malformed user input.
 487  * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the object
 488  * in question implements some form of typeahead or
 489  * pre-selection behavior whereby entering the first character of one or more
 490  * sub-elements causes those elements to scroll into view or become
 491  * selected. Subsequent character input may narrow the selection further as
 492  * long as one or more sub-elements match the string. This state is normally
 493  * only useful and encountered on objects that implement #AtspiSelection.
 494  * In some cases the typeahead behavior may result in full or partial
 495  * completion of the data in the input field, in which case
 496  * these input events may trigger text-changed events from the source.
 497  * @ATSPI_STATE_SELECTABLE_TEXT: This state indicates that the object in
 498  * question supports text selection. It should only be exposed on objects
 499  * which implement the #AtspiText interface, in order to distinguish this state
 500  * from @ATSPI_STATE_SELECTABLE, which infers that the object in question is a
 501  * selectable child of an object which implements #AtspiSelection. While
 502  * similar, text selection and subelement selection are distinct operations.
 503  * @ATSPI_STATE_IS_DEFAULT: This state indicates that the object in question is
 504  * the 'default' interaction object in a dialog, i.e. the one that gets
 505  * activated if the user presses "Enter" when the dialog is initially
 506  * posted.
 507  * @ATSPI_STATE_VISITED: This state indicates that the object (typically a
 508  * hyperlink) has already been activated or invoked, with the result that
 509  * some backing data has been downloaded or rendered.
 510  * @ATSPI_STATE_LAST_DEFINED: This value of the enumeration should not be used
 511  * as a parameter, it indicates the number of items in the #AtspiStateType
 512  * enumeration.
 513  *
 514  *
 515  * Enumeration used by various interfaces indicating every possible state
 516  * an #AtspiAccesible object can assume.
 517  *
 518  * Bitfield/set of flags generated from the AT-SPI specification.
 519  **/
 520 typedef enum {
 521     ATSPI_STATE_INVALID,
 522     ATSPI_STATE_ACTIVE,
 523     ATSPI_STATE_ARMED,
 524     ATSPI_STATE_BUSY,
 525     ATSPI_STATE_CHECKED,
 526     ATSPI_STATE_COLLAPSED,
 527     ATSPI_STATE_DEFUNCT,
 528     ATSPI_STATE_EDITABLE,
 529     ATSPI_STATE_ENABLED,
 530     ATSPI_STATE_EXPANDABLE,
 531     ATSPI_STATE_EXPANDED,
 532     ATSPI_STATE_FOCUSABLE,
 533     ATSPI_STATE_FOCUSED,
 534     ATSPI_STATE_HAS_TOOLTIP,
 535     ATSPI_STATE_HORIZONTAL,
 536     ATSPI_STATE_ICONIFIED,
 537     ATSPI_STATE_MODAL,
 538     ATSPI_STATE_MULTI_LINE,
 539     ATSPI_STATE_MULTISELECTABLE,
 540     ATSPI_STATE_OPAQUE,
 541     ATSPI_STATE_PRESSED,
 542     ATSPI_STATE_RESIZABLE,
 543     ATSPI_STATE_SELECTABLE,
 544     ATSPI_STATE_SELECTED,
 545     ATSPI_STATE_SENSITIVE,
 546     ATSPI_STATE_SHOWING,
 547     ATSPI_STATE_SINGLE_LINE,
 548     ATSPI_STATE_STALE,
 549     ATSPI_STATE_TRANSIENT,
 550     ATSPI_STATE_VERTICAL,
 551     ATSPI_STATE_VISIBLE,
 552     ATSPI_STATE_MANAGES_DESCENDANTS,
 553     ATSPI_STATE_INDETERMINATE,
 554     ATSPI_STATE_REQUIRED,
 555     ATSPI_STATE_TRUNCATED,
 556     ATSPI_STATE_ANIMATED,
 557     ATSPI_STATE_INVALID_ENTRY,
 558     ATSPI_STATE_SUPPORTS_AUTOCOMPLETION,
 559     ATSPI_STATE_SELECTABLE_TEXT,
 560     ATSPI_STATE_IS_DEFAULT,
 561     ATSPI_STATE_VISITED,
 562     ATSPI_STATE_LAST_DEFINED,
 563 } AtspiStateType;
 564
 565 /**
 566  * ATSPI_STATETYPE_COUNT:
 567  *
 568  * One higher than the highest valid value of #AtspiStateType.
 569  **/
 570 #define ATSPI_STATETYPE_COUNT (41+1)
 571
 572 /**
 573  * AtspiKeyEventType:
 574  * @ATSPI_KEY_PRESSED:
 575  * @ATSPI_KEY_RELEASED:
 576  *
 577  * Deprecated. Should not be used.
 578  *
 579  * Bitfield/set of flags generated from the AT-SPI specification.
 580  **/
 581 typedef enum {
 582     ATSPI_KEY_PRESSED,
 583     ATSPI_KEY_RELEASED,
 584 } AtspiKeyEventType;
 585
 586 /**
 587  * ATSPI_KEYEVENTTYPE_COUNT:
 588  *
 589  * One higher than the highest valid value of #AtspiKeyEventType.
 590  **/
 591 #define ATSPI_KEYEVENTTYPE_COUNT (1+1)
 592
 593 /**
 594  * AtspiEventType:
 595  * @ATSPI_KEY_PRESSED_EVENT: Indicates that a key on a keyboard device was
 596  * pressed.
 597  * @ATSPI_KEY_RELEASED_EVENT: Indicates that a key on a keyboard device was
 598  * released.
 599  * @ATSPI_BUTTON_PRESSED_EVENT: Indicates that a button on a non-keyboard
 600  * human interface device (HID) was pressed.
 601  * @ATSPI_BUTTON_RELEASED_EVENT: Indicates that a button on a non-keyboard
 602  * human interface device (HID) was released.
 603  *
 604  * Enumeration used to specify the event types of interest to an
 605  * #AtspiEventListener, or
 606  * to identify the type of an event for which notification has been sent.
 607  *
 608  * Bitfield/set of flags generated from the AT-SPI specification.
 609  **/
 610 typedef enum {
 611     ATSPI_KEY_PRESSED_EVENT,
 612     ATSPI_KEY_RELEASED_EVENT,
 613     ATSPI_BUTTON_PRESSED_EVENT,
 614     ATSPI_BUTTON_RELEASED_EVENT,
 615 } AtspiEventType;
 616
 617 /**
 618  * ATSPI_EVENTTYPE_COUNT:
 619  *
 620  * One higher than the highest valid value of #AtspiEventType.
 621  */
 622 #define ATSPI_EVENTTYPE_COUNT (3+1)
 623
 624 /**
 625  * AtspiKeySynthType:
 626  * @ATSPI_KEY_PRESS: Emulates the pressing of a hardware keyboard key.
 627  * @ATSPI_KEY_RELEASE: Emulates the release of a hardware keyboard key.
 628  * @ATSPI_KEY_PRESSRELEASE: Emulates the pressing and immediate releasing
 629  * ofa hardware keyboard key.
 630  * @ATSPI_KEY_SYM: A symbolic key event is generated, without specifying a
 631  * hardware key. Note: if the keysym is not present in the current keyboard
 632  * map, the #AtspiDeviceEventController instance has a limited ability to
 633  * generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent
 634  * calls using out-of-keymap keysyms will vary from system to system, and on
 635  * the number of different out-of-keymap being generated in quick succession.
 636  * In practice this is rarely significant, since the keysyms of interest to
 637  * AT clients and keyboard emulators are usually part of the current keymap,
 638  * i.e. present on the system keyboard for the current locale (even if a
 639  * physical hardware keyboard is not connected.
 640  * @ATSPI_KEY_STRING: A string is converted to its equivalent keyboard events
 641  * and emitted. If the string consists of complex character or composed
 642  * characters which are not in the current keymap, string emission is
 643  * subject to the out-of-keymap limitations described for
 644  * @ATSPI_KEY_SYM. In practice this limitation primarily effects
 645  * Chinese and Japanese locales.
 646  *
 647  * Enumeration used when synthesizing keyboard input via
 648  * #atspi_generate_keyboard_event.
 649  *
 650  * Bitfield/set of flags generated from the AT-SPI specification.
 651  **/
 652 typedef enum {
 653     ATSPI_KEY_PRESS,
 654     ATSPI_KEY_RELEASE,
 655     ATSPI_KEY_PRESSRELEASE,
 656     ATSPI_KEY_SYM,
 657     ATSPI_KEY_STRING,
 658 } AtspiKeySynthType;
 659
 660 /**
 661  * ATSPI_KEYSYNTHTYPE_COUNT:
 662  *
 663  * One higher than the highest valid value of #AtspiKeySynthType.
 664  **/
 665 #define ATSPI_KEYSYNTHTYPE_COUNT (4+1)
 666
 667 /**
 668  * AtspiModifierType:
 669  * @ATSPI_MODIFIER_SHIFT: The left or right 'Shift' key.
 670  * @ATSPI_MODIFIER_SHIFTLOCK: The ShiftLock or CapsLock key.
 671  * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'.
 672  * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr).
 673  * @ATSPI_MODIFIER_META: Depending on the platform, this may map to 'Window',
 674  * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will
 675  * map to one of META, META2, META3. On X Windows platforms these META
 676  * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an
 677  * event having @ATSPI_MODIFIER_META2 means that the 'Mod2Mask' bit
 678  * is set in the corresponding XEvent.
 679  * @ATSPI_MODIFIER_META2: See @ATSPI_MODIFIER_META.
 680  * @ATSPI_MODIFIER_META3: See @ATSPI_MODIFIER_META.
 681  * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-SPI
 682  * to the appropriate META value, for the convenience of the client.
 683  *
 684  *
 685  *
 686  * Bitfield/set of flags generated from the AT-SPI specification.
 687  **/
 688 typedef enum {
 689     ATSPI_MODIFIER_SHIFT,
 690     ATSPI_MODIFIER_SHIFTLOCK,
 691     ATSPI_MODIFIER_CONTROL,
 692     ATSPI_MODIFIER_ALT,
 693     ATSPI_MODIFIER_META,
 694     ATSPI_MODIFIER_META2,
 695     ATSPI_MODIFIER_META3,
 696     ATSPI_MODIFIER_NUMLOCK,
 697 } AtspiModifierType;
 698
 699 /**
 700  * ATSPI_MODIFIERTYPE_COUNT:
 701  *
 702  * One higher than the highest valid value of #AtspiModifierType.
 703  **/
 704 #define ATSPI_MODIFIERTYPE_COUNT (7+1)
 705
 706 /**
 707  * AtspiRelationType:
 708  * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not
 709  * normally encounter this #AtspiRelationType value.
 710  * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objects.
 711  * @ATSPI_RELATION_LABELLED_BY: Object is labelled by one or more other
 712  * objects.
 713  * @ATSPI_RELATION_CONTROLLER_FOR: Object is an interactive object which
 714  * modifies the state, onscreen location, or other attributes of one or more
 715  * target objects.
 716  * @ATSPI_RELATION_CONTROLLED_BY: Object state, position, etc. is
 717  * modified/controlled by user interaction with one or more other objects.
 718  * For instance a viewport or scroll pane may be @ATSPI_RELATION_CONTROLLED_BY
 719  * scrollbars.
 720  * @ATSPI_RELATION_MEMBER_OF: Object has a grouping relationship (e.g. 'same
 721  * group as') to one or more other objects.
 722  * @ATSPI_RELATION_TOOLTIP_FOR: Object is a tooltip associated with another
 723  * object.
 724  * @ATSPI_RELATION_NODE_CHILD_OF: Object is a child of the target.
 725  * @ATSPI_RELATION_NODE_PARENT_OF: Object is a parent of the target.
 726  * @ATSPI_RELATION_EXTENDED: Used to indicate that a relationship exists, but
 727  * its type is not specified in the enumeration.
 728  * @ATSPI_RELATION_FLOWS_TO: Object renders content which flows logically to
 729  * another object. For instance, text in a paragraph may flow to another
 730  * object which is not the 'next sibling' in the accessibility hierarchy.
 731  * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of @ATSPI_RELATION_FLOWS_TO.
 732  * @ATSPI_RELATION_SUBWINDOW_OF: Object is visually and semantically considered
 733  * a subwindow of another object, even though it is not the object's child.
 734  * Useful when dealing with embedded applications and other cases where the
 735  * widget hierarchy does not map cleanly to the onscreen presentation.
 736  * @ATSPI_RELATION_EMBEDS: Similar to @ATSPI_RELATION_SUBWINDOW_OF, but
 737  * specifically used for cross-process embedding.
 738  * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of @ATSPI_RELATION_EMBEDS. Used to
 739  * denote content rendered by embedded renderers that live in a separate process
 740  * space from the embedding context.
 741  * @ATSPI_RELATION_POPUP_FOR: Denotes that the object is a transient window or
 742  * frame associated with another onscreen object. Similar to @ATSPI_TOOLTIP_FOR,
 743  * but more general. Useful for windows which are technically toplevels
 744  * but which, for one or more reasons, do not explicitly cause their
 745  * associated window to lose 'window focus'. Creation of an @ATSPI_ROLE_WINDOW
 746  * object with the @ATSPI_RELATION_POPUP_FOR relation usually requires
 747  * some presentation action on the part
 748  * of assistive technology clients, even though the previous toplevel
 749  * @ATSPI_ROLE_FRAME object may still be the active window.
 750  * @ATSPI_RELATION_PARENT_WINDOW_OF: This is the reciprocal relation to
 751  * @ATSPI_RELATION_POPUP_FOR.
 752  * @ATSPI_RELATION_DESCRIPTION_FOR: Indicates that an object provides
 753  * descriptive information about another object; more verbose than
 754  * @ATSPI_RELATION_LABEL_FOR.
 755  * @ATSPI_RELATION_DESCRIBED_BY: Indicates that another object provides
 756  * descriptive information about this object; more verbose than
 757  * @ATSPI_RELATION_LABELLED_BY.
 758  * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to
 759  * determine the size of the enumeration.
 760  *
 761  * #AtspiRelationType specifies a relationship between objects
 762  * (possibly one-to-many
 763  * or many-to-one) outside of the normal parent/child hierarchical
 764  * relationship. It allows better semantic       identification of how objects
 765  * are associated with one another.       For instance the
 766  * @ATSPI_RELATION_LABELLED_BY
 767  * relationship may be used to identify labelling information       that should
 768  * accompany the accessible name property when presenting an object's content or
 769  * identity       to the end user.  Similarly,
 770  * @ATSPI_RELATION_CONTROLLER_FOR can be used
 771  * to further specify the context in which a valuator is useful, and/or the
 772  * other UI components which are directly effected by user interactions with
 773  * the valuator. Common examples include association of scrollbars with the
 774  * viewport or panel which they control.
 775  *
 776  *
 777  * Enumeration used to specify
 778  * the type of relation encapsulated in an #AtspiRelation object.
 779  *
 780  * Bitfield/set of flags generated from the AT-SPI specification.
 781  **/
 782 typedef enum {
 783     ATSPI_RELATION_NULL,
 784     ATSPI_RELATION_LABEL_FOR,
 785     ATSPI_RELATION_LABELLED_BY,
 786     ATSPI_RELATION_CONTROLLER_FOR,
 787     ATSPI_RELATION_CONTROLLED_BY,
 788     ATSPI_RELATION_MEMBER_OF,
 789     ATSPI_RELATION_TOOLTIP_FOR,
 790     ATSPI_RELATION_NODE_CHILD_OF,
 791     ATSPI_RELATION_NODE_PARENT_OF,
 792     ATSPI_RELATION_EXTENDED,
 793     ATSPI_RELATION_FLOWS_TO,
 794     ATSPI_RELATION_FLOWS_FROM,
 795     ATSPI_RELATION_SUBWINDOW_OF,
 796     ATSPI_RELATION_EMBEDS,
 797     ATSPI_RELATION_EMBEDDED_BY,
 798     ATSPI_RELATION_POPUP_FOR,
 799     ATSPI_RELATION_PARENT_WINDOW_OF,
 800     ATSPI_RELATION_DESCRIPTION_FOR,
 801     ATSPI_RELATION_DESCRIBED_BY,
 802     ATSPI_RELATION_LAST_DEFINED,
 803 } AtspiRelationType;
 804
 805 /**
 806  * ATSPI_RELATIONTYPE_COUNT:
 807  *
 808  * One higher than the highest valid value of #AtspiRelationType.
 809  **/
 810 #define ATSPI_RELATIONTYPE_COUNT (19+1)
 811
 812 /**
 813  * AtspiRole:
 814  * @ATSPI_ROLE_INVALID: A role indicating an error condition, such as
 815  * uninitialized Role data.
 816  * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard
 817  * accelerators for the parent.
 818  * @ATSPI_ROLE_ALERT: Object is used to alert the user about something.
 819  * @ATSPI_ROLE_ANIMATION: Object contains a dynamic or moving image of some
 820  * kind.
 821  * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator.
 822  * @ATSPI_ROLE_CALENDAR: Object contains one or more dates, usually arranged
 823  * into a 2d list.
 824  * @ATSPI_ROLE_CANVAS: Object that can be drawn into and is used to trap
 825  * events.
 826  * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and
 827  * provides a separate       indicator for the current state.
 828  * @ATSPI_ROLE_CHECK_MENU_ITEM: A menu item that behaves like a check box. See
 829  * @ATSPI_ROLE_CHECK_BOX.
 830  * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a
 831  * color.
 832  * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data.
 833  * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from.
 834  * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date.
 835  * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE.
 836  * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and
 837  * iconified versions of those internal frames.
 838  * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotating a
 839  * visual element, or which displays a value via such a rotating element.
 840  * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border.
 841  * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through
 842  * and select the contents of a directory.
 843  * @ATSPI_ROLE_DRAWING_AREA: A specialized dialog that displays the files in
 844  * the directory and lets the user select a file, browse a different
 845  * directory, or specify a filename.
 846  * @ATSPI_ROLE_FILE_CHOOSER: An object used for drawing custom user interface
 847  * elements.
 848  * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface.
 849  * @ATSPI_ROLE_FOCUS_TRAVERSABLE: Don't use, reserved for future use.
 850  * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font.
 851  * @ATSPI_ROLE_FRAME: A top level window with a title bar, border, menubar,
 852  * etc.
 853  * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of
 854  * all panes beneath it.
 855  * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children
 856  * represent the document content.
 857  * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate
 858  * components.
 859  * @ATSPI_ROLE_IMAGE: An image, typically static.
 860  * @ATSPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop
 861  * pane.
 862  * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in an
 863  * interface.
 864  * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be
 865  * drawn in layers, providing a form of stacking order.
 866  * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user and
 867  * allows the user to select one or more of them.
 868  * @ATSPI_ROLE_LIST_ITEM: An object that represents an element of a list.
 869  * @ATSPI_ROLE_MENU: An object usually found inside a menu bar that contains a
 870  * list of actions the user can choose from.
 871  * @ATSPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary
 872  * dialog box of an application that contains a list of menus the user can
 873  * choose from.
 874  * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presents
 875  * an action the user can choose.
 876  * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a
 877  * dialog.
 878  * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list.
 879  * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or
 880  * page tabs), one at a time,through some mechanism provided by the
 881  * object.
 882  * @ATSPI_ROLE_PANEL: A generic container that is often used to group objects.
 883  * @ATSPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places
 884  * where the text content is not shown visibly to the user.
 885  * @ATSPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer the
 886  * user a list of choices, and then hides when the user selects one of those
 887  * choices.
 888  * @ATSPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has
 889  * been completed.
 890  * @ATSPI_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the
 891  * application to do something.
 892  * @ATSPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other
 893  * radio buttons in the same group to become unchecked when this one is
 894  * checked.
 895  * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio button"
 896  * . See @ATSPI_ROLE_RADIO_BUTTON.
 897  * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a
 898  * layered pane as its children.
 899  * @ATSPI_ROLE_ROW_HEADER: The header for a row of data.
 900  * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to
 901  * incrementally view a large amount of data by moving the bounds of a
 902  * viewport along a one-dimensional axis.
 903  * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally view
 904  * a large amount of information. @ATSPI_ROLE_SCROLL_PANE objects are usually
 905  * accompanied by @ATSPI_ROLE_SCROLL_BAR controllers, on which the
 906  * @ATSPI_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY
 907  * reciprocal relations are set. See  #atspi_get_relation_set.
 908  * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a
 909  * visible and logical separation of the contents in a menu.
 910  * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a bounded
 911  * range.
 912  * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices to
 913  * be selected, and which displays the current choice.  Unlike
 914  * @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control
 915  * 'viewport'-like objects.
 916  * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels
 917  * at the same time.
 918  * @ATSPI_ROLE_STATUS_BAR: Object displays non-quantitative status information
 919  * (c.f. @ATSPI_ROLE_PROGRESS_BAR)
 920  * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of rows
 921  * and columns.
 922  * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. Note:
 923  * Table cells need not have @ATSPI_ROLE_TABLE_CELL, other
 924  * #AtspiRoleType values are valid as well.
 925  * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular column
 926  * in an #AtspiTable.
 927  * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in a
 928  * #AtspiTable. #AtspiTable rows and columns may also be labelled via the
 929  * @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships.
 930  * See #atspi_get_relation_set.
 931  * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from menubar
 932  * and shown in its own window.
 933  * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal.
 934  * @ATSPI_ROLE_TEXT: An object that presents text to the user, of nonspecific
 935  * type.
 936  * @ATSPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or
 937  * unchecked, but does not procide a separate indicator for the current
 938  * state.
 939  * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or
 940  * toggle buttons.
 941  * @ATSPI_ROLE_TOOL_TIP: An object that provides information about another
 942  * object.
 943  * @ATSPI_ROLE_TREE: An object used to repsent hierarchical information to the
 944  * user.
 945  * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and
 946  * hierarchical info to the user.
 947  * @ATSPI_ROLE_UNKNOWN: The object contains some #AtspiAccessible information,
 948  * but its role is not known.
 949  * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to
 950  * otherwise clip a larger object or content renderer to a specific
 951  * onscreen viewport.
 952  * @ATSPI_ROLE_WINDOW: A top level window with no title or border.
 953  * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but not
 954  * included in the core enumeration.
 955  * @ATSPI_ROLE_HEADER: An object that serves as a document header.
 956  * @ATSPI_ROLE_FOOTER: An object that serves as a document footer.
 957  * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of
 958  * text content. See also @ATSPI_ROLE_TEXT.
 959  * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc.
 960  *    for text objects which it controls (should have
 961  * @ATSPI_RELATION_CONTROLLER_FOR relation to such).
 962  * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessible
 963  * of an application, which may contain @ATSPI_ROLE_FRAME objects or other
 964  * accessible objects. Children of #AccessibleDesktop objects  are generally
 965  * @ATSPI_ROLE_APPLICATION objects.
 966  * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items
 967  * for insertion into an entry widget, for instance a list of words for
 968  * completion of a text entry.
 969  * @ATSPI_ROLE_EDITBAR: The object is an editable text object in a toolbar.
 970  * @ATSPI_ROLE_EMBEDDED: The object is an embedded component container.  This
 971  * role is a "grouping" hint that the contained objects share a context
 972  * which is different from the container in which this accessible is
 973  * embedded. In particular, it is used for some kinds of document embedding,
 974  * and for embedding of out-of-process component, "panel applets", etc.
 975  * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may be
 976  * entered or modified by the user, provided @ATSPI_STATE_EDITABLE is present.
 977  * A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is
 978  * not present) implies a read-only 'text field' in a form, as opposed to a
 979  * title, label, or caption.
 980  * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative data.
 981  * It may contain multiple subelements whose attributes and/or description
 982  * may be queried to obtain both the  quantitative data and information about
 983  * how the data is being presented. The @ATSPI_LABELLED_BY relation is
 984  * particularly important in interpreting objects of this type, as is the
 985  * accessible description property. See @ATSPI_ROLE_CAPTION.
 986  * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usually
 987  * textual, about another user interface element such as a table, chart, or
 988  * image.
 989  * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which
 990  * contains a view of document content. #AtspiDocument frames may occur within
 991  * another #AtspiDocument instance, in which case the second  document may be
 992  * said to be embedded in the containing instance.  HTML frames are often
 993  * @ATSPI_ROLE_DOCUMENT_FRAME:  Either this object, or a singleton descendant,
 994  * should implement the #AtspiDocument interface.
 995  * @ATSPI_ROLE_HEADING: The object serves as a heading for content which
 996  * follows it in a document. The 'heading level' of the heading, if
 997  * availabe,  may be obtained by       querying the object's attributes.
 998  * @ATSPI_ROLE_PAGE: The object is a containing instance which encapsulates a
 999  * page of information. @ATSPI_ROLE_PAGE is used in documents and content which
1000  * support a paginated navigation model.
1001  * @ATSPI_ROLE_SECTION: The object is a containing instance of document content
1002  * which constitutes a particular 'logical' section of the document.  The
1003  * type of content within a section, and the nature of the section division
1004  * itself, may be obtained by querying the object's attributes.  Sections
1005  * may be nested.
1006  * @ATSPI_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in
1007  * the hierarchy, and is exposed for purely technical reasons.  Objects of
1008  * this role should be ignored by clients, if they are encountered at all.
1009  * @ATSPI_ROLE_FORM: The object is a containing instance of document content
1010  * which has within it components with which the user can interact in order
1011  * to input information; i.e. the object is a container for pushbuttons,
1012  * comboboxes, text input fields, and other 'GUI' components. @ATSPI_ROLE_FORM
1013  * should not, in general, be used for toplevel GUI containers or dialogs,
1014  * but should be reserved for 'GUI' containers which occur within document
1015  * content, for instance within Web documents, presentations, or text
1016  * documents.  Unlike other GUI containers and dialogs which occur inside
1017  * application instances, @ATSPI_ROLE_FORM containers' components are
1018  * associated with the current document, rather than the current foreground
1019  * application or viewer instance.
1020  * @ATSPI_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a
1021  * hypertext document.  Such objects are distinct from 'inline'       content
1022  * which may also use the #AtspiHypertext/#AtspiHyperlink interfacesto indicate
1023  * the range/location within a text object where an inline or embedded object
1024  * lies.
1025  * @ATSPI_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
1026  * which is used to allow composition or input of a 'complex character',
1027  * in other words it is an "input method window".
1028  * @ATSPI_ROLE_TABLE_ROW: A row in a table.
1029  * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree.
1030  * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a
1031  * spreadsheet.
1032  * @ATSPI_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a
1033  * presentation or slide content.
1034  * @ATSPI_ROLE_DOCUMENT_TEXT: A document frame which contains textual content,
1035  * such as found in a word processing
1036  * application.
1037  * @ATSPI_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other
1038  * markup suitable for display in a web browser.
1039  * @ATSPI_ROLE_DOCUMENT_EMAIL: A document frame which contains email content
1040  * to be displayed or composed either in plain text or
1041  * HTML.
1042  * @ATSPI_ROLE_COMMENT: An object found within a document and designed to
1043  * present a comment, note, or other annotation. In some cases, this object
1044  * might not be visible until activated.
1045  * @ATSPI_ROLE_LIST_BOX: A non-collapsible list of choices the user can
1046  * select from.
1047  * @ATSPI_ROLE_GROUPING: A group of related widgets. This group typically has
1048  * a label.
1049  * @ATSPI_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multiple
1050  * hotspots, where each hotspot can be activated resulting in the loading of
1051  * another document or section of a document.
1052  * @ATSPI_ROLE_NOTIFICATION: A transitory object designed to present a
1053  * message to the user, typically at the desktop level rather than inside a
1054  * particular application.
1055  * @ATSPI_ROLE_INFO_BAR: An object designed to present a message to the user
1056  * within an existing window.
1057  * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of
1058  * enumeration.
1059  *
1060  * Enumeration used by interface #AtspiAccessible to specify the role
1061  * of an #AtspiAccessible object.
1062  *
1063  * Bitfield/set of flags generated from the AT-SPI specification.
1064  */
1065 typedef enum {
1066     ATSPI_ROLE_INVALID,
1067     ATSPI_ROLE_ACCELERATOR_LABEL,
1068     ATSPI_ROLE_ALERT,
1069     ATSPI_ROLE_ANIMATION,
1070     ATSPI_ROLE_ARROW,
1071     ATSPI_ROLE_CALENDAR,
1072     ATSPI_ROLE_CANVAS,
1073     ATSPI_ROLE_CHECK_BOX,
1074     ATSPI_ROLE_CHECK_MENU_ITEM,
1075     ATSPI_ROLE_COLOR_CHOOSER,
1076     ATSPI_ROLE_COLUMN_HEADER,
1077     ATSPI_ROLE_COMBO_BOX,
1078     ATSPI_ROLE_DATE_EDITOR,
1079     ATSPI_ROLE_DESKTOP_ICON,
1080     ATSPI_ROLE_DESKTOP_FRAME,
1081     ATSPI_ROLE_DIAL,
1082     ATSPI_ROLE_DIALOG,
1083     ATSPI_ROLE_DIRECTORY_PANE,
1084     ATSPI_ROLE_DRAWING_AREA,
1085     ATSPI_ROLE_FILE_CHOOSER,
1086     ATSPI_ROLE_FILLER,
1087     ATSPI_ROLE_FOCUS_TRAVERSABLE,
1088     ATSPI_ROLE_FONT_CHOOSER,
1089     ATSPI_ROLE_FRAME,
1090     ATSPI_ROLE_GLASS_PANE,
1091     ATSPI_ROLE_HTML_CONTAINER,
1092     ATSPI_ROLE_ICON,
1093     ATSPI_ROLE_IMAGE,
1094     ATSPI_ROLE_INTERNAL_FRAME,
1095     ATSPI_ROLE_LABEL,
1096     ATSPI_ROLE_LAYERED_PANE,
1097     ATSPI_ROLE_LIST,
1098     ATSPI_ROLE_LIST_ITEM,
1099     ATSPI_ROLE_MENU,
1100     ATSPI_ROLE_MENU_BAR,
1101     ATSPI_ROLE_MENU_ITEM,
1102     ATSPI_ROLE_OPTION_PANE,
1103     ATSPI_ROLE_PAGE_TAB,
1104     ATSPI_ROLE_PAGE_TAB_LIST,
1105     ATSPI_ROLE_PANEL,
1106     ATSPI_ROLE_PASSWORD_TEXT,
1107     ATSPI_ROLE_POPUP_MENU,
1108     ATSPI_ROLE_PROGRESS_BAR,
1109     ATSPI_ROLE_PUSH_BUTTON,
1110     ATSPI_ROLE_RADIO_BUTTON,
1111     ATSPI_ROLE_RADIO_MENU_ITEM,
1112     ATSPI_ROLE_ROOT_PANE,
1113     ATSPI_ROLE_ROW_HEADER,
1114     ATSPI_ROLE_SCROLL_BAR,
1115     ATSPI_ROLE_SCROLL_PANE,
1116     ATSPI_ROLE_SEPARATOR,
1117     ATSPI_ROLE_SLIDER,
1118     ATSPI_ROLE_SPIN_BUTTON,
1119     ATSPI_ROLE_SPLIT_PANE,
1120     ATSPI_ROLE_STATUS_BAR,
1121     ATSPI_ROLE_TABLE,
1122     ATSPI_ROLE_TABLE_CELL,
1123     ATSPI_ROLE_TABLE_COLUMN_HEADER,
1124     ATSPI_ROLE_TABLE_ROW_HEADER,
1125     ATSPI_ROLE_TEAROFF_MENU_ITEM,
1126     ATSPI_ROLE_TERMINAL,
1127     ATSPI_ROLE_TEXT,
1128     ATSPI_ROLE_TOGGLE_BUTTON,
1129     ATSPI_ROLE_TOOL_BAR,
1130     ATSPI_ROLE_TOOL_TIP,
1131     ATSPI_ROLE_TREE,
1132     ATSPI_ROLE_TREE_TABLE,
1133     ATSPI_ROLE_UNKNOWN,
1134     ATSPI_ROLE_VIEWPORT,
1135     ATSPI_ROLE_WINDOW,
1136     ATSPI_ROLE_EXTENDED,
1137     ATSPI_ROLE_HEADER,
1138     ATSPI_ROLE_FOOTER,
1139     ATSPI_ROLE_PARAGRAPH,
1140     ATSPI_ROLE_RULER,
1141     ATSPI_ROLE_APPLICATION,
1142     ATSPI_ROLE_AUTOCOMPLETE,
1143     ATSPI_ROLE_EDITBAR,
1144     ATSPI_ROLE_EMBEDDED,
1145     ATSPI_ROLE_ENTRY,
1146     ATSPI_ROLE_CHART,
1147     ATSPI_ROLE_CAPTION,
1148     ATSPI_ROLE_DOCUMENT_FRAME,
1149     ATSPI_ROLE_HEADING,
1150     ATSPI_ROLE_PAGE,
1151     ATSPI_ROLE_SECTION,
1152     ATSPI_ROLE_REDUNDANT_OBJECT,
1153     ATSPI_ROLE_FORM,
1154     ATSPI_ROLE_LINK,
1155     ATSPI_ROLE_INPUT_METHOD_WINDOW,
1156     ATSPI_ROLE_TABLE_ROW,
1157     ATSPI_ROLE_TREE_ITEM,
1158     ATSPI_ROLE_DOCUMENT_SPREADSHEET,
1159     ATSPI_ROLE_DOCUMENT_PRESENTATION,
1160     ATSPI_ROLE_DOCUMENT_TEXT,
1161     ATSPI_ROLE_DOCUMENT_WEB,
1162     ATSPI_ROLE_DOCUMENT_EMAIL,
1163     ATSPI_ROLE_COMMENT,
1164     ATSPI_ROLE_LIST_BOX,
1165     ATSPI_ROLE_GROUPING,
1166     ATSPI_ROLE_IMAGE_MAP,
1167     ATSPI_ROLE_NOTIFICATION,
1168     ATSPI_ROLE_INFO_BAR,
1169     ATSPI_ROLE_LAST_DEFINED,
1170 } AtspiRole;
1171
1172 /**
1173  * ATSPI_ROLE_COUNT:
1174  *
1175  * One higher than the highest valid value of #AtspiRole.
1176  */
1177 #define ATSPI_ROLE_COUNT (90+1)
1178
1179 typedef enum
1180 {
1181   ATSPI_CACHE_NONE     = 0,
1182   ATSPI_CACHE_PARENT   = 1 << 0,
1183   ATSPI_CACHE_CHILDREN    = 1 << 1,
1184   ATSPI_CACHE_NAME        = 1 << 2,
1185   ATSPI_CACHE_DESCRIPTION = 1 << 3,
1186   ATSPI_CACHE_STATES      = 1 << 4,
1187   ATSPI_CACHE_ROLE        = 1 << 5,
1188   ATSPI_CACHE_INTERFACES  = 1 << 6,
1189   ATSPI_CACHE_ATTRIBUTES = 1 << 7,
1190   ATSPI_CACHE_ALL         = 0x3fffffff,
1191   ATSPI_CACHE_DEFAULT = ATSPI_CACHE_PARENT | ATSPI_CACHE_CHILDREN |
1192                         ATSPI_CACHE_NAME | ATSPI_CACHE_DESCRIPTION |
1193                         ATSPI_CACHE_STATES | ATSPI_CACHE_ROLE |
1194                         ATSPI_CACHE_INTERFACES,
1195   ATSPI_CACHE_UNDEFINED   = 0x40000000,
1196 } AtspiCache;
1197
1198 #define ATSPI_DBUS_NAME_REGISTRY "org.a11y.atspi.Registry"
1199 #define ATSPI_DBUS_PATH_REGISTRY "/org/a11y/atspi/registry"
1200 #define ATSPI_DBUS_INTERFACE_REGISTRY "org.a11y.atspi.Registry"
1201
1202 #define ATSPI_DBUS_PATH_NULL "/org/a11y/atspi/null"
1203 #define ATSPI_DBUS_PATH_ROOT "/org/a11y/atspi/accessible/root"
1204
1205 #define ATSPI_DBUS_PATH_DEC "/org/a11y/atspi/registry/deviceeventcontroller"
1206 #define ATSPI_DBUS_INTERFACE_DEC "org.a11y.atspi.DeviceEventController"
1207 #define ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER "org.a11y.atspi.DeviceEventListener"
1208
1209 #define ATSPI_DBUS_INTERFACE_CACHE "org.a11y.atspi.Cache"
1210 #define ATSPI_DBUS_INTERFACE_ACCESSIBLE "org.a11y.atspi.Accessible"
1211 #define ATSPI_DBUS_INTERFACE_ACTION "org.a11y.atspi.Action"
1212 #define ATSPI_DBUS_INTERFACE_APPLICATION "org.a11y.atspi.Application"
1213 #define ATSPI_DBUS_INTERFACE_COLLECTION "org.a11y.atspi.Collection"
1214 #define ATSPI_DBUS_INTERFACE_COMPONENT "org.a11y.atspi.Component"
1215 #define ATSPI_DBUS_INTERFACE_DOCUMENT "org.a11y.atspi.Document"
1216 #define ATSPI_DBUS_INTERFACE_EDITABLE_TEXT "org.a11y.atspi.EditableText"
1217 #define ATSPI_DBUS_INTERFACE_EVENT_KEYBOARD "org.a11y.atspi.Event.Keyboard"
1218 #define ATSPI_DBUS_INTERFACE_EVENT_MOUSE "org.a11y.atspi.Event.Mouse"
1219 #define ATSPI_DBUS_INTERFACE_EVENT_OBJECT "org.a11y.atspi.Event.Object"
1220 #define ATSPI_DBUS_INTERFACE_HYPERLINK "org.a11y.atspi.Hyperlink"
1221 #define ATSPI_DBUS_INTERFACE_HYPERTEXT "org.a11y.atspi.Hypertext"
1222 #define ATSPI_DBUS_INTERFACE_IMAGE "org.a11y.atspi.Image"
1223 #define ATSPI_DBUS_INTERFACE_SELECTION "org.a11y.atspi.Selection"
1224 #define ATSPI_DBUS_INTERFACE_TABLE "org.a11y.atspi.Table"
1225 #define ATSPI_DBUS_INTERFACE_TEXT "org.a11y.atspi.Text"
1226 #define ATSPI_DBUS_INTERFACE_VALUE "org.a11y.atspi.Value"
1227 #define ATSPI_DBUS_INTERFACE_SOCKET "org.a11y.atspi.Socket"
1228
1229 #ifdef __cplusplus
1230 }
1231 #endif
1232 #endif  /* _ATSPI_CONSTANTS_H_ */