9e4ba719fc66d58302cdc3676f8b1de9bdf1bf48
[platform/upstream/atk.git] / 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 <!-- ##### ENUM AtkStateType ##### -->
19 <para>
20
21 </para>
22
23 @ATK_STATE_INVALID: 
24 @ATK_STATE_ACTIVE: 
25 @ATK_STATE_ARMED: 
26 @ATK_STATE_BUSY: 
27 @ATK_STATE_CHECKED: 
28 @ATK_STATE_DEFUNCT: 
29 @ATK_STATE_EDITABLE: 
30 @ATK_STATE_ENABLED: 
31 @ATK_STATE_EXPANDABLE: 
32 @ATK_STATE_EXPANDED: 
33 @ATK_STATE_FOCUSABLE: 
34 @ATK_STATE_FOCUSED: 
35 @ATK_STATE_HORIZONTAL: 
36 @ATK_STATE_ICONIFIED: 
37 @ATK_STATE_MODAL: 
38 @ATK_STATE_MULTI_LINE: 
39 @ATK_STATE_MULTISELECTABLE: 
40 @ATK_STATE_OPAQUE: 
41 @ATK_STATE_PRESSED: 
42 @ATK_STATE_RESIZABLE: 
43 @ATK_STATE_SELECTABLE: 
44 @ATK_STATE_SELECTED: 
45 @ATK_STATE_SENSITIVE: 
46 @ATK_STATE_SHOWING: 
47 @ATK_STATE_SINGLE_LINE: 
48 @ATK_STATE_STALE: 
49 @ATK_STATE_TRANSIENT: 
50 @ATK_STATE_VERTICAL: 
51 @ATK_STATE_VISIBLE: 
52 @ATK_STATE_MANAGES_DESCENDANTS: 
53 @ATK_STATE_INDETERMINATE: 
54 @ATK_STATE_TRUNCATED: 
55 @ATK_STATE_LAST_DEFINED: 
56
57 <!-- ##### TYPEDEF AtkState ##### -->
58 <para>
59 The AtkState value should not be referenceed directly.
60
61 </para>
62
63
64 <!-- ##### FUNCTION atk_state_type_register ##### -->
65 <para>
66
67 </para>
68
69 @name: 
70 @Returns: 
71
72
73 <!-- ##### FUNCTION atk_state_type_get_name ##### -->
74 <para>
75
76 </para>
77
78 @type: 
79 @Returns: 
80
81
82 <!-- ##### FUNCTION atk_state_type_for_name ##### -->
83 <para>
84
85 </para>
86
87 @name: 
88 @Returns: 
89
90