summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2015-08-07 14:10:49 +0100
committerTom Hacohen <tom@stosb.com>2015-08-07 14:11:09 +0100
commiteb4ffb69e4d7cf55d5aa0629e1f907fa0a1b8d05 (patch)
tree9710670d98179a38c301e30fc592a0d296c6d02e
parent2e1f8a58d4f58ebf6e43e3ad376e8c2c6a7e8d37 (diff)
Label: migrate docs.
-rw-r--r--src/lib/elm_label.eo175
1 files changed, 49 insertions, 126 deletions
diff --git a/src/lib/elm_label.eo b/src/lib/elm_label.eo
index 4ea399c90..9f18be18b 100644
--- a/src/lib/elm_label.eo
+++ b/src/lib/elm_label.eo
@@ -13,186 +13,109 @@ class Elm.Label (Elm.Layout)
13 eo_prefix: elm_obj_label; 13 eo_prefix: elm_obj_label;
14 methods { 14 methods {
15 @property wrap_width { 15 @property wrap_width {
16 set { 16 [[Control wrap width of the label
17 /*@
18 @brief Set wrap width of the label
19
20 This function sets the maximum width size hint of the label.
21 17
22 @warning This is only relevant if the label is inside a container. 18 This function sets the maximum width size hint of the label.
23 19
24 @ingroup Label */ 20 Warning: This is only relevant if the label is inside a container.]]
21 set {
25 } 22 }
26 get { 23 get {
27 /*@
28 @brief Get wrap width of the label
29
30 @return The wrap width in pixels at a minimum where words need to wrap
31
32 @see elm_label_wrap_width_set()
33
34 @ingroup Label */
35 } 24 }
36 values { 25 values {
37 w: Evas.Coord; /*@ The wrap width in pixels at a minimum where words need to wrap */ 26 w: Evas.Coord; [[The wrap width in pixels at a minimum where words need to wrap]]
38 } 27 }
39 } 28 }
40 @property slide_speed { 29 @property slide_speed {
41 set { 30 [[Control the slide speed of the label
42 /*@
43 @brief Set the slide speed of the label
44 31
45 @see elm_label_slide_duration_set() 32 Note: If you set the duration of the slide using @.slide_duration.set
33 you cannot get the correct speed using this function until the label
34 is actually rendered and resized.
46 35
47 @ingroup Label */ 36 See @.slide_duration.set]]
37 set {
48 } 38 }
49 get { 39 get {
50 /*@
51 @brief Get the slide speed of the label
52
53 @return The slide animation speed in px per seconds
54
55 @note If you set the duration of the slide using elm_label_slide_duration_set()
56 you cannot get the correct speed using this function until the label
57 is actually rendered and resized.
58
59 @see elm_label_slide_speed_set()
60
61 @ingroup Label */
62 } 40 }
63 values { 41 values {
64 speed: double; /*@ The speed of the slide animation in px per seconds */ 42 speed: double; [[The speed of the slide animation in px per seconds]]
65 } 43 }
66 } 44 }
67 @property slide_mode { 45 @property slide_mode {
68 set { 46 [[Control the slide mode of the label widget.
69 /*@
70 @brief Set the slide mode of the label widget.
71 47
72 elm_label_slide_mode_set() changes label slide mode. 48 By default, slide mode is none. Possible values for $mode are:
73 By default, slide mode is none. Possible values for $mode are: 49 @Elm.Label.Slide_Mode.none - no slide effect
74 @li #ELM_LABEL_SLIDE_MODE_NONE - no slide effect 50 @Elm.Label.Slide_Mode.auto - slide only if the label area is bigger than
75 @li #ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is bigger than 51 the text width length
76 the text width length 52 @Elm.Label.Slide_Mode.always - slide always
77 @li #ELM_LABEL_SLIDE_MODE_ALWAYS -slide always
78 53
79 @warning #ELM_LABEL_SLIDE_MODE_AUTO, #ELM_LABEL_SLIDE_MODE_ALWAYS only work 54 Warning: @Elm.Label.Slide_Mode.auto, @Elm.Label.Slide_Mode.always only work
80 with the themes "slide_short", "slide_long" and "slide_bounce". 55 with the themes "slide_short", "slide_long" and "slide_bounce".
81 @warning #ELM_LABEL_SLIDE_MODE_AUTO, #ELM_LABEL_SLIDE_MODE_ALWAYS don't work 56 Warning: @Elm.Label.Slide_Mode.auto, @Elm.Label.Slide_Mode.always don't work
82 if the line wrap(elm_label_line_wrap_set()) or 57 if the line wrap(elm_label_line_wrap_set()) or
83 ellipsis(elm_label_ellipsis_set()) is set. 58 ellipsis(elm_label_ellipsis_set()) is set.
84 59
85 @see elm_label_slide_mode_get(). 60 @since 1.8]]
86 @since 1.8 61 set {
87
88 @ingroup Label */
89 } 62 }
90 get { 63 get {
91 /*@
92 @brief Get the slide mode of the label widget.
93
94 @return The slide mode
95
96 @see elm_label_slide_mode_set()
97 @since 1.8
98
99 @ingroup Label */
100 } 64 }
101 values { 65 values {
102 mode: Elm.Label.Slide_Mode; /*@ The slide mode */ 66 mode: Elm.Label.Slide_Mode; [[The slide mode]]
103 } 67 }
104 } 68 }
105 @property slide_duration { 69 @property slide_duration {
106 set { 70 [[Control the slide duration of the label
107 /*@
108 @brief Set the slide duration of the label
109
110 @see elm_label_slide_speed_set()
111 71
112 @ingroup Label */ 72 Note: If you set the speed of the slide using @.slide_speed.set
73 you cannot get the correct duration using this function until the label
74 is actually rendered and resized.]]
75 set {
113 } 76 }
114 get { 77 get {
115 /*@
116 @brief Get the slide duration of the label
117
118 @return The duration time in moving text from slide begin position to slide end position
119
120 @note If you set the speed of the slide using elm_label_slide_speed_set()
121 you cannot get the correct duration using this function until the label
122 is actually rendered and resized.
123
124 @see elm_label_slide_duration_set()
125
126 @ingroup Label */
127 } 78 }
128 values { 79 values {
129 duration: double; /*@ The duration in seconds in moving text from slide begin position 80 duration: double; [[The duration in seconds in moving text from slide begin position to slide end position]]
130 to slide end position */
131 } 81 }
132 } 82 }
133 @property line_wrap { 83 @property line_wrap {
134 set { 84 [[Control the wrapping behavior of the label
135 /*@
136 @brief Set the wrapping behavior of the label
137
138 By default no wrapping is done. Possible values for $wrap are:
139 @li #ELM_WRAP_NONE - No wrapping
140 @li #ELM_WRAP_CHAR - wrap between characters
141 @li #ELM_WRAP_WORD - wrap between words
142 @li #ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
143 85
144 @ingroup Label */ 86 By default no wrapping is done. Possible values for $wrap are:
87 $ELM_WRAP_NONE - No wrapping
88 $ELM_WRAP_CHAR - wrap between characters
89 $ELM_WRAP_WORD - wrap between words
90 $ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap]]
91 set {
145 } 92 }
146 get { 93 get {
147 /*@
148 @brief Get the wrapping behavior of the label
149
150 @return Wrap type
151
152 @see elm_label_line_wrap_set()
153
154 @ingroup Label */
155 } 94 }
156 values { 95 values {
157 wrap: Elm.Wrap.Type; /*@ To wrap text or not */ 96 wrap: Elm.Wrap.Type; [[To wrap text or not]]
158 } 97 }
159 } 98 }
160 @property ellipsis { 99 @property ellipsis {
161 set { 100 [[Control the ellipsis behavior of the label
162 /*@
163 @brief Set the ellipsis behavior of the label
164
165 If set to true and the text doesn't fit in the label an ellipsis("...")
166 will be shown at the end of the widget.
167 101
168 @warning This doesn't work with slide(elm_label_slide_set()) or if the 102 If set to true and the text doesn't fit in the label an ellipsis("...")
169 chosen wrap method was #ELM_WRAP_WORD. 103 will be shown at the end of the widget.
170 104
171 @ingroup Label */ 105 Warning This doesn't work with slide(elm_label_slide_set()) or if the
106 chosen wrap method was $ELM_WRAP_WORD.]]
107 set {
172 } 108 }
173 get { 109 get {
174 /*@
175 @brief Get the ellipsis behavior of the label
176
177 @return If true, an ellipsis will be shown at the end of the label area.
178
179 @see elm_label_ellipsis_set()
180
181 @ingroup Label */
182 } 110 }
183 values { 111 values {
184 ellipsis: bool; /*@ To ellipsis text or not */ 112 ellipsis: bool; [[To ellipsis text or not]]
185 } 113 }
186 } 114 }
187 slide_go { 115 slide_go {
188 /*@ 116 [[Start slide effect.
189 @brief Start slide effect.
190
191 @see elm_label_slide_mode_set()
192 @since 1.8
193
194 @ingroup Label */
195 117
118 See @.slide_mode.set.]]
196 } 119 }
197 } 120 }
198 implements { 121 implements {