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