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
  37 </para>
  38
  39 @parent:
  40 @description:
  41 @name:
  42 @accessible_parent:
  43 @role:
  44 @relation_set:
  45 @layer:
  46
  47 <!-- ##### ENUM AtkRole ##### -->
  48 <para>
  49 These are the built-in enumerated roles that UI components can have in
  50 ATK.  Other roles may be added at runtime, so an AtkRole >=
  51 ATK_ROLE_LAST_DEFINED is not necessarily an error.
  52 </para>
  53
  54 @ATK_ROLE_INVALID:
  55 @ATK_ROLE_ACCEL_LABEL:
  56 @ATK_ROLE_ALERT:
  57 @ATK_ROLE_ANIMATION:
  58 @ATK_ROLE_ARROW:
  59 @ATK_ROLE_CALENDAR:
  60 @ATK_ROLE_CANVAS:
  61 @ATK_ROLE_CHECK_BOX:
  62 @ATK_ROLE_CHECK_MENU_ITEM:
  63 @ATK_ROLE_COLOR_CHOOSER:
  64 @ATK_ROLE_COLUMN_HEADER:
  65 @ATK_ROLE_COMBO_BOX:
  66 @ATK_ROLE_DATE_EDITOR:
  67 @ATK_ROLE_DESKTOP_ICON:
  68 @ATK_ROLE_DESKTOP_FRAME:
  69 @ATK_ROLE_DIAL:
  70 @ATK_ROLE_DIALOG:
  71 @ATK_ROLE_DIRECTORY_PANE:
  72 @ATK_ROLE_DRAWING_AREA:
  73 @ATK_ROLE_FILE_CHOOSER:
  74 @ATK_ROLE_FILLER:
  75 @ATK_ROLE_FONT_CHOOSER:
  76 @ATK_ROLE_FRAME:
  77 @ATK_ROLE_GLASS_PANE:
  78 @ATK_ROLE_HTML_CONTAINER:
  79 @ATK_ROLE_ICON:
  80 @ATK_ROLE_IMAGE:
  81 @ATK_ROLE_INTERNAL_FRAME:
  82 @ATK_ROLE_LABEL:
  83 @ATK_ROLE_LAYERED_PANE:
  84 @ATK_ROLE_LIST:
  85 @ATK_ROLE_LIST_ITEM:
  86 @ATK_ROLE_MENU:
  87 @ATK_ROLE_MENU_BAR:
  88 @ATK_ROLE_MENU_ITEM:
  89 @ATK_ROLE_OPTION_PANE:
  90 @ATK_ROLE_PAGE_TAB:
  91 @ATK_ROLE_PAGE_TAB_LIST:
  92 @ATK_ROLE_PANEL:
  93 @ATK_ROLE_PASSWORD_TEXT:
  94 @ATK_ROLE_POPUP_MENU:
  95 @ATK_ROLE_PROGRESS_BAR:
  96 @ATK_ROLE_PUSH_BUTTON:
  97 @ATK_ROLE_RADIO_BUTTON:
  98 @ATK_ROLE_RADIO_MENU_ITEM:
  99 @ATK_ROLE_ROOT_PANE:
 100 @ATK_ROLE_ROW_HEADER:
 101 @ATK_ROLE_SCROLL_BAR:
 102 @ATK_ROLE_SCROLL_PANE:
 103 @ATK_ROLE_SEPARATOR:
 104 @ATK_ROLE_SLIDER:
 105 @ATK_ROLE_SPLIT_PANE:
 106 @ATK_ROLE_SPIN_BUTTON:
 107 @ATK_ROLE_STATUSBAR:
 108 @ATK_ROLE_TABLE:
 109 @ATK_ROLE_TABLE_CELL:
 110 @ATK_ROLE_TABLE_COLUMN_HEADER:
 111 @ATK_ROLE_TABLE_ROW_HEADER:
 112 @ATK_ROLE_TEAR_OFF_MENU_ITEM:
 113 @ATK_ROLE_TERMINAL:
 114 @ATK_ROLE_TEXT:
 115 @ATK_ROLE_TOGGLE_BUTTON:
 116 @ATK_ROLE_TOOL_BAR:
 117 @ATK_ROLE_TOOL_TIP:
 118 @ATK_ROLE_TREE:
 119 @ATK_ROLE_TREE_TABLE:
 120 @ATK_ROLE_UNKNOWN:
 121 @ATK_ROLE_VIEWPORT:
 122 @ATK_ROLE_WINDOW:
 123 @ATK_ROLE_LAST_DEFINED:
 124
 125 <!-- ##### FUNCTION atk_role_register ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @name:
 131 @Returns:
 132
 133
 134 <!-- ##### ENUM AtkLayer ##### -->
 135 <para>
 136 These enumerated "layer values" are used when determining which UI
 137 rendering layer a component is drawn into, which can help in making
 138 determinations of when components occlude one another.
 139 </para>
 140
 141 @ATK_LAYER_INVALID:
 142 @ATK_LAYER_BACKGROUND:
 143 @ATK_LAYER_CANVAS:
 144 @ATK_LAYER_WIDGET:
 145 @ATK_LAYER_MDI:
 146 @ATK_LAYER_POPUP:
 147 @ATK_LAYER_OVERLAY:
 148
 149 <!-- ##### STRUCT AtkImplementor ##### -->
 150 <para>
 151
 152 </para>
 153
 154
 155 <!-- ##### STRUCT AtkImplementorIface ##### -->
 156 <para>
 157 This interface provides an alternative means of obtaining AtkObjects
 158 from a GOBject instance, and for querying whether a GObject instance
 159 provides ATK functionality.
 160 </para>
 161
 162 @parent:
 163 @ref_accessible:
 164
 165 <!-- ##### STRUCT AtkRelationSet ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @parent:
 171 @relations:
 172
 173 <!-- ##### STRUCT AtkPropertyValues ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @property_name:
 179 @old_value:
 180 @new_value:
 181
 182 <!-- ##### USER_FUNCTION AtkFunction ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @data:
 188 @Returns:
 189
 190
 191 <!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @Param1:
 197 @Param2:
 198
 199
 200 <!-- ##### FUNCTION atk_implementor_ref_accessible ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @implementor:
 206 @Returns:
 207
 208
 209 <!-- ##### FUNCTION atk_object_get_name ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @accessible:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION atk_object_get_description ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @accessible:
 224 @Returns:
 225
 226
 227 <!-- ##### FUNCTION atk_object_get_parent ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @accessible:
 233 @Returns:
 234
 235
 236 <!-- ##### FUNCTION atk_object_get_n_accessible_children ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @accessible:
 242 @Returns:
 243
 244
 245 <!-- ##### FUNCTION atk_object_ref_accessible_child ##### -->
 246 <para>
 247
 248 </para>
 249
 250 @accessible:
 251 @i:
 252 @Returns:
 253
 254
 255 <!-- ##### FUNCTION atk_object_ref_relation_set ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @accessible:
 261 @Returns:
 262
 263
 264 <!-- ##### FUNCTION atk_object_get_layer ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @accessible:
 270 @Returns:
 271
 272
 273 <!-- ##### FUNCTION atk_object_get_mdi_zorder ##### -->
 274 <para>
 275
 276 </para>
 277
 278 @accessible:
 279 @Returns:
 280
 281
 282 <!-- ##### FUNCTION atk_object_get_role ##### -->
 283 <para>
 284
 285 </para>
 286
 287 @accessible:
 288 @Returns:
 289
 290
 291 <!-- ##### FUNCTION atk_object_ref_state_set ##### -->
 292 <para>
 293
 294 </para>
 295
 296 @accessible:
 297 @Returns:
 298
 299
 300 <!-- ##### FUNCTION atk_object_get_index_in_parent ##### -->
 301 <para>
 302
 303 </para>
 304
 305 @accessible:
 306 @Returns:
 307
 308
 309 <!-- ##### FUNCTION atk_object_set_name ##### -->
 310 <para>
 311
 312 </para>
 313
 314 @accessible:
 315 @name:
 316
 317
 318 <!-- ##### FUNCTION atk_object_set_description ##### -->
 319 <para>
 320
 321 </para>
 322
 323 @accessible:
 324 @description:
 325
 326
 327 <!-- ##### FUNCTION atk_object_set_parent ##### -->
 328 <para>
 329
 330 </para>
 331
 332 @accessible:
 333 @parent:
 334
 335
 336 <!-- ##### FUNCTION atk_object_set_role ##### -->
 337 <para>
 338
 339 </para>
 340
 341 @accessible:
 342 @role:
 343
 344
 345 <!-- ##### FUNCTION atk_object_connect_property_change_handler ##### -->
 346 <para>
 347
 348 </para>
 349
 350 @accessible:
 351 @handler:
 352 @Returns:
 353
 354
 355 <!-- ##### FUNCTION atk_object_remove_property_change_handler ##### -->
 356 <para>
 357
 358 </para>
 359
 360 @accessible:
 361 @handler_id:
 362
 363
 364 <!-- ##### FUNCTION atk_object_notify_state_change ##### -->
 365 <para>
 366
 367 </para>
 368
 369 @accessible:
 370 @state:
 371 @value:
 372
 373
 374 <!-- ##### FUNCTION atk_object_initialize ##### -->
 375 <para>
 376
 377 </para>
 378
 379 @accessible:
 380 @data:
 381
 382
 383 <!-- ##### FUNCTION atk_role_get_name ##### -->
 384 <para>
 385
 386 </para>
 387
 388 @role:
 389 @Returns:
 390
 391
 392 <!-- ##### FUNCTION atk_role_for_name ##### -->
 393 <para>
 394
 395 </para>
 396
 397 @name:
 398 @Returns:
 399
 400