elementary / slider, radio, separator, photocam, photo, store, scroller, slideshow...
[framework/uifw/elementary.git] / src / lib / elm_progressbar.c
1 #include <Elementary.h>
2 #include "elm_priv.h"
3
4 /**
5  * @defgroup Progressbar Progressbar
6  *
7  * The progressbar adds a widget for representing current progress
8  * of a job status
9  *
10  * A progressbar can be horizontal or vertical. It can contain an Icon and has a
11  * primary label as well as a units label (that is formatted with floating
12  * point values and thus accepts a printf-style format string, like
13  * “%1.2f units”.
14  *
15  *  Label, Icon and Unit strings/objects are optional.
16  *
17  * A progressbar may be inverted which means values invert, with high vales being
18  * on the left or top and low values on the right or bottom (as opposed to
19  * normally being low on the left or top and high on the bottom and right).
20  *
21  * The span of the progressbar is its length (horizontally or vertically).
22  * This will be scaled by the object or applications scaling factor. At any point
23  * code can query the progressbar for its value with elm_progressbar_value_get().
24  */
25
26 #define MIN_RATIO_LVL 0.0
27 #define MAX_RATIO_LVL 1.0
28
29 typedef struct _Widget_Data Widget_Data;
30
31 struct _Widget_Data
32 {
33    Evas_Object *progressbar;
34    Evas_Object *spacer;
35    Evas_Object *icon;
36    Evas_Coord size;
37    Eina_Bool horizontal : 1;
38    Eina_Bool inverted : 1;
39    Eina_Bool pulse : 1;
40    Eina_Bool pulse_state : 1;
41    const char *units;
42    const char *label;
43    double val;
44 };
45
46 static const char *widtype = NULL;
47 static void _del_hook(Evas_Object *obj);
48 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
49 static void _theme_hook(Evas_Object *obj);
50 static void _sizing_eval(Evas_Object *obj);
51 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
52 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
53 static void _units_set(Evas_Object *obj);
54 static void _val_set(Evas_Object *obj);
55
56 static void
57 _del_hook(Evas_Object *obj)
58 {
59    Widget_Data *wd = elm_widget_data_get(obj);
60    if (!wd) return;
61    if (wd->label) eina_stringshare_del(wd->label);
62    if (wd->units) eina_stringshare_del(wd->units);
63    free(wd);
64 }
65
66 static void
67 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
68 {
69    Widget_Data *wd = elm_widget_data_get(obj);
70    if (!wd) return;
71    edje_object_mirrored_set(wd->progressbar, rtl);
72 }
73
74 static void
75 _theme_hook(Evas_Object *obj)
76 {
77    Widget_Data *wd = elm_widget_data_get(obj);
78    if (!wd) return;
79    _elm_widget_mirrored_reload(obj);
80    _mirrored_set(obj, elm_widget_mirrored_get(obj));
81    if (wd->horizontal)
82      _elm_theme_object_set(obj, wd->progressbar, "progressbar", "horizontal", elm_widget_style_get(obj));
83    else
84      _elm_theme_object_set(obj, wd->progressbar, "progressbar", "vertical", elm_widget_style_get(obj));
85
86    if (wd->icon)
87      {
88         edje_object_part_swallow(wd->progressbar, "elm.swallow.content", wd->icon);
89         edje_object_signal_emit(wd->progressbar, "elm,state,icon,visible", "elm");
90      }
91    if (wd->label)
92      {
93         edje_object_part_text_set(wd->progressbar, "elm.text", wd->label);
94         edje_object_signal_emit(wd->progressbar, "elm,state,text,visible", "elm");
95      }
96    if (wd->pulse)
97      edje_object_signal_emit(wd->progressbar, "elm,state,pulse", "elm");
98    else
99      edje_object_signal_emit(wd->progressbar, "elm,state,fraction", "elm");
100    if (wd->pulse_state)
101      edje_object_signal_emit(wd->progressbar, "elm,state,pulse,start", "elm");
102
103    if ((wd->units) && (!wd->pulse))
104      edje_object_signal_emit(wd->progressbar, "elm,state,units,visible", "elm");
105
106    if (wd->horizontal)
107      evas_object_size_hint_min_set(wd->spacer, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale, 1);
108    else
109      evas_object_size_hint_min_set(wd->spacer, 1, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale);
110
111    edje_object_part_swallow(wd->progressbar, "elm.swallow.bar", wd->spacer);
112
113    if (wd->inverted)
114      edje_object_signal_emit(wd->progressbar, "elm,state,inverted,on", "elm");
115
116    _units_set(obj);
117    edje_object_message_signal_process(wd->progressbar);
118    edje_object_scale_set(wd->progressbar, elm_widget_scale_get(obj) * _elm_config->scale);
119    _val_set(obj);
120    _sizing_eval(obj);
121 }
122
123 static void
124 _sizing_eval(Evas_Object *obj)
125 {
126    Widget_Data *wd = elm_widget_data_get(obj);
127    Evas_Coord minw = -1, minh = -1;
128    if (!wd) return;
129    edje_object_size_min_restricted_calc(wd->progressbar, &minw, &minh, minw, minh);
130    evas_object_size_hint_min_set(obj, minw, minh);
131    evas_object_size_hint_max_set(obj, -1, -1);
132 }
133
134 static void
135 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
136 {
137    Widget_Data *wd = elm_widget_data_get(data);
138    if (!wd) return;
139    if (obj != wd->icon) return;
140    _sizing_eval(data);
141 }
142
143 static void
144 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
145 {
146    Widget_Data *wd = elm_widget_data_get(obj);
147    Evas_Object *sub = event_info;
148    if (!wd) return;
149    if (sub == wd->icon)
150      {
151         edje_object_signal_emit(wd->progressbar, "elm,state,icon,hidden", "elm");
152         evas_object_event_callback_del_full
153            (sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
154         wd->icon = NULL;
155         edje_object_message_signal_process(wd->progressbar);
156         _sizing_eval(obj);
157      }
158 }
159
160 static void
161 _val_set(Evas_Object *obj)
162 {
163    Widget_Data *wd = elm_widget_data_get(obj);
164    Eina_Bool rtl;
165    double pos;
166    if (!wd) return;
167    pos = wd->val;
168    rtl = elm_widget_mirrored_get(obj);
169    if ((!rtl && wd->inverted) || (rtl &&
170                                   ((!wd->horizontal && wd->inverted) ||
171                                    (wd->horizontal && !wd->inverted)))) pos = MAX_RATIO_LVL - pos;
172    edje_object_part_drag_value_set(wd->progressbar, "elm.cur.progressbar", pos, pos);
173 }
174
175 static void
176 _units_set(Evas_Object *obj)
177 {
178    Widget_Data *wd = elm_widget_data_get(obj);
179    if (!wd) return;
180    if (wd->units)
181      {
182         char buf[1024];
183         snprintf(buf, sizeof(buf), wd->units, 100 * wd->val);
184         edje_object_part_text_set(wd->progressbar, "elm.text.status", buf);
185      }
186    else
187      edje_object_part_text_set(wd->progressbar, "elm.text.status", NULL);
188 }
189
190 /**
191  * Add a new progressbar to the parent
192  *
193  * @param parent The parent object
194  * @return The new object or NULL if it cannot be created
195  *
196  * @ingroup Progressbar
197  */
198 EAPI Evas_Object *
199 elm_progressbar_add(Evas_Object *parent)
200 {
201    Evas_Object *obj;
202    Evas *e;
203    Widget_Data *wd;
204
205    ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
206
207    ELM_SET_WIDTYPE(widtype, "progressbar");
208    elm_widget_type_set(obj, "progressbar");
209    elm_widget_sub_object_add(parent, obj);
210    elm_widget_data_set(obj, wd);
211    elm_widget_del_hook_set(obj, _del_hook);
212    elm_widget_theme_hook_set(obj, _theme_hook);
213    elm_widget_can_focus_set(obj, EINA_FALSE);
214
215    wd->horizontal = EINA_TRUE;
216    wd->inverted = EINA_FALSE;
217    wd->pulse = EINA_FALSE;
218    wd->pulse_state = EINA_FALSE;
219    wd->units = eina_stringshare_add("%.0f %%");
220    wd->val = MIN_RATIO_LVL;
221
222    wd->progressbar = edje_object_add(e);
223    _elm_theme_object_set(obj, wd->progressbar, "progressbar", "horizontal", "default");
224    elm_widget_resize_object_set(obj, wd->progressbar);
225
226    wd->spacer = evas_object_rectangle_add(e);
227    evas_object_color_set(wd->spacer, 0, 0, 0, 0);
228    evas_object_pass_events_set(wd->spacer, EINA_TRUE);
229    elm_widget_sub_object_add(obj, wd->spacer);
230    edje_object_part_swallow(wd->progressbar, "elm.swallow.bar", wd->spacer);
231
232    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
233    _units_set(obj);
234    _val_set(obj);
235    _mirrored_set(obj, elm_widget_mirrored_get(obj));
236    _sizing_eval(obj);
237    return obj;
238 }
239
240 /**
241  * Normally the progressbar will display and interpret values from low to high.
242  * This display a progressbar for jobs with unknow state of progression,
243  * (the cursor pulse right to left and left to right, and loop) if pulse is set to 1.
244  *
245  * @param obj The progressbar object
246  * @param pulse The pulse flag. 1 == pulse, 0 == normal
247  *
248  * @ingroup Progressbar
249  */
250 EAPI void
251 elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse)
252 {
253    ELM_CHECK_WIDTYPE(obj, widtype);
254    Widget_Data *wd = elm_widget_data_get(obj);
255    if (!wd) return;
256    pulse = !!pulse;
257    if (wd->pulse == pulse) return;
258    wd->pulse = pulse;
259    _theme_hook(obj);
260 }
261
262 /**
263  * Normally the progressbar will display and interpret values from low to high.
264  * This display a progressbar for jobs with unknow state of progression,
265  * (the cursor pulse right to left and left to right, and loop) if pulse is set to 1.
266  *
267  * @param obj The progressbar object
268  * @return The pulse flag
269  * (1 == pulse, 0 == normal)
270  *
271  * @ingroup Progressbar
272  */
273 EAPI Eina_Bool
274 elm_progressbar_pulse_get(const Evas_Object *obj)
275 {
276    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
277    Widget_Data *wd = elm_widget_data_get(obj);
278    if (!wd) return EINA_FALSE;
279    return wd->pulse;
280 }
281
282 /**
283  * Stat/Stop de pulse action
284  *
285  * @param obj The progressbar object
286  * @param state The pulse flag. 1 == start pulse, 0 == stop pulse
287  *
288  * @ingroup Progressbar
289  */
290 EAPI void
291 elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state)
292 {
293    ELM_CHECK_WIDTYPE(obj, widtype);
294    Widget_Data *wd = elm_widget_data_get(obj);
295    if (!wd) return;
296    state = !!state;
297    if ((!wd->pulse) && (wd->pulse_state == state)) return;
298    wd->pulse_state = state;
299    if (wd->pulse_state)
300      edje_object_signal_emit(wd->progressbar, "elm,state,pulse,start", "elm");
301    else
302      edje_object_signal_emit(wd->progressbar, "elm,state,pulse,stop", "elm");
303 }
304
305 /**
306  * Set the value the progressbar indicates
307  *
308  * @param obj The progressbar object
309  * @param val The fraction value (must be between 0.0 and 1.0)
310  *
311  * @ingroup Progressbar
312  */
313 EAPI void
314 elm_progressbar_value_set(Evas_Object *obj, double val)
315 {
316    ELM_CHECK_WIDTYPE(obj, widtype);
317    Widget_Data *wd = elm_widget_data_get(obj);
318    if (!wd) return;
319    if (wd->val == val) return;
320    wd->val = val;
321    if (wd->val < MIN_RATIO_LVL) wd->val = MIN_RATIO_LVL;
322    if (wd->val > MAX_RATIO_LVL) wd->val = MAX_RATIO_LVL;
323    _val_set(obj);
324    _units_set(obj);
325 }
326
327
328 /**
329  * Get the value the progressbar has
330  *
331  * @param obj The progressbar object
332  * @return The value of the progressbar
333  *
334  * @ingroup Progressbar
335  */
336 EAPI double
337 elm_progressbar_value_get(const Evas_Object *obj)
338 {
339    ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
340    Widget_Data *wd = elm_widget_data_get(obj);
341    if (!wd) return 0.0;
342    return wd->val;
343 }
344
345 /**
346  * Set the label of the progressbar
347  *
348  * @param obj The progressbar object
349  * @param label The text label string in UTF-8
350  *
351  * @ingroup Progressbar
352  */
353 EAPI void
354 elm_progressbar_label_set(Evas_Object *obj, const char *label)
355 {
356    ELM_CHECK_WIDTYPE(obj, widtype);
357    Widget_Data *wd = elm_widget_data_get(obj);
358    if (!wd) return;
359    eina_stringshare_replace(&wd->label, label);
360    if (label)
361      {
362         edje_object_signal_emit(wd->progressbar, "elm,state,text,visible", "elm");
363         edje_object_message_signal_process(wd->progressbar);
364      }
365    else
366      {
367         edje_object_signal_emit(wd->progressbar, "elm,state,text,hidden", "elm");
368         edje_object_message_signal_process(wd->progressbar);
369      }
370    edje_object_part_text_set(wd->progressbar, "elm.text", label);
371    _sizing_eval(obj);
372 }
373
374 /**
375  * Get the label of the progressbar
376  *
377  * @param obj The progressbar object
378  * @return The text label string in UTF-8
379  *
380  * @ingroup Progressbar
381  */
382 EAPI const char *
383 elm_progressbar_label_get(const Evas_Object *obj)
384 {
385    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
386    Widget_Data *wd = elm_widget_data_get(obj);
387    if (!wd) return NULL;
388    return wd->label;
389 }
390
391 /**
392  * Set the icon object of the progressbar object
393  *
394  * Once the icon object is set, a previously set one will be deleted.
395  * If you want to keep that old content object, use the
396  * elm_progressbar_icon_unset() function.
397  *
398  * @param obj The progressbar object
399  * @param icon The icon object
400  *
401  * @ingroup Progressbar
402  */
403 EAPI void
404 elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon)
405 {
406    ELM_CHECK_WIDTYPE(obj, widtype);
407    Widget_Data *wd = elm_widget_data_get(obj);
408    if (!wd) return;
409    if (wd->icon == icon) return;
410    if (wd->icon) evas_object_del(wd->icon);
411    wd->icon = icon;
412    if (icon)
413      {
414         elm_widget_sub_object_add(obj, icon);
415         evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
416                                        _changed_size_hints, obj);
417         edje_object_part_swallow(wd->progressbar, "elm.swallow.content", icon);
418         edje_object_signal_emit(wd->progressbar, "elm,state,icon,visible", "elm");
419         edje_object_message_signal_process(wd->progressbar);
420      }
421    _sizing_eval(obj);
422 }
423
424 /**
425  * Get the icon object of the progressbar object
426  *
427  * @param obj The progressbar object
428  * @return The icon object
429  *
430  * @ingroup Progressbar
431  */
432 EAPI Evas_Object *
433 elm_progressbar_icon_get(const Evas_Object *obj)
434 {
435    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
436    Widget_Data *wd = elm_widget_data_get(obj);
437    if (!wd) return NULL;
438    return wd->icon;
439 }
440
441 /**
442  * Unset the icon used for the progressbar object
443  *
444  * Unparent and return the icon object which was set for this widget.
445  *
446  * @param obj The progressbar object
447  * @return The icon object that was being used
448  *
449  * @ingroup Progressbar
450  */
451 EAPI Evas_Object *
452 elm_progressbar_icon_unset(Evas_Object *obj)
453 {
454    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
455    Widget_Data *wd = elm_widget_data_get(obj);
456    if (!wd) return NULL;
457    if (!wd->icon) return NULL;
458    Evas_Object *icon = wd->icon;
459    elm_widget_sub_object_del(obj, wd->icon);
460    edje_object_part_unswallow(wd->progressbar, wd->icon);
461    wd->icon = NULL;
462    return icon;
463 }
464
465 /**
466  * Set the length of the progression region of the progressbar
467  *
468  * This sets the minimum width or height (depending on orientation) of the
469  * area of the progressbar that allows the progressbar to be dragged around. This in
470  * turn affects the objects minimum size (along with icon label and unit
471  * text).
472  *
473  * @param obj The progressbar object
474  * @param size The length of the progressbar area
475  *
476  * @ingroup Progressbar
477  */
478 EAPI void
479 elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size)
480 {
481    ELM_CHECK_WIDTYPE(obj, widtype);
482    Widget_Data *wd = elm_widget_data_get(obj);
483    if (!wd) return;
484    if (wd->size == size) return;
485    wd->size = size;
486    if (wd->horizontal)
487      evas_object_size_hint_min_set(wd->spacer, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale, 1);
488    else
489      evas_object_size_hint_min_set(wd->spacer, 1, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale);
490    edje_object_part_swallow(wd->progressbar, "elm.swallow.bar", wd->spacer);
491    _sizing_eval(obj);
492 }
493
494 /**
495  * Get the length of the progression region of the progressbar
496  *
497  * @param obj The progressbar object
498  * @return The length of the progressbar area
499  *
500  * @ingroup Progressbar
501  */
502 EAPI Evas_Coord
503 elm_progressbar_span_size_get(const Evas_Object *obj)
504 {
505    ELM_CHECK_WIDTYPE(obj, widtype) 0;
506    Widget_Data *wd = elm_widget_data_get(obj);
507    if (!wd) return 0;
508    return wd->size;
509 }
510
511 /**
512  * Set the format string of the unit area
513  *
514  * If NULL, this disabls the unit area display. If not it sets the format
515  * string for the unit text. The unit text is provided a floating point
516  * value, so the unit text can display up to 1 floating point falue. Note that
517  * this is optional. Use a format string such as "%1.2f meters" for example.
518  *
519  * @param obj The progressbar object
520  * @param units The format string for the units display
521  *
522  * @ingroup Progressbar
523  */
524 EAPI void
525 elm_progressbar_unit_format_set(Evas_Object *obj, const char *units)
526 {
527    ELM_CHECK_WIDTYPE(obj, widtype);
528    Widget_Data *wd = elm_widget_data_get(obj);
529    if (!wd) return;
530    eina_stringshare_replace(&wd->units, units);
531    if (units)
532      {
533         edje_object_signal_emit(wd->progressbar, "elm,state,units,visible", "elm");
534         edje_object_message_signal_process(wd->progressbar);
535      }
536    else
537      {
538         edje_object_signal_emit(wd->progressbar, "elm,state,units,hidden", "elm");
539         edje_object_message_signal_process(wd->progressbar);
540      }
541    _units_set(obj);
542    _sizing_eval(obj);
543 }
544
545 /**
546  * Get the format string of the unit area
547  *
548  * @param obj The progressbar object
549  * @return The format string for the units display
550  *
551  * @ingroup Progressbar
552  */
553 EAPI const char *
554 elm_progressbar_unit_format_get(const Evas_Object *obj)
555 {
556    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
557    Widget_Data *wd = elm_widget_data_get(obj);
558    if (!wd) return NULL;
559    return wd->units;
560 }
561
562 /**
563  * Set orientation of the progressbar
564  *
565  * @param obj The progressbar object
566  * @param horizontal If set, the progressbar will be horizontal
567  *
568  * @ingroup Progressbar
569  */
570 EAPI void
571 elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
572 {
573    ELM_CHECK_WIDTYPE(obj, widtype);
574    Widget_Data *wd = elm_widget_data_get(obj);
575    if (!wd) return;
576    horizontal = !!horizontal;
577    if (wd->horizontal == horizontal) return;
578    wd->horizontal = horizontal;
579    _theme_hook(obj);
580 }
581
582 /**
583  * Gets orientation of the progressbar
584  *
585  * @param obj The progressbar object
586  * @return The orientation
587  * (0 = vertical, 1 = horizontal)
588  *
589  * @ingroup Progressbar
590  */
591 EAPI Eina_Bool
592 elm_progressbar_horizontal_get(const Evas_Object *obj)
593 {
594    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
595    Widget_Data *wd = elm_widget_data_get(obj);
596    if (!wd) return EINA_FALSE;
597    return wd->horizontal;
598 }
599
600 /**
601  * Invert the progressbar display
602  *
603  * Normally the progressbar will display and interpret values from low to high
604  * and when horizontal that is left to right. When vertical that is top
605  * to bottom. This inverts this (so from right to left or bottom to top) if
606  * inverted is set to 1.
607  *
608  * @param obj The progressbar object
609  * @param inverted The inverted flag. 1 == inverted, 0 == normal
610  *
611  * @ingroup Progressbar
612  */
613 EAPI void
614 elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted)
615 {
616    ELM_CHECK_WIDTYPE(obj, widtype);
617    Widget_Data *wd = elm_widget_data_get(obj);
618    if (!wd) return;
619    inverted = !!inverted;
620    if (wd->inverted == inverted) return;
621    wd->inverted = inverted;
622    if (wd->inverted)
623      edje_object_signal_emit(wd->progressbar, "elm,state,inverted,on", "elm");
624    else
625      edje_object_signal_emit(wd->progressbar, "elm,state,inverted,off", "elm");
626    edje_object_message_signal_process(wd->progressbar);
627    _val_set(obj);
628    _units_set(obj);
629 }
630
631 /**
632  * Gets if the progressbar will displayed inverted
633  *
634  * @param obj The progressbar object
635  * @return The inverted flag
636  * (1 == inverted, 0 == normal)
637  *
638  * @ingroup Progressbar
639  */
640 EAPI Eina_Bool
641 elm_progressbar_inverted_get(const Evas_Object *obj)
642 {
643    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
644    Widget_Data *wd = elm_widget_data_get(obj);
645    if (!wd) return EINA_FALSE;
646    return wd->inverted;
647 }