summaryrefslogtreecommitdiff
path: root/docs/tmpl/atkvalue.sgml
blob: 58c1ca6e0d6afbd383f99020ce569ca01f739b96 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<!-- ##### SECTION Title ##### -->
AtkValue

<!-- ##### SECTION Short_Description ##### -->
The ATK interface implemented by valuators and components which display or
select a value from a bounded range of values.

<!-- ##### SECTION Long_Description ##### -->
<para>
#AtkValue should be implemented for components which either display a
value from a bounded range, or which allow the user to specify a value
from a bounded range, or both.  For instance, most sliders and range
controls, as well as dials, should have #AtkObject representations which
implement #AtkValue on the component's behalf.  #AtKValues may be
read-only, in which case attempts to alter the value return FALSE to
indicate failure.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT AtkValue ##### -->
<para>
The AtkValue structure does not contain any fields.

</para>


<!-- ##### FUNCTION atk_value_get_current_value ##### -->
<para>

</para>

@obj: 
@value: 


<!-- ##### FUNCTION atk_value_get_maximum_value ##### -->
<para>

</para>

@obj: 
@value: 


<!-- ##### FUNCTION atk_value_get_minimum_value ##### -->
<para>

</para>

@obj: 
@value: 


<!-- ##### FUNCTION atk_value_set_current_value ##### -->
<para>

</para>

@obj: 
@value: 
@Returns: 


<!-- ##### FUNCTION atk_value_get_minimum_increment ##### -->
<para>

</para>

@obj: 
@value: