docs/tmpl/atkobject.sgml

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