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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/**
* @defgroup Label Label
* @ingroup Elementary
*
* @image html img/widget/label/preview-00.png
* @image latex img/widget/label/preview-00.eps
*
* @brief Widget to display text, with simple html-like markup.
*
* The Label widget @b doesn't allow text to overflow its boundaries, if the
* text doesn't fit the geometry of the label it will be ellipsized or be
* cut. Elementary provides several styles for this widget:
* @li default - No animation
* @li marker - Centers the text in the label and makes it bold by default
* @li slide_long - The entire text appears from the right of the screen and
* slides until it disappears in the left of the screen(reappearing on the
* right again).
* @li slide_short - The text appears in the left of the label and slides to
* the right to show the overflow. When all of the text has been shown the
* position is reset.
* @li slide_bounce - The text appears in the left of the label and slides to
* the right to show the overflow. When all of the text has been shown the
* animation reverses, moving the text to the left.
*
* Custom themes can of course invent new markup tags and style them any way
* they like.
*
* The following signals may be emitted by the label widget:
* @li "language,changed": The program's language changed.
*
* See @ref tutorial_label for a demonstration of how to use a label widget.
* @{
*/
/**
* @brief Add a new label to the parent
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
* @ingroup Label
*/
EAPI Evas_Object *elm_label_add(Evas_Object *parent);
/**
* @brief Set the wrapping behavior of the label
*
* @param obj The label object
* @param wrap To wrap text or not
*
* By default no wrapping is done. Possible values for @p wrap are:
* @li ELM_WRAP_NONE - No wrapping
* @li ELM_WRAP_CHAR - wrap between characters
* @li ELM_WRAP_WORD - wrap between words
* @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
*
* @ingroup Label
*/
EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap);
/**
* @brief Get the wrapping behavior of the label
*
* @param obj The label object
* @return Wrap type
*
* @see elm_label_line_wrap_set()
*
* @ingroup Label
*/
EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj);
/**
* @brief Set wrap width of the label
*
* @param obj The label object
* @param w The wrap width in pixels at a minimum where words need to wrap
*
* This function sets the maximum width size hint of the label.
*
* @warning This is only relevant if the label is inside a container.
*
* @ingroup Label
*/
EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w);
/**
* @brief Get wrap width of the label
*
* @param obj The label object
* @return The wrap width in pixels at a minimum where words need to wrap
*
* @see elm_label_wrap_width_set()
*
* @ingroup Label
*/
EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj);
/**
* @brief Set the ellipsis behavior of the label
*
* @param obj The label object
* @param ellipsis To ellipsis text or not
*
* If set to true and the text doesn't fit in the label an ellipsis("...")
* will be shown at the end of the widget.
*
* @warning This doesn't work with slide(elm_label_slide_set()) or if the
* chosen wrap method was ELM_WRAP_WORD.
*
* @ingroup Label
*/
EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis);
/**
* @brief Get the ellipsis behavior of the label
*
* @param obj The label object
* @return If true, an ellipsis will be shown at the end of the label area.
*
* @see elm_label_ellipsis_set()
*
* @ingroup Label
*/
EAPI Eina_Bool elm_label_ellipsis_get(const Evas_Object *obj);
/**
* @brief Set sliding effect of label widget.
*
* @param obj The label object
* @param slide If true, sliding effect will be shown
*
* If set to true, the text of the label will slide/scroll through the length of
* label.
*
* @warning This only works with the themes "slide_short", "slide_long" and
* "slide_bounce".
*
* @ingroup Label
*/
EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide);
/**
* @brief Get whether sliding effect is shown or not.
*
* @param obj The label object
* @return If true, sliding effect is shown.
*
* @see elm_label_slide_set()
*
* @ingroup Label
*/
EAPI Eina_Bool elm_label_slide_get(const Evas_Object *obj);
/**
* @brief Set the slide duration(speed) of the label
*
* @param obj The label object
* @param duration The duration in seconds in moving text from slide begin position
* to slide end position
*
* @ingroup Label
*/
EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration);
/**
* @brief Get the slide duration(speed) of the label
*
* @param obj The label object
* @return The duration time in moving text from slide begin position to slide end position
*
* @see elm_label_slide_duration_set()
*
* @ingroup Label
*/
EAPI double elm_label_slide_duration_get(const Evas_Object *obj);
/**
* @}
*/
|
