doc/libatspi/tmpl/atspi-constants.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 atspi-constants
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Constant definitions needed by multiple interfaces.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 Constant definitions needed by multiple interfaces.
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### SECTION Stability_Level ##### -->
  18
  19
  20 <!-- ##### SECTION Image ##### -->
  21
  22
  23 <!-- ##### ENUM AtspiLocaleType ##### -->
  24 <para>
  25
  26 </para>
  27
  28 @ATSPI_LOCALE_TYPE_MESSAGES:
  29 @ATSPI_LOCALE_TYPE_COLLATE:
  30 @ATSPI_LOCALE_TYPE_CTYPE:
  31 @ATSPI_LOCALE_TYPE_MONETARY:
  32 @ATSPI_LOCALE_TYPE_NUMERIC:
  33 @ATSPI_LOCALE_TYPE_TIME:
  34
  35 <!-- ##### MACRO ATSPI_LOCALE_TYPE ##### -->
  36 <para>
  37
  38 </para>
  39
  40
  41
  42 <!-- ##### ENUM AtspiScrollType ##### -->
  43 <para>
  44
  45 </para>
  46
  47 @ATSPI_SCROLL_TOP_LEFT:
  48 @ATSPI_SCROLL_BOTTOM_RIGHT:
  49 @ATSPI_SCROLL_TOP_EDGE:
  50 @ATSPI_SCROLL_BOTTOM_EDGE:
  51 @ATSPI_SCROLL_LEFT_EDGE:
  52 @ATSPI_SCROLL_RIGHT_EDGE:
  53 @ATSPI_SCROLL_ANYWHERE:
  54
  55 <!-- ##### MACRO ATSPI_SCROLLTYPE_COUNT ##### -->
  56 <para>
  57
  58 </para>
  59
  60
  61
  62 <!-- ##### ENUM AtspiCoordType ##### -->
  63 <para>
  64
  65 </para>
  66
  67 @ATSPI_COORD_TYPE_SCREEN:
  68 @ATSPI_COORD_TYPE_WINDOW:
  69 @ATSPI_COORD_TYPE_PARENT:
  70
  71 <!-- ##### MACRO ATSPI_COORD_TYPE_COUNT ##### -->
  72 <para>
  73
  74 </para>
  75
  76
  77
  78 <!-- ##### ENUM AtspiCollectionSortOrder ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @ATSPI_Collection_SORT_ORDER_INVALID:
  84 @ATSPI_Collection_SORT_ORDER_CANONICAL:
  85 @ATSPI_Collection_SORT_ORDER_FLOW:
  86 @ATSPI_Collection_SORT_ORDER_TAB:
  87 @ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL:
  88 @ATSPI_Collection_SORT_ORDER_REVERSE_FLOW:
  89 @ATSPI_Collection_SORT_ORDER_REVERSE_TAB:
  90 @ATSPI_Collection_SORT_ORDER_LAST_DEFINED:
  91
  92 <!-- ##### MACRO ATSPI_SORTORDER_COUNT ##### -->
  93 <para>
  94
  95 </para>
  96
  97
  98
  99 <!-- ##### ENUM AtspiCollectionMatchType ##### -->
 100 <para>
 101
 102 </para>
 103
 104 @ATSPI_Collection_MATCH_INVALID:
 105 @ATSPI_Collection_MATCH_ALL:
 106 @ATSPI_Collection_MATCH_ANY:
 107 @ATSPI_Collection_MATCH_NONE:
 108 @ATSPI_Collection_MATCH_EMPTY:
 109 @ATSPI_Collection_MATCH_LAST_DEFINED:
 110
 111 <!-- ##### MACRO ATSPI_MATCHTYPES_COUNT ##### -->
 112 <para>
 113
 114 </para>
 115
 116
 117
 118 <!-- ##### ENUM AtspiCollectionTreeTraversalType ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @ATSPI_Collection_TREE_RESTRICT_CHILDREN:
 124 @ATSPI_Collection_TREE_RESTRICT_SIBLING:
 125 @ATSPI_Collection_TREE_INORDER:
 126 @ATSPI_Collection_TREE_LAST_DEFINED:
 127
 128 <!-- ##### MACRO ATSPI_TREETRAVERSALTYPE ##### -->
 129 <para>
 130
 131 </para>
 132
 133
 134
 135 <!-- ##### ENUM AtspiComponentLayer ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @ATSPI_LAYER_INVALID:
 141 @ATSPI_LAYER_BACKGROUND:
 142 @ATSPI_LAYER_CANVAS:
 143 @ATSPI_LAYER_WIDGET:
 144 @ATSPI_LAYER_MDI:
 145 @ATSPI_LAYER_POPUP:
 146 @ATSPI_LAYER_OVERLAY:
 147 @ATSPI_LAYER_WINDOW:
 148 @ATSPI_LAYER_LAST_DEFINED:
 149
 150 <!-- ##### MACRO ATSPI_COMPONENTLAYER_COUNT ##### -->
 151 <para>
 152
 153 </para>
 154
 155
 156
 157 <!-- ##### ENUM AtspiTextBoundaryType ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @ATSPI_TEXT_BOUNDARY_CHAR:
 163 @ATSPI_TEXT_BOUNDARY_WORD_START:
 164 @ATSPI_TEXT_BOUNDARY_WORD_END:
 165 @ATSPI_TEXT_BOUNDARY_SENTENCE_START:
 166 @ATSPI_TEXT_BOUNDARY_SENTENCE_END:
 167 @ATSPI_TEXT_BOUNDARY_LINE_START:
 168 @ATSPI_TEXT_BOUNDARY_LINE_END:
 169
 170 <!-- ##### MACRO ATSPI_TEXT_BOUNDARY_TYPE_COUNT ##### -->
 171 <para>
 172
 173 </para>
 174
 175
 176
 177 <!-- ##### ENUM AtspiTextClipType ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @ATSPI_TEXT_CLIP_NONE:
 183 @ATSPI_TEXT_CLIP_MIN:
 184 @ATSPI_TEXT_CLIP_MAX:
 185 @ATSPI_TEXT_CLIP_BOTH:
 186
 187 <!-- ##### MACRO ATSPI_TEXT_CLIP_TYPE_COUNT ##### -->
 188 <para>
 189
 190 </para>
 191
 192
 193
 194 <!-- ##### ENUM AtspiStateType ##### -->
 195 <para>
 196
 197 </para>
 198
 199 @ATSPI_STATE_INVALID:
 200 @ATSPI_STATE_ACTIVE:
 201 @ATSPI_STATE_ARMED:
 202 @ATSPI_STATE_BUSY:
 203 @ATSPI_STATE_CHECKED:
 204 @ATSPI_STATE_COLLAPSED:
 205 @ATSPI_STATE_DEFUNCT:
 206 @ATSPI_STATE_EDITABLE:
 207 @ATSPI_STATE_ENABLED:
 208 @ATSPI_STATE_EXPANDABLE:
 209 @ATSPI_STATE_EXPANDED:
 210 @ATSPI_STATE_FOCUSABLE:
 211 @ATSPI_STATE_FOCUSED:
 212 @ATSPI_STATE_HAS_TOOLTIP:
 213 @ATSPI_STATE_HORIZONTAL:
 214 @ATSPI_STATE_ICONIFIED:
 215 @ATSPI_STATE_MODAL:
 216 @ATSPI_STATE_MULTI_LINE:
 217 @ATSPI_STATE_MULTISELECTABLE:
 218 @ATSPI_STATE_OPAQUE:
 219 @ATSPI_STATE_PRESSED:
 220 @ATSPI_STATE_RESIZABLE:
 221 @ATSPI_STATE_SELECTABLE:
 222 @ATSPI_STATE_SELECTED:
 223 @ATSPI_STATE_SENSITIVE:
 224 @ATSPI_STATE_SHOWING:
 225 @ATSPI_STATE_SINGLE_LINE:
 226 @ATSPI_STATE_STALE:
 227 @ATSPI_STATE_TRANSIENT:
 228 @ATSPI_STATE_VERTICAL:
 229 @ATSPI_STATE_VISIBLE:
 230 @ATSPI_STATE_MANAGES_DESCENDANTS:
 231 @ATSPI_STATE_INDETERMINATE:
 232 @ATSPI_STATE_REQUIRED:
 233 @ATSPI_STATE_TRUNCATED:
 234 @ATSPI_STATE_ANIMATED:
 235 @ATSPI_STATE_INVALID_ENTRY:
 236 @ATSPI_STATE_SUPPORTS_AUTOCOMPLETION:
 237 @ATSPI_STATE_SELECTABLE_TEXT:
 238 @ATSPI_STATE_IS_DEFAULT:
 239 @ATSPI_STATE_VISITED:
 240 @ATSPI_STATE_CHECKABLE:
 241 @ATSPI_STATE_HAS_POPUP:
 242 @ATSPI_STATE_READ_ONLY:
 243 @ATSPI_STATE_LAST_DEFINED:
 244
 245 <!-- ##### MACRO ATSPI_STATETYPE_COUNT ##### -->
 246 <para>
 247
 248 </para>
 249
 250
 251
 252 <!-- ##### ENUM AtspiKeyEventType ##### -->
 253 <para>
 254
 255 </para>
 256
 257 @ATSPI_KEY_PRESSED:
 258 @ATSPI_KEY_RELEASED:
 259
 260 <!-- ##### MACRO ATSPI_KEYEVENTTYPE_COUNT ##### -->
 261 <para>
 262
 263 </para>
 264
 265
 266
 267 <!-- ##### ENUM AtspiEventType ##### -->
 268 <para>
 269
 270 </para>
 271
 272 @ATSPI_KEY_PRESSED_EVENT:
 273 @ATSPI_KEY_RELEASED_EVENT:
 274 @ATSPI_BUTTON_PRESSED_EVENT:
 275 @ATSPI_BUTTON_RELEASED_EVENT:
 276
 277 <!-- ##### MACRO ATSPI_EVENTTYPE_COUNT ##### -->
 278 <para>
 279
 280 </para>
 281
 282
 283
 284 <!-- ##### ENUM AtspiKeySynthType ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @ATSPI_KEY_PRESS:
 290 @ATSPI_KEY_RELEASE:
 291 @ATSPI_KEY_PRESSRELEASE:
 292 @ATSPI_KEY_SYM:
 293 @ATSPI_KEY_STRING:
 294 @ATSPI_KEY_LOCKMODIFIERS:
 295 @ATSPI_KEY_UNLOCKMODIFIERS:
 296
 297 <!-- ##### MACRO ATSPI_KEYSYNTHTYPE_COUNT ##### -->
 298 <para>
 299
 300 </para>
 301
 302
 303
 304 <!-- ##### ENUM AtspiModifierType ##### -->
 305 <para>
 306
 307 </para>
 308
 309 @ATSPI_MODIFIER_SHIFT:
 310 @ATSPI_MODIFIER_SHIFTLOCK:
 311 @ATSPI_MODIFIER_CONTROL:
 312 @ATSPI_MODIFIER_ALT:
 313 @ATSPI_MODIFIER_META:
 314 @ATSPI_MODIFIER_META2:
 315 @ATSPI_MODIFIER_META3:
 316 @ATSPI_MODIFIER_NUMLOCK:
 317
 318 <!-- ##### MACRO ATSPI_MODIFIERTYPE_COUNT ##### -->
 319 <para>
 320
 321 </para>
 322
 323
 324
 325 <!-- ##### ENUM AtspiRelationType ##### -->
 326 <para>
 327
 328 </para>
 329
 330 @ATSPI_RELATION_NULL:
 331 @ATSPI_RELATION_LABEL_FOR:
 332 @ATSPI_RELATION_LABELLED_BY:
 333 @ATSPI_RELATION_CONTROLLER_FOR:
 334 @ATSPI_RELATION_CONTROLLED_BY:
 335 @ATSPI_RELATION_MEMBER_OF:
 336 @ATSPI_RELATION_TOOLTIP_FOR:
 337 @ATSPI_RELATION_NODE_CHILD_OF:
 338 @ATSPI_RELATION_NODE_PARENT_OF:
 339 @ATSPI_RELATION_EXTENDED:
 340 @ATSPI_RELATION_FLOWS_TO:
 341 @ATSPI_RELATION_FLOWS_FROM:
 342 @ATSPI_RELATION_SUBWINDOW_OF:
 343 @ATSPI_RELATION_EMBEDS:
 344 @ATSPI_RELATION_EMBEDDED_BY:
 345 @ATSPI_RELATION_POPUP_FOR:
 346 @ATSPI_RELATION_PARENT_WINDOW_OF:
 347 @ATSPI_RELATION_DESCRIPTION_FOR:
 348 @ATSPI_RELATION_DESCRIBED_BY:
 349 @ATSPI_RELATION_DETAILS:
 350 @ATSPI_RELATION_DETAILS_FOR:
 351 @ATSPI_RELATION_ERROR_MESSAGE:
 352 @ATSPI_RELATION_ERROR_FOR:
 353 @ATSPI_RELATION_LAST_DEFINED:
 354
 355 <!-- ##### MACRO ATSPI_RELATIONTYPE_COUNT ##### -->
 356 <para>
 357
 358 </para>
 359
 360
 361
 362 <!-- ##### ENUM AtspiRole ##### -->
 363 <para>
 364
 365 </para>
 366
 367 @ATSPI_ROLE_INVALID:
 368 @ATSPI_ROLE_ACCELERATOR_LABEL:
 369 @ATSPI_ROLE_ALERT:
 370 @ATSPI_ROLE_ANIMATION:
 371 @ATSPI_ROLE_ARROW:
 372 @ATSPI_ROLE_CALENDAR:
 373 @ATSPI_ROLE_CANVAS:
 374 @ATSPI_ROLE_CHECK_BOX:
 375 @ATSPI_ROLE_CHECK_MENU_ITEM:
 376 @ATSPI_ROLE_COLOR_CHOOSER:
 377 @ATSPI_ROLE_COLUMN_HEADER:
 378 @ATSPI_ROLE_COMBO_BOX:
 379 @ATSPI_ROLE_DATE_EDITOR:
 380 @ATSPI_ROLE_DESKTOP_ICON:
 381 @ATSPI_ROLE_DESKTOP_FRAME:
 382 @ATSPI_ROLE_DIAL:
 383 @ATSPI_ROLE_DIALOG:
 384 @ATSPI_ROLE_DIRECTORY_PANE:
 385 @ATSPI_ROLE_DRAWING_AREA:
 386 @ATSPI_ROLE_FILE_CHOOSER:
 387 @ATSPI_ROLE_FILLER:
 388 @ATSPI_ROLE_FOCUS_TRAVERSABLE:
 389 @ATSPI_ROLE_FONT_CHOOSER:
 390 @ATSPI_ROLE_FRAME:
 391 @ATSPI_ROLE_GLASS_PANE:
 392 @ATSPI_ROLE_HTML_CONTAINER:
 393 @ATSPI_ROLE_ICON:
 394 @ATSPI_ROLE_IMAGE:
 395 @ATSPI_ROLE_INTERNAL_FRAME:
 396 @ATSPI_ROLE_LABEL:
 397 @ATSPI_ROLE_LAYERED_PANE:
 398 @ATSPI_ROLE_LIST:
 399 @ATSPI_ROLE_LIST_ITEM:
 400 @ATSPI_ROLE_MENU:
 401 @ATSPI_ROLE_MENU_BAR:
 402 @ATSPI_ROLE_MENU_ITEM:
 403 @ATSPI_ROLE_OPTION_PANE:
 404 @ATSPI_ROLE_PAGE_TAB:
 405 @ATSPI_ROLE_PAGE_TAB_LIST:
 406 @ATSPI_ROLE_PANEL:
 407 @ATSPI_ROLE_PASSWORD_TEXT:
 408 @ATSPI_ROLE_POPUP_MENU:
 409 @ATSPI_ROLE_PROGRESS_BAR:
 410 @ATSPI_ROLE_PUSH_BUTTON:
 411 @ATSPI_ROLE_RADIO_BUTTON:
 412 @ATSPI_ROLE_RADIO_MENU_ITEM:
 413 @ATSPI_ROLE_ROOT_PANE:
 414 @ATSPI_ROLE_ROW_HEADER:
 415 @ATSPI_ROLE_SCROLL_BAR:
 416 @ATSPI_ROLE_SCROLL_PANE:
 417 @ATSPI_ROLE_SEPARATOR:
 418 @ATSPI_ROLE_SLIDER:
 419 @ATSPI_ROLE_SPIN_BUTTON:
 420 @ATSPI_ROLE_SPLIT_PANE:
 421 @ATSPI_ROLE_STATUS_BAR:
 422 @ATSPI_ROLE_TABLE:
 423 @ATSPI_ROLE_TABLE_CELL:
 424 @ATSPI_ROLE_TABLE_COLUMN_HEADER:
 425 @ATSPI_ROLE_TABLE_ROW_HEADER:
 426 @ATSPI_ROLE_TEAROFF_MENU_ITEM:
 427 @ATSPI_ROLE_TERMINAL:
 428 @ATSPI_ROLE_TEXT:
 429 @ATSPI_ROLE_TOGGLE_BUTTON:
 430 @ATSPI_ROLE_TOOL_BAR:
 431 @ATSPI_ROLE_TOOL_TIP:
 432 @ATSPI_ROLE_TREE:
 433 @ATSPI_ROLE_TREE_TABLE:
 434 @ATSPI_ROLE_UNKNOWN:
 435 @ATSPI_ROLE_VIEWPORT:
 436 @ATSPI_ROLE_WINDOW:
 437 @ATSPI_ROLE_EXTENDED:
 438 @ATSPI_ROLE_HEADER:
 439 @ATSPI_ROLE_FOOTER:
 440 @ATSPI_ROLE_PARAGRAPH:
 441 @ATSPI_ROLE_RULER:
 442 @ATSPI_ROLE_APPLICATION:
 443 @ATSPI_ROLE_AUTOCOMPLETE:
 444 @ATSPI_ROLE_EDITBAR:
 445 @ATSPI_ROLE_EMBEDDED:
 446 @ATSPI_ROLE_ENTRY:
 447 @ATSPI_ROLE_CHART:
 448 @ATSPI_ROLE_CAPTION:
 449 @ATSPI_ROLE_DOCUMENT_FRAME:
 450 @ATSPI_ROLE_HEADING:
 451 @ATSPI_ROLE_PAGE:
 452 @ATSPI_ROLE_SECTION:
 453 @ATSPI_ROLE_REDUNDANT_OBJECT:
 454 @ATSPI_ROLE_FORM:
 455 @ATSPI_ROLE_LINK:
 456 @ATSPI_ROLE_INPUT_METHOD_WINDOW:
 457 @ATSPI_ROLE_TABLE_ROW:
 458 @ATSPI_ROLE_TREE_ITEM:
 459 @ATSPI_ROLE_DOCUMENT_SPREADSHEET:
 460 @ATSPI_ROLE_DOCUMENT_PRESENTATION:
 461 @ATSPI_ROLE_DOCUMENT_TEXT:
 462 @ATSPI_ROLE_DOCUMENT_WEB:
 463 @ATSPI_ROLE_DOCUMENT_EMAIL:
 464 @ATSPI_ROLE_COMMENT:
 465 @ATSPI_ROLE_LIST_BOX:
 466 @ATSPI_ROLE_GROUPING:
 467 @ATSPI_ROLE_IMAGE_MAP:
 468 @ATSPI_ROLE_NOTIFICATION:
 469 @ATSPI_ROLE_INFO_BAR:
 470 @ATSPI_ROLE_LEVEL_BAR:
 471 @ATSPI_ROLE_TITLE_BAR:
 472 @ATSPI_ROLE_BLOCK_QUOTE:
 473 @ATSPI_ROLE_AUDIO:
 474 @ATSPI_ROLE_VIDEO:
 475 @ATSPI_ROLE_DEFINITION:
 476 @ATSPI_ROLE_ARTICLE:
 477 @ATSPI_ROLE_LANDMARK:
 478 @ATSPI_ROLE_LOG:
 479 @ATSPI_ROLE_MARQUEE:
 480 @ATSPI_ROLE_MATH:
 481 @ATSPI_ROLE_RATING:
 482 @ATSPI_ROLE_TIMER:
 483 @ATSPI_ROLE_STATIC:
 484 @ATSPI_ROLE_MATH_FRACTION:
 485 @ATSPI_ROLE_MATH_ROOT:
 486 @ATSPI_ROLE_SUBSCRIPT:
 487 @ATSPI_ROLE_SUPERSCRIPT:
 488 @ATSPI_ROLE_DESCRIPTION_LIST:
 489 @ATSPI_ROLE_DESCRIPTION_TERM:
 490 @ATSPI_ROLE_DESCRIPTION_VALUE:
 491 @ATSPI_ROLE_LAST_DEFINED:
 492
 493 <!-- ##### MACRO ATSPI_ROLE_COUNT ##### -->
 494 <para>
 495
 496 </para>
 497
 498
 499