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