docs/tmpl/atkobject.sgml

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