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