1 /* Generated from , version 1.24.0
5 !\mainpage AT-SPI Interfaces and Subinterfaces
7 This is the main documentation page for the
8 Assistive Technology Service Provider Interface (AT-SPI).
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::StreamableContent\n
22 Accessibility::Table\n
24 Accessibility::EditableText\n
27 \section types Enumerated Types
28 Accessibility defines a number of key enumerated types, including:\n\n
29 Accessibility::RelationType\n
31 Accessibility::StateType\n
32 Accessibility::Event\n
33 Accessibility::EventDetails \n
36 Accessibility also includes Accessibility::Registry,
37 which is the service used by assistive technologies and related
38 AT-SPI clients to register interest in certain classes of events,
39 enumerate the currently available desktop and application list,
40 and to synthesize certain kinds of device events.
42 \section listeners Event Listener Interfaces
43 Accessibility::EventListener\n
44 Accessibility::DeviceEventListener
46 \section helpers Helper Interfaces
48 The following interfaces may be implemented by assistive technologies
49 themselves, in order to export their services in a consistent manner or
50 in order to interoperate with other applications or desktop services.\n
52 Accessibility::LoginHelper : Implemented by adaptive technologies which
53 need to participate in user-authentication or login activities, and which
54 therefore may need negotiation with authentication agents or processes.\n
56 Accessibility::Selector [NEW]: Implemented by user agents or assistive
57 technologies which export lists of choices from which the end-user is
58 expected to make selections. Useful for various types of remote
59 activation or intercommunication between multiple ATs.
63 #ifndef _ACCESSIBILITY_H_
64 #define _ACCESSIBILITY_H_
71 Accessibility_LOCALE_TYPE:
72 * @Accessibility_LOCALE_TYPE_MESSAGES: <![CDATA[]]>
73 * @Accessibility_LOCALE_TYPE_COLLATE: <![CDATA[]]>
74 * @Accessibility_LOCALE_TYPE_CTYPE: <![CDATA[]]>
75 * @Accessibility_LOCALE_TYPE_MONETARY: <![CDATA[]]>
76 * @Accessibility_LOCALE_TYPE_NUMERIC: <![CDATA[]]>
77 * @Accessibility_LOCALE_TYPE_TIME: <![CDATA[]]>
79 * <![CDATA[ Used by Text and Document interfaces these correspond to the POSIX 'setlocale' enum values. ]]>
81 * Bitfield/set of flags generated from the AT-SPI specification.
84 Accessibility_LOCALE_TYPE_MESSAGES,
85 Accessibility_LOCALE_TYPE_COLLATE,
86 Accessibility_LOCALE_TYPE_CTYPE,
87 Accessibility_LOCALE_TYPE_MONETARY,
88 Accessibility_LOCALE_TYPE_NUMERIC,
89 Accessibility_LOCALE_TYPE_TIME,
90 } Accessibility_LOCALE_TYPE;
93 * NUM_ACCESSIBILITY_LOCALE_TYPES:
95 * 1 higher than the highest valid value of #Accessibility_LOCALE_TYPE.
97 #define NUM_ACCESSIBILITY_LOCALE_TYPES (5+1)
101 Accessibility_Collection_SortOrder:
102 * @Accessibility_Collection_SORT_ORDER_INVALID: <![CDATA[]]>
103 * @Accessibility_Collection_SORT_ORDER_CANONICAL: <![CDATA[]]>
104 * @Accessibility_Collection_SORT_ORDER_FLOW: <![CDATA[]]>
105 * @Accessibility_Collection_SORT_ORDER_TAB: <![CDATA[]]>
106 * @Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL: <![CDATA[]]>
107 * @Accessibility_Collection_SORT_ORDER_REVERSE_FLOW: <![CDATA[]]>
108 * @Accessibility_Collection_SORT_ORDER_REVERSE_TAB: <![CDATA[]]>
109 * @Accessibility_Collection_SORT_ORDER_LAST_DEFINED: <![CDATA[]]>
111 * Bitfield/set of flags generated from the AT-SPI specification.
114 Accessibility_Collection_SORT_ORDER_INVALID,
115 Accessibility_Collection_SORT_ORDER_CANONICAL,
116 Accessibility_Collection_SORT_ORDER_FLOW,
117 Accessibility_Collection_SORT_ORDER_TAB,
118 Accessibility_Collection_SORT_ORDER_REVERSE_CANONICAL,
119 Accessibility_Collection_SORT_ORDER_REVERSE_FLOW,
120 Accessibility_Collection_SORT_ORDER_REVERSE_TAB,
121 Accessibility_Collection_SORT_ORDER_LAST_DEFINED,
122 } Accessibility_Collection_SortOrder;
125 * NUM_ACCESSIBILITY_SORTORDERS:
127 * 1 higher than the highest valid value of #Accessibility_Collection_SortOrder.
129 #define NUM_ACCESSIBILITY_SORTORDERS (7+1)
133 Accessibility_Collection_MatchType:
134 * @Accessibility_Collection_MATCH_INVALID: <![CDATA[]]>
135 * @Accessibility_Collection_MATCH_ALL: <![CDATA[]]>
136 * @Accessibility_Collection_MATCH_ANY: <![CDATA[]]>
137 * @Accessibility_Collection_MATCH_NONE: <![CDATA[]]>
138 * @Accessibility_Collection_MATCH_EMPTY: <![CDATA[]]>
139 * @Accessibility_Collection_MATCH_LAST_DEFINED: <![CDATA[]]>
141 * Bitfield/set of flags generated from the AT-SPI specification.
144 Accessibility_Collection_MATCH_INVALID,
145 Accessibility_Collection_MATCH_ALL,
146 Accessibility_Collection_MATCH_ANY,
147 Accessibility_Collection_MATCH_NONE,
148 Accessibility_Collection_MATCH_EMPTY,
149 Accessibility_Collection_MATCH_LAST_DEFINED,
150 } Accessibility_Collection_MatchType;
153 * NUM_ACCESSIBILITY_MATCHTYPES:
155 * 1 higher than the highest valid value of #Accessibility_Collection_MatchType.
157 #define NUM_ACCESSIBILITY_MATCHTYPES (5+1)
161 Accessibility_Collection_TreeTraversalType:
162 * @Accessibility_Collection_TREE_RESTRICT_CHILDREN: <![CDATA[]]>
163 * @Accessibility_Collection_TREE_RESTRICT_SIBLING: <![CDATA[]]>
164 * @Accessibility_Collection_TREE_INORDER: <![CDATA[]]>
165 * @Accessibility_Collection_TREE_LAST_DEFINED: <![CDATA[]]>
167 * Bitfield/set of flags generated from the AT-SPI specification.
170 Accessibility_Collection_TREE_RESTRICT_CHILDREN,
171 Accessibility_Collection_TREE_RESTRICT_SIBLING,
172 Accessibility_Collection_TREE_INORDER,
173 Accessibility_Collection_TREE_LAST_DEFINED,
174 } Accessibility_Collection_TreeTraversalType;
177 * NUM_ACCESSIBILITY_TREETRAVERSALTYPES:
179 * 1 higher than the highest valid value of #Accessibility_Collection_TreeTraversalType.
181 #define NUM_ACCESSIBILITY_TREETRAVERSALTYPES (3+1)
185 Accessibility_ComponentLayer:
186 * @Accessibility_LAYER_INVALID: <![CDATA[ Indicates an error condition or uninitialized value. ]]>
187 * @Accessibility_LAYER_BACKGROUND: <![CDATA[ The bottom-most layer, over which everything else is painted. The 'desktop background' is generally in this layer. ]]>
188 * @Accessibility_LAYER_CANVAS: <![CDATA[ The 'background' layer for most content renderers and UI Component containers. ]]>
189 * @Accessibility_LAYER_WIDGET: <![CDATA[ The layer in which the majority of ordinary 'foreground' widgets reside. ]]>
190 * @Accessibility_LAYER_MDI: <![CDATA[ A special layer between LAYER_CANVAS and LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames) reside. (See Component.getMDIZOrder) ]]>
191 * @Accessibility_LAYER_POPUP: <![CDATA[ A layer for popup window content, above LAYER_WIDGET. ]]>
192 * @Accessibility_LAYER_OVERLAY: <![CDATA[ The topmost layer. ]]>
193 * @Accessibility_LAYER_WINDOW: <![CDATA[ The layer in which a toplevel window background usually resides. ]]>
194 * @Accessibility_LAYER_LAST_DEFINED: <![CDATA[ Used only to determine the end of the enumeration. ]]>
196 * <![CDATA[ The ComponentLayer of a Component instance indicates its relative stacking order with respect to the onscreen visual representation of the UI. ComponentLayer, in combination with Component bounds information, can be used to compute the visibility of all or part of a component. This is important in programmatic determination of region-of-interest for magnification, and in ¨flat screen review¨ models of the screen, as well as for other uses. Objects residing in two of the ComponentLayer categories support further z-ordering information, with respect to their peers in the same layer: namely, LAYER_WINDOW and LAYER_MDI. Relative stacking order for other objects within the same layer is not available; the recommended heuristic is ¨first child paints first¨, in other words, assume that the first siblings in the child list are subject to being overpainted by later siblings if their bounds intersect. The order of layers, from bottom to top, is: LAYER_BACKGROUND LAYER_WINDOW LAYER_MDI LAYER_CANVAS LAYER_WIDGET LAYER_POPUP LAYER_OVERLAY ]]>
198 * Bitfield/set of flags generated from the AT-SPI specification.
201 Accessibility_LAYER_INVALID,
202 Accessibility_LAYER_BACKGROUND,
203 Accessibility_LAYER_CANVAS,
204 Accessibility_LAYER_WIDGET,
205 Accessibility_LAYER_MDI,
206 Accessibility_LAYER_POPUP,
207 Accessibility_LAYER_OVERLAY,
208 Accessibility_LAYER_WINDOW,
209 Accessibility_LAYER_LAST_DEFINED,
210 } Accessibility_ComponentLayer;
213 * NUM_ACCESSIBILITY_COMPONENTLAYERS:
215 * 1 higher than the highest valid value of #Accessibility_ComponentLayer.
217 #define NUM_ACCESSIBILITY_COMPONENTLAYERS (8+1)
221 Accessibility_SeekType:
222 * @Accessibility_SEEK_SET: <![CDATA[ Seek from the start of the stream or data source. ]]>
223 * @Accessibility_SEEK_CURRENT: <![CDATA[ Seek relative to the current position. ]]>
224 * @Accessibility_SEEK_END: <![CDATA[ Seek from the end of the file, stream, or data source. ]]>
226 * <![CDATA[ Specifies the meaning of a seek 'offset'. Not all SeekTypes are supported by all StreamableContent data sources, for instance some streams may not support seeking from the beginning or other types of 'backwards' seeks. ]]>
228 * Bitfield/set of flags generated from the AT-SPI specification.
231 Accessibility_SEEK_SET,
232 Accessibility_SEEK_CURRENT,
233 Accessibility_SEEK_END,
234 } Accessibility_SeekType;
237 * NUM_ACCESSIBILITY_SEEKTYPES:
239 * 1 higher than the highest valid value of #Accessibility_SeekType.
241 #define NUM_ACCESSIBILITY_SEEKTYPES (2+1)
245 Accessibility_TEXT_BOUNDARY_TYPE:
246 * @Accessibility_TEXT_BOUNDARY_CHAR: <![CDATA[ Text is bounded by this character only. Start and end offsets differ by one, by definition, for this value. ]]>
247 * @Accessibility_TEXT_BOUNDARY_WORD_START: <![CDATA[ Boundary condition is start of a word; i.e. range is from start of one word to the start of another word. ]]>
248 * @Accessibility_TEXT_BOUNDARY_WORD_END: <![CDATA[ Boundary condition is the end of a word; i.e. range is from the end of one word to the end of another. Some locales may not distinguish between words and characters or glyphs, in particular those locales which use wholly or partially ideographic character sets. In these cases, characters may be returned in lieu of multi-character substrings. ]]>
249 * @Accessibility_TEXT_BOUNDARY_SENTENCE_START: <![CDATA[ Boundary condition is start of a sentence, as determined by the application. Some locales or character sets may not include explicit sentence delimiters, so this boundary type can not always be honored. Some locales will return lines of text instead of grammatical sentences. ]]>
250 * @Accessibility_TEXT_BOUNDARY_SENTENCE_END: <![CDATA[ Boundary condition is end of a sentence, as determined by the application, including the sentence-delimiting character, for instance '.' Some locales or character sets may not include explicit sentence delimiters, so this boundary type can not always be honored. Some locales will return lines of text instead of grammatical sentences. ]]>
251 * @Accessibility_TEXT_BOUNDARY_LINE_START: <![CDATA[ Boundary condition is the start of a line; i.e. range is from start of one line to the start of another. This generally means that an end-of-line character will appear at the end of the range. ]]>
252 * @Accessibility_TEXT_BOUNDARY_LINE_END: <![CDATA[ Boundary condition is the end of a line; i.e. range is from start of one line to the start of another. This generally means that an end-of-line character will be the first character of the range. ]]>
254 * <![CDATA[ Specifies the boundary conditions determining a run of text as returned from getTextAtOffset, getTextAfterOffset, and getTextBeforeOffset. ]]>
256 * Bitfield/set of flags generated from the AT-SPI specification.
259 Accessibility_TEXT_BOUNDARY_CHAR,
260 Accessibility_TEXT_BOUNDARY_WORD_START,
261 Accessibility_TEXT_BOUNDARY_WORD_END,
262 Accessibility_TEXT_BOUNDARY_SENTENCE_START,
263 Accessibility_TEXT_BOUNDARY_SENTENCE_END,
264 Accessibility_TEXT_BOUNDARY_LINE_START,
265 Accessibility_TEXT_BOUNDARY_LINE_END,
266 } Accessibility_TEXT_BOUNDARY_TYPE;
269 * NUM_ACCESSIBILITY_TEXT_BOUNDARY_TYPES:
271 * 1 higher than the highest valid value of #Accessibility_TEXT_BOUNDARY_TYPE.
273 #define NUM_ACCESSIBILITY_TEXT_BOUNDARY_TYPES (6+1)
277 Accessibility_TEXT_CLIP_TYPE:
278 * @Accessibility_TEXT_CLIP_NONE: <![CDATA[]]>
279 * @Accessibility_TEXT_CLIP_MIN: <![CDATA[ Characters/glyphs clipped by the minimum coordinate are omitted ]]>
280 * @Accessibility_TEXT_CLIP_MAX: <![CDATA[ Characters/glyphs which intersect the maximum coordinate are omitted ]]>
281 * @Accessibility_TEXT_CLIP_BOTH: <![CDATA[ Only glyphs falling entirely within the region bounded by min and max are retained. ]]>
283 * <![CDATA[ TEXT_CLIP_TYPE: CLIP_MIN means text clipped by min coordinate is omitted, CLIP_MAX clips text interescted by the max coord, and CLIP_BOTH will retain only text falling fully within the min/max bounds. ]]>
285 * Bitfield/set of flags generated from the AT-SPI specification.
288 Accessibility_TEXT_CLIP_NONE,
289 Accessibility_TEXT_CLIP_MIN,
290 Accessibility_TEXT_CLIP_MAX,
291 Accessibility_TEXT_CLIP_BOTH,
292 } Accessibility_TEXT_CLIP_TYPE;
295 * NUM_ACCESSIBILITY_TEXT_CLIP_TYPES:
297 * 1 higher than the highest valid value of #Accessibility_TEXT_CLIP_TYPE.
299 #define NUM_ACCESSIBILITY_TEXT_CLIP_TYPES (3+1)
303 Accessibility_StateType:
304 * @Accessibility_STATE_INVALID: <![CDATA[]]>
305 * @Accessibility_STATE_ACTIVE: <![CDATA[ Indicates a window is currently the active window, or is an active subelement within a container or table ]]>
306 * @Accessibility_STATE_ARMED: <![CDATA[ Indicates that the object is armed ]]>
307 * @Accessibility_STATE_BUSY: <![CDATA[ Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. ]]>
308 * @Accessibility_STATE_CHECKED: <![CDATA[ Indicates this object is currently checked ]]>
309 * @Accessibility_STATE_COLLAPSED: <![CDATA[ Indicates this object is collapsed ]]>
310 * @Accessibility_STATE_DEFUNCT: <![CDATA[ Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed) ]]>
311 * @Accessibility_STATE_EDITABLE: <![CDATA[ Indicates the user can change the contents of this object ]]>
312 * @Accessibility_STATE_ENABLED: <![CDATA[ Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. @see STATE_SENSITIVE. ]]>
313 * @Accessibility_STATE_EXPANDABLE: <![CDATA[ Indicates this object allows progressive disclosure of its children ]]>
314 * @Accessibility_STATE_EXPANDED: <![CDATA[ Indicates this object its expanded ]]>
315 * @Accessibility_STATE_FOCUSABLE: <![CDATA[ Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus ]]>
316 * @Accessibility_STATE_FOCUSED: <![CDATA[ Indicates this object currently has the keyboard focus ]]>
317 * @Accessibility_STATE_HAS_TOOLTIP: <![CDATA[ Indicates that the object has an associated tooltip ]]>
318 * @Accessibility_STATE_HORIZONTAL: <![CDATA[ Indicates the orientation of thsi object is horizontal ]]>
319 * @Accessibility_STATE_ICONIFIED: <![CDATA[ Indicates this object is minimized and is represented only by an icon ]]>
320 * @Accessibility_STATE_MODAL: <![CDATA[ Indicates something must be done with this object before the user can interact with an object in a different window. ]]>
321 * @Accessibility_STATE_MULTI_LINE: <![CDATA[ Indicates this (text) object can contain multiple lines of text ]]>
322 * @Accessibility_STATE_MULTISELECTABLE: <![CDATA[ Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections. ]]>
323 * @Accessibility_STATE_OPAQUE: <![CDATA[ Indicates this object paints every pixel within its rectangular region. It also indicates an alpha value of unity, if it supports alpha blending. ]]>
324 * @Accessibility_STATE_PRESSED: <![CDATA[ Indicates this object is currently pressed ]]>
325 * @Accessibility_STATE_RESIZABLE: <![CDATA[ Indicates the size of this object's size is not fixed ]]>
326 * @Accessibility_STATE_SELECTABLE: <![CDATA[ Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected. ]]>
327 * @Accessibility_STATE_SELECTED: <![CDATA[ Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected. ]]>
328 * @Accessibility_STATE_SENSITIVE: <![CDATA[ Indicates this object is sensitive, e.g. to user interaction. STATE_SENSITIVE usually accompanies STATE_ENABLED for user-actionable controls, but may be found in the absence of STATE_ENABLED if the current visible state of the control is "disconnected" from the application state. In such cases, direct user interaction can often result in the object gaining STATE_SENSITIVE, for instance if a user makes an explicit selection using an object whose current state is ambiguous or undefined. @see STATE_ENABLED, STATE_INDETERMINATE. ]]>
329 * @Accessibility_STATE_SHOWING: <![CDATA[ Indicates this object, the object's parent, the object's parent's parent, and so on, are all 'shown' to the end-user, i.e. subject to "exposure" if blocking or obscuring objects do not interpose between this object and the top of the window stack. ]]>
330 * @Accessibility_STATE_SINGLE_LINE: <![CDATA[ Indicates this (text) object can contain only a single line of text ]]>
331 * @Accessibility_STATE_STALE: <![CDATA[ Indicates that the information returned for this object may no longer be synchronized with the application state. This can occur if the object has STATE_TRANSIENT, and can also occur towards the end of the object peer's lifecycle. ]]>
332 * @Accessibility_STATE_TRANSIENT: <![CDATA[ Indicates this object is transient ]]>
333 * @Accessibility_STATE_VERTICAL: <![CDATA[ Indicates the orientation of this object is vertical; for example this state may appear on such objects as scrollbars, text objects (with vertical text flow), separators, etc. ]]>
334 * @Accessibility_STATE_VISIBLE: <![CDATA[ Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the field of view, or having an ancestor container that has not yet made visible. A widget is potentially onscreen if it has both STATE_VISIBLE and STATE_SHOWING. The absence of STATE_VISIBLE and STATE_SHOWING is semantically equivalent to saying that an object is 'hidden'. ]]>
335 * @Accessibility_STATE_MANAGES_DESCENDANTS: <![CDATA[ Indicates that "active-descendant-changed" event is sent when children become 'active' (i.e. are selected or navigated to onscreen). Used to prevent need to enumerate all children in very large containers, like tables. The presence of STATE_MANAGES_DESCENDANTS is an indication to the client. that the children should not, and need not, be enumerated by the client. Objects implementing this state are expected to provide relevant state notifications to listening clients, for instance notifications of visibility changes and activation of their contained child objects, without the client having previously requested references to those children. ]]>
336 * @Accessibility_STATE_INDETERMINATE: <![CDATA[ Indicates that a check box or other boolean indicator is in a state other than checked or not checked. This usually means that the boolean value reflected or controlled by the object does not apply consistently to the entire current context. For example, a checkbox for the "Bold" attribute of text may have STATE_INDETERMINATE if the currently selected text contains a mixture of weight attributes. In many cases interacting with a STATE_INDETERMINATE object will cause the context's corresponding boolean attribute to be homogenized, whereupon the object will lose STATE_INDETERMINATE and a corresponding state-changed event will be fired. ]]>
337 * @Accessibility_STATE_REQUIRED: <![CDATA[ Indicates that user interaction with this object is 'required' from the user, for instance before completing the processing of a form. ]]>
338 * @Accessibility_STATE_TRUNCATED: <![CDATA[ Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell. ]]>
339 * @Accessibility_STATE_ANIMATED: <![CDATA[ Indicates this object's visual representation is dynamic, not static. This state may be applied to an object during an animated 'effect' and be removed from the object once its visual representation becomes static. some applications, notably content viewers, may not be able to detect all kinds of animated content. Therefore the absence of this state should not be taken as definitive evidence that the object's visual representation is static; this state is advisory. ]]>
340 * @Accessibility_STATE_INVALID_ENTRY: <![CDATA[ This object has indicated an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input. ]]>
341 * @Accessibility_STATE_SUPPORTS_AUTOCOMPLETION: <![CDATA[ This state indicates that the object in question implements some form of ¨typeahead¨ or pre-selection behavior whereby entering the first character of one or more sub-elements causes those elements to scroll into view or become selected. Subsequent character input may narrow the selection further as long as one or more sub-elements match the string. This state is normally only useful and encountered on objects that implement Selection. In some cases the typeahead behavior may result in full or partial ¨completion¨ of the data in the input field, in which case these input events may trigger text-changed events from the source. ]]>
342 * @Accessibility_STATE_SELECTABLE_TEXT: <![CDATA[ This state indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from STATE_SELECTABLE, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations. ]]>
343 * @Accessibility_STATE_IS_DEFAULT: <![CDATA[ This state indicates that the object in question is the 'default' interaction object in a dialog, i.e. the one that gets activated if the user presses "Enter" when the dialog is initially posted. ]]>
344 * @Accessibility_STATE_VISITED: <![CDATA[ This state indicates that the object (typically a hyperlink) has already been activated or invoked, with the result that some backing data has been downloaded or rendered. ]]>
345 * @Accessibility_STATE_LAST_DEFINED: <![CDATA[ This value of the enumeration should not be used as a parameter, it indicates the number of items in the StateType enumeration. ]]>
347 * Bitfield/set of flags generated from the AT-SPI specification.
350 Accessibility_STATE_INVALID,
351 Accessibility_STATE_ACTIVE,
352 Accessibility_STATE_ARMED,
353 Accessibility_STATE_BUSY,
354 Accessibility_STATE_CHECKED,
355 Accessibility_STATE_COLLAPSED,
356 Accessibility_STATE_DEFUNCT,
357 Accessibility_STATE_EDITABLE,
358 Accessibility_STATE_ENABLED,
359 Accessibility_STATE_EXPANDABLE,
360 Accessibility_STATE_EXPANDED,
361 Accessibility_STATE_FOCUSABLE,
362 Accessibility_STATE_FOCUSED,
363 Accessibility_STATE_HAS_TOOLTIP,
364 Accessibility_STATE_HORIZONTAL,
365 Accessibility_STATE_ICONIFIED,
366 Accessibility_STATE_MODAL,
367 Accessibility_STATE_MULTI_LINE,
368 Accessibility_STATE_MULTISELECTABLE,
369 Accessibility_STATE_OPAQUE,
370 Accessibility_STATE_PRESSED,
371 Accessibility_STATE_RESIZABLE,
372 Accessibility_STATE_SELECTABLE,
373 Accessibility_STATE_SELECTED,
374 Accessibility_STATE_SENSITIVE,
375 Accessibility_STATE_SHOWING,
376 Accessibility_STATE_SINGLE_LINE,
377 Accessibility_STATE_STALE,
378 Accessibility_STATE_TRANSIENT,
379 Accessibility_STATE_VERTICAL,
380 Accessibility_STATE_VISIBLE,
381 Accessibility_STATE_MANAGES_DESCENDANTS,
382 Accessibility_STATE_INDETERMINATE,
383 Accessibility_STATE_REQUIRED,
384 Accessibility_STATE_TRUNCATED,
385 Accessibility_STATE_ANIMATED,
386 Accessibility_STATE_INVALID_ENTRY,
387 Accessibility_STATE_SUPPORTS_AUTOCOMPLETION,
388 Accessibility_STATE_SELECTABLE_TEXT,
389 Accessibility_STATE_IS_DEFAULT,
390 Accessibility_STATE_VISITED,
391 Accessibility_STATE_LAST_DEFINED,
392 } Accessibility_StateType;
395 * NUM_ACCESSIBILITY_STATETYPES:
397 * 1 higher than the highest valid value of #Accessibility_StateType.
399 #define NUM_ACCESSIBILITY_STATETYPES (41+1)
403 Accessibility_KeyEventType:
404 * @Accessibility_KEY_PRESSED: <![CDATA[]]>
405 * @Accessibility_KEY_RELEASED: <![CDATA[]]>
407 * <![CDATA[ Deprecated, DO NOT USE! ]]>
409 * Bitfield/set of flags generated from the AT-SPI specification.
412 Accessibility_KEY_PRESSED,
413 Accessibility_KEY_RELEASED,
414 } Accessibility_KeyEventType;
417 * NUM_ACCESSIBILITY_KEYEVENTTYPES:
419 * 1 higher than the highest valid value of #Accessibility_KeyEventType.
421 #define NUM_ACCESSIBILITY_KEYEVENTTYPES (1+1)
425 Accessibility_EventType:
426 * @Accessibility_KEY_PRESSED_EVENT: <![CDATA[ < key on a keyboard device was pressed. ]]>
427 * @Accessibility_KEY_RELEASED_EVENT: <![CDATA[ < key on a keyboard device was released. ]]>
428 * @Accessibility_BUTTON_PRESSED_EVENT: <![CDATA[ < button on a non-keyboard human interface device (HID) was pressed ]]>
429 * @Accessibility_BUTTON_RELEASED_EVENT: <![CDATA[ < button on a non-keyboard human interface device (HID) was pressed ]]>
431 * <![CDATA[ Used to specify the event types of interest to an EventListener, or to identify the type of an event for which notification has been sent. @see EventTypeSeq, DeviceEvent::type ]]>
433 * Bitfield/set of flags generated from the AT-SPI specification.
436 Accessibility_KEY_PRESSED_EVENT,
437 Accessibility_KEY_RELEASED_EVENT,
438 Accessibility_BUTTON_PRESSED_EVENT,
439 Accessibility_BUTTON_RELEASED_EVENT,
440 } Accessibility_EventType;
443 * NUM_ACCESSIBILITY_EVENTTYPES:
445 * 1 higher than the highest valid value of #Accessibility_EventType.
447 #define NUM_ACCESSIBILITY_EVENTTYPES (3+1)
451 Accessibility_KeySynthType:
452 * @Accessibility_KEY_PRESS: <![CDATA[ emulate the pressing of a hardware keyboard key. ]]>
453 * @Accessibility_KEY_RELEASE: <![CDATA[ emulate the release of a hardware keyboard key. ]]>
454 * @Accessibility_KEY_PRESSRELEASE: <![CDATA[ a hardware keyboard key is pressed and immediately released. ]]>
455 * @Accessibility_KEY_SYM: <![CDATA[ a symbolic key event is generated, without specifying a hardware key. @note if the keysym is not present in the current keyboard map, the DeviceEventController instance has a limited ability to generate such keysyms on-the-fly. Reliability of generateKeyboardEvent calls using out-of-keymap keysyms will vary from system to system, and on the number of different out-of-keymap being generated in quick succession. In practice this is rarely significant, since the keysyms of interest to AT clients and keyboard emulators are usually part of the current keymap, i.e. present on the system keyboard for the current locale (even if a physical hardware keyboard is not connected. ]]>
456 * @Accessibility_KEY_STRING: <![CDATA[ a string is converted to its equivalent keyboard events and emitted. If the string consists of complex character or composed characters which are not in the current keymap, string emission is subject to the out-of-keymap limitations described for KeySynthType::KEY_SYM. In practice this limitation primarily effects Chinese and Japanese locales. ]]>
458 * <![CDATA[ Used when synthesizing keyboard input via DeviceEventController:generateKeyboardEvent. ]]>
460 * Bitfield/set of flags generated from the AT-SPI specification.
463 Accessibility_KEY_PRESS,
464 Accessibility_KEY_RELEASE,
465 Accessibility_KEY_PRESSRELEASE,
466 Accessibility_KEY_SYM,
467 Accessibility_KEY_STRING,
468 } Accessibility_KeySynthType;
471 * NUM_ACCESSIBILITY_KEYSYNTHTYPES:
473 * 1 higher than the highest valid value of #Accessibility_KeySynthType.
475 #define NUM_ACCESSIBILITY_KEYSYNTHTYPES (4+1)
479 Accessibility_ModifierType:
480 * @Accessibility_MODIFIER_SHIFT: <![CDATA[ The left or right 'Shift' key ]]>
481 * @Accessibility_MODIFIER_SHIFTLOCK: <![CDATA[ The ShiftLock or CapsLock key ]]>
482 * @Accessibility_MODIFIER_CONTROL: <![CDATA[ 'Control'/'Ctrl' ]]>
483 * @Accessibility_MODIFIER_ALT: <![CDATA[ The Alt key (as opposed to AltGr) ]]>
484 * @Accessibility_MODIFIER_META: <![CDATA[ depending on the platform this may map to 'Window', 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will map to one of META, META2, META3. On X Windows platforms these META values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an event having ModifierType::MODIFIER_META2 means that the 'Mod2Mask' bit is set in the corresponding XEvent. ]]>
485 * @Accessibility_MODIFIER_META2: <![CDATA[]]>
486 * @Accessibility_MODIFIER_META3: <![CDATA[]]>
487 * @Accessibility_MODIFIER_NUMLOCK: <![CDATA[ A symbolic meta key name that is mapped by AT-SPI to the appropriate META value, for the convenience of the client. ]]>
489 * Bitfield/set of flags generated from the AT-SPI specification.
492 Accessibility_MODIFIER_SHIFT,
493 Accessibility_MODIFIER_SHIFTLOCK,
494 Accessibility_MODIFIER_CONTROL,
495 Accessibility_MODIFIER_ALT,
496 Accessibility_MODIFIER_META,
497 Accessibility_MODIFIER_META2,
498 Accessibility_MODIFIER_META3,
499 Accessibility_MODIFIER_NUMLOCK,
500 } Accessibility_ModifierType;
503 * NUM_ACCESSIBILITY_MODIFIERTYPES:
505 * 1 higher than the highest valid value of #Accessibility_ModifierType.
507 #define NUM_ACCESSIBILITY_MODIFIERTYPES (7+1)
511 Accessibility_RelationType:
512 * @Accessibility_RELATION_NULL: <![CDATA[ Not a meaningful relationship; clients should not normally encounter this RelationType value. ]]>
513 * @Accessibility_RELATION_LABEL_FOR: <![CDATA[ Object is a label for one or more other objects. ]]>
514 * @Accessibility_RELATION_LABELLED_BY: <![CDATA[ Object is labelled by one or more other objects. ]]>
515 * @Accessibility_RELATION_CONTROLLER_FOR: <![CDATA[ Object is an interactive object which modifies the state, onscreen location, or other attributes of one or more target objects. ]]>
516 * @Accessibility_RELATION_CONTROLLED_BY: <![CDATA[ Object state, position, etc. is modified/controlled by user interaction with one or more other objects. For instance a viewport or scroll pane may be CONTROLLED_BY scrollbars. ]]>
517 * @Accessibility_RELATION_MEMBER_OF: <![CDATA[ Object has a grouping relationship (e.g. 'same group as') to one or more other objects. ]]>
518 * @Accessibility_RELATION_TOOLTIP_FOR: <![CDATA[ Object is a tooltip associated with another object. ]]>
519 * @Accessibility_RELATION_NODE_CHILD_OF: <![CDATA[ Reserved for future use. ]]>
520 * @Accessibility_RELATION_EXTENDED: <![CDATA[ Used to indicate that a relationship exists, but its type is not specified in the enumeration and must be obtained via a call to getRelationTypeName. ]]>
521 * @Accessibility_RELATION_FLOWS_TO: <![CDATA[ Object renders content which flows logically to another object. For instance, text in a paragraph may flow to another object which is not the 'next sibling' in the accessibility hierarchy. ]]>
522 * @Accessibility_RELATION_FLOWS_FROM: <![CDATA[ Reciprocal of RELATION_FLOWS_TO. ]]>
523 * @Accessibility_RELATION_SUBWINDOW_OF: <![CDATA[ Object is visually and semantically considered a subwindow of another object, even though it is not the object's child. Useful when dealing with embedded applications and other cases where the widget hierarchy does not map cleanly to the onscreen presentation. ]]>
524 * @Accessibility_RELATION_EMBEDS: <![CDATA[ Similar to SUBWINDOW_OF, but specifically used for cross-process embedding. ]]>
525 * @Accessibility_RELATION_EMBEDDED_BY: <![CDATA[ Reciprocal of RELATION_EMBEDS; Used to denote content rendered by embedded renderers that live in a separate process space from the embedding context. ]]>
526 * @Accessibility_RELATION_POPUP_FOR: <![CDATA[ Denotes that the object is a transient window or frame associated with another onscreen object. Similar to TOOLTIP_FOR, but more general. Useful for windows which are technically toplevels but which, for one or more reasons, do not explicitly cause their associated window to lose 'window focus'. Creation of a ROLE_WINDOW object with the POPUP_FOR relation usually requires some presentation action on the part of assistive technology clients, even though the previous toplevel ROLE_FRAME object may still be the active window. ]]>
527 * @Accessibility_RELATION_PARENT_WINDOW_OF: <![CDATA[ This is the reciprocal relation to RELATION_POPUP_FOR. ]]>
528 * @Accessibility_RELATION_DESCRIPTION_FOR: <![CDATA[ Indicates that an object provides descriptive information about another object; more verbose than RELATION_LABEL_FOR. ]]>
529 * @Accessibility_RELATION_DESCRIBED_BY: <![CDATA[ Indicates that another object provides descriptive information about this object; more verbose than RELATION_LABELLED_BY. ]]>
530 * @Accessibility_RELATION_LAST_DEFINED: <![CDATA[ Do not use as a parameter value, used to determine the size of the enumeration. ]]>
532 * <![CDATA[ RelationType specifies a relationship between objects (possibly one-to-many or many-to-one) outside of the normal parent/child hierarchical relationship. It allows better semantic identification of how objects are associated with one another. For instance the RELATION_LABELLED_BY relationship may be used to identify labelling information that should accompany the accessibleName property when presenting an object's content or identity to the end user. Similarly, RELATION_CONTROLLER_FOR can be used to further specify the context in which a valuator is useful, and/or the other UI components which are directly effected by user interactions with the valuator. Common examples include association of scrollbars with the viewport or panel which they control. ]]>
534 * Bitfield/set of flags generated from the AT-SPI specification.
537 Accessibility_RELATION_NULL,
538 Accessibility_RELATION_LABEL_FOR,
539 Accessibility_RELATION_LABELLED_BY,
540 Accessibility_RELATION_CONTROLLER_FOR,
541 Accessibility_RELATION_CONTROLLED_BY,
542 Accessibility_RELATION_MEMBER_OF,
543 Accessibility_RELATION_TOOLTIP_FOR,
544 Accessibility_RELATION_NODE_CHILD_OF,
545 Accessibility_RELATION_EXTENDED,
546 Accessibility_RELATION_FLOWS_TO,
547 Accessibility_RELATION_FLOWS_FROM,
548 Accessibility_RELATION_SUBWINDOW_OF,
549 Accessibility_RELATION_EMBEDS,
550 Accessibility_RELATION_EMBEDDED_BY,
551 Accessibility_RELATION_POPUP_FOR,
552 Accessibility_RELATION_PARENT_WINDOW_OF,
553 Accessibility_RELATION_DESCRIPTION_FOR,
554 Accessibility_RELATION_DESCRIBED_BY,
555 Accessibility_RELATION_LAST_DEFINED,
556 } Accessibility_RelationType;
559 * NUM_ACCESSIBILITY_RELATIONTYPES:
561 * 1 higher than the highest valid value of #Accessibility_RelationType.
563 #define NUM_ACCESSIBILITY_RELATIONTYPES (18+1)
568 * @Accessibility_ROLE_INVALID: <![CDATA[ A Role indicating an error condition, such as uninitialized Role data. ]]>
569 * @Accessibility_ROLE_ACCELERATOR_LABEL: <![CDATA[ Object is a label indicating the keyboard accelerators for the parent ]]>
570 * @Accessibility_ROLE_ALERT: <![CDATA[ Object is used to alert the user about something ]]>
571 * @Accessibility_ROLE_ANIMATION: <![CDATA[ Object contains a dynamic or moving image of some kind ]]>
572 * @Accessibility_ROLE_ARROW: <![CDATA[ Object is a 2d directional indicator ]]>
573 * @Accessibility_ROLE_CALENDAR: <![CDATA[ Object contains one or more dates, usually arranged into a 2d list ]]>
574 * @Accessibility_ROLE_CANVAS: <![CDATA[ Object that can be drawn into and is used to trap events ]]>
575 * @Accessibility_ROLE_CHECK_BOX: <![CDATA[ A choice that can be checked or unchecked and provides a separate indicator for the current state. ]]>
576 * @Accessibility_ROLE_CHECK_MENU_ITEM: <![CDATA[ A menu item that behaves like a check box (see ROLE_CHECK_BOX) ]]>
577 * @Accessibility_ROLE_COLOR_CHOOSER: <![CDATA[ A specialized dialog that lets the user choose a color. ]]>
578 * @Accessibility_ROLE_COLUMN_HEADER: <![CDATA[ The header for a column of data ]]>
579 * @Accessibility_ROLE_COMBO_BOX: <![CDATA[ A list of choices the user can select from ]]>
580 * @Accessibility_ROLE_DATE_EDITOR: <![CDATA[ An object which allows entry of a date ]]>
581 * @Accessibility_ROLE_DESKTOP_ICON: <![CDATA[ An inconifed internal frame within a DESKTOP_PANE ]]>
582 * @Accessibility_ROLE_DESKTOP_FRAME: <![CDATA[ A pane that supports internal frames and iconified versions of those internal frames. ]]>
583 * @Accessibility_ROLE_DIAL: <![CDATA[ An object that allows a value to be changed via rotating a visual element, or which displays a value via such a rotating element. ]]>
584 * @Accessibility_ROLE_DIALOG: <![CDATA[ A top level window with title bar and a border ]]>
585 * @Accessibility_ROLE_DIRECTORY_PANE: <![CDATA[ A pane that allows the user to navigate through and select the contents of a directory ]]>
586 * @Accessibility_ROLE_DRAWING_AREA: <![CDATA[ A specialized dialog that displays the files in the directory and lets the user select a file, browse a different directory, or specify a filename. ]]>
587 * @Accessibility_ROLE_FILE_CHOOSER: <![CDATA[ An object used for drawing custom user interface elements. ]]>
588 * @Accessibility_ROLE_FILLER: <![CDATA[ A object that fills up space in a user interface ]]>
589 * @Accessibility_ROLE_FOCUS_TRAVERSABLE: <![CDATA[ Don't use, reserved for future use. ]]>
590 * @Accessibility_ROLE_FONT_CHOOSER: <![CDATA[ Allows selection of a display font ]]>
591 * @Accessibility_ROLE_FRAME: <![CDATA[ A top level window with a title bar, border, menubar, etc. ]]>
592 * @Accessibility_ROLE_GLASS_PANE: <![CDATA[ A pane that is guaranteed to be painted on top of all panes beneath it ]]>
593 * @Accessibility_ROLE_HTML_CONTAINER: <![CDATA[ A document container for HTML, whose children represent the document content. ]]>
594 * @Accessibility_ROLE_ICON: <![CDATA[ A small fixed size picture, typically used to decorate components ]]>
595 * @Accessibility_ROLE_IMAGE: <![CDATA[ An image, typically static. ]]>
596 * @Accessibility_ROLE_INTERNAL_FRAME: <![CDATA[ A frame-like object that is clipped by a desktop pane. ]]>
597 * @Accessibility_ROLE_LABEL: <![CDATA[ An object used to present an icon or short string in an interface ]]>
598 * @Accessibility_ROLE_LAYERED_PANE: <![CDATA[ A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. ]]>
599 * @Accessibility_ROLE_LIST: <![CDATA[ An object that presents a list of objects to the user and allows the user to select one or more of them. ]]>
600 * @Accessibility_ROLE_LIST_ITEM: <![CDATA[ An object that represents an element of a list. ]]>
601 * @Accessibility_ROLE_MENU: <![CDATA[ An object usually found inside a menu bar that contains a list of actions the user can choose from. ]]>
602 * @Accessibility_ROLE_MENU_BAR: <![CDATA[ An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from. ]]>
603 * @Accessibility_ROLE_MENU_ITEM: <![CDATA[ An object usually contained in a menu that presents an action the user can choose. ]]>
604 * @Accessibility_ROLE_OPTION_PANE: <![CDATA[ A specialized pane whose primary use is inside a DIALOG ]]>
605 * @Accessibility_ROLE_PAGE_TAB: <![CDATA[ An object that is a child of a page tab list ]]>
606 * @Accessibility_ROLE_PAGE_TAB_LIST: <![CDATA[ An object that presents a series of panels (or page tabs), one at a time, through some mechanism provided by the object. ]]>
607 * @Accessibility_ROLE_PANEL: <![CDATA[ A generic container that is often used to group objects. ]]>
608 * @Accessibility_ROLE_PASSWORD_TEXT: <![CDATA[ A text object uses for passwords, or other places where the text content is not shown visibly to the user. ]]>
609 * @Accessibility_ROLE_POPUP_MENU: <![CDATA[ A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices. ]]>
610 * @Accessibility_ROLE_PROGRESS_BAR: <![CDATA[ An object used to indicate how much of a task has been completed. ]]>
611 * @Accessibility_ROLE_PUSH_BUTTON: <![CDATA[ An object the user can manipulate to tell the application to do something. ]]>
612 * @Accessibility_ROLE_RADIO_BUTTON: <![CDATA[ A specialized check box that will cause other radio buttons in the same group to become uncghecked when this one is checked. ]]>
613 * @Accessibility_ROLE_RADIO_MENU_ITEM: <![CDATA[ Object is both a menu item and a "radio button" (see ROLE_RADIO_BUTTON) ]]>
614 * @Accessibility_ROLE_ROOT_PANE: <![CDATA[ A specialized pane that has a glass pane and a layered pane as its children. ]]>
615 * @Accessibility_ROLE_ROW_HEADER: <![CDATA[ The header for a row of data ]]>
616 * @Accessibility_ROLE_SCROLL_BAR: <![CDATA[ An object usually used to allow a user to incrementally view a large amount of data by moving the bounds of a viewport along a one-dimensional axis. ]]>
617 * @Accessibility_ROLE_SCROLL_PANE: <![CDATA[ An object that allows a user to incrementally view a large amount of information. ROLE_SCROLL_PANE objects are usually accompanied by ROLE_SCROLL_BAR controllers, on which the RELATION_CONTROLLER_FOR and RELATION_CONTROLLED_BY reciprocal relations are set; \see Accessibility::RelationSet. ]]>
618 * @Accessibility_ROLE_SEPARATOR: <![CDATA[ An object usually contained in a menu to provide a visible and logical separation of the contents in a menu. ]]>
619 * @Accessibility_ROLE_SLIDER: <![CDATA[ An object that allows the user to select from a bounded range ]]>
620 * @Accessibility_ROLE_SPIN_BUTTON: <![CDATA[ An object which allows one of a set of choices to be selected, and which displays the current choice. Unlike ROLE_SCROLL_BAR, ROLE_SLIDER objects need not control 'viewport'-like objects. ]]>
621 * @Accessibility_ROLE_SPLIT_PANE: <![CDATA[ A specialized panel that presents two other panels at the same time. ]]>
622 * @Accessibility_ROLE_STATUS_BAR: <![CDATA[ Object displays non-quantitative status information (c.f. ROLE_PROGRESS_BAR) ]]>
623 * @Accessibility_ROLE_TABLE: <![CDATA[ An object used to repesent information in terms of rows and columns. ]]>
624 * @Accessibility_ROLE_TABLE_CELL: <![CDATA[ A 'cell' or discrete child within a Table. \note Table cells need not have ROLE_TABLE_CELL, other RoleType values are valid as well. ]]>
625 * @Accessibility_ROLE_TABLE_COLUMN_HEADER: <![CDATA[ An object which labels a particular column in a Table. ]]>
626 * @Accessibility_ROLE_TABLE_ROW_HEADER: <![CDATA[ An object which labels a particular row in a Table. Table rows and columns may also be labelled via the RELATION_LABEL_FOR/RELATION_LABELLED_BY relationships; see Accessibility.RelationSet. ]]>
627 * @Accessibility_ROLE_TEAROFF_MENU_ITEM: <![CDATA[ Object allows menu to be removed from menubar and shown in its own window. ]]>
628 * @Accessibility_ROLE_TERMINAL: <![CDATA[ An object that emulates a terminal ]]>
629 * @Accessibility_ROLE_TEXT: <![CDATA[ An object that presents text to the user, of nonspecific type. ]]>
630 * @Accessibility_ROLE_TOGGLE_BUTTON: <![CDATA[ A specialized push button that can be checked or unchecked, but does not procide a separate indicator for the current state. ]]>
631 * @Accessibility_ROLE_TOOL_BAR: <![CDATA[ A bar or palette usually composed of push buttons or toggle buttons ]]>
632 * @Accessibility_ROLE_TOOL_TIP: <![CDATA[ An object that provides information about another object ]]>
633 * @Accessibility_ROLE_TREE: <![CDATA[ An object used to repsent hierarchical information to the user. ]]>
634 * @Accessibility_ROLE_TREE_TABLE: <![CDATA[ An object that presents both tabular and hierarchical info to the user ]]>
635 * @Accessibility_ROLE_UNKNOWN: <![CDATA[ The object contains some Accessible information, but its role is not known. ]]>
636 * @Accessibility_ROLE_VIEWPORT: <![CDATA[ An object usually used in a scroll pane, or to otherwise clip a larger object or content renderer to a specific onscreen viewport. ]]>
637 * @Accessibility_ROLE_WINDOW: <![CDATA[ A ¨top level window¨ with no title or border. ]]>
638 * @Accessibility_ROLE_EXTENDED: <![CDATA[ means that the role for this item is known, but not included in the core enumeration ]]>
639 * @Accessibility_ROLE_HEADER: <![CDATA[ An object that serves as a document header. ]]>
640 * @Accessibility_ROLE_FOOTER: <![CDATA[ An object that serves as a document footer. ]]>
641 * @Accessibility_ROLE_PARAGRAPH: <![CDATA[ An object which is contains a single paragraph of text content. See also ROLE_TEXT. ]]>
642 * @Accessibility_ROLE_RULER: <![CDATA[ An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). ]]>
643 * @Accessibility_ROLE_APPLICATION: <![CDATA[ An object corresponding to the toplevel accessible of an application, which may contain ROLE_FRAME objects or other accessible objects. Children of AccessibleDesktop objects are generally ROLE_APPLICATION objects. ]]>
644 * @Accessibility_ROLE_AUTOCOMPLETE: <![CDATA[ The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. ]]>
645 * @Accessibility_ROLE_EDITBAR: <![CDATA[ The object is an editable text object in a toolbar. ]]>
646 * @Accessibility_ROLE_EMBEDDED: <![CDATA[ The object is an embedded component container. This role is a "grouping" hint that the contained objects share a context which is different from the container in which this accessible is embedded. In particular, it is used for some kinds of document embedding, and for embedding of out-of-process component, "panel applets", etc. ]]>
647 * @Accessibility_ROLE_ENTRY: <![CDATA[ The object is a component whose textual content may be entered or modified by the user, provided STATE_EDITABLE is present. A readonly ROLE_ENTRY object (i.e. where STATE_EDITABLE is not present) implies a read-only 'text field' in a form, as opposed to a title, label, or caption. ]]>
648 * @Accessibility_ROLE_CHART: <![CDATA[ The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property. See ROLE_CAPTION ]]>
649 * @Accessibility_ROLE_CAPTION: <![CDATA[ The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. ]]>
650 * @Accessibility_ROLE_DOCUMENT_FRAME: <![CDATA[ The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface. ]]>
651 * @Accessibility_ROLE_HEADING: <![CDATA[ The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes. ]]>
652 * @Accessibility_ROLE_PAGE: <![CDATA[ The object is a containing instance which encapsulates a page of information. ROLE_PAGE is used in documents and content which support a paginated navigation model. ]]>
653 * @Accessibility_ROLE_SECTION: <![CDATA[ The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. ]]>
654 * @Accessibility_ROLE_REDUNDANT_OBJECT: <![CDATA[ The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should be ignored by clients, if they are encountered at all. ]]>
655 * @Accessibility_ROLE_FORM: <![CDATA[ The object is a containing instance of document content which has within it components with which the user can interact in order to input information; i.e. the object is a container for pushbuttons, comboboxes, text input fields, and other 'GUI' components. ROLE_FORM should not, in general, be used for toplevel GUI containers or dialogs, but should be reserved for 'GUI' containers which occur within document content, for instance within Web documents, presentations, or text documents. Unlike other GUI containers and dialogs which occur inside application instances, ROLE_FORM containers' components are associated with the current document, rather than the current foreground application or viewer instance. ]]>
656 * @Accessibility_ROLE_LINK: <![CDATA[ The object is a hypertext anchor, i.e. a "link" in a hypertext document. Such objects are distinct from 'inline' content which may also use the Hypertext/Hyperlink interfaces to indicate the range/location within a text object where an inline or embedded object lies. ]]>
657 * @Accessibility_ROLE_INPUT_METHOD_WINDOW: <![CDATA[ The object is a window or similar viewport which is used to allow composition or input of a 'complex character', in other words it is an "input method window." ]]>
658 * @Accessibility_ROLE_LAST_DEFINED: <![CDATA[ Not a valid role, used for finding end of enumeration. ]]>
660 * Bitfield/set of flags generated from the AT-SPI specification.
663 Accessibility_ROLE_INVALID,
664 Accessibility_ROLE_ACCELERATOR_LABEL,
665 Accessibility_ROLE_ALERT,
666 Accessibility_ROLE_ANIMATION,
667 Accessibility_ROLE_ARROW,
668 Accessibility_ROLE_CALENDAR,
669 Accessibility_ROLE_CANVAS,
670 Accessibility_ROLE_CHECK_BOX,
671 Accessibility_ROLE_CHECK_MENU_ITEM,
672 Accessibility_ROLE_COLOR_CHOOSER,
673 Accessibility_ROLE_COLUMN_HEADER,
674 Accessibility_ROLE_COMBO_BOX,
675 Accessibility_ROLE_DATE_EDITOR,
676 Accessibility_ROLE_DESKTOP_ICON,
677 Accessibility_ROLE_DESKTOP_FRAME,
678 Accessibility_ROLE_DIAL,
679 Accessibility_ROLE_DIALOG,
680 Accessibility_ROLE_DIRECTORY_PANE,
681 Accessibility_ROLE_DRAWING_AREA,
682 Accessibility_ROLE_FILE_CHOOSER,
683 Accessibility_ROLE_FILLER,
684 Accessibility_ROLE_FOCUS_TRAVERSABLE,
685 Accessibility_ROLE_FONT_CHOOSER,
686 Accessibility_ROLE_FRAME,
687 Accessibility_ROLE_GLASS_PANE,
688 Accessibility_ROLE_HTML_CONTAINER,
689 Accessibility_ROLE_ICON,
690 Accessibility_ROLE_IMAGE,
691 Accessibility_ROLE_INTERNAL_FRAME,
692 Accessibility_ROLE_LABEL,
693 Accessibility_ROLE_LAYERED_PANE,
694 Accessibility_ROLE_LIST,
695 Accessibility_ROLE_LIST_ITEM,
696 Accessibility_ROLE_MENU,
697 Accessibility_ROLE_MENU_BAR,
698 Accessibility_ROLE_MENU_ITEM,
699 Accessibility_ROLE_OPTION_PANE,
700 Accessibility_ROLE_PAGE_TAB,
701 Accessibility_ROLE_PAGE_TAB_LIST,
702 Accessibility_ROLE_PANEL,
703 Accessibility_ROLE_PASSWORD_TEXT,
704 Accessibility_ROLE_POPUP_MENU,
705 Accessibility_ROLE_PROGRESS_BAR,
706 Accessibility_ROLE_PUSH_BUTTON,
707 Accessibility_ROLE_RADIO_BUTTON,
708 Accessibility_ROLE_RADIO_MENU_ITEM,
709 Accessibility_ROLE_ROOT_PANE,
710 Accessibility_ROLE_ROW_HEADER,
711 Accessibility_ROLE_SCROLL_BAR,
712 Accessibility_ROLE_SCROLL_PANE,
713 Accessibility_ROLE_SEPARATOR,
714 Accessibility_ROLE_SLIDER,
715 Accessibility_ROLE_SPIN_BUTTON,
716 Accessibility_ROLE_SPLIT_PANE,
717 Accessibility_ROLE_STATUS_BAR,
718 Accessibility_ROLE_TABLE,
719 Accessibility_ROLE_TABLE_CELL,
720 Accessibility_ROLE_TABLE_COLUMN_HEADER,
721 Accessibility_ROLE_TABLE_ROW_HEADER,
722 Accessibility_ROLE_TEAROFF_MENU_ITEM,
723 Accessibility_ROLE_TERMINAL,
724 Accessibility_ROLE_TEXT,
725 Accessibility_ROLE_TOGGLE_BUTTON,
726 Accessibility_ROLE_TOOL_BAR,
727 Accessibility_ROLE_TOOL_TIP,
728 Accessibility_ROLE_TREE,
729 Accessibility_ROLE_TREE_TABLE,
730 Accessibility_ROLE_UNKNOWN,
731 Accessibility_ROLE_VIEWPORT,
732 Accessibility_ROLE_WINDOW,
733 Accessibility_ROLE_EXTENDED,
734 Accessibility_ROLE_HEADER,
735 Accessibility_ROLE_FOOTER,
736 Accessibility_ROLE_PARAGRAPH,
737 Accessibility_ROLE_RULER,
738 Accessibility_ROLE_APPLICATION,
739 Accessibility_ROLE_AUTOCOMPLETE,
740 Accessibility_ROLE_EDITBAR,
741 Accessibility_ROLE_EMBEDDED,
742 Accessibility_ROLE_ENTRY,
743 Accessibility_ROLE_CHART,
744 Accessibility_ROLE_CAPTION,
745 Accessibility_ROLE_DOCUMENT_FRAME,
746 Accessibility_ROLE_HEADING,
747 Accessibility_ROLE_PAGE,
748 Accessibility_ROLE_SECTION,
749 Accessibility_ROLE_REDUNDANT_OBJECT,
750 Accessibility_ROLE_FORM,
751 Accessibility_ROLE_LINK,
752 Accessibility_ROLE_INPUT_METHOD_WINDOW,
753 Accessibility_ROLE_LAST_DEFINED,
754 } Accessibility_Role;
757 * NUM_ACCESSIBILITY_ROLES:
759 * 1 higher than the highest valid value of #Accessibility_Role.
761 #define NUM_ACCESSIBILITY_ROLES (90+1)
765 Accessibility_LoginHelper_DeviceReq:
766 * @Accessibility_LoginHelper_GUI_EVENTS: <![CDATA[ Needs access to the GUI event subsystem (e.g. Xserver) ]]>
767 * @Accessibility_LoginHelper_CORE_KEYBOARD: <![CDATA[ Needs access to the system keyboard events (read and write) ]]>
768 * @Accessibility_LoginHelper_CORE_POINTER: <![CDATA[ Needs access to the onscreen pointer (e.g. mouse pointer) ]]>
769 * @Accessibility_LoginHelper_EXT_INPUT: <![CDATA[ Reads XInput extended input devices ]]>
770 * @Accessibility_LoginHelper_POST_WINDOWS: <![CDATA[ Posts Windows, and needs for toplevel windows to be visible ]]>
771 * @Accessibility_LoginHelper_AUDIO_OUT: <![CDATA[ Writes to audio device ]]>
772 * @Accessibility_LoginHelper_AUDIO_IN: <![CDATA[ Reads from audio device ]]>
773 * @Accessibility_LoginHelper_NETWORK: <![CDATA[ Requires access to general network services, including remote access ]]>
774 * @Accessibility_LoginHelper_LOCALHOST: <![CDATA[ Requires network services hosted on LOCALHOST only ]]>
775 * @Accessibility_LoginHelper_SERIAL_OUT: <![CDATA[ Writes to a serial port ]]>
776 * @Accessibility_LoginHelper_SERIAL_IN: <![CDATA[ !<: Reads from a serial port ]]>
778 * <![CDATA[ The system and device access and services which the LoginHelper-implementing assistive technology requires in order to enable the user to use the system. ]]>
780 * Bitfield/set of flags generated from the AT-SPI specification.
783 Accessibility_LoginHelper_GUI_EVENTS,
784 Accessibility_LoginHelper_CORE_KEYBOARD,
785 Accessibility_LoginHelper_CORE_POINTER,
786 Accessibility_LoginHelper_EXT_INPUT,
787 Accessibility_LoginHelper_POST_WINDOWS,
788 Accessibility_LoginHelper_AUDIO_OUT,
789 Accessibility_LoginHelper_AUDIO_IN,
790 Accessibility_LoginHelper_NETWORK,
791 Accessibility_LoginHelper_LOCALHOST,
792 Accessibility_LoginHelper_SERIAL_OUT,
793 Accessibility_LoginHelper_SERIAL_IN,
794 } Accessibility_LoginHelper_DeviceReq;
797 * NUM_ACCESSIBILITY_DEVICEREQS:
799 * 1 higher than the highest valid value of #Accessibility_LoginHelper_DeviceReq.
801 #define NUM_ACCESSIBILITY_DEVICEREQS (10+1)
805 Accessibility_Selector_CommandResult:
806 * @Accessibility_Selector_COMMAND_RESULT_INVALID: <![CDATA[ The command was invalid or ill-formed; usually indicates an error condition. ]]>
807 * @Accessibility_Selector_COMMAND_RESULT_SUCCESS: <![CDATA[ The command was successfully activated. ]]>
808 * @Accessibility_Selector_COMMAND_RESULT_FAILED: <![CDATA[ The command was valid, but could not be activated. This may be due to problems with permissions or error conditions. ]]>
809 * @Accessibility_Selector_COMMAND_RESULT_OBSOLETE: <![CDATA[ The command is no longer valid in the current program context. This may mean that the application has changed state in such a way that the specified command it no longer applicable, or because changes to the application state have rendered it ambiguous. Commands should be re-fetched and a new selection made. ]]>
810 * @Accessibility_Selector_COMMAND_RESULT_LAST_DEFINED: <![CDATA[ Defines size of enumeration; do not use this value as a parameter. ]]>
812 * <![CDATA[ A code returned by a call to activateCommand, indicating the result of the activation request. ]]>
814 * Bitfield/set of flags generated from the AT-SPI specification.
817 Accessibility_Selector_COMMAND_RESULT_INVALID,
818 Accessibility_Selector_COMMAND_RESULT_SUCCESS,
819 Accessibility_Selector_COMMAND_RESULT_FAILED,
820 Accessibility_Selector_COMMAND_RESULT_OBSOLETE,
821 Accessibility_Selector_COMMAND_RESULT_LAST_DEFINED,
822 } Accessibility_Selector_CommandResult;
825 * NUM_ACCESSIBILITY_COMMANDRESULTS:
827 * 1 higher than the highest valid value of #Accessibility_Selector_CommandResult.
829 #define NUM_ACCESSIBILITY_COMMANDRESULTS (4+1)