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