atspi/atspi-constants.h

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