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