docs/reference/cspi/tmpl/spi_accessible.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Accessible Objects
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 The base accessibility interface which all accessible objects implement.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The Accessible interface provides for a hierarchical tree of accessible
  10 objects corresponding to user interface components and content in an
  11 accessible application.  Accessible objects provide name, descriptive
  12 information, state information, and information on the "role" of the object in
  13 the user interface.  The capabilities of these objects may be queried via
  14 interface queries, as they are implemented via interface aggregation.  These
  15 objects are located in a containment hierarchy with parent/child
  16 relationships, and may have other functional relationships to objects within
  17 the tree.
  18 </para>
  19
  20 <!-- ##### SECTION See_Also ##### -->
  21 <para>
  22
  23 </para>
  24
  25 <!-- ##### SECTION Stability_Level ##### -->
  26
  27
  28 <!-- ##### STRUCT Accessible ##### -->
  29 <para>
  30 An Accessible object is an opaque object used to refer to an accessible
  31 object corresponding to an user interface element.
  32 </para>
  33
  34 @objref: private data
  35 @on_loan: private data
  36 @ref_count: private data
  37
  38 <!-- ##### FUNCTION Accessible_ref ##### -->
  39 <para>
  40
  41 </para>
  42
  43 @obj:
  44
  45
  46 <!-- ##### FUNCTION Accessible_unref ##### -->
  47 <para>
  48
  49 </para>
  50
  51 @obj:
  52
  53
  54 <!-- ##### FUNCTION Accessible_getName ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @obj:
  60 @Returns:
  61
  62
  63 <!-- ##### FUNCTION Accessible_getDescription ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @obj:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION Accessible_getParent ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @obj:
  78 @Returns:
  79
  80
  81 <!-- ##### FUNCTION Accessible_getChildCount ##### -->
  82 <para>
  83
  84 </para>
  85
  86 @obj:
  87 @Returns:
  88
  89
  90 <!-- ##### FUNCTION Accessible_getChildAtIndex ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @obj:
  96 @childIndex:
  97 @Returns:
  98
  99
 100 <!-- ##### FUNCTION Accessible_getIndexInParent ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @obj:
 106 @Returns:
 107
 108
 109 <!-- ##### FUNCTION Accessible_getRelationSet ##### -->
 110 <para>
 111
 112 </para>
 113
 114 @obj:
 115 @Returns:
 116
 117
 118 <!-- ##### FUNCTION Accessible_getRole ##### -->
 119 <para>
 120
 121 </para>
 122
 123 @obj:
 124 @Returns:
 125
 126
 127 <!-- ##### FUNCTION Accessible_getRoleName ##### -->
 128 <para>
 129
 130 </para>
 131
 132 @obj:
 133 @Returns:
 134
 135
 136 <!-- ##### FUNCTION Accessible_getStateSet ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @obj:
 142 @Returns:
 143
 144
 145 <!-- ##### FUNCTION Accessible_getAttributes ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @obj:
 151 @Returns:
 152
 153
 154 <!-- ##### FUNCTION Accessible_getHostApplication ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @obj:
 160 @Returns:
 161
 162
 163 <!-- ##### FUNCTION Accessible_getLocalizedRoleName ##### -->
 164 <para>
 165
 166 </para>
 167
 168 @obj:
 169 @Returns:
 170
 171
 172 <!-- ##### FUNCTION Accessible_isAction ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @obj:
 178 @Returns:
 179
 180
 181 <!-- ##### FUNCTION Accessible_isApplication ##### -->
 182 <para>
 183
 184 </para>
 185
 186 @obj:
 187 @Returns:
 188
 189
 190 <!-- ##### FUNCTION Accessible_isComponent ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @obj:
 196 @Returns:
 197
 198
 199 <!-- ##### FUNCTION Accessible_isDocument ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @obj:
 205 @Returns:
 206
 207
 208 <!-- ##### FUNCTION Accessible_isEditableText ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @obj:
 214 @Returns:
 215
 216
 217 <!-- ##### FUNCTION Accessible_isHypertext ##### -->
 218 <para>
 219
 220 </para>
 221
 222 @obj:
 223 @Returns:
 224
 225
 226 <!-- ##### FUNCTION Accessible_isImage ##### -->
 227 <para>
 228
 229 </para>
 230
 231 @obj:
 232 @Returns:
 233
 234
 235 <!-- ##### FUNCTION Accessible_isSelection ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @obj:
 241 @Returns:
 242
 243
 244 <!-- ##### FUNCTION Accessible_isStreamableContent ##### -->
 245 <para>
 246
 247 </para>
 248
 249 @obj:
 250 @Returns:
 251
 252
 253 <!-- ##### FUNCTION Accessible_isTable ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @obj:
 259 @Returns:
 260
 261
 262 <!-- ##### FUNCTION Accessible_isText ##### -->
 263 <para>
 264
 265 </para>
 266
 267 @obj:
 268 @Returns:
 269
 270
 271 <!-- ##### FUNCTION Accessible_isValue ##### -->
 272 <para>
 273
 274 </para>
 275
 276 @obj:
 277 @Returns:
 278
 279
 280 <!-- ##### FUNCTION Accessible_getAction ##### -->
 281 <para>
 282
 283 </para>
 284
 285 @obj:
 286 @Returns:
 287
 288
 289 <!-- ##### FUNCTION Accessible_getApplication ##### -->
 290 <para>
 291
 292 </para>
 293
 294 @obj:
 295 @Returns:
 296
 297
 298 <!-- ##### FUNCTION Accessible_getComponent ##### -->
 299 <para>
 300
 301 </para>
 302
 303 @obj:
 304 @Returns:
 305
 306
 307 <!-- ##### FUNCTION Accessible_getDocument ##### -->
 308 <para>
 309
 310 </para>
 311
 312 @obj:
 313 @Returns:
 314
 315
 316 <!-- ##### FUNCTION Accessible_getEditableText ##### -->
 317 <para>
 318
 319 </para>
 320
 321 @obj:
 322 @Returns:
 323
 324
 325 <!-- ##### FUNCTION Accessible_getHypertext ##### -->
 326 <para>
 327
 328 </para>
 329
 330 @obj:
 331 @Returns:
 332
 333
 334 <!-- ##### FUNCTION Accessible_getImage ##### -->
 335 <para>
 336
 337 </para>
 338
 339 @obj:
 340 @Returns:
 341
 342
 343 <!-- ##### FUNCTION Accessible_getSelection ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @obj:
 349 @Returns:
 350
 351
 352 <!-- ##### FUNCTION Accessible_getStreamableContent ##### -->
 353 <para>
 354
 355 </para>
 356
 357 @obj:
 358 @Returns:
 359
 360
 361 <!-- ##### FUNCTION Accessible_getTable ##### -->
 362 <para>
 363
 364 </para>
 365
 366 @obj:
 367 @Returns:
 368
 369
 370 <!-- ##### FUNCTION Accessible_getText ##### -->
 371 <para>
 372
 373 </para>
 374
 375 @obj:
 376 @Returns:
 377
 378
 379 <!-- ##### FUNCTION Accessible_getValue ##### -->
 380 <para>
 381
 382 </para>
 383
 384 @obj:
 385 @Returns:
 386
 387
 388 <!-- ##### FUNCTION Accessible_queryInterface ##### -->
 389 <para>
 390
 391 </para>
 392
 393 @obj:
 394 @interface_name:
 395 @Returns:
 396
 397
 398 <!-- ##### ENUM AccessibleRole ##### -->
 399 <para>
 400
 401 </para>
 402
 403 @SPI_ROLE_INVALID:
 404 @SPI_ROLE_ACCEL_LABEL:
 405 @SPI_ROLE_ALERT:
 406 @SPI_ROLE_ANIMATION:
 407 @SPI_ROLE_ARROW:
 408 @SPI_ROLE_CALENDAR:
 409 @SPI_ROLE_CANVAS:
 410 @SPI_ROLE_CHECK_BOX:
 411 @SPI_ROLE_CHECK_MENU_ITEM:
 412 @SPI_ROLE_COLOR_CHOOSER:
 413 @SPI_ROLE_COLUMN_HEADER:
 414 @SPI_ROLE_COMBO_BOX:
 415 @SPI_ROLE_DATE_EDITOR:
 416 @SPI_ROLE_DESKTOP_ICON:
 417 @SPI_ROLE_DESKTOP_FRAME:
 418 @SPI_ROLE_DIAL:
 419 @SPI_ROLE_DIALOG:
 420 @SPI_ROLE_DIRECTORY_PANE:
 421 @SPI_ROLE_DRAWING_AREA:
 422 @SPI_ROLE_FILE_CHOOSER:
 423 @SPI_ROLE_FILLER:
 424 @SPI_ROLE_FONT_CHOOSER:
 425 @SPI_ROLE_FRAME:
 426 @SPI_ROLE_GLASS_PANE:
 427 @SPI_ROLE_HTML_CONTAINER:
 428 @SPI_ROLE_ICON:
 429 @SPI_ROLE_IMAGE:
 430 @SPI_ROLE_INTERNAL_FRAME:
 431 @SPI_ROLE_LABEL:
 432 @SPI_ROLE_LAYERED_PANE:
 433 @SPI_ROLE_LIST:
 434 @SPI_ROLE_LIST_ITEM:
 435 @SPI_ROLE_MENU:
 436 @SPI_ROLE_MENU_BAR:
 437 @SPI_ROLE_MENU_ITEM:
 438 @SPI_ROLE_OPTION_PANE:
 439 @SPI_ROLE_PAGE_TAB:
 440 @SPI_ROLE_PAGE_TAB_LIST:
 441 @SPI_ROLE_PANEL:
 442 @SPI_ROLE_PASSWORD_TEXT:
 443 @SPI_ROLE_POPUP_MENU:
 444 @SPI_ROLE_PROGRESS_BAR:
 445 @SPI_ROLE_PUSH_BUTTON:
 446 @SPI_ROLE_RADIO_BUTTON:
 447 @SPI_ROLE_RADIO_MENU_ITEM:
 448 @SPI_ROLE_ROOT_PANE:
 449 @SPI_ROLE_ROW_HEADER:
 450 @SPI_ROLE_SCROLL_BAR:
 451 @SPI_ROLE_SCROLL_PANE:
 452 @SPI_ROLE_SEPARATOR:
 453 @SPI_ROLE_SLIDER:
 454 @SPI_ROLE_SPIN_BUTTON:
 455 @SPI_ROLE_SPLIT_PANE:
 456 @SPI_ROLE_STATUS_BAR:
 457 @SPI_ROLE_TABLE:
 458 @SPI_ROLE_TABLE_CELL:
 459 @SPI_ROLE_TABLE_COLUMN_HEADER:
 460 @SPI_ROLE_TABLE_ROW_HEADER:
 461 @SPI_ROLE_TEAROFF_MENU_ITEM:
 462 @SPI_ROLE_TERMINAL:
 463 @SPI_ROLE_TEXT:
 464 @SPI_ROLE_TOGGLE_BUTTON:
 465 @SPI_ROLE_TOOL_BAR:
 466 @SPI_ROLE_TOOL_TIP:
 467 @SPI_ROLE_TREE:
 468 @SPI_ROLE_TREE_TABLE:
 469 @SPI_ROLE_UNKNOWN:
 470 @SPI_ROLE_VIEWPORT:
 471 @SPI_ROLE_WINDOW:
 472 @SPI_ROLE_EXTENDED:
 473 @SPI_ROLE_HEADER:
 474 @SPI_ROLE_FOOTER:
 475 @SPI_ROLE_PARAGRAPH:
 476 @SPI_ROLE_RULER:
 477 @SPI_ROLE_APPLICATION:
 478 @SPI_ROLE_AUTOCOMPLETE:
 479 @SPI_ROLE_EDITBAR:
 480 @SPI_ROLE_EMBEDDED:
 481 @SPI_ROLE_ENTRY:
 482 @SPI_ROLE_CHART:
 483 @SPI_ROLE_CAPTION:
 484 @SPI_ROLE_DOCUMENT_FRAME:
 485 @SPI_ROLE_HEADING:
 486 @SPI_ROLE_PAGE:
 487 @SPI_ROLE_SECTION:
 488 @SPI_ROLE_FORM:
 489 @SPI_ROLE_REDUNDANT_OBJECT:
 490 @SPI_ROLE_LINK:
 491 @SPI_ROLE_INPUT_METHOD_WINDOW:
 492 @SPI_ROLE_LAST_DEFINED:
 493
 494 <!-- ##### FUNCTION AccessibleRole_getName ##### -->
 495 <para>
 496
 497 </para>
 498
 499 @role:
 500 @Returns:
 501
 502