Added ATK_STATE_STALE. Updated docs.
[platform/upstream/atk.git] / docs / tmpl / atkstate.sgml
1 <!-- ##### SECTION Title ##### -->
2 AtkState
3
4 <!-- ##### SECTION Short_Description ##### -->
5 describes an objects particular state
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 AtkState describes an objects particular state. The actual state of the 
10 object is defined as an #AtkStateSet, which is a composed set of 
11 AtkStates.
12 </para>
13
14 <!-- ##### SECTION See_Also ##### -->
15 <para>
16
17 </para>
18
19 <!-- ##### ENUM AtkStateType ##### -->
20 <para>
21
22 </para>
23
24 @ATK_STATE_INVALID: 
25 @ATK_STATE_ACTIVE: 
26 @ATK_STATE_ARMED: 
27 @ATK_STATE_BUSY: 
28 @ATK_STATE_CHECKED: 
29 @ATK_STATE_COLLAPSED: 
30 @ATK_STATE_DEFUNCT: 
31 @ATK_STATE_EDITABLE: 
32 @ATK_STATE_EXPANDABLE: 
33 @ATK_STATE_EXPANDED: 
34 @ATK_STATE_FOCUSABLE: 
35 @ATK_STATE_FOCUSED: 
36 @ATK_STATE_HORIZONTAL: 
37 @ATK_STATE_ICONIFIED: 
38 @ATK_STATE_MODAL: 
39 @ATK_STATE_MULTI_LINE: 
40 @ATK_STATE_MULTISELECTABLE: 
41 @ATK_STATE_OPAQUE: 
42 @ATK_STATE_PRESSED: 
43 @ATK_STATE_RESIZABLE: 
44 @ATK_STATE_SELECTABLE: 
45 @ATK_STATE_SELECTED: 
46 @ATK_STATE_SENSITIVE: 
47 @ATK_STATE_SHOWING: 
48 @ATK_STATE_SINGLE_LINE: 
49 @ATK_STATE_STALE: 
50 @ATK_STATE_TRANSIENT: 
51 @ATK_STATE_VERTICAL: 
52 @ATK_STATE_VISIBLE: 
53 @ATK_STATE_LAST_DEFINED: 
54
55 <!-- ##### TYPEDEF AtkState ##### -->
56 <para>
57
58 </para>
59
60
61 <!-- ##### FUNCTION atk_state_type_register ##### -->
62 <para>
63
64 </para>
65
66 @name: 
67 @Returns: 
68
69
70 <!-- ##### FUNCTION atk_state_type_get_name ##### -->
71 <para>
72
73 </para>
74
75 @type: 
76 @Returns: 
77
78
79 <!-- ##### FUNCTION atk_state_type_for_name ##### -->
80 <para>
81
82 </para>
83
84 @name: 
85 @Returns: 
86
87