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_NEIGHBOR_SEARCH_FORWARD = 1,
141 ATSPI_NEIGHBOR_SEARCH_BACKWARD = 2,
142 } AtspiNeighborSearchDirection;
145 * ATSPI_COORD_TYPE_COUNT:
147 * One higher than the highest valid value of #AtspiCoordType.
149 #define ATSPI_COORD_TYPE_COUNT (1+1)
152 * AtspiCollectionSortOrder:
153 * @ATSPI_Collection_SORT_ORDER_INVALID:
154 * @ATSPI_Collection_SORT_ORDER_CANONICAL:
155 * @ATSPI_Collection_SORT_ORDER_FLOW:
156 * @ATSPI_Collection_SORT_ORDER_TAB:
157 * @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL:
158 * @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW:
159 * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB:
160 * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED:
162 * Enumeration used by interface #AtspiCollection to specify
163 * the way #AtspiAccesible objects should be sorted.
167 ATSPI_Collection_SORT_ORDER_INVALID,
168 ATSPI_Collection_SORT_ORDER_CANONICAL,
169 ATSPI_Collection_SORT_ORDER_FLOW,
170 ATSPI_Collection_SORT_ORDER_TAB,
171 ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL,
172 ATSPI_Collection_SORT_ORDER_REVERSE_FLOW,
173 ATSPI_Collection_SORT_ORDER_REVERSE_TAB,
174 ATSPI_Collection_SORT_ORDER_LAST_DEFINED,
175 } AtspiCollectionSortOrder;
178 * ATSPI_SORTORDER_COUNT:
180 * One higher than the highest valid value of #AtspiCollectionSortOrder.
182 #define ATSPI_SORTORDER_COUNT (7+1)
185 * AtspiCollectionMatchType:
186 * @ATSPI_Collection_MATCH_INVALID: Indicates an error condition or
187 * uninitialized value.
188 * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met.
189 * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met.
190 * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met.
191 * @ATSPI_Collection_MATCH_EMPTY: Same as @ATSPI_Collection_MATCH_ALL if
192 * the criteria is non-empty; for empty criteria this rule requires returned
193 * value to also have empty set.
194 * @ATSPI_Collection_MATCH_LAST_DEFINED: Used only to determine the end of the
197 * Enumeration used by #AtspiMatchRule to specify
198 * how to interpret #AtspiAccessible objects.
202 ATSPI_Collection_MATCH_INVALID,
203 ATSPI_Collection_MATCH_ALL,
204 ATSPI_Collection_MATCH_ANY,
205 ATSPI_Collection_MATCH_NONE,
206 ATSPI_Collection_MATCH_EMPTY,
207 ATSPI_Collection_MATCH_LAST_DEFINED,
208 } AtspiCollectionMatchType;
211 * ATSPI_MATCHTYPE_COUNT:
213 * One higher than the highest valid value of #AtspiCollectionMatchType.
215 #define ATSPI_MATCHTYPES_COUNT (5+1)
218 * AtspiCollectionTreeTraversalType:
219 * @ATSPI_Collection_TREE_RESTRICT_CHILDREN:
220 * @ATSPI_Collection_TREE_RESTRICT_SIBLING:
221 * @ATSPI_Collection_TREE_INORDER:
222 * @ATSPI_Collection_TREE_LAST_DEFINED:
224 * Enumeration used by interface #AtspiCollection to specify
225 * restrictions on #AtspiAccesible objects to be traversed.
229 ATSPI_Collection_TREE_RESTRICT_CHILDREN,
230 ATSPI_Collection_TREE_RESTRICT_SIBLING,
231 ATSPI_Collection_TREE_INORDER,
232 ATSPI_Collection_TREE_LAST_DEFINED,
233 } AtspiCollectionTreeTraversalType;
236 * ATSPI_TREETRAVERSALTYPE_COUNT:
238 * One higher than the highest valid value of
239 * #AtspiCollection_TreeTraversalType.
241 #define ATSPI_TREETRAVERSALTYPE _COUNT(3+1)
244 * AtspiComponentLayer:
245 * @ATSPI_LAYER_INVALID: Indicates an error condition or uninitialized value.
246 * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything else
247 * is painted. The 'desktop background' is generally in this layer.
248 * @ATSPI_LAYER_CANVAS: The 'background' layer for most content renderers and
249 * UI #AtspiComponent containers.
250 * @ATSPI_LAYER_WIDGET: The layer in which the majority of ordinary
251 * 'foreground' widgets reside.
252 * @ATSPI_LAYER_MDI: A special layer between @ATSPI_LAYER_CANVAS and
253 * @ATSPI_LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames)
254 * reside. See #atspi_component_get_mdi_z_order.
255 * @ATSPI_LAYER_POPUP: A layer for popup window content, above
256 * @ATSPI_LAYER_WIDGET.
257 * @ATSPI_LAYER_OVERLAY: The topmost layer.
258 * @ATSPI_LAYER_WINDOW: The layer in which a toplevel window background usually
260 * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the
263 * The #AtspiComponentLayer of an #AtspiComponent instance indicates its
264 * relative stacking order with respect to the onscreen visual representation
265 * of the UI. #AtspiComponentLayer, in combination with #AtspiComponent bounds
266 * information, can be used to compute the visibility of all or part of a
267 * component. This is important in programmatic determination of
268 * region-of-interest for magnification, and in
269 * flat screen review models of the screen, as well as
270 * for other uses. Objects residing in two of the #AtspiComponentLayer
271 * categories support further z-ordering information, with respect to their
272 * peers in the same layer: namely, @ATSPI_LAYER_WINDOW and
273 * @ATSPI_LAYER_MDI. Relative stacking order for other objects within the
274 * same layer is not available; the recommended heuristic is
275 * first child paints first. In other words, assume that the
276 * first siblings in the child list are subject to being overpainted by later
277 * siblings if their bounds intersect. The order of layers, from bottom to top,
278 * is: @ATSPI_LAYER_BACKGROUND, @ATSPI_LAYER_WINDOW, @ATSPI_LAYER_MDI,
279 * @ATSPI_LAYER_CANVAS, @ATSPI_LAYER_WIDGET, @ATSPI_LAYER_POPUP, and
280 * @ATSPI_LAYER_OVERLAY.
285 ATSPI_LAYER_BACKGROUND,
292 ATSPI_LAYER_LAST_DEFINED,
293 } AtspiComponentLayer;
296 * ATSPI_COMPONENTLAYER_COUNT:
298 * One higher than the highest valid value of #AtspiComponentLayer.
300 #define ATSPI_COMPONENTLAYER_COUNT (8+1)
303 * AtspiTextBoundaryType:
304 * @ATSPI_TEXT_BOUNDARY_CHAR: An #AtspiText instance is bounded by this
305 * character only. Start and end offsets differ by one, by definition,
307 * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word; i.e.
308 * range is from start of one word to the start of another word.
309 * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word; i.e.
310 * range is from the end of one word to the end of another. Some locales
311 * may not distinguish between words and characters or glyphs. In particular,
312 * those locales which use wholly or partially ideographic character sets.
313 * In these cases, characters may be returned in lieu of multi-character
315 * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: Boundary condition is start of a
316 * sentence, as determined by the application. Some locales or
317 * character sets may not include explicit sentence delimiters, so this
318 * boundary type can not always be honored. Some locales will return lines
319 * of text instead of grammatical sentences.
320 * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: Boundary condition is end of a sentence,
321 * as determined by the application, including the sentence-delimiting
322 * character, for instance '.' Some locales or character sets may not
323 * include explicit sentence delimiters, so this boundary type can not
324 * always be honored. Some locales will return lines of text instead of
325 * grammatical sentences.
326 * @ATSPI_TEXT_BOUNDARY_LINE_START: Boundary condition is the start of a line;
327 * i.e. range is from start of one line to the start of another. This
328 * generally means that an end-of-line character will appear at the end of
330 * @ATSPI_TEXT_BOUNDARY_LINE_END: Boundary condition is the end of a line; i.e.
331 * range is from start of one line to the start of another. This generally
332 * means that an end-of-line character will be the first character of the
335 * Specifies the boundary conditions determining a run of text as returned from
336 * #atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, and
337 * #atspi_text_get_text_before_offset.
339 * This enumerationis deprecated since 2.9.90 and should not be used. Use
340 * AtspiTextGranularity with #atspi_text_get_string_at_offset instead.
343 ATSPI_TEXT_BOUNDARY_CHAR,
344 ATSPI_TEXT_BOUNDARY_WORD_START,
345 ATSPI_TEXT_BOUNDARY_WORD_END,
346 ATSPI_TEXT_BOUNDARY_SENTENCE_START,
347 ATSPI_TEXT_BOUNDARY_SENTENCE_END,
348 ATSPI_TEXT_BOUNDARY_LINE_START,
349 ATSPI_TEXT_BOUNDARY_LINE_END,
350 } AtspiTextBoundaryType;
353 *AtspiTextGranularity:
354 *@ATSPI_TEXT_GRANULARITY_CHAR: Granularity is defined by the boundaries between characters
355 * (including non-printing characters)
356 *@ATSPI_TEXT_GRANULARITY_WORD: Granularity is defined by the boundaries of a word,
357 * starting at the beginning of the current word and finishing at the beginning of
358 * the following one, if present.
359 *@ATSPI_TEXT_GRANULARITY_SENTENCE: Granularity is defined by the boundaries of a sentence,
360 * starting at the beginning of the current sentence and finishing at the beginning of
361 * the following one, if present.
362 *@ATSPI_TEXT_GRANULARITY_LINE: Granularity is defined by the boundaries of a line,
363 * starting at the beginning of the current line and finishing at the beginning of
364 * the following one, if present.
365 *@ATSPI_TEXT_GRANULARITY_PARAGRAPH: Granularity is defined by the boundaries of a paragraph,
366 * starting at the beginning of the current paragraph and finishing at the beginning of
367 * the following one, if present.
369 * Text granularity types used for specifying the granularity of the region of
370 * text we are interested in.
373 ATSPI_TEXT_GRANULARITY_CHAR,
374 ATSPI_TEXT_GRANULARITY_WORD,
375 ATSPI_TEXT_GRANULARITY_SENTENCE,
376 ATSPI_TEXT_GRANULARITY_LINE,
377 ATSPI_TEXT_GRANULARITY_PARAGRAPH
378 } AtspiTextGranularity;
381 * ATSPI_TEXT_BOUNDARY_TYPE_COUNT:
383 * One higher than the highest valid value of #AtspiTextBoundaryType.
385 #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)
389 * @ATSPI_TEXT_CLIP_NONE: No characters/glyphs are omitted.
390 * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinate
392 * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum
393 * coordinate are omitted.
394 * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region
395 * bounded by min and max are retained.
397 * Enumeration used by interface #AtspiText to indicate
398 * how to treat characters intersecting bounding boxes.
402 ATSPI_TEXT_CLIP_NONE,
405 ATSPI_TEXT_CLIP_BOTH,
409 * ATSPI_TEXT_CLIP_TYPE_COUNT:
411 * One higher than the highest valid value of #AtspiTextClipType.
413 #define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1)
417 * @ATSPI_STATE_INVALID: Indicates an invalid state - probably an error
419 * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, or
420 * an object is the active subelement within a container or table.
421 * @ATSPI_STATE_ACTIVE should not be used for objects which have
422 * @ATSPI_STATE_FOCUSABLE or @ATSPI_STATE_SELECTABLE: Those objects should use
423 * @ATSPI_STATE_FOCUSED and @ATSPI_STATE_SELECTED respectively.
424 * @ATSPI_STATE_ACTIVE is a means to indicate that an object which is not
425 * focusable and not selectable is the currently-active item within its
427 * @ATSPI_STATE_ARMED: Indicates that the object is armed.
428 * @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen
429 * representation is in the process of changing, or the object is
430 * temporarily unavailable for interaction due to activity already in progress.
431 * @ATSPI_STATE_CHECKED: Indicates this object is currently checked.
432 * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed.
433 * @ATSPI_STATE_DEFUNCT: Indicates that this object no longer has a valid
434 * backing widget (for instance, if its peer object has been destroyed).
435 * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of this
437 * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that it
438 * currently reflects some application state. Objects that are "greyed out"
439 * may lack this state, and may lack the @ATSPI_STATE_SENSITIVE if direct
440 * user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED.
441 * See @ATSPI_STATE_SENSITIVE.
442 * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive
443 * disclosure of its children.
444 * @ATSPI_STATE_EXPANDED: Indicates this object is expanded.
445 * @ATSPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus,
446 * which means all events resulting from typing on the keyboard will
447 * normally be passed to it when it has focus.
448 * @ATSPI_STATE_FOCUSED: Indicates this object currently has the keyboard
450 * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated
452 * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of this object is
454 * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is
455 * represented only by an icon.
456 * @ATSPI_STATE_MODAL: Indicates something must be done with this object
457 * before the user can interact with an object in a different window.
458 * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multiple
460 * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one of
461 * its children to be selected at the same time, or in the case of text
462 * objects, that the object supports non-contiguous text selections.
463 * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its
464 * rectangular region. It also indicates an alpha value of unity, if it
465 * supports alpha blending.
466 * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed.
467 * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not
469 * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object
470 * that allows its children to be selected and that this child is one of
471 * those children that can be selected.
472 * @ATSPI_STATE_SELECTED: Indicates this object is the child of an object that
473 * allows its children to be selected and that this child is one of those
474 * children that has been selected.
475 * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user
476 * interaction. @ATSPI_STATE_SENSITIVE usually accompanies.
477 * @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the
478 * absence of @ATSPI_STATE_ENABLED if the current visible state of the control
479 * is "disconnected" from the application state. In such cases, direct user
480 * interaction can often result in the object gaining @ATSPI_STATE_SENSITIVE,
481 * for instance if a user makes an explicit selection using an object whose
482 * current state is ambiguous or undefined. See @ATSPI_STATE_ENABLED,
483 * @ATSPI_STATE_INDETERMINATE.
484 * @ATSPI_STATE_SHOWING: Indicates this object, the object's parent, the
485 * object's parent's parent, and so on, are all 'shown' to the end-user,
486 * i.e. subject to "exposure" if blocking or obscuring objects do not
487 * interpose between this object and the top of the window stack.
488 * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only a
489 * single line of text.
490 * @ATSPI_STATE_STALE: Indicates that the information returned for this object
491 * may no longer be synchronized with the application state. This can occur
492 * if the object has @ATSPI_STATE_TRANSIENT, and can also occur towards the
493 * end of the object peer's lifecycle.
494 * @ATSPI_STATE_TRANSIENT: Indicates this object is transient.
495 * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is vertical;
496 * for example this state may appear on such objects as scrollbars, text
497 * objects (with vertical text flow), separators, etc.
498 * @ATSPI_STATE_VISIBLE: Indicates this object is visible, e.g. has been
499 * explicitly marked for exposure to the user. @ATSPI_STATE_VISIBLE is no
500 * guarantee that the object is actually unobscured on the screen, only that
501 * it is 'potentially' visible, barring obstruction, being scrolled or clipped
502 * out of the field of view, or having an ancestor container that has not yet
503 * made visible. A widget is potentially onscreen if it has both
504 * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING. The absence of
505 * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING is
506 * semantically equivalent to saying that an object is 'hidden'.
507 * @ATSPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed"
508 * event is sent when children become 'active' (i.e. are selected or
509 * navigated to onscreen). Used to prevent need to enumerate all children
510 * in very large containers, like tables. The presence of
511 * @ATSPI_STATE_MANAGES_DESCENDANTS is an indication to the client that the
512 * children should not, and need not, be enumerated by the client.
513 * Objects implementing this state are expected to provide relevant state
514 * notifications to listening clients, for instance notifications of
515 * visibility changes and activation of their contained child objects, without
516 * the client having previously requested references to those children.
517 * @ATSPI_STATE_INDETERMINATE: Indicates that a check box or other boolean
518 * indicator is in a state other than checked or not checked. This
519 * usually means that the boolean value reflected or controlled by the
520 * object does not apply consistently to the entire current context.
521 * For example, a checkbox for the "Bold" attribute of text may have
522 * @ATSPI_STATE_INDETERMINATE if the currently selected text contains a mixture
523 * of weight attributes. In many cases interacting with a
524 * @ATSPI_STATE_INDETERMINATE object will cause the context's corresponding
525 * boolean attribute to be homogenized, whereupon the object will lose
526 * @ATSPI_STATE_INDETERMINATE and a corresponding state-changed event will be
528 * @ATSPI_STATE_REQUIRED: Indicates that user interaction with this object is
529 * 'required' from the user, for instance before completing the
530 * processing of a form.
531 * @ATSPI_STATE_TRUNCATED: Indicates that an object's onscreen content
532 * is truncated, e.g. a text value in a spreadsheet cell.
533 * @ATSPI_STATE_ANIMATED: Indicates this object's visual representation is
534 * dynamic, not static. This state may be applied to an object during an
535 * animated 'effect' and be removed from the object once its visual
536 * representation becomes static. Some applications, notably content viewers,
537 * may not be able to detect all kinds of animated content. Therefore the
538 * absence of this state should not be taken as
539 * definitive evidence that the object's visual representation is
540 * static; this state is advisory.
541 * @ATSPI_STATE_INVALID_ENTRY: This object has indicated an error condition
542 * due to failure of input validation. For instance, a form control may
543 * acquire this state in response to invalid or malformed user input.
544 * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the object
545 * in question implements some form of typeahead or
546 * pre-selection behavior whereby entering the first character of one or more
547 * sub-elements causes those elements to scroll into view or become
548 * selected. Subsequent character input may narrow the selection further as
549 * long as one or more sub-elements match the string. This state is normally
550 * only useful and encountered on objects that implement #AtspiSelection.
551 * In some cases the typeahead behavior may result in full or partial
552 * completion of the data in the input field, in which case
553 * these input events may trigger text-changed events from the source.
554 * @ATSPI_STATE_SELECTABLE_TEXT: This state indicates that the object in
555 * question supports text selection. It should only be exposed on objects
556 * which implement the #AtspiText interface, in order to distinguish this state
557 * from @ATSPI_STATE_SELECTABLE, which infers that the object in question is a
558 * selectable child of an object which implements #AtspiSelection. While
559 * similar, text selection and subelement selection are distinct operations.
560 * @ATSPI_STATE_IS_DEFAULT: This state indicates that the object in question is
561 * the 'default' interaction object in a dialog, i.e. the one that gets
562 * activated if the user presses "Enter" when the dialog is initially
564 * @ATSPI_STATE_VISITED: This state indicates that the object (typically a
565 * hyperlink) has already been activated or invoked, with the result that
566 * some backing data has been downloaded or rendered.
567 *@ATSPI_STATE_CHECKABLE: Indicates this object has the potential to
568 * be checked, such as a checkbox or toggle-able table cell. @Since:
570 *@ATSPI_STATE_HAS_POPUP: Indicates that the object has a popup
571 * context menu or sub-level menu which may or may not be
572 * showing. This means that activation renders conditional content.
573 * Note that ordinary tooltips are not considered popups in this
574 * context. @Since: 2.12
575 * @ATSPI_STATE_READ_ONLY: Indicates that an object which is ENABLED and
576 * SENSITIVE has a value which can be read, but not modified, by the
578 * @ATSPI_STATE_HIGHLIGHTED: Indicates that an object which is HIGHLIGHTABLE
579 * has been graphically marked to assits visally impared users. Only one
580 * object per window can have ATSPI_STATE_HIGHLIGHTED state.
581 * @ATSPI_STATE_HIGHLIGHTABLE: Indicates that an object can be graphically
582 * marked to assist visially impaired users.
584 * @ATSPI_STATE_LAST_DEFINED: This value of the enumeration should not be used
585 * as a parameter, it indicates the number of items in the #AtspiStateType
589 * Enumeration used by various interfaces indicating every possible state
590 * an #AtspiAccesible object can assume.
599 ATSPI_STATE_COLLAPSED,
601 ATSPI_STATE_EDITABLE,
603 ATSPI_STATE_EXPANDABLE,
604 ATSPI_STATE_EXPANDED,
605 ATSPI_STATE_FOCUSABLE,
607 ATSPI_STATE_HAS_TOOLTIP,
608 ATSPI_STATE_HORIZONTAL,
609 ATSPI_STATE_ICONIFIED,
611 ATSPI_STATE_MULTI_LINE,
612 ATSPI_STATE_MULTISELECTABLE,
615 ATSPI_STATE_RESIZABLE,
616 ATSPI_STATE_SELECTABLE,
617 ATSPI_STATE_SELECTED,
618 ATSPI_STATE_SENSITIVE,
620 ATSPI_STATE_SINGLE_LINE,
622 ATSPI_STATE_TRANSIENT,
623 ATSPI_STATE_VERTICAL,
625 ATSPI_STATE_MANAGES_DESCENDANTS,
626 ATSPI_STATE_INDETERMINATE,
627 ATSPI_STATE_REQUIRED,
628 ATSPI_STATE_TRUNCATED,
629 ATSPI_STATE_ANIMATED,
630 ATSPI_STATE_INVALID_ENTRY,
631 ATSPI_STATE_SUPPORTS_AUTOCOMPLETION,
632 ATSPI_STATE_SELECTABLE_TEXT,
633 ATSPI_STATE_IS_DEFAULT,
635 ATSPI_STATE_CHECKABLE,
636 ATSPI_STATE_HAS_POPUP,
637 ATSPI_STATE_READ_ONLY,
638 ATSPI_STATE_HIGHLIGHTED,
639 ATSPI_STATE_HIGHLIGHTABLE,
640 ATSPI_STATE_LAST_DEFINED,
644 * ATSPI_STATETYPE_COUNT:
646 * One higher than the highest valid value of #AtspiStateType.
648 #define ATSPI_STATETYPE_COUNT (41+1)
652 * @ATSPI_KEY_PRESSED:
653 * @ATSPI_KEY_RELEASED:
655 * Deprecated. Should not be used.
664 * ATSPI_KEYEVENTTYPE_COUNT:
666 * One higher than the highest valid value of #AtspiKeyEventType.
668 #define ATSPI_KEYEVENTTYPE_COUNT (1+1)
672 * @ATSPI_KEY_PRESSED_EVENT: Indicates that a key on a keyboard device was
674 * @ATSPI_KEY_RELEASED_EVENT: Indicates that a key on a keyboard device was
676 * @ATSPI_BUTTON_PRESSED_EVENT: Indicates that a button on a non-keyboard
677 * human interface device (HID) was pressed.
678 * @ATSPI_BUTTON_RELEASED_EVENT: Indicates that a button on a non-keyboard
679 * human interface device (HID) was released.
681 * Enumeration used to specify the event types of interest to an
682 * #AtspiEventListener, or
683 * to identify the type of an event for which notification has been sent.
687 ATSPI_KEY_PRESSED_EVENT,
688 ATSPI_KEY_RELEASED_EVENT,
689 ATSPI_BUTTON_PRESSED_EVENT,
690 ATSPI_BUTTON_RELEASED_EVENT,
694 * ATSPI_EVENTTYPE_COUNT:
696 * One higher than the highest valid value of #AtspiEventType.
698 #define ATSPI_EVENTTYPE_COUNT (3+1)
702 * @ATSPI_KEY_PRESS: Emulates the pressing of a hardware keyboard key.
703 * @ATSPI_KEY_RELEASE: Emulates the release of a hardware keyboard key.
704 * @ATSPI_KEY_PRESSRELEASE: Emulates the pressing and immediate releasing
705 * of a hardware keyboard key.
706 * @ATSPI_KEY_SYM: A symbolic key event is generated, without specifying a
707 * hardware key. Note: if the keysym is not present in the current keyboard
708 * map, the #AtspiDeviceEventController instance has a limited ability to
709 * generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent
710 * calls using out-of-keymap keysyms will vary from system to system, and on
711 * the number of different out-of-keymap keysyms being generated in quick
713 * In practice this is rarely significant, since the keysyms of interest to
714 * AT clients and keyboard emulators are usually part of the current keymap,
715 * i.e., present on the system keyboard for the current locale (even if a
716 * physical hardware keyboard is not connected).
717 * @ATSPI_KEY_STRING: A string is converted to its equivalent keyboard events
718 * and emitted. If the string consists of complex characters or composed
719 * characters which are not in the current keymap, string emission is
720 * subject to the out-of-keymap limitations described for
721 * @ATSPI_KEY_SYM. In practice this limitation primarily effects
722 * Chinese and Japanese locales.
724 * Enumeration used when synthesizing keyboard input via
725 * #atspi_generate_keyboard_event.
731 ATSPI_KEY_PRESSRELEASE,
737 * ATSPI_KEYSYNTHTYPE_COUNT:
739 * One higher than the highest valid value of #AtspiKeySynthType.
741 #define ATSPI_KEYSYNTHTYPE_COUNT (4+1)
745 * @ATSPI_MODIFIER_SHIFT: The left or right 'Shift' key.
746 * @ATSPI_MODIFIER_SHIFTLOCK: The ShiftLock or CapsLock key.
747 * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'.
748 * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr).
749 * @ATSPI_MODIFIER_META: Depending on the platform, this may map to 'Window',
750 * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will
751 * map to one of META, META2, META3. On X Windows platforms these META
752 * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an
753 * event having @ATSPI_MODIFIER_META2 means that the 'Mod2Mask' bit
754 * is set in the corresponding XEvent.
755 * @ATSPI_MODIFIER_META2: See @ATSPI_MODIFIER_META.
756 * @ATSPI_MODIFIER_META3: See @ATSPI_MODIFIER_META.
757 * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-SPI
758 * to the appropriate META value, for the convenience of the client.
764 ATSPI_MODIFIER_SHIFT,
765 ATSPI_MODIFIER_SHIFTLOCK,
766 ATSPI_MODIFIER_CONTROL,
769 ATSPI_MODIFIER_META2,
770 ATSPI_MODIFIER_META3,
771 ATSPI_MODIFIER_NUMLOCK = 14,
775 * ATSPI_MODIFIERTYPE_COUNT:
777 * One higher than the highest valid value of #AtspiModifierType.
779 #define ATSPI_MODIFIERTYPE_COUNT (7+1)
783 * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not
784 * normally encounter this #AtspiRelationType value.
785 * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objects.
786 * @ATSPI_RELATION_LABELLED_BY: Object is labelled by one or more other
788 * @ATSPI_RELATION_CONTROLLER_FOR: Object is an interactive object which
789 * modifies the state, onscreen location, or other attributes of one or more
791 * @ATSPI_RELATION_CONTROLLED_BY: Object state, position, etc. is
792 * modified/controlled by user interaction with one or more other objects.
793 * For instance a viewport or scroll pane may be @ATSPI_RELATION_CONTROLLED_BY
795 * @ATSPI_RELATION_MEMBER_OF: Object has a grouping relationship (e.g. 'same
796 * group as') to one or more other objects.
797 * @ATSPI_RELATION_TOOLTIP_FOR: Object is a tooltip associated with another
799 * @ATSPI_RELATION_NODE_CHILD_OF: Object is a child of the target.
800 * @ATSPI_RELATION_NODE_PARENT_OF: Object is a parent of the target.
801 * @ATSPI_RELATION_EXTENDED: Used to indicate that a relationship exists, but
802 * its type is not specified in the enumeration.
803 * @ATSPI_RELATION_FLOWS_TO: Object renders content which flows logically to
804 * another object. For instance, text in a paragraph may flow to another
805 * object which is not the 'next sibling' in the accessibility hierarchy.
806 * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of @ATSPI_RELATION_FLOWS_TO.
807 * @ATSPI_RELATION_SUBWINDOW_OF: Object is visually and semantically considered
808 * a subwindow of another object, even though it is not the object's child.
809 * Useful when dealing with embedded applications and other cases where the
810 * widget hierarchy does not map cleanly to the onscreen presentation.
811 * @ATSPI_RELATION_EMBEDS: Similar to @ATSPI_RELATION_SUBWINDOW_OF, but
812 * specifically used for cross-process embedding.
813 * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of @ATSPI_RELATION_EMBEDS. Used to
814 * denote content rendered by embedded renderers that live in a separate process
815 * space from the embedding context.
816 * @ATSPI_RELATION_POPUP_FOR: Denotes that the object is a transient window or
817 * frame associated with another onscreen object. Similar to @ATSPI_TOOLTIP_FOR,
818 * but more general. Useful for windows which are technically toplevels
819 * but which, for one or more reasons, do not explicitly cause their
820 * associated window to lose 'window focus'. Creation of an @ATSPI_ROLE_WINDOW
821 * object with the @ATSPI_RELATION_POPUP_FOR relation usually requires
822 * some presentation action on the part
823 * of assistive technology clients, even though the previous toplevel
824 * @ATSPI_ROLE_FRAME object may still be the active window.
825 * @ATSPI_RELATION_PARENT_WINDOW_OF: This is the reciprocal relation to
826 * @ATSPI_RELATION_POPUP_FOR.
827 * @ATSPI_RELATION_DESCRIPTION_FOR: Indicates that an object provides
828 * descriptive information about another object; more verbose than
829 * @ATSPI_RELATION_LABEL_FOR.
830 * @ATSPI_RELATION_DESCRIBED_BY: Indicates that another object provides
831 * descriptive information about this object; more verbose than
832 * @ATSPI_RELATION_LABELLED_BY.
833 * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to
834 * determine the size of the enumeration.
836 * #AtspiRelationType specifies a relationship between objects
837 * (possibly one-to-many
838 * or many-to-one) outside of the normal parent/child hierarchical
839 * relationship. It allows better semantic identification of how objects
840 * are associated with one another. For instance the
841 * @ATSPI_RELATION_LABELLED_BY
842 * relationship may be used to identify labelling information that should
843 * accompany the accessible name property when presenting an object's content or
844 * identity to the end user. Similarly,
845 * @ATSPI_RELATION_CONTROLLER_FOR can be used
846 * to further specify the context in which a valuator is useful, and/or the
847 * other UI components which are directly effected by user interactions with
848 * the valuator. Common examples include association of scrollbars with the
849 * viewport or panel which they control.
852 * Enumeration used to specify
853 * the type of relation encapsulated in an #AtspiRelation object.
858 ATSPI_RELATION_LABEL_FOR,
859 ATSPI_RELATION_LABELLED_BY,
860 ATSPI_RELATION_CONTROLLER_FOR,
861 ATSPI_RELATION_CONTROLLED_BY,
862 ATSPI_RELATION_MEMBER_OF,
863 ATSPI_RELATION_TOOLTIP_FOR,
864 ATSPI_RELATION_NODE_CHILD_OF,
865 ATSPI_RELATION_NODE_PARENT_OF,
866 ATSPI_RELATION_EXTENDED,
867 ATSPI_RELATION_FLOWS_TO,
868 ATSPI_RELATION_FLOWS_FROM,
869 ATSPI_RELATION_SUBWINDOW_OF,
870 ATSPI_RELATION_EMBEDS,
871 ATSPI_RELATION_EMBEDDED_BY,
872 ATSPI_RELATION_POPUP_FOR,
873 ATSPI_RELATION_PARENT_WINDOW_OF,
874 ATSPI_RELATION_DESCRIPTION_FOR,
875 ATSPI_RELATION_DESCRIBED_BY,
876 ATSPI_RELATION_LAST_DEFINED,
880 * ATSPI_RELATIONTYPE_COUNT:
882 * One higher than the highest valid value of #AtspiRelationType.
884 #define ATSPI_RELATIONTYPE_COUNT (19+1)
888 * @ATSPI_ROLE_INVALID: A role indicating an error condition, such as
889 * uninitialized Role data.
890 * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard
891 * accelerators for the parent.
892 * @ATSPI_ROLE_ALERT: Object is used to alert the user about something.
893 * @ATSPI_ROLE_ANIMATION: Object contains a dynamic or moving image of some
895 * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator.
896 * @ATSPI_ROLE_CALENDAR: Object contains one or more dates, usually arranged
898 * @ATSPI_ROLE_CANVAS: Object that can be drawn into and is used to trap
900 * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and
901 * provides a separate indicator for the current state.
902 * @ATSPI_ROLE_CHECK_MENU_ITEM: A menu item that behaves like a check box. See
903 * @ATSPI_ROLE_CHECK_BOX.
904 * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a
906 * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data.
907 * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from.
908 * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date.
909 * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_PANE.
910 * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and
911 * iconified versions of those internal frames.
912 * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotating a
913 * visual element, or which displays a value via such a rotating element.
914 * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border.
915 * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through
916 * and select the contents of a directory.
917 * @ATSPI_ROLE_DRAWING_AREA: A specialized dialog that displays the files in
918 * the directory and lets the user select a file, browse a different
919 * directory, or specify a filename.
920 * @ATSPI_ROLE_FILE_CHOOSER: An object used for drawing custom user interface
922 * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface.
923 * @ATSPI_ROLE_FOCUS_TRAVERSABLE: Don't use, reserved for future use.
924 * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font.
925 * @ATSPI_ROLE_FRAME: A top level window with a title bar, border, menubar,
927 * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of
928 * all panes beneath it.
929 * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children
930 * represent the document content.
931 * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate
933 * @ATSPI_ROLE_IMAGE: An image, typically static.
934 * @ATSPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop
936 * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in an
938 * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be
939 * drawn in layers, providing a form of stacking order.
940 * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user and
941 * allows the user to select one or more of them.
942 * @ATSPI_ROLE_LIST_ITEM: An object that represents an element of a list.
943 * @ATSPI_ROLE_MENU: An object usually found inside a menu bar that contains a
944 * list of actions the user can choose from.
945 * @ATSPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary
946 * dialog box of an application that contains a list of menus the user can
948 * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presents
949 * an action the user can choose.
950 * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a
952 * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list.
953 * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or
954 * page tabs), one at a time,through some mechanism provided by the
956 * @ATSPI_ROLE_PANEL: A generic container that is often used to group objects.
957 * @ATSPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places
958 * where the text content is not shown visibly to the user.
959 * @ATSPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer the
960 * user a list of choices, and then hides when the user selects one of those
962 * @ATSPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has
964 * @ATSPI_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the
965 * application to do something.
966 * @ATSPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other
967 * radio buttons in the same group to become unchecked when this one is
969 * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio button"
970 * . See @ATSPI_ROLE_RADIO_BUTTON.
971 * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a
972 * layered pane as its children.
973 * @ATSPI_ROLE_ROW_HEADER: The header for a row of data.
974 * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to
975 * incrementally view a large amount of data by moving the bounds of a
976 * viewport along a one-dimensional axis.
977 * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally view
978 * a large amount of information. @ATSPI_ROLE_SCROLL_PANE objects are usually
979 * accompanied by @ATSPI_ROLE_SCROLL_BAR controllers, on which the
980 * @ATSPI_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY
981 * reciprocal relations are set. See #atspi_get_relation_set.
982 * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a
983 * visible and logical separation of the contents in a menu.
984 * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a bounded
986 * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices to
987 * be selected, and which displays the current choice. Unlike
988 * @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control
989 * 'viewport'-like objects.
990 * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels
992 * @ATSPI_ROLE_STATUS_BAR: Object displays non-quantitative status information
993 * (c.f. @ATSPI_ROLE_PROGRESS_BAR)
994 * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of rows
996 * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. Note:
997 * Table cells need not have @ATSPI_ROLE_TABLE_CELL, other
998 * #AtspiRoleType values are valid as well.
999 * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular column
1000 * in an #AtspiTable.
1001 * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in a
1002 * #AtspiTable. #AtspiTable rows and columns may also be labelled via the
1003 * @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships.
1004 * See #atspi_get_relation_set.
1005 * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from menubar
1006 * and shown in its own window.
1007 * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal.
1008 * @ATSPI_ROLE_TEXT: An interactive widget that supports multiple lines of text
1009 * and optionally accepts user input, but whose purpose is not to solicit user
1010 * input. Thus @ATSPI_ROLE_TEXT is appropriate for the text view in a plain text
1011 * editor but inappropriate for an input field in a dialog box or web form. For
1012 * widgets whose purpose is to solicit input from the user, see @ATSPI_ROLE_ENTRY
1013 * and @ATSPI_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount
1014 * of textual information, see @ATSPI_ROLE_STATIC.
1015 * @ATSPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or
1016 * unchecked, but does not procide a separate indicator for the current
1018 * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or
1020 * @ATSPI_ROLE_TOOL_TIP: An object that provides information about another
1022 * @ATSPI_ROLE_TREE: An object used to repsent hierarchical information to the
1024 * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and
1025 * hierarchical info to the user.
1026 * @ATSPI_ROLE_UNKNOWN: The object contains some #AtspiAccessible information,
1027 * but its role is not known.
1028 * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to
1029 * otherwise clip a larger object or content renderer to a specific
1030 * onscreen viewport.
1031 * @ATSPI_ROLE_WINDOW: A top level window with no title or border.
1032 * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but not
1033 * included in the core enumeration.
1034 * @ATSPI_ROLE_HEADER: An object that serves as a document header.
1035 * @ATSPI_ROLE_FOOTER: An object that serves as a document footer.
1036 * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of
1037 * text content. See also @ATSPI_ROLE_TEXT.
1038 * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc.
1039 * for text objects which it controls (should have
1040 * @ATSPI_RELATION_CONTROLLER_FOR relation to such).
1041 * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessible
1042 * of an application, which may contain @ATSPI_ROLE_FRAME objects or other
1043 * accessible objects. Children of #AccessibleDesktop objects are generally
1044 * @ATSPI_ROLE_APPLICATION objects.
1045 * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items
1046 * for insertion into an entry widget, for instance a list of words for
1047 * completion of a text entry.
1048 * @ATSPI_ROLE_EDITBAR: The object is an editable text object in a toolbar.
1049 * @ATSPI_ROLE_EMBEDDED: The object is an embedded component container. This
1050 * role is a "grouping" hint that the contained objects share a context
1051 * which is different from the container in which this accessible is
1052 * embedded. In particular, it is used for some kinds of document embedding,
1053 * and for embedding of out-of-process component, "panel applets", etc.
1054 * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may be
1055 * entered or modified by the user, provided @ATSPI_STATE_EDITABLE is present.
1056 * A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is
1057 * not present) implies a read-only 'text field' in a form, as opposed to a
1058 * title, label, or caption.
1059 * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative data.
1060 * It may contain multiple subelements whose attributes and/or description
1061 * may be queried to obtain both the quantitative data and information about
1062 * how the data is being presented. The @ATSPI_LABELLED_BY relation is
1063 * particularly important in interpreting objects of this type, as is the
1064 * accessible description property. See @ATSPI_ROLE_CAPTION.
1065 * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usually
1066 * textual, about another user interface element such as a table, chart, or
1068 * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which
1069 * contains a view of document content. #AtspiDocument frames may occur within
1070 * another #AtspiDocument instance, in which case the second document may be
1071 * said to be embedded in the containing instance. HTML frames are often
1072 * ATSPI_ROLE_DOCUMENT_FRAME: Either this object, or a singleton descendant,
1073 * should implement the #AtspiDocument interface.
1074 * @ATSPI_ROLE_HEADING: The object serves as a heading for content which
1075 * follows it in a document. The 'heading level' of the heading, if
1076 * availabe, may be obtained by querying the object's attributes.
1077 * @ATSPI_ROLE_PAGE: The object is a containing instance which encapsulates a
1078 * page of information. @ATSPI_ROLE_PAGE is used in documents and content which
1079 * support a paginated navigation model.
1080 * @ATSPI_ROLE_SECTION: The object is a containing instance of document content
1081 * which constitutes a particular 'logical' section of the document. The
1082 * type of content within a section, and the nature of the section division
1083 * itself, may be obtained by querying the object's attributes. Sections
1085 * @ATSPI_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in
1086 * the hierarchy, and is exposed for purely technical reasons. Objects of
1087 * this role should be ignored by clients, if they are encountered at all.
1088 * @ATSPI_ROLE_FORM: The object is a containing instance of document content
1089 * which has within it components with which the user can interact in order
1090 * to input information; i.e. the object is a container for pushbuttons,
1091 * comboboxes, text input fields, and other 'GUI' components. @ATSPI_ROLE_FORM
1092 * should not, in general, be used for toplevel GUI containers or dialogs,
1093 * but should be reserved for 'GUI' containers which occur within document
1094 * content, for instance within Web documents, presentations, or text
1095 * documents. Unlike other GUI containers and dialogs which occur inside
1096 * application instances, @ATSPI_ROLE_FORM containers' components are
1097 * associated with the current document, rather than the current foreground
1098 * application or viewer instance.
1099 * @ATSPI_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a
1100 * hypertext document. Such objects are distinct from 'inline' content
1101 * which may also use the #AtspiHypertext/#AtspiHyperlink interfacesto indicate
1102 * the range/location within a text object where an inline or embedded object
1104 * @ATSPI_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
1105 * which is used to allow composition or input of a 'complex character',
1106 * in other words it is an "input method window".
1107 * @ATSPI_ROLE_TABLE_ROW: A row in a table.
1108 * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree.
1109 * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a
1111 * @ATSPI_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a
1112 * presentation or slide content.
1113 * @ATSPI_ROLE_DOCUMENT_TEXT: A document frame which contains textual content,
1114 * such as found in a word processing
1116 * @ATSPI_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other
1117 * markup suitable for display in a web browser.
1118 * @ATSPI_ROLE_DOCUMENT_EMAIL: A document frame which contains email content
1119 * to be displayed or composed either in plain text or
1121 * @ATSPI_ROLE_COMMENT: An object found within a document and designed to
1122 * present a comment, note, or other annotation. In some cases, this object
1123 * might not be visible until activated.
1124 * @ATSPI_ROLE_LIST_BOX: A non-collapsible list of choices the user can
1126 * @ATSPI_ROLE_GROUPING: A group of related widgets. This group typically has
1128 * @ATSPI_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multiple
1129 * hotspots, where each hotspot can be activated resulting in the loading of
1130 * another document or section of a document.
1131 * @ATSPI_ROLE_NOTIFICATION: A transitory object designed to present a
1132 * message to the user, typically at the desktop level rather than inside a
1133 * particular application.
1134 * @ATSPI_ROLE_INFO_BAR: An object designed to present a message to the user
1135 * within an existing window.
1136 * @ATSPI_ROLE_LEVEL_BAR: A bar that serves as a level indicator to, for
1137 * instance, show the strength of a password or the state of a battery.
1139 *@ATSPI_ROLE_TITLE_BAR: A bar that serves as the title of a window or a
1140 * dialog. @Since: 2.12
1141 *@ATSPI_ROLE_BLOCK_QUOTE: An object which contains a text section
1142 * that is quoted from another source. @Since: 2.12
1143 *@ATSPI_ROLE_AUDIO: An object which represents an audio
1144 * element. @Since: 2.12
1145 *@ATSPI_ROLE_VIDEO: An object which represents a video
1146 * element. @Since: 2.12
1147 *@ATSPI_ROLE_DEFINITION: A definition of a term or concept. @Since: 2.12
1148 *@ATSPI_ROLE_ARTICLE: A section of a page that consists of a
1149 * composition that forms an independent part of a document, page, or
1150 * site. Examples: A blog entry, a news story, a forum post. @Since:
1152 *@ATSPI_ROLE_LANDMARK: A region of a web page intended as a
1153 * navigational landmark. This is designed to allow Assistive
1154 * Technologies to provide quick navigation among key regions within a
1155 * document. @Since: 2.12
1156 *@ATSPI_ROLE_LOG: A text widget or container holding log content, such
1157 * as chat history and error logs. In this role there is a
1158 * relationship between the arrival of new items in the log and the
1159 * reading order. The log contains a meaningful sequence and new
1160 * information is added only to the end of the log, not at arbitrary
1161 * points. @Since: 2.12
1162 *@ATSPI_ROLE_MARQUEE: A container where non-essential information
1163 * changes frequently. Common usages of marquee include stock tickers
1164 * and ad banners. The primary difference between a marquee and a log
1165 * is that logs usually have a meaningful order or sequence of
1166 * important content changes. @Since: 2.12
1167 *@ATSPI_ROLE_MATH: A text widget or container that holds a mathematical
1168 * expression. @Since: 2.12
1169 *@ATSPI_ROLE_RATING: A widget whose purpose is to display a rating,
1170 * such as the number of stars associated with a song in a media
1171 * player. Objects of this role should also implement
1172 * AtspiValue. @Since: 2.12
1173 *@ATSPI_ROLE_TIMER: An object containing a numerical counter which
1174 * indicates an amount of elapsed time from a start point, or the time
1175 * remaining until an end point. @Since: 2.12
1176 *@ATSPI_ROLE_STATIC: A generic non-container object whose purpose is to display
1177 * a brief amount of information to the user and whose role is known by the
1178 * implementor but lacks semantic value for the user. Examples in which
1179 * @ATSPI_ROLE_STATIC is appropriate include the message displayed in a message
1180 * box and an image used as an alternative means to display text.
1181 * @ATSPI_ROLE_STATIC should not be applied to widgets which are traditionally
1182 * interactive, objects which display a significant amount of content, or any
1183 * object which has an accessible relation pointing to another object. The
1184 * displayed information, as a general rule, should be exposed through the
1185 * accessible name of the object. For labels which describe another widget, see
1186 * @ATSPI_ROLE_LABEL. For text views, see @ATSPI_ROLE_TEXT. For generic
1187 * containers, see @ATSPI_ROLE_PANEL. For objects whose role is not known by the
1188 * implementor, see @ATSPI_ROLE_UNKNOWN. @Since: 2.16.
1189 *@ATSPI_ROLE_MATH_FRACTION: An object that represents a mathematical fraction.
1191 *@ATSPI_ROLE_MATH_ROOT: An object that represents a mathematical expression
1192 * displayed with a radical. @Since: 2.16.
1193 *@ATSPI_ROLE_SUBSCRIPT: An object that contains text that is displayed as a
1194 * subscript. @Since: 2.16.
1195 *@ATSPI_ROLE_SUPERSCRIPT: An object that contains text that is displayed as a
1196 * superscript. @Since: 2.16.
1197 * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of
1200 * Enumeration used by interface #AtspiAccessible to specify the role
1201 * of an #AtspiAccessible object.
1206 ATSPI_ROLE_ACCELERATOR_LABEL,
1208 ATSPI_ROLE_ANIMATION,
1210 ATSPI_ROLE_CALENDAR,
1212 ATSPI_ROLE_CHECK_BOX,
1213 ATSPI_ROLE_CHECK_MENU_ITEM,
1214 ATSPI_ROLE_COLOR_CHOOSER,
1215 ATSPI_ROLE_COLUMN_HEADER,
1216 ATSPI_ROLE_COMBO_BOX,
1217 ATSPI_ROLE_DATE_EDITOR,
1218 ATSPI_ROLE_DESKTOP_ICON,
1219 ATSPI_ROLE_DESKTOP_FRAME,
1222 ATSPI_ROLE_DIRECTORY_PANE,
1223 ATSPI_ROLE_DRAWING_AREA,
1224 ATSPI_ROLE_FILE_CHOOSER,
1226 ATSPI_ROLE_FOCUS_TRAVERSABLE,
1227 ATSPI_ROLE_FONT_CHOOSER,
1229 ATSPI_ROLE_GLASS_PANE,
1230 ATSPI_ROLE_HTML_CONTAINER,
1233 ATSPI_ROLE_INTERNAL_FRAME,
1235 ATSPI_ROLE_LAYERED_PANE,
1237 ATSPI_ROLE_LIST_ITEM,
1239 ATSPI_ROLE_MENU_BAR,
1240 ATSPI_ROLE_MENU_ITEM,
1241 ATSPI_ROLE_OPTION_PANE,
1242 ATSPI_ROLE_PAGE_TAB,
1243 ATSPI_ROLE_PAGE_TAB_LIST,
1245 ATSPI_ROLE_PASSWORD_TEXT,
1246 ATSPI_ROLE_POPUP_MENU,
1247 ATSPI_ROLE_PROGRESS_BAR,
1248 ATSPI_ROLE_PUSH_BUTTON,
1249 ATSPI_ROLE_RADIO_BUTTON,
1250 ATSPI_ROLE_RADIO_MENU_ITEM,
1251 ATSPI_ROLE_ROOT_PANE,
1252 ATSPI_ROLE_ROW_HEADER,
1253 ATSPI_ROLE_SCROLL_BAR,
1254 ATSPI_ROLE_SCROLL_PANE,
1255 ATSPI_ROLE_SEPARATOR,
1257 ATSPI_ROLE_SPIN_BUTTON,
1258 ATSPI_ROLE_SPLIT_PANE,
1259 ATSPI_ROLE_STATUS_BAR,
1261 ATSPI_ROLE_TABLE_CELL,
1262 ATSPI_ROLE_TABLE_COLUMN_HEADER,
1263 ATSPI_ROLE_TABLE_ROW_HEADER,
1264 ATSPI_ROLE_TEAROFF_MENU_ITEM,
1265 ATSPI_ROLE_TERMINAL,
1267 ATSPI_ROLE_TOGGLE_BUTTON,
1268 ATSPI_ROLE_TOOL_BAR,
1269 ATSPI_ROLE_TOOL_TIP,
1271 ATSPI_ROLE_TREE_TABLE,
1273 ATSPI_ROLE_VIEWPORT,
1275 ATSPI_ROLE_EXTENDED,
1278 ATSPI_ROLE_PARAGRAPH,
1280 ATSPI_ROLE_APPLICATION,
1281 ATSPI_ROLE_AUTOCOMPLETE,
1283 ATSPI_ROLE_EMBEDDED,
1287 ATSPI_ROLE_DOCUMENT_FRAME,
1291 ATSPI_ROLE_REDUNDANT_OBJECT,
1294 ATSPI_ROLE_INPUT_METHOD_WINDOW,
1295 ATSPI_ROLE_TABLE_ROW,
1296 ATSPI_ROLE_TREE_ITEM,
1297 ATSPI_ROLE_DOCUMENT_SPREADSHEET,
1298 ATSPI_ROLE_DOCUMENT_PRESENTATION,
1299 ATSPI_ROLE_DOCUMENT_TEXT,
1300 ATSPI_ROLE_DOCUMENT_WEB,
1301 ATSPI_ROLE_DOCUMENT_EMAIL,
1303 ATSPI_ROLE_LIST_BOX,
1304 ATSPI_ROLE_GROUPING,
1305 ATSPI_ROLE_IMAGE_MAP,
1306 ATSPI_ROLE_NOTIFICATION,
1307 ATSPI_ROLE_INFO_BAR,
1308 ATSPI_ROLE_LEVEL_BAR,
1309 ATSPI_ROLE_TITLE_BAR,
1310 ATSPI_ROLE_BLOCK_QUOTE,
1313 ATSPI_ROLE_DEFINITION,
1315 ATSPI_ROLE_LANDMARK,
1322 ATSPI_ROLE_MATH_FRACTION,
1323 ATSPI_ROLE_MATH_ROOT,
1324 ATSPI_ROLE_SUBSCRIPT,
1325 ATSPI_ROLE_SUPERSCRIPT,
1326 ATSPI_ROLE_LAST_DEFINED,
1332 * One higher than the highest valid value of #AtspiRole.
1334 #define ATSPI_ROLE_COUNT (121+1)
1338 ATSPI_CACHE_NONE = 0,
1339 ATSPI_CACHE_PARENT = 1 << 0,
1340 ATSPI_CACHE_CHILDREN = 1 << 1,
1341 ATSPI_CACHE_NAME = 1 << 2,
1342 ATSPI_CACHE_DESCRIPTION = 1 << 3,
1343 ATSPI_CACHE_STATES = 1 << 4,
1344 ATSPI_CACHE_ROLE = 1 << 5,
1345 ATSPI_CACHE_INTERFACES = 1 << 6,
1346 ATSPI_CACHE_ATTRIBUTES = 1 << 7,
1347 ATSPI_CACHE_ALL = 0x3fffffff,
1348 ATSPI_CACHE_DEFAULT = ATSPI_CACHE_PARENT | ATSPI_CACHE_CHILDREN | ATSPI_CACHE_NAME | ATSPI_CACHE_DESCRIPTION | ATSPI_CACHE_STATES | ATSPI_CACHE_ROLE | ATSPI_CACHE_INTERFACES,
1349 ATSPI_CACHE_UNDEFINED = 0x40000000,
1352 #define ATSPI_DBUS_NAME_REGISTRY "org.a11y.atspi.Registry"
1353 #define ATSPI_DBUS_PATH_REGISTRY "/org/a11y/atspi/registry"
1354 #define ATSPI_DBUS_INTERFACE_REGISTRY "org.a11y.atspi.Registry"
1356 #define ATSPI_DBUS_PATH_NULL "/org/a11y/atspi/null"
1357 #define ATSPI_DBUS_PATH_ROOT "/org/a11y/atspi/accessible/root"
1359 #define ATSPI_DBUS_PATH_DEC "/org/a11y/atspi/registry/deviceeventcontroller"
1360 #define ATSPI_DBUS_INTERFACE_DEC "org.a11y.atspi.DeviceEventController"
1361 #define ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER "org.a11y.atspi.DeviceEventListener"
1363 #define ATSPI_DBUS_INTERFACE_CACHE "org.a11y.atspi.Cache"
1364 #define ATSPI_DBUS_INTERFACE_ACCESSIBLE "org.a11y.atspi.Accessible"
1365 #define ATSPI_DBUS_INTERFACE_ACTION "org.a11y.atspi.Action"
1366 #define ATSPI_DBUS_INTERFACE_APPLICATION "org.a11y.atspi.Application"
1367 #define ATSPI_DBUS_INTERFACE_COLLECTION "org.a11y.atspi.Collection"
1368 #define ATSPI_DBUS_INTERFACE_COMPONENT "org.a11y.atspi.Component"
1369 #define ATSPI_DBUS_INTERFACE_DOCUMENT "org.a11y.atspi.Document"
1370 #define ATSPI_DBUS_INTERFACE_EDITABLE_TEXT "org.a11y.atspi.EditableText"
1371 #define ATSPI_DBUS_INTERFACE_EVENT_KEYBOARD "org.a11y.atspi.Event.Keyboard"
1372 #define ATSPI_DBUS_INTERFACE_EVENT_MOUSE "org.a11y.atspi.Event.Mouse"
1373 #define ATSPI_DBUS_INTERFACE_EVENT_OBJECT "org.a11y.atspi.Event.Object"
1374 #define ATSPI_DBUS_INTERFACE_HYPERLINK "org.a11y.atspi.Hyperlink"
1375 #define ATSPI_DBUS_INTERFACE_HYPERTEXT "org.a11y.atspi.Hypertext"
1376 #define ATSPI_DBUS_INTERFACE_IMAGE "org.a11y.atspi.Image"
1377 #define ATSPI_DBUS_INTERFACE_SELECTION "org.a11y.atspi.Selection"
1378 #define ATSPI_DBUS_INTERFACE_TABLE "org.a11y.atspi.Table"
1379 #define ATSPI_DBUS_INTERFACE_TABLE_CELL "org.a11y.atspi.TableCell"
1380 #define ATSPI_DBUS_INTERFACE_TEXT "org.a11y.atspi.Text"
1381 #define ATSPI_DBUS_INTERFACE_VALUE "org.a11y.atspi.Value"
1382 #define ATSPI_DBUS_INTERFACE_SOCKET "org.a11y.atspi.Socket"
1387 #endif /* _ATSPI_CONSTANTS_H_ */