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