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  *
  70 ATSPI_LOCALE_TYPE:
  71  * @ATSPI_LOCALE_TYPE_MESSAGES: <![CDATA[]]>
  72  * @ATSPI_LOCALE_TYPE_COLLATE: <![CDATA[]]>
  73  * @ATSPI_LOCALE_TYPE_CTYPE: <![CDATA[]]>
  74  * @ATSPI_LOCALE_TYPE_MONETARY: <![CDATA[]]>
  75  * @ATSPI_LOCALE_TYPE_NUMERIC: <![CDATA[]]>
  76  * @ATSPI_LOCALE_TYPE_TIME: <![CDATA[]]>
  77  *
  78  * <![CDATA[   Used by Text and Document interfaces these correspond to the POSIX 'setlocale' enum values.    ]]>
  79  *
  80  * Bitfield/set of flags generated from the AT-SPI specification.
  81  */
  82 typedef enum {
  83     ATSPI_LOCALE_TYPE_MESSAGES,
  84     ATSPI_LOCALE_TYPE_COLLATE,
  85     ATSPI_LOCALE_TYPE_CTYPE,
  86     ATSPI_LOCALE_TYPE_MONETARY,
  87     ATSPI_LOCALE_TYPE_NUMERIC,
  88     ATSPI_LOCALE_TYPE_TIME,
  89 } AtspiLocaleType;
  90
  91 /**
  92  * NUM_ATSPI_LOCALE_TYPES:
  93  *
  94  * 1 higher than the highest valid value of #AtspiLocaleType.
  95  */
  96 #define NUM_ATSPI_LOCALE_TYPES (5+1)
  97
  98 /**
  99  *
 100 ATSPI_COORD_TYPE:
 101  * @ATSPI_COORD_TYPE_SCREEN: <![CDATA[]]>
 102  * @ATSPI_COORD_TYPE_WINDOW: <![CDATA[]]>
 103  *
 104  * <![CDATA[   Used by Component, Image, and Text interfaces to specify whether coordinates are relative to the window or the screen.   ]]>
 105  *
 106  * Bitfield/set of flags generated from the AT-SPI specification.
 107  */
 108 typedef enum {
 109     ATSPI_COORD_TYPE_SCREEN,
 110     ATSPI_COORD_TYPE_WINDOW,
 111 } AtspiCoordType;
 112
 113 /**
 114  * NUM_ATSPI_COORD_TYPES:
 115  *
 116  * 1 higher than the highest valid value of #AtspiCoordType.
 117  */
 118 #define NUM_ATSPI_COORD_TYPES (1+1)
 119
 120 /**
 121  *
 122 ATSPI_Collection_SortOrder:
 123  * @ATSPI_Collection_SORT_ORDER_INVALID: <![CDATA[]]>
 124  * @ATSPI_Collection_SORT_ORDER_CANONICAL: <![CDATA[]]>
 125  * @ATSPI_Collection_SORT_ORDER_FLOW: <![CDATA[]]>
 126  * @ATSPI_Collection_SORT_ORDER_TAB: <![CDATA[]]>
 127  * @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL: <![CDATA[]]>
 128  * @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW: <![CDATA[]]>
 129  * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB: <![CDATA[]]>
 130  * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED: <![CDATA[]]>
 131  *
 132  * Bitfield/set of flags generated from the AT-SPI specification.
 133  */
 134 typedef enum {
 135     ATSPI_Collection_SORT_ORDER_INVALID,
 136     ATSPI_Collection_SORT_ORDER_CANONICAL,
 137     ATSPI_Collection_SORT_ORDER_FLOW,
 138     ATSPI_Collection_SORT_ORDER_TAB,
 139     ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL,
 140     ATSPI_Collection_SORT_ORDER_REVERSE_FLOW,
 141     ATSPI_Collection_SORT_ORDER_REVERSE_TAB,
 142     ATSPI_Collection_SORT_ORDER_LAST_DEFINED,
 143 } AtspiCollectionSortOrder;
 144
 145 /**
 146  * NUM_ATSPI_SORTORDERS:
 147  *
 148  * 1 higher than the highest valid value of #AtspiCollectionSortOrder.
 149  */
 150 #define NUM_ATSPI_SORTORDERS (7+1)
 151
 152 /**
 153  *
 154 ATSPI_Collection_MatchType:
 155  * @ATSPI_Collection_MATCH_INVALID: <![CDATA[]]>
 156  * @ATSPI_Collection_MATCH_ALL: <![CDATA[]]>
 157  * @ATSPI_Collection_MATCH_ANY: <![CDATA[]]>
 158  * @ATSPI_Collection_MATCH_NONE: <![CDATA[]]>
 159  * @ATSPI_Collection_MATCH_EMPTY: <![CDATA[]]>
 160  * @ATSPI_Collection_MATCH_LAST_DEFINED: <![CDATA[]]>
 161  *
 162  * Bitfield/set of flags generated from the AT-SPI specification.
 163  */
 164 typedef enum {
 165     ATSPI_Collection_MATCH_INVALID,
 166     ATSPI_Collection_MATCH_ALL,
 167     ATSPI_Collection_MATCH_ANY,
 168     ATSPI_Collection_MATCH_NONE,
 169     ATSPI_Collection_MATCH_EMPTY,
 170     ATSPI_Collection_MATCH_LAST_DEFINED,
 171 } AtspiCollectionMatchType;
 172
 173 /**
 174  * NUM_ATSPI_MATCHTYPES:
 175  *
 176  * 1 higher than the highest valid value of #AtspiCollection_MatchType.
 177  */
 178 #define NUM_ATSPI_MATCHTYPES (5+1)
 179
 180 /**
 181  *
 182 ATSPI_Collection_TreeTraversalType:
 183  * @ATSPI_Collection_TREE_RESTRICT_CHILDREN: <![CDATA[]]>
 184  * @ATSPI_Collection_TREE_RESTRICT_SIBLING: <![CDATA[]]>
 185  * @ATSPI_Collection_TREE_INORDER: <![CDATA[]]>
 186  * @ATSPI_Collection_TREE_LAST_DEFINED: <![CDATA[]]>
 187  *
 188  * Bitfield/set of flags generated from the AT-SPI specification.
 189  */
 190 typedef enum {
 191     ATSPI_Collection_TREE_RESTRICT_CHILDREN,
 192     ATSPI_Collection_TREE_RESTRICT_SIBLING,
 193     ATSPI_Collection_TREE_INORDER,
 194     ATSPI_Collection_TREE_LAST_DEFINED,
 195 } AtspiCollectionTreeTraversalType;
 196
 197 /**
 198  * NUM_ATSPI_TREETRAVERSALTYPES:
 199  *
 200  * 1 higher than the highest valid value of #AtspiCollection_TreeTraversalType.
 201  */
 202 #define NUM_ATSPI_TREETRAVERSALTYPES (3+1)
 203
 204 /**
 205  *
 206 ATSPI_ComponentLayer:
 207  * @ATSPI_LAYER_INVALID: <![CDATA[     Indicates an error condition or uninitialized value.    ]]>
 208  * @ATSPI_LAYER_BACKGROUND: <![CDATA[     The bottom-most layer, over which everything else is painted.        The 'desktop background' is generally in this layer.    ]]>
 209  * @ATSPI_LAYER_CANVAS: <![CDATA[     The 'background' layer for most content renderers and UI Component        containers.    ]]>
 210  * @ATSPI_LAYER_WIDGET: <![CDATA[     The layer in which the majority of ordinary 'foreground' widgets reside.   ]]>
 211  * @ATSPI_LAYER_MDI: <![CDATA[     A special layer between LAYER_CANVAS and LAYER_WIDGET, in which the       'pseudo windows' (e.g. the MDI frames) reside.        (See Component.GetMDIZOrder)    ]]>
 212  * @ATSPI_LAYER_POPUP: <![CDATA[     A layer for popup window content, above LAYER_WIDGET.    ]]>
 213  * @ATSPI_LAYER_OVERLAY: <![CDATA[     The topmost layer.    ]]>
 214  * @ATSPI_LAYER_WINDOW: <![CDATA[     The layer in which a toplevel window background usually resides.    ]]>
 215  * @ATSPI_LAYER_LAST_DEFINED: <![CDATA[     Used only to determine the end of the enumeration.    ]]>
 216  *
 217  * <![CDATA[     The ComponentLayer of a Component instance indicates its relative stacking order       with respect to the onscreen visual representation of the UI.       ComponentLayer, in combination with Component bounds information, can be used       to compute the visibility of all or part of a component.  This is important in       programmatic determination of region-of-interest for magnification, and in       &#168;flat screen review&#168; models of the screen, as well as for other uses.       Objects residing in two of the ComponentLayer categories support       further z-ordering information, with respect to their peers in the same layer:       namely, LAYER_WINDOW and LAYER_MDI.  Relative stacking order for other objects within       the same layer is not available; the recommended heuristic is &#168;first child paints first&#168;,        in other words, assume that the first siblings in the child list are subject to being       overpainted by later siblings if their bounds intersect.        The order of layers, from bottom to top, is:                         LAYER_BACKGROUND                LAYER_WINDOW            LAYER_MDI               LAYER_CANVAS            LAYER_WIDGET            LAYER_POPUP             LAYER_OVERLAY               ]]>
 218  *
 219  * Bitfield/set of flags generated from the AT-SPI specification.
 220  */
 221 typedef enum {
 222     ATSPI_LAYER_INVALID,
 223     ATSPI_LAYER_BACKGROUND,
 224     ATSPI_LAYER_CANVAS,
 225     ATSPI_LAYER_WIDGET,
 226     ATSPI_LAYER_MDI,
 227     ATSPI_LAYER_POPUP,
 228     ATSPI_LAYER_OVERLAY,
 229     ATSPI_LAYER_WINDOW,
 230     ATSPI_LAYER_LAST_DEFINED,
 231 } AtspiComponentLayer;
 232
 233 /**
 234  * NUM_ATSPI_COMPONENTLAYERS:
 235  *
 236  * 1 higher than the highest valid value of #AtspiComponentLayer.
 237  */
 238 #define NUM_ATSPI_COMPONENTLAYERS (8+1)
 239
 240 /**
 241  *
 242 ATSPI_TEXT_BOUNDARY_TYPE:
 243  * @ATSPI_TEXT_BOUNDARY_CHAR: <![CDATA[     Text is bounded by this character only.        Start and end offsets differ by one, by definition, for this value.    ]]>
 244  * @ATSPI_TEXT_BOUNDARY_WORD_START: <![CDATA[     Boundary condition is start of a word; i.e. range is from start of       one word to the start of another word.    ]]>
 245  * @ATSPI_TEXT_BOUNDARY_WORD_END: <![CDATA[     Boundary condition is the end of a word; i.e. range is from         the end of one word to the end of another.     Some locales may not distinguish between words and       characters or glyphs, in particular those locales which use       wholly or partially ideographic character sets.  In these cases,       characters may be returned in lieu of multi-character substrings.   ]]>
 246  * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: <![CDATA[     Boundary condition is start of a sentence, as determined              by the application.       Some locales or character sets may not include explicit sentence       delimiters, so this boundary type can not always be honored.       Some locales will return lines of text instead of grammatical sentences.   ]]>
 247  * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: <![CDATA[     Boundary condition is end of a sentence, as determined by the application,              including the sentence-delimiting character, for instance '.'       Some locales or character sets may not include explicit sentence       delimiters, so this boundary type can not always be honored.       Some locales will return lines of text instead of grammatical sentences.   ]]>
 248  * @ATSPI_TEXT_BOUNDARY_LINE_START: <![CDATA[      Boundary condition is the start of a line; i.e. range is        from start of one line to the start of another.  This generally        means that an end-of-line character will appear at the end of the range.    ]]>
 249  * @ATSPI_TEXT_BOUNDARY_LINE_END: <![CDATA[      Boundary condition is the end of a line; i.e. range is       from start of one line to the start of another.  This generally        means that an end-of-line character will be the first character of the range.    ]]>
 250  *
 251  * <![CDATA[     Specifies the boundary conditions determining a run of text as returned from       GetTextAtOffset, GetTextAfterOffset, and GetTextBeforeOffset.   ]]>
 252  *
 253  * Bitfield/set of flags generated from the AT-SPI specification.
 254  */
 255 typedef enum {
 256     ATSPI_TEXT_BOUNDARY_CHAR,
 257     ATSPI_TEXT_BOUNDARY_WORD_START,
 258     ATSPI_TEXT_BOUNDARY_WORD_END,
 259     ATSPI_TEXT_BOUNDARY_SENTENCE_START,
 260     ATSPI_TEXT_BOUNDARY_SENTENCE_END,
 261     ATSPI_TEXT_BOUNDARY_LINE_START,
 262     ATSPI_TEXT_BOUNDARY_LINE_END,
 263 } AtspiTextBoundaryType;
 264
 265 /**
 266  * NUM_ATSPI_TEXT_BOUNDARY_TYPES:
 267  *
 268  * 1 higher than the highest valid value of #AtspiTextBOundaryType.
 269  */
 270 #define NUM_ATSPI_TEXT_BOUNDARY_TYPES (6+1)
 271
 272 /**
 273  *
 274 ATSPI_TEXT_CLIP_TYPE:
 275  * @ATSPI_TEXT_CLIP_NONE: <![CDATA[]]>
 276  * @ATSPI_TEXT_CLIP_MIN: <![CDATA[     Characters/glyphs clipped by the minimum coordinate are omitted    ]]>
 277  * @ATSPI_TEXT_CLIP_MAX: <![CDATA[     Characters/glyphs which intersect the maximum coordinate are omitted    ]]>
 278  * @ATSPI_TEXT_CLIP_BOTH: <![CDATA[     Only glyphs falling entirely within the region bounded by min and max are retained.    ]]>
 279  *
 280  * <![CDATA[     TEXT_CLIP_TYPE:       CLIP_MIN means text clipped by min coordinate is omitted,       CLIP_MAX clips text interescted by the max coord, and CLIP_BOTH       will retain only text falling fully within the min/max bounds.     ]]>
 281  *
 282  * Bitfield/set of flags generated from the AT-SPI specification.
 283  */
 284 typedef enum {
 285     ATSPI_TEXT_CLIP_NONE,
 286     ATSPI_TEXT_CLIP_MIN,
 287     ATSPI_TEXT_CLIP_MAX,
 288     ATSPI_TEXT_CLIP_BOTH,
 289 } AtspiTextClipType;
 290
 291 /**
 292  * NUM_ATSPI_TEXT_CLIP_TYPES:
 293  *
 294  * 1 higher than the highest valid value of #AtspiTextClipType.
 295  */
 296 #define NUM_ATSPI_TEXT_CLIP_TYPES (3+1)
 297
 298 /**
 299  *
 300 ATSPI_StateType:
 301  * @ATSPI_STATE_INVALID: <![CDATA[]]>
 302  * @ATSPI_STATE_ACTIVE: <![CDATA[     Indicates a window is currently the active window, or is an active subelement within a container or table    ]]>
 303  * @ATSPI_STATE_ARMED: <![CDATA[     Indicates that the object is armed    ]]>
 304  * @ATSPI_STATE_BUSY: <![CDATA[     Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or       the object is temporarily unavailable for interaction due to activity already in progress.   ]]>
 305  * @ATSPI_STATE_CHECKED: <![CDATA[     Indicates this object is currently checked    ]]>
 306  * @ATSPI_STATE_COLLAPSED: <![CDATA[     Indicates this object is collapsed    ]]>
 307  * @ATSPI_STATE_DEFUNCT: <![CDATA[     Indicates that this object no longer has a valid backing widget        (for instance, if its peer object has been destroyed)    ]]>
 308  * @ATSPI_STATE_EDITABLE: <![CDATA[     Indicates the user can change the contents of this object    ]]>
 309  * @ATSPI_STATE_ENABLED: <![CDATA[     Indicates that this object is enabled, i.e. that it currently reflects some application state.        Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user       interaction cannot cause them to acquire STATE_ENABLED.  @see STATE_SENSITIVE.   ]]>
 310  * @ATSPI_STATE_EXPANDABLE: <![CDATA[     Indicates this object allows progressive disclosure of its children    ]]>
 311  * @ATSPI_STATE_EXPANDED: <![CDATA[     Indicates this object its expanded    ]]>
 312  * @ATSPI_STATE_FOCUSABLE: <![CDATA[     Indicates this object can accept keyboard focus, which means all       events resulting from typing on the keyboard will normally be passed       to it when it has focus   ]]>
 313  * @ATSPI_STATE_FOCUSED: <![CDATA[     Indicates this object currently has the keyboard focus    ]]>
 314  * @ATSPI_STATE_HAS_TOOLTIP: <![CDATA[     Indicates that the object has an associated tooltip    ]]>
 315  * @ATSPI_STATE_HORIZONTAL: <![CDATA[     Indicates the orientation of thsi object is horizontal    ]]>
 316  * @ATSPI_STATE_ICONIFIED: <![CDATA[     Indicates this object is minimized and is represented only by an icon    ]]>
 317  * @ATSPI_STATE_MODAL: <![CDATA[     Indicates something must be done with this object before the user can       interact with an object in a different window.   ]]>
 318  * @ATSPI_STATE_MULTI_LINE: <![CDATA[     Indicates this (text) object can contain multiple lines of text    ]]>
 319  * @ATSPI_STATE_MULTISELECTABLE: <![CDATA[     Indicates this object allows more than one of its children to be       selected at the same time, or in the case of text objects,        that the object supports non-contiguous text selections.   ]]>
 320  * @ATSPI_STATE_OPAQUE: <![CDATA[     Indicates this object paints every pixel within its rectangular region.       It also indicates an alpha value of unity, if it supports alpha blending.    ]]>
 321  * @ATSPI_STATE_PRESSED: <![CDATA[     Indicates this object is currently pressed    ]]>
 322  * @ATSPI_STATE_RESIZABLE: <![CDATA[     Indicates the size of this object's size is not fixed    ]]>
 323  * @ATSPI_STATE_SELECTABLE: <![CDATA[     Indicates this object is the child of an object that allows its       children to be selected and that this child is one of those children       that can be selected.   ]]>
 324  * @ATSPI_STATE_SELECTED: <![CDATA[     Indicates this object is the child of an object that allows its       children to be selected and that this child is one of those children       that has been selected.   ]]>
 325  * @ATSPI_STATE_SENSITIVE: <![CDATA[     Indicates this object is sensitive, e.g. to user interaction.        STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls,       but may be found in the absence of STATE_ENABLED if the current visible state of the        control is "disconnected" from the application state.  In such cases, direct user interaction       can often result in the object gaining STATE_SENSITIVE, for instance if a user makes        an explicit selection using an object whose current state is ambiguous or undefined.       @see STATE_ENABLED, STATE_INDETERMINATE.    ]]>
 326  * @ATSPI_STATE_SHOWING: <![CDATA[     Indicates this object, the object's parent, the object's parent's       parent, and so on, are all 'shown' to the end-user, i.e.       subject to "exposure" if blocking or obscuring objects do not interpose       between this object and the top of the window stack.   ]]>
 327  * @ATSPI_STATE_SINGLE_LINE: <![CDATA[     Indicates this (text) object can contain only a single line of text    ]]>
 328  * @ATSPI_STATE_STALE: <![CDATA[     Indicates that the information returned for this object may no longer be       synchronized with the application state.  This can occur if the object has STATE_TRANSIENT,       and can also occur towards the end of the object peer's lifecycle.    ]]>
 329  * @ATSPI_STATE_TRANSIENT: <![CDATA[     Indicates this object is transient    ]]>
 330  * @ATSPI_STATE_VERTICAL: <![CDATA[     Indicates the orientation of this object is vertical; for example this state may appear on        such objects as scrollbars, text objects (with vertical text flow), separators, etc.   ]]>
 331  * @ATSPI_STATE_VISIBLE: <![CDATA[        Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.     STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only       that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the        field of view, or having an ancestor container that has not yet made visible.       A widget is potentially onscreen if it has both STATE_VISIBLE and STATE_SHOWING.       The absence of STATE_VISIBLE and STATE_SHOWING is semantically equivalent to saying        that an object is 'hidden'.   ]]>
 332  * @ATSPI_STATE_MANAGES_DESCENDANTS: <![CDATA[     Indicates that "active-descendant-changed" event is sent when children       become 'active' (i.e. are selected or navigated to onscreen).  Used to       prevent need to enumerate all children in very large containers, like       tables.  The presence of STATE_MANAGES_DESCENDANTS is an indication to the client.       that the children should not, and need not, be enumerated by the client.       Objects implementing this state are expected to provide relevant state       notifications to listening clients, for instance notifications of visibility       changes and activation of their contained child objects, without the client        having previously requested references to those children.   ]]>
 333  * @ATSPI_STATE_INDETERMINATE: <![CDATA[     Indicates that a check box or other boolean indicator is in a state other than        checked or not checked.  This usually means that the boolean value reflected or        controlled by the object does not apply consistently to the entire current context.       For example, a checkbox for the "Bold" attribute of text may have STATE_INDETERMINATE       if the currently selected text contains a mixture of weight attributes.         In many cases interacting with a STATE_INDETERMINATE object will cause        the context's corresponding boolean attribute to be homogenized, whereupon the object       will lose STATE_INDETERMINATE and a corresponding state-changed event will be fired.   ]]>
 334  * @ATSPI_STATE_REQUIRED: <![CDATA[     Indicates that user interaction with this object is 'required' from the user,        for instance before completing the processing of a form.   ]]>
 335  * @ATSPI_STATE_TRUNCATED: <![CDATA[      Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell.    ]]>
 336  * @ATSPI_STATE_ANIMATED: <![CDATA[     Indicates this object's visual representation is dynamic, not static.       This state may be applied to an object during an animated 'effect' and        be removed from the object once its visual representation becomes static.     some applications, notably content viewers, may not be able to detect       all kinds of animated content.  Therefore the absence of this state should not       be taken as definitive evidence that the object's visual representation is       static; this state is advisory.   ]]>
 337  * @ATSPI_STATE_INVALID_ENTRY: <![CDATA[     This object has indicated an error condition due to failure of input       validation.  For instance, a form control may acquire this state in response       to invalid or malformed user input.     ]]>
 338  * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: <![CDATA[     This state indicates that the object in question implements some form of &#168;typeahead&#168; or        pre-selection behavior whereby entering the first character of one or more sub-elements       causes those elements to scroll into view or become selected.  Subsequent character input       may narrow the selection further as long as one or more sub-elements match the string.       This state is normally only useful and encountered on objects that implement Selection.       In some cases the typeahead behavior may result in full or partial &#168;completion&#168; of        the data in the input field, in which case these input events may trigger text-changed       events from the source.     ]]>
 339  * @ATSPI_STATE_SELECTABLE_TEXT: <![CDATA[     This state indicates that the object in question supports text selection.        It should only be exposed on objects which implement the Text interface,        in order to distinguish this state from STATE_SELECTABLE, which infers that       the object in question is a selectable child of an object which implements       Selection.  While similar, text selection and subelement selection are       distinct operations.     ]]>
 340  * @ATSPI_STATE_IS_DEFAULT: <![CDATA[     This state indicates that the object in question is the 'default' interaction object        in a dialog, i.e. the one that gets activated if the user presses "Enter" when the       dialog is initially posted.     ]]>
 341  * @ATSPI_STATE_VISITED: <![CDATA[     This state indicates that the object (typically a hyperlink)       has already been activated or invoked, with the result that some backing data       has been downloaded or rendered.     ]]>
 342  * @ATSPI_STATE_LAST_DEFINED: <![CDATA[     This value of the enumeration should not be used as a parameter, it indicates the number of       items in the StateType enumeration.   ]]>
 343  *
 344  * Bitfield/set of flags generated from the AT-SPI specification.
 345  */
 346 typedef enum {
 347     ATSPI_STATE_INVALID,
 348     ATSPI_STATE_ACTIVE,
 349     ATSPI_STATE_ARMED,
 350     ATSPI_STATE_BUSY,
 351     ATSPI_STATE_CHECKED,
 352     ATSPI_STATE_COLLAPSED,
 353     ATSPI_STATE_DEFUNCT,
 354     ATSPI_STATE_EDITABLE,
 355     ATSPI_STATE_ENABLED,
 356     ATSPI_STATE_EXPANDABLE,
 357     ATSPI_STATE_EXPANDED,
 358     ATSPI_STATE_FOCUSABLE,
 359     ATSPI_STATE_FOCUSED,
 360     ATSPI_STATE_HAS_TOOLTIP,
 361     ATSPI_STATE_HORIZONTAL,
 362     ATSPI_STATE_ICONIFIED,
 363     ATSPI_STATE_MODAL,
 364     ATSPI_STATE_MULTI_LINE,
 365     ATSPI_STATE_MULTISELECTABLE,
 366     ATSPI_STATE_OPAQUE,
 367     ATSPI_STATE_PRESSED,
 368     ATSPI_STATE_RESIZABLE,
 369     ATSPI_STATE_SELECTABLE,
 370     ATSPI_STATE_SELECTED,
 371     ATSPI_STATE_SENSITIVE,
 372     ATSPI_STATE_SHOWING,
 373     ATSPI_STATE_SINGLE_LINE,
 374     ATSPI_STATE_STALE,
 375     ATSPI_STATE_TRANSIENT,
 376     ATSPI_STATE_VERTICAL,
 377     ATSPI_STATE_VISIBLE,
 378     ATSPI_STATE_MANAGES_DESCENDANTS,
 379     ATSPI_STATE_INDETERMINATE,
 380     ATSPI_STATE_REQUIRED,
 381     ATSPI_STATE_TRUNCATED,
 382     ATSPI_STATE_ANIMATED,
 383     ATSPI_STATE_INVALID_ENTRY,
 384     ATSPI_STATE_SUPPORTS_AUTOCOMPLETION,
 385     ATSPI_STATE_SELECTABLE_TEXT,
 386     ATSPI_STATE_IS_DEFAULT,
 387     ATSPI_STATE_VISITED,
 388     ATSPI_STATE_LAST_DEFINED,
 389 } AtspiStateType;
 390
 391 /**
 392  * NUM_ATSPI_STATETYPES:
 393  *
 394  * 1 higher than the highest valid value of #AtspiStateType.
 395  */
 396 #define NUM_ATSPI_STATETYPES (41+1)
 397
 398 /**
 399  *
 400 ATSPI_KeyEventType:
 401  * @ATSPI_KEY_PRESSED: <![CDATA[]]>
 402  * @ATSPI_KEY_RELEASED: <![CDATA[]]>
 403  *
 404  * <![CDATA[     Deprecated, DO NOT USE!    ]]>
 405  *
 406  * Bitfield/set of flags generated from the AT-SPI specification.
 407  */
 408 typedef enum {
 409     ATSPI_KEY_PRESSED,
 410     ATSPI_KEY_RELEASED,
 411 } AtspiKeyEventType;
 412
 413 /**
 414  * NUM_ATSPI_KEYEVENTTYPES:
 415  *
 416  * 1 higher than the highest valid value of #AtspiKeyEventType.
 417  */
 418 #define NUM_ATSPI_KEYEVENTTYPES (1+1)
 419
 420 /**
 421  *
 422 ATSPI_EventType:
 423  * @ATSPI_KEY_PRESSED_EVENT: <![CDATA[     < key on a keyboard device was pressed.    ]]>
 424  * @ATSPI_KEY_RELEASED_EVENT: <![CDATA[     < key on a keyboard device was released.    ]]>
 425  * @ATSPI_BUTTON_PRESSED_EVENT: <![CDATA[     < button on a non-keyboard human interface device        (HID) was pressed    ]]>
 426  * @ATSPI_BUTTON_RELEASED_EVENT: <![CDATA[     < button on a non-keyboard human interface device        (HID) was pressed    ]]>
 427  *
 428  * <![CDATA[     Used to specify the event types of interest to an EventListener, or       to identify the type of an event for which notification has been sent.        @see EventTypeSeq, DeviceEvent::type   ]]>
 429  *
 430  * Bitfield/set of flags generated from the AT-SPI specification.
 431  */
 432 typedef enum {
 433     ATSPI_KEY_PRESSED_EVENT,
 434     ATSPI_KEY_RELEASED_EVENT,
 435     ATSPI_BUTTON_PRESSED_EVENT,
 436     ATSPI_BUTTON_RELEASED_EVENT,
 437 } AtspiEventType;
 438
 439 /**
 440  * NUM_ATSPI_EVENTTYPES:
 441  *
 442  * 1 higher than the highest valid value of #AtspiEventType.
 443  */
 444 #define NUM_ATSPI_EVENTTYPES (3+1)
 445
 446 /**
 447  *
 448 AtspiKeySynthType:
 449  * @ATSPI_KEY_PRESS: <![CDATA[     emulate the pressing of a hardware keyboard key.    ]]>
 450  * @ATSPI_KEY_RELEASE: <![CDATA[     emulate the release of a hardware keyboard key.    ]]>
 451  * @ATSPI_KEY_PRESSRELEASE: <![CDATA[     a hardware keyboard key is pressed and immediately released.    ]]>
 452  * @ATSPI_KEY_SYM: <![CDATA[     a symbolic key event is generated, without specifying a hardware key.        @note if the keysym is not present in the current keyboard map,       the DeviceEventController instance has a limited ability to generate       such keysyms on-the-fly.  Reliability of GenerateKeyboardEvent calls       using out-of-keymap keysyms will vary from system to system, and on the       number of different out-of-keymap being generated in quick succession.       In practice this is rarely significant, since the keysyms of interest to       AT clients and keyboard emulators are usually part of the current keymap, i.e.       present on the system keyboard for the current locale (even if a physical       hardware keyboard is not connected.   ]]>
 453  * @ATSPI_KEY_STRING: <![CDATA[     a string is converted to its equivalent keyboard events and emitted.        If the string consists of complex character or composed characters       which are not in the current keymap, string emission is subject to the       out-of-keymap limitations described for KeySynthType::KEY_SYM.       In practice this limitation primarily effects Chinese and Japanese locales.   ]]>
 454  *
 455  * <![CDATA[     Used when synthesizing keyboard input via DeviceEventController:GenerateKeyboardEvent.   ]]>
 456  *
 457  * Bitfield/set of flags generated from the AT-SPI specification.
 458  */
 459 typedef enum {
 460     ATSPI_KEY_PRESS,
 461     ATSPI_KEY_RELEASE,
 462     ATSPI_KEY_PRESSRELEASE,
 463     ATSPI_KEY_SYM,
 464     ATSPI_KEY_STRING,
 465 } AtspiKeySynthType;
 466
 467 /**
 468  * NUM_ATSPI_KEYSYNTHTYPES:
 469  *
 470  * 1 higher than the highest valid value of #AtspiKeySynthType.
 471  */
 472 #define NUM_ATSPI_KEYSYNTHTYPES (4+1)
 473
 474 /**
 475  *
 476 ATSPI_ModifierType:
 477  * @ATSPI_MODIFIER_SHIFT: <![CDATA[     The left or right 'Shift' key    ]]>
 478  * @ATSPI_MODIFIER_SHIFTLOCK: <![CDATA[     The ShiftLock or CapsLock key    ]]>
 479  * @ATSPI_MODIFIER_CONTROL: <![CDATA[     'Control'/'Ctrl'    ]]>
 480  * @ATSPI_MODIFIER_ALT: <![CDATA[     The Alt key (as opposed to AltGr)    ]]>
 481  * @ATSPI_MODIFIER_META: <![CDATA[     depending on the platform this may map to 'Window', 'Function', 'Meta',       'Menu', or 'NumLock'.         Such 'Meta keys' will map to one of META, META2, META3.       On X Windows platforms these META values map to        the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an event having       ModifierType::MODIFIER_META2 means that the 'Mod2Mask' bit is       set in the corresponding XEvent.   ]]>
 482  * @ATSPI_MODIFIER_META2: <![CDATA[]]>
 483  * @ATSPI_MODIFIER_META3: <![CDATA[]]>
 484  * @ATSPI_MODIFIER_NUMLOCK: <![CDATA[     A symbolic meta key name that is mapped by AT-SPI to the        appropriate META value, for the convenience of the client.   ]]>
 485  *
 486  * Bitfield/set of flags generated from the AT-SPI specification.
 487  */
 488 typedef enum {
 489     ATSPI_MODIFIER_SHIFT,
 490     ATSPI_MODIFIER_SHIFTLOCK,
 491     ATSPI_MODIFIER_CONTROL,
 492     ATSPI_MODIFIER_ALT,
 493     ATSPI_MODIFIER_META,
 494     ATSPI_MODIFIER_META2,
 495     ATSPI_MODIFIER_META3,
 496     ATSPI_MODIFIER_NUMLOCK,
 497 } AtspimodifierType;
 498
 499 /**
 500  * NUM_ATSPI_MODIFIERTYPES:
 501  *
 502  * 1 higher than the highest valid value of #AtspiModifierType.
 503  */
 504 #define NUM_ATSPI_MODIFIERTYPES (7+1)
 505
 506 /**
 507  *
 508 ATSPI_RelationType:
 509  * @ATSPI_RELATION_NULL: <![CDATA[     Not a meaningful relationship; clients should not normally encounter this RelationType value.    ]]>
 510  * @ATSPI_RELATION_LABEL_FOR: <![CDATA[     Object is a label for one or more other objects.    ]]>
 511  * @ATSPI_RELATION_LABELLED_BY: <![CDATA[     Object is labelled by one or more other objects.    ]]>
 512  * @ATSPI_RELATION_CONTROLLER_FOR: <![CDATA[     Object is an interactive object which modifies the state, onscreen location, or other attributes       of one or more target objects.    ]]>
 513  * @ATSPI_RELATION_CONTROLLED_BY: <![CDATA[     Object state, position, etc. is modified/controlled by user interaction with one or        more other objects.   For instance a viewport or scroll pane may be CONTROLLED_BY scrollbars.    ]]>
 514  * @ATSPI_RELATION_MEMBER_OF: <![CDATA[     Object has a grouping relationship (e.g. 'same group as') to one or more other objects.     ]]>
 515  * @ATSPI_RELATION_TOOLTIP_FOR: <![CDATA[     Object is a tooltip associated with another object.    ]]>
 516  * @ATSPI_RELATION_NODE_CHILD_OF: <![CDATA[     Object is a child of the target.   ]]>
 517  * @ATSPI_RELATION_NODE_PARENT_OF: <![CDATA[     Object is a parent of the target.   ]]>
 518  * @ATSPI_RELATION_EXTENDED: <![CDATA[     Used to indicate that a relationship exists, but its type is not specified in the enumeration       and must be obtained via a call to getRelationTypeName.     ]]>
 519  * @ATSPI_RELATION_FLOWS_TO: <![CDATA[     Object renders content which flows logically to another object.         For instance, text in a paragraph may flow to another object which is not the        'next sibling' in the accessibility hierarchy.    ]]>
 520  * @ATSPI_RELATION_FLOWS_FROM: <![CDATA[     Reciprocal of RELATION_FLOWS_TO.    ]]>
 521  * @ATSPI_RELATION_SUBWINDOW_OF: <![CDATA[     Object is visually and semantically considered a subwindow of another object, even though       it is not the object's child.  Useful when dealing with embedded applications and other cases       where the widget hierarchy does not map cleanly to the onscreen presentation.     ]]>
 522  * @ATSPI_RELATION_EMBEDS: <![CDATA[     Similar to SUBWINDOW_OF, but specifically used for cross-process embedding.     ]]>
 523  * @ATSPI_RELATION_EMBEDDED_BY: <![CDATA[     Reciprocal of RELATION_EMBEDS; Used to denote content rendered by embedded renderers that       live in a separate process space from the embedding context.     ]]>
 524  * @ATSPI_RELATION_POPUP_FOR: <![CDATA[     Denotes that the object is a transient window or frame associated with another onscreen object.       Similar to TOOLTIP_FOR, but more general.  Useful for windows which are technically        toplevels but which, for one or more reasons, do not explicitly cause their associated       window to lose 'window focus'. Creation of a ROLE_WINDOW object with the POPUP_FOR relation       usually requires some presentation action on the part of assistive technology clients, even though       the previous toplevel ROLE_FRAME object may still be the active window.     ]]>
 525  * @ATSPI_RELATION_PARENT_WINDOW_OF: <![CDATA[     This is the reciprocal relation to RELATION_POPUP_FOR.    ]]>
 526  * @ATSPI_RELATION_DESCRIPTION_FOR: <![CDATA[     Indicates that an object provides descriptive information        about another object; more verbose than RELATION_LABEL_FOR.    ]]>
 527  * @ATSPI_RELATION_DESCRIBED_BY: <![CDATA[     Indicates that another object provides descriptive information        about this object; more verbose than RELATION_LABELLED_BY.    ]]>
 528  * @ATSPI_RELATION_LAST_DEFINED: <![CDATA[     Do not use as a parameter value, used to determine the size of the enumeration.    ]]>
 529  *
 530  * <![CDATA[     RelationType specifies a relationship between objects (possibly one-to-many or many-to-one)       outside of the normal parent/child hierarchical relationship.  It allows better semantic       identification of how objects are associated with one another.       For instance the RELATION_LABELLED_BY relationship may be used to identify labelling information       that should accompany the accessibleName property when presenting an object's content or identity       to the end user.  Similarly, RELATION_CONTROLLER_FOR can be used to further specify the context       in which a valuator is useful, and/or the other UI components which are directly effected by       user interactions with the valuator. Common examples include association of scrollbars with       the viewport or panel which they control.   ]]>
 531  *
 532  * Bitfield/set of flags generated from the AT-SPI specification.
 533  */
 534 typedef enum {
 535     ATSPI_RELATION_NULL,
 536     ATSPI_RELATION_LABEL_FOR,
 537     ATSPI_RELATION_LABELLED_BY,
 538     ATSPI_RELATION_CONTROLLER_FOR,
 539     ATSPI_RELATION_CONTROLLED_BY,
 540     ATSPI_RELATION_MEMBER_OF,
 541     ATSPI_RELATION_TOOLTIP_FOR,
 542     ATSPI_RELATION_NODE_CHILD_OF,
 543     ATSPI_RELATION_NODE_PARENT_OF,
 544     ATSPI_RELATION_EXTENDED,
 545     ATSPI_RELATION_FLOWS_TO,
 546     ATSPI_RELATION_FLOWS_FROM,
 547     ATSPI_RELATION_SUBWINDOW_OF,
 548     ATSPI_RELATION_EMBEDS,
 549     ATSPI_RELATION_EMBEDDED_BY,
 550     ATSPI_RELATION_POPUP_FOR,
 551     ATSPI_RELATION_PARENT_WINDOW_OF,
 552     ATSPI_RELATION_DESCRIPTION_FOR,
 553     ATSPI_RELATION_DESCRIBED_BY,
 554     ATSPI_RELATION_LAST_DEFINED,
 555 } AtspiRelationType;
 556
 557 /**
 558  * NUM_ATSPI_RELATIONTYPES:
 559  *
 560  * 1 higher than the highest valid value of #AtspiRelationType.
 561  */
 562 #define NUM_ATSPI_RELATIONTYPES (19+1)
 563
 564 /**
 565  *
 566 ATSPI_Role:
 567  * @ATSPI_ROLE_INVALID: <![CDATA[     A Role indicating an error condition, such as uninitialized Role data.    ]]>
 568  * @ATSPI_ROLE_ACCELERATOR_LABEL: <![CDATA[     Object is a label indicating the keyboard accelerators for the parent     ]]>
 569  * @ATSPI_ROLE_ALERT: <![CDATA[     Object is used to alert the user about something    ]]>
 570  * @ATSPI_ROLE_ANIMATION: <![CDATA[     Object contains a dynamic or moving image of some kind    ]]>
 571  * @ATSPI_ROLE_ARROW: <![CDATA[     Object is a 2d directional indicator    ]]>
 572  * @ATSPI_ROLE_CALENDAR: <![CDATA[     Object contains one or more dates, usually arranged into a 2d list    ]]>
 573  * @ATSPI_ROLE_CANVAS: <![CDATA[     Object that can be drawn into and is used to trap events    ]]>
 574  * @ATSPI_ROLE_CHECK_BOX: <![CDATA[     A choice that can be checked or unchecked and provides a separate       indicator for the current state.   ]]>
 575  * @ATSPI_ROLE_CHECK_MENU_ITEM: <![CDATA[     A menu item that behaves like a check box (see ROLE_CHECK_BOX)    ]]>
 576  * @ATSPI_ROLE_COLOR_CHOOSER: <![CDATA[     A specialized dialog that lets the user choose a color.    ]]>
 577  * @ATSPI_ROLE_COLUMN_HEADER: <![CDATA[     The header for a column of data    ]]>
 578  * @ATSPI_ROLE_COMBO_BOX: <![CDATA[     A list of choices the user can select from    ]]>
 579  * @ATSPI_ROLE_DATE_EDITOR: <![CDATA[     An object which allows entry of a date    ]]>
 580  * @ATSPI_ROLE_DESKTOP_ICON: <![CDATA[     An inconifed internal frame within a DESKTOP_PANE    ]]>
 581  * @ATSPI_ROLE_DESKTOP_FRAME: <![CDATA[     A pane that supports internal frames and iconified versions of those       internal frames.   ]]>
 582  * @ATSPI_ROLE_DIAL: <![CDATA[     An object that allows a value to be changed via rotating a visual element,       or which displays a value via such a rotating element.    ]]>
 583  * @ATSPI_ROLE_DIALOG: <![CDATA[     A top level window with title bar and a border    ]]>
 584  * @ATSPI_ROLE_DIRECTORY_PANE: <![CDATA[     A pane that allows the user to navigate through and select the contents       of a directory   ]]>
 585  * @ATSPI_ROLE_DRAWING_AREA: <![CDATA[     A specialized dialog that displays the files in the directory and lets       the user select a file, browse a different directory, or specify a       filename.   ]]>
 586  * @ATSPI_ROLE_FILE_CHOOSER: <![CDATA[     An object used for drawing custom user interface elements.   ]]>
 587  * @ATSPI_ROLE_FILLER: <![CDATA[     A object that fills up space in a user interface   ]]>
 588  * @ATSPI_ROLE_FOCUS_TRAVERSABLE: <![CDATA[     Don't use, reserved for future use.    ]]>
 589  * @ATSPI_ROLE_FONT_CHOOSER: <![CDATA[     Allows selection of a display font    ]]>
 590  * @ATSPI_ROLE_FRAME: <![CDATA[     A top level window with a title bar, border, menubar, etc.    ]]>
 591  * @ATSPI_ROLE_GLASS_PANE: <![CDATA[     A pane that is guaranteed to be painted on top of all panes beneath it    ]]>
 592  * @ATSPI_ROLE_HTML_CONTAINER: <![CDATA[     A document container for HTML, whose children       represent the document content.   ]]>
 593  * @ATSPI_ROLE_ICON: <![CDATA[     A small fixed size picture, typically used to decorate components    ]]>
 594  * @ATSPI_ROLE_IMAGE: <![CDATA[     An image, typically static.    ]]>
 595  * @ATSPI_ROLE_INTERNAL_FRAME: <![CDATA[     A frame-like object that is clipped by a desktop pane.    ]]>
 596  * @ATSPI_ROLE_LABEL: <![CDATA[     An object used to present an icon or short string in an interface    ]]>
 597  * @ATSPI_ROLE_LAYERED_PANE: <![CDATA[     A specialized pane that allows its children to be drawn in layers,       providing a form of stacking order.   ]]>
 598  * @ATSPI_ROLE_LIST: <![CDATA[     An object that presents a list of objects to the user and allows the       user to select one or more of them.   ]]>
 599  * @ATSPI_ROLE_LIST_ITEM: <![CDATA[     An object that represents an element of a list.    ]]>
 600  * @ATSPI_ROLE_MENU: <![CDATA[     An object usually found inside a menu bar that contains a list of       actions the user can choose from.   ]]>
 601  * @ATSPI_ROLE_MENU_BAR: <![CDATA[     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.   ]]>
 602  * @ATSPI_ROLE_MENU_ITEM: <![CDATA[     An object usually contained in a menu that presents an action the       user can choose.   ]]>
 603  * @ATSPI_ROLE_OPTION_PANE: <![CDATA[     A specialized pane whose primary use is inside a DIALOG    ]]>
 604  * @ATSPI_ROLE_PAGE_TAB: <![CDATA[     An object that is a child of a page tab list    ]]>
 605  * @ATSPI_ROLE_PAGE_TAB_LIST: <![CDATA[     An object that presents a series of panels (or page tabs), one at a time,       through some mechanism provided by the object.   ]]>
 606  * @ATSPI_ROLE_PANEL: <![CDATA[     A generic container that is often used to group objects.    ]]>
 607  * @ATSPI_ROLE_PASSWORD_TEXT: <![CDATA[     A text object uses for passwords, or other places where the text       content is not shown visibly to the user.   ]]>
 608  * @ATSPI_ROLE_POPUP_MENU: <![CDATA[     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.   ]]>
 609  * @ATSPI_ROLE_PROGRESS_BAR: <![CDATA[     An object used to indicate how much of a task has been completed.    ]]>
 610  * @ATSPI_ROLE_PUSH_BUTTON: <![CDATA[     An object the user can manipulate to tell the application to do       something.   ]]>
 611  * @ATSPI_ROLE_RADIO_BUTTON: <![CDATA[     A specialized check box that will cause other radio buttons in the       same group to become uncghecked when this one is checked.   ]]>
 612  * @ATSPI_ROLE_RADIO_MENU_ITEM: <![CDATA[     Object is both a menu item and a "radio button" (see ROLE_RADIO_BUTTON)    ]]>
 613  * @ATSPI_ROLE_ROOT_PANE: <![CDATA[     A specialized pane that has a glass pane and a layered pane as its       children.   ]]>
 614  * @ATSPI_ROLE_ROW_HEADER: <![CDATA[     The header for a row of data    ]]>
 615  * @ATSPI_ROLE_SCROLL_BAR: <![CDATA[     An object usually used to allow a user to incrementally view a large       amount of data by moving the bounds of a viewport along a one-dimensional axis.   ]]>
 616  * @ATSPI_ROLE_SCROLL_PANE: <![CDATA[     An object that allows a user to incrementally view a large amount       of information.  ROLE_SCROLL_PANE objects are usually accompanied by       ROLE_SCROLL_BAR controllers, on which the RELATION_CONTROLLER_FOR and       RELATION_CONTROLLED_BY reciprocal relations are set; \see        Accessibility::RelationSet.   ]]>
 617  * @ATSPI_ROLE_SEPARATOR: <![CDATA[     An object usually contained in a menu to provide a visible and       logical separation of the contents in a menu.   ]]>
 618  * @ATSPI_ROLE_SLIDER: <![CDATA[     An object that allows the user to select from a bounded range    ]]>
 619  * @ATSPI_ROLE_SPIN_BUTTON: <![CDATA[     An object which allows one of a set of choices to be selected,        and which displays the current choice.  Unlike ROLE_SCROLL_BAR,       ROLE_SLIDER objects need not control 'viewport'-like objects.   ]]>
 620  * @ATSPI_ROLE_SPLIT_PANE: <![CDATA[     A specialized panel that presents two other panels at the same time.    ]]>
 621  * @ATSPI_ROLE_STATUS_BAR: <![CDATA[     Object displays non-quantitative status information (c.f. ROLE_PROGRESS_BAR)    ]]>
 622  * @ATSPI_ROLE_TABLE: <![CDATA[     An object used to repesent information in terms of rows and columns.    ]]>
 623  * @ATSPI_ROLE_TABLE_CELL: <![CDATA[     A 'cell' or discrete child within a Table. \note Table cells need not have ROLE_TABLE_CELL,        other RoleType values are valid as well.     ]]>
 624  * @ATSPI_ROLE_TABLE_COLUMN_HEADER: <![CDATA[     An object which labels a particular column in a Table.    ]]>
 625  * @ATSPI_ROLE_TABLE_ROW_HEADER: <![CDATA[     An object which labels a particular row in a Table. Table rows and columns may also be        labelled via the RELATION_LABEL_FOR/RELATION_LABELLED_BY relationships;        see Accessibility.RelationSet.    ]]>
 626  * @ATSPI_ROLE_TEAROFF_MENU_ITEM: <![CDATA[     Object allows menu to be removed from menubar and shown in its own window.    ]]>
 627  * @ATSPI_ROLE_TERMINAL: <![CDATA[     An object that emulates a terminal    ]]>
 628  * @ATSPI_ROLE_TEXT: <![CDATA[     An object that presents text to the user, of nonspecific type.    ]]>
 629  * @ATSPI_ROLE_TOGGLE_BUTTON: <![CDATA[     A specialized push button that can be checked or unchecked, but does       not procide a separate indicator for the current state.   ]]>
 630  * @ATSPI_ROLE_TOOL_BAR: <![CDATA[     A bar or palette usually composed of push buttons or toggle buttons   ]]>
 631  * @ATSPI_ROLE_TOOL_TIP: <![CDATA[     An object that provides information about another object   ]]>
 632  * @ATSPI_ROLE_TREE: <![CDATA[     An object used to repsent hierarchical information to the user.    ]]>
 633  * @ATSPI_ROLE_TREE_TABLE: <![CDATA[     An object that presents both tabular and hierarchical info to the user    ]]>
 634  * @ATSPI_ROLE_UNKNOWN: <![CDATA[     The object contains some Accessible information, but its role is       not known.     ]]>
 635  * @ATSPI_ROLE_VIEWPORT: <![CDATA[     An object usually used in a scroll pane, or to otherwise clip a larger object or        content renderer to a specific onscreen viewport.    ]]>
 636  * @ATSPI_ROLE_WINDOW: <![CDATA[     A &#168;top level window&#168; with no title or border.    ]]>
 637  * @ATSPI_ROLE_EXTENDED: <![CDATA[     means that the role for this item is known, but not included in the        core enumeration    ]]>
 638  * @ATSPI_ROLE_HEADER: <![CDATA[     An object that serves as a document header.    ]]>
 639  * @ATSPI_ROLE_FOOTER: <![CDATA[     An object that serves as a document footer.    ]]>
 640  * @ATSPI_ROLE_PARAGRAPH: <![CDATA[     An object which is contains a single paragraph of text content. See also ROLE_TEXT.    ]]>
 641  * @ATSPI_ROLE_RULER: <![CDATA[     An object which describes margins and tab stops, etc.        for text objects which it controls        (should have CONTROLLER_FOR relation to such).    ]]>
 642  * @ATSPI_ROLE_APPLICATION: <![CDATA[     An object corresponding to the toplevel accessible of an        application, which may contain ROLE_FRAME objects or other       accessible objects.  Children of AccessibleDesktop objects        are generally ROLE_APPLICATION objects.   ]]>
 643  * @ATSPI_ROLE_AUTOCOMPLETE: <![CDATA[     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.   ]]>
 644  * @ATSPI_ROLE_EDITBAR: <![CDATA[     The object is an editable text object in a toolbar.   ]]>
 645  * @ATSPI_ROLE_EMBEDDED: <![CDATA[     The object is an embedded component container.  This role is a        "grouping" hint that the contained objects share a context which is        different from the container in which this accessible is embedded.       In particular, it is used for some kinds of document embedding, and       for embedding of out-of-process component, "panel applets", etc.   ]]>
 646  * @ATSPI_ROLE_ENTRY: <![CDATA[     The object is a component whose textual content may be entered or modified by the user,         provided STATE_EDITABLE is present.       A readonly ROLE_ENTRY object (i.e. where STATE_EDITABLE is not present) implies a       read-only 'text field' in a form, as opposed to a title, label, or caption.     ]]>
 647  * @ATSPI_ROLE_CHART: <![CDATA[     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.         See ROLE_CAPTION     ]]>
 648  * @ATSPI_ROLE_CAPTION: <![CDATA[     The object contains descriptive information, usually textual, about another user interface       element such as a table, chart, or image.     ]]>
 649  * @ATSPI_ROLE_DOCUMENT_FRAME: <![CDATA[     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.     ]]>
 650  * @ATSPI_ROLE_HEADING: <![CDATA[     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.      ]]>
 651  * @ATSPI_ROLE_PAGE: <![CDATA[     The object is a containing instance which encapsulates a page of        information.  ROLE_PAGE is used in documents and content which support       a paginated navigation model.     ]]>
 652  * @ATSPI_ROLE_SECTION: <![CDATA[     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.     ]]>
 653  * @ATSPI_ROLE_REDUNDANT_OBJECT: <![CDATA[     The object is redundant with another object in the hierarchy,        and is exposed for purely technical reasons.  Objects of this role        should be ignored by clients, if they are encountered at all.      ]]>
 654  * @ATSPI_ROLE_FORM: <![CDATA[     The object is a containing instance of document content which       has within it components with which the user can interact in order to       input information; i.e. the object is a container for pushbuttons,       comboboxes, text input fields, and other 'GUI' components.       ROLE_FORM should not, in general, be used for toplevel GUI containers       or dialogs, but should be reserved for 'GUI' containers which occur within       document content, for instance within Web documents, presentations, or        text documents.  Unlike other GUI containers and dialogs which occur inside       application instances, ROLE_FORM containers' components are associated with       the current document, rather than the current foreground application or       viewer instance.     ]]>
 655  * @ATSPI_ROLE_LINK: <![CDATA[     The object is a hypertext anchor, i.e. a "link" in a       hypertext document.  Such objects are distinct from 'inline'       content which may also use the Hypertext/Hyperlink interfaces       to indicate the range/location within a text object where       an inline or embedded object lies.     ]]>
 656  * @ATSPI_ROLE_INPUT_METHOD_WINDOW: <![CDATA[     The object is a window or similar viewport which is used       to allow composition or input of a 'complex character',       in other words it is an "input method window."     ]]>
 657  * @ATSPI_ROLE_LAST_DEFINED: <![CDATA[     Not a valid role, used for finding end of enumeration.    ]]>
 658  *
 659  * Bitfield/set of flags generated from the AT-SPI specification.
 660  */
 661 typedef enum {
 662     ATSPI_ROLE_INVALID,
 663     ATSPI_ROLE_ACCELERATOR_LABEL,
 664     ATSPI_ROLE_ALERT,
 665     ATSPI_ROLE_ANIMATION,
 666     ATSPI_ROLE_ARROW,
 667     ATSPI_ROLE_CALENDAR,
 668     ATSPI_ROLE_CANVAS,
 669     ATSPI_ROLE_CHECK_BOX,
 670     ATSPI_ROLE_CHECK_MENU_ITEM,
 671     ATSPI_ROLE_COLOR_CHOOSER,
 672     ATSPI_ROLE_COLUMN_HEADER,
 673     ATSPI_ROLE_COMBO_BOX,
 674     ATSPI_ROLE_DATE_EDITOR,
 675     ATSPI_ROLE_DESKTOP_ICON,
 676     ATSPI_ROLE_DESKTOP_FRAME,
 677     ATSPI_ROLE_DIAL,
 678     ATSPI_ROLE_DIALOG,
 679     ATSPI_ROLE_DIRECTORY_PANE,
 680     ATSPI_ROLE_DRAWING_AREA,
 681     ATSPI_ROLE_FILE_CHOOSER,
 682     ATSPI_ROLE_FILLER,
 683     ATSPI_ROLE_FOCUS_TRAVERSABLE,
 684     ATSPI_ROLE_FONT_CHOOSER,
 685     ATSPI_ROLE_FRAME,
 686     ATSPI_ROLE_GLASS_PANE,
 687     ATSPI_ROLE_HTML_CONTAINER,
 688     ATSPI_ROLE_ICON,
 689     ATSPI_ROLE_IMAGE,
 690     ATSPI_ROLE_INTERNAL_FRAME,
 691     ATSPI_ROLE_LABEL,
 692     ATSPI_ROLE_LAYERED_PANE,
 693     ATSPI_ROLE_LIST,
 694     ATSPI_ROLE_LIST_ITEM,
 695     ATSPI_ROLE_MENU,
 696     ATSPI_ROLE_MENU_BAR,
 697     ATSPI_ROLE_MENU_ITEM,
 698     ATSPI_ROLE_OPTION_PANE,
 699     ATSPI_ROLE_PAGE_TAB,
 700     ATSPI_ROLE_PAGE_TAB_LIST,
 701     ATSPI_ROLE_PANEL,
 702     ATSPI_ROLE_PASSWORD_TEXT,
 703     ATSPI_ROLE_POPUP_MENU,
 704     ATSPI_ROLE_PROGRESS_BAR,
 705     ATSPI_ROLE_PUSH_BUTTON,
 706     ATSPI_ROLE_RADIO_BUTTON,
 707     ATSPI_ROLE_RADIO_MENU_ITEM,
 708     ATSPI_ROLE_ROOT_PANE,
 709     ATSPI_ROLE_ROW_HEADER,
 710     ATSPI_ROLE_SCROLL_BAR,
 711     ATSPI_ROLE_SCROLL_PANE,
 712     ATSPI_ROLE_SEPARATOR,
 713     ATSPI_ROLE_SLIDER,
 714     ATSPI_ROLE_SPIN_BUTTON,
 715     ATSPI_ROLE_SPLIT_PANE,
 716     ATSPI_ROLE_STATUS_BAR,
 717     ATSPI_ROLE_TABLE,
 718     ATSPI_ROLE_TABLE_CELL,
 719     ATSPI_ROLE_TABLE_COLUMN_HEADER,
 720     ATSPI_ROLE_TABLE_ROW_HEADER,
 721     ATSPI_ROLE_TEAROFF_MENU_ITEM,
 722     ATSPI_ROLE_TERMINAL,
 723     ATSPI_ROLE_TEXT,
 724     ATSPI_ROLE_TOGGLE_BUTTON,
 725     ATSPI_ROLE_TOOL_BAR,
 726     ATSPI_ROLE_TOOL_TIP,
 727     ATSPI_ROLE_TREE,
 728     ATSPI_ROLE_TREE_TABLE,
 729     ATSPI_ROLE_UNKNOWN,
 730     ATSPI_ROLE_VIEWPORT,
 731     ATSPI_ROLE_WINDOW,
 732     ATSPI_ROLE_EXTENDED,
 733     ATSPI_ROLE_HEADER,
 734     ATSPI_ROLE_FOOTER,
 735     ATSPI_ROLE_PARAGRAPH,
 736     ATSPI_ROLE_RULER,
 737     ATSPI_ROLE_APPLICATION,
 738     ATSPI_ROLE_AUTOCOMPLETE,
 739     ATSPI_ROLE_EDITBAR,
 740     ATSPI_ROLE_EMBEDDED,
 741     ATSPI_ROLE_ENTRY,
 742     ATSPI_ROLE_CHART,
 743     ATSPI_ROLE_CAPTION,
 744     ATSPI_ROLE_DOCUMENT_FRAME,
 745     ATSPI_ROLE_HEADING,
 746     ATSPI_ROLE_PAGE,
 747     ATSPI_ROLE_SECTION,
 748     ATSPI_ROLE_REDUNDANT_OBJECT,
 749     ATSPI_ROLE_FORM,
 750     ATSPI_ROLE_LINK,
 751     ATSPI_ROLE_INPUT_METHOD_WINDOW,
 752     ATSPI_ROLE_LAST_DEFINED,
 753 } AtspiRole;
 754
 755 /**
 756  * NUM_ATSPI_ROLES:
 757  *
 758  * 1 higher than the highest valid value of #AtspiRole.
 759  */
 760 #define NUM_ATSPI_ROLES (90+1)
 761
 762
 763 #ifdef __cplusplus
 764 }
 765 #endif
 766 #endif  /* _ATSPI_CONSTANTS_H_ */