docs/reference/cspi/tmpl/spi_accessible.sgml

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