1/*
2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4 *
5 * Copyright 2010, 2011 Novell, Inc.
6 * Copyright (c) 2012 SUSE LINUX Products GmbH, Nuernberg, Germany.
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
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 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
22 */
23
24/* TODO: Auto-generate this file again
25
26
27
28 !\mainpage AT-SPI Interfaces and Subinterfaces
29
30 This is the main documentation page for the
31 Assistive Technology Service Provider Interface (AT-SPI).
32
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
45 Accessibility::Text\n
46 Accessibility::EditableText\n
47 Accessibility::Value
48
49 \section types Enumerated Types
50 Accessibility defines a number of key enumerated types, including:\n\n
51 Accessibility::RelationType\n
52 Accessibility::Role\n
53 Accessibility::StateType\n
54 Accessibility::Event\n
55 Accessibility::EventDetails \n
56 Accessibility::ScrollType \n
57 Accessibility::CoordType \n
58
59 \section Registry
60 Accessibility also includes Accessibility::Registry,
61 which is the service used by assistive technologies and related
62 AT-SPI clients to register interest in certain classes of events,
63 enumerate the currently available desktop and application list,
64 and to synthesize certain kinds of device events.
65
66 \section listeners Event Listener Interfaces
67 Accessibility::EventListener\n
68 Accessibility::DeviceEventListener
69
70 \section helpers Helper Interfaces
71
72 The following interfaces may be implemented by assistive technologies
73 themselves, in order to export their services in a consistent manner or
74 in order to interoperate with other applications or desktop services.\n
75
76 Accessibility::LoginHelper : Implemented by adaptive technologies which
77 need to participate in user-authentication or login activities, and which
78 therefore may need negotiation with authentication agents or processes.\n
79
80 Accessibility::Selector [NEW]: Implemented by user agents or assistive
81 technologies which export lists of choices from which the end-user is
82 expected to make selections. Useful for various types of remote
83 activation or intercommunication between multiple ATs.
84
85 */
86
87#ifndef _ATSPI_CONSTANTS_H_
88#define _ATSPI_CONSTANTS_H_
89/**
90 * AtspiConstants:
91 *
92 * Constant definitions needed by multiple interfaces.
93 */
94
95#ifdef __cplusplus
96extern "C"
97{
98#endif
99
100 /**
101 * AtspiLocaleType:
102 * @ATSPI_LOCALE_TYPE_MESSAGES: For localizable natural-language messages.
103 * @ATSPI_LOCALE_TYPE_COLLATE: For regular expression matching and string
104 * collation.
105 * @ATSPI_LOCALE_TYPE_CTYPE: For regular expression matching, character
106 * classification, conversion, case-sensitive comparison, and wide character
107 * functions.
108 * @ATSPI_LOCALE_TYPE_MONETARY: For monetary formatting.
109 * @ATSPI_LOCALE_TYPE_NUMERIC: For number formatting (such as the decimal
110 * point and the thousands separator).
111 * @ATSPI_LOCALE_TYPE_TIME: For time and date formatting.
112 *
113 * Used by interfaces #AtspiText and #AtspiDocument, this
114 * enumeration corresponds to the POSIX 'setlocale' enum values.
115 *
116 **/
117 typedef enum
118 {
119 ATSPI_LOCALE_TYPE_MESSAGES,
120 ATSPI_LOCALE_TYPE_COLLATE,
121 ATSPI_LOCALE_TYPE_CTYPE,
122 ATSPI_LOCALE_TYPE_MONETARY,
123 ATSPI_LOCALE_TYPE_NUMERIC,
124 ATSPI_LOCALE_TYPE_TIME,
125 } AtspiLocaleType;
126
127/**
128 * ATSPI_LOCALE_TYPE_COUNT:
129 *
130 * One higher than the highest valid value of #AtspiLocaleType.
131 **/
132#define ATSPI_LOCALE_TYPE_COUNT (5 + 1)
133
134 /**
135 * AtspiCoordType:
136 * @ATSPI_COORD_TYPE_SCREEN: Specifies xy coordinates relative to the screen.
137 * @ATSPI_COORD_TYPE_WINDOW: Specifies xy coordinates relative to the widget's
138 * top-level window.
139 * @ATSPI_COORD_TYPE_PARENT: Specifies xy coordinates relative to the widget's
140 * immediate parent.
141 *
142 * Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces
143 * to specify whether coordinates are relative to the window or the screen.
144 *
145 **/
146 typedef enum
147 {
148 ATSPI_COORD_TYPE_SCREEN,
149 ATSPI_COORD_TYPE_WINDOW,
150 ATSPI_COORD_TYPE_PARENT,
151 } AtspiCoordType;
152
153/**
154 * ATSPI_COORD_TYPE_COUNT:
155 *
156 * One higher than the highest valid value of #AtspiCoordType.
157 **/
158#define ATSPI_COORD_TYPE_COUNT (2 + 1)
159
160 /**
161 * AtspiCollectionSortOrder:
162 * @ATSPI_Collection_SORT_ORDER_INVALID: Invalid sort order
163 * @ATSPI_Collection_SORT_ORDER_CANONICAL: Canonical sort order
164 * @ATSPI_Collection_SORT_ORDER_FLOW: Flow sort order
165 * @ATSPI_Collection_SORT_ORDER_TAB: Tab sort order
166 * @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL: Reverse canonical sort order
167 * @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW: Reverse flow sort order
168 * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB: Reverse tab sort order
169 * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED: Used only to determine the end of the
170 * enumeration.
171
172 *
173 * Enumeration used by interface #AtspiCollection to specify
174 * the way #AtspiAccesible objects should be sorted.
175 *
176 **/
177 typedef enum
178 {
179 ATSPI_Collection_SORT_ORDER_INVALID,
180 ATSPI_Collection_SORT_ORDER_CANONICAL,
181 ATSPI_Collection_SORT_ORDER_FLOW,
182 ATSPI_Collection_SORT_ORDER_TAB,
183 ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL,
184 ATSPI_Collection_SORT_ORDER_REVERSE_FLOW,
185 ATSPI_Collection_SORT_ORDER_REVERSE_TAB,
186 ATSPI_Collection_SORT_ORDER_LAST_DEFINED,
187 } AtspiCollectionSortOrder;
188
189/**
190 * ATSPI_SORTORDER_COUNT:
191 *
192 * One higher than the highest valid value of #AtspiCollectionSortOrder.
193 */
194#define ATSPI_SORTORDER_COUNT (7 + 1)
195
196 /**
197 * AtspiCollectionMatchType:
198 * @ATSPI_Collection_MATCH_INVALID: Indicates an error condition or
199 * uninitialized value.
200 * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met.
201 * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met.
202 * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met.
203 * @ATSPI_Collection_MATCH_EMPTY: Same as @ATSPI_Collection_MATCH_ALL if
204 * the criteria is non-empty; for empty criteria this rule requires returned
205 * value to also have empty set.
206 * @ATSPI_Collection_MATCH_LAST_DEFINED: Used only to determine the end of the
207 * enumeration.
208 *
209 * Enumeration used by #AtspiMatchRule to specify
210 * how to interpret #AtspiAccessible objects.
211 *
212 **/
213 typedef enum
214 {
215 ATSPI_Collection_MATCH_INVALID,
216 ATSPI_Collection_MATCH_ALL,
217 ATSPI_Collection_MATCH_ANY,
218 ATSPI_Collection_MATCH_NONE,
219 ATSPI_Collection_MATCH_EMPTY,
220 ATSPI_Collection_MATCH_LAST_DEFINED,
221 } AtspiCollectionMatchType;
222
223/**
224 * ATSPI_MATCHTYPE_COUNT:
225 *
226 * One higher than the highest valid value of #AtspiCollectionMatchType.
227 **/
228#define ATSPI_MATCHTYPES_COUNT (5 + 1)
229
230 /**
231 * AtspiCollectionTreeTraversalType:
232 * @ATSPI_Collection_TREE_RESTRICT_CHILDREN: Restrict children tree traveral
233 * @ATSPI_Collection_TREE_RESTRICT_SIBLING: Restrict sibling tree traversal
234 * @ATSPI_Collection_TREE_INORDER: In-order tree traversal.
235 * @ATSPI_Collection_TREE_LAST_DEFINED: Used only to determine the end of the
236 * enumeration.
237 *
238 * Enumeration used by interface #AtspiCollection to specify
239 * restrictions on #AtspiAccesible objects to be traversed.
240 *
241 **/
242 typedef enum
243 {
244 ATSPI_Collection_TREE_RESTRICT_CHILDREN,
245 ATSPI_Collection_TREE_RESTRICT_SIBLING,
246 ATSPI_Collection_TREE_INORDER,
247 ATSPI_Collection_TREE_LAST_DEFINED,
248 } AtspiCollectionTreeTraversalType;
249
250/**
251 * ATSPI_TREETRAVERSALTYPE_COUNT:
252 *
253 * One higher than the highest valid value of
254 * #AtspiCollection_TreeTraversalType.
255 */
256#define ATSPI_TREETRAVERSALTYPE_COUNT (3 + 1)
257
258 /**
259 * AtspiComponentLayer:
260 * @ATSPI_LAYER_INVALID: Indicates an error condition or uninitialized value.
261 * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything else
262 * is painted. The 'desktop background' is generally in this layer.
263 * @ATSPI_LAYER_CANVAS: The 'background' layer for most content renderers and
264 * UI #AtspiComponent containers.
265 * @ATSPI_LAYER_WIDGET: The layer in which the majority of ordinary
266 * 'foreground' widgets reside.
267 * @ATSPI_LAYER_MDI: A special layer between @ATSPI_LAYER_CANVAS and
268 * @ATSPI_LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames)
269 * reside. See #atspi_component_get_mdi_z_order.
270 * @ATSPI_LAYER_POPUP: A layer for popup window content, above
271 * @ATSPI_LAYER_WIDGET.
272 * @ATSPI_LAYER_OVERLAY: The topmost layer.
273 * @ATSPI_LAYER_WINDOW: The layer in which a toplevel window background usually
274 * resides.
275 * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the
276 * enumeration.
277 *
278 * The #AtspiComponentLayer of an #AtspiComponent instance indicates its
279 * relative stacking order with respect to the onscreen visual representation
280 * of the UI. #AtspiComponentLayer, in combination with #AtspiComponent bounds
281 * information, can be used to compute the visibility of all or part of a
282 * component. This is important in programmatic determination of
283 * region-of-interest for magnification, and in
284 * flat screen review models of the screen, as well as
285 * for other uses. Objects residing in two of the #AtspiComponentLayer
286 * categories support further z-ordering information, with respect to their
287 * peers in the same layer: namely, @ATSPI_LAYER_WINDOW and
288 * @ATSPI_LAYER_MDI. Relative stacking order for other objects within the
289 * same layer is not available; the recommended heuristic is
290 * first child paints first. In other words, assume that the
291 * first siblings in the child list are subject to being overpainted by later
292 * siblings if their bounds intersect. The order of layers, from bottom to top,
293 * is: @ATSPI_LAYER_BACKGROUND, @ATSPI_LAYER_WINDOW, @ATSPI_LAYER_MDI,
294 * @ATSPI_LAYER_CANVAS, @ATSPI_LAYER_WIDGET, @ATSPI_LAYER_POPUP, and
295 * @ATSPI_LAYER_OVERLAY.
296 *
297 */
298 typedef enum
299 {
300 ATSPI_LAYER_INVALID,
301 ATSPI_LAYER_BACKGROUND,
302 ATSPI_LAYER_CANVAS,
303 ATSPI_LAYER_WIDGET,
304 ATSPI_LAYER_MDI,
305 ATSPI_LAYER_POPUP,
306 ATSPI_LAYER_OVERLAY,
307 ATSPI_LAYER_WINDOW,
308 ATSPI_LAYER_LAST_DEFINED,
309 } AtspiComponentLayer;
310
311/**
312 * ATSPI_COMPONENTLAYER_COUNT:
313 *
314 * One higher than the highest valid value of #AtspiComponentLayer.
315 **/
316#define ATSPI_COMPONENTLAYER_COUNT (8 + 1)
317
318 /**
319 * AtspiTextBoundaryType:
320 * @ATSPI_TEXT_BOUNDARY_CHAR: An #AtspiText instance is bounded by this
321 * character only. Start and end offsets differ by one, by definition,
322 * for this value.
323 * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word; i.e.
324 * range is from start of one word to the start of another word.
325 * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word; i.e.
326 * range is from the end of one word to the end of another. Some locales
327 * may not distinguish between words and characters or glyphs. In particular,
328 * those locales which use wholly or partially ideographic character sets.
329 * In these cases, characters may be returned in lieu of multi-character
330 * substrings.
331 * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: Boundary condition is start of a
332 * sentence, as determined by the application. Some locales or
333 * character sets may not include explicit sentence delimiters, so this
334 * boundary type can not always be honored. Some locales will return lines
335 * of text instead of grammatical sentences.
336 * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: Boundary condition is end of a sentence,
337 * as determined by the application, including the sentence-delimiting
338 * character, for instance '.' Some locales or character sets may not
339 * include explicit sentence delimiters, so this boundary type can not
340 * always be honored. Some locales will return lines of text instead of
341 * grammatical sentences.
342 * @ATSPI_TEXT_BOUNDARY_LINE_START: Boundary condition is the start of a line;
343 * i.e. range is from start of one line to the start of another. This
344 * generally means that an end-of-line character will appear at the end of
345 * the range.
346 * @ATSPI_TEXT_BOUNDARY_LINE_END: Boundary condition is the end of a line; i.e.
347 * range is from start of one line to the start of another. This generally
348 * means that an end-of-line character will be the first character of the
349 * range.
350 *
351 * Specifies the boundary conditions determining a run of text as returned from
352 * #atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, and
353 * #atspi_text_get_text_before_offset.
354 *
355 * This enumerationis deprecated since 2.9.90 and should not be used. Use
356 * AtspiTextGranularity with #atspi_text_get_string_at_offset instead.
357 **/
358 typedef enum
359 {
360 ATSPI_TEXT_BOUNDARY_CHAR,
361 ATSPI_TEXT_BOUNDARY_WORD_START,
362 ATSPI_TEXT_BOUNDARY_WORD_END,
363 ATSPI_TEXT_BOUNDARY_SENTENCE_START,
364 ATSPI_TEXT_BOUNDARY_SENTENCE_END,
365 ATSPI_TEXT_BOUNDARY_LINE_START,
366 ATSPI_TEXT_BOUNDARY_LINE_END,
367 } AtspiTextBoundaryType;
368
369 /**
370 *AtspiTextGranularity:
371 *@ATSPI_TEXT_GRANULARITY_CHAR: Granularity is defined by the boundaries between characters
372 * (including non-printing characters)
373 *@ATSPI_TEXT_GRANULARITY_WORD: Granularity is defined by the boundaries of a word,
374 * starting at the beginning of the current word and finishing at the beginning of
375 * the following one, if present.
376 *@ATSPI_TEXT_GRANULARITY_SENTENCE: Granularity is defined by the boundaries of a sentence,
377 * starting at the beginning of the current sentence and finishing at the beginning of
378 * the following one, if present.
379 *@ATSPI_TEXT_GRANULARITY_LINE: Granularity is defined by the boundaries of a line,
380 * starting at the beginning of the current line and finishing at the beginning of
381 * the following one, if present.
382 *@ATSPI_TEXT_GRANULARITY_PARAGRAPH: Granularity is defined by the boundaries of a paragraph,
383 * starting at the beginning of the current paragraph and finishing at the beginning of
384 * the following one, if present.
385 *
386 * Text granularity types used for specifying the granularity of the region of
387 * text we are interested in.
388 **/
389 typedef enum
390 {
391 ATSPI_TEXT_GRANULARITY_CHAR,
392 ATSPI_TEXT_GRANULARITY_WORD,
393 ATSPI_TEXT_GRANULARITY_SENTENCE,
394 ATSPI_TEXT_GRANULARITY_LINE,
395 ATSPI_TEXT_GRANULARITY_PARAGRAPH
396 } AtspiTextGranularity;
397
398/**
399 * ATSPI_TEXT_BOUNDARY_TYPE_COUNT:
400 *
401 * One higher than the highest valid value of #AtspiTextBoundaryType.
402 */
403#define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6 + 1)
404
405 /**
406 * AtspiTextClipType:
407 * @ATSPI_TEXT_CLIP_NONE: No characters/glyphs are omitted.
408 * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinate
409 * are omitted.
410 * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum
411 * coordinate are omitted.
412 * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region
413 * bounded by min and max are retained.
414 *
415 * Enumeration used by interface #AtspiText to indicate
416 * how to treat characters intersecting bounding boxes.
417 *
418 **/
419 typedef enum
420 {
421 ATSPI_TEXT_CLIP_NONE,
422 ATSPI_TEXT_CLIP_MIN,
423 ATSPI_TEXT_CLIP_MAX,
424 ATSPI_TEXT_CLIP_BOTH,
425 } AtspiTextClipType;
426
427/**
428 * ATSPI_TEXT_CLIP_TYPE_COUNT:
429 *
430 * One higher than the highest valid value of #AtspiTextClipType.
431 */
432#define ATSPI_TEXT_CLIP_TYPE_COUNT (3 + 1)
433
434 /**
435 * AtspiStateType:
436 * @ATSPI_STATE_INVALID: Indicates an invalid state - probably an error
437 * condition.
438 * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, or
439 * an object is the active subelement within a container or table.
440 * @ATSPI_STATE_ACTIVE should not be used for objects which have
441 * #ATSPI_STATE_FOCUSABLE or #ATSPI_STATE_SELECTABLE: Those objects should use
442 * @ATSPI_STATE_FOCUSED and @ATSPI_STATE_SELECTED respectively.
443 * @ATSPI_STATE_ACTIVE is a means to indicate that an object which is not
444 * focusable and not selectable is the currently-active item within its
445 * parent container.
446 * @ATSPI_STATE_ARMED: Indicates that the object is armed.
447 * @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen
448 * representation is in the process of changing, or the object is
449 * temporarily unavailable for interaction due to activity already in progress.
450 * @ATSPI_STATE_CHECKED: Indicates this object is currently checked.
451 * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed.
452 * @ATSPI_STATE_DEFUNCT: Indicates that this object no longer has a valid
453 * backing widget (for instance, if its peer object has been destroyed).
454 * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of this
455 * object.
456 * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that it
457 * currently reflects some application state. Objects that are "greyed out"
458 * may lack this state, and may lack the @ATSPI_STATE_SENSITIVE if direct
459 * user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED.
460 * See @ATSPI_STATE_SENSITIVE.
461 * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive
462 * disclosure of its children.
463 * @ATSPI_STATE_EXPANDED: Indicates this object is expanded.
464 * @ATSPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus,
465 * which means all events resulting from typing on the keyboard will
466 * normally be passed to it when it has focus.
467 * @ATSPI_STATE_FOCUSED: Indicates this object currently has the keyboard
468 * focus.
469 * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated
470 * tooltip.
471 * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of this object is
472 * horizontal.
473 * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is
474 * represented only by an icon.
475 * @ATSPI_STATE_MODAL: Indicates something must be done with this object
476 * before the user can interact with an object in a different window.
477 * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multiple
478 * lines of text.
479 * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one of
480 * its children to be selected at the same time, or in the case of text
481 * objects, that the object supports non-contiguous text selections.
482 * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its
483 * rectangular region. It also indicates an alpha value of unity, if it
484 * supports alpha blending.
485 * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed.
486 * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not
487 * fixed.
488 * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object
489 * that allows its children to be selected and that this child is one of
490 * those children that can be selected.
491 * @ATSPI_STATE_SELECTED: Indicates this object is the child of an object that
492 * allows its children to be selected and that this child is one of those
493 * children that has been selected.
494 * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user
495 * interaction. @ATSPI_STATE_SENSITIVE usually accompanies.
496 * @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the
497 * absence of @ATSPI_STATE_ENABLED if the current visible state of the control
498 * is "disconnected" from the application state. In such cases, direct user
499 * interaction can often result in the object gaining @ATSPI_STATE_SENSITIVE,
500 * for instance if a user makes an explicit selection using an object whose
501 * current state is ambiguous or undefined. See @ATSPI_STATE_ENABLED,
502 * @ATSPI_STATE_INDETERMINATE.
503 * @ATSPI_STATE_SHOWING: Indicates this object, the object's parent, the
504 * object's parent's parent, and so on, are all 'shown' to the end-user,
505 * i.e. subject to "exposure" if blocking or obscuring objects do not
506 * interpose between this object and the top of the window stack.
507 * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only a
508 * single line of text.
509 * @ATSPI_STATE_STALE: Indicates that the information returned for this object
510 * may no longer be synchronized with the application state. This can occur
511 * if the object has @ATSPI_STATE_TRANSIENT, and can also occur towards the
512 * end of the object peer's lifecycle.
513 * @ATSPI_STATE_TRANSIENT: Indicates this object is transient.
514 * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is vertical;
515 * for example this state may appear on such objects as scrollbars, text
516 * objects (with vertical text flow), separators, etc.
517 * @ATSPI_STATE_VISIBLE: Indicates this object is visible, e.g. has been
518 * explicitly marked for exposure to the user. @ATSPI_STATE_VISIBLE is no
519 * guarantee that the object is actually unobscured on the screen, only that
520 * it is 'potentially' visible, barring obstruction, being scrolled or clipped
521 * out of the field of view, or having an ancestor container that has not yet
522 * made visible. A widget is potentially onscreen if it has both
523 * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING. The absence of
524 * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING is
525 * semantically equivalent to saying that an object is 'hidden'.
526 * @ATSPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed"
527 * event is sent when children become 'active' (i.e. are selected or
528 * navigated to onscreen). Used to prevent need to enumerate all children
529 * in very large containers, like tables. The presence of
530 * @ATSPI_STATE_MANAGES_DESCENDANTS is an indication to the client that the
531 * children should not, and need not, be enumerated by the client.
532 * Objects implementing this state are expected to provide relevant state
533 * notifications to listening clients, for instance notifications of
534 * visibility changes and activation of their contained child objects, without
535 * the client having previously requested references to those children.
536 * @ATSPI_STATE_INDETERMINATE: Indicates that a check box or other boolean
537 * indicator is in a state other than checked or not checked. This
538 * usually means that the boolean value reflected or controlled by the
539 * object does not apply consistently to the entire current context.
540 * For example, a checkbox for the "Bold" attribute of text may have
541 * @ATSPI_STATE_INDETERMINATE if the currently selected text contains a mixture
542 * of weight attributes. In many cases interacting with a
543 * @ATSPI_STATE_INDETERMINATE object will cause the context's corresponding
544 * boolean attribute to be homogenized, whereupon the object will lose
545 * @ATSPI_STATE_INDETERMINATE and a corresponding state-changed event will be
546 * fired.
547 * @ATSPI_STATE_REQUIRED: Indicates that user interaction with this object is
548 * 'required' from the user, for instance before completing the
549 * processing of a form.
550 * @ATSPI_STATE_TRUNCATED: Indicates that an object's onscreen content
551 * is truncated, e.g. a text value in a spreadsheet cell.
552 * @ATSPI_STATE_ANIMATED: Indicates this object's visual representation is
553 * dynamic, not static. This state may be applied to an object during an
554 * animated 'effect' and be removed from the object once its visual
555 * representation becomes static. Some applications, notably content viewers,
556 * may not be able to detect all kinds of animated content. Therefore the
557 * absence of this state should not be taken as
558 * definitive evidence that the object's visual representation is
559 * static; this state is advisory.
560 * @ATSPI_STATE_INVALID_ENTRY: This object has indicated an error condition
561 * due to failure of input validation. For instance, a form control may
562 * acquire this state in response to invalid or malformed user input.
563 * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the object
564 * in question implements some form of typeahead or
565 * pre-selection behavior whereby entering the first character of one or more
566 * sub-elements causes those elements to scroll into view or become
567 * selected. Subsequent character input may narrow the selection further as
568 * long as one or more sub-elements match the string. This state is normally
569 * only useful and encountered on objects that implement #AtspiSelection.
570 * In some cases the typeahead behavior may result in full or partial
571 * completion of the data in the input field, in which case
572 * these input events may trigger text-changed events from the source.
573 * @ATSPI_STATE_SELECTABLE_TEXT: This state indicates that the object in
574 * question supports text selection. It should only be exposed on objects
575 * which implement the #AtspiText interface, in order to distinguish this state
576 * from @ATSPI_STATE_SELECTABLE, which infers that the object in question is a
577 * selectable child of an object which implements #AtspiSelection. While
578 * similar, text selection and subelement selection are distinct operations.
579 * @ATSPI_STATE_IS_DEFAULT: This state indicates that the object in question is
580 * the 'default' interaction object in a dialog, i.e. the one that gets
581 * activated if the user presses "Enter" when the dialog is initially
582 * posted.
583 * @ATSPI_STATE_VISITED: This state indicates that the object (typically a
584 * hyperlink) has already been activated or invoked, with the result that
585 * some backing data has been downloaded or rendered.
586 *@ATSPI_STATE_CHECKABLE: Indicates this object has the potential to
587 * be checked, such as a checkbox or toggle-able table cell. @Since:
588 * 2.12
589 *@ATSPI_STATE_HAS_POPUP: Indicates that the object has a popup
590 * context menu or sub-level menu which may or may not be
591 * showing. This means that activation renders conditional content.
592 * Note that ordinary tooltips are not considered popups in this
593 * context. @Since: 2.12
594 * @ATSPI_STATE_READ_ONLY: Indicates that an object which is ENABLED and
595 * SENSITIVE has a value which can be read, but not modified, by the
596 * user. @Since: 2.16
597 * @ATSPI_STATE_LAST_DEFINED: This value of the enumeration should not be used
598 * as a parameter, it indicates the number of items in the #AtspiStateType
599 * enumeration.
600 *
601 *
602 * Enumeration used by various interfaces indicating every possible state
603 * an #AtspiAccesible object can assume.
604 *
605 **/
606 typedef enum
607 {
608 ATSPI_STATE_INVALID,
609 ATSPI_STATE_ACTIVE,
610 ATSPI_STATE_ARMED,
611 ATSPI_STATE_BUSY,
612 ATSPI_STATE_CHECKED,
613 ATSPI_STATE_COLLAPSED,
614 ATSPI_STATE_DEFUNCT,
615 ATSPI_STATE_EDITABLE,
616 ATSPI_STATE_ENABLED,
617 ATSPI_STATE_EXPANDABLE,
618 ATSPI_STATE_EXPANDED,
619 ATSPI_STATE_FOCUSABLE,
620 ATSPI_STATE_FOCUSED,
621 ATSPI_STATE_HAS_TOOLTIP,
622 ATSPI_STATE_HORIZONTAL,
623 ATSPI_STATE_ICONIFIED,
624 ATSPI_STATE_MODAL,
625 ATSPI_STATE_MULTI_LINE,
626 ATSPI_STATE_MULTISELECTABLE,
627 ATSPI_STATE_OPAQUE,
628 ATSPI_STATE_PRESSED,
629 ATSPI_STATE_RESIZABLE,
630 ATSPI_STATE_SELECTABLE,
631 ATSPI_STATE_SELECTED,
632 ATSPI_STATE_SENSITIVE,
633 ATSPI_STATE_SHOWING,
634 ATSPI_STATE_SINGLE_LINE,
635 ATSPI_STATE_STALE,
636 ATSPI_STATE_TRANSIENT,
637 ATSPI_STATE_VERTICAL,
638 ATSPI_STATE_VISIBLE,
639 ATSPI_STATE_MANAGES_DESCENDANTS,
640 ATSPI_STATE_INDETERMINATE,
641 ATSPI_STATE_REQUIRED,
642 ATSPI_STATE_TRUNCATED,
643 ATSPI_STATE_ANIMATED,
644 ATSPI_STATE_INVALID_ENTRY,
645 ATSPI_STATE_SUPPORTS_AUTOCOMPLETION,
646 ATSPI_STATE_SELECTABLE_TEXT,
647 ATSPI_STATE_IS_DEFAULT,
648 ATSPI_STATE_VISITED,
649 ATSPI_STATE_CHECKABLE,
650 ATSPI_STATE_HAS_POPUP,
651 ATSPI_STATE_READ_ONLY,
652 ATSPI_STATE_LAST_DEFINED,
653 } AtspiStateType;
654
655/**
656 * ATSPI_STATETYPE_COUNT:
657 *
658 * One higher than the highest valid value of #AtspiStateType.
659 **/
660#define ATSPI_STATETYPE_COUNT (41 + 1)
661
662 /**
663 * AtspiKeyEventType:
664 * @ATSPI_KEY_PRESSED: Key press event
665 * @ATSPI_KEY_RELEASED: Key release event
666 *
667 * Deprecated. Should not be used.
668 *
669 **/
670 typedef enum
671 {
672 ATSPI_KEY_PRESSED,
673 ATSPI_KEY_RELEASED,
674 } AtspiKeyEventType;
675
676/**
677 * ATSPI_KEYEVENTTYPE_COUNT:
678 *
679 * One higher than the highest valid value of #AtspiKeyEventType.
680 **/
681#define ATSPI_KEYEVENTTYPE_COUNT (1 + 1)
682
683 /**
684 * AtspiEventType:
685 * @ATSPI_KEY_PRESSED_EVENT: Indicates that a key on a keyboard device was
686 * pressed.
687 * @ATSPI_KEY_RELEASED_EVENT: Indicates that a key on a keyboard device was
688 * released.
689 * @ATSPI_BUTTON_PRESSED_EVENT: Indicates that a button on a non-keyboard
690 * human interface device (HID) was pressed.
691 * @ATSPI_BUTTON_RELEASED_EVENT: Indicates that a button on a non-keyboard
692 * human interface device (HID) was released.
693 *
694 * Enumeration used to specify the event types of interest to an
695 * #AtspiEventListener, or
696 * to identify the type of an event for which notification has been sent.
697 *
698 **/
699 typedef enum
700 {
701 ATSPI_KEY_PRESSED_EVENT,
702 ATSPI_KEY_RELEASED_EVENT,
703 ATSPI_BUTTON_PRESSED_EVENT,
704 ATSPI_BUTTON_RELEASED_EVENT,
705 } AtspiEventType;
706
707/**
708 * ATSPI_EVENTTYPE_COUNT:
709 *
710 * One higher than the highest valid value of #AtspiEventType.
711 */
712#define ATSPI_EVENTTYPE_COUNT (3 + 1)
713
714 /**
715 * AtspiKeySynthType:
716 * @ATSPI_KEY_PRESS: Emulates the pressing of a hardware keyboard key.
717 * @ATSPI_KEY_RELEASE: Emulates the release of a hardware keyboard key.
718 * @ATSPI_KEY_PRESSRELEASE: Emulates the pressing and immediate releasing
719 * of a hardware keyboard key.
720 * @ATSPI_KEY_SYM: A symbolic key event is generated, without specifying a
721 * hardware key. Note: if the keysym is not present in the current keyboard
722 * map, the #AtspiDeviceEventController instance has a limited ability to
723 * generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent
724 * calls using out-of-keymap keysyms will vary from system to system, and on
725 * the number of different out-of-keymap keysyms being generated in quick
726 * succession.
727 * In practice this is rarely significant, since the keysyms of interest to
728 * AT clients and keyboard emulators are usually part of the current keymap,
729 * i.e., present on the system keyboard for the current locale (even if a
730 * physical hardware keyboard is not connected).
731 * @ATSPI_KEY_STRING: A string is converted to its equivalent keyboard events
732 * and emitted. If the string consists of complex characters or composed
733 * characters which are not in the current keymap, string emission is
734 * subject to the out-of-keymap limitations described for
735 * @ATSPI_KEY_SYM. In practice this limitation primarily effects
736 * Chinese and Japanese locales.
737 * @ATSPI_KEY_LOCKMODIFIERS: Emulates locking a set of modifiers.
738 * @ATSPI_KEY_UNLOCKMODIFIERS: Emulates unlocking a set of modifiers.
739 *
740 * Enumeration used when synthesizing keyboard input via
741 * #atspi_generate_keyboard_event.
742 *
743 **/
744 typedef enum
745 {
746 ATSPI_KEY_PRESS,
747 ATSPI_KEY_RELEASE,
748 ATSPI_KEY_PRESSRELEASE,
749 ATSPI_KEY_SYM,
750 ATSPI_KEY_STRING,
751 ATSPI_KEY_LOCKMODIFIERS,
752 ATSPI_KEY_UNLOCKMODIFIERS,
753 } AtspiKeySynthType;
754
755/**
756 * ATSPI_KEYSYNTHTYPE_COUNT:
757 *
758 * One higher than the highest valid value of #AtspiKeySynthType.
759 **/
760#define ATSPI_KEYSYNTHTYPE_COUNT (4 + 1)
761
762 /**
763 * AtspiModifierType:
764 * @ATSPI_MODIFIER_SHIFT: The left or right 'Shift' key.
765 * @ATSPI_MODIFIER_SHIFTLOCK: The ShiftLock or CapsLock key.
766 * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'.
767 * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr).
768 * @ATSPI_MODIFIER_META: Depending on the platform, this may map to 'Window',
769 * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will
770 * map to one of META, META2, META3. On X Windows platforms these META
771 * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an
772 * event having @ATSPI_MODIFIER_META2 means that the 'Mod2Mask' bit
773 * is set in the corresponding XEvent.
774 * @ATSPI_MODIFIER_META2: See @ATSPI_MODIFIER_META.
775 * @ATSPI_MODIFIER_META3: See @ATSPI_MODIFIER_META.
776 * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-SPI
777 * to the appropriate META value, for the convenience of the client.
778 *
779 *
780 *
781 **/
782 typedef enum
783 {
784 ATSPI_MODIFIER_SHIFT,
785 ATSPI_MODIFIER_SHIFTLOCK,
786 ATSPI_MODIFIER_CONTROL,
787 ATSPI_MODIFIER_ALT,
788 ATSPI_MODIFIER_META,
789 ATSPI_MODIFIER_META2,
790 ATSPI_MODIFIER_META3,
791 ATSPI_MODIFIER_NUMLOCK = 14,
792 } AtspiModifierType;
793
794/**
795 * ATSPI_MODIFIERTYPE_COUNT:
796 *
797 * One higher than the highest valid value of #AtspiModifierType.
798 **/
799#define ATSPI_MODIFIERTYPE_COUNT (7 + 1)
800
801 /**
802 * AtspiRelationType:
803 * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not
804 * normally encounter this #AtspiRelationType value.
805 * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objects.
806 * @ATSPI_RELATION_LABELLED_BY: Object is labelled by one or more other
807 * objects.
808 * @ATSPI_RELATION_CONTROLLER_FOR: Object is an interactive object which
809 * modifies the state, onscreen location, or other attributes of one or more
810 * target objects.
811 * @ATSPI_RELATION_CONTROLLED_BY: Object state, position, etc. is
812 * modified/controlled by user interaction with one or more other objects.
813 * For instance a viewport or scroll pane may be @ATSPI_RELATION_CONTROLLED_BY
814 * scrollbars.
815 * @ATSPI_RELATION_MEMBER_OF: Object has a grouping relationship (e.g. 'same
816 * group as') to one or more other objects.
817 * @ATSPI_RELATION_TOOLTIP_FOR: Object is a tooltip associated with another
818 * object.
819 * @ATSPI_RELATION_NODE_CHILD_OF: Object is a child of the target.
820 * @ATSPI_RELATION_NODE_PARENT_OF: Object is a parent of the target.
821 * @ATSPI_RELATION_EXTENDED: Used to indicate that a relationship exists, but
822 * its type is not specified in the enumeration.
823 * @ATSPI_RELATION_FLOWS_TO: Object renders content which flows logically to
824 * another object. For instance, text in a paragraph may flow to another
825 * object which is not the 'next sibling' in the accessibility hierarchy.
826 * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of @ATSPI_RELATION_FLOWS_TO.
827 * @ATSPI_RELATION_SUBWINDOW_OF: Object is visually and semantically considered
828 * a subwindow of another object, even though it is not the object's child.
829 * Useful when dealing with embedded applications and other cases where the
830 * widget hierarchy does not map cleanly to the onscreen presentation.
831 * @ATSPI_RELATION_EMBEDS: Similar to @ATSPI_RELATION_SUBWINDOW_OF, but
832 * specifically used for cross-process embedding.
833 * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of @ATSPI_RELATION_EMBEDS. Used to
834 * denote content rendered by embedded renderers that live in a separate process
835 * space from the embedding context.
836 * @ATSPI_RELATION_POPUP_FOR: Denotes that the object is a transient window or
837 * frame associated with another onscreen object. Similar to @ATSPI_TOOLTIP_FOR,
838 * but more general. Useful for windows which are technically toplevels
839 * but which, for one or more reasons, do not explicitly cause their
840 * associated window to lose 'window focus'. Creation of an @ATSPI_ROLE_WINDOW
841 * object with the @ATSPI_RELATION_POPUP_FOR relation usually requires
842 * some presentation action on the part
843 * of assistive technology clients, even though the previous toplevel
844 * @ATSPI_ROLE_FRAME object may still be the active window.
845 * @ATSPI_RELATION_PARENT_WINDOW_OF: This is the reciprocal relation to
846 * @ATSPI_RELATION_POPUP_FOR.
847 * @ATSPI_RELATION_DESCRIPTION_FOR: Reciprocal of %ATSPI_RELATION_DESCRIBED_BY.
848 * Indicates that this object provides descriptive information about the target
849 * object(s). See also %ATSPI_RELATION_DETAILS_FOR and %ATSPI_RELATION_ERROR_FOR.
850 * @ATSPI_RELATION_DESCRIBED_BY: Reciprocal of %ATSPI_RELATION_DESCRIPTION_FOR.
851 * Indicates that one or more target objects provide descriptive information
852 * about this object. This relation type is most appropriate for information
853 * that is not essential as its presentation may be user-configurable and/or
854 * limited to an on-demand mechanism such as an assistive technology command.
855 * For brief, essential information such as can be found in a widget's on-screen
856 * label, use %ATSPI_RELATION_LABELLED_BY. For an on-screen error message, use
857 * %ATSPI_RELATION_ERROR_MESSAGE. For lengthy extended descriptive information
858 * contained in an on-screen object, consider using %ATSPI_RELATION_DETAILS as
859 * assistive technologies may provide a means for the user to navigate to
860 * objects containing detailed descriptions so that their content can be more
861 * closely reviewed.
862 * @ATSPI_RELATION_DETAILS: Reciprocal of %ATSPI_RELATION_DETAILS_FOR. Indicates
863 * that this object has a detailed or extended description, the contents of
864 * which can be found in the target object(s). This relation type is most
865 * appropriate for information that is sufficiently lengthy as to make
866 * navigation to the container of that information desirable. For less verbose
867 * information suitable for announcement only, see %ATSPI_RELATION_DESCRIBED_BY.
868 * If the detailed information describes an error condition,
869 * %ATSPI_RELATION_ERROR_FOR should be used instead. @Since: 2.26.
870 * @ATSPI_RELATION_DETAILS_FOR: Reciprocal of %ATSPI_RELATION_DETAILS. Indicates
871 * that this object provides a detailed or extended description about the target
872 * object(s). See also %ATSPI_RELATION_DESCRIPTION_FOR and
873 * %ATSPI_RELATION_ERROR_FOR. @Since: 2.26.
874 * @ATSPI_RELATION_ERROR_MESSAGE: Reciprocal of %ATSPI_RELATION_ERROR_FOR.
875 * Indicates that this object has one or more errors, the nature of which is
876 * described in the contents of the target object(s). Objects that have this
877 * relation type should also contain %ATSPI_STATE_INVALID_ENTRY in their
878 * #AtspiStateSet. @Since: 2.26.
879 * @ATSPI_RELATION_ERROR_FOR: Reciprocal of %ATSPI_RELATION_ERROR_MESSAGE.
880 * Indicates that this object contains an error message describing an invalid
881 * condition in the target object(s). @Since: 2.26.
882 * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to
883 * determine the size of the enumeration.
884 *
885 * #AtspiRelationType specifies a relationship between objects
886 * (possibly one-to-many
887 * or many-to-one) outside of the normal parent/child hierarchical
888 * relationship. It allows better semantic identification of how objects
889 * are associated with one another. For instance the
890 * @ATSPI_RELATION_LABELLED_BY
891 * relationship may be used to identify labelling information that should
892 * accompany the accessible name property when presenting an object's content or
893 * identity to the end user. Similarly,
894 * @ATSPI_RELATION_CONTROLLER_FOR can be used
895 * to further specify the context in which a valuator is useful, and/or the
896 * other UI components which are directly effected by user interactions with
897 * the valuator. Common examples include association of scrollbars with the
898 * viewport or panel which they control.
899 *
900 *
901 * Enumeration used to specify
902 * the type of relation encapsulated in an #AtspiRelation object.
903 *
904 **/
905 typedef enum
906 {
907 ATSPI_RELATION_NULL,
908 ATSPI_RELATION_LABEL_FOR,
909 ATSPI_RELATION_LABELLED_BY,
910 ATSPI_RELATION_CONTROLLER_FOR,
911 ATSPI_RELATION_CONTROLLED_BY,
912 ATSPI_RELATION_MEMBER_OF,
913 ATSPI_RELATION_TOOLTIP_FOR,
914 ATSPI_RELATION_NODE_CHILD_OF,
915 ATSPI_RELATION_NODE_PARENT_OF,
916 ATSPI_RELATION_EXTENDED,
917 ATSPI_RELATION_FLOWS_TO,
918 ATSPI_RELATION_FLOWS_FROM,
919 ATSPI_RELATION_SUBWINDOW_OF,
920 ATSPI_RELATION_EMBEDS,
921 ATSPI_RELATION_EMBEDDED_BY,
922 ATSPI_RELATION_POPUP_FOR,
923 ATSPI_RELATION_PARENT_WINDOW_OF,
924 ATSPI_RELATION_DESCRIPTION_FOR,
925 ATSPI_RELATION_DESCRIBED_BY,
926 ATSPI_RELATION_DETAILS,
927 ATSPI_RELATION_DETAILS_FOR,
928 ATSPI_RELATION_ERROR_MESSAGE,
929 ATSPI_RELATION_ERROR_FOR,
930 ATSPI_RELATION_LAST_DEFINED,
931 } AtspiRelationType;
932
933/**
934 * ATSPI_RELATIONTYPE_COUNT:
935 *
936 * One higher than the highest valid value of #AtspiRelationType.
937 **/
938#define ATSPI_RELATIONTYPE_COUNT (23 + 1)
939
940 /**
941 * AtspiRole:
942 * @ATSPI_ROLE_INVALID: A role indicating an error condition, such as
943 * uninitialized Role data.
944 * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard
945 * accelerators for the parent.
946 * @ATSPI_ROLE_ALERT: Object is used to alert the user about something.
947 * @ATSPI_ROLE_ANIMATION: Object contains a dynamic or moving image of some
948 * kind.
949 * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator.
950 * @ATSPI_ROLE_CALENDAR: Object contains one or more dates, usually arranged
951 * into a 2d list.
952 * @ATSPI_ROLE_CANVAS: Object that can be drawn into and is used to trap
953 * events.
954 * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and
955 * provides a separate indicator for the current state.
956 * @ATSPI_ROLE_CHECK_MENU_ITEM: A menu item that behaves like a check box. See
957 * @ATSPI_ROLE_CHECK_BOX.
958 * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a
959 * color.
960 * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data.
961 * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from.
962 * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date.
963 * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_FRAME.
964 * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and
965 * iconified versions of those internal frames.
966 * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotating a
967 * visual element, or which displays a value via such a rotating element.
968 * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border.
969 * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through
970 * and select the contents of a directory.
971 * @ATSPI_ROLE_DRAWING_AREA: An object used for drawing custom user interface
972 * elements.
973 * @ATSPI_ROLE_FILE_CHOOSER: A specialized dialog that displays the files in
974 * the directory and lets the user select a file, browse a different
975 * directory, or specify a filename.
976 * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface.
977 * @ATSPI_ROLE_FOCUS_TRAVERSABLE: Don't use, reserved for future use.
978 * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font.
979 * @ATSPI_ROLE_FRAME: A top level window with a title bar, border, menubar,
980 * etc.
981 * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of
982 * all panes beneath it.
983 * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children
984 * represent the document content.
985 * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate
986 * components.
987 * @ATSPI_ROLE_IMAGE: An image, typically static.
988 * @ATSPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop
989 * pane.
990 * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in an
991 * interface.
992 * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be
993 * drawn in layers, providing a form of stacking order.
994 * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user and
995 * allows the user to select one or more of them.
996 * @ATSPI_ROLE_LIST_ITEM: An object that represents an element of a list.
997 * @ATSPI_ROLE_MENU: An object usually found inside a menu bar that contains a
998 * list of actions the user can choose from.
999 * @ATSPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary
1000 * dialog box of an application that contains a list of menus the user can
1001 * choose from.
1002 * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presents
1003 * an action the user can choose.
1004 * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a
1005 * dialog.
1006 * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list.
1007 * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or
1008 * page tabs), one at a time,through some mechanism provided by the
1009 * object.
1010 * @ATSPI_ROLE_PANEL: A generic container that is often used to group objects.
1011 * @ATSPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places
1012 * where the text content is not shown visibly to the user.
1013 * @ATSPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer the
1014 * user a list of choices, and then hides when the user selects one of those
1015 * choices.
1016 * @ATSPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has
1017 * been completed.
1018 * @ATSPI_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the
1019 * application to do something.
1020 * @ATSPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other
1021 * radio buttons in the same group to become unchecked when this one is
1022 * checked.
1023 * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio button"
1024 * . See @ATSPI_ROLE_RADIO_BUTTON.
1025 * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a
1026 * layered pane as its children.
1027 * @ATSPI_ROLE_ROW_HEADER: The header for a row of data.
1028 * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to
1029 * incrementally view a large amount of data by moving the bounds of a
1030 * viewport along a one-dimensional axis.
1031 * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally view
1032 * a large amount of information. @ATSPI_ROLE_SCROLL_PANE objects are usually
1033 * accompanied by @ATSPI_ROLE_SCROLL_BAR controllers, on which the
1034 * @ATSPI_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY
1035 * reciprocal relations are set. See #atspi_get_relation_set.
1036 * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a
1037 * visible and logical separation of the contents in a menu.
1038 * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a bounded
1039 * range. Unlike @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control
1040 * 'viewport'-like objects.
1041 * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices to
1042 * be selected, and which displays the current choice.
1043 * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels
1044 * at the same time.
1045 * @ATSPI_ROLE_STATUS_BAR: Object displays non-quantitative status information
1046 * (c.f. @ATSPI_ROLE_PROGRESS_BAR)
1047 * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of rows
1048 * and columns.
1049 * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. Note:
1050 * Table cells need not have @ATSPI_ROLE_TABLE_CELL, other
1051 * #AtspiRoleType values are valid as well.
1052 * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular column
1053 * in an #AtspiTable.
1054 * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in a
1055 * #AtspiTable. #AtspiTable rows and columns may also be labelled via the
1056 * @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships.
1057 * See #atspi_get_relation_set.
1058 * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from menubar
1059 * and shown in its own window.
1060 * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal.
1061 * @ATSPI_ROLE_TEXT: An interactive widget that supports multiple lines of text
1062 * and optionally accepts user input, but whose purpose is not to solicit user
1063 * input. Thus @ATSPI_ROLE_TEXT is appropriate for the text view in a plain text
1064 * editor but inappropriate for an input field in a dialog box or web form. For
1065 * widgets whose purpose is to solicit input from the user, see @ATSPI_ROLE_ENTRY
1066 * and @ATSPI_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount
1067 * of textual information, see @ATSPI_ROLE_STATIC.
1068 * @ATSPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or
1069 * unchecked, but does not procide a separate indicator for the current
1070 * state.
1071 * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or
1072 * toggle buttons.
1073 * @ATSPI_ROLE_TOOL_TIP: An object that provides information about another
1074 * object.
1075 * @ATSPI_ROLE_TREE: An object used to repsent hierarchical information to the
1076 * user.
1077 * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and
1078 * hierarchical info to the user.
1079 * @ATSPI_ROLE_UNKNOWN: The object contains some #AtspiAccessible information,
1080 * but its role is not known.
1081 * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to
1082 * otherwise clip a larger object or content renderer to a specific
1083 * onscreen viewport.
1084 * @ATSPI_ROLE_WINDOW: A top level window with no title or border.
1085 * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but not
1086 * included in the core enumeration. Deprecated since 2.24.
1087 * @ATSPI_ROLE_HEADER: An object that serves as a document header.
1088 * @ATSPI_ROLE_FOOTER: An object that serves as a document footer.
1089 * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of
1090 * text content. See also @ATSPI_ROLE_TEXT.
1091 * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc.
1092 * for text objects which it controls (should have
1093 * @ATSPI_RELATION_CONTROLLER_FOR relation to such).
1094 * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessible
1095 * of an application, which may contain @ATSPI_ROLE_FRAME objects or other
1096 * accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally
1097 * @ATSPI_ROLE_APPLICATION objects.
1098 * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items
1099 * for insertion into an entry widget, for instance a list of words for
1100 * completion of a text entry.
1101 * @ATSPI_ROLE_EDITBAR: The object is an editable text object in a toolbar.
1102 * @ATSPI_ROLE_EMBEDDED: The object is an embedded component container. This
1103 * role is a "grouping" hint that the contained objects share a context
1104 * which is different from the container in which this accessible is
1105 * embedded. In particular, it is used for some kinds of document embedding,
1106 * and for embedding of out-of-process component, "panel applets", etc.
1107 * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may be
1108 * entered or modified by the user, provided @ATSPI_STATE_EDITABLE is present.
1109 * A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is
1110 * not present) implies a read-only 'text field' in a form, as opposed to a
1111 * title, label, or caption.
1112 * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative data.
1113 * It may contain multiple subelements whose attributes and/or description
1114 * may be queried to obtain both the quantitative data and information about
1115 * how the data is being presented. The @ATSPI_LABELLED_BY relation is
1116 * particularly important in interpreting objects of this type, as is the
1117 * accessible description property. See @ATSPI_ROLE_CAPTION.
1118 * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usually
1119 * textual, about another user interface element such as a table, chart, or
1120 * image.
1121 * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which
1122 * contains a view of document content. #AtspiDocument frames may occur within
1123 * another #AtspiDocument instance, in which case the second document may be
1124 * said to be embedded in the containing instance. HTML frames are often
1125 * ATSPI_ROLE_DOCUMENT_FRAME: Either this object, or a singleton descendant,
1126 * should implement the #AtspiDocument interface.
1127 * @ATSPI_ROLE_HEADING: The object serves as a heading for content which
1128 * follows it in a document. The 'heading level' of the heading, if
1129 * availabe, may be obtained by querying the object's attributes.
1130 * @ATSPI_ROLE_PAGE: The object is a containing instance which encapsulates a
1131 * page of information. @ATSPI_ROLE_PAGE is used in documents and content which
1132 * support a paginated navigation model.
1133 * @ATSPI_ROLE_SECTION: The object is a containing instance of document content
1134 * which constitutes a particular 'logical' section of the document. The
1135 * type of content within a section, and the nature of the section division
1136 * itself, may be obtained by querying the object's attributes. Sections
1137 * may be nested.
1138 * @ATSPI_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in
1139 * the hierarchy, and is exposed for purely technical reasons. Objects of
1140 * this role should be ignored by clients, if they are encountered at all.
1141 * @ATSPI_ROLE_FORM: The object is a containing instance of document content
1142 * which has within it components with which the user can interact in order
1143 * to input information; i.e. the object is a container for pushbuttons,
1144 * comboboxes, text input fields, and other 'GUI' components. @ATSPI_ROLE_FORM
1145 * should not, in general, be used for toplevel GUI containers or dialogs,
1146 * but should be reserved for 'GUI' containers which occur within document
1147 * content, for instance within Web documents, presentations, or text
1148 * documents. Unlike other GUI containers and dialogs which occur inside
1149 * application instances, @ATSPI_ROLE_FORM containers' components are
1150 * associated with the current document, rather than the current foreground
1151 * application or viewer instance.
1152 * @ATSPI_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a
1153 * hypertext document. Such objects are distinct from 'inline' content
1154 * which may also use the #AtspiHypertext/#AtspiHyperlink interfacesto indicate
1155 * the range/location within a text object where an inline or embedded object
1156 * lies.
1157 * @ATSPI_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
1158 * which is used to allow composition or input of a 'complex character',
1159 * in other words it is an "input method window".
1160 * @ATSPI_ROLE_TABLE_ROW: A row in a table.
1161 * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree.
1162 * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a
1163 * spreadsheet.
1164 * @ATSPI_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a
1165 * presentation or slide content.
1166 * @ATSPI_ROLE_DOCUMENT_TEXT: A document frame which contains textual content,
1167 * such as found in a word processing
1168 * application.
1169 * @ATSPI_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other
1170 * markup suitable for display in a web browser.
1171 * @ATSPI_ROLE_DOCUMENT_EMAIL: A document frame which contains email content
1172 * to be displayed or composed either in plain text or
1173 * HTML.
1174 * @ATSPI_ROLE_COMMENT: An object found within a document and designed to
1175 * present a comment, note, or other annotation. In some cases, this object
1176 * might not be visible until activated.
1177 * @ATSPI_ROLE_LIST_BOX: A non-collapsible list of choices the user can
1178 * select from.
1179 * @ATSPI_ROLE_GROUPING: A group of related widgets. This group typically has
1180 * a label.
1181 * @ATSPI_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multiple
1182 * hotspots, where each hotspot can be activated resulting in the loading of
1183 * another document or section of a document.
1184 * @ATSPI_ROLE_NOTIFICATION: A transitory object designed to present a
1185 * message to the user, typically at the desktop level rather than inside a
1186 * particular application.
1187 * @ATSPI_ROLE_INFO_BAR: An object designed to present a message to the user
1188 * within an existing window.
1189 * @ATSPI_ROLE_LEVEL_BAR: A bar that serves as a level indicator to, for
1190 * instance, show the strength of a password or the state of a battery. @Since: 2.8
1191 * @ATSPI_ROLE_TITLE_BAR: A bar that serves as the title of a window or a
1192 * dialog. @Since: 2.12
1193 * @ATSPI_ROLE_BLOCK_QUOTE: An object which contains a text section
1194 * that is quoted from another source. @Since: 2.12
1195 * @ATSPI_ROLE_AUDIO: An object which represents an audio
1196 * element. @Since: 2.12
1197 * @ATSPI_ROLE_VIDEO: An object which represents a video
1198 * element. @Since: 2.12
1199 * @ATSPI_ROLE_DEFINITION: A definition of a term or concept. @Since: 2.12
1200 * @ATSPI_ROLE_ARTICLE: A section of a page that consists of a
1201 * composition that forms an independent part of a document, page, or
1202 * site. Examples: A blog entry, a news story, a forum post. @Since:
1203 * 2.12
1204 * @ATSPI_ROLE_LANDMARK: A region of a web page intended as a
1205 * navigational landmark. This is designed to allow Assistive
1206 * Technologies to provide quick navigation among key regions within a
1207 * document. @Since: 2.12
1208 * @ATSPI_ROLE_LOG: A text widget or container holding log content, such
1209 * as chat history and error logs. In this role there is a
1210 * relationship between the arrival of new items in the log and the
1211 * reading order. The log contains a meaningful sequence and new
1212 * information is added only to the end of the log, not at arbitrary
1213 * points. @Since: 2.12
1214 * @ATSPI_ROLE_MARQUEE: A container where non-essential information
1215 * changes frequently. Common usages of marquee include stock tickers
1216 * and ad banners. The primary difference between a marquee and a log
1217 * is that logs usually have a meaningful order or sequence of
1218 * important content changes. @Since: 2.12
1219 * @ATSPI_ROLE_MATH: A text widget or container that holds a mathematical
1220 * expression. @Since: 2.12
1221 * @ATSPI_ROLE_RATING: A widget whose purpose is to display a rating,
1222 * such as the number of stars associated with a song in a media
1223 * player. Objects of this role should also implement
1224 * AtspiValue. @Since: 2.12
1225 * @ATSPI_ROLE_TIMER: An object containing a numerical counter which
1226 * indicates an amount of elapsed time from a start point, or the time
1227 * remaining until an end point. @Since: 2.12
1228 * @ATSPI_ROLE_STATIC: A generic non-container object whose purpose is to display
1229 * a brief amount of information to the user and whose role is known by the
1230 * implementor but lacks semantic value for the user. Examples in which
1231 * @ATSPI_ROLE_STATIC is appropriate include the message displayed in a message
1232 * box and an image used as an alternative means to display text.
1233 * @ATSPI_ROLE_STATIC should not be applied to widgets which are traditionally
1234 * interactive, objects which display a significant amount of content, or any
1235 * object which has an accessible relation pointing to another object. The
1236 * displayed information, as a general rule, should be exposed through the
1237 * accessible name of the object. For labels which describe another widget, see
1238 * @ATSPI_ROLE_LABEL. For text views, see @ATSPI_ROLE_TEXT. For generic
1239 * containers, see @ATSPI_ROLE_PANEL. For objects whose role is not known by the
1240 * implementor, see @ATSPI_ROLE_UNKNOWN. @Since: 2.16.
1241 * @ATSPI_ROLE_MATH_FRACTION: An object that represents a mathematical fraction. @Since: 2.16.
1242 * @ATSPI_ROLE_MATH_ROOT: An object that represents a mathematical expression
1243 * displayed with a radical. @Since: 2.16.
1244 * @ATSPI_ROLE_SUBSCRIPT: An object that contains text that is displayed as a
1245 * subscript. @Since: 2.16.
1246 * @ATSPI_ROLE_SUPERSCRIPT: An object that contains text that is displayed as a
1247 * superscript. @Since: 2.16.
1248 * @ATSPI_ROLE_DESCRIPTION_LIST: An object that represents a list of term-value
1249 * groups. A term-value group represents an individual description and consist
1250 * of one or more names (@ATSPI_ROLE_DESCRIPTION_TERM) followed by one or more
1251 * values (@ATSPI_ROLE_DESCRIPTION_VALUE). For each list, there should not be
1252 * more than one group with the same term name. @Since: 2.26.
1253 * @ATSPI_ROLE_DESCRIPTION_TERM: An object that represents a term or phrase
1254 * with a corresponding definition. @Since: 2.26.
1255 * @ATSPI_ROLE_DESCRIPTION_VALUE: An object that represents the description,
1256 * definition, or value of a term. @Since: 2.26.
1257 * @ATSPI_ROLE_FOOTNOTE: An object that contains the text of a footnote. @Since: 2.26.
1258 * @ATSPI_ROLE_CONTENT_DELETION: Content previously deleted or proposed to be
1259 * deleted, e.g. in revision history or a content view providing suggestions
1260 * from reviewers. @Since: 2.34.
1261 * @ATSPI_ROLE_CONTENT_INSERTION: Content previously inserted or proposed to be
1262 * inserted, e.g. in revision history or a content view providing suggestions
1263 * from reviewers. @Since: 2.34.
1264 * @ATSPI_ROLE_MARK: A run of content that is marked or highlighted, such as for
1265 * reference purposes, or to call it out as having a special purpose. If the
1266 * marked content has an associated section in the document elaborating on the
1267 * reason for the mark, then %ATSPI_RELATION_DETAILS should be used on the mark
1268 * to point to that associated section. In addition, the reciprocal relation
1269 * %ATSPI_RELATION_DETAILS_FOR should be used on the associated content section
1270 * to point back to the mark. @Since: 2.36.
1271 * @ATSPI_ROLE_SUGGESTION: A container for content that is called out as a proposed
1272 * change from the current version of the document, such as by a reviewer of the
1273 * content. An object with this role should include children with %ATSPI_ROLE_CONTENT_DELETION and/or
1274 * %ATSPI_ROLE_CONTENT_INSERTION, in any order, to indicate what the
1275 * actual change is. @Since: 2.36
1276 * @ATSPI_ROLE_PUSH_BUTTON_MENU: A specialized push button to open a menu. @Since 2.46
1277 * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of
1278 * enumeration.
1279 *
1280 * Enumeration used by interface #AtspiAccessible to specify the role
1281 * of an #AtspiAccessible object.
1282 *
1283 */
1284 typedef enum
1285 {
1286 ATSPI_ROLE_INVALID,
1287 ATSPI_ROLE_ACCELERATOR_LABEL,
1288 ATSPI_ROLE_ALERT,
1289 ATSPI_ROLE_ANIMATION,
1290 ATSPI_ROLE_ARROW,
1291 ATSPI_ROLE_CALENDAR,
1292 ATSPI_ROLE_CANVAS,
1293 ATSPI_ROLE_CHECK_BOX,
1294 ATSPI_ROLE_CHECK_MENU_ITEM,
1295 ATSPI_ROLE_COLOR_CHOOSER,
1296 ATSPI_ROLE_COLUMN_HEADER,
1297 ATSPI_ROLE_COMBO_BOX,
1298 ATSPI_ROLE_DATE_EDITOR,
1299 ATSPI_ROLE_DESKTOP_ICON,
1300 ATSPI_ROLE_DESKTOP_FRAME,
1301 ATSPI_ROLE_DIAL,
1302 ATSPI_ROLE_DIALOG,
1303 ATSPI_ROLE_DIRECTORY_PANE,
1304 ATSPI_ROLE_DRAWING_AREA,
1305 ATSPI_ROLE_FILE_CHOOSER,
1306 ATSPI_ROLE_FILLER,
1307 ATSPI_ROLE_FOCUS_TRAVERSABLE,
1308 ATSPI_ROLE_FONT_CHOOSER,
1309 ATSPI_ROLE_FRAME,
1310 ATSPI_ROLE_GLASS_PANE,
1311 ATSPI_ROLE_HTML_CONTAINER,
1312 ATSPI_ROLE_ICON,
1313 ATSPI_ROLE_IMAGE,
1314 ATSPI_ROLE_INTERNAL_FRAME,
1315 ATSPI_ROLE_LABEL,
1316 ATSPI_ROLE_LAYERED_PANE,
1317 ATSPI_ROLE_LIST,
1318 ATSPI_ROLE_LIST_ITEM,
1319 ATSPI_ROLE_MENU,
1320 ATSPI_ROLE_MENU_BAR,
1321 ATSPI_ROLE_MENU_ITEM,
1322 ATSPI_ROLE_OPTION_PANE,
1323 ATSPI_ROLE_PAGE_TAB,
1324 ATSPI_ROLE_PAGE_TAB_LIST,
1325 ATSPI_ROLE_PANEL,
1326 ATSPI_ROLE_PASSWORD_TEXT,
1327 ATSPI_ROLE_POPUP_MENU,
1328 ATSPI_ROLE_PROGRESS_BAR,
1329 ATSPI_ROLE_PUSH_BUTTON,
1330 ATSPI_ROLE_RADIO_BUTTON,
1331 ATSPI_ROLE_RADIO_MENU_ITEM,
1332 ATSPI_ROLE_ROOT_PANE,
1333 ATSPI_ROLE_ROW_HEADER,
1334 ATSPI_ROLE_SCROLL_BAR,
1335 ATSPI_ROLE_SCROLL_PANE,
1336 ATSPI_ROLE_SEPARATOR,
1337 ATSPI_ROLE_SLIDER,
1338 ATSPI_ROLE_SPIN_BUTTON,
1339 ATSPI_ROLE_SPLIT_PANE,
1340 ATSPI_ROLE_STATUS_BAR,
1341 ATSPI_ROLE_TABLE,
1342 ATSPI_ROLE_TABLE_CELL,
1343 ATSPI_ROLE_TABLE_COLUMN_HEADER,
1344 ATSPI_ROLE_TABLE_ROW_HEADER,
1345 ATSPI_ROLE_TEAROFF_MENU_ITEM,
1346 ATSPI_ROLE_TERMINAL,
1347 ATSPI_ROLE_TEXT,
1348 ATSPI_ROLE_TOGGLE_BUTTON,
1349 ATSPI_ROLE_TOOL_BAR,
1350 ATSPI_ROLE_TOOL_TIP,
1351 ATSPI_ROLE_TREE,
1352 ATSPI_ROLE_TREE_TABLE,
1353 ATSPI_ROLE_UNKNOWN,
1354 ATSPI_ROLE_VIEWPORT,
1355 ATSPI_ROLE_WINDOW,
1356 ATSPI_ROLE_EXTENDED,
1357 ATSPI_ROLE_HEADER,
1358 ATSPI_ROLE_FOOTER,
1359 ATSPI_ROLE_PARAGRAPH,
1360 ATSPI_ROLE_RULER,
1361 ATSPI_ROLE_APPLICATION,
1362 ATSPI_ROLE_AUTOCOMPLETE,
1363 ATSPI_ROLE_EDITBAR,
1364 ATSPI_ROLE_EMBEDDED,
1365 ATSPI_ROLE_ENTRY,
1366 ATSPI_ROLE_CHART,
1367 ATSPI_ROLE_CAPTION,
1368 ATSPI_ROLE_DOCUMENT_FRAME,
1369 ATSPI_ROLE_HEADING,
1370 ATSPI_ROLE_PAGE,
1371 ATSPI_ROLE_SECTION,
1372 ATSPI_ROLE_REDUNDANT_OBJECT,
1373 ATSPI_ROLE_FORM,
1374 ATSPI_ROLE_LINK,
1375 ATSPI_ROLE_INPUT_METHOD_WINDOW,
1376 ATSPI_ROLE_TABLE_ROW,
1377 ATSPI_ROLE_TREE_ITEM,
1378 ATSPI_ROLE_DOCUMENT_SPREADSHEET,
1379 ATSPI_ROLE_DOCUMENT_PRESENTATION,
1380 ATSPI_ROLE_DOCUMENT_TEXT,
1381 ATSPI_ROLE_DOCUMENT_WEB,
1382 ATSPI_ROLE_DOCUMENT_EMAIL,
1383 ATSPI_ROLE_COMMENT,
1384 ATSPI_ROLE_LIST_BOX,
1385 ATSPI_ROLE_GROUPING,
1386 ATSPI_ROLE_IMAGE_MAP,
1387 ATSPI_ROLE_NOTIFICATION,
1388 ATSPI_ROLE_INFO_BAR,
1389 ATSPI_ROLE_LEVEL_BAR,
1390 ATSPI_ROLE_TITLE_BAR,
1391 ATSPI_ROLE_BLOCK_QUOTE,
1392 ATSPI_ROLE_AUDIO,
1393 ATSPI_ROLE_VIDEO,
1394 ATSPI_ROLE_DEFINITION,
1395 ATSPI_ROLE_ARTICLE,
1396 ATSPI_ROLE_LANDMARK,
1397 ATSPI_ROLE_LOG,
1398 ATSPI_ROLE_MARQUEE,
1399 ATSPI_ROLE_MATH,
1400 ATSPI_ROLE_RATING,
1401 ATSPI_ROLE_TIMER,
1402 ATSPI_ROLE_STATIC,
1403 ATSPI_ROLE_MATH_FRACTION,
1404 ATSPI_ROLE_MATH_ROOT,
1405 ATSPI_ROLE_SUBSCRIPT,
1406 ATSPI_ROLE_SUPERSCRIPT,
1407 ATSPI_ROLE_DESCRIPTION_LIST,
1408 ATSPI_ROLE_DESCRIPTION_TERM,
1409 ATSPI_ROLE_DESCRIPTION_VALUE,
1410 ATSPI_ROLE_FOOTNOTE,
1411 ATSPI_ROLE_CONTENT_DELETION,
1412 ATSPI_ROLE_CONTENT_INSERTION,
1413 ATSPI_ROLE_MARK,
1414 ATSPI_ROLE_SUGGESTION,
1415 ATSPI_ROLE_PUSH_BUTTON_MENU,
1416 ATSPI_ROLE_LAST_DEFINED,
1417 } AtspiRole;
1418
1419/**
1420 * ATSPI_ROLE_COUNT:
1421 *
1422 * One higher than the highest valid value of #AtspiRole.
1423 */
1424#define ATSPI_ROLE_COUNT (130 + 1)
1425
1426 typedef enum
1427 {
1428 ATSPI_CACHE_NONE = 0,
1429 ATSPI_CACHE_PARENT = 1 << 0,
1430 ATSPI_CACHE_CHILDREN = 1 << 1,
1431 ATSPI_CACHE_NAME = 1 << 2,
1432 ATSPI_CACHE_DESCRIPTION = 1 << 3,
1433 ATSPI_CACHE_STATES = 1 << 4,
1434 ATSPI_CACHE_ROLE = 1 << 5,
1435 ATSPI_CACHE_INTERFACES = 1 << 6,
1436 ATSPI_CACHE_ATTRIBUTES = 1 << 7,
1437 ATSPI_CACHE_ALL = 0x3fffffff,
1438 ATSPI_CACHE_DEFAULT = ATSPI_CACHE_PARENT | ATSPI_CACHE_CHILDREN | ATSPI_CACHE_NAME | ATSPI_CACHE_DESCRIPTION | ATSPI_CACHE_STATES | ATSPI_CACHE_ROLE | ATSPI_CACHE_INTERFACES,
1439 ATSPI_CACHE_UNDEFINED = 0x40000000,
1440 } AtspiCache;
1441
1442 /**
1443 * AtspiScrollType:
1444 * @ATSPI_SCROLL_TOP_LEFT: Scroll the object to the top left corner of the
1445 * window.
1446 * @ATSPI_SCROLL_BOTTOM_RIGHT: Scroll the object to the bottom right corner of
1447 * the window.
1448 * @ATSPI_SCROLL_TOP_EDGE: Scroll the object to the top edge of the window.
1449 * @ATSPI_SCROLL_BOTTOM_EDGE: Scroll the object to the bottom edge of the
1450 * window.
1451 * @ATSPI_SCROLL_LEFT_EDGE: Scroll the object to the left edge of the
1452 * window.
1453 * @ATSPI_SCROLL_RIGHT_EDGE: Scroll the object to the right edge of the
1454 * window.
1455 * @ATSPI_SCROLL_ANYWHERE: Scroll the object to application-dependent position
1456 * on the window.
1457 *
1458 * Enumeration used by interface #AtspiAccessible to specify where an
1459 * #AtspiAccessible object should be placed on the screen when using scroll_to.
1460 *
1461 */
1462 typedef enum
1463 {
1464 ATSPI_SCROLL_TOP_LEFT,
1465 ATSPI_SCROLL_BOTTOM_RIGHT,
1466 ATSPI_SCROLL_TOP_EDGE,
1467 ATSPI_SCROLL_BOTTOM_EDGE,
1468 ATSPI_SCROLL_LEFT_EDGE,
1469 ATSPI_SCROLL_RIGHT_EDGE,
1470 ATSPI_SCROLL_ANYWHERE
1471 } AtspiScrollType;
1472
1473/**
1474 * ATSPI_SCROLLTYPE_COUNT:
1475 *
1476 * One higher than the highest valid value of #AtspiScrollType.
1477 */
1478#define ATSPI_SCROLLTYPE_COUNT (6 + 1)
1479
1480 /**
1481 * AtspiLive:
1482 * @ATSPI_LIVE_NONE: No live region.
1483 * @ATSPI_LIVE_POLITE: This live region should be considered polite.
1484 * @ATSPI_LIVE_ASSERTIVE: This live region should be considered assertive.
1485 *
1486 * Enumeration used to indicate a type of live region and how assertive it
1487 * should be in terms of speaking notifications. Currently, this is only used
1488 * for "announcement" events, but it may be used for additional purposes
1489 * in the future.
1490 */
1491 typedef enum
1492 {
1493 ATSPI_LIVE_NONE,
1494 ATSPI_LIVE_POLITE,
1495 ATSPI_LIVE_ASSERTIVE
1496 } AtspiLive;
1497
1498#define ATSPI_DBUS_NAME_REGISTRY "org.a11y.atspi.Registry"
1499#define ATSPI_DBUS_PATH_REGISTRY "/org/a11y/atspi/registry"
1500#define ATSPI_DBUS_INTERFACE_REGISTRY "org.a11y.atspi.Registry"
1501
1502#define ATSPI_DBUS_PATH_NULL "/org/a11y/atspi/null"
1503#define ATSPI_DBUS_PATH_ROOT "/org/a11y/atspi/accessible/root"
1504
1505#define ATSPI_DBUS_PATH_DEC "/org/a11y/atspi/registry/deviceeventcontroller"
1506#define ATSPI_DBUS_INTERFACE_DEC "org.a11y.atspi.DeviceEventController"
1507#define ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER "org.a11y.atspi.DeviceEventListener"
1508
1509#define ATSPI_DBUS_INTERFACE_CACHE "org.a11y.atspi.Cache"
1510#define ATSPI_DBUS_INTERFACE_ACCESSIBLE "org.a11y.atspi.Accessible"
1511#define ATSPI_DBUS_INTERFACE_ACTION "org.a11y.atspi.Action"
1512#define ATSPI_DBUS_INTERFACE_APPLICATION "org.a11y.atspi.Application"
1513#define ATSPI_DBUS_INTERFACE_COLLECTION "org.a11y.atspi.Collection"
1514#define ATSPI_DBUS_INTERFACE_COMPONENT "org.a11y.atspi.Component"
1515#define ATSPI_DBUS_INTERFACE_DOCUMENT "org.a11y.atspi.Document"
1516#define ATSPI_DBUS_INTERFACE_EDITABLE_TEXT "org.a11y.atspi.EditableText"
1517#define ATSPI_DBUS_INTERFACE_EVENT_KEYBOARD "org.a11y.atspi.Event.Keyboard"
1518#define ATSPI_DBUS_INTERFACE_EVENT_MOUSE "org.a11y.atspi.Event.Mouse"
1519#define ATSPI_DBUS_INTERFACE_EVENT_OBJECT "org.a11y.atspi.Event.Object"
1520#define ATSPI_DBUS_INTERFACE_HYPERLINK "org.a11y.atspi.Hyperlink"
1521#define ATSPI_DBUS_INTERFACE_HYPERTEXT "org.a11y.atspi.Hypertext"
1522#define ATSPI_DBUS_INTERFACE_IMAGE "org.a11y.atspi.Image"
1523#define ATSPI_DBUS_INTERFACE_SELECTION "org.a11y.atspi.Selection"
1524#define ATSPI_DBUS_INTERFACE_TABLE "org.a11y.atspi.Table"
1525#define ATSPI_DBUS_INTERFACE_TABLE_CELL "org.a11y.atspi.TableCell"
1526#define ATSPI_DBUS_INTERFACE_TEXT "org.a11y.atspi.Text"
1527#define ATSPI_DBUS_INTERFACE_VALUE "org.a11y.atspi.Value"
1528#define ATSPI_DBUS_INTERFACE_SOCKET "org.a11y.atspi.Socket"
1529
1530#define ATSPI_DBUS_PATH_SCREEN_READER "/org/a11y/atspi/screenreader"
1531#define ATSPI_DBUS_INTERFACE_EVENT_SCREEN_READER "org.a11y.atspi.Event.ScreenReader"
1532
1533#ifdef __cplusplus
1534}
1535#endif
1536#endif /* _ATSPI_CONSTANTS_H_ */
1537

source code of include/at-spi-2.0/atspi/atspi-constants.h