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