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