| atspi-constants.h | | atspi-constants.h | |
| | | | |
| skipping to change at line 69 | | skipping to change at line 69 | |
| | | | |
| #ifndef _ATSPI_CONSTANTS_H_ | | #ifndef _ATSPI_CONSTANTS_H_ | |
| #define _ATSPI_CONSTANTS_H_ | | #define _ATSPI_CONSTANTS_H_ | |
| #ifdef __cplusplus | | #ifdef __cplusplus | |
| extern "C" { | | extern "C" { | |
| #endif | | #endif | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_LOCALE_TYPE: | | ATSPI_LOCALE_TYPE: | |
|
| * @ATSPI_LOCALE_TYPE_MESSAGES: <![CDATA[]]> | | * @ATSPI_LOCALE_TYPE_MESSAGES: | |
| * @ATSPI_LOCALE_TYPE_COLLATE: <![CDATA[]]> | | * @ATSPI_LOCALE_TYPE_COLLATE: | |
| * @ATSPI_LOCALE_TYPE_CTYPE: <![CDATA[]]> | | * @ATSPI_LOCALE_TYPE_CTYPE: | |
| * @ATSPI_LOCALE_TYPE_MONETARY: <![CDATA[]]> | | * @ATSPI_LOCALE_TYPE_MONETARY: | |
| * @ATSPI_LOCALE_TYPE_NUMERIC: <![CDATA[]]> | | * @ATSPI_LOCALE_TYPE_NUMERIC: | |
| * @ATSPI_LOCALE_TYPE_TIME: <![CDATA[]]> | | * @ATSPI_LOCALE_TYPE_TIME: | |
| * | | * | |
|
| * <![CDATA[ Used by Text and Document interfaces these correspond to the | | * Used by Text and Document interfaces these correspond to the POSIX | |
| POSIX 'setlocale' enum values. ]]> | | * 'setlocale' enum values. | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_LOCALE_TYPE_MESSAGES, | | ATSPI_LOCALE_TYPE_MESSAGES, | |
| ATSPI_LOCALE_TYPE_COLLATE, | | ATSPI_LOCALE_TYPE_COLLATE, | |
| ATSPI_LOCALE_TYPE_CTYPE, | | ATSPI_LOCALE_TYPE_CTYPE, | |
| ATSPI_LOCALE_TYPE_MONETARY, | | ATSPI_LOCALE_TYPE_MONETARY, | |
| ATSPI_LOCALE_TYPE_NUMERIC, | | ATSPI_LOCALE_TYPE_NUMERIC, | |
| ATSPI_LOCALE_TYPE_TIME, | | ATSPI_LOCALE_TYPE_TIME, | |
| | | | |
| skipping to change at line 99 | | skipping to change at line 100 | |
| /** | | /** | |
| * ATSPI_LOCALE_TYPE_COUNT: | | * ATSPI_LOCALE_TYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiLocaleType. | | * 1 higher than the highest valid value of #AtspiLocaleType. | |
| */ | | */ | |
| #define ATSPI_LOCALE_TYPE _COUNT(5+1) | | #define ATSPI_LOCALE_TYPE _COUNT(5+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_COORD_TYPE: | | ATSPI_COORD_TYPE: | |
|
| * @ATSPI_COORD_TYPE_SCREEN: <![CDATA[]]> | | * @ATSPI_COORD_TYPE_SCREEN: | |
| * @ATSPI_COORD_TYPE_WINDOW: <![CDATA[]]> | | * @ATSPI_COORD_TYPE_WINDOW: | |
| * | | * | |
|
| * <![CDATA[ Used by Component, Image, and Text interfaces to specify whe | | * Used by Component, Image, and Text interfaces to specify whether coordin | |
| ther coordinates are relative to the window or the screen. ]]> | | ates | |
| | | * are relative to the window or the screen. | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_COORD_TYPE_SCREEN, | | ATSPI_COORD_TYPE_SCREEN, | |
| ATSPI_COORD_TYPE_WINDOW, | | ATSPI_COORD_TYPE_WINDOW, | |
| } AtspiCoordType; | | } AtspiCoordType; | |
| | | | |
| /** | | /** | |
| * ATSPI_COORD_TYPE_COUNT: | | * ATSPI_COORD_TYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiCoordType. | | * 1 higher than the highest valid value of #AtspiCoordType. | |
| */ | | */ | |
| #define ATSPI_COORD_TYPE_COUNT (1+1) | | #define ATSPI_COORD_TYPE_COUNT (1+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_Collection_SortOrder: | | ATSPI_Collection_SortOrder: | |
|
| * @ATSPI_Collection_SORT_ORDER_INVALID: <![CDATA[]]> | | * @ATSPI_Collection_SORT_ORDER_INVALID: | |
| * @ATSPI_Collection_SORT_ORDER_CANONICAL: <![CDATA[]]> | | * @ATSPI_Collection_SORT_ORDER_CANONICAL: | |
| * @ATSPI_Collection_SORT_ORDER_FLOW: <![CDATA[]]> | | * @ATSPI_Collection_SORT_ORDER_FLOW: | |
| * @ATSPI_Collection_SORT_ORDER_TAB: <![CDATA[]]> | | * @ATSPI_Collection_SORT_ORDER_TAB: | |
| * @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL: <![CDATA[]]> | | * @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL: | |
| * @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW: <![CDATA[]]> | | * @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW: | |
| * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB: <![CDATA[]]> | | * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB: | |
| * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED: <![CDATA[]]> | | * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED: | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_Collection_SORT_ORDER_INVALID, | | ATSPI_Collection_SORT_ORDER_INVALID, | |
| ATSPI_Collection_SORT_ORDER_CANONICAL, | | ATSPI_Collection_SORT_ORDER_CANONICAL, | |
| ATSPI_Collection_SORT_ORDER_FLOW, | | ATSPI_Collection_SORT_ORDER_FLOW, | |
| ATSPI_Collection_SORT_ORDER_TAB, | | ATSPI_Collection_SORT_ORDER_TAB, | |
| ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL, | | ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL, | |
| ATSPI_Collection_SORT_ORDER_REVERSE_FLOW, | | ATSPI_Collection_SORT_ORDER_REVERSE_FLOW, | |
| | | | |
| skipping to change at line 153 | | skipping to change at line 155 | |
| /** | | /** | |
| * ATSPI_SORTORDER_COUNT: | | * ATSPI_SORTORDER_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiCollectionSortOrder. | | * 1 higher than the highest valid value of #AtspiCollectionSortOrder. | |
| */ | | */ | |
| #define ATSPI_SORTORDER_COUNT (7+1) | | #define ATSPI_SORTORDER_COUNT (7+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_Collection_MatchType: | | ATSPI_Collection_MatchType: | |
|
| * @ATSPI_Collection_MATCH_INVALID: <![CDATA[]]> | | * @ATSPI_Collection_MATCH_INVALID: | |
| * @ATSPI_Collection_MATCH_ALL: <![CDATA[]]> | | * @ATSPI_Collection_MATCH_ALL: | |
| * @ATSPI_Collection_MATCH_ANY: <![CDATA[]]> | | * @ATSPI_Collection_MATCH_ANY: | |
| * @ATSPI_Collection_MATCH_NONE: <![CDATA[]]> | | * @ATSPI_Collection_MATCH_NONE: | |
| * @ATSPI_Collection_MATCH_EMPTY: <![CDATA[]]> | | * @ATSPI_Collection_MATCH_EMPTY: | |
| * @ATSPI_Collection_MATCH_LAST_DEFINED: <![CDATA[]]> | | * @ATSPI_Collection_MATCH_LAST_DEFINED: | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_Collection_MATCH_INVALID, | | ATSPI_Collection_MATCH_INVALID, | |
| ATSPI_Collection_MATCH_ALL, | | ATSPI_Collection_MATCH_ALL, | |
| ATSPI_Collection_MATCH_ANY, | | ATSPI_Collection_MATCH_ANY, | |
| ATSPI_Collection_MATCH_NONE, | | ATSPI_Collection_MATCH_NONE, | |
| ATSPI_Collection_MATCH_EMPTY, | | ATSPI_Collection_MATCH_EMPTY, | |
| ATSPI_Collection_MATCH_LAST_DEFINED, | | ATSPI_Collection_MATCH_LAST_DEFINED, | |
| | | | |
| skipping to change at line 181 | | skipping to change at line 183 | |
| /** | | /** | |
| * ATSPI_MATCHTYPE_COUNT: | | * ATSPI_MATCHTYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiCollectionMatchType. | | * 1 higher than the highest valid value of #AtspiCollectionMatchType. | |
| */ | | */ | |
| #define ATSPI_MATCHTYPES_COUNT (5+1) | | #define ATSPI_MATCHTYPES_COUNT (5+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_Collection_TreeTraversalType: | | ATSPI_Collection_TreeTraversalType: | |
|
| * @ATSPI_Collection_TREE_RESTRICT_CHILDREN: <![CDATA[]]> | | * @ATSPI_Collection_TREE_RESTRICT_CHILDREN: | |
| * @ATSPI_Collection_TREE_RESTRICT_SIBLING: <![CDATA[]]> | | * @ATSPI_Collection_TREE_RESTRICT_SIBLING: | |
| * @ATSPI_Collection_TREE_INORDER: <![CDATA[]]> | | * @ATSPI_Collection_TREE_INORDER: | |
| * @ATSPI_Collection_TREE_LAST_DEFINED: <![CDATA[]]> | | * @ATSPI_Collection_TREE_LAST_DEFINED: | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_Collection_TREE_RESTRICT_CHILDREN, | | ATSPI_Collection_TREE_RESTRICT_CHILDREN, | |
| ATSPI_Collection_TREE_RESTRICT_SIBLING, | | ATSPI_Collection_TREE_RESTRICT_SIBLING, | |
| ATSPI_Collection_TREE_INORDER, | | ATSPI_Collection_TREE_INORDER, | |
| ATSPI_Collection_TREE_LAST_DEFINED, | | ATSPI_Collection_TREE_LAST_DEFINED, | |
| } AtspiCollectionTreeTraversalType; | | } AtspiCollectionTreeTraversalType; | |
| | | | |
| /** | | /** | |
| * ATSPI_TREETRAVERSALTYPE_COUNT: | | * ATSPI_TREETRAVERSALTYPE_COUNT: | |
| * | | * | |
|
| * 1 higher than the highest valid value of #AtspiCollection_TreeTraversalT | | * 1 higher than the highest valid value of | |
| ype. | | * #AtspiCollection_TreeTraversalType. | |
| */ | | */ | |
| #define ATSPI_TREETRAVERSALTYPE _COUNT(3+1) | | #define ATSPI_TREETRAVERSALTYPE _COUNT(3+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_ComponentLayer: | | ATSPI_ComponentLayer: | |
|
| * @ATSPI_LAYER_INVALID: <![CDATA[ Indicates an error condition or unin | | * @ATSPI_LAYER_INVALID: Indicates an error condition or uninitialized valu | |
| itialized value. ]]> | | e. | |
| * @ATSPI_LAYER_BACKGROUND: <![CDATA[ The bottom-most layer, over which | | * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything el | |
| everything else is painted. The 'desktop background' is generally i | | se | |
| n this layer. ]]> | | * is painted. The 'desktop background' is generally in this layer. | |
| * @ATSPI_LAYER_CANVAS: <![CDATA[ The 'background' layer for most conte | | * @ATSPI_LAYER_CANVAS: The 'background' layer for most content renderers a | |
| nt renderers and UI Component containers. ]]> | | nd | |
| * @ATSPI_LAYER_WIDGET: <![CDATA[ The layer in which the majority of or | | * UI Component containers. | |
| dinary 'foreground' widgets reside. ]]> | | * @ATSPI_LAYER_WIDGET: The layer in which the majority of ordinary | |
| * @ATSPI_LAYER_MDI: <![CDATA[ A special layer between LAYER_CANVAS and | | * 'foreground' widgets reside. | |
| LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames) re | | * @ATSPI_LAYER_MDI: A special layer between LAYER_CANVAS and LAYER_WIDGET, | |
| side. (See Component.GetMDIZOrder) ]]> | | in | |
| * @ATSPI_LAYER_POPUP: <![CDATA[ A layer for popup window content, abov | | * which the 'pseudo windows' (e.g. the MDI frames) reside. (S | |
| e LAYER_WIDGET. ]]> | | ee | |
| * @ATSPI_LAYER_OVERLAY: <![CDATA[ The topmost layer. ]]> | | * Component.GetMDIZOrder) | |
| * @ATSPI_LAYER_WINDOW: <![CDATA[ The layer in which a toplevel window | | * @ATSPI_LAYER_POPUP: A layer for popup window content, above LAYER_WIDGET | |
| background usually resides. ]]> | | . | |
| * @ATSPI_LAYER_LAST_DEFINED: <![CDATA[ Used only to determine the end | | * @ATSPI_LAYER_OVERLAY: The topmost layer. | |
| of the enumeration. ]]> | | * @ATSPI_LAYER_WINDOW: The layer in which a toplevel window background usu | |
| * | | ally | |
| * <![CDATA[ The ComponentLayer of a Component instance indicates its r | | * resides. | |
| elative stacking order with respect to the onscreen visual representa | | * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the | |
| tion of the UI. ComponentLayer, in combination with Component bounds | | * enumeration. | |
| information, can be used to compute the visibility of all or part of | | * | |
| a component. This is important in programmatic determination of regi | | * The ComponentLayer of a Component instance indicates its relative stacki | |
| on-of-interest for magnification, and in ¨flat screen review | | ng | |
| 8; models of the screen, as well as for other uses. Objects residing | | * order with respect to the onscreen visual representation of the UI | |
| in two of the ComponentLayer categories support further z-ordering in | | . | |
| formation, with respect to their peers in the same layer: namely, LAY | | * ComponentLayer, in combination with Component bounds information, can be | |
| ER_WINDOW and LAYER_MDI. Relative stacking order for other objects within | | used | |
| the same layer is not available; the recommended heuristic is ¨f | | * to compute the visibility of all or part of a component. This is im | |
| irst child paints first¨, in other words, assume that the first | | portant | |
| siblings in the child list are subject to being overpainted by later | | * in programmatic determination of region-of-interest for magnificat | |
| siblings if their bounds intersect. The order of layers, from botto | | ion, | |
| m to top, is: LAYER_BACKGROUND LAYER_ | | * and in ¨flat screen review¨ models of the screen, as wel | |
| WINDOW LAYER_MDI LAYER_CANVAS LAYER_WID | | l as | |
| GET LAYER_POPUP LAYER_OVERLAY ]]> | | * for other uses. Objects residing in two of the ComponentLayer cate | |
| | | gories | |
| | | * support further z-ordering information, with respect to their peer | |
| | | s in | |
| | | * the same layer: namely, LAYER_WINDOW and LAYER_MDI. Relative stac | |
| | | king | |
| | | * order for other objects within the same layer is not available; th | |
| | | e | |
| | | * recommended heuristic is ¨first child paints first¨, in | |
| | | other | |
| | | * words, assume that the first siblings in the child list are subject to b | |
| | | eing | |
| | | * overpainted by later siblings if their bounds intersect. The o | |
| | | rder of | |
| | | * layers, from bottom to top, is: LAYER_BACKGROUND | |
| | | LAYER_WINDOW | |
| | | * LAYER_MDI LAYER_CANVAS LAYER_WIDGET | |
| | | LAYER_POPUP | |
| | | * LAYER_OVERLAY | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_LAYER_INVALID, | | ATSPI_LAYER_INVALID, | |
| ATSPI_LAYER_BACKGROUND, | | ATSPI_LAYER_BACKGROUND, | |
| ATSPI_LAYER_CANVAS, | | ATSPI_LAYER_CANVAS, | |
| ATSPI_LAYER_WIDGET, | | ATSPI_LAYER_WIDGET, | |
| ATSPI_LAYER_MDI, | | ATSPI_LAYER_MDI, | |
| ATSPI_LAYER_POPUP, | | ATSPI_LAYER_POPUP, | |
| | | | |
| skipping to change at line 241 | | skipping to change at line 266 | |
| /** | | /** | |
| * ATSPI_COMPONENTLAYER:_COUNT | | * ATSPI_COMPONENTLAYER:_COUNT | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiComponentLayer. | | * 1 higher than the highest valid value of #AtspiComponentLayer. | |
| */ | | */ | |
| #define ATSPI_COMPONENTLAYER_COUNT (8+1) | | #define ATSPI_COMPONENTLAYER_COUNT (8+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_TEXT_BOUNDARY_TYPE: | | ATSPI_TEXT_BOUNDARY_TYPE: | |
|
| * @ATSPI_TEXT_BOUNDARY_CHAR: <![CDATA[ Text is bounded by this charact | | * @ATSPI_TEXT_BOUNDARY_CHAR: Text is bounded by this character only. | |
| er only. Start and end offsets differ by one, by definition, for thi | | * Start and end offsets differ by one, by definition, for this value. | |
| s value. ]]> | | * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word; | |
| * @ATSPI_TEXT_BOUNDARY_WORD_START: <![CDATA[ Boundary condition is sta | | i.e. | |
| rt of a word; i.e. range is from start of one word to the start of an | | * range is from start of one word to the start of another word. | |
| other word. ]]> | | * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word; | |
| * @ATSPI_TEXT_BOUNDARY_WORD_END: <![CDATA[ Boundary condition is the e | | i.e. | |
| nd of a word; i.e. range is from the end of one word to the end of a | | * range is from the end of one word to the end of another. S | |
| nother. Some locales may not distinguish between words and charac | | ome locales | |
| ters or glyphs, in particular those locales which use wholly or parti | | * may not distinguish between words and characters or glyphs, in par | |
| ally ideographic character sets. In these cases, characters may be r | | ticular | |
| eturned in lieu of multi-character substrings. ]]> | | * those locales which use wholly or partially ideographic character | |
| * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: <![CDATA[ Boundary condition is | | sets. | |
| start of a sentence, as determined by the application. S | | * In these cases, characters may be returned in lieu of multi-charac | |
| ome locales or character sets may not include explicit sentence delim | | ter | |
| iters, so this boundary type can not always be honored. Some locales | | * substrings. | |
| will return lines of text instead of grammatical sentences. ]]> | | * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: Boundary condition is start of a | |
| * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: <![CDATA[ Boundary condition is e | | * sentence, as determined by the application. Some locales o | |
| nd of a sentence, as determined by the application, including t | | r | |
| he sentence-delimiting character, for instance '.' Some locales or ch | | * character sets may not include explicit sentence delimiters, so th | |
| aracter sets may not include explicit sentence delimiters, so this bo | | is | |
| undary type can not always be honored. Some locales will return lines | | * boundary type can not always be honored. Some locales will return | |
| of text instead of grammatical sentences. ]]> | | lines | |
| * @ATSPI_TEXT_BOUNDARY_LINE_START: <![CDATA[ Boundary condition is th | | * of text instead of grammatical sentences. | |
| e start of a line; i.e. range is from start of one line to the start | | * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: Boundary condition is end of a senten | |
| of another. This generally means that an end-of-line character wil | | ce, | |
| l appear at the end of the range. ]]> | | * as determined by the application, including the sentence-delimitin | |
| * @ATSPI_TEXT_BOUNDARY_LINE_END: <![CDATA[ Boundary condition is the | | g | |
| end of a line; i.e. range is from start of one line to the start of a | | * character, for instance '.' Some locales or character sets may not | |
| nother. This generally means that an end-of-line character will be | | * include explicit sentence delimiters, so this boundary type can no | |
| the first character of the range. ]]> | | t | |
| | | * always be honored. Some locales will return lines of text instead | |
| | | of | |
| | | * grammatical sentences. | |
| | | * @ATSPI_TEXT_BOUNDARY_LINE_START: Boundary condition is the start of a li | |
| | | ne; | |
| | | * i.e. range is from start of one line to the start of another. Th | |
| | | is | |
| | | * generally means that an end-of-line character will appear at the | |
| | | end of | |
| | | * the range. | |
| | | * @ATSPI_TEXT_BOUNDARY_LINE_END: Boundary condition is the end of a line; | |
| | | i.e. | |
| | | * range is from start of one line to the start of another. This gen | |
| | | erally | |
| | | * means that an end-of-line character will be the first character of | |
| | | the | |
| | | * range. | |
| * | | * | |
|
| * <![CDATA[ Specifies the boundary conditions determining a run of tex | | * Specifies the boundary conditions determining a run of text as returned | |
| t as returned from GetTextAtOffset, GetTextAfterOffset, and GetTextBe | | from | |
| foreOffset. ]]> | | * GetTextAtOffset, GetTextAfterOffset, and GetTextBeforeOffset. | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_TEXT_BOUNDARY_CHAR, | | ATSPI_TEXT_BOUNDARY_CHAR, | |
| ATSPI_TEXT_BOUNDARY_WORD_START, | | ATSPI_TEXT_BOUNDARY_WORD_START, | |
| ATSPI_TEXT_BOUNDARY_WORD_END, | | ATSPI_TEXT_BOUNDARY_WORD_END, | |
| ATSPI_TEXT_BOUNDARY_SENTENCE_START, | | ATSPI_TEXT_BOUNDARY_SENTENCE_START, | |
| ATSPI_TEXT_BOUNDARY_SENTENCE_END, | | ATSPI_TEXT_BOUNDARY_SENTENCE_END, | |
| ATSPI_TEXT_BOUNDARY_LINE_START, | | ATSPI_TEXT_BOUNDARY_LINE_START, | |
| | | | |
| skipping to change at line 273 | | skipping to change at line 321 | |
| /** | | /** | |
| * ATSPI_TEXT_BOUNDARY_TYPE_COUNT: | | * ATSPI_TEXT_BOUNDARY_TYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiTextBOundaryType. | | * 1 higher than the highest valid value of #AtspiTextBOundaryType. | |
| */ | | */ | |
| #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1) | | #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_TEXT_CLIP_TYPE: | | ATSPI_TEXT_CLIP_TYPE: | |
|
| * @ATSPI_TEXT_CLIP_NONE: <![CDATA[]]> | | * @ATSPI_TEXT_CLIP_NONE: | |
| * @ATSPI_TEXT_CLIP_MIN: <![CDATA[ Characters/glyphs clipped by the min | | * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinat | |
| imum coordinate are omitted ]]> | | e | |
| * @ATSPI_TEXT_CLIP_MAX: <![CDATA[ Characters/glyphs which intersect th | | * are omitted | |
| e maximum coordinate are omitted ]]> | | * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum | |
| * @ATSPI_TEXT_CLIP_BOTH: <![CDATA[ Only glyphs falling entirely within | | * coordinate are omitted | |
| the region bounded by min and max are retained. ]]> | | * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region | |
| * | | * bounded by min and max are retained. | |
| * <![CDATA[ TEXT_CLIP_TYPE: CLIP_MIN means text clipped by min c | | * | |
| oordinate is omitted, CLIP_MAX clips text interescted by the max coor | | * TEXT_CLIP_TYPE: CLIP_MIN means text clipped by min coordinate is | |
| d, and CLIP_BOTH will retain only text falling fully within the min/m | | * omitted, CLIP_MAX clips text interescted by the max coord, and CLI | |
| ax bounds. ]]> | | P_BOTH | |
| | | * will retain only text falling fully within the min/max bounds. | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_TEXT_CLIP_NONE, | | ATSPI_TEXT_CLIP_NONE, | |
| ATSPI_TEXT_CLIP_MIN, | | ATSPI_TEXT_CLIP_MIN, | |
| ATSPI_TEXT_CLIP_MAX, | | ATSPI_TEXT_CLIP_MAX, | |
| ATSPI_TEXT_CLIP_BOTH, | | ATSPI_TEXT_CLIP_BOTH, | |
| } AtspiTextClipType; | | } AtspiTextClipType; | |
| | | | |
| /** | | /** | |
| * ATSPI_TEXT_CLIP_TYPE_COUNT: | | * ATSPI_TEXT_CLIP_TYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiTextClipType. | | * 1 higher than the highest valid value of #AtspiTextClipType. | |
| */ | | */ | |
| #define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1) | | #define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_StateType: | | ATSPI_StateType: | |
|
| * @ATSPI_STATE_INVALID: <![CDATA[]]> | | * @ATSPI_STATE_INVALID: | |
| * @ATSPI_STATE_ACTIVE: <![CDATA[ Indicates a window is currently the a | | * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, | |
| ctive window, or is an active subelement within a container or table ]]> | | or | |
| * @ATSPI_STATE_ARMED: <![CDATA[ Indicates that the object is armed | | * is an active subelement within a container or table | |
| ]]> | | * @ATSPI_STATE_ARMED: Indicates that the object is armed | |
| * @ATSPI_STATE_BUSY: <![CDATA[ Indicates the current object is busy, i | | * @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen | |
| .e. onscreen representation is in the process of changing, or the obj | | * representation is in the process of changing, or the object is | |
| ect is temporarily unavailable for interaction due to activity already in p | | * temporarily unavailable for interaction due to activity already in progr | |
| rogress. ]]> | | ess. | |
| * @ATSPI_STATE_CHECKED: <![CDATA[ Indicates this object is currently c | | * @ATSPI_STATE_CHECKED: Indicates this object is currently checked | |
| hecked ]]> | | * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed | |
| * @ATSPI_STATE_COLLAPSED: <![CDATA[ Indicates this object is collapsed | | * @ATSPI_STATE_DEFUNCT: Indicates that this object no longer has a valid | |
| ]]> | | * backing widget (for instance, if its peer object has been destroy | |
| * @ATSPI_STATE_DEFUNCT: <![CDATA[ Indicates that this object no longer | | ed) | |
| has a valid backing widget (for instance, if its peer object has be | | * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of thi | |
| en destroyed) ]]> | | s | |
| * @ATSPI_STATE_EDITABLE: <![CDATA[ Indicates the user can change the c | | * object | |
| ontents of this object ]]> | | * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that i | |
| * @ATSPI_STATE_ENABLED: <![CDATA[ Indicates that this object is enable | | t | |
| d, i.e. that it currently reflects some application state. Objects t | | * currently reflects some application state. Objects that are "grey | |
| hat are "greyed out" may lack this state, and may lack the STATE_SENSITIVE | | ed out" | |
| if direct user interaction cannot cause them to acquire STATE_ENABLED | | * may lack this state, and may lack the STATE_SENSITIVE if direct user | |
| . @see STATE_SENSITIVE. ]]> | | * interaction cannot cause | |
| * @ATSPI_STATE_EXPANDABLE: <![CDATA[ Indicates this object allows prog | | * them to acquire STATE_ENABLED. @see STATE_SENSITIVE. | |
| ressive disclosure of its children ]]> | | * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive | |
| * @ATSPI_STATE_EXPANDED: <![CDATA[ Indicates this object its expanded | | * disclosure of its children | |
| ]]> | | * @ATSPI_STATE_EXPANDED: Indicates this object is expanded | |
| * @ATSPI_STATE_FOCUSABLE: <![CDATA[ Indicates this object can accept k | | * @ATSPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus, | |
| eyboard focus, which means all events resulting from typing on the ke | | * which means all events resulting from typing on the keyboard will | |
| yboard will normally be passed to it when it has focus ]]> | | * normally be passed to it when it has focus | |
| * @ATSPI_STATE_FOCUSED: <![CDATA[ Indicates this object currently has | | * @ATSPI_STATE_FOCUSED: Indicates this object currently has the keyboard | |
| the keyboard focus ]]> | | * focus | |
| * @ATSPI_STATE_HAS_TOOLTIP: <![CDATA[ Indicates that the object has an | | * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated | |
| associated tooltip ]]> | | * tooltip | |
| * @ATSPI_STATE_HORIZONTAL: <![CDATA[ Indicates the orientation of thsi | | * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of thsi object is | |
| object is horizontal ]]> | | * horizontal | |
| * @ATSPI_STATE_ICONIFIED: <![CDATA[ Indicates this object is minimized | | * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is | |
| and is represented only by an icon ]]> | | * represented only by an icon | |
| * @ATSPI_STATE_MODAL: <![CDATA[ Indicates something must be done with | | * @ATSPI_STATE_MODAL: Indicates something must be done with this object | |
| this object before the user can interact with an object in a differen | | * before the user can interact with an object in a different window. | |
| t window. ]]> | | * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multip | |
| * @ATSPI_STATE_MULTI_LINE: <![CDATA[ Indicates this (text) object can | | le | |
| contain multiple lines of text ]]> | | * lines of text | |
| * @ATSPI_STATE_MULTISELECTABLE: <![CDATA[ Indicates this object allows | | * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one | |
| more than one of its children to be selected at the same time, or in | | of | |
| the case of text objects, that the object supports non-contiguous t | | * its children to be selected at the same time, or in the case of te | |
| ext selections. ]]> | | xt | |
| * @ATSPI_STATE_OPAQUE: <![CDATA[ Indicates this object paints every pi | | * objects, that the object supports non-contiguous text selections. | |
| xel within its rectangular region. It also indicates an alpha value o | | * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its | |
| f unity, if it supports alpha blending. ]]> | | * rectangular region. It also indicates an alpha value of unity, if | |
| * @ATSPI_STATE_PRESSED: <![CDATA[ Indicates this object is currently p | | it | |
| ressed ]]> | | * supports alpha blending. | |
| * @ATSPI_STATE_RESIZABLE: <![CDATA[ Indicates the size of this object' | | * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed | |
| s size is not fixed ]]> | | * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not | |
| * @ATSPI_STATE_SELECTABLE: <![CDATA[ Indicates this object is the chil | | * fixed | |
| d of an object that allows its children to be selected and that this | | * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object | |
| child is one of those children that can be selected. ]]> | | * that allows its children to be selected and that this child is one | |
| * @ATSPI_STATE_SELECTED: <![CDATA[ Indicates this object is the child | | of | |
| of an object that allows its children to be selected and that this ch | | * those children that can be selected. | |
| ild is one of those children that has been selected. ]]> | | * @ATSPI_STATE_SELECTED: Indicates this object is the child of an object t | |
| * @ATSPI_STATE_SENSITIVE: <![CDATA[ Indicates this object is sensitive | | hat | |
| , e.g. to user interaction. STATE_SENSITIVE usually accompanies STAT | | * allows its children to be selected and that this child is one of t | |
| E_ENABLED for user-actionable controls, but may be found in the absen | | hose | |
| ce of STATE_ENABLED if the current visible state of the control is " | | * children that has been selected. | |
| disconnected" from the application state. In such cases, direct user inter | | * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user | |
| action can often result in the object gaining STATE_SENSITIVE, for in | | * interaction. STATE_SENSITIVE usually accompanies STATE_ENABLED fo | |
| stance if a user makes an explicit selection using an object whose c | | r | |
| urrent state is ambiguous or undefined. @see STATE_ENABLED, STATE_IND | | * user-actionable controls, but may be found in the absence of | |
| ETERMINATE. ]]> | | * STATE_ENABLED if the current visible state of the control is | |
| * @ATSPI_STATE_SHOWING: <![CDATA[ Indicates this object, the object's | | * "disconnected" from the application state. In such cases, direct user | |
| parent, the object's parent's parent, and so on, are all 'shown' to t | | * interaction can often result in the object gaining STATE_SENSITIVE | |
| he end-user, i.e. subject to "exposure" if blocking or obscuring obje | | , for | |
| cts do not interpose between this object and the top of the window st | | * instance if a user makes an explicit selection using an object wh | |
| ack. ]]> | | ose | |
| * @ATSPI_STATE_SINGLE_LINE: <![CDATA[ Indicates this (text) object can | | * current state is ambiguous or undefined. @see STATE_ENABLED, | |
| contain only a single line of text ]]> | | * STATE_INDETERMINATE. | |
| * @ATSPI_STATE_STALE: <![CDATA[ Indicates that the information returne | | * @ATSPI_STATE_SHOWING: Indicates this object, the object's parent, the | |
| d for this object may no longer be synchronized with the application | | * object's parent's parent, and so on, are all 'shown' to the end-us | |
| state. This can occur if the object has STATE_TRANSIENT, and can als | | er, | |
| o occur towards the end of the object peer's lifecycle. ]]> | | * i.e. subject to "exposure" if blocking or obscuring objects do not | |
| * @ATSPI_STATE_TRANSIENT: <![CDATA[ Indicates this object is transient | | * interpose between this object | |
| ]]> | | * and the top of the window stack. | |
| * @ATSPI_STATE_VERTICAL: <![CDATA[ Indicates the orientation of this o | | * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only | |
| bject is vertical; for example this state may appear on such objects | | a | |
| as scrollbars, text objects (with vertical text flow), separators, etc. | | * single line of text | |
| ]]> | | * @ATSPI_STATE_STALE: Indicates that the information returned for this obj | |
| * @ATSPI_STATE_VISIBLE: <![CDATA[ Indicates this object is visible, | | ect | |
| e.g. has been explicitly marked for exposure to the user. STATE_VISIBLE | | * may no longer be synchronized with the application state. This ca | |
| is no guarantee that the object is actually unobscured on the screen, only | | n occur | |
| that it is 'potentially' visible, barring obstruction, being scrolle | | * if the object has STATE_TRANSIENT, and can also occur towards the | |
| d or clipped out of the field of view, or having an ancestor contain | | end of | |
| er that has not yet made visible. A widget is potentially onscreen if | | * the object peer's | |
| it has both STATE_VISIBLE and STATE_SHOWING. The absence of STATE_VI | | * lifecycle. | |
| SIBLE and STATE_SHOWING is semantically equivalent to saying that an | | * @ATSPI_STATE_TRANSIENT: Indicates this object is transient | |
| object is 'hidden'. ]]> | | * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is verti | |
| * @ATSPI_STATE_MANAGES_DESCENDANTS: <![CDATA[ Indicates that "active-d | | cal; | |
| escendant-changed" event is sent when children become 'active' (i.e. | | * for example this state may appear on such objects as scrollbars, | |
| are selected or navigated to onscreen). Used to prevent need to enum | | text | |
| erate all children in very large containers, like tables. The presen | | * objects (with vertical text flow), separators, etc. | |
| ce of STATE_MANAGES_DESCENDANTS is an indication to the client. that | | * @ATSPI_STATE_VISIBLE: Indicates this object is visible, e.g. has | |
| the children should not, and need not, be enumerated by the client. O | | been | |
| bjects implementing this state are expected to provide relevant state | | * explicitly marked for exposure to the user. STATE_VISIBLE is n | |
| notifications to listening clients, for instance notifications of visibili | | o guarantee | |
| ty changes and activation of their contained child objects, without t | | * that the object is actually unobscured on the screen, only that it | |
| he client having previously requested references to those children. | | is | |
| ]]> | | * 'potentially' visible, barring obstruction, being scrolled or clipped ou | |
| * @ATSPI_STATE_INDETERMINATE: <![CDATA[ Indicates that a check box or | | t of | |
| other boolean indicator is in a state other than checked or not chec | | * the field of view, or having an ancestor container that has not y | |
| ked. This usually means that the boolean value reflected or control | | et made | |
| led by the object does not apply consistently to the entire current context | | * visible. A widget is potentially onscreen if it has both STATE_VIS | |
| . For example, a checkbox for the "Bold" attribute of text may have S | | IBLE | |
| TATE_INDETERMINATE if the currently selected text contains a mixture | | * and STATE_SHOWING. The absence of STATE_VISIBLE and STATE_SHOWING | |
| of weight attributes. In many cases interacting with a STATE_INDETE | | is | |
| RMINATE object will cause the context's corresponding boolean attrib | | * semantically equivalent to saying that an object is 'hidden'. | |
| ute to be homogenized, whereupon the object will lose STATE_INDETERMI | | * @ATSPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-chan | |
| NATE and a corresponding state-changed event will be fired. ]]> | | ged" | |
| * @ATSPI_STATE_REQUIRED: <![CDATA[ Indicates that user interaction wit | | * event is sent when children become 'active' (i.e. are selected or | |
| h this object is 'required' from the user, for instance before compl | | * navigated to onscreen). Used to prevent need to enumerate all chi | |
| eting the processing of a form. ]]> | | ldren | |
| * @ATSPI_STATE_TRUNCATED: <![CDATA[ Indicates that an object's onscree | | * in very large containers, like tables. The presence of | |
| n content is truncated, e.g. a text value in a spreadsheet cell. ]]> | | * STATE_MANAGES_DESCENDANTS is an indication to the client. that the | |
| * @ATSPI_STATE_ANIMATED: <![CDATA[ Indicates this object's visual repr | | * children should not, and need not, be enumerated by the client. Ob | |
| esentation is dynamic, not static. This state may be applied to an ob | | jects | |
| ject during an animated 'effect' and be removed from the object once | | * implementing this state are expected to provide relevant state | |
| its visual representation becomes static. some applications, notably c | | * notifications to listening clients, for instance notifications of visibi | |
| ontent viewers, may not be able to detect all kinds of animated conte | | lity | |
| nt. Therefore the absence of this state should not be taken as defin | | * changes and activation of their contained child objects, without the | |
| itive evidence that the object's visual representation is static; thi | | client | |
| s state is advisory. ]]> | | * having previously requested references to those children. | |
| * @ATSPI_STATE_INVALID_ENTRY: <![CDATA[ This object has indicated an e | | * @ATSPI_STATE_INDETERMINATE: Indicates that a check box or other boolean | |
| rror condition due to failure of input validation. For instance, a f | | * indicator is in a state other than checked or not checked. This | |
| orm control may acquire this state in response to invalid or malforme | | * usually means that the boolean value reflected or controlled by t | |
| d user input. ]]> | | he | |
| * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: <![CDATA[ This state indicates | | * object does not apply consistently to the entire current context. | |
| that the object in question implements some form of ¨typeahead¨ | | * For example, a checkbox for the "Bold" attribute of text may have | |
| or pre-selection behavior whereby entering the first character of on | | * STATE_INDETERMINATE if the currently selected text contains a mixt | |
| e or more sub-elements causes those elements to scroll into view or b | | ure | |
| ecome selected. Subsequent character input may narrow the selection | | * of weight attributes. In many cases interacting with a | |
| further as long as one or more sub-elements match the string. This st | | * STATE_INDETERMINATE object will cause the context's corresponding | |
| ate is normally only useful and encountered on objects that implement Selec | | * boolean attribute to be homogenized, whereupon the object will los | |
| tion. In some cases the typeahead behavior may result in full or part | | e | |
| ial ¨completion¨ of the data in the input field, in which | | * STATE_INDETERMINATE and a corresponding state-changed event will be fire | |
| case these input events may trigger text-changed events from the sour | | d. | |
| ce. ]]> | | * @ATSPI_STATE_REQUIRED: Indicates that user interaction with this object | |
| * @ATSPI_STATE_SELECTABLE_TEXT: <![CDATA[ This state indicates that th | | is | |
| e object in question supports text selection. It should only be expo | | * 'required' from the user, for instance before completing the | |
| sed on objects which implement the Text interface, in order to disti | | * processing of a form. | |
| nguish this state from STATE_SELECTABLE, which infers that the object | | * @ATSPI_STATE_TRUNCATED: Indicates that an object's onscreen conten | |
| in question is a selectable child of an object which implements Sele | | t | |
| ction. While similar, text selection and subelement selection are di | | * is truncated, e.g. a text value in a spreadsheet cell. | |
| stinct operations. ]]> | | * @ATSPI_STATE_ANIMATED: Indicates this object's visual representation is | |
| * @ATSPI_STATE_IS_DEFAULT: <![CDATA[ This state indicates that the obj | | * dynamic, not static. This state may be applied to an object during | |
| ect in question is the 'default' interaction object in a dialog, i.e | | an | |
| . the one that gets activated if the user presses "Enter" when the di | | * animated 'effect' and be removed from the object once its visual | |
| alog is initially posted. ]]> | | * representation becomes static. some applications, notably content vi | |
| * @ATSPI_STATE_VISITED: <![CDATA[ This state indicates that the object | | ewers, | |
| (typically a hyperlink) has already been activated or invoked, with | | * may not be able to detect all kinds of animated content. Therefor | |
| the result that some backing data has been downloaded or rendered. | | e the | |
| ]]> | | * absence of this state should not be taken as | |
| * @ATSPI_STATE_LAST_DEFINED: <![CDATA[ This value of the enumeration s | | * definitive evidence that the object's visual representation is | |
| hould not be used as a parameter, it indicates the number of items in | | * static; this state is advisory. | |
| the StateType enumeration. ]]> | | * @ATSPI_STATE_INVALID_ENTRY: 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. | |
| | | * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the obje | |
| | | ct | |
| | | * in question implements some form of ¨typeahead¨ or | |
| | | * pre-selection behavior whereby entering the first character of one or mo | |
| | | re | |
| | | * sub-elements causes those elements to scroll into view or become | |
| | | * selected. Subsequent character input may narrow the selection fur | |
| | | ther as | |
| | | * long as one or more sub-elements match the string. This state is n | |
| | | ormally | |
| | | * only useful and encountered on objects that implement Selection. I | |
| | | n some | |
| | | * cases the typeahead behavior may result in full or partial | |
| | | * ¨completion¨ of the data in the input field, in which c | |
| | | ase | |
| | | * these input events may trigger text-changed events from the source | |
| | | . | |
| | | * @ATSPI_STATE_SELECTABLE_TEXT: This state indicates that the object in | |
| | | * question supports text selection. It should only be exposed on ob | |
| | | jects | |
| | | * 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 s | |
| | | imilar, | |
| | | * text selection and subelement selection are distinct operations. | |
| | | * @ATSPI_STATE_IS_DEFAULT: This state indicates that the object in questio | |
| | | n is | |
| | | * the 'default' interaction object in a dialog, i.e. the one that g | |
| | | ets | |
| | | * activated if the user presses "Enter" when the dialog is initially | |
| | | * posted. | |
| | | * @ATSPI_STATE_VISITED: 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. | |
| | | * @ATSPI_STATE_LAST_DEFINED: This value of the enumeration should not be u | |
| | | sed | |
| | | * as a parameter, it indicates the number of items in the StateType | |
| | | * enumeration. | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_STATE_INVALID, | | ATSPI_STATE_INVALID, | |
| ATSPI_STATE_ACTIVE, | | ATSPI_STATE_ACTIVE, | |
| ATSPI_STATE_ARMED, | | ATSPI_STATE_ARMED, | |
| ATSPI_STATE_BUSY, | | ATSPI_STATE_BUSY, | |
| ATSPI_STATE_CHECKED, | | ATSPI_STATE_CHECKED, | |
| ATSPI_STATE_COLLAPSED, | | ATSPI_STATE_COLLAPSED, | |
| | | | |
| skipping to change at line 399 | | skipping to change at line 557 | |
| /** | | /** | |
| * ATSPI_STATETYPE_COUNT: | | * ATSPI_STATETYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiStateType. | | * 1 higher than the highest valid value of #AtspiStateType. | |
| */ | | */ | |
| #define ATSPI_STATETYPE_COUNT (41+1) | | #define ATSPI_STATETYPE_COUNT (41+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_KeyEventType: | | ATSPI_KeyEventType: | |
|
| * @ATSPI_KEY_PRESSED: <![CDATA[]]> | | * @ATSPI_KEY_PRESSED: | |
| * @ATSPI_KEY_RELEASED: <![CDATA[]]> | | * @ATSPI_KEY_RELEASED: | |
| * | | * | |
|
| * <![CDATA[ Deprecated, DO NOT USE! ]]> | | * Deprecated, DO NOT USE! | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_KEY_PRESSED, | | ATSPI_KEY_PRESSED, | |
| ATSPI_KEY_RELEASED, | | ATSPI_KEY_RELEASED, | |
| } AtspiKeyEventType; | | } AtspiKeyEventType; | |
| | | | |
| /** | | /** | |
| * ATSPI_KEYEVENTTYPE_COUNT: | | * ATSPI_KEYEVENTTYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiKeyEventType. | | * 1 higher than the highest valid value of #AtspiKeyEventType. | |
| */ | | */ | |
| #define ATSPI_KEYEVENTTYPE_COUNT (1+1) | | #define ATSPI_KEYEVENTTYPE_COUNT (1+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_EventType: | | ATSPI_EventType: | |
|
| * @ATSPI_KEY_PRESSED_EVENT: <![CDATA[ < key on a keyboard device was p | | * @ATSPI_KEY_PRESSED_EVENT: < key on a keyboard device was pressed. | |
| ressed. ]]> | | * @ATSPI_KEY_RELEASED_EVENT: < key on a keyboard device was released. | |
| * @ATSPI_KEY_RELEASED_EVENT: <![CDATA[ < key on a keyboard device was | | * @ATSPI_BUTTON_PRESSED_EVENT: < button on a non-keyboard human interface | |
| released. ]]> | | * device (HID) was pressed | |
| * @ATSPI_BUTTON_PRESSED_EVENT: <![CDATA[ < button on a non-keyboard hu | | * @ATSPI_BUTTON_RELEASED_EVENT: < button on a non-keyboard human interface | |
| man interface device (HID) was pressed ]]> | | * device (HID) was pressed | |
| * @ATSPI_BUTTON_RELEASED_EVENT: <![CDATA[ < button on a non-keyboard h | | * | |
| uman interface device (HID) was pressed ]]> | | * Used to specify the event types of interest to an EventListener, or | |
| * | | to | |
| * <![CDATA[ Used to specify the event types of interest to an EventLis | | * identify the type of an event for which notification has been sent. | |
| tener, or to identify the type of an event for which notification has | | @see | |
| been sent. @see EventTypeSeq, DeviceEvent::type ]]> | | * EventTypeSeq, DeviceEvent::type | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_KEY_PRESSED_EVENT, | | ATSPI_KEY_PRESSED_EVENT, | |
| ATSPI_KEY_RELEASED_EVENT, | | ATSPI_KEY_RELEASED_EVENT, | |
| ATSPI_BUTTON_PRESSED_EVENT, | | ATSPI_BUTTON_PRESSED_EVENT, | |
| ATSPI_BUTTON_RELEASED_EVENT, | | ATSPI_BUTTON_RELEASED_EVENT, | |
| } AtspiEventType; | | } AtspiEventType; | |
| | | | |
| /** | | /** | |
| * ATSPI_EVENTTYPE_COUNT: | | * ATSPI_EVENTTYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiEventType. | | * 1 higher than the highest valid value of #AtspiEventType. | |
| */ | | */ | |
| #define ATSPI_EVENTTYPE_COUNT (3+1) | | #define ATSPI_EVENTTYPE_COUNT (3+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| AtspiKeySynthType: | | AtspiKeySynthType: | |
|
| * @ATSPI_KEY_PRESS: <![CDATA[ emulate the pressing of a hardware keybo | | * @ATSPI_KEY_PRESS: emulate the pressing of a hardware keyboard key. | |
| ard key. ]]> | | * @ATSPI_KEY_RELEASE: emulate the release of a hardware keyboard key. | |
| * @ATSPI_KEY_RELEASE: <![CDATA[ emulate the release of a hardware keyb | | * @ATSPI_KEY_PRESSRELEASE: a hardware keyboard key is pressed and immediat | |
| oard key. ]]> | | ely | |
| * @ATSPI_KEY_PRESSRELEASE: <![CDATA[ a hardware keyboard key is presse | | * released. | |
| d and immediately released. ]]> | | * @ATSPI_KEY_SYM: a symbolic key event is generated, without specifying a | |
| * @ATSPI_KEY_SYM: <![CDATA[ a symbolic key event is generated, without | | * hardware key. @note if the keysym is not present in the current k | |
| specifying a hardware key. @note if the keysym is not present in th | | eyboard | |
| e current keyboard map, the DeviceEventController instance has a limi | | * map, the DeviceEventController instance has a limited ability to g | |
| ted ability to generate such keysyms on-the-fly. Reliability of Gene | | enerate | |
| rateKeyboardEvent calls using out-of-keymap keysyms will vary from sy | | * such keysyms on-the-fly. Reliability of GenerateKeyboardEvent cal | |
| stem to system, and on the number of different out-of-keymap being ge | | ls | |
| nerated in quick succession. In practice this is rarely significant, | | * using out-of-keymap keysyms will vary from system to system, and on the | |
| since the keysyms of interest to AT clients and keyboard emulators ar | | * number of different out-of-keymap being generated in quick succession. | |
| e usually part of the current keymap, i.e. present on the system keyb | | In | |
| oard for the current locale (even if a physical hardware keyboard is | | * practice this is rarely significant, since the keysyms of interest to | |
| not connected. ]]> | | AT | |
| * @ATSPI_KEY_STRING: <![CDATA[ a string is converted to its equivalent | | * clients and keyboard emulators are usually part of the current keymap, i | |
| keyboard events and emitted. If the string consists of complex char | | .e. | |
| acter or composed characters which are not in the current keymap, str | | * present on the system keyboard for the current locale (even if a physi | |
| ing emission is subject to the out-of-keymap limitations described fo | | cal | |
| r KeySynthType::KEY_SYM. In practice this limitation primarily effect | | * hardware keyboard is not connected. | |
| s Chinese and Japanese locales. ]]> | | * @ATSPI_KEY_STRING: a string is converted to its equivalent keyboard even | |
| | | ts | |
| | | * and emitted. If the string consists of complex character or compo | |
| | | sed | |
| | | * 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 effec | |
| | | ts | |
| | | * Chinese and Japanese locales. | |
| * | | * | |
|
| * <![CDATA[ Used when synthesizing keyboard input via DeviceEventContr | | * Used when synthesizing keyboard input via | |
| oller:GenerateKeyboardEvent. ]]> | | * DeviceEventController:GenerateKeyboardEvent. | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_KEY_PRESS, | | ATSPI_KEY_PRESS, | |
| ATSPI_KEY_RELEASE, | | ATSPI_KEY_RELEASE, | |
| ATSPI_KEY_PRESSRELEASE, | | ATSPI_KEY_PRESSRELEASE, | |
| ATSPI_KEY_SYM, | | ATSPI_KEY_SYM, | |
| ATSPI_KEY_STRING, | | ATSPI_KEY_STRING, | |
| } AtspiKeySynthType; | | } AtspiKeySynthType; | |
| | | | |
| skipping to change at line 475 | | skipping to change at line 653 | |
| /** | | /** | |
| * ATSPI_KEYSYNTHTYPE_COUNT: | | * ATSPI_KEYSYNTHTYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiKeySynthType. | | * 1 higher than the highest valid value of #AtspiKeySynthType. | |
| */ | | */ | |
| #define ATSPI_KEYSYNTHTYPE_COUNT (4+1) | | #define ATSPI_KEYSYNTHTYPE_COUNT (4+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_ModifierType: | | ATSPI_ModifierType: | |
|
| * @ATSPI_MODIFIER_SHIFT: <![CDATA[ The left or right 'Shift' key ]] | | * @ATSPI_MODIFIER_SHIFT: The left or right 'Shift' key | |
| > | | * @ATSPI_MODIFIER_SHIFTLOCK: The ShiftLock or CapsLock key | |
| * @ATSPI_MODIFIER_SHIFTLOCK: <![CDATA[ The ShiftLock or CapsLock key | | * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl' | |
| ]]> | | * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr) | |
| * @ATSPI_MODIFIER_CONTROL: <![CDATA[ 'Control'/'Ctrl' ]]> | | * @ATSPI_MODIFIER_META: depending on the platform this may map to 'Window' | |
| * @ATSPI_MODIFIER_ALT: <![CDATA[ The Alt key (as opposed to AltGr) | | , | |
| ]]> | | * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' | |
| * @ATSPI_MODIFIER_META: <![CDATA[ depending on the platform this may m | | will | |
| ap to 'Window', 'Function', 'Meta', 'Menu', or 'NumLock'. Suc | | * map to one of META, META2, META3. On X Windows platforms these MET | |
| h 'Meta keys' will map to one of META, META2, META3. On X Windows pla | | A | |
| tforms these META values map to the modifier masks Mod1Mask, Mod2Mas | | * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e. | |
| k, Mod3Mask, e.g. an event having ModifierType::MODIFIER_META2 means | | g. an | |
| that the 'Mod2Mask' bit is set in the corresponding XEvent. ]]> | | * event having ModifierType::MODIFIER_META2 means that the 'Mod2Mask | |
| * @ATSPI_MODIFIER_META2: <![CDATA[]]> | | ' bit | |
| * @ATSPI_MODIFIER_META3: <![CDATA[]]> | | * is set in the corresponding XEvent. | |
| * @ATSPI_MODIFIER_NUMLOCK: <![CDATA[ A symbolic meta key name that is | | * @ATSPI_MODIFIER_META2: | |
| mapped by AT-SPI to the appropriate META value, for the convenience | | * @ATSPI_MODIFIER_META3: | |
| of the client. ]]> | | * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-S | |
| | | PI | |
| | | * to the appropriate META value, for the convenience of the client. | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_MODIFIER_SHIFT, | | ATSPI_MODIFIER_SHIFT, | |
| ATSPI_MODIFIER_SHIFTLOCK, | | ATSPI_MODIFIER_SHIFTLOCK, | |
| ATSPI_MODIFIER_CONTROL, | | ATSPI_MODIFIER_CONTROL, | |
| ATSPI_MODIFIER_ALT, | | ATSPI_MODIFIER_ALT, | |
| ATSPI_MODIFIER_META, | | ATSPI_MODIFIER_META, | |
| ATSPI_MODIFIER_META2, | | ATSPI_MODIFIER_META2, | |
| | | | |
| skipping to change at line 507 | | skipping to change at line 691 | |
| /** | | /** | |
| * ATSPI_MODIFIERTYPE_COUNT: | | * ATSPI_MODIFIERTYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiModifierType. | | * 1 higher than the highest valid value of #AtspiModifierType. | |
| */ | | */ | |
| #define ATSPI_MODIFIERTYPE_COUNT (7+1) | | #define ATSPI_MODIFIERTYPE_COUNT (7+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_RelationType: | | ATSPI_RelationType: | |
|
| * @ATSPI_RELATION_NULL: <![CDATA[ Not a meaningful relationship; clien | | * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not | |
| ts should not normally encounter this RelationType value. ]]> | | * normally encounter this RelationType value. | |
| * @ATSPI_RELATION_LABEL_FOR: <![CDATA[ Object is a label for one or mo | | * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objec | |
| re other objects. ]]> | | ts. | |
| * @ATSPI_RELATION_LABELLED_BY: <![CDATA[ Object is labelled by one or | | * @ATSPI_RELATION_LABELLED_BY: Object is labelled by one or more other | |
| more other objects. ]]> | | * objects. | |
| * @ATSPI_RELATION_CONTROLLER_FOR: <![CDATA[ Object is an interactive o | | * @ATSPI_RELATION_CONTROLLER_FOR: Object is an interactive object which | |
| bject which modifies the state, onscreen location, or other attributes | | * modifies the state, onscreen location, or other attributes of one | |
| of one or more target objects. ]]> | | or more | |
| * @ATSPI_RELATION_CONTROLLED_BY: <![CDATA[ Object state, position, etc | | * target objects. | |
| . is modified/controlled by user interaction with one or more other | | * @ATSPI_RELATION_CONTROLLED_BY: Object state, position, etc. is | |
| objects. For instance a viewport or scroll pane may be CONTROLLED_BY scro | | * modified/controlled by user interaction with one or more other ob | |
| llbars. ]]> | | jects. | |
| * @ATSPI_RELATION_MEMBER_OF: <![CDATA[ Object has a grouping relations | | * For instance a viewport or scroll pane may be CONTROLLED_BY scrollbars. | |
| hip (e.g. 'same group as') to one or more other objects. ]]> | | * @ATSPI_RELATION_MEMBER_OF: Object has a grouping relationship (e.g. 'sam | |
| * @ATSPI_RELATION_TOOLTIP_FOR: <![CDATA[ Object is a tooltip associate | | e | |
| d with another object. ]]> | | * group as') to one or more other objects. | |
| * @ATSPI_RELATION_NODE_CHILD_OF: <![CDATA[ Object is a child of the ta | | * @ATSPI_RELATION_TOOLTIP_FOR: Object is a tooltip associated with another | |
| rget. ]]> | | * object. | |
| * @ATSPI_RELATION_NODE_PARENT_OF: <![CDATA[ Object is a parent of the | | * @ATSPI_RELATION_NODE_CHILD_OF: Object is a child of the target. | |
| target. ]]> | | * @ATSPI_RELATION_NODE_PARENT_OF: Object is a parent of the target. | |
| * @ATSPI_RELATION_EXTENDED: <![CDATA[ Used to indicate that a relation | | * @ATSPI_RELATION_EXTENDED: Used to indicate that a relationship exists, b | |
| ship exists, but its type is not specified in the enumeration and mus | | ut | |
| t be obtained via a call to getRelationTypeName. ]]> | | * its type is not specified in the enumeration and must be obtained | |
| * @ATSPI_RELATION_FLOWS_TO: <![CDATA[ Object renders content which flo | | via a | |
| ws logically to another object. For instance, text in a paragraph m | | * call to getRelationTypeName. | |
| ay flow to another object which is not the 'next sibling' in the acc | | * @ATSPI_RELATION_FLOWS_TO: Object renders content which flows logically t | |
| essibility hierarchy. ]]> | | o | |
| * @ATSPI_RELATION_FLOWS_FROM: <![CDATA[ Reciprocal of RELATION_FLOWS_T | | * another object. For instance, text in a paragraph may flow to an | |
| O. ]]> | | other | |
| * @ATSPI_RELATION_SUBWINDOW_OF: <![CDATA[ Object is visually and seman | | * object which is not the 'next sibling' in the accessibility hiera | |
| tically considered a subwindow of another object, even though it is n | | rchy. | |
| ot the object's child. Useful when dealing with embedded applications and | | * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of RELATION_FLOWS_TO. | |
| other cases where the widget hierarchy does not map cleanly to the on | | * @ATSPI_RELATION_SUBWINDOW_OF: Object is visually and semantically consid | |
| screen presentation. ]]> | | ered | |
| * @ATSPI_RELATION_EMBEDS: <![CDATA[ Similar to SUBWINDOW_OF, but speci | | * a subwindow of another object, even though it is not the object's | |
| fically used for cross-process embedding. ]]> | | child. | |
| * @ATSPI_RELATION_EMBEDDED_BY: <![CDATA[ Reciprocal of RELATION_EMBEDS | | * Useful when dealing with embedded applications and other cases whe | |
| ; Used to denote content rendered by embedded renderers that live in | | re the | |
| a separate process space from the embedding context. ]]> | | * widget hierarchy does not map cleanly to the onscreen presentation. | |
| * @ATSPI_RELATION_POPUP_FOR: <![CDATA[ Denotes that the object is a tr | | * @ATSPI_RELATION_EMBEDS: Similar to SUBWINDOW_OF, but specifically used f | |
| ansient window or frame associated with another onscreen object. Simi | | or | |
| lar to TOOLTIP_FOR, but more general. Useful for windows which are technic | | * cross-process embedding. | |
| ally toplevels but which, for one or more reasons, do not explicitly | | * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of RELATION_EMBEDS; Used to deno | |
| cause their associated window to lose 'window focus'. Creation of a | | te | |
| ROLE_WINDOW object with the POPUP_FOR relation usually requires some | | * content rendered by embedded renderers that live in a separate pro | |
| presentation action on the part of assistive technology clients, even thoug | | cess | |
| h the previous toplevel ROLE_FRAME object may still be the active win | | * space from the embedding context. | |
| dow. ]]> | | * @ATSPI_RELATION_POPUP_FOR: Denotes that the object is a transient window | |
| * @ATSPI_RELATION_PARENT_WINDOW_OF: <![CDATA[ This is the reciprocal r | | or | |
| elation to RELATION_POPUP_FOR. ]]> | | * frame associated with another onscreen object. Similar to TOOLTIP_ | |
| * @ATSPI_RELATION_DESCRIPTION_FOR: <![CDATA[ Indicates that an object | | FOR, | |
| provides descriptive information about another object; more verbose | | * but more general. Useful for windows which are technically tople | |
| than RELATION_LABEL_FOR. ]]> | | vels | |
| * @ATSPI_RELATION_DESCRIBED_BY: <![CDATA[ Indicates that another objec | | * but which, for one or more reasons, do not explicitly cause their associ | |
| t provides descriptive information about this object; more verbose t | | ated | |
| han RELATION_LABELLED_BY. ]]> | | * window to lose 'window focus'. Creation of a ROLE_WINDOW object with | |
| * @ATSPI_RELATION_LAST_DEFINED: <![CDATA[ Do not use as a parameter va | | the | |
| lue, used to determine the size of the enumeration. ]]> | | * POPUP_FOR relation usually requires some presentation action on th | |
| * | | e part | |
| * <![CDATA[ RelationType specifies a relationship between objects (pos | | * of assistive technology clients, even though the previous toplevel | |
| sibly one-to-many or many-to-one) outside of the normal parent/child | | * ROLE_FRAME object may still be the active window. | |
| hierarchical relationship. It allows better semantic identification | | * @ATSPI_RELATION_PARENT_WINDOW_OF: This is the reciprocal relation to | |
| of how objects are associated with one another. For instance the RELA | | * RELATION_POPUP_FOR. | |
| TION_LABELLED_BY relationship may be used to identify labelling information | | * @ATSPI_RELATION_DESCRIPTION_FOR: Indicates that an object provides | |
| that should accompany the accessibleName property when presenting an | | * descriptive information about another object; more verbose than | |
| object's content or identity to the end user. Similarly, RELATION_C | | * RELATION_LABEL_FOR. | |
| ONTROLLER_FOR can be used to further specify the context in which a v | | * @ATSPI_RELATION_DESCRIBED_BY: Indicates that another object provides | |
| aluator is useful, and/or the other UI components which are directly effect | | * descriptive information about this object; more verbose than | |
| ed by user interactions with the valuator. Common examples include as | | * RELATION_LABELLED_BY. | |
| sociation of scrollbars with the viewport or panel which they control | | * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to | |
| . ]]> | | * determine the size of the enumeration. | |
| | | * | |
| | | * RelationType specifies a relationship between objects (possibly one-to-m | |
| | | any | |
| | | * or many-to-one) outside of the normal parent/child hierarchical | |
| | | * relationship. It allows better semantic identification of how obj | |
| | | ects | |
| | | * are associated with one another. For instance the RELATION_LABELLE | |
| | | D_BY | |
| | | * relationship may be used to identify labelling information that sh | |
| | | ould | |
| | | * accompany the accessibleName property when presenting an object's conten | |
| | | t 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 interactio | |
| | | ns with | |
| | | * the valuator. Common examples include association of scrollbars with | |
| | | the | |
| | | * viewport or panel which they control. | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_RELATION_NULL, | | ATSPI_RELATION_NULL, | |
| ATSPI_RELATION_LABEL_FOR, | | ATSPI_RELATION_LABEL_FOR, | |
| ATSPI_RELATION_LABELLED_BY, | | ATSPI_RELATION_LABELLED_BY, | |
| ATSPI_RELATION_CONTROLLER_FOR, | | ATSPI_RELATION_CONTROLLER_FOR, | |
| ATSPI_RELATION_CONTROLLED_BY, | | ATSPI_RELATION_CONTROLLED_BY, | |
| ATSPI_RELATION_MEMBER_OF, | | ATSPI_RELATION_MEMBER_OF, | |
| | | | |
| skipping to change at line 565 | | skipping to change at line 790 | |
| /** | | /** | |
| * ATSPI_RELATIONTYPE_COUNT: | | * ATSPI_RELATIONTYPE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiRelationType. | | * 1 higher than the highest valid value of #AtspiRelationType. | |
| */ | | */ | |
| #define ATSPI_RELATIONTYPE_COUNT (19+1) | | #define ATSPI_RELATIONTYPE_COUNT (19+1) | |
| | | | |
| /** | | /** | |
| * | | * | |
| ATSPI_Role: | | ATSPI_Role: | |
|
| * @ATSPI_ROLE_INVALID: <![CDATA[ A Role indicating an error condition, | | * @ATSPI_ROLE_INVALID: A Role indicating an error condition, such as | |
| such as uninitialized Role data. ]]> | | * uninitialized Role data. | |
| * @ATSPI_ROLE_ACCELERATOR_LABEL: <![CDATA[ Object is a label indicatin | | * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard | |
| g the keyboard accelerators for the parent ]]> | | * accelerators for the parent | |
| * @ATSPI_ROLE_ALERT: <![CDATA[ Object is used to alert the user about | | * @ATSPI_ROLE_ALERT: Object is used to alert the user about something | |
| something ]]> | | * @ATSPI_ROLE_ANIMATION: Object contains a dynamic or moving image of some | |
| * @ATSPI_ROLE_ANIMATION: <![CDATA[ Object contains a dynamic or moving | | * kind | |
| image of some kind ]]> | | * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator | |
| * @ATSPI_ROLE_ARROW: <![CDATA[ Object is a 2d directional indicator | | * @ATSPI_ROLE_CALENDAR: Object contains one or more dates, usually arrange | |
| ]]> | | d | |
| * @ATSPI_ROLE_CALENDAR: <![CDATA[ Object contains one or more dates, u | | * into a 2d list | |
| sually arranged into a 2d list ]]> | | * @ATSPI_ROLE_CANVAS: Object that can be drawn into and is used to trap | |
| * @ATSPI_ROLE_CANVAS: <![CDATA[ Object that can be drawn into and is u | | * events | |
| sed to trap events ]]> | | * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and | |
| * @ATSPI_ROLE_CHECK_BOX: <![CDATA[ A choice that can be checked or unc | | * provides a separate indicator for the current state. | |
| hecked and provides a separate indicator for the current state. ]]> | | * @ATSPI_ROLE_CHECK_MENU_ITEM: A menu item that behaves like a check box ( | |
| * @ATSPI_ROLE_CHECK_MENU_ITEM: <![CDATA[ A menu item that behaves like | | see | |
| a check box (see ROLE_CHECK_BOX) ]]> | | * ROLE_CHECK_BOX) | |
| * @ATSPI_ROLE_COLOR_CHOOSER: <![CDATA[ A specialized dialog that lets | | * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choos | |
| the user choose a color. ]]> | | e a | |
| * @ATSPI_ROLE_COLUMN_HEADER: <![CDATA[ The header for a column of data | | * color. | |
| ]]> | | * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data | |
| * @ATSPI_ROLE_COMBO_BOX: <![CDATA[ A list of choices the user can sele | | * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from | |
| ct from ]]> | | * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date | |
| * @ATSPI_ROLE_DATE_EDITOR: <![CDATA[ An object which allows entry of a | | * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_P | |
| date ]]> | | ANE | |
| * @ATSPI_ROLE_DESKTOP_ICON: <![CDATA[ An inconifed internal frame with | | * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and | |
| in a DESKTOP_PANE ]]> | | * iconified versions of those internal frames. | |
| * @ATSPI_ROLE_DESKTOP_FRAME: <![CDATA[ A pane that supports internal f | | * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotati | |
| rames and iconified versions of those internal frames. ]]> | | ng a | |
| * @ATSPI_ROLE_DIAL: <![CDATA[ An object that allows a value to be chan | | * visual element, or which displays a value via such a rotating elem | |
| ged via rotating a visual element, or which displays a value via such | | ent. | |
| a rotating element. ]]> | | * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border | |
| * @ATSPI_ROLE_DIALOG: <![CDATA[ A top level window with title bar and | | * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate thro | |
| a border ]]> | | ugh | |
| * @ATSPI_ROLE_DIRECTORY_PANE: <![CDATA[ A pane that allows the user to | | * and select the contents of a directory | |
| navigate through and select the contents of a directory ]]> | | * @ATSPI_ROLE_DRAWING_AREA: A specialized dialog that displays the files i | |
| * @ATSPI_ROLE_DRAWING_AREA: <![CDATA[ A specialized dialog that displa | | n | |
| ys the files in the directory and lets the user select a file, browse | | * the directory and lets the user select a file, browse a different | |
| a different directory, or specify a filename. ]]> | | * directory, or specify a filename. | |
| * @ATSPI_ROLE_FILE_CHOOSER: <![CDATA[ An object used for drawing custo | | * @ATSPI_ROLE_FILE_CHOOSER: An object used for drawing custom user interfa | |
| m user interface elements. ]]> | | ce | |
| * @ATSPI_ROLE_FILLER: <![CDATA[ A object that fills up space in a user | | * elements. | |
| interface ]]> | | * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface | |
| * @ATSPI_ROLE_FOCUS_TRAVERSABLE: <![CDATA[ Don't use, reserved for fut | | * @ATSPI_ROLE_FOCUS_TRAVERSABLE: Don't use, reserved for future use. | |
| ure use. ]]> | | * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font | |
| * @ATSPI_ROLE_FONT_CHOOSER: <![CDATA[ Allows selection of a display fo | | * @ATSPI_ROLE_FRAME: A top level window with a title bar, border, menubar, | |
| nt ]]> | | * etc. | |
| * @ATSPI_ROLE_FRAME: <![CDATA[ A top level window with a title bar, bo | | * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top o | |
| rder, menubar, etc. ]]> | | f | |
| * @ATSPI_ROLE_GLASS_PANE: <![CDATA[ A pane that is guaranteed to be pa | | * all panes beneath it | |
| inted on top of all panes beneath it ]]> | | * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose childre | |
| * @ATSPI_ROLE_HTML_CONTAINER: <![CDATA[ A document container for HTML, | | n | |
| whose children represent the document content. ]]> | | * represent the document content. | |
| * @ATSPI_ROLE_ICON: <![CDATA[ A small fixed size picture, typically us | | * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate | |
| ed to decorate components ]]> | | * components | |
| * @ATSPI_ROLE_IMAGE: <![CDATA[ An image, typically static. ]]> | | * @ATSPI_ROLE_IMAGE: An image, typically static. | |
| * @ATSPI_ROLE_INTERNAL_FRAME: <![CDATA[ A frame-like object that is cl | | * @ATSPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a des | |
| ipped by a desktop pane. ]]> | | ktop | |
| * @ATSPI_ROLE_LABEL: <![CDATA[ An object used to present an icon or sh | | * pane. | |
| ort string in an interface ]]> | | * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in | |
| * @ATSPI_ROLE_LAYERED_PANE: <![CDATA[ A specialized pane that allows i | | an | |
| ts children to be drawn in layers, providing a form of stacking order | | * interface | |
| . ]]> | | * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to | |
| * @ATSPI_ROLE_LIST: <![CDATA[ An object that presents a list of object | | be | |
| s to the user and allows the user to select one or more of them. ]] | | * drawn in layers, providing a form of stacking order. | |
| > | | * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user | |
| * @ATSPI_ROLE_LIST_ITEM: <![CDATA[ An object that represents an elemen | | and | |
| t of a list. ]]> | | * allows the user to select one or more of them. | |
| * @ATSPI_ROLE_MENU: <![CDATA[ An object usually found inside a menu ba | | * @ATSPI_ROLE_LIST_ITEM: An object that represents an element of a list. | |
| r that contains a list of actions the user can choose from. ]]> | | * @ATSPI_ROLE_MENU: An object usually found inside a menu bar that contain | |
| * @ATSPI_ROLE_MENU_BAR: <![CDATA[ An object usually drawn at the top o | | s a | |
| f the primary dialog box of an application that contains a list of me | | * list of actions the user can choose from. | |
| nus the user can choose from. ]]> | | * @ATSPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary | |
| * @ATSPI_ROLE_MENU_ITEM: <![CDATA[ An object usually contained in a me | | * dialog box of an application that contains a list of menus the use | |
| nu that presents an action the user can choose. ]]> | | r can | |
| * @ATSPI_ROLE_OPTION_PANE: <![CDATA[ A specialized pane whose primary | | * choose from. | |
| use is inside a DIALOG ]]> | | * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presen | |
| * @ATSPI_ROLE_PAGE_TAB: <![CDATA[ An object that is a child of a page | | ts | |
| tab list ]]> | | * an action the user can choose. | |
| * @ATSPI_ROLE_PAGE_TAB_LIST: <![CDATA[ An object that presents a serie | | * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside | |
| s of panels (or page tabs), one at a time, through some mechanism pro | | a | |
| vided by the object. ]]> | | * DIALOG | |
| * @ATSPI_ROLE_PANEL: <![CDATA[ A generic container that is often used | | * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list | |
| to group objects. ]]> | | * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (o | |
| * @ATSPI_ROLE_PASSWORD_TEXT: <![CDATA[ A text object uses for password | | r | |
| s, or other places where the text content is not shown visibly to the | | * page tabs), one at a time, through some mechanism provided by the | |
| user. ]]> | | * object. | |
| * @ATSPI_ROLE_POPUP_MENU: <![CDATA[ A temporary window that is usually | | * @ATSPI_ROLE_PANEL: A generic container that is often used to group objec | |
| used to offer the user a list of choices, and then hides when the us | | ts. | |
| er selects one of those choices. ]]> | | * @ATSPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other pl | |
| * @ATSPI_ROLE_PROGRESS_BAR: <![CDATA[ An object used to indicate how m | | aces | |
| uch of a task has been completed. ]]> | | * where the text content is not shown visibly to the user. | |
| * @ATSPI_ROLE_PUSH_BUTTON: <![CDATA[ An object the user can manipulate | | * @ATSPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer | |
| to tell the application to do something. ]]> | | the | |
| * @ATSPI_ROLE_RADIO_BUTTON: <![CDATA[ A specialized check box that wil | | * user a list of choices, and then hides when the user selects one o | |
| l cause other radio buttons in the same group to become uncghecked wh | | f those | |
| en this one is checked. ]]> | | * choices. | |
| * @ATSPI_ROLE_RADIO_MENU_ITEM: <![CDATA[ Object is both a menu item an | | * @ATSPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task | |
| d a "radio button" (see ROLE_RADIO_BUTTON) ]]> | | has | |
| * @ATSPI_ROLE_ROOT_PANE: <![CDATA[ A specialized pane that has a glass | | * been completed. | |
| pane and a layered pane as its children. ]]> | | * @ATSPI_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the | |
| * @ATSPI_ROLE_ROW_HEADER: <![CDATA[ The header for a row of data ]] | | * application to do something. | |
| > | | * @ATSPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other | |
| * @ATSPI_ROLE_SCROLL_BAR: <![CDATA[ An object usually used to allow a | | * radio buttons in the same group to become uncghecked when this one | |
| user to incrementally view a large amount of data by moving the bound | | is | |
| s of a viewport along a one-dimensional axis. ]]> | | * checked. | |
| * @ATSPI_ROLE_SCROLL_PANE: <![CDATA[ An object that allows a user to i | | * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio but | |
| ncrementally view a large amount of information. ROLE_SCROLL_PANE ob | | ton" | |
| jects are usually accompanied by ROLE_SCROLL_BAR controllers, on whic | | * (see ROLE_RADIO_BUTTON) | |
| h the RELATION_CONTROLLER_FOR and RELATION_CONTROLLED_BY reciprocal r | | * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a | |
| elations are set; \see Accessibility::RelationSet. ]]> | | * layered pane as its children. | |
| * @ATSPI_ROLE_SEPARATOR: <![CDATA[ An object usually contained in a me | | * @ATSPI_ROLE_ROW_HEADER: The header for a row of data | |
| nu to provide a visible and logical separation of the contents in a m | | * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to | |
| enu. ]]> | | * incrementally view a large amount of data by moving the bounds of | |
| * @ATSPI_ROLE_SLIDER: <![CDATA[ An object that allows the user to sele | | a | |
| ct from a bounded range ]]> | | * viewport along a one-dimensional axis. | |
| * @ATSPI_ROLE_SPIN_BUTTON: <![CDATA[ An object which allows one of a s | | * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally v | |
| et of choices to be selected, and which displays the current choice. | | iew | |
| Unlike ROLE_SCROLL_BAR, ROLE_SLIDER objects need not control 'viewp | | * a large amount of information. ROLE_SCROLL_PANE objects are usual | |
| ort'-like objects. ]]> | | ly | |
| * @ATSPI_ROLE_SPLIT_PANE: <![CDATA[ A specialized panel that presents | | * accompanied by ROLE_SCROLL_BAR controllers, on which the | |
| two other panels at the same time. ]]> | | * RELATION_CONTROLLER_FOR and RELATION_CONTROLLED_BY reciprocal rela | |
| * @ATSPI_ROLE_STATUS_BAR: <![CDATA[ Object displays non-quantitative s | | tions | |
| tatus information (c.f. ROLE_PROGRESS_BAR) ]]> | | * are set; \see Accessibility::RelationSet. | |
| * @ATSPI_ROLE_TABLE: <![CDATA[ An object used to repesent information | | * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide | |
| in terms of rows and columns. ]]> | | a | |
| * @ATSPI_ROLE_TABLE_CELL: <![CDATA[ A 'cell' or discrete child within | | * visible and logical separation of the contents in a menu. | |
| a Table. \note Table cells need not have ROLE_TABLE_CELL, other Role | | * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a boun | |
| Type values are valid as well. ]]> | | ded | |
| * @ATSPI_ROLE_TABLE_COLUMN_HEADER: <![CDATA[ An object which labels a | | * range | |
| particular column in a Table. ]]> | | * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices | |
| * @ATSPI_ROLE_TABLE_ROW_HEADER: <![CDATA[ An object which labels a par | | to | |
| ticular row in a Table. Table rows and columns may also be labelled | | * be selected, and which displays the current choice. Unlike | |
| via the RELATION_LABEL_FOR/RELATION_LABELLED_BY relationships; see A | | * ROLE_SCROLL_BAR, ROLE_SLIDER objects need not control 'viewport'-l | |
| ccessibility.RelationSet. ]]> | | ike | |
| * @ATSPI_ROLE_TEAROFF_MENU_ITEM: <![CDATA[ Object allows menu to be re | | * objects. | |
| moved from menubar and shown in its own window. ]]> | | * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other pane | |
| * @ATSPI_ROLE_TERMINAL: <![CDATA[ An object that emulates a terminal | | ls | |
| ]]> | | * at the same time. | |
| * @ATSPI_ROLE_TEXT: <![CDATA[ An object that presents text to the user | | * @ATSPI_ROLE_STATUS_BAR: Object displays non-quantitative status informat | |
| , of nonspecific type. ]]> | | ion | |
| * @ATSPI_ROLE_TOGGLE_BUTTON: <![CDATA[ A specialized push button that | | * (c.f. ROLE_PROGRESS_BAR) | |
| can be checked or unchecked, but does not procide a separate indicato | | * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of ro | |
| r for the current state. ]]> | | ws | |
| * @ATSPI_ROLE_TOOL_BAR: <![CDATA[ A bar or palette usually composed of | | * and columns. | |
| push buttons or toggle buttons ]]> | | * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. \note | |
| * @ATSPI_ROLE_TOOL_TIP: <![CDATA[ An object that provides information | | * Table cells need not have ROLE_TABLE_CELL, other RoleType values | |
| about another object ]]> | | are | |
| * @ATSPI_ROLE_TREE: <![CDATA[ An object used to repsent hierarchical i | | * valid as well. | |
| nformation to the user. ]]> | | * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular col | |
| * @ATSPI_ROLE_TREE_TABLE: <![CDATA[ An object that presents both tabul | | umn | |
| ar and hierarchical info to the user ]]> | | * in a Table. | |
| * @ATSPI_ROLE_UNKNOWN: <![CDATA[ The object contains some Accessible i | | * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in | |
| nformation, but its role is not known. ]]> | | a | |
| * @ATSPI_ROLE_VIEWPORT: <![CDATA[ An object usually used in a scroll p | | * Table. Table rows and columns may also be labelled via the | |
| ane, or to otherwise clip a larger object or content renderer to a s | | * RELATION_LABEL_FOR/RELATION_LABELLED_BY relationships; see | |
| pecific onscreen viewport. ]]> | | * Accessibility.RelationSet. | |
| * @ATSPI_ROLE_WINDOW: <![CDATA[ A ¨top level window¨ with no | | * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from men | |
| title or border. ]]> | | ubar | |
| * @ATSPI_ROLE_EXTENDED: <![CDATA[ means that the role for this item is | | * and shown in its own window. | |
| known, but not included in the core enumeration ]]> | | * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal | |
| * @ATSPI_ROLE_HEADER: <![CDATA[ An object that serves as a document he | | * @ATSPI_ROLE_TEXT: An object that presents text to the user, of nonspecif | |
| ader. ]]> | | ic | |
| * @ATSPI_ROLE_FOOTER: <![CDATA[ An object that serves as a document fo | | * type. | |
| oter. ]]> | | * @ATSPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked | |
| * @ATSPI_ROLE_PARAGRAPH: <![CDATA[ An object which is contains a singl | | or | |
| e paragraph of text content. See also ROLE_TEXT. ]]> | | * unchecked, but does not procide a separate indicator for the curre | |
| * @ATSPI_ROLE_RULER: <![CDATA[ An object which describes margins and t | | nt | |
| ab stops, etc. for text objects which it controls (should hav | | * state. | |
| e CONTROLLER_FOR relation to such). ]]> | | * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons | |
| * @ATSPI_ROLE_APPLICATION: <![CDATA[ An object corresponding to the to | | or | |
| plevel accessible of an application, which may contain ROLE_FRAME ob | | * toggle buttons | |
| jects or other accessible objects. Children of AccessibleDesktop obj | | * @ATSPI_ROLE_TOOL_TIP: An object that provides information about another | |
| ects are generally ROLE_APPLICATION objects. ]]> | | * object | |
| * @ATSPI_ROLE_AUTOCOMPLETE: <![CDATA[ The object is a dialog or list c | | * @ATSPI_ROLE_TREE: An object used to repsent hierarchical information to | |
| ontaining items for insertion into an entry widget, for instance a l | | the | |
| ist of words for completion of a text entry. ]]> | | * user. | |
| * @ATSPI_ROLE_EDITBAR: <![CDATA[ The object is an editable text object | | * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and | |
| in a toolbar. ]]> | | * hierarchical info to the user | |
| * @ATSPI_ROLE_EMBEDDED: <![CDATA[ The object is an embedded component | | * @ATSPI_ROLE_UNKNOWN: The object contains some Accessible information, bu | |
| container. This role is a "grouping" hint that the contained object | | t | |
| s share a context which is different from the container in which thi | | * its role is not known. | |
| s accessible is embedded. In particular, it is used for some kinds of | | * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to | |
| document embedding, and for embedding of out-of-process component, " | | * otherwise clip a larger object or content renderer to a specific | |
| panel applets", etc. ]]> | | * onscreen viewport. | |
| * @ATSPI_ROLE_ENTRY: <![CDATA[ The object is a component whose textual | | * @ATSPI_ROLE_WINDOW: A ¨top level window¨ with no title or bord | |
| content may be entered or modified by the user, provided STATE_EDIT | | er. | |
| ABLE is present. A readonly ROLE_ENTRY object (i.e. where STATE_EDITA | | * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but no | |
| BLE is not present) implies a read-only 'text field' in a form, as op | | t | |
| posed to a title, label, or caption. ]]> | | * included in the core enumeration | |
| * @ATSPI_ROLE_CHART: <![CDATA[ The object is a graphical depiction of | | * @ATSPI_ROLE_HEADER: An object that serves as a document header. | |
| quantitative data. It may contain multiple subelements whose attribu | | * @ATSPI_ROLE_FOOTER: An object that serves as a document footer. | |
| tes and/or description may be queried to obtain both the quantitative | | * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of | |
| data and information about how the data is being presented. The LABE | | * text content. See also ROLE_TEXT. | |
| LLED_BY relation is particularly important in interpreting objects of this | | * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc. | |
| type, as is the accessible-description property. See ROLE_CAP | | * for text objects which it controls (should have CONTROLLER_FOR | |
| TION ]]> | | * relation to such). | |
| * @ATSPI_ROLE_CAPTION: <![CDATA[ The object contains descriptive infor | | * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessi | |
| mation, usually textual, about another user interface element such as | | ble | |
| a table, chart, or image. ]]> | | * of an application, which may contain ROLE_FRAME objects or other | |
| * @ATSPI_ROLE_DOCUMENT_FRAME: <![CDATA[ The object is a visual frame o | | * accessible objects. Children of AccessibleDesktop objects are ge | |
| r container which contains a view of document content. Document fra | | nerally | |
| mes may occur within another Document instance, in which case the second | | * ROLE_APPLICATION objects. | |
| document may be said to be embedded in the containing instance. HTML | | * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing item | |
| frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singl | | s | |
| eton descendant, should implement the Document interface. ]]> | | * for insertion into an entry widget, for instance a list of words | |
| * @ATSPI_ROLE_HEADING: <![CDATA[ The object serves as a heading for co | | for | |
| ntent which follows it in a document. The 'heading level' of the head | | * completion of a text entry. | |
| ing, if availabe, may be obtained by querying the object's attribute | | * @ATSPI_ROLE_EDITBAR: The object is an editable text object in a toolbar. | |
| s. ]]> | | * @ATSPI_ROLE_EMBEDDED: The object is an embedded component container. Th | |
| * @ATSPI_ROLE_PAGE: <![CDATA[ The object is a containing instance whic | | is | |
| h encapsulates a page of information. ROLE_PAGE is used in document | | * role is a "grouping" hint that the contained objects share a cont | |
| s and content which support a paginated navigation model. ]]> | | ext | |
| * @ATSPI_ROLE_SECTION: <![CDATA[ The object is a containing instance o | | * which is different from the container in which this accessible is | |
| f document content which constitutes a particular 'logical' section o | | * embedded. In particular, it is used for some kinds of document emb | |
| f the document. The type of content within a section, and the nature | | edding, | |
| of the section division itself, may be obtained by querying the obje | | * and for embedding of out-of-process component, "panel applets", et | |
| ct's attributes. Sections may be nested. ]]> | | c. | |
| * @ATSPI_ROLE_REDUNDANT_OBJECT: <![CDATA[ The object is redundant with | | * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may b | |
| another object in the hierarchy, and is exposed for purely technica | | e | |
| l reasons. Objects of this role should be ignored by clients, if th | | * entered or modified by the user, provided STATE_EDITABLE is prese | |
| ey are encountered at all. ]]> | | nt. | |
| * @ATSPI_ROLE_FORM: <![CDATA[ The object is a containing instance of d | | * A readonly ROLE_ENTRY object (i.e. where STATE_EDITABLE is not present) | |
| ocument content which has within it components with which the user ca | | implies | |
| n interact in order to input information; i.e. the object is a contai | | * a read-only 'text field' in a form, as opposed to a title, label, | |
| ner for pushbuttons, comboboxes, text input fields, and other 'GUI' c | | or | |
| omponents. ROLE_FORM should not, in general, be used for toplevel GUI | | * caption. | |
| containers or dialogs, but should be reserved for 'GUI' containers w | | * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative d | |
| hich occur within document content, for instance within Web documents | | ata. | |
| , presentations, or text documents. Unlike other GUI containers and | | * It may contain multiple subelements whose attributes and/or descr | |
| dialogs which occur inside application instances, ROLE_FORM containe | | iption | |
| rs' components are associated with the current document, rather than | | * may be queried to obtain both the quantitative data and informatio | |
| the current foreground application or viewer instance. ]]> | | n about | |
| * @ATSPI_ROLE_LINK: <![CDATA[ The object is a hypertext anchor, i.e. a | | * how the data is being presented. The LABELLED_BY relation is parti | |
| "link" in a hypertext document. Such objects are distinct from 'inl | | cularly | |
| ine' content which may also use the Hypertext/Hyperlink interfaces | | * important in interpreting objects of this type, as is the | |
| to indicate the range/location within a text object where an inli | | * accessible-description property. See ROLE_CAPTION | |
| ne or embedded object lies. ]]> | | * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usuall | |
| * @ATSPI_ROLE_INPUT_METHOD_WINDOW: <![CDATA[ The object is a window or | | y | |
| similar viewport which is used to allow composition or input of a 'c | | * textual, about another user interface element such as a table, cha | |
| omplex character', in other words it is an "input method window." | | rt, or | |
| ]]> | | * image. | |
| * @ATSPI_ROLE_LAST_DEFINED: <![CDATA[ Not a valid role, used for findi | | * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container wh | |
| ng end of enumeration. ]]> | | ich | |
| | | * contains a view of document content. Document frames may occur w | |
| | | ithin | |
| | | * 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, sho | |
| | | uld | |
| | | * implement the Document interface. | |
| | | * @ATSPI_ROLE_HEADING: 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. | |
| | | * @ATSPI_ROLE_PAGE: 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. | |
| | | * @ATSPI_ROLE_SECTION: The object is a containing instance of document con | |
| | | tent | |
| | | * which constitutes a particular 'logical' section of the document. | |
| | | The | |
| | | * type of content within a section, and the nature of the section di | |
| | | vision | |
| | | * itself, may be obtained by querying the object's attributes. Sect | |
| | | ions | |
| | | * may be nested. | |
| | | * @ATSPI_ROLE_REDUNDANT_OBJECT: The object is redundant with another objec | |
| | | t in | |
| | | * the hierarchy, and is exposed for purely technical reasons. Obje | |
| | | cts of | |
| | | * this role should be ignored by clients, if they are encountered a | |
| | | t all. | |
| | | * @ATSPI_ROLE_FORM: The object is a containing instance of document conten | |
| | | t | |
| | | * which has within it components with which the user can interact in | |
| | | order | |
| | | * to input information; i.e. the object is a container for pushbutto | |
| | | ns, | |
| | | * comboboxes, text input fields, and other 'GUI' components. ROLE_ | |
| | | FORM | |
| | | * should not, in general, be used for toplevel GUI containers or dia | |
| | | logs, | |
| | | * but should be reserved for 'GUI' containers which occur within doc | |
| | | ument | |
| | | * content, for instance within Web documents, presentations, or tex | |
| | | t | |
| | | * documents. Unlike other GUI containers and dialogs which occur inside | |
| | | * application instances, ROLE_FORM containers' components are associated w | |
| | | ith | |
| | | * the current document, rather than the current foreground application o | |
| | | r | |
| | | * viewer instance. | |
| | | * @ATSPI_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a | |
| | | * hypertext document. Such objects are distinct from 'inline' conte | |
| | | nt | |
| | | * which may also use the Hypertext/Hyperlink interfaces to indicate | |
| | | the | |
| | | * range/location within a text object where an inline or embedded ob | |
| | | ject | |
| | | * lies. | |
| | | * @ATSPI_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewp | |
| | | ort | |
| | | * which is used to allow composition or input of a 'complex characte | |
| | | r', | |
| | | * in other words it is an "input method window." | |
| | | * @ATSPI_ROLE_TABLE_ROW: A row in a table. | |
| | | * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree. | |
| | | * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a | |
| | | * spreadsheet. | |
| | | * @ATSPI_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a | |
| | | * presentation or slide content. | |
| | | * @ATSPI_ROLE_DOCUMENT_TEXT: A document frame which contains textual conte | |
| | | nt, | |
| | | * such as found in a word processing | |
| | | * application. | |
| | | * @ATSPI_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other | |
| | | * markup suitable for display in a web browser. | |
| | | * @ATSPI_ROLE_DOCUMENT_EMAIL: A document frame which contains email conten | |
| | | t | |
| | | * to be displayed or composed either in plain text or | |
| | | * HTML. | |
| | | * @ATSPI_ROLE_COMMENT: 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. | |
| | | * @ATSPI_ROLE_LIST_BOX: A non-collapsible list of choices the user can | |
| | | * select from. | |
| | | * @ATSPI_ROLE_GROUPING: A group of related widgets. This group typically h | |
| | | as | |
| | | * a label. | |
| | | * @ATSPI_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multi | |
| | | ple | |
| | | * hotspots, where each hotspot can be activated resulting in the loading o | |
| | | f | |
| | | * another document or section of a document. | |
| | | * @ATSPI_ROLE_NOTIFICATION: A transitory object designed to present a | |
| | | * message to the user, typically at the desktop level rather than inside a | |
| | | * particular application. | |
| | | * @ATSPI_ROLE_INFO_BAR: An object designed to present a message to the use | |
| | | r | |
| | | * within an existing window. | |
| | | * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of | |
| | | * enumeration. | |
| * | | * | |
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Bitfield/set of flags generated from the AT-SPI specification. | |
| */ | | */ | |
| typedef enum { | | typedef enum { | |
| ATSPI_ROLE_INVALID, | | ATSPI_ROLE_INVALID, | |
| ATSPI_ROLE_ACCELERATOR_LABEL, | | ATSPI_ROLE_ACCELERATOR_LABEL, | |
| ATSPI_ROLE_ALERT, | | ATSPI_ROLE_ALERT, | |
| ATSPI_ROLE_ANIMATION, | | ATSPI_ROLE_ANIMATION, | |
| ATSPI_ROLE_ARROW, | | ATSPI_ROLE_ARROW, | |
| ATSPI_ROLE_CALENDAR, | | ATSPI_ROLE_CALENDAR, | |
| | | | |
| skipping to change at line 750 | | skipping to change at line 1129 | |
| ATSPI_ROLE_CHART, | | ATSPI_ROLE_CHART, | |
| ATSPI_ROLE_CAPTION, | | ATSPI_ROLE_CAPTION, | |
| ATSPI_ROLE_DOCUMENT_FRAME, | | ATSPI_ROLE_DOCUMENT_FRAME, | |
| ATSPI_ROLE_HEADING, | | ATSPI_ROLE_HEADING, | |
| ATSPI_ROLE_PAGE, | | ATSPI_ROLE_PAGE, | |
| ATSPI_ROLE_SECTION, | | ATSPI_ROLE_SECTION, | |
| ATSPI_ROLE_REDUNDANT_OBJECT, | | ATSPI_ROLE_REDUNDANT_OBJECT, | |
| ATSPI_ROLE_FORM, | | ATSPI_ROLE_FORM, | |
| ATSPI_ROLE_LINK, | | ATSPI_ROLE_LINK, | |
| ATSPI_ROLE_INPUT_METHOD_WINDOW, | | 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_LAST_DEFINED, | | ATSPI_ROLE_LAST_DEFINED, | |
| } AtspiRole; | | } AtspiRole; | |
| | | | |
| /** | | /** | |
| * ATSPI_ROLE_COUNT: | | * ATSPI_ROLE_COUNT: | |
| * | | * | |
| * 1 higher than the highest valid value of #AtspiRole. | | * 1 higher than the highest valid value of #AtspiRole. | |
| */ | | */ | |
| #define ATSPI_ROLE_COUNT (90+1) | | #define ATSPI_ROLE_COUNT (90+1) | |
| | | | |
| | | | |
End of changes. 22 change blocks. |
| 652 lines changed or deleted | | 878 lines changed or added | |
|