1 #include <Elementary.h>
5 * @defgroup Progressbar Progressbar
7 * The progressbar adds a widget for representing current progress
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
15 * Label, Icon and Unit strings/objects are optional.
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).
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().
26 #define MIN_RATIO_LVL 0.0
27 #define MAX_RATIO_LVL 1.0
29 typedef struct _Widget_Data Widget_Data;
33 Evas_Object *progressbar;
37 Eina_Bool horizontal : 1;
38 Eina_Bool inverted : 1;
40 Eina_Bool pulse_state : 1;
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);
57 _del_hook(Evas_Object *obj)
59 Widget_Data *wd = elm_widget_data_get(obj);
61 if (wd->label) eina_stringshare_del(wd->label);
62 if (wd->units) eina_stringshare_del(wd->units);
67 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
69 Widget_Data *wd = elm_widget_data_get(obj);
71 edje_object_mirrored_set(wd->progressbar, rtl);
75 _theme_hook(Evas_Object *obj)
77 Widget_Data *wd = elm_widget_data_get(obj);
79 _elm_widget_mirrored_reload(obj);
80 _mirrored_set(obj, elm_widget_mirrored_get(obj));
82 _elm_theme_object_set(obj, wd->progressbar, "progressbar", "horizontal", elm_widget_style_get(obj));
84 _elm_theme_object_set(obj, wd->progressbar, "progressbar", "vertical", elm_widget_style_get(obj));
88 edje_object_part_swallow(wd->progressbar, "elm.swallow.content", wd->icon);
89 edje_object_signal_emit(wd->progressbar, "elm,state,icon,visible", "elm");
93 edje_object_part_text_set(wd->progressbar, "elm.text", wd->label);
94 edje_object_signal_emit(wd->progressbar, "elm,state,text,visible", "elm");
97 edje_object_signal_emit(wd->progressbar, "elm,state,pulse", "elm");
99 edje_object_signal_emit(wd->progressbar, "elm,state,fraction", "elm");
101 edje_object_signal_emit(wd->progressbar, "elm,state,pulse,start", "elm");
103 if ((wd->units) && (!wd->pulse))
104 edje_object_signal_emit(wd->progressbar, "elm,state,units,visible", "elm");
107 evas_object_size_hint_min_set(wd->spacer, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale, 1);
109 evas_object_size_hint_min_set(wd->spacer, 1, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale);
111 edje_object_part_swallow(wd->progressbar, "elm.swallow.bar", wd->spacer);
114 edje_object_signal_emit(wd->progressbar, "elm,state,inverted,on", "elm");
117 edje_object_message_signal_process(wd->progressbar);
118 edje_object_scale_set(wd->progressbar, elm_widget_scale_get(obj) * _elm_config->scale);
124 _sizing_eval(Evas_Object *obj)
126 Widget_Data *wd = elm_widget_data_get(obj);
127 Evas_Coord minw = -1, minh = -1;
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);
135 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
137 Widget_Data *wd = elm_widget_data_get(data);
139 if (obj != wd->icon) return;
144 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
146 Widget_Data *wd = elm_widget_data_get(obj);
147 Evas_Object *sub = event_info;
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);
155 edje_object_message_signal_process(wd->progressbar);
161 _val_set(Evas_Object *obj)
163 Widget_Data *wd = elm_widget_data_get(obj);
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);
176 _units_set(Evas_Object *obj)
178 Widget_Data *wd = elm_widget_data_get(obj);
183 snprintf(buf, sizeof(buf), wd->units, 100 * wd->val);
184 edje_object_part_text_set(wd->progressbar, "elm.text.status", buf);
187 edje_object_part_text_set(wd->progressbar, "elm.text.status", NULL);
191 * Add a new progressbar to the parent
193 * @param parent The parent object
194 * @return The new object or NULL if it cannot be created
196 * @ingroup Progressbar
199 elm_progressbar_add(Evas_Object *parent)
205 EINA_SAFETY_ON_NULL_RETURN_VAL(parent, NULL);
207 wd = ELM_NEW(Widget_Data);
208 e = evas_object_evas_get(parent);
210 obj = elm_widget_add(e);
211 ELM_SET_WIDTYPE(widtype, "progressbar");
212 elm_widget_type_set(obj, "progressbar");
213 elm_widget_sub_object_add(parent, obj);
214 elm_widget_data_set(obj, wd);
215 elm_widget_del_hook_set(obj, _del_hook);
216 elm_widget_theme_hook_set(obj, _theme_hook);
217 elm_widget_can_focus_set(obj, EINA_FALSE);
219 wd->horizontal = EINA_TRUE;
220 wd->inverted = EINA_FALSE;
221 wd->pulse = EINA_FALSE;
222 wd->pulse_state = EINA_FALSE;
223 wd->units = eina_stringshare_add("%.0f %%");
224 wd->val = MIN_RATIO_LVL;
226 wd->progressbar = edje_object_add(e);
227 _elm_theme_object_set(obj, wd->progressbar, "progressbar", "horizontal", "default");
228 elm_widget_resize_object_set(obj, wd->progressbar);
230 wd->spacer = evas_object_rectangle_add(e);
231 evas_object_color_set(wd->spacer, 0, 0, 0, 0);
232 evas_object_pass_events_set(wd->spacer, EINA_TRUE);
233 elm_widget_sub_object_add(obj, wd->spacer);
234 edje_object_part_swallow(wd->progressbar, "elm.swallow.bar", wd->spacer);
236 evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
239 _mirrored_set(obj, elm_widget_mirrored_get(obj));
245 * Normally the progressbar will display and interpret values from low to high.
246 * This display a progressbar for jobs with unknow state of progression,
247 * (the cursor pulse right to left and left to right, and loop) if pulse is set to 1.
249 * @param obj The progressbar object
250 * @param pulse The pulse flag. 1 == pulse, 0 == normal
252 * @ingroup Progressbar
255 elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse)
257 ELM_CHECK_WIDTYPE(obj, widtype);
258 Widget_Data *wd = elm_widget_data_get(obj);
261 if (wd->pulse == pulse) return;
267 * Normally the progressbar will display and interpret values from low to high.
268 * This display a progressbar for jobs with unknow state of progression,
269 * (the cursor pulse right to left and left to right, and loop) if pulse is set to 1.
271 * @param obj The progressbar object
272 * @return The pulse flag
273 * (1 == pulse, 0 == normal)
275 * @ingroup Progressbar
278 elm_progressbar_pulse_get(const Evas_Object *obj)
280 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
281 Widget_Data *wd = elm_widget_data_get(obj);
282 if (!wd) return EINA_FALSE;
287 * Stat/Stop de pulse action
289 * @param obj The progressbar object
290 * @param state The pulse flag. 1 == start pulse, 0 == stop pulse
292 * @ingroup Progressbar
295 elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state)
297 ELM_CHECK_WIDTYPE(obj, widtype);
298 Widget_Data *wd = elm_widget_data_get(obj);
301 if ((!wd->pulse) && (wd->pulse_state == state)) return;
302 wd->pulse_state = state;
304 edje_object_signal_emit(wd->progressbar, "elm,state,pulse,start", "elm");
306 edje_object_signal_emit(wd->progressbar, "elm,state,pulse,stop", "elm");
310 * Set the value the progressbar indicates
312 * @param obj The progressbar object
313 * @param val The fraction value (must be between 0.0 and 1.0)
315 * @ingroup Progressbar
318 elm_progressbar_value_set(Evas_Object *obj, double val)
320 ELM_CHECK_WIDTYPE(obj, widtype);
321 Widget_Data *wd = elm_widget_data_get(obj);
323 if (wd->val == val) return;
325 if (wd->val < MIN_RATIO_LVL) wd->val = MIN_RATIO_LVL;
326 if (wd->val > MAX_RATIO_LVL) wd->val = MAX_RATIO_LVL;
333 * Get the value the progressbar has
335 * @param obj The progressbar object
336 * @return The value of the progressbar
338 * @ingroup Progressbar
341 elm_progressbar_value_get(const Evas_Object *obj)
343 ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
344 Widget_Data *wd = elm_widget_data_get(obj);
350 * Set the label of the progressbar
352 * @param obj The progressbar object
353 * @param label The text label string in UTF-8
355 * @ingroup Progressbar
358 elm_progressbar_label_set(Evas_Object *obj, const char *label)
360 ELM_CHECK_WIDTYPE(obj, widtype);
361 Widget_Data *wd = elm_widget_data_get(obj);
363 eina_stringshare_replace(&wd->label, label);
366 edje_object_signal_emit(wd->progressbar, "elm,state,text,visible", "elm");
367 edje_object_message_signal_process(wd->progressbar);
371 edje_object_signal_emit(wd->progressbar, "elm,state,text,hidden", "elm");
372 edje_object_message_signal_process(wd->progressbar);
374 edje_object_part_text_set(wd->progressbar, "elm.text", label);
379 * Get the label of the progressbar
381 * @param obj The progressbar object
382 * @return The text label string in UTF-8
384 * @ingroup Progressbar
387 elm_progressbar_label_get(const Evas_Object *obj)
389 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
390 Widget_Data *wd = elm_widget_data_get(obj);
391 if (!wd) return NULL;
396 * Set the icon object of the progressbar object
398 * Once the icon object is set, a previously set one will be deleted.
399 * If you want to keep that old content object, use the
400 * elm_progressbar_icon_unset() function.
402 * @param obj The progressbar object
403 * @param icon The icon object
405 * @ingroup Progressbar
408 elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon)
410 ELM_CHECK_WIDTYPE(obj, widtype);
411 Widget_Data *wd = elm_widget_data_get(obj);
413 if (wd->icon == icon) return;
414 if (wd->icon) evas_object_del(wd->icon);
418 elm_widget_sub_object_add(obj, icon);
419 evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
420 _changed_size_hints, obj);
421 edje_object_part_swallow(wd->progressbar, "elm.swallow.content", icon);
422 edje_object_signal_emit(wd->progressbar, "elm,state,icon,visible", "elm");
423 edje_object_message_signal_process(wd->progressbar);
429 * Get the icon object of the progressbar object
431 * @param obj The progressbar object
432 * @return The icon object
434 * @ingroup Progressbar
437 elm_progressbar_icon_get(const Evas_Object *obj)
439 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
440 Widget_Data *wd = elm_widget_data_get(obj);
441 if (!wd) return NULL;
446 * Unset the icon used for the progressbar object
448 * Unparent and return the icon object which was set for this widget.
450 * @param obj The progressbar object
451 * @return The icon object that was being used
453 * @ingroup Progressbar
456 elm_progressbar_icon_unset(Evas_Object *obj)
458 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
459 Widget_Data *wd = elm_widget_data_get(obj);
460 if (!wd) return NULL;
461 if (!wd->icon) return NULL;
462 Evas_Object *icon = wd->icon;
463 elm_widget_sub_object_del(obj, wd->icon);
464 edje_object_part_unswallow(wd->progressbar, wd->icon);
470 * Set the length of the progression region of the progressbar
472 * This sets the minimum width or height (depending on orientation) of the
473 * area of the progressbar that allows the progressbar to be dragged around. This in
474 * turn affects the objects minimum size (along with icon label and unit
477 * @param obj The progressbar object
478 * @param size The length of the progressbar area
480 * @ingroup Progressbar
483 elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size)
485 ELM_CHECK_WIDTYPE(obj, widtype);
486 Widget_Data *wd = elm_widget_data_get(obj);
488 if (wd->size == size) return;
491 evas_object_size_hint_min_set(wd->spacer, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale, 1);
493 evas_object_size_hint_min_set(wd->spacer, 1, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale);
494 edje_object_part_swallow(wd->progressbar, "elm.swallow.bar", wd->spacer);
499 * Get the length of the progression region of the progressbar
501 * @param obj The progressbar object
502 * @return The length of the progressbar area
504 * @ingroup Progressbar
507 elm_progressbar_span_size_get(const Evas_Object *obj)
509 ELM_CHECK_WIDTYPE(obj, widtype) 0;
510 Widget_Data *wd = elm_widget_data_get(obj);
516 * Set the format string of the unit area
518 * If NULL, this disabls the unit area display. If not it sets the format
519 * string for the unit text. The unit text is provided a floating point
520 * value, so the unit text can display up to 1 floating point falue. Note that
521 * this is optional. Use a format string such as "%1.2f meters" for example.
523 * @param obj The progressbar object
524 * @param units The format string for the units display
526 * @ingroup Progressbar
529 elm_progressbar_unit_format_set(Evas_Object *obj, const char *units)
531 ELM_CHECK_WIDTYPE(obj, widtype);
532 Widget_Data *wd = elm_widget_data_get(obj);
534 eina_stringshare_replace(&wd->units, units);
537 edje_object_signal_emit(wd->progressbar, "elm,state,units,visible", "elm");
538 edje_object_message_signal_process(wd->progressbar);
542 edje_object_signal_emit(wd->progressbar, "elm,state,units,hidden", "elm");
543 edje_object_message_signal_process(wd->progressbar);
550 * Get the format string of the unit area
552 * @param obj The progressbar object
553 * @return The format string for the units display
555 * @ingroup Progressbar
558 elm_progressbar_unit_format_get(const Evas_Object *obj)
560 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
561 Widget_Data *wd = elm_widget_data_get(obj);
562 if (!wd) return NULL;
567 * Set orientation of the progressbar
569 * @param obj The progressbar object
570 * @param horizontal If set, the progressbar will be horizontal
572 * @ingroup Progressbar
575 elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
577 ELM_CHECK_WIDTYPE(obj, widtype);
578 Widget_Data *wd = elm_widget_data_get(obj);
580 horizontal = !!horizontal;
581 if (wd->horizontal == horizontal) return;
582 wd->horizontal = horizontal;
587 * Gets orientation of the progressbar
589 * @param obj The progressbar object
590 * @return The orientation
591 * (0 = vertical, 1 = horizontal)
593 * @ingroup Progressbar
596 elm_progressbar_horizontal_get(const Evas_Object *obj)
598 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
599 Widget_Data *wd = elm_widget_data_get(obj);
600 if (!wd) return EINA_FALSE;
601 return wd->horizontal;
605 * Invert the progressbar display
607 * Normally the progressbar will display and interpret values from low to high
608 * and when horizontal that is left to right. When vertical that is top
609 * to bottom. This inverts this (so from right to left or bottom to top) if
610 * inverted is set to 1.
612 * @param obj The progressbar object
613 * @param inverted The inverted flag. 1 == inverted, 0 == normal
615 * @ingroup Progressbar
618 elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted)
620 ELM_CHECK_WIDTYPE(obj, widtype);
621 Widget_Data *wd = elm_widget_data_get(obj);
623 inverted = !!inverted;
624 if (wd->inverted == inverted) return;
625 wd->inverted = inverted;
627 edje_object_signal_emit(wd->progressbar, "elm,state,inverted,on", "elm");
629 edje_object_signal_emit(wd->progressbar, "elm,state,inverted,off", "elm");
630 edje_object_message_signal_process(wd->progressbar);
636 * Gets if the progressbar will displayed inverted
638 * @param obj The progressbar object
639 * @return The inverted flag
640 * (1 == inverted, 0 == normal)
642 * @ingroup Progressbar
645 elm_progressbar_inverted_get(const Evas_Object *obj)
647 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
648 Widget_Data *wd = elm_widget_data_get(obj);
649 if (!wd) return EINA_FALSE;