docs/tmpl/atkobject.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkObject
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 represents the minimum information all accessible objects return
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 AtkObject represents the minimum information all accessible objects
  10 return. This information includes accessible name, accessible
  11 description, role and state of the object, as well information about
  12 its parent and children. It is also possible to obtain more specific
  13 accessibility information about a component if it supports one or more
  14 of the other ATK interfaces:
  15 </para>
  16
  17 <!-- ##### SECTION See_Also ##### -->
  18 <para>
  19
  20 </para>
  21
  22 <!-- ##### STRUCT AtkObject ##### -->
  23 <para>
  24
  25 </para>
  26
  27 @parent:
  28 @description:
  29 @name:
  30 @accessible_parent:
  31 @role:
  32 @relation_set:
  33 @layer:
  34
  35 <!-- ##### ENUM AtkRole ##### -->
  36 <para>
  37
  38 </para>
  39
  40 @ATK_ROLE_INVALID:
  41 @ATK_ROLE_ACCEL_LABEL:
  42 @ATK_ROLE_ALERT:
  43 @ATK_ROLE_ANIMATION:
  44 @ATK_ROLE_ARROW:
  45 @ATK_ROLE_CALENDAR:
  46 @ATK_ROLE_CANVAS:
  47 @ATK_ROLE_CHECK_BOX:
  48 @ATK_ROLE_CHECK_MENU_ITEM:
  49 @ATK_ROLE_COLOR_CHOOSER:
  50 @ATK_ROLE_COLUMN_HEADER:
  51 @ATK_ROLE_COMBO_BOX:
  52 @ATK_ROLE_DATE_EDITOR:
  53 @ATK_ROLE_DESKTOP_ICON:
  54 @ATK_ROLE_DESKTOP_FRAME:
  55 @ATK_ROLE_DIAL:
  56 @ATK_ROLE_DIALOG:
  57 @ATK_ROLE_DIRECTORY_PANE:
  58 @ATK_ROLE_DRAWING_AREA:
  59 @ATK_ROLE_FILE_CHOOSER:
  60 @ATK_ROLE_FILLER:
  61 @ATK_ROLE_FONT_CHOOSER:
  62 @ATK_ROLE_FRAME:
  63 @ATK_ROLE_GLASS_PANE:
  64 @ATK_ROLE_HTML_CONTAINER:
  65 @ATK_ROLE_ICON:
  66 @ATK_ROLE_IMAGE:
  67 @ATK_ROLE_INTERNAL_FRAME:
  68 @ATK_ROLE_LABEL:
  69 @ATK_ROLE_LAYERED_PANE:
  70 @ATK_ROLE_LIST:
  71 @ATK_ROLE_LIST_ITEM:
  72 @ATK_ROLE_MENU:
  73 @ATK_ROLE_MENU_BAR:
  74 @ATK_ROLE_MENU_ITEM:
  75 @ATK_ROLE_OPTION_PANE:
  76 @ATK_ROLE_PAGE_TAB:
  77 @ATK_ROLE_PAGE_TAB_LIST:
  78 @ATK_ROLE_PANEL:
  79 @ATK_ROLE_PASSWORD_TEXT:
  80 @ATK_ROLE_POPUP_MENU:
  81 @ATK_ROLE_PROGRESS_BAR:
  82 @ATK_ROLE_PUSH_BUTTON:
  83 @ATK_ROLE_RADIO_BUTTON:
  84 @ATK_ROLE_RADIO_MENU_ITEM:
  85 @ATK_ROLE_ROOT_PANE:
  86 @ATK_ROLE_ROW_HEADER:
  87 @ATK_ROLE_SCROLL_BAR:
  88 @ATK_ROLE_SCROLL_PANE:
  89 @ATK_ROLE_SEPARATOR:
  90 @ATK_ROLE_SLIDER:
  91 @ATK_ROLE_SPLIT_PANE:
  92 @ATK_ROLE_SPIN_BUTTON:
  93 @ATK_ROLE_STATUSBAR:
  94 @ATK_ROLE_TABLE:
  95 @ATK_ROLE_TABLE_CELL:
  96 @ATK_ROLE_TABLE_COLUMN_HEADER:
  97 @ATK_ROLE_TABLE_ROW_HEADER:
  98 @ATK_ROLE_TEAR_OFF_MENU_ITEM:
  99 @ATK_ROLE_TERMINAL:
 100 @ATK_ROLE_TEXT:
 101 @ATK_ROLE_TOGGLE_BUTTON:
 102 @ATK_ROLE_TOOL_BAR:
 103 @ATK_ROLE_TOOL_TIP:
 104 @ATK_ROLE_TREE:
 105 @ATK_ROLE_TREE_TABLE:
 106 @ATK_ROLE_UNKNOWN:
 107 @ATK_ROLE_VIEWPORT:
 108 @ATK_ROLE_WINDOW:
 109 @ATK_ROLE_LAST_DEFINED:
 110
 111 <!-- ##### FUNCTION atk_role_register ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @name:
 117 @Returns:
 118
 119
 120 <!-- ##### ENUM AtkLayer ##### -->
 121 <para>
 122
 123 </para>
 124
 125 @ATK_LAYER_INVALID:
 126 @ATK_LAYER_BACKGROUND:
 127 @ATK_LAYER_CANVAS:
 128 @ATK_LAYER_WIDGET:
 129 @ATK_LAYER_MDI:
 130 @ATK_LAYER_POPUP:
 131 @ATK_LAYER_OVERLAY:
 132
 133 <!-- ##### STRUCT AtkImplementor ##### -->
 134 <para>
 135
 136 </para>
 137
 138
 139 <!-- ##### STRUCT AtkImplementorIface ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @parent:
 145 @ref_accessible:
 146
 147 <!-- ##### STRUCT AtkRelationSet ##### -->
 148 <para>
 149
 150 </para>
 151
 152 @parent:
 153 @relations:
 154
 155 <!-- ##### STRUCT AtkPropertyValues ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @property_name:
 161 @old_value:
 162 @new_value:
 163
 164 <!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @Param1:
 170 @Param2:
 171
 172
 173 <!-- ##### FUNCTION atk_implementor_ref_accessible ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @implementor:
 179 @Returns:
 180
 181
 182 <!-- ##### FUNCTION atk_object_get_name ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @accessible:
 188 @Returns:
 189
 190
 191 <!-- ##### FUNCTION atk_object_get_description ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @accessible:
 197 @Returns:
 198
 199
 200 <!-- ##### FUNCTION atk_object_get_parent ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @accessible:
 206 @Returns:
 207
 208
 209 <!-- ##### FUNCTION atk_object_get_n_accessible_children ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @accessible:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION atk_object_ref_accessible_child ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @accessible:
 224 @i:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION atk_object_ref_relation_set ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @accessible:
 234 @Returns:
 235
 236
 237 <!-- ##### FUNCTION atk_object_get_layer ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @accessible:
 243 @Returns:
 244
 245
 246 <!-- ##### FUNCTION atk_object_get_mdi_zorder ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @accessible:
 252 @Returns:
 253 <!-- # Unused Parameters # -->
 254 @acessible:
 255
 256
 257 <!-- ##### FUNCTION atk_object_get_role ##### -->
 258 <para>
 259
 260 </para>
 261
 262 @accessible:
 263 @Returns:
 264
 265
 266 <!-- ##### FUNCTION atk_object_ref_state_set ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @accessible:
 272 @Returns:
 273
 274
 275 <!-- ##### FUNCTION atk_object_get_index_in_parent ##### -->
 276 <para>
 277
 278 </para>
 279
 280 @accessible:
 281 @Returns:
 282
 283
 284 <!-- ##### FUNCTION atk_object_set_name ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @accessible:
 290 @name:
 291
 292
 293 <!-- ##### FUNCTION atk_object_set_description ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @accessible:
 299 @description:
 300
 301
 302 <!-- ##### FUNCTION atk_object_set_parent ##### -->
 303 <para>
 304
 305 </para>
 306
 307 @accessible:
 308 @parent:
 309
 310
 311 <!-- ##### FUNCTION atk_object_set_role ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @accessible:
 317 @role:
 318
 319
 320 <!-- ##### FUNCTION atk_object_connect_property_change_handler ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @accessible:
 326 @handler:
 327 @Returns:
 328
 329
 330 <!-- ##### FUNCTION atk_object_remove_property_change_handler ##### -->
 331 <para>
 332
 333 </para>
 334
 335 @accessible:
 336 @handler_id:
 337
 338
 339 <!-- ##### FUNCTION atk_object_notify_state_change ##### -->
 340 <para>
 341
 342 </para>
 343
 344 @accessible:
 345 @state:
 346 @value:
 347
 348