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