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