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_LAST_DEFINED:
 118
 119 <!-- ##### FUNCTION atk_role_register ##### -->
 120 <para>
 121
 122 </para>
 123
 124 @name:
 125 @Returns:
 126
 127
 128 <!-- ##### ENUM AtkLayer ##### -->
 129 <para>
 130 These enumerated "layer values" are used when determining which UI
 131 rendering layer a component is drawn into, which can help in making
 132 determinations of when components occlude one another.
 133 </para>
 134
 135 @ATK_LAYER_INVALID:
 136 @ATK_LAYER_BACKGROUND:
 137 @ATK_LAYER_CANVAS:
 138 @ATK_LAYER_WIDGET:
 139 @ATK_LAYER_MDI:
 140 @ATK_LAYER_POPUP:
 141 @ATK_LAYER_OVERLAY:
 142
 143 <!-- ##### STRUCT AtkImplementor ##### -->
 144 <para>
 145 The AtkImplementor structure does not contain any fields.
 146
 147 </para>
 148
 149
 150 <!-- ##### STRUCT AtkPropertyValues ##### -->
 151 <para>
 152 The Atk PropertyValue structure is used when notifying a change in property.
 153 Currently, the only property for which old_value is used is
 154 accessible-state; for instance if there is a focus change the
 155 property change handler will be called for the object which lost the focus
 156 with the old_value containing the AtkState value corresponding to focused
 157 and the property change handler will be called for the object which
 158 received the focus with the new_value containing the AtkState value
 159 corresponding to focused.
 160
 161 </para>
 162
 163 @property_name:
 164 @old_value:
 165 @new_value:
 166
 167 <!-- ##### USER_FUNCTION AtkFunction ##### -->
 168 <para>
 169 An AtkFunction is a function definition used for padding which has been added
 170 to class and interface structures to allow for expansion in the future.
 171
 172 </para>
 173
 174 @data:
 175 @Returns:
 176
 177
 178 <!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### -->
 179 <para>
 180 An AtkPropertyChangeHandler is a function which is executed when an AtkObject's property changes value. It is specified in a call to
 181 atk_object_connect_property_change_handler().
 182 </para>
 183
 184 @Param1:
 185 @Param2:
 186
 187
 188 <!-- ##### FUNCTION atk_implementor_ref_accessible ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @implementor:
 194 @Returns:
 195
 196
 197 <!-- ##### FUNCTION atk_object_get_name ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @accessible:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION atk_object_get_description ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @accessible:
 212 @Returns:
 213
 214
 215 <!-- ##### FUNCTION atk_object_get_parent ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @accessible:
 221 @Returns:
 222
 223
 224 <!-- ##### FUNCTION atk_object_get_n_accessible_children ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @accessible:
 230 @Returns:
 231
 232
 233 <!-- ##### FUNCTION atk_object_ref_accessible_child ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @accessible:
 239 @i:
 240 @Returns:
 241
 242
 243 <!-- ##### FUNCTION atk_object_ref_relation_set ##### -->
 244 <para>
 245
 246 </para>
 247
 248 @accessible:
 249 @Returns:
 250
 251
 252 <!-- ##### FUNCTION atk_object_get_layer ##### -->
 253 <para>
 254
 255 </para>
 256
 257 @accessible:
 258 @Returns:
 259
 260
 261 <!-- ##### FUNCTION atk_object_get_mdi_zorder ##### -->
 262 <para>
 263
 264 </para>
 265
 266 @accessible:
 267 @Returns:
 268
 269
 270 <!-- ##### FUNCTION atk_object_get_role ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @accessible:
 276 @Returns:
 277
 278
 279 <!-- ##### FUNCTION atk_object_ref_state_set ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @accessible:
 285 @Returns:
 286
 287
 288 <!-- ##### FUNCTION atk_object_get_index_in_parent ##### -->
 289 <para>
 290
 291 </para>
 292
 293 @accessible:
 294 @Returns:
 295
 296
 297 <!-- ##### FUNCTION atk_object_set_name ##### -->
 298 <para>
 299
 300 </para>
 301
 302 @accessible:
 303 @name:
 304
 305
 306 <!-- ##### FUNCTION atk_object_set_description ##### -->
 307 <para>
 308
 309 </para>
 310
 311 @accessible:
 312 @description:
 313
 314
 315 <!-- ##### FUNCTION atk_object_set_parent ##### -->
 316 <para>
 317
 318 </para>
 319
 320 @accessible:
 321 @parent:
 322
 323
 324 <!-- ##### FUNCTION atk_object_set_role ##### -->
 325 <para>
 326
 327 </para>
 328
 329 @accessible:
 330 @role:
 331
 332
 333 <!-- ##### FUNCTION atk_object_connect_property_change_handler ##### -->
 334 <para>
 335
 336 </para>
 337
 338 @accessible:
 339 @handler:
 340 @Returns:
 341
 342
 343 <!-- ##### FUNCTION atk_object_remove_property_change_handler ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @accessible:
 349 @handler_id:
 350
 351
 352 <!-- ##### FUNCTION atk_object_notify_state_change ##### -->
 353 <para>
 354
 355 </para>
 356
 357 @accessible:
 358 @state:
 359 @value:
 360
 361
 362 <!-- ##### FUNCTION atk_object_initialize ##### -->
 363 <para>
 364
 365 </para>
 366
 367 @accessible:
 368 @data:
 369
 370
 371 <!-- ##### FUNCTION atk_role_get_name ##### -->
 372 <para>
 373
 374 </para>
 375
 376 @role:
 377 @Returns:
 378
 379
 380 <!-- ##### FUNCTION atk_role_for_name ##### -->
 381 <para>
 382
 383 </para>
 384
 385 @name:
 386 @Returns:
 387
 388
 389 <!-- ##### SIGNAL AtkObject::children-changed ##### -->
 390 <para>
 391 The children_changed signal supports two details, "add" and "remove" which
 392 indicate whether a child was added or removed
 393 </para>
 394
 395 @atkobject: the object which received the signal.
 396 @arg1: The index of the added or removed child
 397 @arg2: The child which was added or removed
 398
 399 <!-- ##### SIGNAL AtkObject::focus-event ##### -->
 400 <para>
 401
 402 </para>
 403
 404 @atkobject: the object which received the signal.
 405 @arg1: A boolean value which indicates whether or not the focus event is is or out.
 406
 407 <!-- ##### SIGNAL AtkObject::property-change ##### -->
 408 <para>
 409 This signal support a detail which identifies the property which has
 410 changed.
 411 </para>
 412
 413 @atkobject: the object which received the signal.
 414 @arg1: The new value of the property which changed.
 415
 416 <!-- ##### SIGNAL AtkObject::state-change ##### -->
 417 <para>
 418 This signal support, which may be any of the accessible state types.
 419 </para>
 420
 421 @atkobject: the object which received the signal.
 422 @arg1: The name of the state which has changed
 423 @arg2: A boolean which indicates whether the state has been set or unset.
 424
 425 <!-- ##### SIGNAL AtkObject::visible-data-changed ##### -->
 426 <para>
 427
 428 </para>
 429
 430 @atkobject: the object which received the signal.
 431
 432 <!-- ##### ARG AtkObject:accessible-name ##### -->
 433 <para>
 434
 435 </para>
 436
 437 <!-- ##### ARG AtkObject:accessible-description ##### -->
 438 <para>
 439
 440 </para>
 441
 442 <!-- ##### ARG AtkObject:accessible-parent ##### -->
 443 <para>
 444
 445 </para>
 446
 447 <!-- ##### ARG AtkObject:accessible-value ##### -->
 448 <para>
 449
 450 </para>
 451
 452 <!-- ##### ARG AtkObject:accessible-role ##### -->
 453 <para>
 454
 455 </para>
 456
 457 <!-- ##### ARG AtkObject:accessible-component-layer ##### -->
 458 <para>
 459
 460 </para>
 461
 462 <!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### -->
 463 <para>
 464
 465 </para>
 466
 467 <!-- ##### ARG AtkObject:accessible-table-caption ##### -->
 468 <para>
 469
 470 </para>
 471
 472 <!-- ##### ARG AtkObject:accessible-table-column-description ##### -->
 473 <para>
 474
 475 </para>
 476
 477 <!-- ##### ARG AtkObject:accessible-table-column-header ##### -->
 478 <para>
 479
 480 </para>
 481
 482 <!-- ##### ARG AtkObject:accessible-table-row-description ##### -->
 483 <para>
 484
 485 </para>
 486
 487 <!-- ##### ARG AtkObject:accessible-table-row-header ##### -->
 488 <para>
 489
 490 </para>
 491
 492 <!-- ##### ARG AtkObject:accessible-table-summary ##### -->
 493 <para>
 494
 495 </para>
 496