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