docs/tmpl/atkstate.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 AtkState
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 An AtkState describes a component's particular state.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 An AtkState describes a component's particular state. The actual state of
  10 an component is described by its AtkStateSet, which is a set of AtkStates.
  11 </para>
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15
  16 </para>
  17
  18 <!-- ##### SECTION Stability_Level ##### -->
  19
  20
  21 <!-- ##### ENUM AtkStateType ##### -->
  22 <para>
  23
  24 </para>
  25
  26 @ATK_STATE_INVALID:
  27 @ATK_STATE_ACTIVE:
  28 @ATK_STATE_ARMED:
  29 @ATK_STATE_BUSY:
  30 @ATK_STATE_CHECKED:
  31 @ATK_STATE_DEFUNCT:
  32 @ATK_STATE_EDITABLE:
  33 @ATK_STATE_ENABLED:
  34 @ATK_STATE_EXPANDABLE:
  35 @ATK_STATE_EXPANDED:
  36 @ATK_STATE_FOCUSABLE:
  37 @ATK_STATE_FOCUSED:
  38 @ATK_STATE_HORIZONTAL:
  39 @ATK_STATE_ICONIFIED:
  40 @ATK_STATE_MODAL:
  41 @ATK_STATE_MULTI_LINE:
  42 @ATK_STATE_MULTISELECTABLE:
  43 @ATK_STATE_OPAQUE:
  44 @ATK_STATE_PRESSED:
  45 @ATK_STATE_RESIZABLE:
  46 @ATK_STATE_SELECTABLE:
  47 @ATK_STATE_SELECTED:
  48 @ATK_STATE_SENSITIVE:
  49 @ATK_STATE_SHOWING:
  50 @ATK_STATE_SINGLE_LINE:
  51 @ATK_STATE_STALE:
  52 @ATK_STATE_TRANSIENT:
  53 @ATK_STATE_VERTICAL:
  54 @ATK_STATE_VISIBLE:
  55 @ATK_STATE_MANAGES_DESCENDANTS:
  56 @ATK_STATE_INDETERMINATE:
  57 @ATK_STATE_TRUNCATED:
  58 @ATK_STATE_REQUIRED:
  59 @ATK_STATE_INVALID_ENTRY:
  60 @ATK_STATE_SUPPORTS_AUTOCOMPLETION:
  61 @ATK_STATE_SELECTABLE_TEXT:
  62 @ATK_STATE_LAST_DEFINED:
  63
  64 <!-- ##### TYPEDEF AtkState ##### -->
  65 <para>
  66 The AtkState value should not be referenceed directly.
  67
  68 </para>
  69
  70
  71 <!-- ##### FUNCTION atk_state_type_register ##### -->
  72 <para>
  73
  74 </para>
  75
  76 @name:
  77 @Returns:
  78
  79
  80 <!-- ##### FUNCTION atk_state_type_get_name ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @type:
  86 @Returns:
  87
  88
  89 <!-- ##### FUNCTION atk_state_type_for_name ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @name:
  95 @Returns:
  96
  97