1 /**
2  * Add a new spinner widget to the given parent Elementary
3  * (container) object.
4  *
5  * @param parent The parent object.
6  * @return a new spinner widget handle or @c NULL, on errors.
7  *
8  * This function inserts a new spinner widget on the canvas.
9  *
10  * @ingroup Elm_Spinner_Group
11  *
12  */
13 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent);
14 
15 /**
16  * Delete the special string display in the place of the numerical value.
17  *
18  * @param obj The spinner object.
19  * @param value The replaced value.
20  *
21  * It will remove a previously added special value. After this, the spinner
22  * will display the value itself instead of a label.
23  *
24  * @see elm_spinner_special_value_add() for more details.
25  *
26  * @ingroup Elm_Spinner_Group
27  * @since 1.8
28  */
29 EAPI void elm_spinner_special_value_del(Evas_Object *obj, double value);
30 
31 /**
32  * Get the special string display in the place of the numerical value.
33  *
34  * @param obj The spinner object.
35  * @param value The replaced value.
36  * @return The used label.
37  *
38  * @see elm_spinner_special_value_add() for more details.
39  *
40  * @ingroup Elm_Spinner_Group
41  * @since 1.8
42  */
43 EAPI const char *elm_spinner_special_value_get(Evas_Object *obj, double value);
44 
45 /**
46  * @brief Control the minimum and maximum values for the spinner.
47  *
48  * Define the allowed range of values to be selected by the user.
49  *
50  * If actual value is less than @c min, it will be updated to @c min. If it is
51  * bigger then @c max, will be updated to @c max. Actual value can be get with
52  * @ref elm_obj_spinner_value_get.
53  *
54  * By default, min is equal to 0, and max is equal to 100.
55  *
56  * @warning Maximum must be greater than minimum.
57  *
58  * @param[in] min The minimum value.
59  * @param[in] max The maximum value.
60  *
61  * @ingroup Elm_Spinner_Group
62  */
63 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max);
64 
65 /**
66  * @brief Control the minimum and maximum values for the spinner.
67  *
68  * Define the allowed range of values to be selected by the user.
69  *
70  * If actual value is less than @c min, it will be updated to @c min. If it is
71  * bigger then @c max, will be updated to @c max. Actual value can be get with
72  * @ref elm_obj_spinner_value_get.
73  *
74  * By default, min is equal to 0, and max is equal to 100.
75  *
76  * @warning Maximum must be greater than minimum.
77  *
78  * @param[out] min The minimum value.
79  * @param[out] max The maximum value.
80  *
81  * @ingroup Elm_Spinner_Group
82  */
83 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max);
84 
85 /**
86  * @brief Control the step used to increment or decrement the spinner value.
87  *
88  * This value will be incremented or decremented to the displayed value. It
89  * will be incremented while the user keep right or top arrow pressed, and will
90  * be decremented while the user keep left or bottom arrow pressed.
91  *
92  * The interval to increment / decrement can be set with
93  * @ref elm_obj_spinner_interval_set.
94  *
95  * By default step value is equal to 1.
96  *
97  * @param[in] step The step value.
98  *
99  * @ingroup Elm_Spinner_Group
100  */
101 EAPI void elm_spinner_step_set(Evas_Object *obj, double step);
102 
103 /**
104  * @brief Control the step used to increment or decrement the spinner value.
105  *
106  * This value will be incremented or decremented to the displayed value. It
107  * will be incremented while the user keep right or top arrow pressed, and will
108  * be decremented while the user keep left or bottom arrow pressed.
109  *
110  * The interval to increment / decrement can be set with
111  * @ref elm_obj_spinner_interval_set.
112  *
113  * By default step value is equal to 1.
114  *
115  * @return The step value.
116  *
117  * @ingroup Elm_Spinner_Group
118  */
119 EAPI double elm_spinner_step_get(const Evas_Object *obj);
120 
121 /**
122  * @brief Control the value the spinner displays.
123  *
124  * Value will be presented on the label following format specified with
125  * elm_spinner_format_set().
126  *
127  * Warning The value must to be between min and max values. This values are set
128  * by elm_spinner_min_max_set().
129  *
130  * @param[in] val The value to be displayed.
131  *
132  * @ingroup Elm_Spinner_Group
133  */
134 EAPI void elm_spinner_value_set(Evas_Object *obj, double val);
135 
136 /**
137  * @brief Control the value the spinner displays.
138  *
139  * Value will be presented on the label following format specified with
140  * elm_spinner_format_set().
141  *
142  * Warning The value must to be between min and max values. This values are set
143  * by elm_spinner_min_max_set().
144  *
145  * @return The value to be displayed.
146  *
147  * @ingroup Elm_Spinner_Group
148  */
149 EAPI double elm_spinner_value_get(const Evas_Object *obj);
150 
151 #include "elm_spinner_eo.legacy.h"
152