summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_flipselector_eo.legacy.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_flipselector_eo.legacy.h')
-rw-r--r--src/lib/elementary/elm_flipselector_eo.legacy.h189
1 files changed, 189 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_flipselector_eo.legacy.h b/src/lib/elementary/elm_flipselector_eo.legacy.h
new file mode 100644
index 0000000..707d7a3
--- /dev/null
+++ b/src/lib/elementary/elm_flipselector_eo.legacy.h
@@ -0,0 +1,189 @@
1#ifndef _ELM_FLIPSELECTOR_EO_LEGACY_H_
2#define _ELM_FLIPSELECTOR_EO_LEGACY_H_
3
4#ifndef _ELM_FLIPSELECTOR_EO_CLASS_TYPE
5#define _ELM_FLIPSELECTOR_EO_CLASS_TYPE
6
7typedef Eo Elm_Flipselector;
8
9#endif
10
11#ifndef _ELM_FLIPSELECTOR_EO_TYPES
12#define _ELM_FLIPSELECTOR_EO_TYPES
13
14
15#endif
16
17/**
18 * @brief Get the internal list of items in a given flip selector widget.
19 *
20 * This list is not to be modified in any way and must not be freed. Use the
21 * list members with functions like @ref elm_object_item_text_set, @ref
22 * elm_object_item_text_get, @ref elm_object_item_del, @ref
23 * elm_flipselector_item_selected_get, @ref elm_flipselector_item_selected_set.
24 *
25 * @warning This list is only valid until @c obj object's internal items list
26 * is changed. It should be fetched again with another call to this function
27 * when changes happen.
28 *
29 * @param[in] obj The object.
30 *
31 * @return List of items
32 *
33 * @ingroup Elm_Flipselector_Group
34 */
35EAPI const Eina_List *elm_flipselector_items_get(const Elm_Flipselector *obj);
36
37/**
38 * @brief Get the first item in the given flip selector widget's list of items.
39 *
40 * See also @ref elm_flipselector_item_append,
41 * @ref elm_flipselector_last_item_get.
42 *
43 * @param[in] obj The object.
44 *
45 * @return The first item or @c null, if it has no items (and on errors).
46 *
47 * @ingroup Elm_Flipselector_Group
48 */
49EAPI Elm_Widget_Item *elm_flipselector_first_item_get(const Elm_Flipselector *obj);
50
51/**
52 * @brief Get the last item in the given flip selector widget's list of items.
53 *
54 * See also @ref elm_flipselector_item_prepend,
55 * @ref elm_flipselector_first_item_get.
56 *
57 * @param[in] obj The object.
58 *
59 * @return The last item or @c null, if it has no items (and on errors).
60 *
61 * @ingroup Elm_Flipselector_Group
62 */
63EAPI Elm_Widget_Item *elm_flipselector_last_item_get(const Elm_Flipselector *obj);
64
65/**
66 * @brief Get the currently selected item in a flip selector widget.
67 *
68 * @param[in] obj The object.
69 *
70 * @return The selected item or @c null, if the widget has no items (and on
71 * errors).
72 *
73 * @ingroup Elm_Flipselector_Group
74 */
75EAPI Elm_Widget_Item *elm_flipselector_selected_item_get(const Elm_Flipselector *obj);
76
77/**
78 * @brief Set the interval on time updates for a user mouse button hold on a
79 * flip selector widget.
80 *
81 * This interval value is decreased while the user holds the mouse pointer
82 * either flipping up or flipping down a given flip selector.
83 *
84 * This helps the user to get to a given item distant from the current one
85 * easier/faster, as it will start to flip quicker and quicker on mouse button
86 * holds.
87 *
88 * The calculation for the next flip interval value, starting from the one set
89 * with this call, is the previous interval divided by 1.05, so it decreases a
90 * little bit.
91 *
92 * The default starting interval value for automatic flips is 0.85 seconds.
93 *
94 * See also @ref elm_flipselector_first_interval_get.
95 *
96 * @param[in] obj The object.
97 * @param[in] interval The (first) interval value in seconds.
98 *
99 * @ingroup Elm_Flipselector_Group
100 */
101EAPI void elm_flipselector_first_interval_set(Elm_Flipselector *obj, double interval);
102
103/**
104 * @brief Get the interval on time updates for an user mouse button hold on a
105 * flip selector widget.
106 *
107 * See also @ref elm_flipselector_first_interval_set for more details.
108 *
109 * @param[in] obj The object.
110 *
111 * @return The (first) interval value in seconds.
112 *
113 * @ingroup Elm_Flipselector_Group
114 */
115EAPI double elm_flipselector_first_interval_get(const Elm_Flipselector *obj);
116
117/**
118 * @brief Prepend a (text) item to a flip selector widget
119 *
120 * The widget's list of labels to show will be prepended with the given value.
121 * If the user wishes so, a callback function pointer can be passed, which will
122 * get called when this same item is selected.
123 *
124 * @note The current selection won't be modified by prepending an element to
125 * the list.
126 *
127 * @note The maximum length of the text label is going to be determined by the
128 * widget's theme. Strings larger than that value are going to be truncated.
129 *
130 * @param[in] obj The object.
131 * @param[in] label The (text) label of the new item.
132 * @param[in] func Convenience callback function to take place when item is
133 * selected.
134 * @param[in] data Data passed to @c func, above.
135 *
136 * @return New widget item
137 *
138 * @ingroup Elm_Flipselector_Group
139 */
140EAPI Elm_Widget_Item *elm_flipselector_item_prepend(Elm_Flipselector *obj, const char *label, Evas_Smart_Cb func, void *data);
141
142/**
143 * @brief Programmatically select the next item of a flip selector widget
144 *
145 * @note The selection will be animated. Also, if it reaches the end of its
146 * list of member items, it will continue with the first one onwards.
147 * @param[in] obj The object.
148 *
149 * @ingroup Elm_Flipselector_Group
150 */
151EAPI void elm_flipselector_flip_next(Elm_Flipselector *obj);
152
153/**
154 * @brief Append a (text) item to a flip selector widget
155 *
156 * The widget's list of labels to show will be appended with the given value.
157 * If the user wishes so, a callback function pointer can be passed, which will
158 * get called when this same item is selected.
159 *
160 * @note The current selection won't be modified by appending an element to the
161 * list.
162 *
163 * @note The maximum length of the text label is going to be determined by the
164 * widget's theme. Strings larger than that value are going to be truncated.
165 *
166 * @param[in] obj The object.
167 * @param[in] label The (text) label of the new item.
168 * @param[in] func Convenience callback function to take place when item is
169 * selected.
170 * @param[in] data Data passed to @c func, above.
171 *
172 * @return New widget item
173 *
174 * @ingroup Elm_Flipselector_Group
175 */
176EAPI Elm_Widget_Item *elm_flipselector_item_append(Elm_Flipselector *obj, const char *label, Evas_Smart_Cb func, const void *data);
177
178/**
179 * @brief Programmatically select the previous item of a flip selector widget
180 *
181 * @note The selection will be animated. Also, if it reaches the beginning of
182 * its list of member items, it will continue with the last one backwards.
183 * @param[in] obj The object.
184 *
185 * @ingroup Elm_Flipselector_Group
186 */
187EAPI void elm_flipselector_flip_prev(Elm_Flipselector *obj);
188
189#endif