| atspi-constants.h | | atspi-constants.h | |
| | | | |
| skipping to change at line 67 | | skipping to change at line 67 | |
| | | | |
| */ | | */ | |
| | | | |
| #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 | |
| | | | |
| /** | | /** | |
|
| | | * AtspiLocaleType: | |
| | | * @ATSPI_LOCALE_TYPE_MESSAGES: For localizable natural-language messages. | |
| | | * @ATSPI_LOCALE_TYPE_COLLATE: For regular expression matching and string | |
| | | * collation. | |
| | | * @ATSPI_LOCALE_TYPE_CTYPE: For regular expression matching, character | |
| | | * classification, conversion, case-sensitive comparison, and wide characte | |
| | | r | |
| | | * functions. | |
| | | * @ATSPI_LOCALE_TYPE_MONETARY: For monetary formatting. | |
| | | * @ATSPI_LOCALE_TYPE_NUMERIC: For number formatting (such as the decimal | |
| | | * point and the thousands separator). | |
| | | * @ATSPI_LOCALE_TYPE_TIME: For time and date formatting. | |
| * | | * | |
|
| ATSPI_LOCALE_TYPE: | | * Used by interfaces #AtspiText and #AtspiDocument, this | |
| * @ATSPI_LOCALE_TYPE_MESSAGES: | | * enumeration corresponds to the POSIX 'setlocale' enum values. | |
| * @ATSPI_LOCALE_TYPE_COLLATE: | | | |
| * @ATSPI_LOCALE_TYPE_CTYPE: | | | |
| * @ATSPI_LOCALE_TYPE_MONETARY: | | | |
| * @ATSPI_LOCALE_TYPE_NUMERIC: | | | |
| * @ATSPI_LOCALE_TYPE_TIME: | | | |
| * | | * | |
|
| * Used by Text and Document interfaces these correspond to the POSIX | | **/ | |
| * 'setlocale' enum values. | | | |
| * | | | |
| * 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, | |
| } AtspiLocaleType; | | } AtspiLocaleType; | |
| | | | |
| /** | | /** | |
| * ATSPI_LOCALE_TYPE_COUNT: | | * ATSPI_LOCALE_TYPE_COUNT: | |
| * | | * | |
|
| * 1 higher than the highest valid value of #AtspiLocaleType. | | * One higher than the highest valid value of #AtspiLocaleType. | |
| */ | | **/ | |
| #define ATSPI_LOCALE_TYPE _COUNT(5+1) | | #define ATSPI_LOCALE_TYPE _COUNT(5+1) | |
| | | | |
| /** | | /** | |
|
| | | * AtspiCoordType: | |
| | | * @ATSPI_COORD_TYPE_SCREEN: Specifies xy coordinates relative to the scree | |
| | | n. | |
| | | * @ATSPI_COORD_TYPE_WINDOW: Specifies xy coordinates relative to the widge | |
| | | t's | |
| | | * top-level window. | |
| * | | * | |
|
| ATSPI_COORD_TYPE: | | * Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfa | |
| * @ATSPI_COORD_TYPE_SCREEN: | | ces | |
| * @ATSPI_COORD_TYPE_WINDOW: | | * to specify whether coordinates are relative to the window or the screen. | |
| * | | | |
| * Used by Component, Image, and Text interfaces to specify whether coordin | | | |
| ates | | | |
| * are relative to the window or the screen. | | | |
| * | | * | |
|
| * 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. | | * One higher than the highest valid value of #AtspiCoordType. | |
| */ | | **/ | |
| #define ATSPI_COORD_TYPE_COUNT (1+1) | | #define ATSPI_COORD_TYPE_COUNT (1+1) | |
| | | | |
| /** | | /** | |
|
| * | | * AtspiCollectionSortOrder: | |
| ATSPI_Collection_SortOrder: | | | |
| * @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: | |
| * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB: | | * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB: | |
| * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED: | | * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED: | |
| * | | * | |
|
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Enumeration used by interface #AtspiCollection to specify | |
| */ | | * the way #AtspiAccesible objects should be sorted. | |
| | | * | |
| | | **/ | |
| 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, | |
| ATSPI_Collection_SORT_ORDER_REVERSE_TAB, | | ATSPI_Collection_SORT_ORDER_REVERSE_TAB, | |
| ATSPI_Collection_SORT_ORDER_LAST_DEFINED, | | ATSPI_Collection_SORT_ORDER_LAST_DEFINED, | |
| } AtspiCollectionSortOrder; | | } AtspiCollectionSortOrder; | |
| | | | |
| /** | | /** | |
| * ATSPI_SORTORDER_COUNT: | | * ATSPI_SORTORDER_COUNT: | |
| * | | * | |
|
| * 1 higher than the highest valid value of #AtspiCollectionSortOrder. | | * One higher than the highest valid value of #AtspiCollectionSortOrder. | |
| */ | | */ | |
| #define ATSPI_SORTORDER_COUNT (7+1) | | #define ATSPI_SORTORDER_COUNT (7+1) | |
| | | | |
| /** | | /** | |
|
| | | * AtspiCollectionMatchType: | |
| | | * @ATSPI_Collection_MATCH_INVALID: Indicates an error condition or | |
| | | * uninitialized value. | |
| | | * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met. | |
| | | * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met. | |
| | | * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met. | |
| | | * @ATSPI_Collection_MATCH_EMPTY: Same as @ATSPI_Collection_MATCH_ALL if | |
| | | * the criteria is non-empty; for empty criteria this rule requires returne | |
| | | d | |
| | | * value to also have empty set. | |
| | | * @ATSPI_Collection_MATCH_LAST_DEFINED: Used only to determine the end of | |
| | | the | |
| | | * enumeration. | |
| * | | * | |
|
| ATSPI_Collection_MatchType: | | * Enumeration used by #AtspiMatchRule to specify | |
| * @ATSPI_Collection_MATCH_INVALID: | | * how to interpret #AtspiAccesible objects. | |
| * @ATSPI_Collection_MATCH_ALL: | | | |
| * @ATSPI_Collection_MATCH_ANY: | | | |
| * @ATSPI_Collection_MATCH_NONE: | | | |
| * @ATSPI_Collection_MATCH_EMPTY: | | | |
| * @ATSPI_Collection_MATCH_LAST_DEFINED: | | | |
| * | | * | |
|
| * 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, | |
| } AtspiCollectionMatchType; | | } AtspiCollectionMatchType; | |
| | | | |
| /** | | /** | |
| * ATSPI_MATCHTYPE_COUNT: | | * ATSPI_MATCHTYPE_COUNT: | |
| * | | * | |
|
| * 1 higher than the highest valid value of #AtspiCollectionMatchType. | | * One higher than the highest valid value of #AtspiCollectionMatchType. | |
| */ | | **/ | |
| #define ATSPI_MATCHTYPES_COUNT (5+1) | | #define ATSPI_MATCHTYPES_COUNT (5+1) | |
| | | | |
| /** | | /** | |
|
| * | | * AtspiCollectionTreeTraversalType: | |
| ATSPI_Collection_TreeTraversalType: | | | |
| * @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: | |
| * | | * | |
|
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Enumeration used by interface #AtspiCollection to specify | |
| */ | | * restrictions on #AtspiAccesible objects to be traversed. | |
| | | * | |
| | | **/ | |
| 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 | | * One higher than the highest valid value of | |
| * #AtspiCollection_TreeTraversalType. | | * #AtspiCollection_TreeTraversalType. | |
| */ | | */ | |
| #define ATSPI_TREETRAVERSALTYPE _COUNT(3+1) | | #define ATSPI_TREETRAVERSALTYPE _COUNT(3+1) | |
| | | | |
| /** | | /** | |
|
| * | | * AtspiComponentLayer: | |
| ATSPI_ComponentLayer: | | | |
| * @ATSPI_LAYER_INVALID: Indicates an error condition or uninitialized valu
e. | | * @ATSPI_LAYER_INVALID: Indicates an error condition or uninitialized valu
e. | |
| * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything el
se | | * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything el
se | |
| * is painted. The 'desktop background' is generally in this layer. | | * is painted. The 'desktop background' is generally in this layer. | |
| * @ATSPI_LAYER_CANVAS: The 'background' layer for most content renderers a
nd | | * @ATSPI_LAYER_CANVAS: The 'background' layer for most content renderers a
nd | |
|
| * UI Component containers. | | * UI #AtspiComponent containers. | |
| * @ATSPI_LAYER_WIDGET: The layer in which the majority of ordinary | | * @ATSPI_LAYER_WIDGET: The layer in which the majority of ordinary | |
| * 'foreground' widgets reside. | | * 'foreground' widgets reside. | |
|
| * @ATSPI_LAYER_MDI: A special layer between LAYER_CANVAS and LAYER_WIDGET, | | * @ATSPI_LAYER_MDI: A special layer between @ATSPI_LAYER_CANVAS and | |
| in | | * @ATSPI_LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames) | |
| * which the 'pseudo windows' (e.g. the MDI frames) reside. (S | | * reside. See #atspi_component_get_mdi_z_order. | |
| ee | | * @ATSPI_LAYER_POPUP: A layer for popup window content, above | |
| * Component.GetMDIZOrder) | | * @ATSPI_LAYER_WIDGET. | |
| * @ATSPI_LAYER_POPUP: A layer for popup window content, above LAYER_WIDGET | | | |
| . | | | |
| * @ATSPI_LAYER_OVERLAY: The topmost layer. | | * @ATSPI_LAYER_OVERLAY: The topmost layer. | |
| * @ATSPI_LAYER_WINDOW: The layer in which a toplevel window background usu
ally | | * @ATSPI_LAYER_WINDOW: The layer in which a toplevel window background usu
ally | |
| * resides. | | * resides. | |
| * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the | | * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the | |
| * enumeration. | | * enumeration. | |
| * | | * | |
|
| * The ComponentLayer of a Component instance indicates its relative stacki | | * The #AtspiComponentLayer of an #AtspiComponent instance indicates its | |
| ng | | * relative stacking order with respect to the onscreen visual representati | |
| * order with respect to the onscreen visual representation of the UI | | on | |
| . | | * of the UI. #AtspiComponentLayer, in combination with #AtspiComponent bou | |
| * ComponentLayer, in combination with Component bounds information, can be | | nds | |
| used | | * information, can be used to compute the visibility of all or part of a | |
| * to compute the visibility of all or part of a component. This is im | | * component. This is important in programmatic determination of | |
| portant | | * region-of-interest for magnification, and in | |
| * in programmatic determination of region-of-interest for magnificat | | * flat screen review models of the screen, as well as | |
| ion, | | * for other uses. Objects residing in two of the #AtspiComponentLayer | |
| * and in ¨flat screen review¨ models of the screen, as wel | | * categories support further z-ordering information, with respect to their | |
| l as | | * peers in the same layer: namely, @ATSPI_LAYER_WINDOW and | |
| * for other uses. Objects residing in two of the ComponentLayer cate | | * @ATSPI_LAYER_MDI. Relative stacking order for other objects within the | |
| gories | | * same layer is not available; the recommended heuristic is | |
| * support further z-ordering information, with respect to their peer | | * first child paints first. In other words, assume that the | |
| s in | | * first siblings in the child list are subject to being overpainted by lat | |
| * the same layer: namely, LAYER_WINDOW and LAYER_MDI. Relative stac | | er | |
| king | | * siblings if their bounds intersect. The order of layers, from bottom to | |
| * order for other objects within the same layer is not available; th | | top, | |
| e | | * is: @ATSPI_LAYER_BACKGROUND, @ATSPI_LAYER_WINDOW, @ATSPI_LAYER_MDI, | |
| * recommended heuristic is ¨first child paints first¨, in | | * @ATSPI_LAYER_CANVAS, @ATSPI_LAYER_WIDGET, @ATSPI_LAYER_POPUP, and | |
| other | | * @ATSPI_LAYER_OVERLAY. | |
| * 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. | | | |
| */ | | */ | |
| 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, | |
| ATSPI_LAYER_OVERLAY, | | ATSPI_LAYER_OVERLAY, | |
| ATSPI_LAYER_WINDOW, | | ATSPI_LAYER_WINDOW, | |
| ATSPI_LAYER_LAST_DEFINED, | | ATSPI_LAYER_LAST_DEFINED, | |
| } AtspiComponentLayer; | | } AtspiComponentLayer; | |
| | | | |
| /** | | /** | |
|
| * ATSPI_COMPONENTLAYER:_COUNT | | * ATSPI_COMPONENTLAYER_COUNT: | |
| * | | * | |
|
| * 1 higher than the highest valid value of #AtspiComponentLayer. | | * One higher than the highest valid value of #AtspiComponentLayer. | |
| */ | | **/ | |
| #define ATSPI_COMPONENTLAYER_COUNT (8+1) | | #define ATSPI_COMPONENTLAYER_COUNT (8+1) | |
| | | | |
| /** | | /** | |
|
| * | | * AtspiTextBoundaryType: | |
| ATSPI_TEXT_BOUNDARY_TYPE: | | * @ATSPI_TEXT_BOUNDARY_CHAR: An #AtspiText instance is bounded by this | |
| * @ATSPI_TEXT_BOUNDARY_CHAR: Text is bounded by this character only. | | * character only. Start and end offsets differ by one, by definition, | |
| * Start and end offsets differ by one, by definition, for this value. | | * for this value. | |
| * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word;
i.e. | | * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word;
i.e. | |
|
| * range is from start of one word to the start of another word. | | * range is from start of one word to the start of another word. | |
| * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word;
i.e. | | * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word;
i.e. | |
|
| * range is from the end of one word to the end of another. S | | * range is from the end of one word to the end of another. Some locales | |
| ome locales | | * may not distinguish between words and characters or glyphs. In particula | |
| * may not distinguish between words and characters or glyphs, in par | | r, | |
| ticular | | * those locales which use wholly or partially ideographic character sets. | |
| * those locales which use wholly or partially ideographic character | | * In these cases, characters may be returned in lieu of multi-character | |
| sets. | | | |
| * In these cases, characters may be returned in lieu of multi-charac | | | |
| ter | | | |
| * substrings. | | * substrings. | |
| * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: Boundary condition is start of a | | * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: Boundary condition is start of a | |
|
| * sentence, as determined by the application. Some locales o | | * sentence, as determined by the application. Some locales or | |
| r | | * character sets may not include explicit sentence delimiters, so this | |
| * character sets may not include explicit sentence delimiters, so th | | * boundary type can not always be honored. Some locales will return lines | |
| is | | | |
| * boundary type can not always be honored. Some locales will return | | | |
| lines | | | |
| * of text instead of grammatical sentences. | | * of text instead of grammatical sentences. | |
| * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: Boundary condition is end of a senten
ce, | | * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: Boundary condition is end of a senten
ce, | |
|
| * as determined by the application, including the sentence-delimitin | | * as determined by the application, including the sentence-delimiting | |
| g | | * character, for instance '.' Some locales or character sets may not | |
| * character, for instance '.' Some locales or character sets may not | | * include explicit sentence delimiters, so this boundary type can not | |
| * include explicit sentence delimiters, so this boundary type can no | | * always be honored. Some locales will return lines of text instead of | |
| t | | | |
| * always be honored. Some locales will return lines of text instead | | | |
| of | | | |
| * grammatical sentences. | | * grammatical sentences. | |
| * @ATSPI_TEXT_BOUNDARY_LINE_START: Boundary condition is the start of a li
ne; | | * @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 | | * i.e. range is from start of one line to the start of another. This | |
| is | | * generally means that an end-of-line character will appear at the end of | |
| * generally means that an end-of-line character will appear at the | | | |
| end of | | | |
| * the range. | | * the range. | |
| * @ATSPI_TEXT_BOUNDARY_LINE_END: Boundary condition is the end of a line;
i.e. | | * @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 | | * range is from start of one line to the start of another. This generally | |
| erally | | * means that an end-of-line character will be the first character of the | |
| * means that an end-of-line character will be the first character of | | | |
| the | | | |
| * range. | | * range. | |
| * | | * | |
| * Specifies the boundary conditions determining a run of text as returned
from | | * Specifies the boundary conditions determining a run of text as returned
from | |
|
| * GetTextAtOffset, GetTextAfterOffset, and GetTextBeforeOffset. | | * #atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, and | |
| | | * #atspi_text_get_text_before_offset. | |
| * | | * | |
|
| * 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, | |
| ATSPI_TEXT_BOUNDARY_LINE_END, | | ATSPI_TEXT_BOUNDARY_LINE_END, | |
| } AtspiTextBoundaryType; | | } AtspiTextBoundaryType; | |
| | | | |
| /** | | /** | |
| * ATSPI_TEXT_BOUNDARY_TYPE_COUNT: | | * ATSPI_TEXT_BOUNDARY_TYPE_COUNT: | |
| * | | * | |
|
| * 1 higher than the highest valid value of #AtspiTextBOundaryType. | | * One higher than the highest valid value of #AtspiTextBoundaryType. | |
| */ | | */ | |
| #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1) | | #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6+1) | |
| | | | |
| /** | | /** | |
|
| * | | * AtspiTextClipType: | |
| ATSPI_TEXT_CLIP_TYPE: | | * @ATSPI_TEXT_CLIP_NONE: No characters/glyphs are omitted. | |
| * @ATSPI_TEXT_CLIP_NONE: | | | |
| * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinat
e | | * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinat
e | |
|
| * are omitted | | * are omitted. | |
| * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum | | * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum | |
|
| * coordinate are omitted | | * coordinate are omitted. | |
| * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region | | * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region | |
| * bounded by min and max are retained. | | * bounded by min and max are retained. | |
| * | | * | |
|
| * TEXT_CLIP_TYPE: CLIP_MIN means text clipped by min coordinate is | | * Enumeration used by interface #AtspiText to indicate | |
| * omitted, CLIP_MAX clips text interescted by the max coord, and CLI | | * how to treat characters intersecting bounding boxes. | |
| P_BOTH | | | |
| * will retain only text falling fully within the min/max bounds. | | | |
| * | | * | |
|
| * 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. | | * One higher than the highest valid value of #AtspiTextClipType. | |
| */ | | */ | |
| #define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1) | | #define ATSPI_TEXT_CLIP_TYPE_COUNT (3+1) | |
| | | | |
| /** | | /** | |
|
| * | | * AtspiStateType: | |
| ATSPI_StateType: | | * @ATSPI_STATE_INVALID: Indicates an invalid state - probably an error | |
| * @ATSPI_STATE_INVALID: | | * condition. | |
| * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window,
or | | * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window,
or | |
|
| * is an active subelement within a container or table | | * is an active subelement within a container or table. | |
| * @ATSPI_STATE_ARMED: Indicates that the object is armed | | * @ATSPI_STATE_ARMED: Indicates that the object is armed. | |
| * @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen | | * @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen | |
| * representation is in the process of changing, or the object is | | * representation is in the process of changing, or the object is | |
| * temporarily unavailable for interaction due to activity already in progr
ess. | | * temporarily unavailable for interaction due to activity already in progr
ess. | |
|
| * @ATSPI_STATE_CHECKED: Indicates this object is currently checked | | * @ATSPI_STATE_CHECKED: Indicates this object is currently checked. | |
| * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed | | * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed. | |
| * @ATSPI_STATE_DEFUNCT: Indicates that this object no longer has a valid | | * @ATSPI_STATE_DEFUNCT: Indicates that this object no longer has a valid | |
|
| * backing widget (for instance, if its peer object has been destroy
ed) | | * backing widget (for instance, if its peer object has been destroy
ed). | |
| * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of thi
s | | * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of thi
s | |
|
| * object | | * object. | |
| * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that i
t | | * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that i
t | |
|
| * currently reflects some application state. Objects that are "grey | | * currently reflects some application state. Objects that are "greyed out" | |
| ed out" | | * may lack this state, and may lack the @ATSPI_STATE_SENSITIVE if direct | |
| * may lack this state, and may lack the STATE_SENSITIVE if direct user | | * user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED. | |
| * interaction cannot cause | | * See @ATSPI_STATE_SENSITIVE. | |
| * them to acquire STATE_ENABLED. @see STATE_SENSITIVE. | | | |
| * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive | | * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive | |
|
| * disclosure of its children | | * disclosure of its children. | |
| * @ATSPI_STATE_EXPANDED: Indicates this object is expanded | | * @ATSPI_STATE_EXPANDED: Indicates this object is expanded. | |
| * @ATSPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus, | | * @ATSPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus, | |
| * which means all events resulting from typing on the keyboard will | | * which means all events resulting from typing on the keyboard will | |
|
| * normally be passed to it when it has focus | | * normally be passed to it when it has focus. | |
| * @ATSPI_STATE_FOCUSED: Indicates this object currently has the keyboard | | * @ATSPI_STATE_FOCUSED: Indicates this object currently has the keyboard | |
|
| * focus | | * focus. | |
| * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated | | * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated | |
|
| * tooltip | | * tooltip. | |
| * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of thsi object is | | * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of this object is | |
| * horizontal | | * horizontal. | |
| * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is | | * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is | |
|
| * represented only by an icon | | * represented only by an icon. | |
| * @ATSPI_STATE_MODAL: Indicates something must be done with this object | | * @ATSPI_STATE_MODAL: Indicates something must be done with this object | |
|
| * before the user can interact with an object in a different window. | | * before the user can interact with an object in a different window. | |
| * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multip
le | | * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multip
le | |
|
| * lines of text | | * lines of text. | |
| * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one
of | | * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one
of | |
|
| * its children to be selected at the same time, or in the case of te | | * its children to be selected at the same time, or in the case of text | |
| xt | | * objects, that the object supports non-contiguous text selections. | |
| * objects, that the object supports non-contiguous text selections. | | | |
| * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its | | * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its | |
|
| * rectangular region. It also indicates an alpha value of unity, if
it | | * rectangular region. It also indicates an alpha value of unity, if it | |
| * supports alpha blending. | | * supports alpha blending. | |
|
| * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed | | * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed. | |
| * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not | | * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not | |
|
| * fixed | | * fixed. | |
| * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object | | * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object | |
|
| * that allows its children to be selected and that this child is one
of | | * that allows its children to be selected and that this child is one of | |
| * those children that can be selected. | | * those children that can be selected. | |
| * @ATSPI_STATE_SELECTED: Indicates this object is the child of an object t
hat | | * @ATSPI_STATE_SELECTED: Indicates this object is the child of an object t
hat | |
|
| * allows its children to be selected and that this child is one of t | | * allows its children to be selected and that this child is one of those | |
| hose | | * children that has been selected. | |
| * children that has been selected. | | | |
| * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user | | * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user | |
|
| * interaction. STATE_SENSITIVE usually accompanies STATE_ENABLED fo | | * interaction. @ATSPI_STATE_SENSITIVE usually accompanies. | |
| r | | * @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in t | |
| * user-actionable controls, but may be found in the absence of | | he | |
| * STATE_ENABLED if the current visible state of the control is | | * absence of @ATSPI_STATE_ENABLED if the current visible state of the cont | |
| * "disconnected" from the application state. In such cases, direct user | | rol | |
| * interaction can often result in the object gaining STATE_SENSITIVE | | * is "disconnected" from the application state. In such cases, direct use | |
| , for | | r | |
| * instance if a user makes an explicit selection using an object wh | | * interaction can often result in the object gaining @ATSPI_STATE_SENSITIV | |
| ose | | E, | |
| * current state is ambiguous or undefined. @see STATE_ENABLED, | | * for instance if a user makes an explicit selection using an object whose | |
| * STATE_INDETERMINATE. | | * current state is ambiguous or undefined. See @ATSPI_STATE_ENABLED, | |
| | | * @ATSPI_STATE_INDETERMINATE. | |
| * @ATSPI_STATE_SHOWING: Indicates this object, the object's parent, the | | * @ATSPI_STATE_SHOWING: Indicates this object, the object's parent, the | |
|
| * object's parent's parent, and so on, are all 'shown' to the end-us | | * object's parent's parent, and so on, are all 'shown' to the end-user, | |
| er, | | * i.e. subject to "exposure" if blocking or obscuring objects do not | |
| * i.e. subject to "exposure" if blocking or obscuring objects do not | | * interpose between this object and the top of the window stack. | |
| * interpose between this object | | | |
| * and the top of the window stack. | | | |
| * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only
a | | * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only
a | |
|
| * single line of text | | * single line of text. | |
| * @ATSPI_STATE_STALE: Indicates that the information returned for this obj
ect | | * @ATSPI_STATE_STALE: Indicates that the information returned for this obj
ect | |
|
| * may no longer be synchronized with the application state. This ca | | * may no longer be synchronized with the application state. This can occu | |
| n occur | | r | |
| * if the object has STATE_TRANSIENT, and can also occur towards the | | * if the object has @ATSPI_STATE_TRANSIENT, and can also occur towards the | |
| end of | | * end of the object peer's lifecycle. | |
| * the object peer's | | * @ATSPI_STATE_TRANSIENT: Indicates this object is transient. | |
| * lifecycle. | | | |
| * @ATSPI_STATE_TRANSIENT: Indicates this object is transient | | | |
| * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is verti
cal; | | * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is verti
cal; | |
|
| * for example this state may appear on such objects as scrollbars,
text | | * for example this state may appear on such objects as scrollbars, text | |
| * objects (with vertical text flow), separators, etc. | | * objects (with vertical text flow), separators, etc. | |
|
| * @ATSPI_STATE_VISIBLE: Indicates this object is visible, e.g. has | | * @ATSPI_STATE_VISIBLE: Indicates this object is visible, e.g. has been | |
| been | | * explicitly marked for exposure to the user. @ATSPI_STATE_VISIBLE is no | |
| * explicitly marked for exposure to the user. STATE_VISIBLE is n | | * guarantee that the object is actually unobscured on the screen, only tha | |
| o guarantee | | t | |
| * that the object is actually unobscured on the screen, only that it | | * it is 'potentially' visible, barring obstruction, being scrolled or clip | |
| is | | ped | |
| * 'potentially' visible, barring obstruction, being scrolled or clipped ou | | * out of the field of view, or having an ancestor container that has not y | |
| t of | | et | |
| * the field of view, or having an ancestor container that has not y | | * made visible. A widget is potentially onscreen if it has both | |
| et made | | * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING. The absence of | |
| * visible. A widget is potentially onscreen if it has both STATE_VIS | | * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING is | |
| IBLE | | * semantically equivalent to saying that an object is 'hidden'. | |
| * and STATE_SHOWING. The absence of STATE_VISIBLE and STATE_SHOWING | | | |
| is | | | |
| * semantically equivalent to saying that an object is 'hidden'. | | | |
| * @ATSPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-chan
ged" | | * @ATSPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-chan
ged" | |
|
| * event is sent when children become 'active' (i.e. are selected or | | * event is sent when children become 'active' (i.e. are selected or | |
| * navigated to onscreen). Used to prevent need to enumerate all chi | | * navigated to onscreen). Used to prevent need to enumerate all children | |
| ldren | | * in very large containers, like tables. The presence of | |
| * in very large containers, like tables. The presence of | | * @ATSPI_STATE_MANAGES_DESCENDANTS is an indication to the client that the | |
| * STATE_MANAGES_DESCENDANTS is an indication to the client. that the | | * children should not, and need not, be enumerated by the client. | |
| * children should not, and need not, be enumerated by the client. Ob | | * Objects implementing this state are expected to provide relevant state | |
| jects | | * notifications to listening clients, for instance notifications of | |
| * implementing this state are expected to provide relevant state | | * visibility changes and activation of their contained child objects, with | |
| * notifications to listening clients, for instance notifications of visibi | | out | |
| lity | | * the client having previously requested references to those children. | |
| * changes and activation of their contained child objects, without the | | | |
| client | | | |
| * having previously requested references to those children. | | | |
| * @ATSPI_STATE_INDETERMINATE: Indicates that a check box or other boolean | | * @ATSPI_STATE_INDETERMINATE: Indicates that a check box or other boolean | |
|
| * indicator is in a state other than checked or not checked. This | | * indicator is in a state other than checked or not checked. This | |
| * usually means that the boolean value reflected or controlled by t | | * usually means that the boolean value reflected or controlled by the | |
| he | | | |
| * object does not apply consistently to the entire current context. | | * object does not apply consistently to the entire current context. | |
| * For example, a checkbox for the "Bold" attribute of text may have | | * For example, a checkbox for the "Bold" attribute of text may have | |
|
| * STATE_INDETERMINATE if the currently selected text contains a mixt | | * @ATSPI_STATE_INDETERMINATE if the currently selected text contains a mix | |
| ure | | ture | |
| * of weight attributes. In many cases interacting with a | | * of weight attributes. In many cases interacting with a | |
| * STATE_INDETERMINATE object will cause the context's corresponding | | * @ATSPI_STATE_INDETERMINATE object will cause the context's corresponding | |
| * boolean attribute to be homogenized, whereupon the object will los | | * boolean attribute to be homogenized, whereupon the object will lose | |
| e | | * @ATSPI_STATE_INDETERMINATE and a corresponding state-changed event will | |
| * STATE_INDETERMINATE and a corresponding state-changed event will be fire | | be | |
| d. | | * fired. | |
| * @ATSPI_STATE_REQUIRED: Indicates that user interaction with this object
is | | * @ATSPI_STATE_REQUIRED: Indicates that user interaction with this object
is | |
|
| * 'required' from the user, for instance before completing the | | * 'required' from the user, for instance before completing the | |
| * processing of a form. | | * processing of a form. | |
| * @ATSPI_STATE_TRUNCATED: Indicates that an object's onscreen conten
t | | * @ATSPI_STATE_TRUNCATED: Indicates that an object's onscreen conten
t | |
| * is truncated, e.g. a text value in a spreadsheet cell. | | * is truncated, e.g. a text value in a spreadsheet cell. | |
| * @ATSPI_STATE_ANIMATED: Indicates this object's visual representation is | | * @ATSPI_STATE_ANIMATED: Indicates this object's visual representation is | |
|
| * dynamic, not static. This state may be applied to an object during | | * dynamic, not static. This state may be applied to an object during an | |
| an | | * animated 'effect' and be removed from the object once its visual | |
| * animated 'effect' and be removed from the object once its visual | | * representation becomes static. Some applications, notably content viewer | |
| * representation becomes static. some applications, notably content vi | | s, | |
| ewers, | | * may not be able to detect all kinds of animated content. Therefore the | |
| * may not be able to detect all kinds of animated content. Therefor | | * absence of this state should not be taken as | |
| e the | | | |
| * absence of this state should not be taken as | | | |
| * definitive evidence that the object's visual representation is | | * definitive evidence that the object's visual representation is | |
| * static; this state is advisory. | | * static; this state is advisory. | |
| * @ATSPI_STATE_INVALID_ENTRY: This object has indicated an error condition | | * @ATSPI_STATE_INVALID_ENTRY: This object has indicated an error condition | |
|
| * due | | * due to failure of input validation. For instance, a form control may | |
| * to failure of input validation. For instance, a form control may | | * acquire this state in response to invalid or malformed user input. | |
| * acquire this state in response to invalid or malformed user input. | | | |
| * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the obje
ct | | * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the obje
ct | |
|
| * in question implements some form of ¨typeahead¨ or | | * in question implements some form of typeahead or | |
| * pre-selection behavior whereby entering the first character of one or mo
re | | * pre-selection behavior whereby entering the first character of one or mo
re | |
|
| * sub-elements causes those elements to scroll into view or become | | * sub-elements causes those elements to scroll into view or become | |
| * selected. Subsequent character input may narrow the selection fur | | * selected. Subsequent character input may narrow the selection further as | |
| ther as | | * long as one or more sub-elements match the string. This state is normall | |
| * long as one or more sub-elements match the string. This state is n | | y | |
| ormally | | * only useful and encountered on objects that implement #AtspiSelection. | |
| * only useful and encountered on objects that implement Selection. I | | * In some cases the typeahead behavior may result in full or partial | |
| n some | | * completion of the data in the input field, in which case | |
| * cases the typeahead behavior may result in full or partial | | * these input events may trigger text-changed events from the source. | |
| * ¨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 | | * @ATSPI_STATE_SELECTABLE_TEXT: This state indicates that the object in | |
|
| * question supports text selection. It should only be exposed on ob | | * question supports text selection. It should only be exposed on objects | |
| jects | | * which implement the #AtspiText interface, in order to distinguish this s | |
| * which implement the Text interface, in order to distinguish this | | tate | |
| state | | * from @ATSPI_STATE_SELECTABLE, which infers that the object in question i | |
| * from STATE_SELECTABLE, which infers that the object in question is | | s a | |
| a | | * selectable child of an object which implements #AtspiSelection. While | |
| * selectable child of an object which implements Selection. While s | | * similar, text selection and subelement selection are distinct operations | |
| imilar, | | . | |
| * text selection and subelement selection are distinct operations. | | | |
| * @ATSPI_STATE_IS_DEFAULT: This state indicates that the object in questio
n is | | * @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 | | * the 'default' interaction object in a dialog, i.e. the one that gets | |
| ets | | * activated if the user presses "Enter" when the dialog is initially | |
| * activated if the user presses "Enter" when the dialog is initially | | | |
| * posted. | | * posted. | |
| * @ATSPI_STATE_VISITED: This state indicates that the object (typically a | | * @ATSPI_STATE_VISITED: This state indicates that the object (typically a | |
|
| * hyperlink) has already been activated or invoked, with the result | | * hyperlink) has already been activated or invoked, with the result that | |
| that | | * some backing data has been downloaded or rendered. | |
| * some backing data has been downloaded or rendered. | | | |
| * @ATSPI_STATE_LAST_DEFINED: This value of the enumeration should not be u
sed | | * @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 | | * as a parameter, it indicates the number of items in the #AtspiStateType | |
| * enumeration. | | * enumeration. | |
| * | | * | |
|
| * Bitfield/set of flags generated from the AT-SPI specification. | | * | |
| */ | | * Enumeration used by various interfaces indicating every possible state | |
| | | * an #AtspiAccesible object can assume. | |
| | | * | |
| | | **/ | |
| 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, | |
| ATSPI_STATE_DEFUNCT, | | ATSPI_STATE_DEFUNCT, | |
| ATSPI_STATE_EDITABLE, | | ATSPI_STATE_EDITABLE, | |
| ATSPI_STATE_ENABLED, | | ATSPI_STATE_ENABLED, | |
| | | | |
| skipping to change at line 550 | | skipping to change at line 558 | |
| ATSPI_STATE_SUPPORTS_AUTOCOMPLETION, | | ATSPI_STATE_SUPPORTS_AUTOCOMPLETION, | |
| ATSPI_STATE_SELECTABLE_TEXT, | | ATSPI_STATE_SELECTABLE_TEXT, | |
| ATSPI_STATE_IS_DEFAULT, | | ATSPI_STATE_IS_DEFAULT, | |
| ATSPI_STATE_VISITED, | | ATSPI_STATE_VISITED, | |
| ATSPI_STATE_LAST_DEFINED, | | ATSPI_STATE_LAST_DEFINED, | |
| } AtspiStateType; | | } AtspiStateType; | |
| | | | |
| /** | | /** | |
| * ATSPI_STATETYPE_COUNT: | | * ATSPI_STATETYPE_COUNT: | |
| * | | * | |
|
| * 1 higher than the highest valid value of #AtspiStateType. | | * One higher than the highest valid value of #AtspiStateType. | |
| */ | | **/ | |
| #define ATSPI_STATETYPE_COUNT (41+1) | | #define ATSPI_STATETYPE_COUNT (41+1) | |
| | | | |
| /** | | /** | |
|
| * | | * AtspiKeyEventType: | |
| ATSPI_KeyEventType: | | | |
| * @ATSPI_KEY_PRESSED: | | * @ATSPI_KEY_PRESSED: | |
| * @ATSPI_KEY_RELEASED: | | * @ATSPI_KEY_RELEASED: | |
| * | | * | |
|
| * Deprecated, DO NOT USE! | | * Deprecated. Should not be used. | |
| * | | * | |
|
| * 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. | | * One higher than the highest valid value of #AtspiKeyEventType. | |
| */ | | **/ | |
| #define ATSPI_KEYEVENTTYPE_COUNT (1+1) | | #define ATSPI_KEYEVENTTYPE_COUNT (1+1) | |
| | | | |
| /** | | /** | |
|
| | | * AtspiEventType: | |
| | | * @ATSPI_KEY_PRESSED_EVENT: Indicates that a key on a keyboard device was | |
| | | * pressed. | |
| | | * @ATSPI_KEY_RELEASED_EVENT: Indicates that a key on a keyboard device was | |
| | | * released. | |
| | | * @ATSPI_BUTTON_PRESSED_EVENT: Indicates that a button on a non-keyboard | |
| | | * human interface device (HID) was pressed. | |
| | | * @ATSPI_BUTTON_RELEASED_EVENT: Indicates that a button on a non-keyboard | |
| | | * human interface device (HID) was released. | |
| | | * | |
| | | * Enumeration used to specify the event types of interest to an | |
| | | * #AtspiEventListener, or | |
| | | * to identify the type of an event for which notification has been sent. | |
| * | | * | |
|
| ATSPI_EventType: | | **/ | |
| * @ATSPI_KEY_PRESSED_EVENT: < key on a keyboard device was pressed. | | | |
| * @ATSPI_KEY_RELEASED_EVENT: < key on a keyboard device was released. | | | |
| * @ATSPI_BUTTON_PRESSED_EVENT: < button on a non-keyboard human interface | | | |
| * device (HID) was pressed | | | |
| * @ATSPI_BUTTON_RELEASED_EVENT: < button on a non-keyboard human interface | | | |
| * device (HID) was pressed | | | |
| * | | | |
| * Used to specify the event types of interest to an EventListener, or | | | |
| to | | | |
| * identify the type of an event for which notification has been sent. | | | |
| @see | | | |
| * EventTypeSeq, DeviceEvent::type | | | |
| * | | | |
| * 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. | | * One 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: Emulates the pressing of a hardware keyboard key. | |
| * @ATSPI_KEY_PRESS: emulate the pressing of a hardware keyboard key. | | * @ATSPI_KEY_RELEASE: Emulates the release of a hardware keyboard key. | |
| * @ATSPI_KEY_RELEASE: emulate the release of a hardware keyboard key. | | * @ATSPI_KEY_PRESSRELEASE: Emulates the pressing and immediate releasing | |
| * @ATSPI_KEY_PRESSRELEASE: a hardware keyboard key is pressed and immediat | | * ofa hardware keyboard key. | |
| ely | | * @ATSPI_KEY_SYM: A symbolic key event is generated, without specifying a | |
| * released. | | * hardware key. Note: if the keysym is not present in the current keyboard | |
| * @ATSPI_KEY_SYM: a symbolic key event is generated, without specifying a | | * map, the #AtspiDeviceEventController instance has a limited ability to | |
| * hardware key. @note if the keysym is not present in the current k | | * generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent | |
| eyboard | | * calls using out-of-keymap keysyms will vary from system to system, and o | |
| * map, the DeviceEventController instance has a limited ability to g | | n | |
| enerate | | * the number of different out-of-keymap being generated in quick successio | |
| * such keysyms on-the-fly. Reliability of GenerateKeyboardEvent cal | | n. | |
| ls | | * In practice this is rarely significant, since the keysyms of interest to | |
| * using out-of-keymap keysyms will vary from system to system, and on the | | * AT clients and keyboard emulators are usually part of the current keymap | |
| * number of different out-of-keymap being generated in quick succession. | | , | |
| In | | * i.e. present on the system keyboard for the current locale (even if a | |
| * practice this is rarely significant, since the keysyms of interest to | | * physical hardware keyboard is not connected. | |
| AT | | * @ATSPI_KEY_STRING: A string is converted to its equivalent keyboard even | |
| * clients and keyboard emulators are usually part of the current keymap, i | | ts | |
| .e. | | * and emitted. If the string consists of complex character or composed | |
| * present on the system keyboard for the current locale (even if a physi | | * characters which are not in the current keymap, string emission is | |
| cal | | * subject to the out-of-keymap limitations described for | |
| * hardware keyboard is not connected. | | * @ATSPI_KEY_SYM. In practice this limitation primarily effects | |
| * @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. | | * Chinese and Japanese locales. | |
| * | | * | |
|
| * Used when synthesizing keyboard input via | | * Enumeration used when synthesizing keyboard input via | |
| * DeviceEventController:GenerateKeyboardEvent. | | * #atspi_generate_keyboard_event. | |
| * | | * | |
|
| * 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; | |
| | | | |
| /** | | /** | |
| * ATSPI_KEYSYNTHTYPE_COUNT: | | * ATSPI_KEYSYNTHTYPE_COUNT: | |
| * | | * | |
|
| * 1 higher than the highest valid value of #AtspiKeySynthType. | | * One higher than the highest valid value of #AtspiKeySynthType. | |
| */ | | **/ | |
| #define ATSPI_KEYSYNTHTYPE_COUNT (4+1) | | #define ATSPI_KEYSYNTHTYPE_COUNT (4+1) | |
| | | | |
| /** | | /** | |
|
| * | | * AtspiModifierType: | |
| ATSPI_ModifierType: | | * @ATSPI_MODIFIER_SHIFT: 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: The ShiftLock or CapsLock key | | * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'. | |
| * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl' | | * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr). | |
| * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr) | | * @ATSPI_MODIFIER_META: Depending on the platform, this may map to 'Window | |
| * @ATSPI_MODIFIER_META: depending on the platform this may map to 'Window' | | ', | |
| , | | * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will | |
| * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' | | * map to one of META, META2, META3. On X Windows platforms these META | |
| will | | * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an | |
| * map to one of META, META2, META3. On X Windows platforms these MET | | * event having @ATSPI_MODIFIER_META2 means that the 'Mod2Mask' bit | |
| A | | * is set in the corresponding XEvent. | |
| * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e. | | * @ATSPI_MODIFIER_META2: See @ATSPI_MODIFIER_META. | |
| g. an | | * @ATSPI_MODIFIER_META3: See @ATSPI_MODIFIER_META. | |
| * event having ModifierType::MODIFIER_META2 means that the 'Mod2Mask | | | |
| ' bit | | | |
| * is set in the corresponding XEvent. | | | |
| * @ATSPI_MODIFIER_META2: | | | |
| * @ATSPI_MODIFIER_META3: | | | |
| * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-S
PI | | * @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. | | * to the appropriate META value, for the convenience of the client. | |
| * | | * | |
|
| * 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, | |
| ATSPI_MODIFIER_META3, | | ATSPI_MODIFIER_META3, | |
| ATSPI_MODIFIER_NUMLOCK, | | ATSPI_MODIFIER_NUMLOCK, | |
| } AtspiModifierType; | | } AtspiModifierType; | |
| | | | |
| /** | | /** | |
| * ATSPI_MODIFIERTYPE_COUNT: | | * ATSPI_MODIFIERTYPE_COUNT: | |
| * | | * | |
|
| * 1 higher than the highest valid value of #AtspiModifierType. | | * One higher than the highest valid value of #AtspiModifierType. | |
| */ | | **/ | |
| #define ATSPI_MODIFIERTYPE_COUNT (7+1) | | #define ATSPI_MODIFIERTYPE_COUNT (7+1) | |
| | | | |
| /** | | /** | |
|
| * | | * AtspiRelationType: | |
| ATSPI_RelationType: | | | |
| * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not | | * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not | |
|
| * normally encounter this RelationType value. | | * normally encounter this #AtspiRelationType value. | |
| * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objec
ts. | | * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objec
ts. | |
| * @ATSPI_RELATION_LABELLED_BY: Object is labelled by one or more other | | * @ATSPI_RELATION_LABELLED_BY: Object is labelled by one or more other | |
| * objects. | | * objects. | |
| * @ATSPI_RELATION_CONTROLLER_FOR: Object is an interactive object which | | * @ATSPI_RELATION_CONTROLLER_FOR: Object is an interactive object which | |
|
| * modifies the state, onscreen location, or other attributes of one
or more | | * modifies the state, onscreen location, or other attributes of one or mor
e | |
| * target objects. | | * target objects. | |
| * @ATSPI_RELATION_CONTROLLED_BY: Object state, position, etc. is | | * @ATSPI_RELATION_CONTROLLED_BY: Object state, position, etc. is | |
|
| * modified/controlled by user interaction with one or more other ob | | * modified/controlled by user interaction with one or more other objects. | |
| jects. | | * For instance a viewport or scroll pane may be @ATSPI_RELATION_CONTROLLED | |
| * For instance a viewport or scroll pane may be CONTROLLED_BY scrollbars. | | _BY | |
| | | * scrollbars. | |
| * @ATSPI_RELATION_MEMBER_OF: Object has a grouping relationship (e.g. 'sam
e | | * @ATSPI_RELATION_MEMBER_OF: Object has a grouping relationship (e.g. 'sam
e | |
| * group as') to one or more other objects. | | * group as') to one or more other objects. | |
| * @ATSPI_RELATION_TOOLTIP_FOR: Object is a tooltip associated with another | | * @ATSPI_RELATION_TOOLTIP_FOR: Object is a tooltip associated with another | |
| * object. | | * object. | |
| * @ATSPI_RELATION_NODE_CHILD_OF: Object is a child of the target. | | * @ATSPI_RELATION_NODE_CHILD_OF: Object is a child of the target. | |
| * @ATSPI_RELATION_NODE_PARENT_OF: Object is a parent of the target. | | * @ATSPI_RELATION_NODE_PARENT_OF: Object is a parent of the target. | |
| * @ATSPI_RELATION_EXTENDED: Used to indicate that a relationship exists, b
ut | | * @ATSPI_RELATION_EXTENDED: Used to indicate that a relationship exists, b
ut | |
|
| * its type is not specified in the enumeration and must be obtained | | * its type is not specified in the enumeration. | |
| via a | | | |
| * call to getRelationTypeName. | | | |
| * @ATSPI_RELATION_FLOWS_TO: Object renders content which flows logically t
o | | * @ATSPI_RELATION_FLOWS_TO: Object renders content which flows logically t
o | |
|
| * another object. For instance, text in a paragraph may flow to an | | * another object. For instance, text in a paragraph may flow to another | |
| other | | * object which is not the 'next sibling' in the accessibility hierarchy. | |
| * object which is not the 'next sibling' in the accessibility hiera | | * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of @ATSPI_RELATION_FLOWS_TO. | |
| rchy. | | | |
| * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of RELATION_FLOWS_TO. | | | |
| * @ATSPI_RELATION_SUBWINDOW_OF: Object is visually and semantically consid
ered | | * @ATSPI_RELATION_SUBWINDOW_OF: Object is visually and semantically consid
ered | |
|
| * a subwindow of another object, even though it is not the object's | | * a subwindow of another object, even though it is not the object's child. | |
| child. | | * Useful when dealing with embedded applications and other cases where the | |
| * Useful when dealing with embedded applications and other cases whe | | | |
| re the | | | |
| * widget hierarchy does not map cleanly to the onscreen presentation. | | * widget hierarchy does not map cleanly to the onscreen presentation. | |
|
| * @ATSPI_RELATION_EMBEDS: Similar to SUBWINDOW_OF, but specifically used f | | * @ATSPI_RELATION_EMBEDS: Similar to @ATSPI_RELATION_SUBWINDOW_OF, but | |
| or | | * specifically used for cross-process embedding. | |
| * cross-process embedding. | | * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of @ATSPI_RELATION_EMBEDS. Used | |
| * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of RELATION_EMBEDS; Used to deno | | to | |
| te | | * denote content rendered by embedded renderers that live in a separate pr | |
| * content rendered by embedded renderers that live in a separate pro | | ocess | |
| cess | | | |
| * space from the embedding context. | | * space from the embedding context. | |
| * @ATSPI_RELATION_POPUP_FOR: Denotes that the object is a transient window
or | | * @ATSPI_RELATION_POPUP_FOR: Denotes that the object is a transient window
or | |
|
| * frame associated with another onscreen object. Similar to TOOLTIP_ | | * frame associated with another onscreen object. Similar to @ATSPI_TOOLTIP | |
| FOR, | | _FOR, | |
| * but more general. Useful for windows which are technically tople | | * but more general. Useful for windows which are technically toplevels | |
| vels | | * but which, for one or more reasons, do not explicitly cause their | |
| * but which, for one or more reasons, do not explicitly cause their associ | | * associated window to lose 'window focus'. Creation of an @ATSPI_ROLE_WIN | |
| ated | | DOW | |
| * window to lose 'window focus'. Creation of a ROLE_WINDOW object with | | * object with the @ATSPI_RELATION_POPUP_FOR relation usually requires | |
| the | | * some presentation action on the part | |
| * POPUP_FOR relation usually requires some presentation action on th | | * of assistive technology clients, even though the previous toplevel | |
| e part | | * @ATSPI_ROLE_FRAME object may still be the active window. | |
| * of assistive technology clients, even though the previous toplevel | | | |
| * ROLE_FRAME object may still be the active window. | | | |
| * @ATSPI_RELATION_PARENT_WINDOW_OF: This is the reciprocal relation to | | * @ATSPI_RELATION_PARENT_WINDOW_OF: This is the reciprocal relation to | |
|
| * RELATION_POPUP_FOR. | | * @ATSPI_RELATION_POPUP_FOR. | |
| * @ATSPI_RELATION_DESCRIPTION_FOR: Indicates that an object provides | | * @ATSPI_RELATION_DESCRIPTION_FOR: Indicates that an object provides | |
|
| * descriptive information about another object; more verbose than | | * descriptive information about another object; more verbose than | |
| * RELATION_LABEL_FOR. | | * @ATSPI_RELATION_LABEL_FOR. | |
| * @ATSPI_RELATION_DESCRIBED_BY: Indicates that another object provides | | * @ATSPI_RELATION_DESCRIBED_BY: Indicates that another object provides | |
|
| * descriptive information about this object; more verbose than | | * descriptive information about this object; more verbose than | |
| * RELATION_LABELLED_BY. | | * @ATSPI_RELATION_LABELLED_BY. | |
| * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to | | * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to | |
| * determine the size of the enumeration. | | * determine the size of the enumeration. | |
| * | | * | |
|
| * RelationType specifies a relationship between objects (possibly one-to-m | | * #AtspiRelationType specifies a relationship between objects | |
| any | | * (possibly one-to-many | |
| * or many-to-one) outside of the normal parent/child hierarchical | | * or many-to-one) outside of the normal parent/child hierarchical | |
| * relationship. It allows better semantic identification of how obj | | * relationship. It allows better semantic identification of how obje | |
| ects | | cts | |
| * are associated with one another. For instance the RELATION_LABELLE | | * are associated with one another. For instance the | |
| D_BY | | * @ATSPI_RELATION_LABELLED_BY | |
| * relationship may be used to identify labelling information that sh
ould | | * relationship may be used to identify labelling information that sh
ould | |
|
| * accompany the accessibleName property when presenting an object's conten | | * accompany the accessible name property when presenting an object's conte | |
| t or | | nt or | |
| * identity to the end user. Similarly, RELATION_CONTROLLER_FOR can | | * identity to the end user. Similarly, | |
| be used | | * @ATSPI_RELATION_CONTROLLER_FOR can be used | |
| * to further specify the context in which a valuator is useful, and/ | | * to further specify the context in which a valuator is useful, and/or the | |
| or the | | * other UI components which are directly effected by user interactions wit | |
| * other UI components which are directly effected by user interactio | | h | |
| ns with | | * the valuator. Common examples include association of scrollbars with the | |
| * the valuator. Common examples include association of scrollbars with | | | |
| the | | | |
| * viewport or panel which they control. | | * viewport or panel which they control. | |
| * | | * | |
|
| * Bitfield/set of flags generated from the AT-SPI specification. | | * | |
| */ | | * Enumeration used to specify | |
| | | * the type of relation encapsulated in an #AtspiRelation object. | |
| | | * | |
| | | **/ | |
| 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, | |
| ATSPI_RELATION_TOOLTIP_FOR, | | ATSPI_RELATION_TOOLTIP_FOR, | |
| ATSPI_RELATION_NODE_CHILD_OF, | | ATSPI_RELATION_NODE_CHILD_OF, | |
| ATSPI_RELATION_NODE_PARENT_OF, | | ATSPI_RELATION_NODE_PARENT_OF, | |
| | | | |
| skipping to change at line 783 | | skipping to change at line 793 | |
| ATSPI_RELATION_POPUP_FOR, | | ATSPI_RELATION_POPUP_FOR, | |
| ATSPI_RELATION_PARENT_WINDOW_OF, | | ATSPI_RELATION_PARENT_WINDOW_OF, | |
| ATSPI_RELATION_DESCRIPTION_FOR, | | ATSPI_RELATION_DESCRIPTION_FOR, | |
| ATSPI_RELATION_DESCRIBED_BY, | | ATSPI_RELATION_DESCRIBED_BY, | |
| ATSPI_RELATION_LAST_DEFINED, | | ATSPI_RELATION_LAST_DEFINED, | |
| } AtspiRelationType; | | } AtspiRelationType; | |
| | | | |
| /** | | /** | |
| * ATSPI_RELATIONTYPE_COUNT: | | * ATSPI_RELATIONTYPE_COUNT: | |
| * | | * | |
|
| * 1 higher than the highest valid value of #AtspiRelationType. | | * One higher than the highest valid value of #AtspiRelationType. | |
| */ | | **/ | |
| #define ATSPI_RELATIONTYPE_COUNT (19+1) | | #define ATSPI_RELATIONTYPE_COUNT (19+1) | |
| | | | |
| /** | | /** | |
|
| * | | * AtspiRole: | |
| ATSPI_Role: | | * @ATSPI_ROLE_INVALID: A role indicating an error condition, such as | |
| * @ATSPI_ROLE_INVALID: A Role indicating an error condition, such as | | | |
| * uninitialized Role data. | | * uninitialized Role data. | |
| * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard | | * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard | |
|
| * accelerators for the parent | | * accelerators for the parent. | |
| * @ATSPI_ROLE_ALERT: Object is used to alert the user about something | | * @ATSPI_ROLE_ALERT: Object is used to alert the user about something. | |
| * @ATSPI_ROLE_ANIMATION: Object contains a dynamic or moving image of some | | * @ATSPI_ROLE_ANIMATION: Object contains a dynamic or moving image of some | |
|
| * kind | | * kind. | |
| * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator | | * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator. | |
| * @ATSPI_ROLE_CALENDAR: Object contains one or more dates, usually arrange
d | | * @ATSPI_ROLE_CALENDAR: Object contains one or more dates, usually arrange
d | |
|
| * into a 2d list | | * into a 2d list. | |
| * @ATSPI_ROLE_CANVAS: Object that can be drawn into and is used to trap | | * @ATSPI_ROLE_CANVAS: Object that can be drawn into and is used to trap | |
|
| * events | | * events. | |
| * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and | | * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and | |
| * provides a separate indicator for the current state. | | * 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: A menu item that behaves like a check box. | |
| see | | See | |
| * ROLE_CHECK_BOX) | | * @ATSPI_ROLE_CHECK_BOX. | |
| * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choos
e a | | * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choos
e a | |
| * color. | | * color. | |
|
| * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data | | * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data. | |
| * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from | | * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from. | |
| * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date | | * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date. | |
| * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_P | | * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_P | |
| ANE | | ANE. | |
| * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and | | * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and | |
|
| * iconified versions of those internal frames. | | * iconified versions of those internal frames. | |
| * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotati
ng a | | * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotati
ng a | |
|
| * visual element, or which displays a value via such a rotating elem | | * visual element, or which displays a value via such a rotating element. | |
| ent. | | * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border. | |
| * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border | | | |
| * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate thro
ugh | | * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate thro
ugh | |
|
| * and select the contents of a directory | | * and select the contents of a directory. | |
| * @ATSPI_ROLE_DRAWING_AREA: A specialized dialog that displays the files i
n | | * @ATSPI_ROLE_DRAWING_AREA: A specialized dialog that displays the files i
n | |
|
| * the directory and lets the user select a file, browse a different | | * the directory and lets the user select a file, browse a different | |
| * directory, or specify a filename. | | * directory, or specify a filename. | |
| * @ATSPI_ROLE_FILE_CHOOSER: An object used for drawing custom user interfa
ce | | * @ATSPI_ROLE_FILE_CHOOSER: An object used for drawing custom user interfa
ce | |
| * elements. | | * elements. | |
|
| * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface | | * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface. | |
| * @ATSPI_ROLE_FOCUS_TRAVERSABLE: Don't use, reserved for future use. | | * @ATSPI_ROLE_FOCUS_TRAVERSABLE: Don't use, reserved for future use. | |
|
| * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font | | * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font. | |
| * @ATSPI_ROLE_FRAME: A top level window with a title bar, border, menubar, | | * @ATSPI_ROLE_FRAME: A top level window with a title bar, border, menubar, | |
| * etc. | | * etc. | |
| * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top o
f | | * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top o
f | |
|
| * all panes beneath it | | * all panes beneath it. | |
| * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose childre
n | | * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose childre
n | |
|
| * represent the document content. | | * represent the document content. | |
| * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate | | * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate | |
|
| * components | | * components. | |
| * @ATSPI_ROLE_IMAGE: An image, typically static. | | * @ATSPI_ROLE_IMAGE: An image, typically static. | |
| * @ATSPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a des
ktop | | * @ATSPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a des
ktop | |
| * pane. | | * pane. | |
| * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in
an | | * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in
an | |
|
| * interface | | * interface. | |
| * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to
be | | * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to
be | |
|
| * drawn in layers, providing a form of stacking order. | | * drawn in layers, providing a form of stacking order. | |
| * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user
and | | * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user
and | |
|
| * allows the user to select one or more of them. | | * allows the user to select one or more of them. | |
| * @ATSPI_ROLE_LIST_ITEM: An object that represents an element of a list. | | * @ATSPI_ROLE_LIST_ITEM: An object that represents an element of a list. | |
| * @ATSPI_ROLE_MENU: An object usually found inside a menu bar that contain
s a | | * @ATSPI_ROLE_MENU: An object usually found inside a menu bar that contain
s a | |
|
| * list of actions the user can choose from. | | * list of actions the user can choose from. | |
| * @ATSPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary | | * @ATSPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary | |
|
| * dialog box of an application that contains a list of menus the use
r can | | * dialog box of an application that contains a list of menus the user can | |
| * choose from. | | * choose from. | |
| * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presen
ts | | * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presen
ts | |
|
| * an action the user can choose. | | * an action the user can choose. | |
| * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside
a | | * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside
a | |
|
| * DIALOG | | * dialog. | |
| * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list | | * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list. | |
| * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (o
r | | * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (o
r | |
|
| * page tabs), one at a time, through some mechanism provided by the | | * page tabs), one at a time,through some mechanism provided by the | |
| * object. | | * object. | |
| * @ATSPI_ROLE_PANEL: A generic container that is often used to group objec
ts. | | * @ATSPI_ROLE_PANEL: A generic container that is often used to group objec
ts. | |
| * @ATSPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other pl
aces | | * @ATSPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other pl
aces | |
|
| * where the text content is not shown visibly to the user. | | * where the text content is not shown visibly to the user. | |
| * @ATSPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer
the | | * @ATSPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer
the | |
|
| * user a list of choices, and then hides when the user selects one o
f those | | * user a list of choices, and then hides when the user selects one of thos
e | |
| * choices. | | * choices. | |
| * @ATSPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task
has | | * @ATSPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task
has | |
| * been completed. | | * been completed. | |
| * @ATSPI_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the | | * @ATSPI_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the | |
|
| * application to do something. | | * application to do something. | |
| * @ATSPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other | | * @ATSPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other | |
|
| * radio buttons in the same group to become uncghecked when this one
is | | * radio buttons in the same group to become unchecked when this one is | |
| * checked. | | * checked. | |
| * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio but
ton" | | * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio but
ton" | |
|
| * (see ROLE_RADIO_BUTTON) | | * . See @ATSPI_ROLE_RADIO_BUTTON. | |
| * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a | | * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a | |
|
| * layered pane as its children. | | * layered pane as its children. | |
| * @ATSPI_ROLE_ROW_HEADER: The header for a row of data | | * @ATSPI_ROLE_ROW_HEADER: The header for a row of data. | |
| * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to | | * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to | |
|
| * incrementally view a large amount of data by moving the bounds of
a | | * incrementally view a large amount of data by moving the bounds of a | |
| * viewport along a one-dimensional axis. | | * viewport along a one-dimensional axis. | |
| * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally v
iew | | * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally v
iew | |
|
| * a large amount of information. ROLE_SCROLL_PANE objects are usual | | * a large amount of information. @ATSPI_ROLE_SCROLL_PANE objects are usual | |
| ly | | ly | |
| * accompanied by ROLE_SCROLL_BAR controllers, on which the | | * accompanied by @ATSPI_ROLE_SCROLL_BAR controllers, on which the | |
| * RELATION_CONTROLLER_FOR and RELATION_CONTROLLED_BY reciprocal rela | | * @ATSPI_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY | |
| tions | | * reciprocal relations are set. See #atspi_get_relation_set. | |
| * are set; \see Accessibility::RelationSet. | | | |
| * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide
a | | * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide
a | |
|
| * visible and logical separation of the contents in a menu. | | * visible and logical separation of the contents in a menu. | |
| * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a boun
ded | | * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a boun
ded | |
|
| * range | | * range. | |
| * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices
to | | * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices
to | |
|
| * be selected, and which displays the current choice. Unlike | | * be selected, and which displays the current choice. Unlike | |
| * ROLE_SCROLL_BAR, ROLE_SLIDER objects need not control 'viewport'-l | | * @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control | |
| ike | | * 'viewport'-like objects. | |
| * objects. | | | |
| * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other pane
ls | | * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other pane
ls | |
| * at the same time. | | * at the same time. | |
| * @ATSPI_ROLE_STATUS_BAR: Object displays non-quantitative status informat
ion | | * @ATSPI_ROLE_STATUS_BAR: Object displays non-quantitative status informat
ion | |
|
| * (c.f. ROLE_PROGRESS_BAR) | | * (c.f. @ATSPI_ROLE_PROGRESS_BAR) | |
| * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of ro
ws | | * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of ro
ws | |
| * and columns. | | * and columns. | |
|
| * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. \note | | * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. Note: | |
| * Table cells need not have ROLE_TABLE_CELL, other RoleType values | | * Table cells need not have @ATSPI_ROLE_TABLE_CELL, other | |
| are | | * #AtspiRoleType values are valid as well. | |
| * valid as well. | | | |
| * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular col
umn | | * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular col
umn | |
|
| * in a Table. | | * in an #AtspiTable. | |
| * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in
a | | * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in
a | |
|
| * Table. Table rows and columns may also be labelled via the | | * #AtspiTable. #AtspiTable rows and columns may also be labelled via the | |
| * RELATION_LABEL_FOR/RELATION_LABELLED_BY relationships; see | | * @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships. | |
| * Accessibility.RelationSet. | | * See #atspi_get_relation_set. | |
| * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from men
ubar | | * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from men
ubar | |
| * and shown in its own window. | | * and shown in its own window. | |
|
| * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal | | * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal. | |
| * @ATSPI_ROLE_TEXT: An object that presents text to the user, of nonspecif
ic | | * @ATSPI_ROLE_TEXT: An object that presents text to the user, of nonspecif
ic | |
| * type. | | * type. | |
| * @ATSPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked
or | | * @ATSPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked
or | |
|
| * unchecked, but does not procide a separate indicator for the curre
nt | | * unchecked, but does not procide a separate indicator for the current | |
| * state. | | * state. | |
| * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons
or | | * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons
or | |
|
| * toggle buttons | | * toggle buttons. | |
| * @ATSPI_ROLE_TOOL_TIP: An object that provides information about another | | * @ATSPI_ROLE_TOOL_TIP: An object that provides information about another | |
|
| * object | | * object. | |
| * @ATSPI_ROLE_TREE: An object used to repsent hierarchical information to
the | | * @ATSPI_ROLE_TREE: An object used to repsent hierarchical information to
the | |
| * user. | | * user. | |
| * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and | | * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and | |
|
| * hierarchical info to the user | | * hierarchical info to the user. | |
| * @ATSPI_ROLE_UNKNOWN: The object contains some Accessible information, bu | | * @ATSPI_ROLE_UNKNOWN: The object contains some #AtspiAccessible informati | |
| t | | on, | |
| * its role is not known. | | * but its role is not known. | |
| * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to | | * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to | |
|
| * otherwise clip a larger object or content renderer to a specific | | * otherwise clip a larger object or content renderer to a specific | |
| * onscreen viewport. | | * onscreen viewport. | |
|
| * @ATSPI_ROLE_WINDOW: A ¨top level window¨ with no title or bord
er. | | * @ATSPI_ROLE_WINDOW: A top level window with no title or border. | |
| * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but no
t | | * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but no
t | |
|
| * included in the core enumeration | | * included in the core enumeration. | |
| * @ATSPI_ROLE_HEADER: An object that serves as a document header. | | * @ATSPI_ROLE_HEADER: An object that serves as a document header. | |
| * @ATSPI_ROLE_FOOTER: An object that serves as a document footer. | | * @ATSPI_ROLE_FOOTER: An object that serves as a document footer. | |
| * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of | | * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of | |
|
| * text content. See also ROLE_TEXT. | | * text content. See also @ATSPI_ROLE_TEXT. | |
| * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc. | | * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc. | |
|
| * for text objects which it controls (should have CONTROLLER_FOR | | * for text objects which it controls (should have | |
| * relation to such). | | * @ATSPI_RELATION_CONTROLLER_FOR relation to such). | |
| * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessi
ble | | * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessi
ble | |
|
| * of an application, which may contain ROLE_FRAME objects or other | | * of an application, which may contain @ATSPI_ROLE_FRAME objects or other | |
| * accessible objects. Children of AccessibleDesktop objects are ge | | * accessible objects. Children of #AccessibleDesktop objects are generall | |
| nerally | | y | |
| * ROLE_APPLICATION objects. | | * @ATSPI_ROLE_APPLICATION objects. | |
| * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing item
s | | * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing item
s | |
|
| * for insertion into an entry widget, for instance a list of words | | * for insertion into an entry widget, for instance a list of words for | |
| for | | * completion of a text entry. | |
| * completion of a text entry. | | | |
| * @ATSPI_ROLE_EDITBAR: The object is an editable text object in a toolbar. | | * @ATSPI_ROLE_EDITBAR: The object is an editable text object in a toolbar. | |
| * @ATSPI_ROLE_EMBEDDED: The object is an embedded component container. Th
is | | * @ATSPI_ROLE_EMBEDDED: The object is an embedded component container. Th
is | |
|
| * role is a "grouping" hint that the contained objects share a cont | | * role is a "grouping" hint that the contained objects share a context | |
| ext | | * which is different from the container in which this accessible is | |
| * which is different from the container in which this accessible is | | * embedded. In particular, it is used for some kinds of document embedding | |
| * embedded. In particular, it is used for some kinds of document emb | | , | |
| edding, | | * and for embedding of out-of-process component, "panel applets", etc. | |
| * and for embedding of out-of-process component, "panel applets", et | | | |
| c. | | | |
| * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may b
e | | * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may b
e | |
|
| * entered or modified by the user, provided STATE_EDITABLE is prese | | * entered or modified by the user, provided @ATSPI_STATE_EDITABLE is prese | |
| nt. | | nt. | |
| * A readonly ROLE_ENTRY object (i.e. where STATE_EDITABLE is not present) | | * A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is | |
| implies | | * not present) implies a read-only 'text field' in a form, as opposed to a | |
| * a read-only 'text field' in a form, as opposed to a title, label, | | * title, label, or caption. | |
| or | | | |
| * caption. | | | |
| * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative d
ata. | | * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative d
ata. | |
|
| * It may contain multiple subelements whose attributes and/or descr | | * It may contain multiple subelements whose attributes and/or description | |
| iption | | * may be queried to obtain both the quantitative data and information abo | |
| * may be queried to obtain both the quantitative data and informatio | | ut | |
| n about | | * how the data is being presented. The @ATSPI_LABELLED_BY relation is | |
| * how the data is being presented. The LABELLED_BY relation is parti | | * particularly important in interpreting objects of this type, as is the | |
| cularly | | * accessible description property. See @ATSPI_ROLE_CAPTION. | |
| * important in interpreting objects of this type, as is the | | | |
| * accessible-description property. See ROLE_CAPTION | | | |
| * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usuall
y | | * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usuall
y | |
|
| * textual, about another user interface element such as a table, cha
rt, or | | * textual, about another user interface element such as a table, chart, or | |
| * image. | | * image. | |
| * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container wh
ich | | * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container wh
ich | |
|
| * contains a view of document content. Document frames may occur w | | * contains a view of document content. #AtspiDocument frames may occur wit | |
| ithin | | hin | |
| * another Document instance, in which case the second document may | | * another #AtspiDocument instance, in which case the second document may | |
| be said | | be | |
| * to be embedded in the containing instance. HTML frames are often | | * said to be embedded in the containing instance. HTML frames are often | |
| * ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, sho | | * @ATSPI_ROLE_DOCUMENT_FRAME: Either this object, or a singleton descenda | |
| uld | | nt, | |
| * implement the Document interface. | | * should implement the #AtspiDocument interface. | |
| * @ATSPI_ROLE_HEADING: The object serves as a heading for content which | | * @ATSPI_ROLE_HEADING: The object serves as a heading for content which | |
|
| * follows it in a document. The 'heading level' of the heading, if | | * follows it in a document. The 'heading level' of the heading, if | |
| * availabe, may be obtained by querying the object's attributes. | | * availabe, may be obtained by querying the object's attributes. | |
| * @ATSPI_ROLE_PAGE: The object is a containing instance which encapsulates
a | | * @ATSPI_ROLE_PAGE: The object is a containing instance which encapsulates
a | |
|
| * page of information. ROLE_PAGE is used in documents and content | | * page of information. @ATSPI_ROLE_PAGE is used in documents and content w | |
| which | | hich | |
| * support a paginated navigation model. | | * support a paginated navigation model. | |
| * @ATSPI_ROLE_SECTION: The object is a containing instance of document con
tent | | * @ATSPI_ROLE_SECTION: The object is a containing instance of document con
tent | |
|
| * which constitutes a particular 'logical' section of the document. | | * which constitutes a particular 'logical' section of the document. The | |
| The | | * type of content within a section, and the nature of the section division | |
| * type of content within a section, and the nature of the section di | | * itself, may be obtained by querying the object's attributes. Sections | |
| vision | | | |
| * itself, may be obtained by querying the object's attributes. Sect | | | |
| ions | | | |
| * may be nested. | | * may be nested. | |
| * @ATSPI_ROLE_REDUNDANT_OBJECT: The object is redundant with another objec
t in | | * @ATSPI_ROLE_REDUNDANT_OBJECT: The object is redundant with another objec
t in | |
|
| * the hierarchy, and is exposed for purely technical reasons. Obje | | * the hierarchy, and is exposed for purely technical reasons. Objects of | |
| cts of | | * this role should be ignored by clients, if they are encountered at all. | |
| * 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 | | * @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 | | * which has within it components with which the user can interact in order | |
| order | | * to input information; i.e. the object is a container for pushbuttons, | |
| * to input information; i.e. the object is a container for pushbutto | | * comboboxes, text input fields, and other 'GUI' components. @ATSPI_ROLE_F | |
| ns, | | ORM | |
| * comboboxes, text input fields, and other 'GUI' components. ROLE_ | | * should not, in general, be used for toplevel GUI containers or dialogs, | |
| FORM | | * but should be reserved for 'GUI' containers which occur within document | |
| * should not, in general, be used for toplevel GUI containers or dia | | * content, for instance within Web documents, presentations, or text | |
| 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 | | * documents. Unlike other GUI containers and dialogs which occur inside | |
|
| * application instances, ROLE_FORM containers' components are associated w | | * application instances, @ATSPI_ROLE_FORM containers' components are | |
| ith | | * associated with the current document, rather than the current foreground | |
| * the current document, rather than the current foreground application o | | * application or viewer instance. | |
| r | | | |
| * viewer instance. | | | |
| * @ATSPI_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a | | * @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 | | * hypertext document. Such objects are distinct from 'inline' conte
nt | |
|
| * which may also use the Hypertext/Hyperlink interfaces to indicate | | * which may also use the #AtspiHypertext/#AtspiHyperlink interfacesto indi | |
| the | | cate | |
| * range/location within a text object where an inline or embedded ob | | * the range/location within a text object where an inline or embedded obje | |
| ject | | ct | |
| * lies. | | * lies. | |
| * @ATSPI_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewp
ort | | * @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 | | * which is used to allow composition or input of a 'complex character', | |
| r', | | * in other words it is an "input method window". | |
| * in other words it is an "input method window." | | | |
| * @ATSPI_ROLE_TABLE_ROW: A row in a table. | | * @ATSPI_ROLE_TABLE_ROW: A row in a table. | |
| * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree. | | * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree. | |
| * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a | | * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a | |
| * spreadsheet. | | * spreadsheet. | |
| * @ATSPI_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a | | * @ATSPI_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a | |
| * presentation or slide content. | | * presentation or slide content. | |
| * @ATSPI_ROLE_DOCUMENT_TEXT: A document frame which contains textual conte
nt, | | * @ATSPI_ROLE_DOCUMENT_TEXT: A document frame which contains textual conte
nt, | |
| * such as found in a word processing | | * such as found in a word processing | |
| * application. | | * application. | |
| * @ATSPI_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other | | * @ATSPI_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other | |
| | | | |
| skipping to change at line 1036 | | skipping to change at line 1045 | |
| * hotspots, where each hotspot can be activated resulting in the loading o
f | | * hotspots, where each hotspot can be activated resulting in the loading o
f | |
| * another document or section of a document. | | * another document or section of a document. | |
| * @ATSPI_ROLE_NOTIFICATION: A transitory object designed to present a | | * @ATSPI_ROLE_NOTIFICATION: A transitory object designed to present a | |
| * message to the user, typically at the desktop level rather than inside a | | * message to the user, typically at the desktop level rather than inside a | |
| * particular application. | | * particular application. | |
| * @ATSPI_ROLE_INFO_BAR: An object designed to present a message to the use
r | | * @ATSPI_ROLE_INFO_BAR: An object designed to present a message to the use
r | |
| * within an existing window. | | * within an existing window. | |
| * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of | | * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of | |
| * enumeration. | | * enumeration. | |
| * | | * | |
|
| * Bitfield/set of flags generated from the AT-SPI specification. | | * Enumeration used by interface #AtspiAccessible to specify the role | |
| | | * of an #AtspiAccessible object. | |
| | | * | |
| */ | | */ | |
| 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, | |
| ATSPI_ROLE_CANVAS, | | ATSPI_ROLE_CANVAS, | |
| ATSPI_ROLE_CHECK_BOX, | | ATSPI_ROLE_CHECK_BOX, | |
| | | | |
| skipping to change at line 1148 | | skipping to change at line 1159 | |
| ATSPI_ROLE_GROUPING, | | ATSPI_ROLE_GROUPING, | |
| ATSPI_ROLE_IMAGE_MAP, | | ATSPI_ROLE_IMAGE_MAP, | |
| ATSPI_ROLE_NOTIFICATION, | | ATSPI_ROLE_NOTIFICATION, | |
| ATSPI_ROLE_INFO_BAR, | | 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. | | * One higher than the highest valid value of #AtspiRole. | |
| */ | | */ | |
| #define ATSPI_ROLE_COUNT (90+1) | | #define ATSPI_ROLE_COUNT (90+1) | |
| | | | |
| typedef enum | | typedef enum | |
| { | | { | |
| ATSPI_CACHE_NONE = 0, | | ATSPI_CACHE_NONE = 0, | |
| ATSPI_CACHE_PARENT = 1 << 0, | | ATSPI_CACHE_PARENT = 1 << 0, | |
| ATSPI_CACHE_CHILDREN = 1 << 1, | | ATSPI_CACHE_CHILDREN = 1 << 1, | |
| ATSPI_CACHE_NAME = 1 << 2, | | ATSPI_CACHE_NAME = 1 << 2, | |
| ATSPI_CACHE_DESCRIPTION = 1 << 3, | | ATSPI_CACHE_DESCRIPTION = 1 << 3, | |
| | | | |
End of changes. 177 change blocks. |
| 593 lines changed or deleted | | 508 lines changed or added | |
|