summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_label_eo.legacy.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_label_eo.legacy.h')
-rw-r--r--src/lib/elementary/elm_label_eo.legacy.h243
1 files changed, 243 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_label_eo.legacy.h b/src/lib/elementary/elm_label_eo.legacy.h
new file mode 100644
index 0000000..126207a
--- /dev/null
+++ b/src/lib/elementary/elm_label_eo.legacy.h
@@ -0,0 +1,243 @@
1#ifndef _ELM_LABEL_EO_LEGACY_H_
2#define _ELM_LABEL_EO_LEGACY_H_
3
4#ifndef _ELM_LABEL_EO_CLASS_TYPE
5#define _ELM_LABEL_EO_CLASS_TYPE
6
7typedef Eo Elm_Label;
8
9#endif
10
11#ifndef _ELM_LABEL_EO_TYPES
12#define _ELM_LABEL_EO_TYPES
13
14/** Slide mode of a label widget
15 *
16 * @ingroup Elm_Label
17 */
18typedef enum
19{
20 ELM_LABEL_SLIDE_MODE_NONE = 0, /**< No slide effect. */
21 ELM_LABEL_SLIDE_MODE_AUTO, /**< Slide only if the label area is bigger than
22 * the text width length. */
23 ELM_LABEL_SLIDE_MODE_ALWAYS /**< Slide always. */
24} Elm_Label_Slide_Mode;
25
26
27#endif
28
29/**
30 * @brief Control wrap width of the label
31 *
32 * This function sets the maximum width size hint of the label.
33 *
34 * @warning This is only relevant if the label is inside a container.
35 *
36 * @param[in] obj The object.
37 * @param[in] w The wrap width in pixels at a minimum where words need to wrap
38 *
39 * @ingroup Elm_Label_Group
40 */
41EAPI void elm_label_wrap_width_set(Elm_Label *obj, int w);
42
43/**
44 * @brief Control wrap width of the label
45 *
46 * This function sets the maximum width size hint of the label.
47 *
48 * @warning This is only relevant if the label is inside a container.
49 *
50 * @param[in] obj The object.
51 *
52 * @return The wrap width in pixels at a minimum where words need to wrap
53 *
54 * @ingroup Elm_Label_Group
55 */
56EAPI int elm_label_wrap_width_get(const Elm_Label *obj);
57
58/**
59 * @brief Control the slide speed of the label
60 *
61 * @note If you set the duration of the slide using
62 * @ref elm_label_slide_duration_set you cannot get the correct speed using
63 * this function until the label is actually rendered and resized.
64 *
65 * See @ref elm_label_slide_duration_set
66 *
67 * @param[in] obj The object.
68 * @param[in] speed The speed of the slide animation in px per seconds
69 *
70 * @ingroup Elm_Label_Group
71 */
72EAPI void elm_label_slide_speed_set(Elm_Label *obj, double speed);
73
74/**
75 * @brief Control the slide speed of the label
76 *
77 * @note If you set the duration of the slide using
78 * @ref elm_label_slide_duration_set you cannot get the correct speed using
79 * this function until the label is actually rendered and resized.
80 *
81 * See @ref elm_label_slide_duration_set
82 *
83 * @param[in] obj The object.
84 *
85 * @return The speed of the slide animation in px per seconds
86 *
87 * @ingroup Elm_Label_Group
88 */
89EAPI double elm_label_slide_speed_get(const Elm_Label *obj);
90
91/**
92 * @brief Control the slide mode of the label widget.
93 *
94 * By default, slide mode is none. Possible values for @c mode are:
95 * @ref ELM_LABEL_SLIDE_MODE_NONE - no slide effect
96 * @ref ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than
97 * the text width length @ref ELM_LABEL_SLIDE_MODE_ALWAYS - slide always
98 *
99 * @warning @ref ELM_LABEL_SLIDE_MODE_AUTO, @ref ELM_LABEL_SLIDE_MODE_ALWAYS
100 * only work with the themes "slide_short", "slide_long" and "slide_bounce".
101 * Warning: @ref ELM_LABEL_SLIDE_MODE_AUTO, @ref ELM_LABEL_SLIDE_MODE_ALWAYS
102 * don't work if the line wrap(elm_label_line_wrap_set()) or
103 * ellipsis(elm_label_ellipsis_set()) is set.
104 *
105 * @param[in] obj The object.
106 * @param[in] mode The slide mode
107 *
108 * @since 1.8
109 *
110 * @ingroup Elm_Label_Group
111 */
112EAPI void elm_label_slide_mode_set(Elm_Label *obj, Elm_Label_Slide_Mode mode);
113
114/**
115 * @brief Control the slide mode of the label widget.
116 *
117 * By default, slide mode is none. Possible values for @c mode are:
118 * @ref ELM_LABEL_SLIDE_MODE_NONE - no slide effect
119 * @ref ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than
120 * the text width length @ref ELM_LABEL_SLIDE_MODE_ALWAYS - slide always
121 *
122 * @warning @ref ELM_LABEL_SLIDE_MODE_AUTO, @ref ELM_LABEL_SLIDE_MODE_ALWAYS
123 * only work with the themes "slide_short", "slide_long" and "slide_bounce".
124 * Warning: @ref ELM_LABEL_SLIDE_MODE_AUTO, @ref ELM_LABEL_SLIDE_MODE_ALWAYS
125 * don't work if the line wrap(elm_label_line_wrap_set()) or
126 * ellipsis(elm_label_ellipsis_set()) is set.
127 *
128 * @param[in] obj The object.
129 *
130 * @return The slide mode
131 *
132 * @since 1.8
133 *
134 * @ingroup Elm_Label_Group
135 */
136EAPI Elm_Label_Slide_Mode elm_label_slide_mode_get(const Elm_Label *obj);
137
138/**
139 * @brief Control the slide duration of the label
140 *
141 * @note If you set the speed of the slide using @ref elm_label_slide_speed_set
142 * you cannot get the correct duration using this function until the label is
143 * actually rendered and resized.
144 *
145 * @param[in] obj The object.
146 * @param[in] duration The duration in seconds in moving text from slide begin
147 * position to slide end position
148 *
149 * @ingroup Elm_Label_Group
150 */
151EAPI void elm_label_slide_duration_set(Elm_Label *obj, double duration);
152
153/**
154 * @brief Control the slide duration of the label
155 *
156 * @note If you set the speed of the slide using @ref elm_label_slide_speed_set
157 * you cannot get the correct duration using this function until the label is
158 * actually rendered and resized.
159 *
160 * @param[in] obj The object.
161 *
162 * @return The duration in seconds in moving text from slide begin position to
163 * slide end position
164 *
165 * @ingroup Elm_Label_Group
166 */
167EAPI double elm_label_slide_duration_get(const Elm_Label *obj);
168
169/**
170 * @brief Control the wrapping behavior of the label
171 *
172 * By default no wrapping is done. Possible values for @c wrap are:
173 * @c ELM_WRAP_NONE - No wrapping @c ELM_WRAP_CHAR - wrap between characters
174 * @c ELM_WRAP_WORD - wrap between words @c ELM_WRAP_MIXED - Word wrap, and if
175 * that fails, char wrap
176 *
177 * @param[in] obj The object.
178 * @param[in] wrap To wrap text or not
179 *
180 * @ingroup Elm_Label_Group
181 */
182EAPI void elm_label_line_wrap_set(Elm_Label *obj, Elm_Wrap_Type wrap);
183
184/**
185 * @brief Control the wrapping behavior of the label
186 *
187 * By default no wrapping is done. Possible values for @c wrap are:
188 * @c ELM_WRAP_NONE - No wrapping @c ELM_WRAP_CHAR - wrap between characters
189 * @c ELM_WRAP_WORD - wrap between words @c ELM_WRAP_MIXED - Word wrap, and if
190 * that fails, char wrap
191 *
192 * @param[in] obj The object.
193 *
194 * @return To wrap text or not
195 *
196 * @ingroup Elm_Label_Group
197 */
198EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Elm_Label *obj);
199
200/**
201 * @brief Control the ellipsis behavior of the label
202 *
203 * If set to true and the text doesn't fit in the label an ellipsis("...") will
204 * be shown at the end of the widget.
205 *
206 * Warning This doesn't work with slide(elm_label_slide_set()) or if the chosen
207 * wrap method was @c ELM_WRAP_WORD.
208 *
209 * @param[in] obj The object.
210 * @param[in] ellipsis To ellipsis text or not
211 *
212 * @ingroup Elm_Label_Group
213 */
214EAPI void elm_label_ellipsis_set(Elm_Label *obj, Eina_Bool ellipsis);
215
216/**
217 * @brief Control the ellipsis behavior of the label
218 *
219 * If set to true and the text doesn't fit in the label an ellipsis("...") will
220 * be shown at the end of the widget.
221 *
222 * Warning This doesn't work with slide(elm_label_slide_set()) or if the chosen
223 * wrap method was @c ELM_WRAP_WORD.
224 *
225 * @param[in] obj The object.
226 *
227 * @return To ellipsis text or not
228 *
229 * @ingroup Elm_Label_Group
230 */
231EAPI Eina_Bool elm_label_ellipsis_get(const Elm_Label *obj);
232
233/**
234 * @brief Start slide effect.
235 *
236 * See @ref elm_label_slide_mode_set.
237 * @param[in] obj The object.
238 *
239 * @ingroup Elm_Label_Group
240 */
241EAPI void elm_label_slide_go(Elm_Label *obj);
242
243#endif