2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2010, 2011 Novell, Inc.
6 * Copyright (c) 2012 SUSE LINUX Products GmbH, Nuernberg, Germany.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 /* TODO: Auto-generate this file again
28 !\mainpage AT-SPI Interfaces and Subinterfaces
30 This is the main documentation page for the
31 Assistive Technology Service Provider Interface (AT-SPI).
33 \section apps Applications and Interface Components
34 Namespace Accessibility includes service APIs implemented by
35 participating applications and their user interface components:\n\n
36 Accessibility::Accessible\n
37 Accessibility::Application\n
38 Accessibility::Desktop\n
39 Accessibility::Collecgtion\n
40 Accessibility::Component\n
41 Accessibility::Hypertext\n
42 Accessibility::Image\n
43 Accessibility::Selection\n
44 Accessibility::Table\n
46 Accessibility::EditableText\n
49 \section types Enumerated Types
50 Accessibility defines a number of key enumerated types, including:\n\n
51 Accessibility::RelationType\n
53 Accessibility::StateType\n
54 Accessibility::Event\n
55 Accessibility::EventDetails \n
58 Accessibility also includes Accessibility::Registry,
59 which is the service used by assistive technologies and related
60 AT-SPI clients to register interest in certain classes of events,
61 enumerate the currently available desktop and application list,
62 and to synthesize certain kinds of device events.
64 \section listeners Event Listener Interfaces
65 Accessibility::EventListener\n
66 Accessibility::DeviceEventListener
68 \section helpers Helper Interfaces
70 The following interfaces may be implemented by assistive technologies
71 themselves, in order to export their services in a consistent manner or
72 in order to interoperate with other applications or desktop services.\n
74 Accessibility::LoginHelper : Implemented by adaptive technologies which
75 need to participate in user-authentication or login activities, and which
76 therefore may need negotiation with authentication agents or processes.\n
78 Accessibility::Selector [NEW]: Implemented by user agents or assistive
79 technologies which export lists of choices from which the end-user is
80 expected to make selections. Useful for various types of remote
81 activation or intercommunication between multiple ATs.
85 #ifndef _ATSPI_CONSTANTS_H_
86 #define _ATSPI_CONSTANTS_H_
93 * @ATSPI_LOCALE_TYPE_MESSAGES: For localizable natural-language messages.
94 * @ATSPI_LOCALE_TYPE_COLLATE: For regular expression matching and string
96 * @ATSPI_LOCALE_TYPE_CTYPE: For regular expression matching, character
97 * classification, conversion, case-sensitive comparison, and wide character
99 * @ATSPI_LOCALE_TYPE_MONETARY: For monetary formatting.
100 * @ATSPI_LOCALE_TYPE_NUMERIC: For number formatting (such as the decimal
101 * point and the thousands separator).
102 * @ATSPI_LOCALE_TYPE_TIME: For time and date formatting.
104 * Used by interfaces #AtspiText and #AtspiDocument, this
105 * enumeration corresponds to the POSIX 'setlocale' enum values.
109 ATSPI_LOCALE_TYPE_MESSAGES,
110 ATSPI_LOCALE_TYPE_COLLATE,
111 ATSPI_LOCALE_TYPE_CTYPE,
112 ATSPI_LOCALE_TYPE_MONETARY,
113 ATSPI_LOCALE_TYPE_NUMERIC,
114 ATSPI_LOCALE_TYPE_TIME,
118 * ATSPI_LOCALE_TYPE_COUNT:
120 * One higher than the highest valid value of #AtspiLocaleType.
122 #define ATSPI_LOCALE_TYPE _COUNT(5+1)
126 * @ATSPI_COORD_TYPE_SCREEN: Specifies xy coordinates relative to the screen.
127 * @ATSPI_COORD_TYPE_WINDOW: Specifies xy coordinates relative to the widget's
130 * Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces
131 * to specify whether coordinates are relative to the window or the screen.
135 ATSPI_COORD_TYPE_SCREEN,
136 ATSPI_COORD_TYPE_WINDOW,
140 * ATSPI_COORD_TYPE_COUNT:
142 * One higher than the highest valid value of #AtspiCoordType.
144 #define ATSPI_COORD_TYPE_COUNT (1+1)
147 * AtspiCollectionSortOrder:
148 * @ATSPI_Collection_SORT_ORDER_INVALID:
149 * @ATSPI_Collection_SORT_ORDER_CANONICAL:
150 * @ATSPI_Collection_SORT_ORDER_FLOW:
151 * @ATSPI_Collection_SORT_ORDER_TAB:
152 * @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL:
153 * @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW:
154 * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB:
155 * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED:
157 * Enumeration used by interface #AtspiCollection to specify
158 * the way #AtspiAccesible objects should be sorted.
162 ATSPI_Collection_SORT_ORDER_INVALID,
163 ATSPI_Collection_SORT_ORDER_CANONICAL,
164 ATSPI_Collection_SORT_ORDER_FLOW,
165 ATSPI_Collection_SORT_ORDER_TAB,
166 ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL,
167 ATSPI_Collection_SORT_ORDER_REVERSE_FLOW,
168 ATSPI_Collection_SORT_ORDER_REVERSE_TAB,
169 ATSPI_Collection_SORT_ORDER_LAST_DEFINED,
170 } AtspiCollectionSortOrder;
173 * ATSPI_SORTORDER_COUNT:
175 * One higher than the highest valid value of #AtspiCollectionSortOrder.
177 #define ATSPI_SORTORDER_COUNT (7+1)
180 * AtspiCollectionMatchType:
181 * @ATSPI_Collection_MATCH_INVALID: Indicates an error condition or
182 * uninitialized value.
183 * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met.
184 * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met.
185 * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met.
186 * @ATSPI_Collection_MATCH_EMPTY: Same as @ATSPI_Collection_MATCH_ALL if
187 * the criteria is non-empty; for empty criteria this rule requires returned
188 * value to also have empty set.
189 * @ATSPI_Collection_MATCH_LAST_DEFINED: Used only to determine the end of the
192 * Enumeration used by #AtspiMatchRule to specify
193 * how to interpret #AtspiAccessible objects.
197 ATSPI_Collection_MATCH_INVALID,
198 ATSPI_Collection_MATCH_ALL,
199 ATSPI_Collection_MATCH_ANY,
200 ATSPI_Collection_MATCH_NONE,
201 ATSPI_Collection_MATCH_EMPTY,
202 ATSPI_Collection_MATCH_LAST_DEFINED,
203 } AtspiCollectionMatchType;
206 * ATSPI_MATCHTYPE_COUNT:
208 * One higher than the highest valid value of #AtspiCollectionMatchType.
210 #define ATSPI_MATCHTYPES_COUNT (5+1)
213 * AtspiCollectionTreeTraversalType:
214 * @ATSPI_Collection_TREE_RESTRICT_CHILDREN:
215 * @ATSPI_Collection_TREE_RESTRICT_SIBLING:
216 * @ATSPI_Collection_TREE_INORDER:
217 * @ATSPI_Collection_TREE_LAST_DEFINED:
219 * Enumeration used by interface #AtspiCollection to specify
220 * restrictions on #AtspiAccesible objects to be traversed.
224 ATSPI_Collection_TREE_RESTRICT_CHILDREN,
225 ATSPI_Collection_TREE_RESTRICT_SIBLING,
226 ATSPI_Collection_TREE_INORDER,
227 ATSPI_Collection_TREE_LAST_DEFINED,
228 } AtspiCollectionTreeTraversalType;
231 * ATSPI_TREETRAVERSALTYPE_COUNT:
233 * One higher than the highest valid value of
234 * #AtspiCollection_TreeTraversalType.
236 #define ATSPI_TREETRAVERSALTYPE _COUNT(3+1)
239 * AtspiComponentLayer:
240 * @ATSPI_LAYER_INVALID: Indicates an error condition or uninitialized value.
241 * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything else
242 * is painted. The 'desktop background' is generally in this layer.
243 * @ATSPI_LAYER_CANVAS: The 'background' layer for most content renderers and
244 * UI #AtspiComponent containers.
245 * @ATSPI_LAYER_WIDGET: The layer in which the majority of ordinary
246 * 'foreground' widgets reside.
247 * @ATSPI_LAYER_MDI: A special layer between @ATSPI_LAYER_CANVAS and
248 * @ATSPI_LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames)
249 * reside. See #atspi_component_get_mdi_z_order.
250 * @ATSPI_LAYER_POPUP: A layer for popup window content, above
251 * @ATSPI_LAYER_WIDGET.
252 * @ATSPI_LAYER_OVERLAY: The topmost layer.
253 * @ATSPI_LAYER_WINDOW: The layer in which a toplevel window background usually
255 * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the
258 * The #AtspiComponentLayer of an #AtspiComponent instance indicates its
259 * relative stacking order with respect to the onscreen visual representation
260 * of the UI. #AtspiComponentLayer, in combination with #AtspiComponent bounds
261 * information, can be used to compute the visibility of all or part of a
262 * component. This is important in programmatic determination of
263 * region-of-interest for magnification, and in
264 * flat screen review models of the screen, as well as
265 * for other uses. Objects residing in two of the #AtspiComponentLayer
266 * categories support further z-ordering information, with respect to their
267 * peers in the same layer: namely, @ATSPI_LAYER_WINDOW and
268 * @ATSPI_LAYER_MDI. Relative stacking order for other objects within the
269 * same layer is not available; the recommended heuristic is
270 * first child paints first. In other words, assume that the
271 * first siblings in the child list are subject to being overpainted by later
272 * siblings if their bounds intersect. The order of layers, from bottom to top,
273 * is: @ATSPI_LAYER_BACKGROUND, @ATSPI_LAYER_WINDOW, @ATSPI_LAYER_MDI,
274 * @ATSPI_LAYER_CANVAS, @ATSPI_LAYER_WIDGET, @ATSPI_LAYER_POPUP, and
275 * @ATSPI_LAYER_OVERLAY.
280 ATSPI_LAYER_BACKGROUND,
287 ATSPI_LAYER_LAST_DEFINED,
288 } AtspiComponentLayer;
291 * ATSPI_COMPONENTLAYER_COUNT:
293 * One higher than the highest valid value of #AtspiComponentLayer.
295 #define ATSPI_COMPONENTLAYER_COUNT (8+1)
298 * AtspiTextBoundaryType:
299 * @ATSPI_TEXT_BOUNDARY_CHAR: An #AtspiText instance is bounded by this
300 * character only. Start and end offsets differ by one, by definition,
302 * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word; i.e.
303 * range is from start of one word to the start of another word.
304 * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word; i.e.
305 * range is from the end of one word to the end of another. Some locales
306 * may not distinguish between words and characters or glyphs. In particular,
307 * those locales which use wholly or partially ideographic character sets.
308 * In these cases, characters may be returned in lieu of multi-character
310 * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: Boundary condition is start of a
311 * sentence, as determined by the application. Some locales or
312 * character sets may not include explicit sentence delimiters, so this
313 * boundary type can not always be honored. Some locales will return lines
314 * of text instead of grammatical sentences.
315 * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: Boundary condition is end of a sentence,
316 * as determined by the application, including the sentence-delimiting
317 * character, for instance '.' Some locales or character sets may not
318 * include explicit sentence delimiters, so this boundary type can not
319 * always be honored. Some locales will return lines of text instead of
320 * grammatical sentences.
321 * @ATSPI_TEXT_BOUNDARY_LINE_START: Boundary condition is the start of a line;
322 * i.e. range is from start of one line to the start of another. This
323 * generally means that an end-of-line character will appear at the end of
325 * @ATSPI_TEXT_BOUNDARY_LINE_END: Boundary condition is the end of a line; i.e.
326 * range is from start of one line to the start of another. This generally
327 * means that an end-of-line character will be the first character of the
330 * Specifies the boundary conditions determining a run of text as returned from
331 * #atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, and
332 * #atspi_text_get_text_before_offset.
334 * This enumerationis deprecated since 2.9.90 and should not be used. Use
335 * AtspiTextGranularity with #atspi_text_get_string_at_offset instead.
338 ATSPI_TEXT_BOUNDARY_CHAR,
339 ATSPI_TEXT_BOUNDARY_WORD_START,
340 ATSPI_TEXT_BOUNDARY_WORD_END,
341 ATSPI_TEXT_BOUNDARY_SENTENCE_START,
342 ATSPI_TEXT_BOUNDARY_SENTENCE_END,
343 ATSPI_TEXT_BOUNDARY_LINE_START,
344 ATSPI_TEXT_BOUNDARY_LINE_END,
345 } AtspiTextBoundaryType;
348 *AtspiTextGranularity:
349 *@ATSPI_TEXT_GRANULARITY_CHAR: Granularity is defined by the boundaries between characters
350 * (including non-printing characters)
351 *@ATSPI_TEXT_GRANULARITY_WORD: Granularity is defined by the boundaries of a word,
352 * starting at the beginning of the current word and finishing at the beginning of
353 * the following one, if present.
354 *@ATSPI_TEXT_GRANULARITY_SENTENCE: Granularity is defined by the boundaries of a sentence,
355 * starting at the beginning of the current sentence and finishing at the beginning of
356 * the following one, if present.
357 *@ATSPI_TEXT_GRANULARITY_LINE: Granularity is defined by the boundaries of a line,
358 * starting at the beginning of the current line and finishing at the beginning of
359 * the following one, if present.
360 *@ATSPI_TEXT_GRANULARITY_PARAGRAPH: Granularity is defined by the boundaries of a paragraph,
361 * starting at the beginning of the current paragraph and finishing at the beginning of
362 * the following one, if present.
364 * Text granularity types used for specifying the granularity of the region of
365 * text we are interested in.
368 ATSPI_TEXT_GRANULARITY_CHAR,
369 ATSPI_TEXT_GRANULARITY_WORD,
370 ATSPI_TEXT_GRANULARITY_SENTENCE,
371 ATSPI_TEXT_GRANULARITY_LINE,
372 ATSPI_TEXT_GRANULARITY_PARAGRAPH
373 } AtspiTextGranularity;
376 * ATSPI_TEXT_BOUNDARY_TYPE_COUNT:
378 * One higher than the highest valid value of #AtspiTextBoundaryType.
380 #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)
384 * @ATSPI_TEXT_CLIP_NONE: No characters/glyphs are omitted.
385 * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinate
387 * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum
388 * coordinate are omitted.
389 * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region
390 * bounded by min and max are retained.
392 * Enumeration used by interface #AtspiText to indicate
393 * how to treat characters intersecting bounding boxes.
397 ATSPI_TEXT_CLIP_NONE,
400 ATSPI_TEXT_CLIP_BOTH,
404 * ATSPI_TEXT_CLIP_TYPE_COUNT:
406 * One higher than the highest valid value of #AtspiTextClipType.
408 #define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1)
412 * @ATSPI_STATE_INVALID: Indicates an invalid state - probably an error
414 * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, or
415 * is an active subelement within a container or table.
416 * @ATSPI_STATE_ARMED: Indicates that the object is armed.
417 * @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen
418 * representation is in the process of changing, or the object is
419 * temporarily unavailable for interaction due to activity already in progress.
420 * @ATSPI_STATE_CHECKED: Indicates this object is currently checked.
421 * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed.
422 * @ATSPI_STATE_DEFUNCT: Indicates that this object no longer has a valid
423 * backing widget (for instance, if its peer object has been destroyed).
424 * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of this
426 * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that it
427 * currently reflects some application state. Objects that are "greyed out"
428 * may lack this state, and may lack the @ATSPI_STATE_SENSITIVE if direct
429 * user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED.
430 * See @ATSPI_STATE_SENSITIVE.
431 * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive
432 * disclosure of its children.
433 * @ATSPI_STATE_EXPANDED: Indicates this object is expanded.
434 * @ATSPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus,
435 * which means all events resulting from typing on the keyboard will
436 * normally be passed to it when it has focus.
437 * @ATSPI_STATE_FOCUSED: Indicates this object currently has the keyboard
439 * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated
441 * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of this object is
443 * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is
444 * represented only by an icon.
445 * @ATSPI_STATE_MODAL: Indicates something must be done with this object
446 * before the user can interact with an object in a different window.
447 * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multiple
449 * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one of
450 * its children to be selected at the same time, or in the case of text
451 * objects, that the object supports non-contiguous text selections.
452 * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its
453 * rectangular region. It also indicates an alpha value of unity, if it
454 * supports alpha blending.
455 * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed.
456 * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not
458 * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object
459 * that allows its children to be selected and that this child is one of
460 * those children that can be selected.
461 * @ATSPI_STATE_SELECTED: Indicates this object is the child of an object that
462 * allows its children to be selected and that this child is one of those
463 * children that has been selected.
464 * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user
465 * interaction. @ATSPI_STATE_SENSITIVE usually accompanies.
466 * @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the
467 * absence of @ATSPI_STATE_ENABLED if the current visible state of the control
468 * is "disconnected" from the application state. In such cases, direct user
469 * interaction can often result in the object gaining @ATSPI_STATE_SENSITIVE,
470 * for instance if a user makes an explicit selection using an object whose
471 * current state is ambiguous or undefined. See @ATSPI_STATE_ENABLED,
472 * @ATSPI_STATE_INDETERMINATE.
473 * @ATSPI_STATE_SHOWING: Indicates this object, the object's parent, the
474 * object's parent's parent, and so on, are all 'shown' to the end-user,
475 * i.e. subject to "exposure" if blocking or obscuring objects do not
476 * interpose between this object and the top of the window stack.
477 * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only a
478 * single line of text.
479 * @ATSPI_STATE_STALE: Indicates that the information returned for this object
480 * may no longer be synchronized with the application state. This can occur
481 * if the object has @ATSPI_STATE_TRANSIENT, and can also occur towards the
482 * end of the object peer's lifecycle.
483 * @ATSPI_STATE_TRANSIENT: Indicates this object is transient.
484 * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is vertical;
485 * for example this state may appear on such objects as scrollbars, text
486 * objects (with vertical text flow), separators, etc.
487 * @ATSPI_STATE_VISIBLE: Indicates this object is visible, e.g. has been
488 * explicitly marked for exposure to the user. @ATSPI_STATE_VISIBLE is no
489 * guarantee that the object is actually unobscured on the screen, only that
490 * it is 'potentially' visible, barring obstruction, being scrolled or clipped
491 * out of the field of view, or having an ancestor container that has not yet
492 * made visible. A widget is potentially onscreen if it has both
493 * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING. The absence of
494 * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING is
495 * semantically equivalent to saying that an object is 'hidden'.
496 * @ATSPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed"
497 * event is sent when children become 'active' (i.e. are selected or
498 * navigated to onscreen). Used to prevent need to enumerate all children
499 * in very large containers, like tables. The presence of
500 * @ATSPI_STATE_MANAGES_DESCENDANTS is an indication to the client that the
501 * children should not, and need not, be enumerated by the client.
502 * Objects implementing this state are expected to provide relevant state
503 * notifications to listening clients, for instance notifications of
504 * visibility changes and activation of their contained child objects, without
505 * the client having previously requested references to those children.
506 * @ATSPI_STATE_INDETERMINATE: Indicates that a check box or other boolean
507 * indicator is in a state other than checked or not checked. This
508 * usually means that the boolean value reflected or controlled by the
509 * object does not apply consistently to the entire current context.
510 * For example, a checkbox for the "Bold" attribute of text may have
511 * @ATSPI_STATE_INDETERMINATE if the currently selected text contains a mixture
512 * of weight attributes. In many cases interacting with a
513 * @ATSPI_STATE_INDETERMINATE object will cause the context's corresponding
514 * boolean attribute to be homogenized, whereupon the object will lose
515 * @ATSPI_STATE_INDETERMINATE and a corresponding state-changed event will be
517 * @ATSPI_STATE_REQUIRED: Indicates that user interaction with this object is
518 * 'required' from the user, for instance before completing the
519 * processing of a form.
520 * @ATSPI_STATE_TRUNCATED: Indicates that an object's onscreen content
521 * is truncated, e.g. a text value in a spreadsheet cell.
522 * @ATSPI_STATE_ANIMATED: Indicates this object's visual representation is
523 * dynamic, not static. This state may be applied to an object during an
524 * animated 'effect' and be removed from the object once its visual
525 * representation becomes static. Some applications, notably content viewers,
526 * may not be able to detect all kinds of animated content. Therefore the
527 * absence of this state should not be taken as
528 * definitive evidence that the object's visual representation is
529 * static; this state is advisory.
530 * @ATSPI_STATE_INVALID_ENTRY: This object has indicated an error condition
531 * due to failure of input validation. For instance, a form control may
532 * acquire this state in response to invalid or malformed user input.
533 * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the object
534 * in question implements some form of typeahead or
535 * pre-selection behavior whereby entering the first character of one or more
536 * sub-elements causes those elements to scroll into view or become
537 * selected. Subsequent character input may narrow the selection further as
538 * long as one or more sub-elements match the string. This state is normally
539 * only useful and encountered on objects that implement #AtspiSelection.
540 * In some cases the typeahead behavior may result in full or partial
541 * completion of the data in the input field, in which case
542 * these input events may trigger text-changed events from the source.
543 * @ATSPI_STATE_SELECTABLE_TEXT: This state indicates that the object in
544 * question supports text selection. It should only be exposed on objects
545 * which implement the #AtspiText interface, in order to distinguish this state
546 * from @ATSPI_STATE_SELECTABLE, which infers that the object in question is a
547 * selectable child of an object which implements #AtspiSelection. While
548 * similar, text selection and subelement selection are distinct operations.
549 * @ATSPI_STATE_IS_DEFAULT: This state indicates that the object in question is
550 * the 'default' interaction object in a dialog, i.e. the one that gets
551 * activated if the user presses "Enter" when the dialog is initially
553 * @ATSPI_STATE_VISITED: This state indicates that the object (typically a
554 * hyperlink) has already been activated or invoked, with the result that
555 * some backing data has been downloaded or rendered.
556 * @ATSPI_STATE_LAST_DEFINED: This value of the enumeration should not be used
557 * as a parameter, it indicates the number of items in the #AtspiStateType
561 * Enumeration used by various interfaces indicating every possible state
562 * an #AtspiAccesible object can assume.
571 ATSPI_STATE_COLLAPSED,
573 ATSPI_STATE_EDITABLE,
575 ATSPI_STATE_EXPANDABLE,
576 ATSPI_STATE_EXPANDED,
577 ATSPI_STATE_FOCUSABLE,
579 ATSPI_STATE_HAS_TOOLTIP,
580 ATSPI_STATE_HORIZONTAL,
581 ATSPI_STATE_ICONIFIED,
583 ATSPI_STATE_MULTI_LINE,
584 ATSPI_STATE_MULTISELECTABLE,
587 ATSPI_STATE_RESIZABLE,
588 ATSPI_STATE_SELECTABLE,
589 ATSPI_STATE_SELECTED,
590 ATSPI_STATE_SENSITIVE,
592 ATSPI_STATE_SINGLE_LINE,
594 ATSPI_STATE_TRANSIENT,
595 ATSPI_STATE_VERTICAL,
597 ATSPI_STATE_MANAGES_DESCENDANTS,
598 ATSPI_STATE_INDETERMINATE,
599 ATSPI_STATE_REQUIRED,
600 ATSPI_STATE_TRUNCATED,
601 ATSPI_STATE_ANIMATED,
602 ATSPI_STATE_INVALID_ENTRY,
603 ATSPI_STATE_SUPPORTS_AUTOCOMPLETION,
604 ATSPI_STATE_SELECTABLE_TEXT,
605 ATSPI_STATE_IS_DEFAULT,
607 ATSPI_STATE_LAST_DEFINED,
611 * ATSPI_STATETYPE_COUNT:
613 * One higher than the highest valid value of #AtspiStateType.
615 #define ATSPI_STATETYPE_COUNT (41+1)
619 * @ATSPI_KEY_PRESSED:
620 * @ATSPI_KEY_RELEASED:
622 * Deprecated. Should not be used.
631 * ATSPI_KEYEVENTTYPE_COUNT:
633 * One higher than the highest valid value of #AtspiKeyEventType.
635 #define ATSPI_KEYEVENTTYPE_COUNT (1+1)
639 * @ATSPI_KEY_PRESSED_EVENT: Indicates that a key on a keyboard device was
641 * @ATSPI_KEY_RELEASED_EVENT: Indicates that a key on a keyboard device was
643 * @ATSPI_BUTTON_PRESSED_EVENT: Indicates that a button on a non-keyboard
644 * human interface device (HID) was pressed.
645 * @ATSPI_BUTTON_RELEASED_EVENT: Indicates that a button on a non-keyboard
646 * human interface device (HID) was released.
648 * Enumeration used to specify the event types of interest to an
649 * #AtspiEventListener, or
650 * to identify the type of an event for which notification has been sent.
654 ATSPI_KEY_PRESSED_EVENT,
655 ATSPI_KEY_RELEASED_EVENT,
656 ATSPI_BUTTON_PRESSED_EVENT,
657 ATSPI_BUTTON_RELEASED_EVENT,
661 * ATSPI_EVENTTYPE_COUNT:
663 * One higher than the highest valid value of #AtspiEventType.
665 #define ATSPI_EVENTTYPE_COUNT (3+1)
669 * @ATSPI_KEY_PRESS: Emulates the pressing of a hardware keyboard key.
670 * @ATSPI_KEY_RELEASE: Emulates the release of a hardware keyboard key.
671 * @ATSPI_KEY_PRESSRELEASE: Emulates the pressing and immediate releasing
672 * of a hardware keyboard key.
673 * @ATSPI_KEY_SYM: A symbolic key event is generated, without specifying a
674 * hardware key. Note: if the keysym is not present in the current keyboard
675 * map, the #AtspiDeviceEventController instance has a limited ability to
676 * generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent
677 * calls using out-of-keymap keysyms will vary from system to system, and on
678 * the number of different out-of-keymap keysyms being generated in quick
680 * In practice this is rarely significant, since the keysyms of interest to
681 * AT clients and keyboard emulators are usually part of the current keymap,
682 * i.e., present on the system keyboard for the current locale (even if a
683 * physical hardware keyboard is not connected).
684 * @ATSPI_KEY_STRING: A string is converted to its equivalent keyboard events
685 * and emitted. If the string consists of complex characters or composed
686 * characters which are not in the current keymap, string emission is
687 * subject to the out-of-keymap limitations described for
688 * @ATSPI_KEY_SYM. In practice this limitation primarily effects
689 * Chinese and Japanese locales.
691 * Enumeration used when synthesizing keyboard input via
692 * #atspi_generate_keyboard_event.
698 ATSPI_KEY_PRESSRELEASE,
704 * ATSPI_KEYSYNTHTYPE_COUNT:
706 * One higher than the highest valid value of #AtspiKeySynthType.
708 #define ATSPI_KEYSYNTHTYPE_COUNT (4+1)
712 * @ATSPI_MODIFIER_SHIFT: The left or right 'Shift' key.
713 * @ATSPI_MODIFIER_SHIFTLOCK: The ShiftLock or CapsLock key.
714 * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'.
715 * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr).
716 * @ATSPI_MODIFIER_META: Depending on the platform, this may map to 'Window',
717 * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will
718 * map to one of META, META2, META3. On X Windows platforms these META
719 * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an
720 * event having @ATSPI_MODIFIER_META2 means that the 'Mod2Mask' bit
721 * is set in the corresponding XEvent.
722 * @ATSPI_MODIFIER_META2: See @ATSPI_MODIFIER_META.
723 * @ATSPI_MODIFIER_META3: See @ATSPI_MODIFIER_META.
724 * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-SPI
725 * to the appropriate META value, for the convenience of the client.
731 ATSPI_MODIFIER_SHIFT,
732 ATSPI_MODIFIER_SHIFTLOCK,
733 ATSPI_MODIFIER_CONTROL,
736 ATSPI_MODIFIER_META2,
737 ATSPI_MODIFIER_META3,
738 ATSPI_MODIFIER_NUMLOCK = 14,
742 * ATSPI_MODIFIERTYPE_COUNT:
744 * One higher than the highest valid value of #AtspiModifierType.
746 #define ATSPI_MODIFIERTYPE_COUNT (7+1)
750 * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not
751 * normally encounter this #AtspiRelationType value.
752 * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objects.
753 * @ATSPI_RELATION_LABELLED_BY: Object is labelled by one or more other
755 * @ATSPI_RELATION_CONTROLLER_FOR: Object is an interactive object which
756 * modifies the state, onscreen location, or other attributes of one or more
758 * @ATSPI_RELATION_CONTROLLED_BY: Object state, position, etc. is
759 * modified/controlled by user interaction with one or more other objects.
760 * For instance a viewport or scroll pane may be @ATSPI_RELATION_CONTROLLED_BY
762 * @ATSPI_RELATION_MEMBER_OF: Object has a grouping relationship (e.g. 'same
763 * group as') to one or more other objects.
764 * @ATSPI_RELATION_TOOLTIP_FOR: Object is a tooltip associated with another
766 * @ATSPI_RELATION_NODE_CHILD_OF: Object is a child of the target.
767 * @ATSPI_RELATION_NODE_PARENT_OF: Object is a parent of the target.
768 * @ATSPI_RELATION_EXTENDED: Used to indicate that a relationship exists, but
769 * its type is not specified in the enumeration.
770 * @ATSPI_RELATION_FLOWS_TO: Object renders content which flows logically to
771 * another object. For instance, text in a paragraph may flow to another
772 * object which is not the 'next sibling' in the accessibility hierarchy.
773 * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of @ATSPI_RELATION_FLOWS_TO.
774 * @ATSPI_RELATION_SUBWINDOW_OF: Object is visually and semantically considered
775 * a subwindow of another object, even though it is not the object's child.
776 * Useful when dealing with embedded applications and other cases where the
777 * widget hierarchy does not map cleanly to the onscreen presentation.
778 * @ATSPI_RELATION_EMBEDS: Similar to @ATSPI_RELATION_SUBWINDOW_OF, but
779 * specifically used for cross-process embedding.
780 * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of @ATSPI_RELATION_EMBEDS. Used to
781 * denote content rendered by embedded renderers that live in a separate process
782 * space from the embedding context.
783 * @ATSPI_RELATION_POPUP_FOR: Denotes that the object is a transient window or
784 * frame associated with another onscreen object. Similar to @ATSPI_TOOLTIP_FOR,
785 * but more general. Useful for windows which are technically toplevels
786 * but which, for one or more reasons, do not explicitly cause their
787 * associated window to lose 'window focus'. Creation of an @ATSPI_ROLE_WINDOW
788 * object with the @ATSPI_RELATION_POPUP_FOR relation usually requires
789 * some presentation action on the part
790 * of assistive technology clients, even though the previous toplevel
791 * @ATSPI_ROLE_FRAME object may still be the active window.
792 * @ATSPI_RELATION_PARENT_WINDOW_OF: This is the reciprocal relation to
793 * @ATSPI_RELATION_POPUP_FOR.
794 * @ATSPI_RELATION_DESCRIPTION_FOR: Indicates that an object provides
795 * descriptive information about another object; more verbose than
796 * @ATSPI_RELATION_LABEL_FOR.
797 * @ATSPI_RELATION_DESCRIBED_BY: Indicates that another object provides
798 * descriptive information about this object; more verbose than
799 * @ATSPI_RELATION_LABELLED_BY.
800 * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to
801 * determine the size of the enumeration.
803 * #AtspiRelationType specifies a relationship between objects
804 * (possibly one-to-many
805 * or many-to-one) outside of the normal parent/child hierarchical
806 * relationship. It allows better semantic identification of how objects
807 * are associated with one another. For instance the
808 * @ATSPI_RELATION_LABELLED_BY
809 * relationship may be used to identify labelling information that should
810 * accompany the accessible name property when presenting an object's content or
811 * identity to the end user. Similarly,
812 * @ATSPI_RELATION_CONTROLLER_FOR can be used
813 * to further specify the context in which a valuator is useful, and/or the
814 * other UI components which are directly effected by user interactions with
815 * the valuator. Common examples include association of scrollbars with the
816 * viewport or panel which they control.
819 * Enumeration used to specify
820 * the type of relation encapsulated in an #AtspiRelation object.
825 ATSPI_RELATION_LABEL_FOR,
826 ATSPI_RELATION_LABELLED_BY,
827 ATSPI_RELATION_CONTROLLER_FOR,
828 ATSPI_RELATION_CONTROLLED_BY,
829 ATSPI_RELATION_MEMBER_OF,
830 ATSPI_RELATION_TOOLTIP_FOR,
831 ATSPI_RELATION_NODE_CHILD_OF,
832 ATSPI_RELATION_NODE_PARENT_OF,
833 ATSPI_RELATION_EXTENDED,
834 ATSPI_RELATION_FLOWS_TO,
835 ATSPI_RELATION_FLOWS_FROM,
836 ATSPI_RELATION_SUBWINDOW_OF,
837 ATSPI_RELATION_EMBEDS,
838 ATSPI_RELATION_EMBEDDED_BY,
839 ATSPI_RELATION_POPUP_FOR,
840 ATSPI_RELATION_PARENT_WINDOW_OF,
841 ATSPI_RELATION_DESCRIPTION_FOR,
842 ATSPI_RELATION_DESCRIBED_BY,
843 ATSPI_RELATION_LAST_DEFINED,
847 * ATSPI_RELATIONTYPE_COUNT:
849 * One higher than the highest valid value of #AtspiRelationType.
851 #define ATSPI_RELATIONTYPE_COUNT (19+1)
855 * @ATSPI_ROLE_INVALID: A role indicating an error condition, such as
856 * uninitialized Role data.
857 * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard
858 * accelerators for the parent.
859 * @ATSPI_ROLE_ALERT: Object is used to alert the user about something.
860 * @ATSPI_ROLE_ANIMATION: Object contains a dynamic or moving image of some
862 * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator.
863 * @ATSPI_ROLE_CALENDAR: Object contains one or more dates, usually arranged
865 * @ATSPI_ROLE_CANVAS: Object that can be drawn into and is used to trap
867 * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and
868 * provides a separate indicator for the current state.
869 * @ATSPI_ROLE_CHECK_MENU_ITEM: A menu item that behaves like a check box. See
870 * @ATSPI_ROLE_CHECK_BOX.
871 * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a
873 * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data.
874 * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from.
875 * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date.
876 * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE.
877 * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and
878 * iconified versions of those internal frames.
879 * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotating a
880 * visual element, or which displays a value via such a rotating element.
881 * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border.
882 * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through
883 * and select the contents of a directory.
884 * @ATSPI_ROLE_DRAWING_AREA: A specialized dialog that displays the files in
885 * the directory and lets the user select a file, browse a different
886 * directory, or specify a filename.
887 * @ATSPI_ROLE_FILE_CHOOSER: An object used for drawing custom user interface
889 * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface.
890 * @ATSPI_ROLE_FOCUS_TRAVERSABLE: Don't use, reserved for future use.
891 * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font.
892 * @ATSPI_ROLE_FRAME: A top level window with a title bar, border, menubar,
894 * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of
895 * all panes beneath it.
896 * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children
897 * represent the document content.
898 * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate
900 * @ATSPI_ROLE_IMAGE: An image, typically static.
901 * @ATSPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop
903 * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in an
905 * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be
906 * drawn in layers, providing a form of stacking order.
907 * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user and
908 * allows the user to select one or more of them.
909 * @ATSPI_ROLE_LIST_ITEM: An object that represents an element of a list.
910 * @ATSPI_ROLE_MENU: An object usually found inside a menu bar that contains a
911 * list of actions the user can choose from.
912 * @ATSPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary
913 * dialog box of an application that contains a list of menus the user can
915 * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presents
916 * an action the user can choose.
917 * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a
919 * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list.
920 * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or
921 * page tabs), one at a time,through some mechanism provided by the
923 * @ATSPI_ROLE_PANEL: A generic container that is often used to group objects.
924 * @ATSPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places
925 * where the text content is not shown visibly to the user.
926 * @ATSPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer the
927 * user a list of choices, and then hides when the user selects one of those
929 * @ATSPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has
931 * @ATSPI_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the
932 * application to do something.
933 * @ATSPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other
934 * radio buttons in the same group to become unchecked when this one is
936 * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio button"
937 * . See @ATSPI_ROLE_RADIO_BUTTON.
938 * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a
939 * layered pane as its children.
940 * @ATSPI_ROLE_ROW_HEADER: The header for a row of data.
941 * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to
942 * incrementally view a large amount of data by moving the bounds of a
943 * viewport along a one-dimensional axis.
944 * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally view
945 * a large amount of information. @ATSPI_ROLE_SCROLL_PANE objects are usually
946 * accompanied by @ATSPI_ROLE_SCROLL_BAR controllers, on which the
947 * @ATSPI_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY
948 * reciprocal relations are set. See #atspi_get_relation_set.
949 * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a
950 * visible and logical separation of the contents in a menu.
951 * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a bounded
953 * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices to
954 * be selected, and which displays the current choice. Unlike
955 * @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control
956 * 'viewport'-like objects.
957 * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels
959 * @ATSPI_ROLE_STATUS_BAR: Object displays non-quantitative status information
960 * (c.f. @ATSPI_ROLE_PROGRESS_BAR)
961 * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of rows
963 * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. Note:
964 * Table cells need not have @ATSPI_ROLE_TABLE_CELL, other
965 * #AtspiRoleType values are valid as well.
966 * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular column
968 * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in a
969 * #AtspiTable. #AtspiTable rows and columns may also be labelled via the
970 * @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships.
971 * See #atspi_get_relation_set.
972 * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from menubar
973 * and shown in its own window.
974 * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal.
975 * @ATSPI_ROLE_TEXT: An object that presents text to the user, of nonspecific
977 * @ATSPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or
978 * unchecked, but does not procide a separate indicator for the current
980 * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or
982 * @ATSPI_ROLE_TOOL_TIP: An object that provides information about another
984 * @ATSPI_ROLE_TREE: An object used to repsent hierarchical information to the
986 * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and
987 * hierarchical info to the user.
988 * @ATSPI_ROLE_UNKNOWN: The object contains some #AtspiAccessible information,
989 * but its role is not known.
990 * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to
991 * otherwise clip a larger object or content renderer to a specific
993 * @ATSPI_ROLE_WINDOW: A top level window with no title or border.
994 * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but not
995 * included in the core enumeration.
996 * @ATSPI_ROLE_HEADER: An object that serves as a document header.
997 * @ATSPI_ROLE_FOOTER: An object that serves as a document footer.
998 * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of
999 * text content. See also @ATSPI_ROLE_TEXT.
1000 * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc.
1001 * for text objects which it controls (should have
1002 * @ATSPI_RELATION_CONTROLLER_FOR relation to such).
1003 * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessible
1004 * of an application, which may contain @ATSPI_ROLE_FRAME objects or other
1005 * accessible objects. Children of #AccessibleDesktop objects are generally
1006 * @ATSPI_ROLE_APPLICATION objects.
1007 * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items
1008 * for insertion into an entry widget, for instance a list of words for
1009 * completion of a text entry.
1010 * @ATSPI_ROLE_EDITBAR: The object is an editable text object in a toolbar.
1011 * @ATSPI_ROLE_EMBEDDED: The object is an embedded component container. This
1012 * role is a "grouping" hint that the contained objects share a context
1013 * which is different from the container in which this accessible is
1014 * embedded. In particular, it is used for some kinds of document embedding,
1015 * and for embedding of out-of-process component, "panel applets", etc.
1016 * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may be
1017 * entered or modified by the user, provided @ATSPI_STATE_EDITABLE is present.
1018 * A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is
1019 * not present) implies a read-only 'text field' in a form, as opposed to a
1020 * title, label, or caption.
1021 * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative data.
1022 * It may contain multiple subelements whose attributes and/or description
1023 * may be queried to obtain both the quantitative data and information about
1024 * how the data is being presented. The @ATSPI_LABELLED_BY relation is
1025 * particularly important in interpreting objects of this type, as is the
1026 * accessible description property. See @ATSPI_ROLE_CAPTION.
1027 * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usually
1028 * textual, about another user interface element such as a table, chart, or
1030 * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which
1031 * contains a view of document content. #AtspiDocument frames may occur within
1032 * another #AtspiDocument instance, in which case the second document may be
1033 * said to be embedded in the containing instance. HTML frames are often
1034 * ATSPI_ROLE_DOCUMENT_FRAME: Either this object, or a singleton descendant,
1035 * should implement the #AtspiDocument interface.
1036 * @ATSPI_ROLE_HEADING: The object serves as a heading for content which
1037 * follows it in a document. The 'heading level' of the heading, if
1038 * availabe, may be obtained by querying the object's attributes.
1039 * @ATSPI_ROLE_PAGE: The object is a containing instance which encapsulates a
1040 * page of information. @ATSPI_ROLE_PAGE is used in documents and content which
1041 * support a paginated navigation model.
1042 * @ATSPI_ROLE_SECTION: The object is a containing instance of document content
1043 * which constitutes a particular 'logical' section of the document. The
1044 * type of content within a section, and the nature of the section division
1045 * itself, may be obtained by querying the object's attributes. Sections
1047 * @ATSPI_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in
1048 * the hierarchy, and is exposed for purely technical reasons. Objects of
1049 * this role should be ignored by clients, if they are encountered at all.
1050 * @ATSPI_ROLE_FORM: The object is a containing instance of document content
1051 * which has within it components with which the user can interact in order
1052 * to input information; i.e. the object is a container for pushbuttons,
1053 * comboboxes, text input fields, and other 'GUI' components. @ATSPI_ROLE_FORM
1054 * should not, in general, be used for toplevel GUI containers or dialogs,
1055 * but should be reserved for 'GUI' containers which occur within document
1056 * content, for instance within Web documents, presentations, or text
1057 * documents. Unlike other GUI containers and dialogs which occur inside
1058 * application instances, @ATSPI_ROLE_FORM containers' components are
1059 * associated with the current document, rather than the current foreground
1060 * application or viewer instance.
1061 * @ATSPI_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a
1062 * hypertext document. Such objects are distinct from 'inline' content
1063 * which may also use the #AtspiHypertext/#AtspiHyperlink interfacesto indicate
1064 * the range/location within a text object where an inline or embedded object
1066 * @ATSPI_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
1067 * which is used to allow composition or input of a 'complex character',
1068 * in other words it is an "input method window".
1069 * @ATSPI_ROLE_TABLE_ROW: A row in a table.
1070 * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree.
1071 * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a
1073 * @ATSPI_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a
1074 * presentation or slide content.
1075 * @ATSPI_ROLE_DOCUMENT_TEXT: A document frame which contains textual content,
1076 * such as found in a word processing
1078 * @ATSPI_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other
1079 * markup suitable for display in a web browser.
1080 * @ATSPI_ROLE_DOCUMENT_EMAIL: A document frame which contains email content
1081 * to be displayed or composed either in plain text or
1083 * @ATSPI_ROLE_COMMENT: An object found within a document and designed to
1084 * present a comment, note, or other annotation. In some cases, this object
1085 * might not be visible until activated.
1086 * @ATSPI_ROLE_LIST_BOX: A non-collapsible list of choices the user can
1088 * @ATSPI_ROLE_GROUPING: A group of related widgets. This group typically has
1090 * @ATSPI_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multiple
1091 * hotspots, where each hotspot can be activated resulting in the loading of
1092 * another document or section of a document.
1093 * @ATSPI_ROLE_NOTIFICATION: A transitory object designed to present a
1094 * message to the user, typically at the desktop level rather than inside a
1095 * particular application.
1096 * @ATSPI_ROLE_INFO_BAR: An object designed to present a message to the user
1097 * within an existing window.
1098 *@ATSPI_ROLE_LEVEL_BAR: A bar that serves as a level indicator to, for
1099 * instance, show the strength of a password or the state of a battery.
1101 * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of
1104 * Enumeration used by interface #AtspiAccessible to specify the role
1105 * of an #AtspiAccessible object.
1110 ATSPI_ROLE_ACCELERATOR_LABEL,
1112 ATSPI_ROLE_ANIMATION,
1114 ATSPI_ROLE_CALENDAR,
1116 ATSPI_ROLE_CHECK_BOX,
1117 ATSPI_ROLE_CHECK_MENU_ITEM,
1118 ATSPI_ROLE_COLOR_CHOOSER,
1119 ATSPI_ROLE_COLUMN_HEADER,
1120 ATSPI_ROLE_COMBO_BOX,
1121 ATSPI_ROLE_DATE_EDITOR,
1122 ATSPI_ROLE_DESKTOP_ICON,
1123 ATSPI_ROLE_DESKTOP_FRAME,
1126 ATSPI_ROLE_DIRECTORY_PANE,
1127 ATSPI_ROLE_DRAWING_AREA,
1128 ATSPI_ROLE_FILE_CHOOSER,
1130 ATSPI_ROLE_FOCUS_TRAVERSABLE,
1131 ATSPI_ROLE_FONT_CHOOSER,
1133 ATSPI_ROLE_GLASS_PANE,
1134 ATSPI_ROLE_HTML_CONTAINER,
1137 ATSPI_ROLE_INTERNAL_FRAME,
1139 ATSPI_ROLE_LAYERED_PANE,
1141 ATSPI_ROLE_LIST_ITEM,
1143 ATSPI_ROLE_MENU_BAR,
1144 ATSPI_ROLE_MENU_ITEM,
1145 ATSPI_ROLE_OPTION_PANE,
1146 ATSPI_ROLE_PAGE_TAB,
1147 ATSPI_ROLE_PAGE_TAB_LIST,
1149 ATSPI_ROLE_PASSWORD_TEXT,
1150 ATSPI_ROLE_POPUP_MENU,
1151 ATSPI_ROLE_PROGRESS_BAR,
1152 ATSPI_ROLE_PUSH_BUTTON,
1153 ATSPI_ROLE_RADIO_BUTTON,
1154 ATSPI_ROLE_RADIO_MENU_ITEM,
1155 ATSPI_ROLE_ROOT_PANE,
1156 ATSPI_ROLE_ROW_HEADER,
1157 ATSPI_ROLE_SCROLL_BAR,
1158 ATSPI_ROLE_SCROLL_PANE,
1159 ATSPI_ROLE_SEPARATOR,
1161 ATSPI_ROLE_SPIN_BUTTON,
1162 ATSPI_ROLE_SPLIT_PANE,
1163 ATSPI_ROLE_STATUS_BAR,
1165 ATSPI_ROLE_TABLE_CELL,
1166 ATSPI_ROLE_TABLE_COLUMN_HEADER,
1167 ATSPI_ROLE_TABLE_ROW_HEADER,
1168 ATSPI_ROLE_TEAROFF_MENU_ITEM,
1169 ATSPI_ROLE_TERMINAL,
1171 ATSPI_ROLE_TOGGLE_BUTTON,
1172 ATSPI_ROLE_TOOL_BAR,
1173 ATSPI_ROLE_TOOL_TIP,
1175 ATSPI_ROLE_TREE_TABLE,
1177 ATSPI_ROLE_VIEWPORT,
1179 ATSPI_ROLE_EXTENDED,
1182 ATSPI_ROLE_PARAGRAPH,
1184 ATSPI_ROLE_APPLICATION,
1185 ATSPI_ROLE_AUTOCOMPLETE,
1187 ATSPI_ROLE_EMBEDDED,
1191 ATSPI_ROLE_DOCUMENT_FRAME,
1195 ATSPI_ROLE_REDUNDANT_OBJECT,
1198 ATSPI_ROLE_INPUT_METHOD_WINDOW,
1199 ATSPI_ROLE_TABLE_ROW,
1200 ATSPI_ROLE_TREE_ITEM,
1201 ATSPI_ROLE_DOCUMENT_SPREADSHEET,
1202 ATSPI_ROLE_DOCUMENT_PRESENTATION,
1203 ATSPI_ROLE_DOCUMENT_TEXT,
1204 ATSPI_ROLE_DOCUMENT_WEB,
1205 ATSPI_ROLE_DOCUMENT_EMAIL,
1207 ATSPI_ROLE_LIST_BOX,
1208 ATSPI_ROLE_GROUPING,
1209 ATSPI_ROLE_IMAGE_MAP,
1210 ATSPI_ROLE_NOTIFICATION,
1211 ATSPI_ROLE_INFO_BAR,
1212 ATSPI_ROLE_LEVEL_BAR,
1213 ATSPI_ROLE_LAST_DEFINED,
1219 * One higher than the highest valid value of #AtspiRole.
1221 #define ATSPI_ROLE_COUNT (90+1)
1225 ATSPI_CACHE_NONE = 0,
1226 ATSPI_CACHE_PARENT = 1 << 0,
1227 ATSPI_CACHE_CHILDREN = 1 << 1,
1228 ATSPI_CACHE_NAME = 1 << 2,
1229 ATSPI_CACHE_DESCRIPTION = 1 << 3,
1230 ATSPI_CACHE_STATES = 1 << 4,
1231 ATSPI_CACHE_ROLE = 1 << 5,
1232 ATSPI_CACHE_INTERFACES = 1 << 6,
1233 ATSPI_CACHE_ATTRIBUTES = 1 << 7,
1234 ATSPI_CACHE_ALL = 0x3fffffff,
1235 ATSPI_CACHE_DEFAULT = ATSPI_CACHE_PARENT | ATSPI_CACHE_CHILDREN |
1236 ATSPI_CACHE_NAME | ATSPI_CACHE_DESCRIPTION |
1237 ATSPI_CACHE_STATES | ATSPI_CACHE_ROLE |
1238 ATSPI_CACHE_INTERFACES,
1239 ATSPI_CACHE_UNDEFINED = 0x40000000,
1242 #define ATSPI_DBUS_NAME_REGISTRY "org.a11y.atspi.Registry"
1243 #define ATSPI_DBUS_PATH_REGISTRY "/org/a11y/atspi/registry"
1244 #define ATSPI_DBUS_INTERFACE_REGISTRY "org.a11y.atspi.Registry"
1246 #define ATSPI_DBUS_PATH_NULL "/org/a11y/atspi/null"
1247 #define ATSPI_DBUS_PATH_ROOT "/org/a11y/atspi/accessible/root"
1249 #define ATSPI_DBUS_PATH_DEC "/org/a11y/atspi/registry/deviceeventcontroller"
1250 #define ATSPI_DBUS_INTERFACE_DEC "org.a11y.atspi.DeviceEventController"
1251 #define ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER "org.a11y.atspi.DeviceEventListener"
1253 #define ATSPI_DBUS_INTERFACE_CACHE "org.a11y.atspi.Cache"
1254 #define ATSPI_DBUS_INTERFACE_ACCESSIBLE "org.a11y.atspi.Accessible"
1255 #define ATSPI_DBUS_INTERFACE_ACTION "org.a11y.atspi.Action"
1256 #define ATSPI_DBUS_INTERFACE_APPLICATION "org.a11y.atspi.Application"
1257 #define ATSPI_DBUS_INTERFACE_COLLECTION "org.a11y.atspi.Collection"
1258 #define ATSPI_DBUS_INTERFACE_COMPONENT "org.a11y.atspi.Component"
1259 #define ATSPI_DBUS_INTERFACE_DOCUMENT "org.a11y.atspi.Document"
1260 #define ATSPI_DBUS_INTERFACE_EDITABLE_TEXT "org.a11y.atspi.EditableText"
1261 #define ATSPI_DBUS_INTERFACE_EVENT_KEYBOARD "org.a11y.atspi.Event.Keyboard"
1262 #define ATSPI_DBUS_INTERFACE_EVENT_MOUSE "org.a11y.atspi.Event.Mouse"
1263 #define ATSPI_DBUS_INTERFACE_EVENT_OBJECT "org.a11y.atspi.Event.Object"
1264 #define ATSPI_DBUS_INTERFACE_HYPERLINK "org.a11y.atspi.Hyperlink"
1265 #define ATSPI_DBUS_INTERFACE_HYPERTEXT "org.a11y.atspi.Hypertext"
1266 #define ATSPI_DBUS_INTERFACE_IMAGE "org.a11y.atspi.Image"
1267 #define ATSPI_DBUS_INTERFACE_SELECTION "org.a11y.atspi.Selection"
1268 #define ATSPI_DBUS_INTERFACE_TABLE "org.a11y.atspi.Table"
1269 #define ATSPI_DBUS_INTERFACE_TEXT "org.a11y.atspi.Text"
1270 #define ATSPI_DBUS_INTERFACE_VALUE "org.a11y.atspi.Value"
1271 #define ATSPI_DBUS_INTERFACE_SOCKET "org.a11y.atspi.Socket"
1276 #endif /* _ATSPI_CONSTANTS_H_ */