File indexing completed on 2024-04-14 04:37:53

0001 /* TODO: Auto-generate this file again
0002 
0003 
0004 
0005  !\mainpage AT-SPI Interfaces and Subinterfaces
0006 
0007   This is the main documentation page for the
0008   Assistive Technology Service Provider Interface (AT-SPI).
0009 
0010   \section apps Applications and Interface Components
0011   Namespace Accessibility includes service APIs implemented by
0012   participating applications and their user interface components:\n\n
0013   Accessibility::Accessible\n
0014   Accessibility::Application\n
0015   Accessibility::Desktop\n
0016   Accessibility::Collecgtion\n
0017   Accessibility::Component\n
0018   Accessibility::Hypertext\n
0019   Accessibility::Image\n
0020   Accessibility::Selection\n
0021   Accessibility::Table\n
0022   Accessibility::Text\n
0023   Accessibility::EditableText\n
0024   Accessibility::Value
0025 
0026   \section types Enumerated Types
0027   Accessibility defines a number of key enumerated types, including:\n\n
0028   Accessibility::RelationType\n
0029   Accessibility::Role\n
0030   Accessibility::StateType\n
0031   Accessibility::Event\n
0032   Accessibility::EventDetails \n
0033 
0034   \section Registry
0035   Accessibility also includes Accessibility::Registry,
0036   which is the service used by assistive technologies and related
0037   AT-SPI clients to register interest in certain classes of events,
0038   enumerate the currently available desktop and application list,
0039   and to synthesize certain kinds of device events.
0040 
0041   \section listeners Event Listener Interfaces
0042   Accessibility::EventListener\n
0043   Accessibility::DeviceEventListener
0044 
0045   \section helpers Helper Interfaces
0046 
0047   The following interfaces may be implemented by assistive technologies
0048   themselves, in order to export their services in a consistent manner or
0049   in order to interoperate with other applications or desktop services.\n
0050 
0051   Accessibility::LoginHelper : Implemented by adaptive technologies which
0052   need to participate in user-authentication or login activities, and which
0053   therefore may need negotiation with authentication agents or processes.\n
0054 
0055   Accessibility::Selector [NEW]: Implemented by user agents or assistive
0056   technologies which export lists of choices from which the end-user is
0057   expected to make selections.  Useful for various types of remote
0058   activation or intercommunication between multiple ATs.
0059 
0060  */
0061 
0062 #ifndef _ATSPI_CONSTANTS_H_
0063 #define _ATSPI_CONSTANTS_H_
0064 #ifdef __cplusplus
0065 extern "C" {
0066 #endif
0067 
0068 /**
0069  * AtspiLocaleType:
0070  * @ATSPI_LOCALE_TYPE_MESSAGES: For localizable natural-language messages.
0071  * @ATSPI_LOCALE_TYPE_COLLATE: For regular expression matching and string 
0072  * collation. 
0073  * @ATSPI_LOCALE_TYPE_CTYPE: For regular expression matching, character 
0074  * classification, conversion, case-sensitive comparison, and wide character 
0075  * functions. 
0076  * @ATSPI_LOCALE_TYPE_MONETARY: For monetary formatting.
0077  * @ATSPI_LOCALE_TYPE_NUMERIC: For number formatting (such as the decimal 
0078  * point and the thousands separator).
0079  * @ATSPI_LOCALE_TYPE_TIME: For time and date formatting.
0080  *
0081  * Used by interfaces #AtspiText and #AtspiDocument, this
0082  * enumeration corresponds to the POSIX 'setlocale' enum values.
0083  *
0084  **/
0085 typedef enum {
0086     ATSPI_LOCALE_TYPE_MESSAGES,
0087     ATSPI_LOCALE_TYPE_COLLATE,
0088     ATSPI_LOCALE_TYPE_CTYPE,
0089     ATSPI_LOCALE_TYPE_MONETARY,
0090     ATSPI_LOCALE_TYPE_NUMERIC,
0091     ATSPI_LOCALE_TYPE_TIME,
0092 } AtspiLocaleType;
0093 
0094 /**
0095  * ATSPI_LOCALE_TYPE_COUNT:
0096  *
0097  * One higher than the highest valid value of #AtspiLocaleType.
0098  **/
0099 #define ATSPI_LOCALE_TYPE _COUNT(5+1)
0100 
0101 /**
0102  * AtspiCoordType:
0103  * @ATSPI_COORD_TYPE_SCREEN: Specifies xy coordinates relative to the screen.
0104  * @ATSPI_COORD_TYPE_WINDOW: Specifies xy coordinates relative to the widget's 
0105  * top-level window.
0106  *
0107  * Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces
0108  * to specify whether coordinates are relative to the window or the screen.
0109  *
0110  **/
0111 typedef enum {
0112     ATSPI_COORD_TYPE_SCREEN,
0113     ATSPI_COORD_TYPE_WINDOW,
0114 } AtspiCoordType;
0115 
0116 /**
0117  * ATSPI_COORD_TYPE_COUNT:
0118  *
0119  * One higher than the highest valid value of #AtspiCoordType.
0120  **/
0121 #define ATSPI_COORD_TYPE_COUNT (1+1)
0122 
0123 /**
0124  * AtspiCollectionSortOrder:
0125  * @ATSPI_Collection_SORT_ORDER_INVALID:
0126  * @ATSPI_Collection_SORT_ORDER_CANONICAL:
0127  * @ATSPI_Collection_SORT_ORDER_FLOW:
0128  * @ATSPI_Collection_SORT_ORDER_TAB:
0129  * @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL:
0130  * @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW:
0131  * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB:
0132  * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED:
0133  *
0134  * Enumeration used by interface #AtspiCollection to specify
0135  * the way #AtspiAccesible objects should be sorted.
0136  *
0137  **/
0138 typedef enum {
0139     ATSPI_Collection_SORT_ORDER_INVALID,
0140     ATSPI_Collection_SORT_ORDER_CANONICAL,
0141     ATSPI_Collection_SORT_ORDER_FLOW,
0142     ATSPI_Collection_SORT_ORDER_TAB,
0143     ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL,
0144     ATSPI_Collection_SORT_ORDER_REVERSE_FLOW,
0145     ATSPI_Collection_SORT_ORDER_REVERSE_TAB,
0146     ATSPI_Collection_SORT_ORDER_LAST_DEFINED,
0147 } AtspiCollectionSortOrder;
0148 
0149 /**
0150  * ATSPI_SORTORDER_COUNT:
0151  *
0152  * One higher than the highest valid value of #AtspiCollectionSortOrder.
0153  */
0154 #define ATSPI_SORTORDER_COUNT (7+1)
0155 
0156 /**
0157  * AtspiCollectionMatchType:
0158  * @ATSPI_Collection_MATCH_INVALID: Indicates an error condition or 
0159  * uninitialized value.
0160  * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met.
0161  * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met.
0162  * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met.
0163  * @ATSPI_Collection_MATCH_EMPTY: Same as @ATSPI_Collection_MATCH_ALL if
0164  * the criteria is non-empty; for empty criteria this rule requires returned 
0165  * value to also have empty set. 
0166  * @ATSPI_Collection_MATCH_LAST_DEFINED: Used only to determine the end of the
0167  * enumeration.
0168  *
0169  * Enumeration used by #AtspiMatchRule to specify
0170  * how to interpret #AtspiAccesible objects.
0171  *
0172  **/
0173 typedef enum {
0174     ATSPI_Collection_MATCH_INVALID,
0175     ATSPI_Collection_MATCH_ALL,
0176     ATSPI_Collection_MATCH_ANY,
0177     ATSPI_Collection_MATCH_NONE,
0178     ATSPI_Collection_MATCH_EMPTY,
0179     ATSPI_Collection_MATCH_LAST_DEFINED,
0180 } AtspiCollectionMatchType;
0181 
0182 /**
0183  * ATSPI_MATCHTYPE_COUNT:
0184  *
0185  * One higher than the highest valid value of #AtspiCollectionMatchType.
0186  **/
0187 #define ATSPI_MATCHTYPES_COUNT (5+1)
0188 
0189 /**
0190  * AtspiCollectionTreeTraversalType:
0191  * @ATSPI_Collection_TREE_RESTRICT_CHILDREN:
0192  * @ATSPI_Collection_TREE_RESTRICT_SIBLING:
0193  * @ATSPI_Collection_TREE_INORDER:
0194  * @ATSPI_Collection_TREE_LAST_DEFINED:
0195  *
0196  * Enumeration used by interface #AtspiCollection to specify
0197  * restrictions on #AtspiAccesible objects to be traversed.
0198  *
0199  **/
0200 typedef enum {
0201     ATSPI_Collection_TREE_RESTRICT_CHILDREN,
0202     ATSPI_Collection_TREE_RESTRICT_SIBLING,
0203     ATSPI_Collection_TREE_INORDER,
0204     ATSPI_Collection_TREE_LAST_DEFINED,
0205 } AtspiCollectionTreeTraversalType;
0206 
0207 /**
0208  * ATSPI_TREETRAVERSALTYPE_COUNT:
0209  *
0210  * One higher than the highest valid value of
0211  * #AtspiCollection_TreeTraversalType.
0212  */
0213 #define ATSPI_TREETRAVERSALTYPE _COUNT(3+1)
0214 
0215 /**
0216  * AtspiComponentLayer:
0217  * @ATSPI_LAYER_INVALID: Indicates an error condition or uninitialized value.
0218  * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything else
0219  * is painted.        The 'desktop background' is generally in this layer.
0220  * @ATSPI_LAYER_CANVAS: The 'background' layer for most content renderers and
0221  * UI #AtspiComponent containers.
0222  * @ATSPI_LAYER_WIDGET: The layer in which the majority of ordinary
0223  * 'foreground' widgets reside.
0224  * @ATSPI_LAYER_MDI: A special layer between @ATSPI_LAYER_CANVAS and 
0225  * @ATSPI_LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames) 
0226  * reside. See #atspi_component_get_mdi_z_order. 
0227  * @ATSPI_LAYER_POPUP: A layer for popup window content, above
0228  * @ATSPI_LAYER_WIDGET.
0229  * @ATSPI_LAYER_OVERLAY: The topmost layer.
0230  * @ATSPI_LAYER_WINDOW: The layer in which a toplevel window background usually
0231  * resides.
0232  * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the
0233  * enumeration.
0234  *
0235  * The #AtspiComponentLayer of an #AtspiComponent instance indicates its 
0236  * relative stacking order with respect to the onscreen visual representation 
0237  * of the UI. #AtspiComponentLayer, in combination with #AtspiComponent bounds 
0238  * information, can be used to compute the visibility of all or part of a 
0239  * component.  This is important in programmatic determination of 
0240  * region-of-interest for magnification, and in 
0241  * flat screen review models of the screen, as well as
0242  * for other uses. Objects residing in two of the #AtspiComponentLayer 
0243  * categories support further z-ordering information, with respect to their 
0244  * peers in the same layer: namely, @ATSPI_LAYER_WINDOW and 
0245  * @ATSPI_LAYER_MDI.  Relative stacking order for other objects within the 
0246  * same layer is not available; the recommended heuristic is 
0247  * first child paints first. In other words, assume that the 
0248  * first siblings in the child list are subject to being overpainted by later 
0249  * siblings if their bounds intersect. The order of layers, from bottom to top,
0250  *  is: @ATSPI_LAYER_BACKGROUND, @ATSPI_LAYER_WINDOW, @ATSPI_LAYER_MDI,
0251  * @ATSPI_LAYER_CANVAS, @ATSPI_LAYER_WIDGET, @ATSPI_LAYER_POPUP, and       
0252  * @ATSPI_LAYER_OVERLAY.
0253  *
0254  */
0255 typedef enum {
0256     ATSPI_LAYER_INVALID,
0257     ATSPI_LAYER_BACKGROUND,
0258     ATSPI_LAYER_CANVAS,
0259     ATSPI_LAYER_WIDGET,
0260     ATSPI_LAYER_MDI,
0261     ATSPI_LAYER_POPUP,
0262     ATSPI_LAYER_OVERLAY,
0263     ATSPI_LAYER_WINDOW,
0264     ATSPI_LAYER_LAST_DEFINED,
0265 } AtspiComponentLayer;
0266 
0267 /**
0268  * ATSPI_COMPONENTLAYER_COUNT:
0269  *
0270  * One higher than the highest valid value of #AtspiComponentLayer.
0271  **/
0272 #define ATSPI_COMPONENTLAYER_COUNT (8+1)
0273 
0274 /**
0275  * AtspiTextBoundaryType:
0276  * @ATSPI_TEXT_BOUNDARY_CHAR: An #AtspiText instance is bounded by this 
0277  * character only. Start and end offsets differ by one, by definition, 
0278  * for this value.
0279  * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word; i.e.
0280  * range is from start of one word to the start of another word.
0281  * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word; i.e.
0282  * range is from the end of one word to the end of another. Some locales
0283  * may not distinguish between words and characters or glyphs. In particular,
0284  * those locales which use wholly or partially ideographic character sets. 
0285  * In these cases, characters may be returned in lieu of multi-character
0286  * substrings.
0287  * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: Boundary condition is start of a
0288  * sentence, as determined by the application. Some locales or
0289  * character sets may not include explicit sentence delimiters, so this
0290  * boundary type can not always be honored. Some locales will return lines
0291  * of text instead of grammatical sentences.
0292  * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: Boundary condition is end of a sentence,
0293  * as determined by the application, including the sentence-delimiting
0294  * character, for instance '.' Some locales or character sets may not
0295  * include explicit sentence delimiters, so this boundary type can not
0296  * always be honored. Some locales will return lines of text instead of
0297  * grammatical sentences.
0298  * @ATSPI_TEXT_BOUNDARY_LINE_START: Boundary condition is the start of a line;
0299  * i.e. range is from start of one line to the start of another.  This
0300  * generally means that an end-of-line character will appear at the end of
0301  * the range.
0302  * @ATSPI_TEXT_BOUNDARY_LINE_END: Boundary condition is the end of a line; i.e.
0303  * range is from start of one line to the start of another.  This generally 
0304  * means that an end-of-line character will be the first character of the
0305  * range.
0306  *
0307  * Specifies the boundary conditions determining a run of text as returned from
0308  * #atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, and
0309  * #atspi_text_get_text_before_offset.
0310  *
0311  **/
0312 typedef enum {
0313     ATSPI_TEXT_BOUNDARY_CHAR,
0314     ATSPI_TEXT_BOUNDARY_WORD_START,
0315     ATSPI_TEXT_BOUNDARY_WORD_END,
0316     ATSPI_TEXT_BOUNDARY_SENTENCE_START,
0317     ATSPI_TEXT_BOUNDARY_SENTENCE_END,
0318     ATSPI_TEXT_BOUNDARY_LINE_START,
0319     ATSPI_TEXT_BOUNDARY_LINE_END,
0320 } AtspiTextBoundaryType;
0321 
0322 /**
0323  * ATSPI_TEXT_BOUNDARY_TYPE_COUNT:
0324  *
0325  * One higher than the highest valid value of #AtspiTextBoundaryType.
0326  */
0327 #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)
0328 
0329 /**
0330  * AtspiTextClipType:
0331  * @ATSPI_TEXT_CLIP_NONE: No characters/glyphs are omitted.
0332  * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinate
0333  * are omitted.
0334  * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum
0335  * coordinate are omitted.
0336  * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region
0337  * bounded by min and max are retained.
0338  *
0339  * Enumeration used by interface #AtspiText to indicate
0340  * how to treat characters intersecting bounding boxes.
0341  *
0342  **/
0343 typedef enum {
0344     ATSPI_TEXT_CLIP_NONE,
0345     ATSPI_TEXT_CLIP_MIN,
0346     ATSPI_TEXT_CLIP_MAX,
0347     ATSPI_TEXT_CLIP_BOTH,
0348 } AtspiTextClipType;
0349 
0350 /**
0351  * ATSPI_TEXT_CLIP_TYPE_COUNT:
0352  *
0353  * One higher than the highest valid value of #AtspiTextClipType.
0354  */
0355 #define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1)
0356 
0357 /**
0358  * AtspiStateType:
0359  * @ATSPI_STATE_INVALID: Indicates an invalid state - probably an error 
0360  * condition.
0361  * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, or
0362  * is an active subelement within a container or table.
0363  * @ATSPI_STATE_ARMED: Indicates that the object is armed.
0364  * @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen
0365  * representation is in the process of changing, or       the object is
0366  * temporarily unavailable for interaction due to activity already in progress.
0367  * @ATSPI_STATE_CHECKED: Indicates this object is currently checked.
0368  * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed.
0369  * @ATSPI_STATE_DEFUNCT: Indicates that this object no longer has a valid
0370  * backing widget        (for instance, if its peer object has been destroyed).
0371  * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of this
0372  * object.
0373  * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that it
0374  * currently reflects some application state. Objects that are "greyed out"
0375  * may lack this state, and may lack the @ATSPI_STATE_SENSITIVE if direct
0376  * user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED. 
0377  * See @ATSPI_STATE_SENSITIVE.
0378  * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive
0379  * disclosure of its children.
0380  * @ATSPI_STATE_EXPANDED: Indicates this object is expanded.
0381  * @ATSPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus,
0382  * which means all       events resulting from typing on the keyboard will
0383  * normally be passed       to it when it has focus.
0384  * @ATSPI_STATE_FOCUSED: Indicates this object currently has the keyboard
0385  * focus.
0386  * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated
0387  * tooltip.
0388  * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of this object is
0389  * horizontal.
0390  * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is
0391  * represented only by an icon.
0392  * @ATSPI_STATE_MODAL: Indicates something must be done with this object
0393  * before the user can interact with an object in a different window.
0394  * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multiple
0395  * lines of text.
0396  * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one of
0397  * its children to be selected at the same time, or in the case of text
0398  * objects, that the object supports non-contiguous text selections.
0399  * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its
0400  * rectangular region. It also indicates an alpha value of unity, if it
0401  * supports alpha blending.
0402  * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed.
0403  * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not
0404  * fixed.
0405  * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object
0406  * that allows its children to be selected and that this child is one of
0407  * those children       that can be selected.
0408  * @ATSPI_STATE_SELECTED: Indicates this object is the child of an object that
0409  * allows its children to be selected and that this child is one of those
0410  * children that has been selected.
0411  * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user
0412  * interaction. @ATSPI_STATE_SENSITIVE usually accompanies.
0413  * @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the 
0414  * absence of @ATSPI_STATE_ENABLED if the current visible state of the control 
0415  * is "disconnected" from the application state.  In such cases, direct user
0416  * interaction can often result in the object gaining @ATSPI_STATE_SENSITIVE, 
0417  * for instance if a user makes an explicit selection using an object whose
0418  * current state is ambiguous or undefined. See @ATSPI_STATE_ENABLED,
0419  * @ATSPI_STATE_INDETERMINATE.
0420  * @ATSPI_STATE_SHOWING: Indicates this object, the object's parent, the
0421  * object's parent's parent, and so on, are all 'shown' to the end-user,
0422  * i.e. subject to "exposure" if blocking or obscuring objects do not
0423  * interpose between this object and the top of the window stack.
0424  * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only a
0425  * single line of text.
0426  * @ATSPI_STATE_STALE: Indicates that the information returned for this object
0427  * may no longer be synchronized with the application state.  This can occur
0428  * if the object has @ATSPI_STATE_TRANSIENT, and can also occur towards the 
0429  * end of the object peer's lifecycle.
0430  * @ATSPI_STATE_TRANSIENT: Indicates this object is transient.
0431  * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is vertical;
0432  * for example this state may appear on such objects as scrollbars, text
0433  * objects (with vertical text flow), separators, etc.
0434  * @ATSPI_STATE_VISIBLE: Indicates this object is visible, e.g. has been
0435  * explicitly marked for exposure to the user. @ATSPI_STATE_VISIBLE is no 
0436  * guarantee that the object is actually unobscured on the screen, only that 
0437  * it is 'potentially' visible, barring obstruction, being scrolled or clipped 
0438  * out of the field of view, or having an ancestor container that has not yet 
0439  * made visible. A widget is potentially onscreen if it has both 
0440  * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING. The absence of 
0441  * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING is
0442  * semantically equivalent to saying that an object is 'hidden'.
0443  * @ATSPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed"
0444  * event is sent when children become 'active' (i.e. are selected or
0445  * navigated to onscreen).  Used to prevent need to enumerate all children
0446  * in very large containers, like tables. The presence of
0447  * @ATSPI_STATE_MANAGES_DESCENDANTS is an indication to the client that the
0448  * children should not, and need not, be enumerated by the client.
0449  * Objects implementing this state are expected to provide relevant state      
0450  * notifications to listening clients, for instance notifications of 
0451  * visibility changes and activation of their contained child objects, without 
0452  * the client having previously requested references to those children.
0453  * @ATSPI_STATE_INDETERMINATE: Indicates that a check box or other boolean
0454  * indicator is in a state other than checked or not checked.  This
0455  * usually means that the boolean value reflected or controlled by the
0456  * object does not apply consistently to the entire current context.      
0457  * For example, a checkbox for the "Bold" attribute of text may have
0458  * @ATSPI_STATE_INDETERMINATE if the currently selected text contains a mixture
0459  * of weight attributes. In many cases interacting with a
0460  * @ATSPI_STATE_INDETERMINATE object will cause the context's corresponding
0461  * boolean attribute to be homogenized, whereupon the object will lose
0462  * @ATSPI_STATE_INDETERMINATE and a corresponding state-changed event will be
0463  * fired.
0464  * @ATSPI_STATE_REQUIRED: Indicates that user interaction with this object is
0465  * 'required' from the user, for instance before completing the
0466  * processing of a form.
0467  * @ATSPI_STATE_TRUNCATED:    Indicates that an object's onscreen content
0468  * is truncated, e.g. a text value in a spreadsheet cell.
0469  * @ATSPI_STATE_ANIMATED: Indicates this object's visual representation is
0470  * dynamic, not static. This state may be applied to an object during an
0471  * animated 'effect' and be removed from the object once its visual
0472  * representation becomes static. Some applications, notably content viewers,
0473  * may not be able to detect all kinds of animated content.  Therefore the
0474  * absence of this state should not be taken as
0475  * definitive evidence that the object's visual representation is      
0476  * static; this state is advisory.
0477  * @ATSPI_STATE_INVALID_ENTRY: This object has indicated an error condition
0478  * due to failure of input validation.  For instance, a form control may
0479  * acquire this state in response to invalid or malformed user input.
0480  * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the object
0481  * in question implements some form of typeahead or       
0482  * pre-selection behavior whereby entering the first character of one or more
0483  * sub-elements causes those elements to scroll into view or become
0484  * selected. Subsequent character input may narrow the selection further as
0485  * long as one or more sub-elements match the string. This state is normally
0486  * only useful and encountered on objects that implement #AtspiSelection.
0487  * In some cases the typeahead behavior may result in full or partial
0488  * completion of the data in the input field, in which case
0489  * these input events may trigger text-changed events from the source.
0490  * @ATSPI_STATE_SELECTABLE_TEXT: This state indicates that the object in
0491  * question supports text selection. It should only be exposed on objects
0492  * which implement the #AtspiText interface, in order to distinguish this state
0493  * from @ATSPI_STATE_SELECTABLE, which infers that the object in question is a
0494  * selectable child of an object which implements #AtspiSelection. While 
0495  * similar, text selection and subelement selection are distinct operations.
0496  * @ATSPI_STATE_IS_DEFAULT: This state indicates that the object in question is
0497  * the 'default' interaction object in a dialog, i.e. the one that gets
0498  * activated if the user presses "Enter" when the dialog is initially
0499  * posted.
0500  * @ATSPI_STATE_VISITED: This state indicates that the object (typically a
0501  * hyperlink) has already been activated or invoked, with the result that
0502  * some backing data has been downloaded or rendered.
0503  * @ATSPI_STATE_LAST_DEFINED: This value of the enumeration should not be used
0504  * as a parameter, it indicates the number of items in the #AtspiStateType
0505  * enumeration.
0506  *
0507  * 
0508  * Enumeration used by various interfaces indicating every possible state 
0509  * an #AtspiAccesible object can assume.
0510  *
0511  **/
0512 typedef enum {
0513     ATSPI_STATE_INVALID,
0514     ATSPI_STATE_ACTIVE,
0515     ATSPI_STATE_ARMED,
0516     ATSPI_STATE_BUSY,
0517     ATSPI_STATE_CHECKED,
0518     ATSPI_STATE_COLLAPSED,
0519     ATSPI_STATE_DEFUNCT,
0520     ATSPI_STATE_EDITABLE,
0521     ATSPI_STATE_ENABLED,
0522     ATSPI_STATE_EXPANDABLE,
0523     ATSPI_STATE_EXPANDED,
0524     ATSPI_STATE_FOCUSABLE,
0525     ATSPI_STATE_FOCUSED,
0526     ATSPI_STATE_HAS_TOOLTIP,
0527     ATSPI_STATE_HORIZONTAL,
0528     ATSPI_STATE_ICONIFIED,
0529     ATSPI_STATE_MODAL,
0530     ATSPI_STATE_MULTI_LINE,
0531     ATSPI_STATE_MULTISELECTABLE,
0532     ATSPI_STATE_OPAQUE,
0533     ATSPI_STATE_PRESSED,
0534     ATSPI_STATE_RESIZABLE,
0535     ATSPI_STATE_SELECTABLE,
0536     ATSPI_STATE_SELECTED,
0537     ATSPI_STATE_SENSITIVE,
0538     ATSPI_STATE_SHOWING,
0539     ATSPI_STATE_SINGLE_LINE,
0540     ATSPI_STATE_STALE,
0541     ATSPI_STATE_TRANSIENT,
0542     ATSPI_STATE_VERTICAL,
0543     ATSPI_STATE_VISIBLE,
0544     ATSPI_STATE_MANAGES_DESCENDANTS,
0545     ATSPI_STATE_INDETERMINATE,
0546     ATSPI_STATE_REQUIRED,
0547     ATSPI_STATE_TRUNCATED,
0548     ATSPI_STATE_ANIMATED,
0549     ATSPI_STATE_INVALID_ENTRY,
0550     ATSPI_STATE_SUPPORTS_AUTOCOMPLETION,
0551     ATSPI_STATE_SELECTABLE_TEXT,
0552     ATSPI_STATE_IS_DEFAULT,
0553     ATSPI_STATE_VISITED,
0554     ATSPI_STATE_LAST_DEFINED,
0555 } AtspiStateType;
0556 
0557 /**
0558  * ATSPI_STATETYPE_COUNT:
0559  *
0560  * One higher than the highest valid value of #AtspiStateType.
0561  **/
0562 #define ATSPI_STATETYPE_COUNT (41+1)
0563 
0564 /**
0565  * AtspiKeyEventType:
0566  * @ATSPI_KEY_PRESSED:
0567  * @ATSPI_KEY_RELEASED:
0568  *
0569  * Deprecated. Should not be used.
0570  *
0571  **/
0572 typedef enum {
0573     ATSPI_KEY_PRESSED,
0574     ATSPI_KEY_RELEASED,
0575 } AtspiKeyEventType;
0576 
0577 /**
0578  * ATSPI_KEYEVENTTYPE_COUNT:
0579  *
0580  * One higher than the highest valid value of #AtspiKeyEventType.
0581  **/
0582 #define ATSPI_KEYEVENTTYPE_COUNT (1+1)
0583 
0584 /**
0585  * AtspiEventType:
0586  * @ATSPI_KEY_PRESSED_EVENT: Indicates that a key on a keyboard device was 
0587  * pressed.
0588  * @ATSPI_KEY_RELEASED_EVENT: Indicates that a key on a keyboard device was 
0589  * released.
0590  * @ATSPI_BUTTON_PRESSED_EVENT: Indicates that a button on a non-keyboard 
0591  * human interface device (HID) was pressed.
0592  * @ATSPI_BUTTON_RELEASED_EVENT: Indicates that a button on a non-keyboard
0593  * human interface device (HID) was released.
0594  *
0595  * Enumeration used to specify the event types of interest to an 
0596  * #AtspiEventListener, or 
0597  * to identify the type of an event for which notification has been sent.  
0598  *
0599  **/
0600 typedef enum {
0601     ATSPI_KEY_PRESSED_EVENT,
0602     ATSPI_KEY_RELEASED_EVENT,
0603     ATSPI_BUTTON_PRESSED_EVENT,
0604     ATSPI_BUTTON_RELEASED_EVENT,
0605 } AtspiEventType;
0606 
0607 /**
0608  * ATSPI_EVENTTYPE_COUNT:
0609  *
0610  * One higher than the highest valid value of #AtspiEventType.
0611  */
0612 #define ATSPI_EVENTTYPE_COUNT (3+1)
0613 
0614 /**
0615  * AtspiKeySynthType:
0616  * @ATSPI_KEY_PRESS: Emulates the pressing of a hardware keyboard key.
0617  * @ATSPI_KEY_RELEASE: Emulates the release of a hardware keyboard key.
0618  * @ATSPI_KEY_PRESSRELEASE: Emulates the pressing and immediate releasing
0619  * ofa hardware keyboard key.
0620  * @ATSPI_KEY_SYM: A symbolic key event is generated, without specifying a
0621  * hardware key. Note: if the keysym is not present in the current keyboard
0622  * map, the #AtspiDeviceEventController instance has a limited ability to 
0623  * generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent 
0624  * calls using out-of-keymap keysyms will vary from system to system, and on 
0625  * the number of different out-of-keymap being generated in quick succession. 
0626  * In practice this is rarely significant, since the keysyms of interest to 
0627  * AT clients and keyboard emulators are usually part of the current keymap, 
0628  * i.e. present on the system keyboard for the current locale (even if a 
0629  * physical hardware keyboard is not connected.
0630  * @ATSPI_KEY_STRING: A string is converted to its equivalent keyboard events
0631  * and emitted. If the string consists of complex character or composed
0632  * characters which are not in the current keymap, string emission is
0633  * subject to the out-of-keymap limitations described for
0634  * @ATSPI_KEY_SYM. In practice this limitation primarily effects
0635  * Chinese and Japanese locales.
0636  *
0637  * Enumeration used when synthesizing keyboard input via
0638  * #atspi_generate_keyboard_event.
0639  *
0640  **/
0641 typedef enum {
0642     ATSPI_KEY_PRESS,
0643     ATSPI_KEY_RELEASE,
0644     ATSPI_KEY_PRESSRELEASE,
0645     ATSPI_KEY_SYM,
0646     ATSPI_KEY_STRING,
0647 } AtspiKeySynthType;
0648 
0649 /**
0650  * ATSPI_KEYSYNTHTYPE_COUNT:
0651  *
0652  * One higher than the highest valid value of #AtspiKeySynthType.
0653  **/
0654 #define ATSPI_KEYSYNTHTYPE_COUNT (4+1)
0655 
0656 /**
0657  * AtspiModifierType:
0658  * @ATSPI_MODIFIER_SHIFT: The left or right 'Shift' key.
0659  * @ATSPI_MODIFIER_SHIFTLOCK: The ShiftLock or CapsLock key.
0660  * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'.
0661  * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr).
0662  * @ATSPI_MODIFIER_META: Depending on the platform, this may map to 'Window',
0663  * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will
0664  * map to one of META, META2, META3. On X Windows platforms these META
0665  * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an
0666  * event having @ATSPI_MODIFIER_META2 means that the 'Mod2Mask' bit
0667  * is set in the corresponding XEvent.
0668  * @ATSPI_MODIFIER_META2: See @ATSPI_MODIFIER_META.
0669  * @ATSPI_MODIFIER_META3: See @ATSPI_MODIFIER_META.
0670  * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-SPI
0671  * to the appropriate META value, for the convenience of the client.
0672  *
0673  *
0674  *
0675  **/
0676 typedef enum {
0677     ATSPI_MODIFIER_SHIFT,
0678     ATSPI_MODIFIER_SHIFTLOCK,
0679     ATSPI_MODIFIER_CONTROL,
0680     ATSPI_MODIFIER_ALT,
0681     ATSPI_MODIFIER_META,
0682     ATSPI_MODIFIER_META2,
0683     ATSPI_MODIFIER_META3,
0684     ATSPI_MODIFIER_NUMLOCK = 14,
0685 } AtspiModifierType;
0686 
0687 /**
0688  * ATSPI_MODIFIERTYPE_COUNT:
0689  *
0690  * One higher than the highest valid value of #AtspiModifierType.
0691  **/
0692 #define ATSPI_MODIFIERTYPE_COUNT (7+1)
0693 
0694 /**
0695  * AtspiRelationType:
0696  * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not
0697  * normally encounter this #AtspiRelationType value.
0698  * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objects.
0699  * @ATSPI_RELATION_LABELLED_BY: Object is labelled by one or more other
0700  * objects.
0701  * @ATSPI_RELATION_CONTROLLER_FOR: Object is an interactive object which
0702  * modifies the state, onscreen location, or other attributes of one or more
0703  * target objects.
0704  * @ATSPI_RELATION_CONTROLLED_BY: Object state, position, etc. is
0705  * modified/controlled by user interaction with one or more other objects. 
0706  * For instance a viewport or scroll pane may be @ATSPI_RELATION_CONTROLLED_BY
0707  * scrollbars.
0708  * @ATSPI_RELATION_MEMBER_OF: Object has a grouping relationship (e.g. 'same
0709  * group as') to one or more other objects.
0710  * @ATSPI_RELATION_TOOLTIP_FOR: Object is a tooltip associated with another
0711  * object.
0712  * @ATSPI_RELATION_NODE_CHILD_OF: Object is a child of the target.
0713  * @ATSPI_RELATION_NODE_PARENT_OF: Object is a parent of the target.
0714  * @ATSPI_RELATION_EXTENDED: Used to indicate that a relationship exists, but
0715  * its type is not specified in the enumeration.
0716  * @ATSPI_RELATION_FLOWS_TO: Object renders content which flows logically to
0717  * another object. For instance, text in a paragraph may flow to another
0718  * object which is not the 'next sibling' in the accessibility hierarchy.
0719  * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of @ATSPI_RELATION_FLOWS_TO.
0720  * @ATSPI_RELATION_SUBWINDOW_OF: Object is visually and semantically considered
0721  * a subwindow of another object, even though it is not the object's child. 
0722  * Useful when dealing with embedded applications and other cases where the
0723  * widget hierarchy does not map cleanly to the onscreen presentation.
0724  * @ATSPI_RELATION_EMBEDS: Similar to @ATSPI_RELATION_SUBWINDOW_OF, but 
0725  * specifically used for cross-process embedding.
0726  * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of @ATSPI_RELATION_EMBEDS. Used to
0727  * denote content rendered by embedded renderers that live in a separate process
0728  * space from the embedding context.
0729  * @ATSPI_RELATION_POPUP_FOR: Denotes that the object is a transient window or
0730  * frame associated with another onscreen object. Similar to @ATSPI_TOOLTIP_FOR,
0731  * but more general. Useful for windows which are technically toplevels
0732  * but which, for one or more reasons, do not explicitly cause their 
0733  * associated window to lose 'window focus'. Creation of an @ATSPI_ROLE_WINDOW
0734  * object with the @ATSPI_RELATION_POPUP_FOR relation usually requires 
0735  * some presentation action on the part
0736  * of assistive technology clients, even though the previous toplevel
0737  * @ATSPI_ROLE_FRAME object may still be the active window.
0738  * @ATSPI_RELATION_PARENT_WINDOW_OF: This is the reciprocal relation to
0739  * @ATSPI_RELATION_POPUP_FOR.
0740  * @ATSPI_RELATION_DESCRIPTION_FOR: Indicates that an object provides
0741  * descriptive information about another object; more verbose than
0742  * @ATSPI_RELATION_LABEL_FOR.
0743  * @ATSPI_RELATION_DESCRIBED_BY: Indicates that another object provides
0744  * descriptive information about this object; more verbose than
0745  * @ATSPI_RELATION_LABELLED_BY.
0746  * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to
0747  * determine the size of the enumeration. 
0748  *
0749  * #AtspiRelationType specifies a relationship between objects 
0750  * (possibly one-to-many
0751  * or many-to-one) outside of the normal parent/child hierarchical
0752  * relationship. It allows better semantic       identification of how objects
0753  * are associated with one another.       For instance the 
0754  * @ATSPI_RELATION_LABELLED_BY
0755  * relationship may be used to identify labelling information       that should
0756  * accompany the accessible name property when presenting an object's content or
0757  * identity       to the end user.  Similarly, 
0758  * @ATSPI_RELATION_CONTROLLER_FOR can be used
0759  * to further specify the context in which a valuator is useful, and/or the
0760  * other UI components which are directly effected by user interactions with
0761  * the valuator. Common examples include association of scrollbars with the
0762  * viewport or panel which they control.
0763  *
0764  * 
0765  * Enumeration used to specify
0766  * the type of relation encapsulated in an #AtspiRelation object.
0767  *
0768  **/
0769 typedef enum {
0770     ATSPI_RELATION_NULL,
0771     ATSPI_RELATION_LABEL_FOR,
0772     ATSPI_RELATION_LABELLED_BY,
0773     ATSPI_RELATION_CONTROLLER_FOR,
0774     ATSPI_RELATION_CONTROLLED_BY,
0775     ATSPI_RELATION_MEMBER_OF,
0776     ATSPI_RELATION_TOOLTIP_FOR,
0777     ATSPI_RELATION_NODE_CHILD_OF,
0778     ATSPI_RELATION_NODE_PARENT_OF,
0779     ATSPI_RELATION_EXTENDED,
0780     ATSPI_RELATION_FLOWS_TO,
0781     ATSPI_RELATION_FLOWS_FROM,
0782     ATSPI_RELATION_SUBWINDOW_OF,
0783     ATSPI_RELATION_EMBEDS,
0784     ATSPI_RELATION_EMBEDDED_BY,
0785     ATSPI_RELATION_POPUP_FOR,
0786     ATSPI_RELATION_PARENT_WINDOW_OF,
0787     ATSPI_RELATION_DESCRIPTION_FOR,
0788     ATSPI_RELATION_DESCRIBED_BY,
0789     ATSPI_RELATION_LAST_DEFINED,
0790 } AtspiRelationType;
0791 
0792 /**
0793  * ATSPI_RELATIONTYPE_COUNT:
0794  *
0795  * One higher than the highest valid value of #AtspiRelationType.
0796  **/
0797 #define ATSPI_RELATIONTYPE_COUNT (19+1)
0798 
0799 /**
0800  * AtspiRole:
0801  * @ATSPI_ROLE_INVALID: A role indicating an error condition, such as
0802  * uninitialized Role data.
0803  * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard
0804  * accelerators for the parent.
0805  * @ATSPI_ROLE_ALERT: Object is used to alert the user about something.
0806  * @ATSPI_ROLE_ANIMATION: Object contains a dynamic or moving image of some
0807  * kind.
0808  * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator.
0809  * @ATSPI_ROLE_CALENDAR: Object contains one or more dates, usually arranged
0810  * into a 2d list.
0811  * @ATSPI_ROLE_CANVAS: Object that can be drawn into and is used to trap
0812  * events.
0813  * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and
0814  * provides a separate       indicator for the current state.
0815  * @ATSPI_ROLE_CHECK_MENU_ITEM: A menu item that behaves like a check box. See
0816  * @ATSPI_ROLE_CHECK_BOX.
0817  * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a
0818  * color.
0819  * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data.
0820  * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from.
0821  * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date.
0822  * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE.
0823  * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and
0824  * iconified versions of those internal frames.
0825  * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotating a
0826  * visual element, or which displays a value via such a rotating element.
0827  * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border.
0828  * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through
0829  * and select the contents of a directory.
0830  * @ATSPI_ROLE_DRAWING_AREA: A specialized dialog that displays the files in
0831  * the directory and lets the user select a file, browse a different
0832  * directory, or specify a filename.
0833  * @ATSPI_ROLE_FILE_CHOOSER: An object used for drawing custom user interface
0834  * elements.
0835  * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface.
0836  * @ATSPI_ROLE_FOCUS_TRAVERSABLE: Don't use, reserved for future use.
0837  * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font.
0838  * @ATSPI_ROLE_FRAME: A top level window with a title bar, border, menubar,
0839  * etc.
0840  * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of
0841  * all panes beneath it.
0842  * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children   
0843  * represent the document content.
0844  * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate
0845  * components.
0846  * @ATSPI_ROLE_IMAGE: An image, typically static.
0847  * @ATSPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop
0848  * pane.
0849  * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in an
0850  * interface.
0851  * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be
0852  * drawn in layers, providing a form of stacking order.
0853  * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user and
0854  * allows the user to select one or more of them.
0855  * @ATSPI_ROLE_LIST_ITEM: An object that represents an element of a list.
0856  * @ATSPI_ROLE_MENU: An object usually found inside a menu bar that contains a
0857  * list of actions the user can choose from.
0858  * @ATSPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary
0859  * dialog box of an application that contains a list of menus the user can
0860  * choose from.
0861  * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presents
0862  * an action the user can choose.
0863  * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a
0864  * dialog.
0865  * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list.
0866  * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or
0867  * page tabs), one at a time,through some mechanism provided by the
0868  * object.
0869  * @ATSPI_ROLE_PANEL: A generic container that is often used to group objects.
0870  * @ATSPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places
0871  * where the text content is not shown visibly to the user.
0872  * @ATSPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer the
0873  * user a list of choices, and then hides when the user selects one of those
0874  * choices.
0875  * @ATSPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has
0876  * been completed.
0877  * @ATSPI_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the
0878  * application to do something.
0879  * @ATSPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other
0880  * radio buttons in the same group to become unchecked when this one is
0881  * checked.
0882  * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio button"
0883  * . See @ATSPI_ROLE_RADIO_BUTTON.
0884  * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a
0885  * layered pane as its children.
0886  * @ATSPI_ROLE_ROW_HEADER: The header for a row of data.
0887  * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to
0888  * incrementally view a large amount of data by moving the bounds of a
0889  * viewport along a one-dimensional axis.
0890  * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally view
0891  * a large amount of information. @ATSPI_ROLE_SCROLL_PANE objects are usually
0892  * accompanied by @ATSPI_ROLE_SCROLL_BAR controllers, on which the
0893  * @ATSPI_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY 
0894  * reciprocal relations are set. See  #atspi_get_relation_set.
0895  * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a
0896  * visible and logical separation of the contents in a menu.
0897  * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a bounded
0898  * range.
0899  * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices to
0900  * be selected, and which displays the current choice.  Unlike
0901  * @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control 
0902  * 'viewport'-like objects.
0903  * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels
0904  * at the same time.
0905  * @ATSPI_ROLE_STATUS_BAR: Object displays non-quantitative status information
0906  * (c.f. @ATSPI_ROLE_PROGRESS_BAR)
0907  * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of rows
0908  * and columns.
0909  * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. Note:
0910  * Table cells need not have @ATSPI_ROLE_TABLE_CELL, other 
0911  * #AtspiRoleType values are valid as well.
0912  * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular column
0913  * in an #AtspiTable.
0914  * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in a
0915  * #AtspiTable. #AtspiTable rows and columns may also be labelled via the
0916  * @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships.
0917  * See #atspi_get_relation_set.
0918  * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from menubar
0919  * and shown in its own window.
0920  * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal.
0921  * @ATSPI_ROLE_TEXT: An object that presents text to the user, of nonspecific
0922  * type.
0923  * @ATSPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or
0924  * unchecked, but does not procide a separate indicator for the current
0925  * state.
0926  * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or
0927  * toggle buttons.
0928  * @ATSPI_ROLE_TOOL_TIP: An object that provides information about another
0929  * object.
0930  * @ATSPI_ROLE_TREE: An object used to repsent hierarchical information to the
0931  * user.
0932  * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and
0933  * hierarchical info to the user.
0934  * @ATSPI_ROLE_UNKNOWN: The object contains some #AtspiAccessible information, 
0935  * but its role is not known.
0936  * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to
0937  * otherwise clip a larger object or content renderer to a specific
0938  * onscreen viewport.
0939  * @ATSPI_ROLE_WINDOW: A top level window with no title or border.
0940  * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but not
0941  * included in the core enumeration.
0942  * @ATSPI_ROLE_HEADER: An object that serves as a document header.
0943  * @ATSPI_ROLE_FOOTER: An object that serves as a document footer.
0944  * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of
0945  * text content. See also @ATSPI_ROLE_TEXT.
0946  * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc.    
0947  *    for text objects which it controls (should have 
0948  * @ATSPI_RELATION_CONTROLLER_FOR relation to such).
0949  * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessible
0950  * of an application, which may contain @ATSPI_ROLE_FRAME objects or other      
0951  * accessible objects. Children of #AccessibleDesktop objects  are generally
0952  * @ATSPI_ROLE_APPLICATION objects.
0953  * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items
0954  * for insertion into an entry widget, for instance a list of words for
0955  * completion of a text entry.
0956  * @ATSPI_ROLE_EDITBAR: The object is an editable text object in a toolbar.
0957  * @ATSPI_ROLE_EMBEDDED: The object is an embedded component container.  This
0958  * role is a "grouping" hint that the contained objects share a context
0959  * which is different from the container in which this accessible is
0960  * embedded. In particular, it is used for some kinds of document embedding,
0961  * and for embedding of out-of-process component, "panel applets", etc.
0962  * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may be
0963  * entered or modified by the user, provided @ATSPI_STATE_EDITABLE is present.
0964  * A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is 
0965  * not present) implies a read-only 'text field' in a form, as opposed to a 
0966  * title, label, or caption.
0967  * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative data.
0968  * It may contain multiple subelements whose attributes and/or description
0969  * may be queried to obtain both the  quantitative data and information about
0970  * how the data is being presented. The @ATSPI_LABELLED_BY relation is 
0971  * particularly important in interpreting objects of this type, as is the
0972  * accessible description property. See @ATSPI_ROLE_CAPTION.
0973  * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usually
0974  * textual, about another user interface element such as a table, chart, or
0975  * image.
0976  * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which
0977  * contains a view of document content. #AtspiDocument frames may occur within
0978  * another #AtspiDocument instance, in which case the second  document may be
0979  * said to be embedded in the containing instance.  HTML frames are often
0980  * @ATSPI_ROLE_DOCUMENT_FRAME:  Either this object, or a singleton descendant, 
0981  * should implement the #AtspiDocument interface.
0982  * @ATSPI_ROLE_HEADING: The object serves as a heading for content which
0983  * follows it in a document. The 'heading level' of the heading, if
0984  * availabe,  may be obtained by       querying the object's attributes.
0985  * @ATSPI_ROLE_PAGE: The object is a containing instance which encapsulates a
0986  * page of information. @ATSPI_ROLE_PAGE is used in documents and content which
0987  * support a paginated navigation model.
0988  * @ATSPI_ROLE_SECTION: The object is a containing instance of document content
0989  * which constitutes a particular 'logical' section of the document.  The
0990  * type of content within a section, and the nature of the section division
0991  * itself, may be obtained by querying the object's attributes.  Sections
0992  * may be nested.
0993  * @ATSPI_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in
0994  * the hierarchy, and is exposed for purely technical reasons.  Objects of
0995  * this role should be ignored by clients, if they are encountered at all.
0996  * @ATSPI_ROLE_FORM: The object is a containing instance of document content
0997  * which has within it components with which the user can interact in order
0998  * to input information; i.e. the object is a container for pushbuttons,    
0999  * comboboxes, text input fields, and other 'GUI' components. @ATSPI_ROLE_FORM
1000  * should not, in general, be used for toplevel GUI containers or dialogs,
1001  * but should be reserved for 'GUI' containers which occur within document
1002  * content, for instance within Web documents, presentations, or text
1003  * documents.  Unlike other GUI containers and dialogs which occur inside      
1004  * application instances, @ATSPI_ROLE_FORM containers' components are
1005  * associated with the current document, rather than the current foreground 
1006  * application or viewer instance.
1007  * @ATSPI_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a      
1008  * hypertext document.  Such objects are distinct from 'inline'       content
1009  * which may also use the #AtspiHypertext/#AtspiHyperlink interfacesto indicate
1010  * the range/location within a text object where an inline or embedded object
1011  * lies.
1012  * @ATSPI_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
1013  * which is used to allow composition or input of a 'complex character',    
1014  * in other words it is an "input method window".
1015  * @ATSPI_ROLE_TABLE_ROW: A row in a table.
1016  * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree.
1017  * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a
1018  * spreadsheet.
1019  * @ATSPI_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a
1020  * presentation or slide content.
1021  * @ATSPI_ROLE_DOCUMENT_TEXT: A document frame which contains textual content,
1022  * such as found in a word processing
1023  * application.
1024  * @ATSPI_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other
1025  * markup suitable for display in a web browser.
1026  * @ATSPI_ROLE_DOCUMENT_EMAIL: A document frame which contains email content
1027  * to be displayed or composed either in plain text or
1028  * HTML.
1029  * @ATSPI_ROLE_COMMENT: An object found within a document and designed to
1030  * present a comment, note, or other annotation. In some cases, this object
1031  * might not be visible until activated.
1032  * @ATSPI_ROLE_LIST_BOX: A non-collapsible list of choices the user can
1033  * select from.
1034  * @ATSPI_ROLE_GROUPING: A group of related widgets. This group typically has
1035  * a label.
1036  * @ATSPI_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multiple
1037  * hotspots, where each hotspot can be activated resulting in the loading of
1038  * another document or section of a document.
1039  * @ATSPI_ROLE_NOTIFICATION: A transitory object designed to present a
1040  * message to the user, typically at the desktop level rather than inside a
1041  * particular application.
1042  * @ATSPI_ROLE_INFO_BAR: An object designed to present a message to the user
1043  * within an existing window.
1044  * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of
1045  * enumeration.
1046  *
1047  * Enumeration used by interface #AtspiAccessible to specify the role
1048  * of an #AtspiAccessible object.
1049  *
1050  */
1051 typedef enum {
1052     ATSPI_ROLE_INVALID,
1053     ATSPI_ROLE_ACCELERATOR_LABEL,
1054     ATSPI_ROLE_ALERT,
1055     ATSPI_ROLE_ANIMATION,
1056     ATSPI_ROLE_ARROW,
1057     ATSPI_ROLE_CALENDAR,
1058     ATSPI_ROLE_CANVAS,
1059     ATSPI_ROLE_CHECK_BOX,
1060     ATSPI_ROLE_CHECK_MENU_ITEM,
1061     ATSPI_ROLE_COLOR_CHOOSER,
1062     ATSPI_ROLE_COLUMN_HEADER,
1063     ATSPI_ROLE_COMBO_BOX,
1064     ATSPI_ROLE_DATE_EDITOR,
1065     ATSPI_ROLE_DESKTOP_ICON,
1066     ATSPI_ROLE_DESKTOP_FRAME,
1067     ATSPI_ROLE_DIAL,
1068     ATSPI_ROLE_DIALOG,
1069     ATSPI_ROLE_DIRECTORY_PANE,
1070     ATSPI_ROLE_DRAWING_AREA,
1071     ATSPI_ROLE_FILE_CHOOSER,
1072     ATSPI_ROLE_FILLER,
1073     ATSPI_ROLE_FOCUS_TRAVERSABLE,
1074     ATSPI_ROLE_FONT_CHOOSER,
1075     ATSPI_ROLE_FRAME,
1076     ATSPI_ROLE_GLASS_PANE,
1077     ATSPI_ROLE_HTML_CONTAINER,
1078     ATSPI_ROLE_ICON,
1079     ATSPI_ROLE_IMAGE,
1080     ATSPI_ROLE_INTERNAL_FRAME,
1081     ATSPI_ROLE_LABEL,
1082     ATSPI_ROLE_LAYERED_PANE,
1083     ATSPI_ROLE_LIST,
1084     ATSPI_ROLE_LIST_ITEM,
1085     ATSPI_ROLE_MENU,
1086     ATSPI_ROLE_MENU_BAR,
1087     ATSPI_ROLE_MENU_ITEM,
1088     ATSPI_ROLE_OPTION_PANE,
1089     ATSPI_ROLE_PAGE_TAB,
1090     ATSPI_ROLE_PAGE_TAB_LIST,
1091     ATSPI_ROLE_PANEL,
1092     ATSPI_ROLE_PASSWORD_TEXT,
1093     ATSPI_ROLE_POPUP_MENU,
1094     ATSPI_ROLE_PROGRESS_BAR,
1095     ATSPI_ROLE_PUSH_BUTTON,
1096     ATSPI_ROLE_RADIO_BUTTON,
1097     ATSPI_ROLE_RADIO_MENU_ITEM,
1098     ATSPI_ROLE_ROOT_PANE,
1099     ATSPI_ROLE_ROW_HEADER,
1100     ATSPI_ROLE_SCROLL_BAR,
1101     ATSPI_ROLE_SCROLL_PANE,
1102     ATSPI_ROLE_SEPARATOR,
1103     ATSPI_ROLE_SLIDER,
1104     ATSPI_ROLE_SPIN_BUTTON,
1105     ATSPI_ROLE_SPLIT_PANE,
1106     ATSPI_ROLE_STATUS_BAR,
1107     ATSPI_ROLE_TABLE,
1108     ATSPI_ROLE_TABLE_CELL,
1109     ATSPI_ROLE_TABLE_COLUMN_HEADER,
1110     ATSPI_ROLE_TABLE_ROW_HEADER,
1111     ATSPI_ROLE_TEAROFF_MENU_ITEM,
1112     ATSPI_ROLE_TERMINAL,
1113     ATSPI_ROLE_TEXT,
1114     ATSPI_ROLE_TOGGLE_BUTTON,
1115     ATSPI_ROLE_TOOL_BAR,
1116     ATSPI_ROLE_TOOL_TIP,
1117     ATSPI_ROLE_TREE,
1118     ATSPI_ROLE_TREE_TABLE,
1119     ATSPI_ROLE_UNKNOWN,
1120     ATSPI_ROLE_VIEWPORT,
1121     ATSPI_ROLE_WINDOW,
1122     ATSPI_ROLE_EXTENDED,
1123     ATSPI_ROLE_HEADER,
1124     ATSPI_ROLE_FOOTER,
1125     ATSPI_ROLE_PARAGRAPH,
1126     ATSPI_ROLE_RULER,
1127     ATSPI_ROLE_APPLICATION,
1128     ATSPI_ROLE_AUTOCOMPLETE,
1129     ATSPI_ROLE_EDITBAR,
1130     ATSPI_ROLE_EMBEDDED,
1131     ATSPI_ROLE_ENTRY,
1132     ATSPI_ROLE_CHART,
1133     ATSPI_ROLE_CAPTION,
1134     ATSPI_ROLE_DOCUMENT_FRAME,
1135     ATSPI_ROLE_HEADING,
1136     ATSPI_ROLE_PAGE,
1137     ATSPI_ROLE_SECTION,
1138     ATSPI_ROLE_REDUNDANT_OBJECT,
1139     ATSPI_ROLE_FORM,
1140     ATSPI_ROLE_LINK,
1141     ATSPI_ROLE_INPUT_METHOD_WINDOW,
1142     ATSPI_ROLE_TABLE_ROW,
1143     ATSPI_ROLE_TREE_ITEM,
1144     ATSPI_ROLE_DOCUMENT_SPREADSHEET,
1145     ATSPI_ROLE_DOCUMENT_PRESENTATION,
1146     ATSPI_ROLE_DOCUMENT_TEXT,
1147     ATSPI_ROLE_DOCUMENT_WEB,
1148     ATSPI_ROLE_DOCUMENT_EMAIL,
1149     ATSPI_ROLE_COMMENT,
1150     ATSPI_ROLE_LIST_BOX,
1151     ATSPI_ROLE_GROUPING,
1152     ATSPI_ROLE_IMAGE_MAP,
1153     ATSPI_ROLE_NOTIFICATION,
1154     ATSPI_ROLE_INFO_BAR,
1155     ATSPI_ROLE_LAST_DEFINED,
1156 } AtspiRole;
1157 
1158 /**
1159  * ATSPI_ROLE_COUNT:
1160  *
1161  * One higher than the highest valid value of #AtspiRole.
1162  */
1163 #define ATSPI_ROLE_COUNT (90+1)
1164 
1165 typedef enum
1166 {
1167   ATSPI_CACHE_NONE     = 0,
1168   ATSPI_CACHE_PARENT   = 1 << 0,
1169   ATSPI_CACHE_CHILDREN    = 1 << 1,
1170   ATSPI_CACHE_NAME        = 1 << 2,
1171   ATSPI_CACHE_DESCRIPTION = 1 << 3,
1172   ATSPI_CACHE_STATES      = 1 << 4,
1173   ATSPI_CACHE_ROLE        = 1 << 5,
1174   ATSPI_CACHE_INTERFACES  = 1 << 6,
1175   ATSPI_CACHE_ATTRIBUTES = 1 << 7,
1176   ATSPI_CACHE_ALL         = 0x3fffffff,
1177   ATSPI_CACHE_DEFAULT = ATSPI_CACHE_PARENT | ATSPI_CACHE_CHILDREN |
1178                         ATSPI_CACHE_NAME | ATSPI_CACHE_DESCRIPTION |
1179                         ATSPI_CACHE_STATES | ATSPI_CACHE_ROLE |
1180                         ATSPI_CACHE_INTERFACES,
1181   ATSPI_CACHE_UNDEFINED   = 0x40000000,
1182 } AtspiCache;
1183 
1184 #define ATSPI_DBUS_NAME_REGISTRY "org.a11y.atspi.Registry"
1185 #define ATSPI_DBUS_PATH_REGISTRY "/org/a11y/atspi/registry"
1186 #define ATSPI_DBUS_INTERFACE_REGISTRY "org.a11y.atspi.Registry"
1187 
1188 #define ATSPI_DBUS_PATH_NULL "/org/a11y/atspi/null"
1189 #define ATSPI_DBUS_PATH_ROOT "/org/a11y/atspi/accessible/root"
1190 
1191 #define ATSPI_DBUS_PATH_DEC "/org/a11y/atspi/registry/deviceeventcontroller"
1192 #define ATSPI_DBUS_INTERFACE_DEC "org.a11y.atspi.DeviceEventController"
1193 #define ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER "org.a11y.atspi.DeviceEventListener"
1194 
1195 #define ATSPI_DBUS_INTERFACE_CACHE "org.a11y.atspi.Cache"
1196 #define ATSPI_DBUS_INTERFACE_ACCESSIBLE "org.a11y.atspi.Accessible"
1197 #define ATSPI_DBUS_INTERFACE_ACTION "org.a11y.atspi.Action"
1198 #define ATSPI_DBUS_INTERFACE_APPLICATION "org.a11y.atspi.Application"
1199 #define ATSPI_DBUS_INTERFACE_COLLECTION "org.a11y.atspi.Collection"
1200 #define ATSPI_DBUS_INTERFACE_COMPONENT "org.a11y.atspi.Component"
1201 #define ATSPI_DBUS_INTERFACE_DOCUMENT "org.a11y.atspi.Document"
1202 #define ATSPI_DBUS_INTERFACE_EDITABLE_TEXT "org.a11y.atspi.EditableText"
1203 #define ATSPI_DBUS_INTERFACE_EVENT_KEYBOARD "org.a11y.atspi.Event.Keyboard"
1204 #define ATSPI_DBUS_INTERFACE_EVENT_MOUSE "org.a11y.atspi.Event.Mouse"
1205 #define ATSPI_DBUS_INTERFACE_EVENT_OBJECT "org.a11y.atspi.Event.Object"
1206 #define ATSPI_DBUS_INTERFACE_HYPERLINK "org.a11y.atspi.Hyperlink"
1207 #define ATSPI_DBUS_INTERFACE_HYPERTEXT "org.a11y.atspi.Hypertext"
1208 #define ATSPI_DBUS_INTERFACE_IMAGE "org.a11y.atspi.Image"
1209 #define ATSPI_DBUS_INTERFACE_SELECTION "org.a11y.atspi.Selection"
1210 #define ATSPI_DBUS_INTERFACE_TABLE "org.a11y.atspi.Table"
1211 #define ATSPI_DBUS_INTERFACE_TEXT "org.a11y.atspi.Text"
1212 #define ATSPI_DBUS_INTERFACE_VALUE "org.a11y.atspi.Value"
1213 #define ATSPI_DBUS_INTERFACE_SOCKET "org.a11y.atspi.Socket"
1214 
1215 #ifdef __cplusplus
1216 }
1217 #endif
1218 #endif  /* _ATSPI_CONSTANTS_H_ */