summaryrefslogtreecommitdiff
path: root/legacy/elementary/src/lib/elm_label.eo
blob: 27bd910e93b92e2b127fdeff291b048d40de5e37 (plain) (blame)
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
import elm_general;

enum Elm.Label.Slide_Mode
{
   [[
     @addtogroup Label
     Slide mode of a label widget
   ]]
   none = 0, [[No slide effect.]]
   auto, [[Slide only if the label area is bigger than the text width length.]]
   always [[Slide always.]]
}

class Elm.Label (Elm.Layout)
{
   eo_prefix: elm_obj_label;
   methods {
      @property wrap_width {
         set {
            /*@
            @brief Set wrap width of the label

            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 */
         }
         get {
            /*@
            @brief Get wrap width of the label

            @return The wrap width in pixels at a minimum where words need to wrap

            @see elm_label_wrap_width_set()

            @ingroup Label */
         }
         values {
            w: Evas.Coord; /*@ The wrap width in pixels at a minimum where words need to wrap */
         }
      }
      @property slide_speed {
         set {
            /*@
            @brief Set the slide speed of the label

            @see elm_label_slide_duration_set()

            @ingroup Label */
         }
         get {
            /*@
            @brief Get the slide speed of the label

            @return The slide animation speed in px per seconds

            @note If you set the duration of the slide using elm_label_slide_duration_set()
            you cannot get the correct speed using this function until the label
            is actually rendered and resized.

            @see elm_label_slide_speed_set()

            @ingroup Label */
         }
         values {
            speed: double; /*@ The speed of the slide animation in px per seconds */
         }
      }
      @property slide_mode {
         set {
            /*@
            @brief Set the slide mode of the label widget.

            elm_label_slide_mode_set() changes label slide mode.
            By default, slide mode is none. Possible values for @p mode are:
            @li #ELM_LABEL_SLIDE_MODE_NONE - no slide effect
            @li #ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than
            the text width length
            @li #ELM_LABEL_SLIDE_MODE_ALWAYS -slide always

            @warning #ELM_LABEL_SLIDE_MODE_AUTO, #ELM_LABEL_SLIDE_MODE_ALWAYS only work
            with the themes "slide_short", "slide_long" and "slide_bounce".
            @warning #ELM_LABEL_SLIDE_MODE_AUTO, #ELM_LABEL_SLIDE_MODE_ALWAYS don't work
            if the line wrap(elm_label_line_wrap_set()) or
            ellipsis(elm_label_ellipsis_set()) is set.

            @see elm_label_slide_mode_get().
            @since 1.8

            @ingroup Label */
         }
         get {
            /*@
            @brief Get the slide mode of the label widget.

            @return The slide mode

            @see elm_label_slide_mode_set()
            @since 1.8

            @ingroup Label */
         }
         values {
            mode: Elm.Label.Slide_Mode; /*@ The slide mode */
         }
      }
      @property slide_duration {
         set {
            /*@
            @brief Set the slide duration of the label

            @see elm_label_slide_speed_set()

            @ingroup Label */
         }
         get {
            /*@
            @brief Get the slide duration of the label

            @return The duration time in moving text from slide begin position to slide end position

            @note If you set the speed of the slide using elm_label_slide_speed_set()
            you cannot get the correct duration using this function until the label
            is actually rendered and resized.

            @see elm_label_slide_duration_set()

            @ingroup Label */
         }
         values {
            duration: double; /*@ The duration in seconds in moving text from slide begin position
            to slide end position */
         }
      }
      @property line_wrap {
         set {
            /*@
            @brief Set the wrapping behavior of the label

            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 */
         }
         get {
            /*@
            @brief Get the wrapping behavior of the label

            @return Wrap type

            @see elm_label_line_wrap_set()

            @ingroup Label */
         }
         values {
            wrap: Elm.Wrap.Type; /*@ To wrap text or not */
         }
      }
      @property ellipsis {
         set {
            /*@
            @brief Set the ellipsis behavior of the label

            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 */
         }
         get {
            /*@
            @brief Get the ellipsis behavior of the label

            @return If true, an ellipsis will be shown at the end of the label area.

            @see elm_label_ellipsis_set()

            @ingroup Label */
         }
         values {
            ellipsis: bool; /*@ To ellipsis text or not */
         }
      }
      slide_go {
         /*@
         @brief Start slide effect.

         @see elm_label_slide_mode_set()
         @since 1.8

         @ingroup Label */

      }
   }
   implements {
      class.constructor;
      Eo.Base.constructor;
      Evas.Object_Smart.add;
      Elm.Widget.focus_next_manager_is;
      Elm.Widget.focus_direction_manager_is;
      Elm.Widget.theme_apply;
      Elm.Layout.text_set;
      Elm.Layout.text_aliases.get;
      Elm.Layout.sizing_eval;
   }
   events {
      language,changed;
      access,changed;
      slide,end;
   }

}