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