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