Added ATK_STATE_STALE. Updated docs.
[platform/upstream/atk.git] / docs / tmpl / atkselection.sgml
1 <!-- ##### SECTION Title ##### -->
2 atkselection
3
4 <!-- ##### SECTION Short_Description ##### -->
5 accessibility interface for determining what the current selected 
6 children are, as well as modify the selection set
7
8 <!-- ##### SECTION Long_Description ##### -->
9 <para>
10 This AtkSelection interface provides the standard mechanism for an 
11 assistive technology to determine what the current selected children are, 
12 as well as modify the selection set. Any object that has children that 
13 can be selected should support the AtkSelection interface.
14 </para>
15
16 <!-- ##### SECTION See_Also ##### -->
17 <para>
18
19 </para>
20
21 <!-- ##### STRUCT AtkSelection ##### -->
22 <para>
23
24 </para>
25
26
27 <!-- ##### STRUCT AtkSelectionIface ##### -->
28 <para>
29
30 </para>
31
32 @parent: 
33 @add_selection: 
34 @clear_selection: 
35 @ref_selection: 
36 @get_selection_count: 
37 @is_child_selected: 
38 @remove_selection: 
39 @select_all_selection: 
40
41 <!-- ##### FUNCTION atk_selection_add_selection ##### -->
42 <para>
43
44 </para>
45
46 @selection: 
47 @i: 
48 @Returns: 
49
50
51 <!-- ##### FUNCTION atk_selection_clear_selection ##### -->
52 <para>
53
54 </para>
55
56 @selection: 
57 @Returns: 
58
59
60 <!-- ##### FUNCTION atk_selection_ref_selection ##### -->
61 <para>
62
63 </para>
64
65 @selection: 
66 @i: 
67 @Returns: 
68
69
70 <!-- ##### FUNCTION atk_selection_get_selection_count ##### -->
71 <para>
72
73 </para>
74
75 @selection: 
76 @Returns: 
77
78
79 <!-- ##### FUNCTION atk_selection_is_child_selected ##### -->
80 <para>
81
82 </para>
83
84 @selection: 
85 @i: 
86 @Returns: 
87
88
89 <!-- ##### FUNCTION atk_selection_remove_selection ##### -->
90 <para>
91
92 </para>
93
94 @selection: 
95 @i: 
96 @Returns: 
97
98
99 <!-- ##### FUNCTION atk_selection_select_all_selection ##### -->
100 <para>
101
102 </para>
103
104 @selection: 
105
106