Top | Description |
Synopsis
enum AtspiLocaleType; #define ATSPI_LOCALE_TYPE enum AtspiCoordType; #define ATSPI_COORD_TYPE_COUNT enum AtspiCollectionSortOrder; #define ATSPI_SORTORDER_COUNT enum AtspiCollectionMatchType; #define ATSPI_MATCHTYPES_COUNT enum AtspiCollectionTreeTraversalType; #define ATSPI_TREETRAVERSALTYPE enum AtspiComponentLayer; #define ATSPI_COMPONENTLAYER_COUNT enum AtspiTextBoundaryType; #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT enum AtspiTextClipType; #define ATSPI_TEXT_CLIP_TYPE_COUNT enum AtspiStateType; #define ATSPI_STATETYPE_COUNT enum AtspiKeyEventType; #define ATSPI_KEYEVENTTYPE_COUNT enum AtspiEventType; #define ATSPI_EVENTTYPE_COUNT enum AtspiKeySynthType; #define ATSPI_KEYSYNTHTYPE_COUNT enum AtspiModifierType; #define ATSPI_MODIFIERTYPE_COUNT enum AtspiRelationType; #define ATSPI_RELATIONTYPE_COUNT enum AtspiRole; #define ATSPI_ROLE_COUNT
Details
enum AtspiLocaleType
typedef enum { ATSPI_LOCALE_TYPE_MESSAGES, ATSPI_LOCALE_TYPE_COLLATE, ATSPI_LOCALE_TYPE_CTYPE, ATSPI_LOCALE_TYPE_MONETARY, ATSPI_LOCALE_TYPE_NUMERIC, ATSPI_LOCALE_TYPE_TIME, } AtspiLocaleType;
Used by interfaces AtspiText and AtspiDocument, this enumeration corresponds to the POSIX 'setlocale' enum values.
For localizable natural-language messages. | |
For regular expression matching and string collation. | |
For regular expression matching, character classification, conversion, case-sensitive comparison, and wide character functions. | |
For monetary formatting. | |
For number formatting (such as the decimal point and the thousands separator). | |
For time and date formatting. |
enum AtspiCoordType
typedef enum { ATSPI_COORD_TYPE_SCREEN, ATSPI_COORD_TYPE_WINDOW, } AtspiCoordType;
Enumeration used by AtspiComponent, AtspiImage, and AtspiText interfaces to specify whether coordinates are relative to the window or the screen.
ATSPI_COORD_TYPE_COUNT
#define ATSPI_COORD_TYPE_COUNT (1+1)
One higher than the highest valid value of AtspiCoordType.
enum AtspiCollectionSortOrder
typedef enum { ATSPI_Collection_SORT_ORDER_INVALID, ATSPI_Collection_SORT_ORDER_CANONICAL, ATSPI_Collection_SORT_ORDER_FLOW, ATSPI_Collection_SORT_ORDER_TAB, ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL, ATSPI_Collection_SORT_ORDER_REVERSE_FLOW, ATSPI_Collection_SORT_ORDER_REVERSE_TAB, ATSPI_Collection_SORT_ORDER_LAST_DEFINED, } AtspiCollectionSortOrder;
Enumeration used by interface AtspiCollection to specify the way AtspiAccesible objects should be sorted.
ATSPI_SORTORDER_COUNT
#define ATSPI_SORTORDER_COUNT (7+1)
One higher than the highest valid value of AtspiCollectionSortOrder.
enum AtspiCollectionMatchType
typedef enum { ATSPI_Collection_MATCH_INVALID, ATSPI_Collection_MATCH_ALL, ATSPI_Collection_MATCH_ANY, ATSPI_Collection_MATCH_NONE, ATSPI_Collection_MATCH_EMPTY, ATSPI_Collection_MATCH_LAST_DEFINED, } AtspiCollectionMatchType;
Enumeration used by AtspiMatchRule to specify how to interpret AtspiAccessible objects.
Indicates an error condition or uninitialized value. | |
TRUE if all of the criteria are met. | |
TRUE if any of the criteria are met. | |
TRUE if none of the criteria are met. | |
Same as ATSPI_Collection_MATCH_ALL if
the criteria is non-empty; for empty criteria this rule requires returned
value to also have empty set.
|
|
Used only to determine the end of the enumeration. |
enum AtspiCollectionTreeTraversalType
typedef enum { ATSPI_Collection_TREE_RESTRICT_CHILDREN, ATSPI_Collection_TREE_RESTRICT_SIBLING, ATSPI_Collection_TREE_INORDER, ATSPI_Collection_TREE_LAST_DEFINED, } AtspiCollectionTreeTraversalType;
Enumeration used by interface AtspiCollection to specify restrictions on AtspiAccesible objects to be traversed.
enum AtspiComponentLayer
typedef enum { ATSPI_LAYER_INVALID, ATSPI_LAYER_BACKGROUND, ATSPI_LAYER_CANVAS, ATSPI_LAYER_WIDGET, ATSPI_LAYER_MDI, ATSPI_LAYER_POPUP, ATSPI_LAYER_OVERLAY, ATSPI_LAYER_WINDOW, ATSPI_LAYER_LAST_DEFINED, } AtspiComponentLayer;
The AtspiComponentLayer of an AtspiComponent instance indicates its
relative stacking order with respect to the onscreen visual representation
of the UI. AtspiComponentLayer, in combination with AtspiComponent 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 AtspiComponentLayer
categories support further z-ordering information, with respect to their
peers in the same layer: namely, ATSPI_LAYER_WINDOW
and
ATSPI_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: ATSPI_LAYER_BACKGROUND
, ATSPI_LAYER_WINDOW
, ATSPI_LAYER_MDI
,
ATSPI_LAYER_CANVAS
, ATSPI_LAYER_WIDGET
, ATSPI_LAYER_POPUP
, and
ATSPI_LAYER_OVERLAY
.
Indicates an error condition or uninitialized value. | |
The bottom-most layer, over which everything else is painted. The 'desktop background' is generally in this layer. | |
The 'background' layer for most content renderers and UI AtspiComponent containers. | |
The layer in which the majority of ordinary 'foreground' widgets reside. | |
A special layer between ATSPI_LAYER_CANVAS and
ATSPI_LAYER_WIDGET , in which the 'pseudo windows' (e.g. the MDI frames)
reside. See atspi_component_get_mdi_z_order.
|
|
A layer for popup window content, above
ATSPI_LAYER_WIDGET .
|
|
The topmost layer. | |
The layer in which a toplevel window background usually resides. | |
Used only to determine the end of the enumeration. |
ATSPI_COMPONENTLAYER_COUNT
#define ATSPI_COMPONENTLAYER_COUNT (8+1)
One higher than the highest valid value of AtspiComponentLayer.
enum AtspiTextBoundaryType
typedef enum { ATSPI_TEXT_BOUNDARY_CHAR, ATSPI_TEXT_BOUNDARY_WORD_START, ATSPI_TEXT_BOUNDARY_WORD_END, ATSPI_TEXT_BOUNDARY_SENTENCE_START, ATSPI_TEXT_BOUNDARY_SENTENCE_END, ATSPI_TEXT_BOUNDARY_LINE_START, ATSPI_TEXT_BOUNDARY_LINE_END, } AtspiTextBoundaryType;
Specifies the boundary conditions determining a run of text as returned from atspi_text_get_text_at_offset, atspi_text_get_text_after_offset, and atspi_text_get_text_before_offset.
This enumerationis deprecated since 2.9.90 and should not be used. Use AtspiTextGranularity with atspi_text_get_string_at_offset instead.
An AtspiText instance is bounded by this character only. Start and end offsets differ by one, by definition, for this value. | |
Boundary condition is start of a word; i.e. range is from start of one word to the start of another word. | |
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. | |
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. | |
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. | |
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. | |
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. |
ATSPI_TEXT_BOUNDARY_TYPE_COUNT
#define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)
One higher than the highest valid value of AtspiTextBoundaryType.
enum AtspiTextClipType
typedef enum { ATSPI_TEXT_CLIP_NONE, ATSPI_TEXT_CLIP_MIN, ATSPI_TEXT_CLIP_MAX, ATSPI_TEXT_CLIP_BOTH, } AtspiTextClipType;
Enumeration used by interface AtspiText to indicate how to treat characters intersecting bounding boxes.
No characters/glyphs are omitted. | |
Characters/glyphs clipped by the minimum coordinate are omitted. | |
Characters/glyphs which intersect the maximum coordinate are omitted. | |
Only glyphs falling entirely within the region bounded by min and max are retained. |
ATSPI_TEXT_CLIP_TYPE_COUNT
#define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1)
One higher than the highest valid value of AtspiTextClipType.
enum AtspiStateType
typedef enum { ATSPI_STATE_INVALID, ATSPI_STATE_ACTIVE, ATSPI_STATE_ARMED, ATSPI_STATE_BUSY, ATSPI_STATE_CHECKED, ATSPI_STATE_COLLAPSED, ATSPI_STATE_DEFUNCT, ATSPI_STATE_EDITABLE, ATSPI_STATE_ENABLED, ATSPI_STATE_EXPANDABLE, ATSPI_STATE_EXPANDED, ATSPI_STATE_FOCUSABLE, ATSPI_STATE_FOCUSED, ATSPI_STATE_HAS_TOOLTIP, ATSPI_STATE_HORIZONTAL, ATSPI_STATE_ICONIFIED, ATSPI_STATE_MODAL, ATSPI_STATE_MULTI_LINE, ATSPI_STATE_MULTISELECTABLE, ATSPI_STATE_OPAQUE, ATSPI_STATE_PRESSED, ATSPI_STATE_RESIZABLE, ATSPI_STATE_SELECTABLE, ATSPI_STATE_SELECTED, ATSPI_STATE_SENSITIVE, ATSPI_STATE_SHOWING, ATSPI_STATE_SINGLE_LINE, ATSPI_STATE_STALE, ATSPI_STATE_TRANSIENT, ATSPI_STATE_VERTICAL, ATSPI_STATE_VISIBLE, ATSPI_STATE_MANAGES_DESCENDANTS, ATSPI_STATE_INDETERMINATE, ATSPI_STATE_REQUIRED, ATSPI_STATE_TRUNCATED, ATSPI_STATE_ANIMATED, ATSPI_STATE_INVALID_ENTRY, ATSPI_STATE_SUPPORTS_AUTOCOMPLETION, ATSPI_STATE_SELECTABLE_TEXT, ATSPI_STATE_IS_DEFAULT, ATSPI_STATE_VISITED, ATSPI_STATE_LAST_DEFINED, } AtspiStateType;
Enumeration used by various interfaces indicating every possible state an AtspiAccesible object can assume.
Indicates an invalid state - probably an error condition. | |
Indicates a window is currently the active window, or is an active subelement within a container or table. | |
Indicates that the object is armed. | |
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. | |
Indicates this object is currently checked. | |
Indicates this object is collapsed. | |
Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed). | |
Indicates the user can change the contents of this object. | |
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 ATSPI_STATE_SENSITIVE if direct
user interaction cannot cause them to acquire ATSPI_STATE_ENABLED .
See ATSPI_STATE_SENSITIVE .
|
|
Indicates this object allows progressive disclosure of its children. | |
Indicates this object is expanded. | |
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. | |
Indicates this object currently has the keyboard focus. | |
Indicates that the object has an associated tooltip. | |
Indicates the orientation of this object is horizontal. | |
Indicates this object is minimized and is represented only by an icon. | |
Indicates something must be done with this object before the user can interact with an object in a different window. | |
Indicates this (text) object can contain multiple lines of text. | |
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. | |
Indicates this object paints every pixel within its rectangular region. It also indicates an alpha value of unity, if it supports alpha blending. | |
Indicates this object is currently pressed. | |
Indicates the size of this object's size is not fixed. | |
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. | |
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. | |
Indicates this object is sensitive, e.g. to user
interaction. ATSPI_STATE_SENSITIVE usually accompanies.
ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the
absence of ATSPI_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 ATSPI_STATE_SENSITIVE ,
for instance if a user makes an explicit selection using an object whose
current state is ambiguous or undefined. See ATSPI_STATE_ENABLED ,
ATSPI_STATE_INDETERMINATE .
|
|
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. | |
Indicates this (text) object can contain only a single line of text. | |
Indicates that the information returned for this object
may no longer be synchronized with the application state. This can occur
if the object has ATSPI_STATE_TRANSIENT , and can also occur towards the
end of the object peer's lifecycle.
|
|
Indicates this object is transient. | |
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. | |
Indicates this object is visible, e.g. has been
explicitly marked for exposure to the user. ATSPI_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
ATSPI_STATE_VISIBLE and ATSPI_STATE_SHOWING . The absence of
ATSPI_STATE_VISIBLE and ATSPI_STATE_SHOWING is
semantically equivalent to saying that an object is 'hidden'.
|
|
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
ATSPI_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.
|
|
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
ATSPI_STATE_INDETERMINATE if the currently selected text contains a mixture
of weight attributes. In many cases interacting with a
ATSPI_STATE_INDETERMINATE object will cause the context's corresponding
boolean attribute to be homogenized, whereupon the object will lose
ATSPI_STATE_INDETERMINATE and a corresponding state-changed event will be
fired.
|
|
Indicates that user interaction with this object is 'required' from the user, for instance before completing the processing of a form. | |
Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell. | |
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. | |
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. | |
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 AtspiSelection. 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. | |
This state indicates that the object in
question supports text selection. It should only be exposed on objects
which implement the AtspiText interface, in order to distinguish this state
from ATSPI_STATE_SELECTABLE , which infers that the object in question is a
selectable child of an object which implements AtspiSelection. While
similar, text selection and subelement selection are distinct operations.
|
|
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. | |
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. | |
This value of the enumeration should not be used as a parameter, it indicates the number of items in the AtspiStateType enumeration. |
ATSPI_STATETYPE_COUNT
#define ATSPI_STATETYPE_COUNT (41+1)
One higher than the highest valid value of AtspiStateType.
enum AtspiKeyEventType
typedef enum { ATSPI_KEY_PRESSED, ATSPI_KEY_RELEASED, } AtspiKeyEventType;
Deprecated. Should not be used.
ATSPI_KEYEVENTTYPE_COUNT
#define ATSPI_KEYEVENTTYPE_COUNT (1+1)
One higher than the highest valid value of AtspiKeyEventType.
enum AtspiEventType
typedef enum { ATSPI_KEY_PRESSED_EVENT, ATSPI_KEY_RELEASED_EVENT, ATSPI_BUTTON_PRESSED_EVENT, ATSPI_BUTTON_RELEASED_EVENT, } AtspiEventType;
Enumeration used to specify the event types of interest to an AtspiEventListener, or to identify the type of an event for which notification has been sent.
Indicates that a key on a keyboard device was pressed. | |
Indicates that a key on a keyboard device was released. | |
Indicates that a button on a non-keyboard human interface device (HID) was pressed. | |
Indicates that a button on a non-keyboard human interface device (HID) was released. |
ATSPI_EVENTTYPE_COUNT
#define ATSPI_EVENTTYPE_COUNT (3+1)
One higher than the highest valid value of AtspiEventType.
enum AtspiKeySynthType
typedef enum { ATSPI_KEY_PRESS, ATSPI_KEY_RELEASE, ATSPI_KEY_PRESSRELEASE, ATSPI_KEY_SYM, ATSPI_KEY_STRING, } AtspiKeySynthType;
Enumeration used when synthesizing keyboard input via atspi_generate_keyboard_event.
Emulates the pressing of a hardware keyboard key. | |
Emulates the release of a hardware keyboard key. | |
Emulates the pressing and immediate releasing of a hardware keyboard key. | |
A symbolic key event is generated, without specifying a hardware key. Note: if the keysym is not present in the current keyboard map, the AtspiDeviceEventController 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 keysyms 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). | |
A string is converted to its equivalent keyboard events
and emitted. If the string consists of complex characters or composed
characters which are not in the current keymap, string emission is
subject to the out-of-keymap limitations described for
ATSPI_KEY_SYM . In practice this limitation primarily effects
Chinese and Japanese locales.
|
ATSPI_KEYSYNTHTYPE_COUNT
#define ATSPI_KEYSYNTHTYPE_COUNT (4+1)
One higher than the highest valid value of AtspiKeySynthType.
enum AtspiModifierType
typedef enum { ATSPI_MODIFIER_SHIFT, ATSPI_MODIFIER_SHIFTLOCK, ATSPI_MODIFIER_CONTROL, ATSPI_MODIFIER_ALT, ATSPI_MODIFIER_META, ATSPI_MODIFIER_META2, ATSPI_MODIFIER_META3, ATSPI_MODIFIER_NUMLOCK = 14, } AtspiModifierType;
The left or right 'Shift' key. | |
The ShiftLock or CapsLock key. | |
'Control'/'Ctrl'. | |
The Alt key (as opposed to AltGr). | |
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 ATSPI_MODIFIER_META2 means that the 'Mod2Mask' bit
is set in the corresponding XEvent.
|
|
See ATSPI_MODIFIER_META .
|
|
See ATSPI_MODIFIER_META .
|
|
A symbolic meta key name that is mapped by AT-SPI to the appropriate META value, for the convenience of the client. |
ATSPI_MODIFIERTYPE_COUNT
#define ATSPI_MODIFIERTYPE_COUNT (7+1)
One higher than the highest valid value of AtspiModifierType.
enum AtspiRelationType
typedef enum { ATSPI_RELATION_NULL, ATSPI_RELATION_LABEL_FOR, ATSPI_RELATION_LABELLED_BY, ATSPI_RELATION_CONTROLLER_FOR, ATSPI_RELATION_CONTROLLED_BY, ATSPI_RELATION_MEMBER_OF, ATSPI_RELATION_TOOLTIP_FOR, ATSPI_RELATION_NODE_CHILD_OF, ATSPI_RELATION_NODE_PARENT_OF, ATSPI_RELATION_EXTENDED, ATSPI_RELATION_FLOWS_TO, ATSPI_RELATION_FLOWS_FROM, ATSPI_RELATION_SUBWINDOW_OF, ATSPI_RELATION_EMBEDS, ATSPI_RELATION_EMBEDDED_BY, ATSPI_RELATION_POPUP_FOR, ATSPI_RELATION_PARENT_WINDOW_OF, ATSPI_RELATION_DESCRIPTION_FOR, ATSPI_RELATION_DESCRIBED_BY, ATSPI_RELATION_LAST_DEFINED, } AtspiRelationType;
AtspiRelationType 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
ATSPI_RELATION_LABELLED_BY
relationship may be used to identify labelling information that should
accompany the accessible name property when presenting an object's content or
identity to the end user. Similarly,
ATSPI_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.
Enumeration used to specify the type of relation encapsulated in an AtspiRelation object.
Not a meaningful relationship; clients should not normally encounter this AtspiRelationType value. | |
Object is a label for one or more other objects. | |
Object is labelled by one or more other objects. | |
Object is an interactive object which modifies the state, onscreen location, or other attributes of one or more target objects. | |
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 ATSPI_RELATION_CONTROLLED_BY
scrollbars.
|
|
Object has a grouping relationship (e.g. 'same group as') to one or more other objects. | |
Object is a tooltip associated with another object. | |
Object is a child of the target. | |
Object is a parent of the target. | |
Used to indicate that a relationship exists, but its type is not specified in the enumeration. | |
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. | |
Reciprocal of ATSPI_RELATION_FLOWS_TO .
|
|
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. | |
Similar to ATSPI_RELATION_SUBWINDOW_OF , but
specifically used for cross-process embedding.
|
|
Reciprocal of ATSPI_RELATION_EMBEDS . Used to
denote content rendered by embedded renderers that live in a separate process
space from the embedding context.
|
|
Denotes that the object is a transient window or
frame associated with another onscreen object. Similar to ATSPI_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 an ATSPI_ROLE_WINDOW
object with the ATSPI_RELATION_POPUP_FOR relation usually requires
some presentation action on the part
of assistive technology clients, even though the previous toplevel
ATSPI_ROLE_FRAME object may still be the active window.
|
|
This is the reciprocal relation to
ATSPI_RELATION_POPUP_FOR .
|
|
Indicates that an object provides
descriptive information about another object; more verbose than
ATSPI_RELATION_LABEL_FOR .
|
|
Indicates that another object provides
descriptive information about this object; more verbose than
ATSPI_RELATION_LABELLED_BY .
|
|
Do not use as a parameter value, used to determine the size of the enumeration. |
ATSPI_RELATIONTYPE_COUNT
#define ATSPI_RELATIONTYPE_COUNT (19+1)
One higher than the highest valid value of AtspiRelationType.
enum AtspiRole
typedef enum { ATSPI_ROLE_INVALID, ATSPI_ROLE_ACCELERATOR_LABEL, ATSPI_ROLE_ALERT, ATSPI_ROLE_ANIMATION, ATSPI_ROLE_ARROW, ATSPI_ROLE_CALENDAR, ATSPI_ROLE_CANVAS, ATSPI_ROLE_CHECK_BOX, ATSPI_ROLE_CHECK_MENU_ITEM, ATSPI_ROLE_COLOR_CHOOSER, ATSPI_ROLE_COLUMN_HEADER, ATSPI_ROLE_COMBO_BOX, ATSPI_ROLE_DATE_EDITOR, ATSPI_ROLE_DESKTOP_ICON, ATSPI_ROLE_DESKTOP_FRAME, ATSPI_ROLE_DIAL, ATSPI_ROLE_DIALOG, ATSPI_ROLE_DIRECTORY_PANE, ATSPI_ROLE_DRAWING_AREA, ATSPI_ROLE_FILE_CHOOSER, ATSPI_ROLE_FILLER, ATSPI_ROLE_FOCUS_TRAVERSABLE, ATSPI_ROLE_FONT_CHOOSER, ATSPI_ROLE_FRAME, ATSPI_ROLE_GLASS_PANE, ATSPI_ROLE_HTML_CONTAINER, ATSPI_ROLE_ICON, ATSPI_ROLE_IMAGE, ATSPI_ROLE_INTERNAL_FRAME, ATSPI_ROLE_LABEL, ATSPI_ROLE_LAYERED_PANE, ATSPI_ROLE_LIST, ATSPI_ROLE_LIST_ITEM, ATSPI_ROLE_MENU, ATSPI_ROLE_MENU_BAR, ATSPI_ROLE_MENU_ITEM, ATSPI_ROLE_OPTION_PANE, ATSPI_ROLE_PAGE_TAB, ATSPI_ROLE_PAGE_TAB_LIST, ATSPI_ROLE_PANEL, ATSPI_ROLE_PASSWORD_TEXT, ATSPI_ROLE_POPUP_MENU, ATSPI_ROLE_PROGRESS_BAR, ATSPI_ROLE_PUSH_BUTTON, ATSPI_ROLE_RADIO_BUTTON, ATSPI_ROLE_RADIO_MENU_ITEM, ATSPI_ROLE_ROOT_PANE, ATSPI_ROLE_ROW_HEADER, ATSPI_ROLE_SCROLL_BAR, ATSPI_ROLE_SCROLL_PANE, ATSPI_ROLE_SEPARATOR, ATSPI_ROLE_SLIDER, ATSPI_ROLE_SPIN_BUTTON, ATSPI_ROLE_SPLIT_PANE, ATSPI_ROLE_STATUS_BAR, ATSPI_ROLE_TABLE, ATSPI_ROLE_TABLE_CELL, ATSPI_ROLE_TABLE_COLUMN_HEADER, ATSPI_ROLE_TABLE_ROW_HEADER, ATSPI_ROLE_TEAROFF_MENU_ITEM, ATSPI_ROLE_TERMINAL, ATSPI_ROLE_TEXT, ATSPI_ROLE_TOGGLE_BUTTON, ATSPI_ROLE_TOOL_BAR, ATSPI_ROLE_TOOL_TIP, ATSPI_ROLE_TREE, ATSPI_ROLE_TREE_TABLE, ATSPI_ROLE_UNKNOWN, ATSPI_ROLE_VIEWPORT, ATSPI_ROLE_WINDOW, ATSPI_ROLE_EXTENDED, ATSPI_ROLE_HEADER, ATSPI_ROLE_FOOTER, ATSPI_ROLE_PARAGRAPH, ATSPI_ROLE_RULER, ATSPI_ROLE_APPLICATION, ATSPI_ROLE_AUTOCOMPLETE, ATSPI_ROLE_EDITBAR, ATSPI_ROLE_EMBEDDED, ATSPI_ROLE_ENTRY, ATSPI_ROLE_CHART, ATSPI_ROLE_CAPTION, ATSPI_ROLE_DOCUMENT_FRAME, ATSPI_ROLE_HEADING, ATSPI_ROLE_PAGE, ATSPI_ROLE_SECTION, ATSPI_ROLE_REDUNDANT_OBJECT, ATSPI_ROLE_FORM, ATSPI_ROLE_LINK, ATSPI_ROLE_INPUT_METHOD_WINDOW, ATSPI_ROLE_TABLE_ROW, ATSPI_ROLE_TREE_ITEM, ATSPI_ROLE_DOCUMENT_SPREADSHEET, ATSPI_ROLE_DOCUMENT_PRESENTATION, ATSPI_ROLE_DOCUMENT_TEXT, ATSPI_ROLE_DOCUMENT_WEB, ATSPI_ROLE_DOCUMENT_EMAIL, ATSPI_ROLE_COMMENT, ATSPI_ROLE_LIST_BOX, ATSPI_ROLE_GROUPING, ATSPI_ROLE_IMAGE_MAP, ATSPI_ROLE_NOTIFICATION, ATSPI_ROLE_INFO_BAR, ATSPI_ROLE_LEVEL_BAR, ATSPI_ROLE_LAST_DEFINED, } AtspiRole;
Enumeration used by interface AtspiAccessible to specify the role of an AtspiAccessible object.
A role indicating an error condition, such as uninitialized Role data. | |
Object is a label indicating the keyboard accelerators for the parent. | |
Object is used to alert the user about something. | |
Object contains a dynamic or moving image of some kind. | |
Object is a 2d directional indicator. | |
Object contains one or more dates, usually arranged into a 2d list. | |
Object that can be drawn into and is used to trap events. | |
A choice that can be checked or unchecked and provides a separate indicator for the current state. | |
A menu item that behaves like a check box. See
ATSPI_ROLE_CHECK_BOX .
|
|
A specialized dialog that lets the user choose a color. | |
The header for a column of data. | |
A list of choices the user can select from. | |
An object which allows entry of a date. | |
An inconifed internal frame within a DESKTOP_PANE. | |
A pane that supports internal frames and iconified versions of those internal frames. | |
An object that allows a value to be changed via rotating a visual element, or which displays a value via such a rotating element. | |
A top level window with title bar and a border. | |
A pane that allows the user to navigate through and select the contents of a directory. | |
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. | |
An object used for drawing custom user interface elements. | |
A object that fills up space in a user interface. | |
Don't use, reserved for future use. | |
Allows selection of a display font. | |
A top level window with a title bar, border, menubar, etc. | |
A pane that is guaranteed to be painted on top of all panes beneath it. | |
A document container for HTML, whose children represent the document content. | |
A small fixed size picture, typically used to decorate components. | |
An image, typically static. | |
A frame-like object that is clipped by a desktop pane. | |
An object used to present an icon or short string in an interface. | |
A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. | |
An object that presents a list of objects to the user and allows the user to select one or more of them. | |
An object that represents an element of a list. | |
An object usually found inside a menu bar that contains a list of actions the user can choose from. | |
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. | |
An object usually contained in a menu that presents an action the user can choose. | |
A specialized pane whose primary use is inside a dialog. | |
An object that is a child of a page tab list. | |
An object that presents a series of panels (or page tabs), one at a time,through some mechanism provided by the object. | |
A generic container that is often used to group objects. | |
A text object uses for passwords, or other places where the text content is not shown visibly to the user. | |
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. | |
An object used to indicate how much of a task has been completed. | |
An object the user can manipulate to tell the application to do something. | |
A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked. | |
Object is both a menu item and a "radio button"
. See ATSPI_ROLE_RADIO_BUTTON .
|
|
A specialized pane that has a glass pane and a layered pane as its children. | |
The header for a row of data. | |
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. | |
An object that allows a user to incrementally view
a large amount of information. ATSPI_ROLE_SCROLL_PANE objects are usually
accompanied by ATSPI_ROLE_SCROLL_BAR controllers, on which the
ATSPI_RELATION_CONTROLLER_FOR and ATSPI_RELATION_CONTROLLED_BY
reciprocal relations are set. See atspi_get_relation_set.
|
|
An object usually contained in a menu to provide a visible and logical separation of the contents in a menu. | |
An object that allows the user to select from a bounded range. | |
An object which allows one of a set of choices to
be selected, and which displays the current choice. Unlike
ATSPI_ROLE_SCROLL_BAR , ATSPI_ROLE_SLIDER objects need not control
'viewport'-like objects.
|
|
A specialized panel that presents two other panels at the same time. | |
Object displays non-quantitative status information
(c.f. ATSPI_ROLE_PROGRESS_BAR )
|
|
An object used to repesent information in terms of rows and columns. | |
A 'cell' or discrete child within a Table. Note:
Table cells need not have ATSPI_ROLE_TABLE_CELL , other
AtspiRoleType values are valid as well.
|
|
An object which labels a particular column in an AtspiTable. | |
An object which labels a particular row in a
AtspiTable. AtspiTable rows and columns may also be labelled via the
ATSPI_RELATION_LABEL_FOR /ATSPI_RELATION_LABELLED_BY relationships.
See atspi_get_relation_set.
|
|
Object allows menu to be removed from menubar and shown in its own window. | |
An object that emulates a terminal. | |
An object that presents text to the user, of nonspecific type. | |
A specialized push button that can be checked or unchecked, but does not procide a separate indicator for the current state. | |
A bar or palette usually composed of push buttons or toggle buttons. | |
An object that provides information about another object. | |
An object used to repsent hierarchical information to the user. | |
An object that presents both tabular and hierarchical info to the user. | |
The object contains some AtspiAccessible information, but its role is not known. | |
An object usually used in a scroll pane, or to otherwise clip a larger object or content renderer to a specific onscreen viewport. | |
A top level window with no title or border. | |
means that the role for this item is known, but not included in the core enumeration. | |
An object that serves as a document header. | |
An object that serves as a document footer. | |
An object which is contains a single paragraph of
text content. See also ATSPI_ROLE_TEXT .
|
|
An object which describes margins and tab stops, etc.
for text objects which it controls (should have
ATSPI_RELATION_CONTROLLER_FOR relation to such).
|
|
An object corresponding to the toplevel accessible
of an application, which may contain ATSPI_ROLE_FRAME objects or other
accessible objects. Children of AccessibleDesktop objects are generally
ATSPI_ROLE_APPLICATION objects.
|
|
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. | |
The object is an editable text object in a toolbar. | |
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. | |
The object is a component whose textual content may be
entered or modified by the user, provided ATSPI_STATE_EDITABLE is present.
A readonly ATSPI_ROLE_ENTRY object (i.e. where ATSPI_STATE_EDITABLE is
not present) implies a read-only 'text field' in a form, as opposed to a
title, label, or caption.
|
|
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 ATSPI_LABELLED_BY relation is
particularly important in interpreting objects of this type, as is the
accessible description property. See ATSPI_ROLE_CAPTION .
|
|
The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. | |
The object is a visual frame or container which contains a view of document content. AtspiDocument frames may occur within another AtspiDocument instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often | |
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. | |
The object is a containing instance which encapsulates a
page of information. ATSPI_ROLE_PAGE is used in documents and content which
support a paginated navigation model.
|
|
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. | |
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. | |
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. ATSPI_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, ATSPI_ROLE_FORM containers' components are
associated with the current document, rather than the current foreground
application or viewer instance.
|
|
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 AtspiHypertext/AtspiHyperlink interfacesto indicate the range/location within a text object where an inline or embedded object lies. | |
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". | |
A row in a table. | |
An object that represents an element of a tree. | |
A document frame which contains a spreadsheet. | |
A document frame which contains a presentation or slide content. | |
A document frame which contains textual content, such as found in a word processing application. | |
A document frame which contains HTML or other markup suitable for display in a web browser. | |
A document frame which contains email content to be displayed or composed either in plain text or HTML. | |
An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated. | |
A non-collapsible list of choices the user can select from. | |
A group of related widgets. This group typically has a label. | |
An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. | |
A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. | |
An object designed to present a message to the user within an existing window. | |
A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. Since: 2.8 | |
Not a valid role, used for finding end of enumeration. |
ATSPI_ROLE_COUNT
#define ATSPI_ROLE_COUNT (90+1)
One higher than the highest valid value of AtspiRole.