Documentation fixes for ref/unref methods that no longer return ints.
[platform/core/uifw/at-spi2-atk.git] / cspi / spi_value.c
1 #include <cspi/spi-private.h>
2
3 /**
4  * AccessibleValue_ref:
5  * @obj: a pointer to the #AccessibleValue implementor on which to operate.
6  *
7  * Increment the reference count for an #AccessibleValue object.
8  *
9  **/
10 void
11 AccessibleValue_ref (AccessibleValue *obj)
12 {
13   cspi_object_ref (obj);
14 }
15
16 /**
17  * AccessibleValue_unref:
18  * @obj: a pointer to the #AccessibleValue implementor on which to operate. 
19  *
20  * Decrement the reference count for an #AccessibleValue object.
21  *
22  **/
23 void
24 AccessibleValue_unref (AccessibleValue *obj)
25 {
26   cspi_object_unref (obj);
27 }
28
29 /**
30  * AccessibleValue_getMinimumValue:
31  * @obj: a pointer to the #AccessibleValue implementor on which to operate. 
32  *
33  * Get the minimum allowed value for an #AccessibleValue.
34  *
35  * Returns: the minimum allowed value for this object.
36  *
37  **/
38 float
39 AccessibleValue_getMinimumValue (AccessibleValue *obj)
40 {
41   return (float)
42     Accessibility_Value__get_minimumValue (CSPI_OBJREF (obj), cspi_ev ());
43 }
44
45
46
47 /**
48  * AccessibleValue_getCurrentValue:
49  * @obj: a pointer to the #AccessibleValue implementor on which to operate. 
50  *
51  * Get the current value for an #AccessibleValue.
52  *
53  * Returns: the current value for this object.
54  *
55  **/
56 float
57 AccessibleValue_getCurrentValue (AccessibleValue *obj)
58 {
59   return (float)
60     Accessibility_Value__get_currentValue (CSPI_OBJREF (obj), cspi_ev ());
61 }
62
63
64
65 /**
66  * AccessibleValue_getMaximumValue:
67  * @obj: a pointer to the #AccessibleValue implementor on which to operate. 
68  *
69  * Get the maximum allowed value for an #AccessibleValue.
70  *
71  * Returns: the maximum allowed value for this object.
72  *
73  **/
74 float
75 AccessibleValue_getMaximumValue (AccessibleValue *obj)
76 {
77   return (float)
78     Accessibility_Value__get_maximumValue (CSPI_OBJREF (obj), cspi_ev ());
79 }
80
81
82
83 /**
84  * AccessibleValue_setCurrentValue:
85  * @obj: a pointer to the #AccessibleValue implementor on which to operate.
86  * @newValue: a #float value which is the desired new value of the object.
87  *
88  * Set the current value of an #AccessibleValue.
89  *
90  * Returns: #TRUE if the value could be assigned the specified value,
91  *          #FALSE otherwise.
92  *
93  **/
94 SPIBoolean
95 AccessibleValue_setCurrentValue (AccessibleValue *obj,
96                                  float newValue)
97 {
98   Accessibility_Value__set_currentValue (CSPI_OBJREF (obj),
99                                          (CORBA_float) newValue, cspi_ev ());
100   return TRUE;
101 }
102
103