Qt Accessibility Client

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

KDE's Doxygen guidelines are available online.