summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2015-08-07 15:48:51 +0100
committerTom Hacohen <tom@stosb.com>2015-08-07 15:49:14 +0100
commit7a475249ddf5e5cd3142ab9c51af413720d2ff4d (patch)
tree05b95f647d8907520e665d4f304300b3dad83e86
parent356d1b1d813f9114bda17ee67d1ef36f70e2bb3c (diff)
Progressbar: migrate docs.
-rw-r--r--src/lib/elm_progressbar.eo270
1 files changed, 76 insertions, 194 deletions
diff --git a/src/lib/elm_progressbar.eo b/src/lib/elm_progressbar.eo
index 1d797174c..827581c4c 100644
--- a/src/lib/elm_progressbar.eo
+++ b/src/lib/elm_progressbar.eo
@@ -3,271 +3,153 @@ class Elm.Progressbar (Elm.Layout)
3 eo_prefix: elm_obj_progressbar; 3 eo_prefix: elm_obj_progressbar;
4 methods { 4 methods {
5 @property span_size { 5 @property span_size {
6 [[Control the (exact) length of the bar region of a given progress bar widget
7
8 This sets the minimum width (when in horizontal mode) or height
9 (when in vertical mode) of the actual bar area of the progress
10 bar $obj. This in turn affects the object's minimum size. Use
11 this when you're not setting other size hints expanding on the
12 given direction (like weight and alignment hints) and you would
13 like it to have a specific size.
14
15 Note: Icon, label and unit text around $obj will require their
16 own space, which will make $obj to require more the $size,
17 actually.]]
6 set { 18 set {
7 /*@
8 Set the (exact) length of the bar region of a given progress bar
9 widget
10
11 This sets the minimum width (when in horizontal mode) or height
12 (when in vertical mode) of the actual bar area of the progress
13 bar $obj. This in turn affects the object's minimum size. Use
14 this when you're not setting other size hints expanding on the
15 given direction (like weight and alignment hints) and you would
16 like it to have a specific size.
17
18 @note Icon, label and unit text around $obj will require their
19 own space, which will make $obj to require more the $size,
20 actually.
21
22 @see elm_progressbar_span_size_get()
23
24 @ingroup Progressbar */
25 } 19 }
26 get { 20 get {
27 /*@
28 Get the length set for the bar region of a given progress bar
29 widget
30
31 @return The length of the progress bar's bar region
32
33 If that size was not set previously, with
34 elm_progressbar_span_size_set(), this call will return $0.
35
36 @ingroup Progressbar */
37 } 21 }
38 values { 22 values {
39 size: Evas.Coord; /*@ The length of the progress bar's bar region */ 23 size: Evas.Coord; [[The length of the progress bar's bar region]]
40 } 24 }
41 } 25 }
42 @property pulse { 26 @property pulse {
27 [[Control whether a given progress bar widget is at "pulsing mode" or not.
28
29 By default, progress bars will display values from the low to
30 high value boundaries. There are, though, contexts in which the
31 progress of a given task is unknown. For such cases,
32 one can set a progress bar widget to a "pulsing state", to give
33 the user an idea that some computation is being held, but
34 without exact progress values. In the default theme, it will
35 animate its bar with the contents filling in constantly and back
36 to non-filled, in a loop. To start and stop this pulsing
37 animation, one has to explicitly call elm_progressbar_pulse().]]
43 set { 38 set {
44 /*@
45 Set whether a given progress bar widget is at "pulsing mode" or
46 not.
47
48 By default, progress bars will display values from the low to
49 high value boundaries. There are, though, contexts in which the
50 progress of a given task is @b unknown. For such cases,
51 one can set a progress bar widget to a "pulsing state", to give
52 the user an idea that some computation is being held, but
53 without exact progress values. In the default theme, it will
54 animate its bar with the contents filling in constantly and back
55 to non-filled, in a loop. To start and stop this pulsing
56 animation, one has to explicitly call elm_progressbar_pulse().
57
58 @see elm_progressbar_pulse_get()
59 @see elm_progressbar_pulse()
60
61 @ingroup Progressbar */
62 } 39 }
63 get { 40 get {
64 /*@
65 Get whether a given progress bar widget is at "pulsing mode" or
66 not.
67
68 @return $true, if $obj is in pulsing mode, $false
69 if it's in the default one (and on errors)
70
71 @ingroup Progressbar */
72 } 41 }
73 values { 42 values {
74 pulse: bool; /*@ $true to put $obj in pulsing mode, 43 pulse: bool; [[$true to put $obj in pulsing mode, $false to put it back to its default one]]
75 $false to put it back to its default one */
76 } 44 }
77 } 45 }
78 @property value { 46 @property value {
79 set { 47 [[Control the progress value (in percentage) on a given progress bar widget
80 /*@
81 Set the progress value (in percentage) on a given progress bar
82 widget
83
84 Use this call to set progress bar levels.
85 48
86 @note If you passes a value out of the specified range for @p 49 Use this call to set progress bar levels.
87 val, it will be interpreted as the @b closest of the @b boundary
88 values in the range.
89 50
90 @ingroup Progressbar */ 51 Note: If you passes a value out of the specified range for
52 $val, it will be interpreted as the closest of the boundary
53 values in the range.]]
54 set {
91 } 55 }
92 get { 56 get {
93 /*@
94 Get the progress value (in percentage) on a given progress bar
95 widget
96
97 @return The value of the progressbar
98
99 @see elm_progressbar_value_set() for more details
100
101 @ingroup Progressbar */
102 } 57 }
103 values { 58 values {
104 val: double; /*@ The progress value (@b must be between $0.0 and @c 59 val: double; [[The progress value (must be between $0.0 and 1.0)]]
105 1.0) */
106 } 60 }
107 } 61 }
108 @property inverted { 62 @property inverted {
109 set { 63 [[Invert a given progress bar widget's displaying values order
110 /*@
111 Invert a given progress bar widget's displaying values order
112
113 A progress bar may be @b inverted, in which state it gets its
114 values inverted, with high values being on the left or top and
115 low values on the right or bottom, as opposed to normally have
116 the low values on the former and high values on the latter,
117 respectively, for horizontal and vertical modes.
118
119 @see elm_progressbar_inverted_get()
120 64
121 @ingroup Progressbar */ 65 A progress bar may be inverted, in which state it gets its
66 values inverted, with high values being on the left or top and
67 low values on the right or bottom, as opposed to normally have
68 the low values on the former and high values on the latter,
69 respectively, for horizontal and vertical modes.]]
70 set {
122 } 71 }
123 get { 72 get {
124 /*@
125 Get whether a given progress bar widget's displaying values are
126 inverted or not
127
128 @return $true, if $obj has inverted values,
129 $false otherwise (and on errors)
130
131 @see elm_progressbar_inverted_set() for more details
132
133 @ingroup Progressbar */
134 } 73 }
135 values { 74 values {
136 inverted: bool; /*@ Use $true to make $obj inverted, 75 inverted: bool; [[Use $true to make $obj inverted, $false to bring it back to default, non-inverted values.]]
137 $false to bring it back to default, non-inverted values. */
138 } 76 }
139 } 77 }
140 @property horizontal { 78 @property horizontal {
141 set { 79 [[Control the orientation of a given progress bar widget
142 /*@
143 Set the orientation of a given progress bar widget
144
145 Use this function to change how your progress bar is to be
146 disposed: vertically or horizontally.
147 80
148 @see elm_progressbar_horizontal_get() 81 Use this function to change how your progress bar is to be
149 82 disposed: vertically or horizontally.]]
150 @ingroup Progressbar */ 83 set {
151 } 84 }
152 get { 85 get {
153 /*@
154 Get the orientation of a given progress bar widget
155
156 @return $true, if $obj is set to be @b horizontal,
157 $false if it's @b vertical (and on errors)
158
159 @see elm_progressbar_horizontal_set() for more details
160
161 @ingroup Progressbar */
162 } 86 }
163 values { 87 values {
164 horizontal: bool; /*@ Use $true to make $obj to be 88 horizontal: bool; [[Use $true to make $obj to be horizontal, $false to make it vertical]]
165 @b horizontal, $false to make it @b vertical */
166 } 89 }
167 } 90 }
168 @property unit_format { 91 @property unit_format {
92 [[Control the format string for a given progress bar widget's units label
93
94 If $NULL is passed on $format, it will make $obj's units
95 area to be hidden completely. If not, it'll set the <b>format
96 string</b> for the units label's text. The units label is
97 provided a floating point value, so the units text is up display
98 at most one floating point value. Note that the units label is
99 optional. Use a format string such as "%1.2f meters" for
100 example.
101
102 Note: The default format string for a progress bar is an integer
103 percentage, as in $"%.0f %%".]]
169 set { 104 set {
170 /*@
171 Set the format string for a given progress bar widget's units
172 label
173
174 If $NULL is passed on $format, it will make $obj's units
175 area to be hidden completely. If not, it'll set the <b>format
176 string</b> for the units label's @b text. The units label is
177 provided a floating point value, so the units text is up display
178 at most one floating point value. Note that the units label is
179 optional. Use a format string such as "%1.2f meters" for
180 example.
181
182 @note The default format string for a progress bar is an integer
183 percentage, as in $"%.0f %%".
184
185 @see elm_progressbar_unit_format_get()
186
187 @ingroup Progressbar */
188 } 105 }
189 get { 106 get {
190 /*@
191 Get the format string set for a given progress bar widget's
192 units label
193
194 @return The format set string for $obj's units label or
195 $NULL, if none was set (and on errors)
196
197 @see elm_progressbar_unit_format_set() for more details
198
199 @ingroup Progressbar */
200 } 107 }
201 values { 108 values {
202 units: const(char)* @nullable; /*@ The format string for $obj's units label */ 109 units: const(char)* @nullable; [[The format string for $obj's units label]]
203 } 110 }
204 } 111 }
205 @property unit_format_function { 112 @property unit_format_function {
206 set { 113 set {
207 /*@ 114 [[Set the format function pointer for the units label
208 Set the format function pointer for the units label
209 115
210 Set the callback function to format the unit string. 116 Set the callback function to format the unit string.
211 117
212 @see elm_progressbar_unit_format_set() for more info on how this works. 118 See: @.unit_format.set for more info on how this works.
213 119
214 @since 1.7 120 @since 1.7]]
215
216 @ingroup Progressbar */
217 } 121 }
218 values { 122 values {
219 func: progressbar_func_type @nullable; /*@ The unit format function */ 123 func: progressbar_func_type @nullable; [[The unit format function]]
220 free_func: progressbar_freefunc_type @optional; /*@ The freeing function for the format string. */ 124 free_func: progressbar_freefunc_type @optional; [[The freeing function for the format string.]]
221 } 125 }
222 } 126 }
223 part_value_set { 127 part_value_set {
224 /*@ 128 [[Set the progress value (in percentage) on a given progress bar widget for the given part name
225 Set the progress value (in percentage) on a given progress bar
226 widget for the given part name
227
228 @since 1.8
229
230 Use this call to set progress bar status for more than one progress status .
231 129
232 @ingroup Progressbar */ 130 Use this call to set progress bar status for more than one progress status .
233 131
132 @since 1.8]]
234 params { 133 params {
235 @in part: const(char)*; /*@ The partname to which val have to set */ 134 @in part: const(char)*; [[The partname to which val have to set]]
236 @in val: double; /*@ The progress value (@b must be between $0.0 and @c 135 @in val: double; [[The progress value (must be between $0.0 and 1.0)]]
237 1.0) */
238 } 136 }
239 } 137 }
240 part_value_get @const { 138 part_value_get @const {
241 /*@ 139 [[Get the progress value (in percentage) on a given progress bar widget for a particular part
242 Get the progress value (in percentage) on a given progress bar
243 widget for a particular part
244 140
245 @since 1.8 141 @since 1.8]]
246 142 return: double; [[The value of the progressbar]]
247 @return The value of the progressbar
248
249 @see elm_progressbar_value_set() for more details
250
251 @ingroup Progressbar */
252 return: double;
253 params { 143 params {
254 @in part: const(char)*; /*@ The part name of the progress bar */ 144 @in part: const(char)*; [[The part name of the progress bar]]
255 } 145 }
256 } 146 }
257 pulse { 147 pulse {
258 /*@ 148 [[Start/stop a given progress bar "pulsing" animation, if its under that mode
259 Start/stop a given progress bar "pulsing" animation, if its
260 under that mode
261
262 @note This call won't do anything if $obj is not under "pulsing mode".
263
264 @see elm_progressbar_pulse_set() for more details.
265
266 @ingroup Progressbar */
267 149
150 Note: This call won't do anything if $obj is not under "pulsing mode".]]
268 params { 151 params {
269 @in state: bool; /*@ $true, to @b start the pulsing animation, 152 @in state: bool; [[$true, to start the pulsing animation, $false to stop it]]
270 $false to @b stop it */
271 } 153 }
272 } 154 }
273 } 155 }