atspi-constants

## atspi-constants atspi-constants |

## 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

## Description

## 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;

### ATSPI_LOCALE_TYPE

    #define ATSPI_LOCALE_TYPE _COUNT(5+1)

Used by Text and Document interfaces these correspond to the POSIX 'setlocale' enum values.

Bitfield/set of flags generated from the AT-SPI specification.

`ATSPI_LOCALE_TYPE_MESSAGES` : |
`ATSPI_LOCALE_TYPE_COLLATE` : |
`ATSPI_LOCALE_TYPE_CTYPE` : |
`ATSPI_LOCALE_TYPE_MONETARY` : |
`ATSPI_LOCALE_TYPE_NUMERIC` : |
`ATSPI_LOCALE_TYPE_TIME` : |

### enum AtspiCoordType

    typedef enum {
        ATSPI_COORD_TYPE_SCREEN,
        ATSPI_COORD_TYPE_WINDOW,
    } AtspiCoordType;

### ATSPI_COORD_TYPE_COUNT

    #define ATSPI_COORD_TYPE_COUNT (1+1)

1 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;

### ATSPI_SORTORDER_COUNT

    #define ATSPI_SORTORDER_COUNT (7+1)

1 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;

### ATSPI_MATCHTYPES_COUNT

    #define ATSPI_MATCHTYPES_COUNT (5+1)

### enum AtspiCollectionTreeTraversalType

    typedef enum {
        ATSPI_Collection_TREE_RESTRICT_CHILDREN,
        ATSPI_Collection_TREE_RESTRICT_SIBLING,
        ATSPI_Collection_TREE_INORDER,
        ATSPI_Collection_TREE_LAST_DEFINED,
    } AtspiCollectionTreeTraversalType;

### ATSPI_TREETRAVERSALTYPE

    #define ATSPI_TREETRAVERSALTYPE _COUNT(3+1)

### 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;

### ATSPI_COMPONENTLAYER_COUNT

    #define ATSPI_COMPONENTLAYER_COUNT (8+1)

### 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;

### ATSPI_TEXT_BOUNDARY_TYPE_COUNT

    #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1)

1 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;

### ATSPI_TEXT_CLIP_TYPE_COUNT

    #define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1)

1 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;

### ATSPI_STATETYPE_COUNT

    #define ATSPI_STATETYPE_COUNT (41+1)

1 higher than the highest valid value of AtspiStateType.

### enum AtspiKeyEventType

    typedef enum {
        ATSPI_KEY_PRESSED,
        ATSPI_KEY_RELEASED,
    } AtspiKeyEventType;

### ATSPI_KEYEVENTTYPE_COUNT

    #define ATSPI_KEYEVENTTYPE_COUNT (1+1)

1 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;

### ATSPI_EVENTTYPE_COUNT

    #define ATSPI_EVENTTYPE_COUNT (3+1)

1 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;

Used when synthesizing keyboard input via DeviceEventController:GenerateKeyboardEvent.

Bitfield/set of flags generated from the AT-SPI specification.

`ATSPI_KEY_PRESS` | emulate the pressing of a hardware keyboard key.
`ATSPI_KEY_RELEASE` | emulate the release of a hardware keyboard key.
`ATSPI_KEY_PRESSRELEASE` | a hardware keyboard key is pressed and immediately released.
`ATSPI_KEY_SYM` | 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.
`ATSPI_KEY_STRING` | 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.

### ATSPI_KEYSYNTHTYPE_COUNT

    #define ATSPI_KEYSYNTHTYPE_COUNT (4+1)

1 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,
    } AtspiModifierType;

### ATSPI_MODIFIERTYPE_COUNT

    #define ATSPI_MODIFIERTYPE_COUNT (7+1)

1 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;

### ATSPI_RELATIONTYPE_COUNT

    #define ATSPI_RELATIONTYPE_COUNT (19+1)

1 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_LAST_DEFINED,
    } AtspiRole;

### ATSPI_ROLE_COUNT

    #define ATSPI_ROLE_COUNT (90+1)

1 higher than the highest valid value of AtspiRole.