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 _elm_progressbar_label_set(Evas_Object *obj, const char *item, const char *label)
193 ELM_CHECK_WIDTYPE(obj, widtype);
194 Widget_Data *wd = elm_widget_data_get(obj);
195 if (item && strcmp(item, "default")) return;
197 eina_stringshare_replace(&wd->label, label);
200 edje_object_signal_emit(wd->progressbar, "elm,state,text,visible", "elm");
201 edje_object_message_signal_process(wd->progressbar);
205 edje_object_signal_emit(wd->progressbar, "elm,state,text,hidden", "elm");
206 edje_object_message_signal_process(wd->progressbar);
208 edje_object_part_text_set(wd->progressbar, "elm.text", label);
213 _elm_progressbar_label_get(const Evas_Object *obj, const char *item)
215 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
216 Widget_Data *wd = elm_widget_data_get(obj);
217 if (item && strcmp(item, "default")) return NULL;
218 if (!wd) return NULL;
223 * Add a new progressbar to the parent
225 * @param parent The parent object
226 * @return The new object or NULL if it cannot be created
228 * @ingroup Progressbar
231 elm_progressbar_add(Evas_Object *parent)
237 ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
239 ELM_SET_WIDTYPE(widtype, "progressbar");
240 elm_widget_type_set(obj, "progressbar");
241 elm_widget_sub_object_add(parent, obj);
242 elm_widget_data_set(obj, wd);
243 elm_widget_del_hook_set(obj, _del_hook);
244 elm_widget_theme_hook_set(obj, _theme_hook);
245 elm_widget_can_focus_set(obj, EINA_FALSE);
246 elm_widget_text_set_hook_set(obj, _elm_progressbar_label_set);
247 elm_widget_text_get_hook_set(obj, _elm_progressbar_label_get);
249 wd->horizontal = EINA_TRUE;
250 wd->inverted = EINA_FALSE;
251 wd->pulse = EINA_FALSE;
252 wd->pulse_state = EINA_FALSE;
253 wd->units = eina_stringshare_add("%.0f %%");
254 wd->val = MIN_RATIO_LVL;
256 wd->progressbar = edje_object_add(e);
257 _elm_theme_object_set(obj, wd->progressbar, "progressbar", "horizontal", "default");
258 elm_widget_resize_object_set(obj, wd->progressbar);
260 wd->spacer = evas_object_rectangle_add(e);
261 evas_object_color_set(wd->spacer, 0, 0, 0, 0);
262 evas_object_pass_events_set(wd->spacer, EINA_TRUE);
263 elm_widget_sub_object_add(obj, wd->spacer);
264 edje_object_part_swallow(wd->progressbar, "elm.swallow.bar", wd->spacer);
266 evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
269 _mirrored_set(obj, elm_widget_mirrored_get(obj));
275 * Normally the progressbar will display and interpret values from low to high.
276 * This display a progressbar for jobs with unknow state of progression,
277 * (the cursor pulse right to left and left to right, and loop) if pulse is set to 1.
279 * @param obj The progressbar object
280 * @param pulse The pulse flag. 1 == pulse, 0 == normal
282 * @ingroup Progressbar
285 elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse)
287 ELM_CHECK_WIDTYPE(obj, widtype);
288 Widget_Data *wd = elm_widget_data_get(obj);
291 if (wd->pulse == pulse) return;
297 * Normally the progressbar will display and interpret values from low to high.
298 * This display a progressbar for jobs with unknow state of progression,
299 * (the cursor pulse right to left and left to right, and loop) if pulse is set to 1.
301 * @param obj The progressbar object
302 * @return The pulse flag
303 * (1 == pulse, 0 == normal)
305 * @ingroup Progressbar
308 elm_progressbar_pulse_get(const Evas_Object *obj)
310 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
311 Widget_Data *wd = elm_widget_data_get(obj);
312 if (!wd) return EINA_FALSE;
317 * Stat/Stop de pulse action
319 * @param obj The progressbar object
320 * @param state The pulse flag. 1 == start pulse, 0 == stop pulse
322 * @ingroup Progressbar
325 elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state)
327 ELM_CHECK_WIDTYPE(obj, widtype);
328 Widget_Data *wd = elm_widget_data_get(obj);
331 if ((!wd->pulse) && (wd->pulse_state == state)) return;
332 wd->pulse_state = state;
334 edje_object_signal_emit(wd->progressbar, "elm,state,pulse,start", "elm");
336 edje_object_signal_emit(wd->progressbar, "elm,state,pulse,stop", "elm");
340 * Set the value the progressbar indicates
342 * @param obj The progressbar object
343 * @param val The fraction value (must be between 0.0 and 1.0)
345 * @ingroup Progressbar
348 elm_progressbar_value_set(Evas_Object *obj, double val)
350 ELM_CHECK_WIDTYPE(obj, widtype);
351 Widget_Data *wd = elm_widget_data_get(obj);
353 if (wd->val == val) return;
355 if (wd->val < MIN_RATIO_LVL) wd->val = MIN_RATIO_LVL;
356 if (wd->val > MAX_RATIO_LVL) wd->val = MAX_RATIO_LVL;
363 * Get the value the progressbar has
365 * @param obj The progressbar object
366 * @return The value of the progressbar
368 * @ingroup Progressbar
371 elm_progressbar_value_get(const Evas_Object *obj)
373 ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
374 Widget_Data *wd = elm_widget_data_get(obj);
380 * Set the label of the progressbar
382 * @param obj The progressbar object
383 * @param label The text label string in UTF-8
385 * @ingroup Progressbar
386 * @deprecated use elm_object_text_set() instead.
389 elm_progressbar_label_set(Evas_Object *obj, const char *label)
391 _elm_progressbar_label_set(obj, NULL, label);
395 * Get the label of the progressbar
397 * @param obj The progressbar object
398 * @return The text label string in UTF-8
400 * @ingroup Progressbar
401 * @deprecated use elm_object_text_set() instead.
404 elm_progressbar_label_get(const Evas_Object *obj)
406 return _elm_progressbar_label_get(obj, NULL);
410 * Set the icon object of the progressbar object
412 * Once the icon object is set, a previously set one will be deleted.
413 * If you want to keep that old content object, use the
414 * elm_progressbar_icon_unset() function.
416 * @param obj The progressbar object
417 * @param icon The icon object
419 * @ingroup Progressbar
422 elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon)
424 ELM_CHECK_WIDTYPE(obj, widtype);
425 Widget_Data *wd = elm_widget_data_get(obj);
427 if (wd->icon == icon) return;
428 if (wd->icon) evas_object_del(wd->icon);
432 elm_widget_sub_object_add(obj, icon);
433 evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
434 _changed_size_hints, obj);
435 edje_object_part_swallow(wd->progressbar, "elm.swallow.content", icon);
436 edje_object_signal_emit(wd->progressbar, "elm,state,icon,visible", "elm");
437 edje_object_message_signal_process(wd->progressbar);
443 * Get the icon object of the progressbar object
445 * @param obj The progressbar object
446 * @return The icon object
448 * @ingroup Progressbar
451 elm_progressbar_icon_get(const Evas_Object *obj)
453 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
454 Widget_Data *wd = elm_widget_data_get(obj);
455 if (!wd) return NULL;
460 * Unset the icon used for the progressbar object
462 * Unparent and return the icon object which was set for this widget.
464 * @param obj The progressbar object
465 * @return The icon object that was being used
467 * @ingroup Progressbar
470 elm_progressbar_icon_unset(Evas_Object *obj)
472 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
473 Widget_Data *wd = elm_widget_data_get(obj);
474 if (!wd) return NULL;
475 if (!wd->icon) return NULL;
476 Evas_Object *icon = wd->icon;
477 elm_widget_sub_object_del(obj, wd->icon);
478 edje_object_part_unswallow(wd->progressbar, wd->icon);
484 * Set the length of the progression region of the progressbar
486 * This sets the minimum width or height (depending on orientation) of the
487 * area of the progressbar that allows the progressbar to be dragged around. This in
488 * turn affects the objects minimum size (along with icon label and unit
491 * @param obj The progressbar object
492 * @param size The length of the progressbar area
494 * @ingroup Progressbar
497 elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size)
499 ELM_CHECK_WIDTYPE(obj, widtype);
500 Widget_Data *wd = elm_widget_data_get(obj);
502 if (wd->size == size) return;
505 evas_object_size_hint_min_set(wd->spacer, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale, 1);
507 evas_object_size_hint_min_set(wd->spacer, 1, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale);
508 edje_object_part_swallow(wd->progressbar, "elm.swallow.bar", wd->spacer);
513 * Get the length of the progression region of the progressbar
515 * @param obj The progressbar object
516 * @return The length of the progressbar area
518 * @ingroup Progressbar
521 elm_progressbar_span_size_get(const Evas_Object *obj)
523 ELM_CHECK_WIDTYPE(obj, widtype) 0;
524 Widget_Data *wd = elm_widget_data_get(obj);
530 * Set the format string of the unit area
532 * If NULL, this disabls the unit area display. If not it sets the format
533 * string for the unit text. The unit text is provided a floating point
534 * value, so the unit text can display up to 1 floating point falue. Note that
535 * this is optional. Use a format string such as "%1.2f meters" for example.
537 * @param obj The progressbar object
538 * @param units The format string for the units display
540 * @ingroup Progressbar
543 elm_progressbar_unit_format_set(Evas_Object *obj, const char *units)
545 ELM_CHECK_WIDTYPE(obj, widtype);
546 Widget_Data *wd = elm_widget_data_get(obj);
548 eina_stringshare_replace(&wd->units, units);
551 edje_object_signal_emit(wd->progressbar, "elm,state,units,visible", "elm");
552 edje_object_message_signal_process(wd->progressbar);
556 edje_object_signal_emit(wd->progressbar, "elm,state,units,hidden", "elm");
557 edje_object_message_signal_process(wd->progressbar);
564 * Get the format string of the unit area
566 * @param obj The progressbar object
567 * @return The format string for the units display
569 * @ingroup Progressbar
572 elm_progressbar_unit_format_get(const Evas_Object *obj)
574 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
575 Widget_Data *wd = elm_widget_data_get(obj);
576 if (!wd) return NULL;
581 * Set orientation of the progressbar
583 * @param obj The progressbar object
584 * @param horizontal If set, the progressbar will be horizontal
586 * @ingroup Progressbar
589 elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
591 ELM_CHECK_WIDTYPE(obj, widtype);
592 Widget_Data *wd = elm_widget_data_get(obj);
594 horizontal = !!horizontal;
595 if (wd->horizontal == horizontal) return;
596 wd->horizontal = horizontal;
601 * Gets orientation of the progressbar
603 * @param obj The progressbar object
604 * @return The orientation
605 * (0 = vertical, 1 = horizontal)
607 * @ingroup Progressbar
610 elm_progressbar_horizontal_get(const Evas_Object *obj)
612 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
613 Widget_Data *wd = elm_widget_data_get(obj);
614 if (!wd) return EINA_FALSE;
615 return wd->horizontal;
619 * Invert the progressbar display
621 * Normally the progressbar will display and interpret values from low to high
622 * and when horizontal that is left to right. When vertical that is top
623 * to bottom. This inverts this (so from right to left or bottom to top) if
624 * inverted is set to 1.
626 * @param obj The progressbar object
627 * @param inverted The inverted flag. 1 == inverted, 0 == normal
629 * @ingroup Progressbar
632 elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted)
634 ELM_CHECK_WIDTYPE(obj, widtype);
635 Widget_Data *wd = elm_widget_data_get(obj);
637 inverted = !!inverted;
638 if (wd->inverted == inverted) return;
639 wd->inverted = inverted;
641 edje_object_signal_emit(wd->progressbar, "elm,state,inverted,on", "elm");
643 edje_object_signal_emit(wd->progressbar, "elm,state,inverted,off", "elm");
644 edje_object_message_signal_process(wd->progressbar);
650 * Gets if the progressbar will displayed inverted
652 * @param obj The progressbar object
653 * @return The inverted flag
654 * (1 == inverted, 0 == normal)
656 * @ingroup Progressbar
659 elm_progressbar_inverted_get(const Evas_Object *obj)
661 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
662 Widget_Data *wd = elm_widget_data_get(obj);
663 if (!wd) return EINA_FALSE;