docs/tmpl/atkobject.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkObject
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 The base object class for the Accessibility Toolkit API.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 This class is the primary class for accessibility support via
  11 the Accessibility ToolKit (ATK).  Objects which are instances
  12 of #AtkObject (or instances of AtkObject-derived types) are
  13 queried for properties which relate basic (and generic) properties of a
  14 UI component such as name and description.  Instances of #AtkObject
  15 may also be queried as to whether they implement other ATK interfaces
  16 (e.g. #AtkAction, #AtkComponent, etc.), as appropriate to the role
  17 which a given UI component plays in a user interface.
  18 </para>
  19 <para>All UI components in an application which provide useful
  20 information or services to the user must provide corresponding
  21 #AtkObject instances on request (in GTK+, for instance, usually
  22 on a call to #gtk_widget_get_accessible ()), either via ATK support
  23 built into the toolkit for the widget class or ancestor class, or in
  24 the case of custom widgets, if the inherited #AtkObject implementation
  25 is insufficient, via instances of a new #AtkObject subclass.
  26 </para>
  27
  28 <!-- ##### SECTION See_Also ##### -->
  29 <para>
  30 See also: #AtkObjectFactory, #AtkRegistry.
  31 ( GTK+ users see also #GtkAccessible).
  32 </para>
  33
  34 <!-- ##### STRUCT AtkObject ##### -->
  35 <para>
  36 The AtkObject structure should not be accessed directly.
  37
  38 </para>
  39
  40
  41 <!-- ##### ENUM AtkRole ##### -->
  42 <para>
  43 These are the built-in enumerated roles that UI components can have in
  44 ATK.  Other roles may be added at runtime, so an AtkRole >=
  45 ATK_ROLE_LAST_DEFINED is not necessarily an error.
  46 </para>
  47
  48 @ATK_ROLE_INVALID:
  49 @ATK_ROLE_ACCEL_LABEL:
  50 @ATK_ROLE_ALERT:
  51 @ATK_ROLE_ANIMATION:
  52 @ATK_ROLE_ARROW:
  53 @ATK_ROLE_CALENDAR:
  54 @ATK_ROLE_CANVAS:
  55 @ATK_ROLE_CHECK_BOX:
  56 @ATK_ROLE_CHECK_MENU_ITEM:
  57 @ATK_ROLE_COLOR_CHOOSER:
  58 @ATK_ROLE_COLUMN_HEADER:
  59 @ATK_ROLE_COMBO_BOX:
  60 @ATK_ROLE_DATE_EDITOR:
  61 @ATK_ROLE_DESKTOP_ICON:
  62 @ATK_ROLE_DESKTOP_FRAME:
  63 @ATK_ROLE_DIAL:
  64 @ATK_ROLE_DIALOG:
  65 @ATK_ROLE_DIRECTORY_PANE:
  66 @ATK_ROLE_DRAWING_AREA:
  67 @ATK_ROLE_FILE_CHOOSER:
  68 @ATK_ROLE_FILLER:
  69 @ATK_ROLE_FONT_CHOOSER:
  70 @ATK_ROLE_FRAME:
  71 @ATK_ROLE_GLASS_PANE:
  72 @ATK_ROLE_HTML_CONTAINER:
  73 @ATK_ROLE_ICON:
  74 @ATK_ROLE_IMAGE:
  75 @ATK_ROLE_INTERNAL_FRAME:
  76 @ATK_ROLE_LABEL:
  77 @ATK_ROLE_LAYERED_PANE:
  78 @ATK_ROLE_LIST:
  79 @ATK_ROLE_LIST_ITEM:
  80 @ATK_ROLE_MENU:
  81 @ATK_ROLE_MENU_BAR:
  82 @ATK_ROLE_MENU_ITEM:
  83 @ATK_ROLE_OPTION_PANE:
  84 @ATK_ROLE_PAGE_TAB:
  85 @ATK_ROLE_PAGE_TAB_LIST:
  86 @ATK_ROLE_PANEL:
  87 @ATK_ROLE_PASSWORD_TEXT:
  88 @ATK_ROLE_POPUP_MENU:
  89 @ATK_ROLE_PROGRESS_BAR:
  90 @ATK_ROLE_PUSH_BUTTON:
  91 @ATK_ROLE_RADIO_BUTTON:
  92 @ATK_ROLE_RADIO_MENU_ITEM:
  93 @ATK_ROLE_ROOT_PANE:
  94 @ATK_ROLE_ROW_HEADER:
  95 @ATK_ROLE_SCROLL_BAR:
  96 @ATK_ROLE_SCROLL_PANE:
  97 @ATK_ROLE_SEPARATOR:
  98 @ATK_ROLE_SLIDER:
  99 @ATK_ROLE_SPLIT_PANE:
 100 @ATK_ROLE_SPIN_BUTTON:
 101 @ATK_ROLE_STATUSBAR:
 102 @ATK_ROLE_TABLE:
 103 @ATK_ROLE_TABLE_CELL:
 104 @ATK_ROLE_TABLE_COLUMN_HEADER:
 105 @ATK_ROLE_TABLE_ROW_HEADER:
 106 @ATK_ROLE_TEAR_OFF_MENU_ITEM:
 107 @ATK_ROLE_TERMINAL:
 108 @ATK_ROLE_TEXT:
 109 @ATK_ROLE_TOGGLE_BUTTON:
 110 @ATK_ROLE_TOOL_BAR:
 111 @ATK_ROLE_TOOL_TIP:
 112 @ATK_ROLE_TREE:
 113 @ATK_ROLE_TREE_TABLE:
 114 @ATK_ROLE_UNKNOWN:
 115 @ATK_ROLE_VIEWPORT:
 116 @ATK_ROLE_WINDOW:
 117 @ATK_ROLE_HEADER:
 118 @ATK_ROLE_FOOTER:
 119 @ATK_ROLE_PARAGRAPH:
 120 @ATK_ROLE_RULER:
 121 @ATK_ROLE_APPLICATION:
 122 @ATK_ROLE_LAST_DEFINED:
 123
 124 <!-- ##### FUNCTION atk_role_register ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @name:
 130 @Returns:
 131
 132
 133 <!-- ##### ENUM AtkLayer ##### -->
 134 <para>
 135 These enumerated "layer values" are used when determining which UI
 136 rendering layer a component is drawn into, which can help in making
 137 determinations of when components occlude one another.
 138 </para>
 139
 140 @ATK_LAYER_INVALID:
 141 @ATK_LAYER_BACKGROUND:
 142 @ATK_LAYER_CANVAS:
 143 @ATK_LAYER_WIDGET:
 144 @ATK_LAYER_MDI:
 145 @ATK_LAYER_POPUP:
 146 @ATK_LAYER_OVERLAY:
 147 @ATK_LAYER_WINDOW:
 148
 149 <!-- ##### STRUCT AtkImplementor ##### -->
 150 <para>
 151 The AtkImplementor structure does not contain any fields.
 152
 153 </para>
 154
 155
 156 <!-- ##### STRUCT AtkPropertyValues ##### -->
 157 <para>
 158 The Atk PropertyValue structure is used when notifying a change in property.
 159 Currently, the only property for which old_value is used is
 160 accessible-state; for instance if there is a focus change the
 161 property change handler will be called for the object which lost the focus
 162 with the old_value containing the AtkState value corresponding to focused
 163 and the property change handler will be called for the object which
 164 received the focus with the new_value containing the AtkState value
 165 corresponding to focused.
 166
 167 </para>
 168
 169 @property_name:
 170 @old_value:
 171 @new_value:
 172
 173 <!-- ##### USER_FUNCTION AtkFunction ##### -->
 174 <para>
 175 An AtkFunction is a function definition used for padding which has been added
 176 to class and interface structures to allow for expansion in the future.
 177
 178 </para>
 179
 180 @data:
 181 @Returns:
 182
 183
 184 <!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### -->
 185 <para>
 186 An AtkPropertyChangeHandler is a function which is executed when an AtkObject's property changes value. It is specified in a call to
 187 atk_object_connect_property_change_handler().
 188 </para>
 189
 190 @Param1:
 191 @Param2:
 192
 193
 194 <!-- ##### FUNCTION atk_implementor_ref_accessible ##### -->
 195 <para>
 196
 197 </para>
 198
 199 @implementor:
 200 @Returns:
 201
 202
 203 <!-- ##### FUNCTION atk_object_get_name ##### -->
 204 <para>
 205
 206 </para>
 207
 208 @accessible:
 209 @Returns:
 210
 211
 212 <!-- ##### FUNCTION atk_object_get_description ##### -->
 213 <para>
 214
 215 </para>
 216
 217 @accessible:
 218 @Returns:
 219
 220
 221 <!-- ##### FUNCTION atk_object_get_parent ##### -->
 222 <para>
 223
 224 </para>
 225
 226 @accessible:
 227 @Returns:
 228
 229
 230 <!-- ##### FUNCTION atk_object_get_n_accessible_children ##### -->
 231 <para>
 232
 233 </para>
 234
 235 @accessible:
 236 @Returns:
 237
 238
 239 <!-- ##### FUNCTION atk_object_ref_accessible_child ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @accessible:
 245 @i:
 246 @Returns:
 247
 248
 249 <!-- ##### FUNCTION atk_object_ref_relation_set ##### -->
 250 <para>
 251
 252 </para>
 253
 254 @accessible:
 255 @Returns:
 256
 257
 258 <!-- ##### FUNCTION atk_object_get_layer ##### -->
 259 <para>
 260
 261 </para>
 262
 263 @accessible:
 264 @Returns:
 265
 266
 267 <!-- ##### FUNCTION atk_object_get_mdi_zorder ##### -->
 268 <para>
 269
 270 </para>
 271
 272 @accessible:
 273 @Returns:
 274
 275
 276 <!-- ##### FUNCTION atk_object_get_role ##### -->
 277 <para>
 278
 279 </para>
 280
 281 @accessible:
 282 @Returns:
 283
 284
 285 <!-- ##### FUNCTION atk_object_ref_state_set ##### -->
 286 <para>
 287
 288 </para>
 289
 290 @accessible:
 291 @Returns:
 292
 293
 294 <!-- ##### FUNCTION atk_object_get_index_in_parent ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @accessible:
 300 @Returns:
 301
 302
 303 <!-- ##### FUNCTION atk_object_set_name ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @accessible:
 309 @name:
 310
 311
 312 <!-- ##### FUNCTION atk_object_set_description ##### -->
 313 <para>
 314
 315 </para>
 316
 317 @accessible:
 318 @description:
 319
 320
 321 <!-- ##### FUNCTION atk_object_set_parent ##### -->
 322 <para>
 323
 324 </para>
 325
 326 @accessible:
 327 @parent:
 328
 329
 330 <!-- ##### FUNCTION atk_object_set_role ##### -->
 331 <para>
 332
 333 </para>
 334
 335 @accessible:
 336 @role:
 337
 338
 339 <!-- ##### FUNCTION atk_object_connect_property_change_handler ##### -->
 340 <para>
 341
 342 </para>
 343
 344 @accessible:
 345 @handler:
 346 @Returns:
 347
 348
 349 <!-- ##### FUNCTION atk_object_remove_property_change_handler ##### -->
 350 <para>
 351
 352 </para>
 353
 354 @accessible:
 355 @handler_id:
 356
 357
 358 <!-- ##### FUNCTION atk_object_notify_state_change ##### -->
 359 <para>
 360
 361 </para>
 362
 363 @accessible:
 364 @state:
 365 @value:
 366
 367
 368 <!-- ##### FUNCTION atk_object_initialize ##### -->
 369 <para>
 370
 371 </para>
 372
 373 @accessible:
 374 @data:
 375
 376
 377 <!-- ##### FUNCTION atk_object_add_relationship ##### -->
 378 <para>
 379
 380 </para>
 381
 382 @object:
 383 @relationship:
 384 @target:
 385 @Returns:
 386
 387
 388 <!-- ##### FUNCTION atk_object_remove_relationship ##### -->
 389 <para>
 390
 391 </para>
 392
 393 @object:
 394 @relationship:
 395 @target:
 396 @Returns:
 397
 398
 399 <!-- ##### FUNCTION atk_role_get_name ##### -->
 400 <para>
 401
 402 </para>
 403
 404 @role:
 405 @Returns:
 406
 407
 408 <!-- ##### FUNCTION atk_role_get_localized_name ##### -->
 409 <para>
 410
 411 </para>
 412
 413 @role:
 414 @Returns:
 415
 416
 417 <!-- ##### FUNCTION atk_role_for_name ##### -->
 418 <para>
 419
 420 </para>
 421
 422 @name:
 423 @Returns:
 424
 425
 426 <!-- ##### SIGNAL AtkObject::active-descendant-changed ##### -->
 427 <para>
 428
 429 </para>
 430
 431 @atkobject: the object which received the signal.
 432 @arg1:
 433
 434 <!-- ##### SIGNAL AtkObject::children-changed ##### -->
 435 <para>
 436 The children_changed signal supports two details, "add" and "remove" which
 437 indicate whether a child was added or removed
 438 </para>
 439
 440 @atkobject: the object which received the signal.
 441 @arg1: The index of the added or removed child
 442 @arg2: The child which was added or removed
 443
 444 <!-- ##### SIGNAL AtkObject::focus-event ##### -->
 445 <para>
 446
 447 </para>
 448
 449 @atkobject: the object which received the signal.
 450 @arg1: A boolean value which indicates whether or not the focus event is is or out.
 451
 452 <!-- ##### SIGNAL AtkObject::property-change ##### -->
 453 <para>
 454 This signal support a detail which identifies the property which has
 455 changed.
 456 </para>
 457
 458 @atkobject: the object which received the signal.
 459 @arg1: The new value of the property which changed.
 460
 461 <!-- ##### SIGNAL AtkObject::state-change ##### -->
 462 <para>
 463 This signal support, which may be any of the accessible state types.
 464 </para>
 465
 466 @atkobject: the object which received the signal.
 467 @arg1: The name of the state which has changed
 468 @arg2: A boolean which indicates whether the state has been set or unset.
 469
 470 <!-- ##### SIGNAL AtkObject::visible-data-changed ##### -->
 471 <para>
 472
 473 </para>
 474
 475 @atkobject: the object which received the signal.
 476
 477 <!-- ##### ARG AtkObject:accessible-component-layer ##### -->
 478 <para>
 479
 480 </para>
 481
 482 <!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### -->
 483 <para>
 484
 485 </para>
 486
 487 <!-- ##### ARG AtkObject:accessible-description ##### -->
 488 <para>
 489
 490 </para>
 491
 492 <!-- ##### ARG AtkObject:accessible-name ##### -->
 493 <para>
 494
 495 </para>
 496
 497 <!-- ##### ARG AtkObject:accessible-parent ##### -->
 498 <para>
 499
 500 </para>
 501
 502 <!-- ##### ARG AtkObject:accessible-role ##### -->
 503 <para>
 504
 505 </para>
 506
 507 <!-- ##### ARG AtkObject:accessible-table-caption ##### -->
 508 <para>
 509
 510 </para>
 511
 512 <!-- ##### ARG AtkObject:accessible-table-column-description ##### -->
 513 <para>
 514
 515 </para>
 516
 517 <!-- ##### ARG AtkObject:accessible-table-column-header ##### -->
 518 <para>
 519
 520 </para>
 521
 522 <!-- ##### ARG AtkObject:accessible-table-row-description ##### -->
 523 <para>
 524
 525 </para>
 526
 527 <!-- ##### ARG AtkObject:accessible-table-row-header ##### -->
 528 <para>
 529
 530 </para>
 531
 532 <!-- ##### ARG AtkObject:accessible-table-summary ##### -->
 533 <para>
 534
 535 </para>
 536
 537 <!-- ##### ARG AtkObject:accessible-value ##### -->
 538 <para>
 539
 540 </para>
 541