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_UNKNOWN:
  93 @ATK_ROLE_VIEWPORT:
  94 @ATK_ROLE_WINDOW:
  95 @ATK_ROLE_LAST_DEFINED:
  96
  97 <!-- ##### FUNCTION atk_role_register ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @name:
 103 @Returns:
 104
 105
 106 <!-- ##### STRUCT AtkImplementor ##### -->
 107 <para>
 108
 109 </para>
 110
 111
 112 <!-- ##### STRUCT AtkImplementorIface ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @parent:
 118 @ref_accessible:
 119
 120 <!-- ##### STRUCT AtkRelationSet ##### -->
 121 <para>
 122
 123 </para>
 124
 125 @parent:
 126 @relations:
 127
 128 <!-- ##### STRUCT AtkPropertyValues ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @property_name:
 134 @old_value:
 135 @new_value:
 136
 137 <!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @Param1:
 143 @Param2:
 144
 145
 146 <!-- ##### FUNCTION atk_implementor_ref_accessible ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @implementor:
 152 @Returns:
 153
 154
 155 <!-- ##### FUNCTION atk_object_get_name ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @accessible:
 161 @Returns:
 162
 163
 164 <!-- ##### FUNCTION atk_object_get_description ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @accessible:
 170 @Returns:
 171
 172
 173 <!-- ##### FUNCTION atk_object_get_parent ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @accessible:
 179 @Returns:
 180
 181
 182 <!-- ##### FUNCTION atk_object_get_n_accessible_children ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @accessible:
 188 @Returns:
 189
 190
 191 <!-- ##### FUNCTION atk_object_ref_accessible_child ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @accessible:
 197 @i:
 198 @Returns:
 199
 200
 201 <!-- ##### FUNCTION atk_object_ref_relation_set ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @accessible:
 207 @Returns:
 208
 209
 210 <!-- ##### FUNCTION atk_object_get_role ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @accessible:
 216 @Returns:
 217
 218
 219 <!-- ##### FUNCTION atk_object_ref_state_set ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @accessible:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION atk_object_get_index_in_parent ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @accessible:
 234 @Returns:
 235
 236
 237 <!-- ##### FUNCTION atk_object_set_name ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @accessible:
 243 @name:
 244
 245
 246 <!-- ##### FUNCTION atk_object_set_description ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @accessible:
 252 @description:
 253
 254
 255 <!-- ##### FUNCTION atk_object_set_parent ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @accessible:
 261 @parent:
 262
 263
 264 <!-- ##### FUNCTION atk_object_set_role ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @accessible:
 270 @role:
 271
 272
 273 <!-- ##### FUNCTION atk_object_connect_property_change_handler ##### -->
 274 <para>
 275
 276 </para>
 277
 278 @accessible:
 279 @handler:
 280 @Returns:
 281
 282
 283 <!-- ##### FUNCTION atk_object_remove_property_change_handler ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @accessible:
 289 @handler_id:
 290
 291
 292 <!-- ##### FUNCTION atk_object_notify_state_change ##### -->
 293 <para>
 294
 295 </para>
 296
 297 @accessible:
 298 @state:
 299 @value:
 300
 301