|
||||
File indexing completed on 2025-01-18 09:28:16
0001 /* 0002 * AT-SPI - Assistive Technology Service Provider Interface 0003 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap) 0004 * 0005 * Copyright 2010, 2011 Novell, Inc. 0006 * Copyright (c) 2012 SUSE LINUX Products GmbH, Nuernberg, Germany. 0007 * 0008 * This library is free software; you can redistribute it and/or 0009 * modify it under the terms of the GNU Lesser General Public 0010 * License as published by the Free Software Foundation; either 0011 * version 2.1 of the License, or (at your option) any later version. 0012 * 0013 * This library is distributed in the hope that it will be useful, 0014 * but WITHOUT ANY WARRANTY; without even the implied warranty of 0015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 0016 * Lesser General Public License for more details. 0017 * 0018 * You should have received a copy of the GNU Lesser General Public 0019 * License along with this library; if not, write to the 0020 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 0021 * Boston, MA 02110-1301, USA. 0022 */ 0023 0024 /* TODO: Auto-generate this file again 0025 0026 0027 0028 !\mainpage AT-SPI Interfaces and Subinterfaces 0029 0030 This is the main documentation page for the 0031 Assistive Technology Service Provider Interface (AT-SPI). 0032 0033 \section apps Applications and Interface Components 0034 Namespace Accessibility includes service APIs implemented by 0035 participating applications and their user interface components:\n\n 0036 Accessibility::Accessible\n 0037 Accessibility::Application\n 0038 Accessibility::Desktop\n 0039 Accessibility::Collecgtion\n 0040 Accessibility::Component\n 0041 Accessibility::Hypertext\n 0042 Accessibility::Image\n 0043 Accessibility::Selection\n 0044 Accessibility::Table\n 0045 Accessibility::Text\n 0046 Accessibility::EditableText\n 0047 Accessibility::Value 0048 0049 \section types Enumerated Types 0050 Accessibility defines a number of key enumerated types, including:\n\n 0051 Accessibility::RelationType\n 0052 Accessibility::Role\n 0053 Accessibility::StateType\n 0054 Accessibility::Event\n 0055 Accessibility::EventDetails \n 0056 Accessibility::ScrollType \n 0057 Accessibility::CoordType \n 0058 0059 \section Registry 0060 Accessibility also includes Accessibility::Registry, 0061 which is the service used by assistive technologies and related 0062 AT-SPI clients to register interest in certain classes of events, 0063 enumerate the currently available desktop and application list, 0064 and to synthesize certain kinds of device events. 0065 0066 \section listeners Event Listener Interfaces 0067 Accessibility::EventListener\n 0068 Accessibility::DeviceEventListener 0069 0070 \section helpers Helper Interfaces 0071 0072 The following interfaces may be implemented by assistive technologies 0073 themselves, in order to export their services in a consistent manner or 0074 in order to interoperate with other applications or desktop services.\n 0075 0076 Accessibility::LoginHelper : Implemented by adaptive technologies which 0077 need to participate in user-authentication or login activities, and which 0078 therefore may need negotiation with authentication agents or processes.\n 0079 0080 Accessibility::Selector [NEW]: Implemented by user agents or assistive 0081 technologies which export lists of choices from which the end-user is 0082 expected to make selections. Useful for various types of remote 0083 activation or intercommunication between multiple ATs. 0084 0085 */ 0086 0087 #ifndef _ATSPI_CONSTANTS_H_ 0088 #define _ATSPI_CONSTANTS_H_ 0089 /** 0090 * AtspiConstants: 0091 * 0092 * Constant definitions needed by multiple interfaces. 0093 */ 0094 0095 #ifdef __cplusplus 0096 extern "C" 0097 { 0098 #endif 0099 0100 /** 0101 * AtspiLocaleType: 0102 * @ATSPI_LOCALE_TYPE_MESSAGES: For localizable natural-language messages. 0103 * @ATSPI_LOCALE_TYPE_COLLATE: For regular expression matching and string 0104 * collation. 0105 * @ATSPI_LOCALE_TYPE_CTYPE: For regular expression matching, character 0106 * classification, conversion, case-sensitive comparison, and wide character 0107 * functions. 0108 * @ATSPI_LOCALE_TYPE_MONETARY: For monetary formatting. 0109 * @ATSPI_LOCALE_TYPE_NUMERIC: For number formatting (such as the decimal 0110 * point and the thousands separator). 0111 * @ATSPI_LOCALE_TYPE_TIME: For time and date formatting. 0112 * 0113 * Used by interfaces #AtspiText and #AtspiDocument, this 0114 * enumeration corresponds to the POSIX 'setlocale' enum values. 0115 * 0116 **/ 0117 typedef enum 0118 { 0119 ATSPI_LOCALE_TYPE_MESSAGES, 0120 ATSPI_LOCALE_TYPE_COLLATE, 0121 ATSPI_LOCALE_TYPE_CTYPE, 0122 ATSPI_LOCALE_TYPE_MONETARY, 0123 ATSPI_LOCALE_TYPE_NUMERIC, 0124 ATSPI_LOCALE_TYPE_TIME, 0125 } AtspiLocaleType; 0126 0127 /** 0128 * ATSPI_LOCALE_TYPE_COUNT: 0129 * 0130 * One higher than the highest valid value of #AtspiLocaleType. 0131 **/ 0132 #define ATSPI_LOCALE_TYPE_COUNT (5 + 1) 0133 0134 /** 0135 * AtspiCoordType: 0136 * @ATSPI_COORD_TYPE_SCREEN: Specifies xy coordinates relative to the screen. 0137 * @ATSPI_COORD_TYPE_WINDOW: Specifies xy coordinates relative to the widget's 0138 * top-level window. 0139 * @ATSPI_COORD_TYPE_PARENT: Specifies xy coordinates relative to the widget's 0140 * immediate parent. 0141 * 0142 * Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces 0143 * to specify whether coordinates are relative to the window or the screen. 0144 * 0145 **/ 0146 typedef enum 0147 { 0148 ATSPI_COORD_TYPE_SCREEN, 0149 ATSPI_COORD_TYPE_WINDOW, 0150 ATSPI_COORD_TYPE_PARENT, 0151 } AtspiCoordType; 0152 0153 /** 0154 * ATSPI_COORD_TYPE_COUNT: 0155 * 0156 * One higher than the highest valid value of #AtspiCoordType. 0157 **/ 0158 #define ATSPI_COORD_TYPE_COUNT (2 + 1) 0159 0160 /** 0161 * AtspiCollectionSortOrder: 0162 * @ATSPI_Collection_SORT_ORDER_INVALID: Invalid sort order 0163 * @ATSPI_Collection_SORT_ORDER_CANONICAL: Canonical sort order 0164 * @ATSPI_Collection_SORT_ORDER_FLOW: Flow sort order 0165 * @ATSPI_Collection_SORT_ORDER_TAB: Tab sort order 0166 * @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL: Reverse canonical sort order 0167 * @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW: Reverse flow sort order 0168 * @ATSPI_Collection_SORT_ORDER_REVERSE_TAB: Reverse tab sort order 0169 * @ATSPI_Collection_SORT_ORDER_LAST_DEFINED: Used only to determine the end of the 0170 * enumeration. 0171 0172 * 0173 * Enumeration used by interface #AtspiCollection to specify 0174 * the way #AtspiAccesible objects should be sorted. 0175 * 0176 **/ 0177 typedef enum 0178 { 0179 ATSPI_Collection_SORT_ORDER_INVALID, 0180 ATSPI_Collection_SORT_ORDER_CANONICAL, 0181 ATSPI_Collection_SORT_ORDER_FLOW, 0182 ATSPI_Collection_SORT_ORDER_TAB, 0183 ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL, 0184 ATSPI_Collection_SORT_ORDER_REVERSE_FLOW, 0185 ATSPI_Collection_SORT_ORDER_REVERSE_TAB, 0186 ATSPI_Collection_SORT_ORDER_LAST_DEFINED, 0187 } AtspiCollectionSortOrder; 0188 0189 /** 0190 * ATSPI_SORTORDER_COUNT: 0191 * 0192 * One higher than the highest valid value of #AtspiCollectionSortOrder. 0193 */ 0194 #define ATSPI_SORTORDER_COUNT (7 + 1) 0195 0196 /** 0197 * AtspiCollectionMatchType: 0198 * @ATSPI_Collection_MATCH_INVALID: Indicates an error condition or 0199 * uninitialized value. 0200 * @ATSPI_Collection_MATCH_ALL: #TRUE if all of the criteria are met. 0201 * @ATSPI_Collection_MATCH_ANY: #TRUE if any of the criteria are met. 0202 * @ATSPI_Collection_MATCH_NONE: #TRUE if none of the criteria are met. 0203 * @ATSPI_Collection_MATCH_EMPTY: Same as @ATSPI_Collection_MATCH_ALL if 0204 * the criteria is non-empty; for empty criteria this rule requires returned 0205 * value to also have empty set. 0206 * @ATSPI_Collection_MATCH_LAST_DEFINED: Used only to determine the end of the 0207 * enumeration. 0208 * 0209 * Enumeration used by #AtspiMatchRule to specify 0210 * how to interpret #AtspiAccessible objects. 0211 * 0212 **/ 0213 typedef enum 0214 { 0215 ATSPI_Collection_MATCH_INVALID, 0216 ATSPI_Collection_MATCH_ALL, 0217 ATSPI_Collection_MATCH_ANY, 0218 ATSPI_Collection_MATCH_NONE, 0219 ATSPI_Collection_MATCH_EMPTY, 0220 ATSPI_Collection_MATCH_LAST_DEFINED, 0221 } AtspiCollectionMatchType; 0222 0223 /** 0224 * ATSPI_MATCHTYPE_COUNT: 0225 * 0226 * One higher than the highest valid value of #AtspiCollectionMatchType. 0227 **/ 0228 #define ATSPI_MATCHTYPES_COUNT (5 + 1) 0229 0230 /** 0231 * AtspiCollectionTreeTraversalType: 0232 * @ATSPI_Collection_TREE_RESTRICT_CHILDREN: Restrict children tree traveral 0233 * @ATSPI_Collection_TREE_RESTRICT_SIBLING: Restrict sibling tree traversal 0234 * @ATSPI_Collection_TREE_INORDER: In-order tree traversal. 0235 * @ATSPI_Collection_TREE_LAST_DEFINED: Used only to determine the end of the 0236 * enumeration. 0237 * 0238 * Enumeration used by interface #AtspiCollection to specify 0239 * restrictions on #AtspiAccesible objects to be traversed. 0240 * 0241 **/ 0242 typedef enum 0243 { 0244 ATSPI_Collection_TREE_RESTRICT_CHILDREN, 0245 ATSPI_Collection_TREE_RESTRICT_SIBLING, 0246 ATSPI_Collection_TREE_INORDER, 0247 ATSPI_Collection_TREE_LAST_DEFINED, 0248 } AtspiCollectionTreeTraversalType; 0249 0250 /** 0251 * ATSPI_TREETRAVERSALTYPE_COUNT: 0252 * 0253 * One higher than the highest valid value of 0254 * #AtspiCollection_TreeTraversalType. 0255 */ 0256 #define ATSPI_TREETRAVERSALTYPE_COUNT (3 + 1) 0257 0258 /** 0259 * AtspiComponentLayer: 0260 * @ATSPI_LAYER_INVALID: Indicates an error condition or uninitialized value. 0261 * @ATSPI_LAYER_BACKGROUND: The bottom-most layer, over which everything else 0262 * is painted. The 'desktop background' is generally in this layer. 0263 * @ATSPI_LAYER_CANVAS: The 'background' layer for most content renderers and 0264 * UI #AtspiComponent containers. 0265 * @ATSPI_LAYER_WIDGET: The layer in which the majority of ordinary 0266 * 'foreground' widgets reside. 0267 * @ATSPI_LAYER_MDI: A special layer between @ATSPI_LAYER_CANVAS and 0268 * @ATSPI_LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames) 0269 * reside. See #atspi_component_get_mdi_z_order. 0270 * @ATSPI_LAYER_POPUP: A layer for popup window content, above 0271 * @ATSPI_LAYER_WIDGET. 0272 * @ATSPI_LAYER_OVERLAY: The topmost layer. 0273 * @ATSPI_LAYER_WINDOW: The layer in which a toplevel window background usually 0274 * resides. 0275 * @ATSPI_LAYER_LAST_DEFINED: Used only to determine the end of the 0276 * enumeration. 0277 * 0278 * The #AtspiComponentLayer of an #AtspiComponent instance indicates its 0279 * relative stacking order with respect to the onscreen visual representation 0280 * of the UI. #AtspiComponentLayer, in combination with #AtspiComponent bounds 0281 * information, can be used to compute the visibility of all or part of a 0282 * component. This is important in programmatic determination of 0283 * region-of-interest for magnification, and in 0284 * flat screen review models of the screen, as well as 0285 * for other uses. Objects residing in two of the #AtspiComponentLayer 0286 * categories support further z-ordering information, with respect to their 0287 * peers in the same layer: namely, @ATSPI_LAYER_WINDOW and 0288 * @ATSPI_LAYER_MDI. Relative stacking order for other objects within the 0289 * same layer is not available; the recommended heuristic is 0290 * first child paints first. In other words, assume that the 0291 * first siblings in the child list are subject to being overpainted by later 0292 * siblings if their bounds intersect. The order of layers, from bottom to top, 0293 * is: @ATSPI_LAYER_BACKGROUND, @ATSPI_LAYER_WINDOW, @ATSPI_LAYER_MDI, 0294 * @ATSPI_LAYER_CANVAS, @ATSPI_LAYER_WIDGET, @ATSPI_LAYER_POPUP, and 0295 * @ATSPI_LAYER_OVERLAY. 0296 * 0297 */ 0298 typedef enum 0299 { 0300 ATSPI_LAYER_INVALID, 0301 ATSPI_LAYER_BACKGROUND, 0302 ATSPI_LAYER_CANVAS, 0303 ATSPI_LAYER_WIDGET, 0304 ATSPI_LAYER_MDI, 0305 ATSPI_LAYER_POPUP, 0306 ATSPI_LAYER_OVERLAY, 0307 ATSPI_LAYER_WINDOW, 0308 ATSPI_LAYER_LAST_DEFINED, 0309 } AtspiComponentLayer; 0310 0311 /** 0312 * ATSPI_COMPONENTLAYER_COUNT: 0313 * 0314 * One higher than the highest valid value of #AtspiComponentLayer. 0315 **/ 0316 #define ATSPI_COMPONENTLAYER_COUNT (8 + 1) 0317 0318 /** 0319 * AtspiTextBoundaryType: 0320 * @ATSPI_TEXT_BOUNDARY_CHAR: An #AtspiText instance is bounded by this 0321 * character only. Start and end offsets differ by one, by definition, 0322 * for this value. 0323 * @ATSPI_TEXT_BOUNDARY_WORD_START: Boundary condition is start of a word; i.e. 0324 * range is from start of one word to the start of another word. 0325 * @ATSPI_TEXT_BOUNDARY_WORD_END: Boundary condition is the end of a word; i.e. 0326 * range is from the end of one word to the end of another. Some locales 0327 * may not distinguish between words and characters or glyphs. In particular, 0328 * those locales which use wholly or partially ideographic character sets. 0329 * In these cases, characters may be returned in lieu of multi-character 0330 * substrings. 0331 * @ATSPI_TEXT_BOUNDARY_SENTENCE_START: Boundary condition is start of a 0332 * sentence, as determined by the application. Some locales or 0333 * character sets may not include explicit sentence delimiters, so this 0334 * boundary type can not always be honored. Some locales will return lines 0335 * of text instead of grammatical sentences. 0336 * @ATSPI_TEXT_BOUNDARY_SENTENCE_END: Boundary condition is end of a sentence, 0337 * as determined by the application, including the sentence-delimiting 0338 * character, for instance '.' Some locales or character sets may not 0339 * include explicit sentence delimiters, so this boundary type can not 0340 * always be honored. Some locales will return lines of text instead of 0341 * grammatical sentences. 0342 * @ATSPI_TEXT_BOUNDARY_LINE_START: Boundary condition is the start of a line; 0343 * i.e. range is from start of one line to the start of another. This 0344 * generally means that an end-of-line character will appear at the end of 0345 * the range. 0346 * @ATSPI_TEXT_BOUNDARY_LINE_END: Boundary condition is the end of a line; i.e. 0347 * range is from start of one line to the start of another. This generally 0348 * means that an end-of-line character will be the first character of the 0349 * range. 0350 * 0351 * Specifies the boundary conditions determining a run of text as returned from 0352 * #atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, and 0353 * #atspi_text_get_text_before_offset. 0354 * 0355 * This enumerationis deprecated since 2.9.90 and should not be used. Use 0356 * AtspiTextGranularity with #atspi_text_get_string_at_offset instead. 0357 **/ 0358 typedef enum 0359 { 0360 ATSPI_TEXT_BOUNDARY_CHAR, 0361 ATSPI_TEXT_BOUNDARY_WORD_START, 0362 ATSPI_TEXT_BOUNDARY_WORD_END, 0363 ATSPI_TEXT_BOUNDARY_SENTENCE_START, 0364 ATSPI_TEXT_BOUNDARY_SENTENCE_END, 0365 ATSPI_TEXT_BOUNDARY_LINE_START, 0366 ATSPI_TEXT_BOUNDARY_LINE_END, 0367 } AtspiTextBoundaryType; 0368 0369 /** 0370 *AtspiTextGranularity: 0371 *@ATSPI_TEXT_GRANULARITY_CHAR: Granularity is defined by the boundaries between characters 0372 * (including non-printing characters) 0373 *@ATSPI_TEXT_GRANULARITY_WORD: Granularity is defined by the boundaries of a word, 0374 * starting at the beginning of the current word and finishing at the beginning of 0375 * the following one, if present. 0376 *@ATSPI_TEXT_GRANULARITY_SENTENCE: Granularity is defined by the boundaries of a sentence, 0377 * starting at the beginning of the current sentence and finishing at the beginning of 0378 * the following one, if present. 0379 *@ATSPI_TEXT_GRANULARITY_LINE: Granularity is defined by the boundaries of a line, 0380 * starting at the beginning of the current line and finishing at the beginning of 0381 * the following one, if present. 0382 *@ATSPI_TEXT_GRANULARITY_PARAGRAPH: Granularity is defined by the boundaries of a paragraph, 0383 * starting at the beginning of the current paragraph and finishing at the beginning of 0384 * the following one, if present. 0385 * 0386 * Text granularity types used for specifying the granularity of the region of 0387 * text we are interested in. 0388 **/ 0389 typedef enum 0390 { 0391 ATSPI_TEXT_GRANULARITY_CHAR, 0392 ATSPI_TEXT_GRANULARITY_WORD, 0393 ATSPI_TEXT_GRANULARITY_SENTENCE, 0394 ATSPI_TEXT_GRANULARITY_LINE, 0395 ATSPI_TEXT_GRANULARITY_PARAGRAPH 0396 } AtspiTextGranularity; 0397 0398 /** 0399 * ATSPI_TEXT_BOUNDARY_TYPE_COUNT: 0400 * 0401 * One higher than the highest valid value of #AtspiTextBoundaryType. 0402 */ 0403 #define ATSPI_TEXT_BOUNDARY_TYPE_COUNT (6 + 1) 0404 0405 /** 0406 * AtspiTextClipType: 0407 * @ATSPI_TEXT_CLIP_NONE: No characters/glyphs are omitted. 0408 * @ATSPI_TEXT_CLIP_MIN: Characters/glyphs clipped by the minimum coordinate 0409 * are omitted. 0410 * @ATSPI_TEXT_CLIP_MAX: Characters/glyphs which intersect the maximum 0411 * coordinate are omitted. 0412 * @ATSPI_TEXT_CLIP_BOTH: Only glyphs falling entirely within the region 0413 * bounded by min and max are retained. 0414 * 0415 * Enumeration used by interface #AtspiText to indicate 0416 * how to treat characters intersecting bounding boxes. 0417 * 0418 **/ 0419 typedef enum 0420 { 0421 ATSPI_TEXT_CLIP_NONE, 0422 ATSPI_TEXT_CLIP_MIN, 0423 ATSPI_TEXT_CLIP_MAX, 0424 ATSPI_TEXT_CLIP_BOTH, 0425 } AtspiTextClipType; 0426 0427 /** 0428 * ATSPI_TEXT_CLIP_TYPE_COUNT: 0429 * 0430 * One higher than the highest valid value of #AtspiTextClipType. 0431 */ 0432 #define ATSPI_TEXT_CLIP_TYPE_COUNT (3 + 1) 0433 0434 /** 0435 * AtspiStateType: 0436 * @ATSPI_STATE_INVALID: Indicates an invalid state - probably an error 0437 * condition. 0438 * @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, or 0439 * an object is the active subelement within a container or table. 0440 * @ATSPI_STATE_ACTIVE should not be used for objects which have 0441 * #ATSPI_STATE_FOCUSABLE or #ATSPI_STATE_SELECTABLE: Those objects should use 0442 * @ATSPI_STATE_FOCUSED and @ATSPI_STATE_SELECTED respectively. 0443 * @ATSPI_STATE_ACTIVE is a means to indicate that an object which is not 0444 * focusable and not selectable is the currently-active item within its 0445 * parent container. 0446 * @ATSPI_STATE_ARMED: Indicates that the object is armed. 0447 * @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen 0448 * representation is in the process of changing, or the object is 0449 * temporarily unavailable for interaction due to activity already in progress. 0450 * @ATSPI_STATE_CHECKED: Indicates this object is currently checked. 0451 * @ATSPI_STATE_COLLAPSED: Indicates this object is collapsed. 0452 * @ATSPI_STATE_DEFUNCT: Indicates that this object no longer has a valid 0453 * backing widget (for instance, if its peer object has been destroyed). 0454 * @ATSPI_STATE_EDITABLE: Indicates the user can change the contents of this 0455 * object. 0456 * @ATSPI_STATE_ENABLED: Indicates that this object is enabled, i.e. that it 0457 * currently reflects some application state. Objects that are "greyed out" 0458 * may lack this state, and may lack the @ATSPI_STATE_SENSITIVE if direct 0459 * user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED. 0460 * See @ATSPI_STATE_SENSITIVE. 0461 * @ATSPI_STATE_EXPANDABLE: Indicates this object allows progressive 0462 * disclosure of its children. 0463 * @ATSPI_STATE_EXPANDED: Indicates this object is expanded. 0464 * @ATSPI_STATE_FOCUSABLE: Indicates this object can accept keyboard focus, 0465 * which means all events resulting from typing on the keyboard will 0466 * normally be passed to it when it has focus. 0467 * @ATSPI_STATE_FOCUSED: Indicates this object currently has the keyboard 0468 * focus. 0469 * @ATSPI_STATE_HAS_TOOLTIP: Indicates that the object has an associated 0470 * tooltip. 0471 * @ATSPI_STATE_HORIZONTAL: Indicates the orientation of this object is 0472 * horizontal. 0473 * @ATSPI_STATE_ICONIFIED: Indicates this object is minimized and is 0474 * represented only by an icon. 0475 * @ATSPI_STATE_MODAL: Indicates something must be done with this object 0476 * before the user can interact with an object in a different window. 0477 * @ATSPI_STATE_MULTI_LINE: Indicates this (text) object can contain multiple 0478 * lines of text. 0479 * @ATSPI_STATE_MULTISELECTABLE: Indicates this object allows more than one of 0480 * its children to be selected at the same time, or in the case of text 0481 * objects, that the object supports non-contiguous text selections. 0482 * @ATSPI_STATE_OPAQUE: Indicates this object paints every pixel within its 0483 * rectangular region. It also indicates an alpha value of unity, if it 0484 * supports alpha blending. 0485 * @ATSPI_STATE_PRESSED: Indicates this object is currently pressed. 0486 * @ATSPI_STATE_RESIZABLE: Indicates the size of this object's size is not 0487 * fixed. 0488 * @ATSPI_STATE_SELECTABLE: Indicates this object is the child of an object 0489 * that allows its children to be selected and that this child is one of 0490 * those children that can be selected. 0491 * @ATSPI_STATE_SELECTED: Indicates this object is the child of an object that 0492 * allows its children to be selected and that this child is one of those 0493 * children that has been selected. 0494 * @ATSPI_STATE_SENSITIVE: Indicates this object is sensitive, e.g. to user 0495 * interaction. @ATSPI_STATE_SENSITIVE usually accompanies. 0496 * @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the 0497 * absence of @ATSPI_STATE_ENABLED if the current visible state of the control 0498 * is "disconnected" from the application state. In such cases, direct user 0499 * interaction can often result in the object gaining @ATSPI_STATE_SENSITIVE, 0500 * for instance if a user makes an explicit selection using an object whose 0501 * current state is ambiguous or undefined. See @ATSPI_STATE_ENABLED, 0502 * @ATSPI_STATE_INDETERMINATE. 0503 * @ATSPI_STATE_SHOWING: Indicates this object, the object's parent, the 0504 * object's parent's parent, and so on, are all 'shown' to the end-user, 0505 * i.e. subject to "exposure" if blocking or obscuring objects do not 0506 * interpose between this object and the top of the window stack. 0507 * @ATSPI_STATE_SINGLE_LINE: Indicates this (text) object can contain only a 0508 * single line of text. 0509 * @ATSPI_STATE_STALE: Indicates that the information returned for this object 0510 * may no longer be synchronized with the application state. This can occur 0511 * if the object has @ATSPI_STATE_TRANSIENT, and can also occur towards the 0512 * end of the object peer's lifecycle. 0513 * @ATSPI_STATE_TRANSIENT: Indicates this object is transient. 0514 * @ATSPI_STATE_VERTICAL: Indicates the orientation of this object is vertical; 0515 * for example this state may appear on such objects as scrollbars, text 0516 * objects (with vertical text flow), separators, etc. 0517 * @ATSPI_STATE_VISIBLE: Indicates this object is visible, e.g. has been 0518 * explicitly marked for exposure to the user. @ATSPI_STATE_VISIBLE is no 0519 * guarantee that the object is actually unobscured on the screen, only that 0520 * it is 'potentially' visible, barring obstruction, being scrolled or clipped 0521 * out of the field of view, or having an ancestor container that has not yet 0522 * made visible. A widget is potentially onscreen if it has both 0523 * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING. The absence of 0524 * @ATSPI_STATE_VISIBLE and @ATSPI_STATE_SHOWING is 0525 * semantically equivalent to saying that an object is 'hidden'. 0526 * @ATSPI_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed" 0527 * event is sent when children become 'active' (i.e. are selected or 0528 * navigated to onscreen). Used to prevent need to enumerate all children 0529 * in very large containers, like tables. The presence of 0530 * @ATSPI_STATE_MANAGES_DESCENDANTS is an indication to the client that the 0531 * children should not, and need not, be enumerated by the client. 0532 * Objects implementing this state are expected to provide relevant state 0533 * notifications to listening clients, for instance notifications of 0534 * visibility changes and activation of their contained child objects, without 0535 * the client having previously requested references to those children. 0536 * @ATSPI_STATE_INDETERMINATE: Indicates that a check box or other boolean 0537 * indicator is in a state other than checked or not checked. This 0538 * usually means that the boolean value reflected or controlled by the 0539 * object does not apply consistently to the entire current context. 0540 * For example, a checkbox for the "Bold" attribute of text may have 0541 * @ATSPI_STATE_INDETERMINATE if the currently selected text contains a mixture 0542 * of weight attributes. In many cases interacting with a 0543 * @ATSPI_STATE_INDETERMINATE object will cause the context's corresponding 0544 * boolean attribute to be homogenized, whereupon the object will lose 0545 * @ATSPI_STATE_INDETERMINATE and a corresponding state-changed event will be 0546 * fired. 0547 * @ATSPI_STATE_REQUIRED: Indicates that user interaction with this object is 0548 * 'required' from the user, for instance before completing the 0549 * processing of a form. 0550 * @ATSPI_STATE_TRUNCATED: Indicates that an object's onscreen content 0551 * is truncated, e.g. a text value in a spreadsheet cell. 0552 * @ATSPI_STATE_ANIMATED: Indicates this object's visual representation is 0553 * dynamic, not static. This state may be applied to an object during an 0554 * animated 'effect' and be removed from the object once its visual 0555 * representation becomes static. Some applications, notably content viewers, 0556 * may not be able to detect all kinds of animated content. Therefore the 0557 * absence of this state should not be taken as 0558 * definitive evidence that the object's visual representation is 0559 * static; this state is advisory. 0560 * @ATSPI_STATE_INVALID_ENTRY: This object has indicated an error condition 0561 * due to failure of input validation. For instance, a form control may 0562 * acquire this state in response to invalid or malformed user input. 0563 * @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: This state indicates that the object 0564 * in question implements some form of typeahead or 0565 * pre-selection behavior whereby entering the first character of one or more 0566 * sub-elements causes those elements to scroll into view or become 0567 * selected. Subsequent character input may narrow the selection further as 0568 * long as one or more sub-elements match the string. This state is normally 0569 * only useful and encountered on objects that implement #AtspiSelection. 0570 * In some cases the typeahead behavior may result in full or partial 0571 * completion of the data in the input field, in which case 0572 * these input events may trigger text-changed events from the source. 0573 * @ATSPI_STATE_SELECTABLE_TEXT: This state indicates that the object in 0574 * question supports text selection. It should only be exposed on objects 0575 * which implement the #AtspiText interface, in order to distinguish this state 0576 * from @ATSPI_STATE_SELECTABLE, which infers that the object in question is a 0577 * selectable child of an object which implements #AtspiSelection. While 0578 * similar, text selection and subelement selection are distinct operations. 0579 * @ATSPI_STATE_IS_DEFAULT: This state indicates that the object in question is 0580 * the 'default' interaction object in a dialog, i.e. the one that gets 0581 * activated if the user presses "Enter" when the dialog is initially 0582 * posted. 0583 * @ATSPI_STATE_VISITED: This state indicates that the object (typically a 0584 * hyperlink) has already been activated or invoked, with the result that 0585 * some backing data has been downloaded or rendered. 0586 *@ATSPI_STATE_CHECKABLE: Indicates this object has the potential to 0587 * be checked, such as a checkbox or toggle-able table cell. @Since: 0588 * 2.12 0589 *@ATSPI_STATE_HAS_POPUP: Indicates that the object has a popup 0590 * context menu or sub-level menu which may or may not be 0591 * showing. This means that activation renders conditional content. 0592 * Note that ordinary tooltips are not considered popups in this 0593 * context. @Since: 2.12 0594 * @ATSPI_STATE_READ_ONLY: Indicates that an object which is ENABLED and 0595 * SENSITIVE has a value which can be read, but not modified, by the 0596 * user. @Since: 2.16 0597 * @ATSPI_STATE_LAST_DEFINED: This value of the enumeration should not be used 0598 * as a parameter, it indicates the number of items in the #AtspiStateType 0599 * enumeration. 0600 * 0601 * 0602 * Enumeration used by various interfaces indicating every possible state 0603 * an #AtspiAccesible object can assume. 0604 * 0605 **/ 0606 typedef enum 0607 { 0608 ATSPI_STATE_INVALID, 0609 ATSPI_STATE_ACTIVE, 0610 ATSPI_STATE_ARMED, 0611 ATSPI_STATE_BUSY, 0612 ATSPI_STATE_CHECKED, 0613 ATSPI_STATE_COLLAPSED, 0614 ATSPI_STATE_DEFUNCT, 0615 ATSPI_STATE_EDITABLE, 0616 ATSPI_STATE_ENABLED, 0617 ATSPI_STATE_EXPANDABLE, 0618 ATSPI_STATE_EXPANDED, 0619 ATSPI_STATE_FOCUSABLE, 0620 ATSPI_STATE_FOCUSED, 0621 ATSPI_STATE_HAS_TOOLTIP, 0622 ATSPI_STATE_HORIZONTAL, 0623 ATSPI_STATE_ICONIFIED, 0624 ATSPI_STATE_MODAL, 0625 ATSPI_STATE_MULTI_LINE, 0626 ATSPI_STATE_MULTISELECTABLE, 0627 ATSPI_STATE_OPAQUE, 0628 ATSPI_STATE_PRESSED, 0629 ATSPI_STATE_RESIZABLE, 0630 ATSPI_STATE_SELECTABLE, 0631 ATSPI_STATE_SELECTED, 0632 ATSPI_STATE_SENSITIVE, 0633 ATSPI_STATE_SHOWING, 0634 ATSPI_STATE_SINGLE_LINE, 0635 ATSPI_STATE_STALE, 0636 ATSPI_STATE_TRANSIENT, 0637 ATSPI_STATE_VERTICAL, 0638 ATSPI_STATE_VISIBLE, 0639 ATSPI_STATE_MANAGES_DESCENDANTS, 0640 ATSPI_STATE_INDETERMINATE, 0641 ATSPI_STATE_REQUIRED, 0642 ATSPI_STATE_TRUNCATED, 0643 ATSPI_STATE_ANIMATED, 0644 ATSPI_STATE_INVALID_ENTRY, 0645 ATSPI_STATE_SUPPORTS_AUTOCOMPLETION, 0646 ATSPI_STATE_SELECTABLE_TEXT, 0647 ATSPI_STATE_IS_DEFAULT, 0648 ATSPI_STATE_VISITED, 0649 ATSPI_STATE_CHECKABLE, 0650 ATSPI_STATE_HAS_POPUP, 0651 ATSPI_STATE_READ_ONLY, 0652 ATSPI_STATE_LAST_DEFINED, 0653 } AtspiStateType; 0654 0655 /** 0656 * ATSPI_STATETYPE_COUNT: 0657 * 0658 * One higher than the highest valid value of #AtspiStateType. 0659 **/ 0660 #define ATSPI_STATETYPE_COUNT (41 + 1) 0661 0662 /** 0663 * AtspiKeyEventType: 0664 * @ATSPI_KEY_PRESSED: Key press event 0665 * @ATSPI_KEY_RELEASED: Key release event 0666 * 0667 * Deprecated. Should not be used. 0668 * 0669 **/ 0670 typedef enum 0671 { 0672 ATSPI_KEY_PRESSED, 0673 ATSPI_KEY_RELEASED, 0674 } AtspiKeyEventType; 0675 0676 /** 0677 * ATSPI_KEYEVENTTYPE_COUNT: 0678 * 0679 * One higher than the highest valid value of #AtspiKeyEventType. 0680 **/ 0681 #define ATSPI_KEYEVENTTYPE_COUNT (1 + 1) 0682 0683 /** 0684 * AtspiEventType: 0685 * @ATSPI_KEY_PRESSED_EVENT: Indicates that a key on a keyboard device was 0686 * pressed. 0687 * @ATSPI_KEY_RELEASED_EVENT: Indicates that a key on a keyboard device was 0688 * released. 0689 * @ATSPI_BUTTON_PRESSED_EVENT: Indicates that a button on a non-keyboard 0690 * human interface device (HID) was pressed. 0691 * @ATSPI_BUTTON_RELEASED_EVENT: Indicates that a button on a non-keyboard 0692 * human interface device (HID) was released. 0693 * 0694 * Enumeration used to specify the event types of interest to an 0695 * #AtspiEventListener, or 0696 * to identify the type of an event for which notification has been sent. 0697 * 0698 **/ 0699 typedef enum 0700 { 0701 ATSPI_KEY_PRESSED_EVENT, 0702 ATSPI_KEY_RELEASED_EVENT, 0703 ATSPI_BUTTON_PRESSED_EVENT, 0704 ATSPI_BUTTON_RELEASED_EVENT, 0705 } AtspiEventType; 0706 0707 /** 0708 * ATSPI_EVENTTYPE_COUNT: 0709 * 0710 * One higher than the highest valid value of #AtspiEventType. 0711 */ 0712 #define ATSPI_EVENTTYPE_COUNT (3 + 1) 0713 0714 /** 0715 * AtspiKeySynthType: 0716 * @ATSPI_KEY_PRESS: Emulates the pressing of a hardware keyboard key. 0717 * @ATSPI_KEY_RELEASE: Emulates the release of a hardware keyboard key. 0718 * @ATSPI_KEY_PRESSRELEASE: Emulates the pressing and immediate releasing 0719 * of a hardware keyboard key. 0720 * @ATSPI_KEY_SYM: A symbolic key event is generated, without specifying a 0721 * hardware key. Note: if the keysym is not present in the current keyboard 0722 * map, the #AtspiDeviceEventController instance has a limited ability to 0723 * generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent 0724 * calls using out-of-keymap keysyms will vary from system to system, and on 0725 * the number of different out-of-keymap keysyms being generated in quick 0726 * succession. 0727 * In practice this is rarely significant, since the keysyms of interest to 0728 * AT clients and keyboard emulators are usually part of the current keymap, 0729 * i.e., present on the system keyboard for the current locale (even if a 0730 * physical hardware keyboard is not connected). 0731 * @ATSPI_KEY_STRING: A string is converted to its equivalent keyboard events 0732 * and emitted. If the string consists of complex characters or composed 0733 * characters which are not in the current keymap, string emission is 0734 * subject to the out-of-keymap limitations described for 0735 * @ATSPI_KEY_SYM. In practice this limitation primarily effects 0736 * Chinese and Japanese locales. 0737 * @ATSPI_KEY_LOCKMODIFIERS: Emulates locking a set of modifiers. 0738 * @ATSPI_KEY_UNLOCKMODIFIERS: Emulates unlocking a set of modifiers. 0739 * 0740 * Enumeration used when synthesizing keyboard input via 0741 * #atspi_generate_keyboard_event. 0742 * 0743 **/ 0744 typedef enum 0745 { 0746 ATSPI_KEY_PRESS, 0747 ATSPI_KEY_RELEASE, 0748 ATSPI_KEY_PRESSRELEASE, 0749 ATSPI_KEY_SYM, 0750 ATSPI_KEY_STRING, 0751 ATSPI_KEY_LOCKMODIFIERS, 0752 ATSPI_KEY_UNLOCKMODIFIERS, 0753 } AtspiKeySynthType; 0754 0755 /** 0756 * ATSPI_KEYSYNTHTYPE_COUNT: 0757 * 0758 * One higher than the highest valid value of #AtspiKeySynthType. 0759 **/ 0760 #define ATSPI_KEYSYNTHTYPE_COUNT (4 + 1) 0761 0762 /** 0763 * AtspiModifierType: 0764 * @ATSPI_MODIFIER_SHIFT: The left or right 'Shift' key. 0765 * @ATSPI_MODIFIER_SHIFTLOCK: The ShiftLock or CapsLock key. 0766 * @ATSPI_MODIFIER_CONTROL: 'Control'/'Ctrl'. 0767 * @ATSPI_MODIFIER_ALT: The Alt key (as opposed to AltGr). 0768 * @ATSPI_MODIFIER_META: Depending on the platform, this may map to 'Window', 0769 * 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will 0770 * map to one of META, META2, META3. On X Windows platforms these META 0771 * values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an 0772 * event having @ATSPI_MODIFIER_META2 means that the 'Mod2Mask' bit 0773 * is set in the corresponding XEvent. 0774 * @ATSPI_MODIFIER_META2: See @ATSPI_MODIFIER_META. 0775 * @ATSPI_MODIFIER_META3: See @ATSPI_MODIFIER_META. 0776 * @ATSPI_MODIFIER_NUMLOCK: A symbolic meta key name that is mapped by AT-SPI 0777 * to the appropriate META value, for the convenience of the client. 0778 * 0779 * 0780 * 0781 **/ 0782 typedef enum 0783 { 0784 ATSPI_MODIFIER_SHIFT, 0785 ATSPI_MODIFIER_SHIFTLOCK, 0786 ATSPI_MODIFIER_CONTROL, 0787 ATSPI_MODIFIER_ALT, 0788 ATSPI_MODIFIER_META, 0789 ATSPI_MODIFIER_META2, 0790 ATSPI_MODIFIER_META3, 0791 ATSPI_MODIFIER_NUMLOCK = 14, 0792 } AtspiModifierType; 0793 0794 /** 0795 * ATSPI_MODIFIERTYPE_COUNT: 0796 * 0797 * One higher than the highest valid value of #AtspiModifierType. 0798 **/ 0799 #define ATSPI_MODIFIERTYPE_COUNT (7 + 1) 0800 0801 /** 0802 * AtspiRelationType: 0803 * @ATSPI_RELATION_NULL: Not a meaningful relationship; clients should not 0804 * normally encounter this #AtspiRelationType value. 0805 * @ATSPI_RELATION_LABEL_FOR: Object is a label for one or more other objects. 0806 * @ATSPI_RELATION_LABELLED_BY: Object is labelled by one or more other 0807 * objects. 0808 * @ATSPI_RELATION_CONTROLLER_FOR: Object is an interactive object which 0809 * modifies the state, onscreen location, or other attributes of one or more 0810 * target objects. 0811 * @ATSPI_RELATION_CONTROLLED_BY: Object state, position, etc. is 0812 * modified/controlled by user interaction with one or more other objects. 0813 * For instance a viewport or scroll pane may be @ATSPI_RELATION_CONTROLLED_BY 0814 * scrollbars. 0815 * @ATSPI_RELATION_MEMBER_OF: Object has a grouping relationship (e.g. 'same 0816 * group as') to one or more other objects. 0817 * @ATSPI_RELATION_TOOLTIP_FOR: Object is a tooltip associated with another 0818 * object. 0819 * @ATSPI_RELATION_NODE_CHILD_OF: Object is a child of the target. 0820 * @ATSPI_RELATION_NODE_PARENT_OF: Object is a parent of the target. 0821 * @ATSPI_RELATION_EXTENDED: Used to indicate that a relationship exists, but 0822 * its type is not specified in the enumeration. 0823 * @ATSPI_RELATION_FLOWS_TO: Object renders content which flows logically to 0824 * another object. For instance, text in a paragraph may flow to another 0825 * object which is not the 'next sibling' in the accessibility hierarchy. 0826 * @ATSPI_RELATION_FLOWS_FROM: Reciprocal of @ATSPI_RELATION_FLOWS_TO. 0827 * @ATSPI_RELATION_SUBWINDOW_OF: Object is visually and semantically considered 0828 * a subwindow of another object, even though it is not the object's child. 0829 * Useful when dealing with embedded applications and other cases where the 0830 * widget hierarchy does not map cleanly to the onscreen presentation. 0831 * @ATSPI_RELATION_EMBEDS: Similar to @ATSPI_RELATION_SUBWINDOW_OF, but 0832 * specifically used for cross-process embedding. 0833 * @ATSPI_RELATION_EMBEDDED_BY: Reciprocal of @ATSPI_RELATION_EMBEDS. Used to 0834 * denote content rendered by embedded renderers that live in a separate process 0835 * space from the embedding context. 0836 * @ATSPI_RELATION_POPUP_FOR: Denotes that the object is a transient window or 0837 * frame associated with another onscreen object. Similar to @ATSPI_TOOLTIP_FOR, 0838 * but more general. Useful for windows which are technically toplevels 0839 * but which, for one or more reasons, do not explicitly cause their 0840 * associated window to lose 'window focus'. Creation of an @ATSPI_ROLE_WINDOW 0841 * object with the @ATSPI_RELATION_POPUP_FOR relation usually requires 0842 * some presentation action on the part 0843 * of assistive technology clients, even though the previous toplevel 0844 * @ATSPI_ROLE_FRAME object may still be the active window. 0845 * @ATSPI_RELATION_PARENT_WINDOW_OF: This is the reciprocal relation to 0846 * @ATSPI_RELATION_POPUP_FOR. 0847 * @ATSPI_RELATION_DESCRIPTION_FOR: Reciprocal of %ATSPI_RELATION_DESCRIBED_BY. 0848 * Indicates that this object provides descriptive information about the target 0849 * object(s). See also %ATSPI_RELATION_DETAILS_FOR and %ATSPI_RELATION_ERROR_FOR. 0850 * @ATSPI_RELATION_DESCRIBED_BY: Reciprocal of %ATSPI_RELATION_DESCRIPTION_FOR. 0851 * Indicates that one or more target objects provide descriptive information 0852 * about this object. This relation type is most appropriate for information 0853 * that is not essential as its presentation may be user-configurable and/or 0854 * limited to an on-demand mechanism such as an assistive technology command. 0855 * For brief, essential information such as can be found in a widget's on-screen 0856 * label, use %ATSPI_RELATION_LABELLED_BY. For an on-screen error message, use 0857 * %ATSPI_RELATION_ERROR_MESSAGE. For lengthy extended descriptive information 0858 * contained in an on-screen object, consider using %ATSPI_RELATION_DETAILS as 0859 * assistive technologies may provide a means for the user to navigate to 0860 * objects containing detailed descriptions so that their content can be more 0861 * closely reviewed. 0862 * @ATSPI_RELATION_DETAILS: Reciprocal of %ATSPI_RELATION_DETAILS_FOR. Indicates 0863 * that this object has a detailed or extended description, the contents of 0864 * which can be found in the target object(s). This relation type is most 0865 * appropriate for information that is sufficiently lengthy as to make 0866 * navigation to the container of that information desirable. For less verbose 0867 * information suitable for announcement only, see %ATSPI_RELATION_DESCRIBED_BY. 0868 * If the detailed information describes an error condition, 0869 * %ATSPI_RELATION_ERROR_FOR should be used instead. @Since: 2.26. 0870 * @ATSPI_RELATION_DETAILS_FOR: Reciprocal of %ATSPI_RELATION_DETAILS. Indicates 0871 * that this object provides a detailed or extended description about the target 0872 * object(s). See also %ATSPI_RELATION_DESCRIPTION_FOR and 0873 * %ATSPI_RELATION_ERROR_FOR. @Since: 2.26. 0874 * @ATSPI_RELATION_ERROR_MESSAGE: Reciprocal of %ATSPI_RELATION_ERROR_FOR. 0875 * Indicates that this object has one or more errors, the nature of which is 0876 * described in the contents of the target object(s). Objects that have this 0877 * relation type should also contain %ATSPI_STATE_INVALID_ENTRY in their 0878 * #AtspiStateSet. @Since: 2.26. 0879 * @ATSPI_RELATION_ERROR_FOR: Reciprocal of %ATSPI_RELATION_ERROR_MESSAGE. 0880 * Indicates that this object contains an error message describing an invalid 0881 * condition in the target object(s). @Since: 2.26. 0882 * @ATSPI_RELATION_LAST_DEFINED: Do not use as a parameter value, used to 0883 * determine the size of the enumeration. 0884 * 0885 * #AtspiRelationType specifies a relationship between objects 0886 * (possibly one-to-many 0887 * or many-to-one) outside of the normal parent/child hierarchical 0888 * relationship. It allows better semantic identification of how objects 0889 * are associated with one another. For instance the 0890 * @ATSPI_RELATION_LABELLED_BY 0891 * relationship may be used to identify labelling information that should 0892 * accompany the accessible name property when presenting an object's content or 0893 * identity to the end user. Similarly, 0894 * @ATSPI_RELATION_CONTROLLER_FOR can be used 0895 * to further specify the context in which a valuator is useful, and/or the 0896 * other UI components which are directly effected by user interactions with 0897 * the valuator. Common examples include association of scrollbars with the 0898 * viewport or panel which they control. 0899 * 0900 * 0901 * Enumeration used to specify 0902 * the type of relation encapsulated in an #AtspiRelation object. 0903 * 0904 **/ 0905 typedef enum 0906 { 0907 ATSPI_RELATION_NULL, 0908 ATSPI_RELATION_LABEL_FOR, 0909 ATSPI_RELATION_LABELLED_BY, 0910 ATSPI_RELATION_CONTROLLER_FOR, 0911 ATSPI_RELATION_CONTROLLED_BY, 0912 ATSPI_RELATION_MEMBER_OF, 0913 ATSPI_RELATION_TOOLTIP_FOR, 0914 ATSPI_RELATION_NODE_CHILD_OF, 0915 ATSPI_RELATION_NODE_PARENT_OF, 0916 ATSPI_RELATION_EXTENDED, 0917 ATSPI_RELATION_FLOWS_TO, 0918 ATSPI_RELATION_FLOWS_FROM, 0919 ATSPI_RELATION_SUBWINDOW_OF, 0920 ATSPI_RELATION_EMBEDS, 0921 ATSPI_RELATION_EMBEDDED_BY, 0922 ATSPI_RELATION_POPUP_FOR, 0923 ATSPI_RELATION_PARENT_WINDOW_OF, 0924 ATSPI_RELATION_DESCRIPTION_FOR, 0925 ATSPI_RELATION_DESCRIBED_BY, 0926 ATSPI_RELATION_DETAILS, 0927 ATSPI_RELATION_DETAILS_FOR, 0928 ATSPI_RELATION_ERROR_MESSAGE, 0929 ATSPI_RELATION_ERROR_FOR, 0930 ATSPI_RELATION_LAST_DEFINED, 0931 } AtspiRelationType; 0932 0933 /** 0934 * ATSPI_RELATIONTYPE_COUNT: 0935 * 0936 * One higher than the highest valid value of #AtspiRelationType. 0937 **/ 0938 #define ATSPI_RELATIONTYPE_COUNT (23 + 1) 0939 0940 /** 0941 * AtspiRole: 0942 * @ATSPI_ROLE_INVALID: A role indicating an error condition, such as 0943 * uninitialized Role data. 0944 * @ATSPI_ROLE_ACCELERATOR_LABEL: Object is a label indicating the keyboard 0945 * accelerators for the parent. 0946 * @ATSPI_ROLE_ALERT: Object is used to alert the user about something. 0947 * @ATSPI_ROLE_ANIMATION: Object contains a dynamic or moving image of some 0948 * kind. 0949 * @ATSPI_ROLE_ARROW: Object is a 2d directional indicator. 0950 * @ATSPI_ROLE_CALENDAR: Object contains one or more dates, usually arranged 0951 * into a 2d list. 0952 * @ATSPI_ROLE_CANVAS: Object that can be drawn into and is used to trap 0953 * events. 0954 * @ATSPI_ROLE_CHECK_BOX: A choice that can be checked or unchecked and 0955 * provides a separate indicator for the current state. 0956 * @ATSPI_ROLE_CHECK_MENU_ITEM: A menu item that behaves like a check box. See 0957 * @ATSPI_ROLE_CHECK_BOX. 0958 * @ATSPI_ROLE_COLOR_CHOOSER: A specialized dialog that lets the user choose a 0959 * color. 0960 * @ATSPI_ROLE_COLUMN_HEADER: The header for a column of data. 0961 * @ATSPI_ROLE_COMBO_BOX: A list of choices the user can select from. 0962 * @ATSPI_ROLE_DATE_EDITOR: An object which allows entry of a date. 0963 * @ATSPI_ROLE_DESKTOP_ICON: An inconifed internal frame within a DESKTOP_FRAME. 0964 * @ATSPI_ROLE_DESKTOP_FRAME: A pane that supports internal frames and 0965 * iconified versions of those internal frames. 0966 * @ATSPI_ROLE_DIAL: An object that allows a value to be changed via rotating a 0967 * visual element, or which displays a value via such a rotating element. 0968 * @ATSPI_ROLE_DIALOG: A top level window with title bar and a border. 0969 * @ATSPI_ROLE_DIRECTORY_PANE: A pane that allows the user to navigate through 0970 * and select the contents of a directory. 0971 * @ATSPI_ROLE_DRAWING_AREA: An object used for drawing custom user interface 0972 * elements. 0973 * @ATSPI_ROLE_FILE_CHOOSER: A specialized dialog that displays the files in 0974 * the directory and lets the user select a file, browse a different 0975 * directory, or specify a filename. 0976 * @ATSPI_ROLE_FILLER: A object that fills up space in a user interface. 0977 * @ATSPI_ROLE_FOCUS_TRAVERSABLE: Don't use, reserved for future use. 0978 * @ATSPI_ROLE_FONT_CHOOSER: Allows selection of a display font. 0979 * @ATSPI_ROLE_FRAME: A top level window with a title bar, border, menubar, 0980 * etc. 0981 * @ATSPI_ROLE_GLASS_PANE: A pane that is guaranteed to be painted on top of 0982 * all panes beneath it. 0983 * @ATSPI_ROLE_HTML_CONTAINER: A document container for HTML, whose children 0984 * represent the document content. 0985 * @ATSPI_ROLE_ICON: A small fixed size picture, typically used to decorate 0986 * components. 0987 * @ATSPI_ROLE_IMAGE: An image, typically static. 0988 * @ATSPI_ROLE_INTERNAL_FRAME: A frame-like object that is clipped by a desktop 0989 * pane. 0990 * @ATSPI_ROLE_LABEL: An object used to present an icon or short string in an 0991 * interface. 0992 * @ATSPI_ROLE_LAYERED_PANE: A specialized pane that allows its children to be 0993 * drawn in layers, providing a form of stacking order. 0994 * @ATSPI_ROLE_LIST: An object that presents a list of objects to the user and 0995 * allows the user to select one or more of them. 0996 * @ATSPI_ROLE_LIST_ITEM: An object that represents an element of a list. 0997 * @ATSPI_ROLE_MENU: An object usually found inside a menu bar that contains a 0998 * list of actions the user can choose from. 0999 * @ATSPI_ROLE_MENU_BAR: An object usually drawn at the top of the primary 1000 * dialog box of an application that contains a list of menus the user can 1001 * choose from. 1002 * @ATSPI_ROLE_MENU_ITEM: An object usually contained in a menu that presents 1003 * an action the user can choose. 1004 * @ATSPI_ROLE_OPTION_PANE: A specialized pane whose primary use is inside a 1005 * dialog. 1006 * @ATSPI_ROLE_PAGE_TAB: An object that is a child of a page tab list. 1007 * @ATSPI_ROLE_PAGE_TAB_LIST: An object that presents a series of panels (or 1008 * page tabs), one at a time,through some mechanism provided by the 1009 * object. 1010 * @ATSPI_ROLE_PANEL: A generic container that is often used to group objects. 1011 * @ATSPI_ROLE_PASSWORD_TEXT: A text object uses for passwords, or other places 1012 * where the text content is not shown visibly to the user. 1013 * @ATSPI_ROLE_POPUP_MENU: A temporary window that is usually used to offer the 1014 * user a list of choices, and then hides when the user selects one of those 1015 * choices. 1016 * @ATSPI_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has 1017 * been completed. 1018 * @ATSPI_ROLE_BUTTON: An object the user can manipulate to tell the 1019 * application to do something. 1020 * @ATSPI_ROLE_RADIO_BUTTON: A specialized check box that will cause other 1021 * radio buttons in the same group to become unchecked when this one is 1022 * checked. 1023 * @ATSPI_ROLE_RADIO_MENU_ITEM: Object is both a menu item and a "radio button" 1024 * . See @ATSPI_ROLE_RADIO_BUTTON. 1025 * @ATSPI_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a 1026 * layered pane as its children. 1027 * @ATSPI_ROLE_ROW_HEADER: The header for a row of data. 1028 * @ATSPI_ROLE_SCROLL_BAR: An object usually used to allow a user to 1029 * incrementally view a large amount of data by moving the bounds of a 1030 * viewport along a one-dimensional axis. 1031 * @ATSPI_ROLE_SCROLL_PANE: An object that allows a user to incrementally view 1032 * a large amount of information. @ATSPI_ROLE_SCROLL_PANE objects are usually 1033 * accompanied by @ATSPI_ROLE_SCROLL_BAR controllers, on which the 1034 * @ATSPI_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY 1035 * reciprocal relations are set. See #atspi_get_relation_set. 1036 * @ATSPI_ROLE_SEPARATOR: An object usually contained in a menu to provide a 1037 * visible and logical separation of the contents in a menu. 1038 * @ATSPI_ROLE_SLIDER: An object that allows the user to select from a bounded 1039 * range. Unlike @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control 1040 * 'viewport'-like objects. 1041 * @ATSPI_ROLE_SPIN_BUTTON: An object which allows one of a set of choices to 1042 * be selected, and which displays the current choice. 1043 * @ATSPI_ROLE_SPLIT_PANE: A specialized panel that presents two other panels 1044 * at the same time. 1045 * @ATSPI_ROLE_STATUS_BAR: Object displays non-quantitative status information 1046 * (c.f. @ATSPI_ROLE_PROGRESS_BAR) 1047 * @ATSPI_ROLE_TABLE: An object used to repesent information in terms of rows 1048 * and columns. 1049 * @ATSPI_ROLE_TABLE_CELL: A 'cell' or discrete child within a Table. Note: 1050 * Table cells need not have @ATSPI_ROLE_TABLE_CELL, other 1051 * #AtspiRoleType values are valid as well. 1052 * @ATSPI_ROLE_TABLE_COLUMN_HEADER: An object which labels a particular column 1053 * in an #AtspiTable. 1054 * @ATSPI_ROLE_TABLE_ROW_HEADER: An object which labels a particular row in a 1055 * #AtspiTable. #AtspiTable rows and columns may also be labelled via the 1056 * @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships. 1057 * See #atspi_get_relation_set. 1058 * @ATSPI_ROLE_TEAROFF_MENU_ITEM: Object allows menu to be removed from menubar 1059 * and shown in its own window. 1060 * @ATSPI_ROLE_TERMINAL: An object that emulates a terminal. 1061 * @ATSPI_ROLE_TEXT: An interactive widget that supports multiple lines of text 1062 * and optionally accepts user input, but whose purpose is not to solicit user 1063 * input. Thus @ATSPI_ROLE_TEXT is appropriate for the text view in a plain text 1064 * editor but inappropriate for an input field in a dialog box or web form. For 1065 * widgets whose purpose is to solicit input from the user, see @ATSPI_ROLE_ENTRY 1066 * and @ATSPI_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount 1067 * of textual information, see @ATSPI_ROLE_STATIC. 1068 * @ATSPI_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or 1069 * unchecked, but does not procide a separate indicator for the current 1070 * state. 1071 * @ATSPI_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or 1072 * toggle buttons. 1073 * @ATSPI_ROLE_TOOL_TIP: An object that provides information about another 1074 * object. 1075 * @ATSPI_ROLE_TREE: An object used to repsent hierarchical information to the 1076 * user. 1077 * @ATSPI_ROLE_TREE_TABLE: An object that presents both tabular and 1078 * hierarchical info to the user. 1079 * @ATSPI_ROLE_UNKNOWN: The object contains some #AtspiAccessible information, 1080 * but its role is not known. 1081 * @ATSPI_ROLE_VIEWPORT: An object usually used in a scroll pane, or to 1082 * otherwise clip a larger object or content renderer to a specific 1083 * onscreen viewport. 1084 * @ATSPI_ROLE_WINDOW: A top level window with no title or border. 1085 * @ATSPI_ROLE_EXTENDED: means that the role for this item is known, but not 1086 * included in the core enumeration. Deprecated since 2.24. 1087 * @ATSPI_ROLE_HEADER: An object that serves as a document header. 1088 * @ATSPI_ROLE_FOOTER: An object that serves as a document footer. 1089 * @ATSPI_ROLE_PARAGRAPH: An object which is contains a single paragraph of 1090 * text content. See also @ATSPI_ROLE_TEXT. 1091 * @ATSPI_ROLE_RULER: An object which describes margins and tab stops, etc. 1092 * for text objects which it controls (should have 1093 * @ATSPI_RELATION_CONTROLLER_FOR relation to such). 1094 * @ATSPI_ROLE_APPLICATION: An object corresponding to the toplevel accessible 1095 * of an application, which may contain @ATSPI_ROLE_FRAME objects or other 1096 * accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally 1097 * @ATSPI_ROLE_APPLICATION objects. 1098 * @ATSPI_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items 1099 * for insertion into an entry widget, for instance a list of words for 1100 * completion of a text entry. 1101 * @ATSPI_ROLE_EDITBAR: The object is an editable text object in a toolbar. 1102 * @ATSPI_ROLE_EMBEDDED: The object is an embedded component container. This 1103 * role is a "grouping" hint that the contained objects share a context 1104 * which is different from the container in which this accessible is 1105 * embedded. In particular, it is used for some kinds of document embedding, 1106 * and for embedding of out-of-process component, "panel applets", etc. 1107 * @ATSPI_ROLE_ENTRY: The object is a component whose textual content may be 1108 * entered or modified by the user, provided @ATSPI_STATE_EDITABLE is present. 1109 * A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is 1110 * not present) implies a read-only 'text field' in a form, as opposed to a 1111 * title, label, or caption. 1112 * @ATSPI_ROLE_CHART: The object is a graphical depiction of quantitative data. 1113 * It may contain multiple subelements whose attributes and/or description 1114 * may be queried to obtain both the quantitative data and information about 1115 * how the data is being presented. The @ATSPI_LABELLED_BY relation is 1116 * particularly important in interpreting objects of this type, as is the 1117 * accessible description property. See @ATSPI_ROLE_CAPTION. 1118 * @ATSPI_ROLE_CAPTION: The object contains descriptive information, usually 1119 * textual, about another user interface element such as a table, chart, or 1120 * image. 1121 * @ATSPI_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which 1122 * contains a view of document content. #AtspiDocument frames may occur within 1123 * another #AtspiDocument instance, in which case the second document may be 1124 * said to be embedded in the containing instance. HTML frames are often 1125 * ATSPI_ROLE_DOCUMENT_FRAME: Either this object, or a singleton descendant, 1126 * should implement the #AtspiDocument interface. 1127 * @ATSPI_ROLE_HEADING: The object serves as a heading for content which 1128 * follows it in a document. The 'heading level' of the heading, if 1129 * availabe, may be obtained by querying the object's attributes. 1130 * @ATSPI_ROLE_PAGE: The object is a containing instance which encapsulates a 1131 * page of information. @ATSPI_ROLE_PAGE is used in documents and content which 1132 * support a paginated navigation model. 1133 * @ATSPI_ROLE_SECTION: The object is a containing instance of document content 1134 * which constitutes a particular 'logical' section of the document. The 1135 * type of content within a section, and the nature of the section division 1136 * itself, may be obtained by querying the object's attributes. Sections 1137 * may be nested. 1138 * @ATSPI_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in 1139 * the hierarchy, and is exposed for purely technical reasons. Objects of 1140 * this role should be ignored by clients, if they are encountered at all. 1141 * @ATSPI_ROLE_FORM: The object is a containing instance of document content 1142 * which has within it components with which the user can interact in order 1143 * to input information; i.e. the object is a container for pushbuttons, 1144 * comboboxes, text input fields, and other 'GUI' components. @ATSPI_ROLE_FORM 1145 * should not, in general, be used for toplevel GUI containers or dialogs, 1146 * but should be reserved for 'GUI' containers which occur within document 1147 * content, for instance within Web documents, presentations, or text 1148 * documents. Unlike other GUI containers and dialogs which occur inside 1149 * application instances, @ATSPI_ROLE_FORM containers' components are 1150 * associated with the current document, rather than the current foreground 1151 * application or viewer instance. 1152 * @ATSPI_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a 1153 * hypertext document. Such objects are distinct from 'inline' content 1154 * which may also use the #AtspiHypertext/#AtspiHyperlink interfacesto indicate 1155 * the range/location within a text object where an inline or embedded object 1156 * lies. 1157 * @ATSPI_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport 1158 * which is used to allow composition or input of a 'complex character', 1159 * in other words it is an "input method window". 1160 * @ATSPI_ROLE_TABLE_ROW: A row in a table. 1161 * @ATSPI_ROLE_TREE_ITEM: An object that represents an element of a tree. 1162 * @ATSPI_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a 1163 * spreadsheet. 1164 * @ATSPI_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a 1165 * presentation or slide content. 1166 * @ATSPI_ROLE_DOCUMENT_TEXT: A document frame which contains textual content, 1167 * such as found in a word processing 1168 * application. 1169 * @ATSPI_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other 1170 * markup suitable for display in a web browser. 1171 * @ATSPI_ROLE_DOCUMENT_EMAIL: A document frame which contains email content 1172 * to be displayed or composed either in plain text or 1173 * HTML. 1174 * @ATSPI_ROLE_COMMENT: An object found within a document and designed to 1175 * present a comment, note, or other annotation. In some cases, this object 1176 * might not be visible until activated. 1177 * @ATSPI_ROLE_LIST_BOX: A non-collapsible list of choices the user can 1178 * select from. 1179 * @ATSPI_ROLE_GROUPING: A group of related widgets. This group typically has 1180 * a label. 1181 * @ATSPI_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multiple 1182 * hotspots, where each hotspot can be activated resulting in the loading of 1183 * another document or section of a document. 1184 * @ATSPI_ROLE_NOTIFICATION: A transitory object designed to present a 1185 * message to the user, typically at the desktop level rather than inside a 1186 * particular application. 1187 * @ATSPI_ROLE_INFO_BAR: An object designed to present a message to the user 1188 * within an existing window. 1189 * @ATSPI_ROLE_LEVEL_BAR: A bar that serves as a level indicator to, for 1190 * instance, show the strength of a password or the state of a battery. @Since: 2.8 1191 * @ATSPI_ROLE_TITLE_BAR: A bar that serves as the title of a window or a 1192 * dialog. @Since: 2.12 1193 * @ATSPI_ROLE_BLOCK_QUOTE: An object which contains a text section 1194 * that is quoted from another source. @Since: 2.12 1195 * @ATSPI_ROLE_AUDIO: An object which represents an audio 1196 * element. @Since: 2.12 1197 * @ATSPI_ROLE_VIDEO: An object which represents a video 1198 * element. @Since: 2.12 1199 * @ATSPI_ROLE_DEFINITION: A definition of a term or concept. @Since: 2.12 1200 * @ATSPI_ROLE_ARTICLE: A section of a page that consists of a 1201 * composition that forms an independent part of a document, page, or 1202 * site. Examples: A blog entry, a news story, a forum post. @Since: 1203 * 2.12 1204 * @ATSPI_ROLE_LANDMARK: A region of a web page intended as a 1205 * navigational landmark. This is designed to allow Assistive 1206 * Technologies to provide quick navigation among key regions within a 1207 * document. @Since: 2.12 1208 * @ATSPI_ROLE_LOG: A text widget or container holding log content, such 1209 * as chat history and error logs. In this role there is a 1210 * relationship between the arrival of new items in the log and the 1211 * reading order. The log contains a meaningful sequence and new 1212 * information is added only to the end of the log, not at arbitrary 1213 * points. @Since: 2.12 1214 * @ATSPI_ROLE_MARQUEE: A container where non-essential information 1215 * changes frequently. Common usages of marquee include stock tickers 1216 * and ad banners. The primary difference between a marquee and a log 1217 * is that logs usually have a meaningful order or sequence of 1218 * important content changes. @Since: 2.12 1219 * @ATSPI_ROLE_MATH: A text widget or container that holds a mathematical 1220 * expression. @Since: 2.12 1221 * @ATSPI_ROLE_RATING: A widget whose purpose is to display a rating, 1222 * such as the number of stars associated with a song in a media 1223 * player. Objects of this role should also implement 1224 * AtspiValue. @Since: 2.12 1225 * @ATSPI_ROLE_TIMER: An object containing a numerical counter which 1226 * indicates an amount of elapsed time from a start point, or the time 1227 * remaining until an end point. @Since: 2.12 1228 * @ATSPI_ROLE_STATIC: A generic non-container object whose purpose is to display 1229 * a brief amount of information to the user and whose role is known by the 1230 * implementor but lacks semantic value for the user. Examples in which 1231 * @ATSPI_ROLE_STATIC is appropriate include the message displayed in a message 1232 * box and an image used as an alternative means to display text. 1233 * @ATSPI_ROLE_STATIC should not be applied to widgets which are traditionally 1234 * interactive, objects which display a significant amount of content, or any 1235 * object which has an accessible relation pointing to another object. The 1236 * displayed information, as a general rule, should be exposed through the 1237 * accessible name of the object. For labels which describe another widget, see 1238 * @ATSPI_ROLE_LABEL. For text views, see @ATSPI_ROLE_TEXT. For generic 1239 * containers, see @ATSPI_ROLE_PANEL. For objects whose role is not known by the 1240 * implementor, see @ATSPI_ROLE_UNKNOWN. @Since: 2.16. 1241 * @ATSPI_ROLE_MATH_FRACTION: An object that represents a mathematical fraction. @Since: 2.16. 1242 * @ATSPI_ROLE_MATH_ROOT: An object that represents a mathematical expression 1243 * displayed with a radical. @Since: 2.16. 1244 * @ATSPI_ROLE_SUBSCRIPT: An object that contains text that is displayed as a 1245 * subscript. @Since: 2.16. 1246 * @ATSPI_ROLE_SUPERSCRIPT: An object that contains text that is displayed as a 1247 * superscript. @Since: 2.16. 1248 * @ATSPI_ROLE_DESCRIPTION_LIST: An object that represents a list of term-value 1249 * groups. A term-value group represents an individual description and consist 1250 * of one or more names (@ATSPI_ROLE_DESCRIPTION_TERM) followed by one or more 1251 * values (@ATSPI_ROLE_DESCRIPTION_VALUE). For each list, there should not be 1252 * more than one group with the same term name. @Since: 2.26. 1253 * @ATSPI_ROLE_DESCRIPTION_TERM: An object that represents a term or phrase 1254 * with a corresponding definition. @Since: 2.26. 1255 * @ATSPI_ROLE_DESCRIPTION_VALUE: An object that represents the description, 1256 * definition, or value of a term. @Since: 2.26. 1257 * @ATSPI_ROLE_FOOTNOTE: An object that contains the text of a footnote. @Since: 2.26. 1258 * @ATSPI_ROLE_CONTENT_DELETION: Content previously deleted or proposed to be 1259 * deleted, e.g. in revision history or a content view providing suggestions 1260 * from reviewers. @Since: 2.34. 1261 * @ATSPI_ROLE_CONTENT_INSERTION: Content previously inserted or proposed to be 1262 * inserted, e.g. in revision history or a content view providing suggestions 1263 * from reviewers. @Since: 2.34. 1264 * @ATSPI_ROLE_MARK: A run of content that is marked or highlighted, such as for 1265 * reference purposes, or to call it out as having a special purpose. If the 1266 * marked content has an associated section in the document elaborating on the 1267 * reason for the mark, then %ATSPI_RELATION_DETAILS should be used on the mark 1268 * to point to that associated section. In addition, the reciprocal relation 1269 * %ATSPI_RELATION_DETAILS_FOR should be used on the associated content section 1270 * to point back to the mark. @Since: 2.36. 1271 * @ATSPI_ROLE_SUGGESTION: A container for content that is called out as a proposed 1272 * change from the current version of the document, such as by a reviewer of the 1273 * content. An object with this role should include children with %ATSPI_ROLE_CONTENT_DELETION and/or 1274 * %ATSPI_ROLE_CONTENT_INSERTION, in any order, to indicate what the 1275 * actual change is. @Since: 2.36 1276 * @ATSPI_ROLE_PUSH_BUTTON_MENU: A specialized push button to open a menu. @Since 2.46 1277 * @ATSPI_ROLE_LAST_DEFINED: Not a valid role, used for finding end of 1278 * enumeration. 1279 * 1280 * Enumeration used by interface #AtspiAccessible to specify the role 1281 * of an #AtspiAccessible object. 1282 * 1283 */ 1284 typedef enum 1285 { 1286 ATSPI_ROLE_INVALID, 1287 ATSPI_ROLE_ACCELERATOR_LABEL, 1288 ATSPI_ROLE_ALERT, 1289 ATSPI_ROLE_ANIMATION, 1290 ATSPI_ROLE_ARROW, 1291 ATSPI_ROLE_CALENDAR, 1292 ATSPI_ROLE_CANVAS, 1293 ATSPI_ROLE_CHECK_BOX, 1294 ATSPI_ROLE_CHECK_MENU_ITEM, 1295 ATSPI_ROLE_COLOR_CHOOSER, 1296 ATSPI_ROLE_COLUMN_HEADER, 1297 ATSPI_ROLE_COMBO_BOX, 1298 ATSPI_ROLE_DATE_EDITOR, 1299 ATSPI_ROLE_DESKTOP_ICON, 1300 ATSPI_ROLE_DESKTOP_FRAME, 1301 ATSPI_ROLE_DIAL, 1302 ATSPI_ROLE_DIALOG, 1303 ATSPI_ROLE_DIRECTORY_PANE, 1304 ATSPI_ROLE_DRAWING_AREA, 1305 ATSPI_ROLE_FILE_CHOOSER, 1306 ATSPI_ROLE_FILLER, 1307 ATSPI_ROLE_FOCUS_TRAVERSABLE, 1308 ATSPI_ROLE_FONT_CHOOSER, 1309 ATSPI_ROLE_FRAME, 1310 ATSPI_ROLE_GLASS_PANE, 1311 ATSPI_ROLE_HTML_CONTAINER, 1312 ATSPI_ROLE_ICON, 1313 ATSPI_ROLE_IMAGE, 1314 ATSPI_ROLE_INTERNAL_FRAME, 1315 ATSPI_ROLE_LABEL, 1316 ATSPI_ROLE_LAYERED_PANE, 1317 ATSPI_ROLE_LIST, 1318 ATSPI_ROLE_LIST_ITEM, 1319 ATSPI_ROLE_MENU, 1320 ATSPI_ROLE_MENU_BAR, 1321 ATSPI_ROLE_MENU_ITEM, 1322 ATSPI_ROLE_OPTION_PANE, 1323 ATSPI_ROLE_PAGE_TAB, 1324 ATSPI_ROLE_PAGE_TAB_LIST, 1325 ATSPI_ROLE_PANEL, 1326 ATSPI_ROLE_PASSWORD_TEXT, 1327 ATSPI_ROLE_POPUP_MENU, 1328 ATSPI_ROLE_PROGRESS_BAR, 1329 ATSPI_ROLE_BUTTON, 1330 ATSPI_ROLE_RADIO_BUTTON, 1331 ATSPI_ROLE_RADIO_MENU_ITEM, 1332 ATSPI_ROLE_ROOT_PANE, 1333 ATSPI_ROLE_ROW_HEADER, 1334 ATSPI_ROLE_SCROLL_BAR, 1335 ATSPI_ROLE_SCROLL_PANE, 1336 ATSPI_ROLE_SEPARATOR, 1337 ATSPI_ROLE_SLIDER, 1338 ATSPI_ROLE_SPIN_BUTTON, 1339 ATSPI_ROLE_SPLIT_PANE, 1340 ATSPI_ROLE_STATUS_BAR, 1341 ATSPI_ROLE_TABLE, 1342 ATSPI_ROLE_TABLE_CELL, 1343 ATSPI_ROLE_TABLE_COLUMN_HEADER, 1344 ATSPI_ROLE_TABLE_ROW_HEADER, 1345 ATSPI_ROLE_TEAROFF_MENU_ITEM, 1346 ATSPI_ROLE_TERMINAL, 1347 ATSPI_ROLE_TEXT, 1348 ATSPI_ROLE_TOGGLE_BUTTON, 1349 ATSPI_ROLE_TOOL_BAR, 1350 ATSPI_ROLE_TOOL_TIP, 1351 ATSPI_ROLE_TREE, 1352 ATSPI_ROLE_TREE_TABLE, 1353 ATSPI_ROLE_UNKNOWN, 1354 ATSPI_ROLE_VIEWPORT, 1355 ATSPI_ROLE_WINDOW, 1356 ATSPI_ROLE_EXTENDED, 1357 ATSPI_ROLE_HEADER, 1358 ATSPI_ROLE_FOOTER, 1359 ATSPI_ROLE_PARAGRAPH, 1360 ATSPI_ROLE_RULER, 1361 ATSPI_ROLE_APPLICATION, 1362 ATSPI_ROLE_AUTOCOMPLETE, 1363 ATSPI_ROLE_EDITBAR, 1364 ATSPI_ROLE_EMBEDDED, 1365 ATSPI_ROLE_ENTRY, 1366 ATSPI_ROLE_CHART, 1367 ATSPI_ROLE_CAPTION, 1368 ATSPI_ROLE_DOCUMENT_FRAME, 1369 ATSPI_ROLE_HEADING, 1370 ATSPI_ROLE_PAGE, 1371 ATSPI_ROLE_SECTION, 1372 ATSPI_ROLE_REDUNDANT_OBJECT, 1373 ATSPI_ROLE_FORM, 1374 ATSPI_ROLE_LINK, 1375 ATSPI_ROLE_INPUT_METHOD_WINDOW, 1376 ATSPI_ROLE_TABLE_ROW, 1377 ATSPI_ROLE_TREE_ITEM, 1378 ATSPI_ROLE_DOCUMENT_SPREADSHEET, 1379 ATSPI_ROLE_DOCUMENT_PRESENTATION, 1380 ATSPI_ROLE_DOCUMENT_TEXT, 1381 ATSPI_ROLE_DOCUMENT_WEB, 1382 ATSPI_ROLE_DOCUMENT_EMAIL, 1383 ATSPI_ROLE_COMMENT, 1384 ATSPI_ROLE_LIST_BOX, 1385 ATSPI_ROLE_GROUPING, 1386 ATSPI_ROLE_IMAGE_MAP, 1387 ATSPI_ROLE_NOTIFICATION, 1388 ATSPI_ROLE_INFO_BAR, 1389 ATSPI_ROLE_LEVEL_BAR, 1390 ATSPI_ROLE_TITLE_BAR, 1391 ATSPI_ROLE_BLOCK_QUOTE, 1392 ATSPI_ROLE_AUDIO, 1393 ATSPI_ROLE_VIDEO, 1394 ATSPI_ROLE_DEFINITION, 1395 ATSPI_ROLE_ARTICLE, 1396 ATSPI_ROLE_LANDMARK, 1397 ATSPI_ROLE_LOG, 1398 ATSPI_ROLE_MARQUEE, 1399 ATSPI_ROLE_MATH, 1400 ATSPI_ROLE_RATING, 1401 ATSPI_ROLE_TIMER, 1402 ATSPI_ROLE_STATIC, 1403 ATSPI_ROLE_MATH_FRACTION, 1404 ATSPI_ROLE_MATH_ROOT, 1405 ATSPI_ROLE_SUBSCRIPT, 1406 ATSPI_ROLE_SUPERSCRIPT, 1407 ATSPI_ROLE_DESCRIPTION_LIST, 1408 ATSPI_ROLE_DESCRIPTION_TERM, 1409 ATSPI_ROLE_DESCRIPTION_VALUE, 1410 ATSPI_ROLE_FOOTNOTE, 1411 ATSPI_ROLE_CONTENT_DELETION, 1412 ATSPI_ROLE_CONTENT_INSERTION, 1413 ATSPI_ROLE_MARK, 1414 ATSPI_ROLE_SUGGESTION, 1415 ATSPI_ROLE_PUSH_BUTTON_MENU, 1416 ATSPI_ROLE_LAST_DEFINED, 1417 1418 /* For backwards compatibility */ 1419 ATSPI_ROLE_PUSH_BUTTON = ATSPI_ROLE_BUTTON, 1420 } AtspiRole; 1421 1422 /** 1423 * ATSPI_ROLE_COUNT: 1424 * 1425 * One higher than the highest valid value of #AtspiRole. 1426 */ 1427 #define ATSPI_ROLE_COUNT (130 + 1) 1428 1429 typedef enum 1430 { 1431 ATSPI_CACHE_NONE = 0, 1432 ATSPI_CACHE_PARENT = 1 << 0, 1433 ATSPI_CACHE_CHILDREN = 1 << 1, 1434 ATSPI_CACHE_NAME = 1 << 2, 1435 ATSPI_CACHE_DESCRIPTION = 1 << 3, 1436 ATSPI_CACHE_STATES = 1 << 4, 1437 ATSPI_CACHE_ROLE = 1 << 5, 1438 ATSPI_CACHE_INTERFACES = 1 << 6, 1439 ATSPI_CACHE_ATTRIBUTES = 1 << 7, 1440 ATSPI_CACHE_ALL = 0x3fffffff, 1441 ATSPI_CACHE_DEFAULT = ATSPI_CACHE_PARENT | ATSPI_CACHE_CHILDREN | ATSPI_CACHE_NAME | ATSPI_CACHE_DESCRIPTION | ATSPI_CACHE_STATES | ATSPI_CACHE_ROLE | ATSPI_CACHE_INTERFACES, 1442 ATSPI_CACHE_UNDEFINED = 0x40000000, 1443 } AtspiCache; 1444 1445 /** 1446 * AtspiScrollType: 1447 * @ATSPI_SCROLL_TOP_LEFT: Scroll the object to the top left corner of the 1448 * window. 1449 * @ATSPI_SCROLL_BOTTOM_RIGHT: Scroll the object to the bottom right corner of 1450 * the window. 1451 * @ATSPI_SCROLL_TOP_EDGE: Scroll the object to the top edge of the window. 1452 * @ATSPI_SCROLL_BOTTOM_EDGE: Scroll the object to the bottom edge of the 1453 * window. 1454 * @ATSPI_SCROLL_LEFT_EDGE: Scroll the object to the left edge of the 1455 * window. 1456 * @ATSPI_SCROLL_RIGHT_EDGE: Scroll the object to the right edge of the 1457 * window. 1458 * @ATSPI_SCROLL_ANYWHERE: Scroll the object to application-dependent position 1459 * on the window. 1460 * 1461 * Enumeration used by interface #AtspiAccessible to specify where an 1462 * #AtspiAccessible object should be placed on the screen when using scroll_to. 1463 * 1464 */ 1465 typedef enum 1466 { 1467 ATSPI_SCROLL_TOP_LEFT, 1468 ATSPI_SCROLL_BOTTOM_RIGHT, 1469 ATSPI_SCROLL_TOP_EDGE, 1470 ATSPI_SCROLL_BOTTOM_EDGE, 1471 ATSPI_SCROLL_LEFT_EDGE, 1472 ATSPI_SCROLL_RIGHT_EDGE, 1473 ATSPI_SCROLL_ANYWHERE 1474 } AtspiScrollType; 1475 1476 /** 1477 * ATSPI_SCROLLTYPE_COUNT: 1478 * 1479 * One higher than the highest valid value of #AtspiScrollType. 1480 */ 1481 #define ATSPI_SCROLLTYPE_COUNT (6 + 1) 1482 1483 /** 1484 * AtspiLive: 1485 * @ATSPI_LIVE_NONE: No live region. 1486 * @ATSPI_LIVE_POLITE: This live region should be considered polite. 1487 * @ATSPI_LIVE_ASSERTIVE: This live region should be considered assertive. 1488 * 1489 * Enumeration used to indicate a type of live region and how assertive it 1490 * should be in terms of speaking notifications. Currently, this is only used 1491 * for "announcement" events, but it may be used for additional purposes 1492 * in the future. 1493 */ 1494 typedef enum 1495 { 1496 ATSPI_LIVE_NONE, 1497 ATSPI_LIVE_POLITE, 1498 ATSPI_LIVE_ASSERTIVE 1499 } AtspiLive; 1500 1501 #define ATSPI_DBUS_NAME_REGISTRY "org.a11y.atspi.Registry" 1502 #define ATSPI_DBUS_PATH_REGISTRY "/org/a11y/atspi/registry" 1503 #define ATSPI_DBUS_INTERFACE_REGISTRY "org.a11y.atspi.Registry" 1504 1505 #define ATSPI_DBUS_PATH_NULL "/org/a11y/atspi/null" 1506 #define ATSPI_DBUS_PATH_ROOT "/org/a11y/atspi/accessible/root" 1507 1508 #define ATSPI_DBUS_PATH_DEC "/org/a11y/atspi/registry/deviceeventcontroller" 1509 #define ATSPI_DBUS_INTERFACE_DEC "org.a11y.atspi.DeviceEventController" 1510 #define ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER "org.a11y.atspi.DeviceEventListener" 1511 1512 #define ATSPI_DBUS_INTERFACE_CACHE "org.a11y.atspi.Cache" 1513 #define ATSPI_DBUS_INTERFACE_ACCESSIBLE "org.a11y.atspi.Accessible" 1514 #define ATSPI_DBUS_INTERFACE_ACTION "org.a11y.atspi.Action" 1515 #define ATSPI_DBUS_INTERFACE_APPLICATION "org.a11y.atspi.Application" 1516 #define ATSPI_DBUS_INTERFACE_COLLECTION "org.a11y.atspi.Collection" 1517 #define ATSPI_DBUS_INTERFACE_COMPONENT "org.a11y.atspi.Component" 1518 #define ATSPI_DBUS_INTERFACE_DOCUMENT "org.a11y.atspi.Document" 1519 #define ATSPI_DBUS_INTERFACE_EDITABLE_TEXT "org.a11y.atspi.EditableText" 1520 #define ATSPI_DBUS_INTERFACE_EVENT_KEYBOARD "org.a11y.atspi.Event.Keyboard" 1521 #define ATSPI_DBUS_INTERFACE_EVENT_MOUSE "org.a11y.atspi.Event.Mouse" 1522 #define ATSPI_DBUS_INTERFACE_EVENT_OBJECT "org.a11y.atspi.Event.Object" 1523 #define ATSPI_DBUS_INTERFACE_HYPERLINK "org.a11y.atspi.Hyperlink" 1524 #define ATSPI_DBUS_INTERFACE_HYPERTEXT "org.a11y.atspi.Hypertext" 1525 #define ATSPI_DBUS_INTERFACE_IMAGE "org.a11y.atspi.Image" 1526 #define ATSPI_DBUS_INTERFACE_SELECTION "org.a11y.atspi.Selection" 1527 #define ATSPI_DBUS_INTERFACE_TABLE "org.a11y.atspi.Table" 1528 #define ATSPI_DBUS_INTERFACE_TABLE_CELL "org.a11y.atspi.TableCell" 1529 #define ATSPI_DBUS_INTERFACE_TEXT "org.a11y.atspi.Text" 1530 #define ATSPI_DBUS_INTERFACE_VALUE "org.a11y.atspi.Value" 1531 #define ATSPI_DBUS_INTERFACE_SOCKET "org.a11y.atspi.Socket" 1532 1533 #define ATSPI_DBUS_PATH_SCREEN_READER "/org/a11y/atspi/screenreader" 1534 #define ATSPI_DBUS_INTERFACE_EVENT_SCREEN_READER "org.a11y.atspi.Event.ScreenReader" 1535 1536 #ifdef __cplusplus 1537 } 1538 #endif 1539 #endif /* _ATSPI_CONSTANTS_H_ */
[ Source navigation ] | [ Diff markup ] | [ Identifier search ] | [ general search ] |
This page was automatically generated by the 2.3.7 LXR engine. The LXR team |