src/lib/elm_slider.c

   1 #include <Elementary.h>
   2 #include "elm_priv.h"
   3
   4 /**
   5  * @defgroup Slider Slider
   6  *
   7  * The slider adds a dragable “slider” widget for selecting the value of
   8  * something within a range.
   9  *
  10  * Signals that you can add callbacks for are:
  11  *
  12  * changed - Whenever the slider value is changed by the user.
  13  *
  14  * delay,changed - A short time after the value is changed by the user.
  15  * This will be called only when the user stops dragging for a very short
  16  * period or when they release their finger/mouse, so it avoids possibly
  17  * expensive reactions to the value change.
  18  *
  19  * slider,drag,start - dragging the slider indicator around has started
  20  *
  21  * slider,drag,stop - dragging the slider indicator around has stopped
  22  *
  23  * A slider can be horizontal or vertical. It can contain an Icon and has a
  24  * primary label as well as a units label (that is formatted with floating
  25  * point values and thus accepts a printf-style format string, like
  26  * “%1.2f units”. There is also an indicator string that may be somewhere
  27  * else (like on the slider itself) that also accepts a format string like
  28  * units. Label, Icon Unit and Indicator strings/objects are optional.
  29  *
  30  * A slider may be inverted which means values invert, with high vales being
  31  * on the left or top and low values on the right or bottom (as opposed to
  32  * normally being low on the left or top and high on the bottom and right).
  33  *
  34  * The slider should have its minimum and maximum values set by the
  35  * application with  elm_slider_min_max_set() and value should also be set by
  36  * the application before use with  elm_slider_value_set(). The span of the
  37  * slider is its length (horizontally or vertically). This will be scaled by
  38  * the object or applications scaling factor. At any point code can query the
  39  * slider for its value with elm_slider_value_get().
  40  */
  41
  42 typedef struct _Widget_Data Widget_Data;
  43
  44 struct _Widget_Data
  45 {
  46    Evas_Object *slider;
  47    Evas_Object *icon;
  48    Evas_Object *end;
  49    Evas_Object *spacer;
  50    const char *label;
  51    const char *units;
  52    const char *indicator;
  53    const char *(*indicator_format_func)(double val);
  54    Eina_Bool horizontal : 1;
  55    Eina_Bool inverted : 1;
  56    Eina_Bool indicator_show : 1;
  57    double val, val_min, val_max;
  58    Ecore_Timer *delay;
  59    Evas_Coord size;
  60 };
  61
  62 #define ELM_SLIDER_INVERTED_FACTOR (-1.0)
  63
  64 static const char *widtype = NULL;
  65 static void _del_hook(Evas_Object *obj);
  66 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
  67 static void _theme_hook(Evas_Object *obj);
  68 static void _disable_hook(Evas_Object *obj);
  69 static void _sizing_eval(Evas_Object *obj);
  70 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
  71 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
  72 static void _units_set(Evas_Object *obj);
  73 static void _val_set(Evas_Object *obj);
  74 static void _indicator_set(Evas_Object *obj);
  75 static void _on_focus_hook(void *data, Evas_Object *obj);
  76 static void _drag_up(void *data, Evas_Object *obj,
  77                     const char *emission, const char *source);
  78 static void _drag_down(void *data, Evas_Object *obj,
  79                     const char *emission, const char *source);
  80 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
  81                              Evas_Callback_Type type, void *event_info);
  82 static void _spacer_cb(void *data, Evas * e, Evas_Object * obj, void *event_info);
  83
  84 static const char SIG_CHANGED[] = "changed";
  85 static const char SIG_DELAY_CHANGED[] = "delay,changed";
  86 static const char SIG_DRAG_START[] = "slider,drag,start";
  87 static const char SIG_DRAG_STOP[] = "slider,drag,stop";
  88 static const Evas_Smart_Cb_Description _signals[] = {
  89   {SIG_CHANGED, ""},
  90   {SIG_DELAY_CHANGED, ""},
  91   {SIG_DRAG_START, ""},
  92   {SIG_DRAG_STOP, ""},
  93   {NULL, NULL}
  94 };
  95
  96 static Eina_Bool
  97 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
  98 {
  99    Evas_Event_Mouse_Wheel *mev;
 100    Evas_Event_Key_Down *ev;
 101    Widget_Data *wd;
 102
 103    wd = elm_widget_data_get(obj);
 104    if (!wd) return EINA_FALSE;
 105
 106    if (type == EVAS_CALLBACK_KEY_DOWN) goto key_down;
 107    else if (type != EVAS_CALLBACK_MOUSE_WHEEL) return EINA_FALSE;
 108
 109    mev = event_info;
 110    if (mev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
 111    if (elm_widget_disabled_get(obj)) return EINA_FALSE;
 112
 113    if (mev->z < 0) _drag_up(obj, NULL, NULL, NULL);
 114    else _drag_down(obj, NULL, NULL, NULL);
 115    mev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
 116    return EINA_TRUE;
 117
 118   key_down:
 119    ev = event_info;
 120    if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
 121    if (elm_widget_disabled_get(obj)) return EINA_FALSE;
 122    if ((!strcmp(ev->keyname, "Left"))
 123        || (!strcmp(ev->keyname, "KP_Left")))
 124      {
 125         if (!wd->horizontal) return EINA_FALSE;
 126         if (!wd->inverted) _drag_down(obj, NULL, NULL, NULL);
 127         else _drag_up(obj, NULL, NULL, NULL);
 128         ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
 129         return EINA_TRUE;
 130      }
 131    else if ((!strcmp(ev->keyname, "Right"))
 132             || (!strcmp(ev->keyname, "KP_Right")))
 133      {
 134         if (!wd->horizontal) return EINA_FALSE;
 135         if (!wd->inverted) _drag_up(obj, NULL, NULL, NULL);
 136         else _drag_down(obj, NULL, NULL, NULL);
 137         ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
 138         return EINA_TRUE;
 139      }
 140    else if ((!strcmp(ev->keyname, "Up")) || (!strcmp(ev->keyname, "KP_Up")))
 141      {
 142         if (wd->horizontal) return EINA_FALSE;
 143         if (wd->inverted) _drag_up(obj, NULL, NULL, NULL);
 144         else _drag_down(obj, NULL, NULL, NULL);
 145         ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
 146         return EINA_TRUE;
 147      }
 148    else if ((!strcmp(ev->keyname, "Down")) || (!strcmp(ev->keyname, "KP_Down")))
 149      {
 150         if (wd->horizontal) return EINA_FALSE;
 151         if (wd->inverted) _drag_down(obj, NULL, NULL, NULL);
 152         else _drag_up(obj, NULL, NULL, NULL);
 153         ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
 154         return EINA_TRUE;
 155      }
 156    else return EINA_FALSE;
 157 }
 158
 159 static void
 160 _del_hook(Evas_Object *obj)
 161 {
 162    Widget_Data *wd = elm_widget_data_get(obj);
 163    if (!wd) return;
 164    if (wd->label) eina_stringshare_del(wd->label);
 165    if (wd->indicator) eina_stringshare_del(wd->units);
 166    if (wd->delay) ecore_timer_del(wd->delay);
 167    free(wd);
 168 }
 169
 170 static void
 171 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
 172 {
 173    Widget_Data *wd = elm_widget_data_get(obj);
 174    if (!wd) return;
 175    if (elm_widget_focus_get(obj))
 176      {
 177         edje_object_signal_emit(wd->slider, "elm,action,focus", "elm");
 178         evas_object_focus_set(wd->slider, EINA_TRUE);
 179      }
 180    else
 181      {
 182         edje_object_signal_emit(wd->slider, "elm,action,unfocus", "elm");
 183         evas_object_focus_set(wd->slider, EINA_FALSE);
 184      }
 185 }
 186
 187 static void
 188 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
 189 {
 190    Widget_Data *wd = elm_widget_data_get(obj);
 191    if (!wd) return;
 192    edje_object_mirrored_set(wd->slider, rtl);
 193 }
 194
 195 static void
 196 _theme_hook(Evas_Object *obj)
 197 {
 198    Widget_Data *wd = elm_widget_data_get(obj);
 199    if (!wd) return;
 200    _elm_widget_mirrored_reload(obj);
 201    _mirrored_set(obj, elm_widget_mirrored_get(obj));
 202    if (wd->horizontal)
 203      _elm_theme_object_set(obj, wd->slider, "slider", "horizontal", elm_widget_style_get(obj));
 204    else
 205      _elm_theme_object_set(obj, wd->slider, "slider", "vertical", elm_widget_style_get(obj));
 206    if (wd->icon)
 207      {
 208         edje_object_part_swallow(wd->slider, "elm.swallow.content", wd->icon);
 209         edje_object_signal_emit(wd->slider, "elm,state,icon,visible", "elm");
 210      }
 211    if (wd->end)
 212      edje_object_signal_emit(wd->slider, "elm,state,end,visible", "elm");
 213    else
 214      edje_object_signal_emit(wd->slider, "elm,state,end,hidden", "elm");
 215    if (wd->label)
 216      {
 217         edje_object_part_text_set(wd->slider, "elm.text", wd->label);
 218         edje_object_signal_emit(wd->slider, "elm,state,text,visible", "elm");
 219      }
 220
 221    if (wd->units)
 222      edje_object_signal_emit(wd->slider, "elm,state,units,visible", "elm");
 223
 224    if (wd->horizontal)
 225      evas_object_size_hint_min_set(wd->spacer, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale, 1);
 226    else
 227      evas_object_size_hint_min_set(wd->spacer, 1, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale);
 228
 229    if (wd->inverted)
 230       edje_object_signal_emit(wd->slider, "elm,state,inverted,on", "elm");
 231
 232    edje_object_part_swallow(wd->slider, "elm.swallow.bar", wd->spacer);
 233    _units_set(obj);
 234    _indicator_set(obj);
 235    edje_object_message_signal_process(wd->slider);
 236    edje_object_scale_set(wd->slider, elm_widget_scale_get(obj) * _elm_config->scale);
 237    _val_set(obj);
 238    _sizing_eval(obj);
 239 }
 240
 241 static void
 242 _disable_hook(Evas_Object *obj)
 243 {
 244    Widget_Data *wd = elm_widget_data_get(obj);
 245    if (!wd) return;
 246    if (elm_widget_disabled_get(obj))
 247       edje_object_signal_emit(wd->slider, "elm,state,disabled", "elm");
 248    else
 249       edje_object_signal_emit(wd->slider, "elm,state,enabled", "elm");
 250 }
 251
 252 static void
 253 _sizing_eval(Evas_Object *obj)
 254 {
 255    Widget_Data *wd = elm_widget_data_get(obj);
 256    Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
 257    if (!wd) return;
 258    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 259    edje_object_size_min_restricted_calc(wd->slider, &minw, &minh, minw, minh);
 260    elm_coords_finger_size_adjust(1, &minw, 1, &minh);
 261    evas_object_size_hint_min_set(obj, minw, minh);
 262    evas_object_size_hint_max_set(obj, maxw, maxh);
 263 }
 264
 265 static void
 266 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
 267 {
 268    Widget_Data *wd = elm_widget_data_get(data);
 269    if (!wd) return;
 270    if ((obj != wd->icon) && (obj != wd->end)) return;
 271    _sizing_eval(data);
 272 }
 273
 274 static void
 275 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
 276 {
 277    Widget_Data *wd = elm_widget_data_get(obj);
 278    Evas_Object *sub = event_info;
 279    if (!wd) return;
 280    if (sub == wd->icon)
 281      {
 282         edje_object_signal_emit(wd->slider, "elm,state,icon,hidden", "elm");
 283         evas_object_event_callback_del_full
 284           (sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
 285         wd->icon = NULL;
 286         edje_object_message_signal_process(wd->slider);
 287         _sizing_eval(obj);
 288      }
 289    if (sub == wd->end)
 290      {
 291         edje_object_signal_emit(wd->slider, "elm,state,end,hidden", "elm");
 292         evas_object_event_callback_del_full(sub,
 293                                             EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 294                                             _changed_size_hints, obj);
 295         wd->end = NULL;
 296         edje_object_message_signal_process(wd->slider);
 297         _sizing_eval(obj);
 298      }
 299 }
 300
 301 static Eina_Bool
 302 _delay_change(void *data)
 303 {
 304    Widget_Data *wd = elm_widget_data_get(data);
 305    if (!wd) return ECORE_CALLBACK_CANCEL;
 306    wd->delay = NULL;
 307    evas_object_smart_callback_call(data, SIG_DELAY_CHANGED, NULL);
 308    return ECORE_CALLBACK_CANCEL;
 309 }
 310
 311 static void
 312 _val_fetch(Evas_Object *obj)
 313 {
 314    Eina_Bool rtl;
 315    Widget_Data *wd = elm_widget_data_get(obj);
 316    double posx = 0.0, posy = 0.0, pos = 0.0, val;
 317    if (!wd) return;
 318    edje_object_part_drag_value_get(wd->slider, "elm.dragable.slider",
 319                                    &posx, &posy);
 320    if (wd->horizontal) pos = posx;
 321    else pos = posy;
 322
 323    rtl = elm_widget_mirrored_get(obj);
 324    if ((!rtl && wd->inverted) || (rtl &&
 325             ((!wd->horizontal && wd->inverted) ||
 326              (wd->horizontal && !wd->inverted)))) pos = 1.0 - pos;
 327    val = (pos * (wd->val_max - wd->val_min)) + wd->val_min;
 328    if (val != wd->val)
 329      {
 330         wd->val = val;
 331         evas_object_smart_callback_call(obj, SIG_CHANGED, NULL);
 332         if (wd->delay) ecore_timer_del(wd->delay);
 333         wd->delay = ecore_timer_add(0.2, _delay_change, obj);
 334      }
 335 }
 336
 337 static void
 338 _val_set(Evas_Object *obj)
 339 {
 340    Eina_Bool rtl;
 341    Widget_Data *wd = elm_widget_data_get(obj);
 342    double pos;
 343    if (!wd) return;
 344    if (wd->val_max > wd->val_min)
 345      pos = (wd->val - wd->val_min) / (wd->val_max - wd->val_min);
 346    else
 347      pos = 0.0;
 348    if (pos < 0.0) pos = 0.0;
 349    else if (pos > 1.0) pos = 1.0;
 350
 351    rtl = elm_widget_mirrored_get(obj);
 352    if ((!rtl && wd->inverted) || (rtl &&
 353             ((!wd->horizontal && wd->inverted) ||
 354              (wd->horizontal && !wd->inverted)))) pos = 1.0 - pos;
 355    edje_object_part_drag_value_set(wd->slider, "elm.dragable.slider", pos, pos);
 356 }
 357
 358 static void
 359 _units_set(Evas_Object *obj)
 360 {
 361    Widget_Data *wd = elm_widget_data_get(obj);
 362    if (!wd) return;
 363    if (wd->units)
 364      {
 365         char buf[1024];
 366
 367         snprintf(buf, sizeof(buf), wd->units, wd->val);
 368         edje_object_part_text_set(wd->slider, "elm.units", buf);
 369      }
 370    else
 371      edje_object_part_text_set(wd->slider, "elm.units", NULL);
 372 }
 373
 374 static void
 375 _indicator_set(Evas_Object *obj)
 376 {
 377    Widget_Data *wd = elm_widget_data_get(obj);
 378    if (!wd) return;
 379    if (wd->indicator_format_func)
 380      {
 381         const char *buf;
 382         buf = wd->indicator_format_func(wd->val);
 383         edje_object_part_text_set(wd->slider, "elm.dragable.slider:elm.indicator", buf);
 384      }
 385    else if (wd->indicator)
 386      {
 387         char buf[1024];
 388         snprintf(buf, sizeof(buf), wd->indicator, wd->val);
 389         edje_object_part_text_set(wd->slider, "elm.dragable.slider:elm.indicator", buf);
 390      }
 391    else
 392      edje_object_part_text_set(wd->slider, "elm.dragable.slider:elm.indicator", NULL);
 393 }
 394
 395 static void
 396 _drag(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 397 {
 398    _val_fetch(data);
 399    _units_set(data);
 400    _indicator_set(data);
 401 }
 402
 403 static void
 404 _drag_start(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 405 {
 406    _val_fetch(data);
 407    evas_object_smart_callback_call(data, SIG_DRAG_START, NULL);
 408    _units_set(data);
 409    _indicator_set(data);
 410    elm_widget_scroll_freeze_push(data);
 411 }
 412
 413 static void
 414 _drag_stop(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 415 {
 416    _val_fetch(data);
 417    evas_object_smart_callback_call(data, SIG_DRAG_STOP, NULL);
 418    _units_set(data);
 419    _indicator_set(data);
 420    elm_widget_scroll_freeze_pop(data);
 421 }
 422
 423 static void
 424 _drag_step(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 425 {
 426    _val_fetch(data);
 427    _units_set(data);
 428    _indicator_set(data);
 429 }
 430
 431 static void
 432 _drag_up(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 433 {
 434    double step;
 435    Widget_Data *wd;
 436
 437    wd = elm_widget_data_get(data);
 438    step = 0.05;
 439
 440    if (wd->inverted) step *= ELM_SLIDER_INVERTED_FACTOR;
 441
 442    edje_object_part_drag_step(wd->slider, "elm.dragable.slider", step, step);
 443 }
 444
 445 static void
 446 _drag_down(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
 447 {
 448    double step;
 449    Widget_Data *wd;
 450
 451    wd = elm_widget_data_get(data);
 452    step = -0.05;
 453
 454    if (wd->inverted) step *= ELM_SLIDER_INVERTED_FACTOR;
 455
 456    edje_object_part_drag_step(wd->slider, "elm.dragable.slider", step, step);
 457 }
 458
 459 static void
 460 _spacer_cb(void *data, Evas *e, Evas_Object *obj __UNUSED__, void *event_info)
 461 {
 462    Widget_Data *wd = elm_widget_data_get(data);
 463    Evas_Event_Mouse_Down *ev = event_info;
 464    Evas_Coord x, y, w, h;
 465    double button_x, button_y;
 466
 467    evas_object_geometry_get(wd->spacer, &x, &y, &w, &h);
 468    edje_object_part_drag_value_get(wd->slider, "elm.dragable.slider", &button_x, &button_y);
 469    if (wd->horizontal)
 470      {
 471         button_x = ((double)ev->output.x - (double)x) / (double)w;
 472         if (button_x > 1) button_x = 1;
 473         if (button_x < 0) button_x = 0;
 474      }
 475    else
 476      {
 477         button_y = ((double)ev->output.y - (double)y) / (double)h;
 478         if (button_y > 1) button_y = 1;
 479         if (button_y < 0) button_y = 0;
 480      }
 481    edje_object_part_drag_value_set(wd->slider, "elm.dragable.slider", button_x, button_y);
 482    evas_event_feed_mouse_cancel(e, 0, NULL);
 483    evas_event_feed_mouse_down(e, 1, EVAS_BUTTON_NONE, 0, NULL);
 484 }
 485
 486 /**
 487  * Add a new slider to the parent
 488  *
 489  * @param parent The parent object
 490  * @return The new object or NULL if it cannot be created
 491  *
 492  * @ingroup Slider
 493  */
 494 EAPI Evas_Object *
 495 elm_slider_add(Evas_Object *parent)
 496 {
 497    Evas_Object *obj;
 498    Evas *e;
 499    Widget_Data *wd;
 500
 501    EINA_SAFETY_ON_NULL_RETURN_VAL(parent, NULL);
 502
 503    wd = ELM_NEW(Widget_Data);
 504    e = evas_object_evas_get(parent);
 505    if (!e) return NULL;
 506    obj = elm_widget_add(e);
 507    ELM_SET_WIDTYPE(widtype, "slider");
 508    elm_widget_type_set(obj, "slider");
 509    elm_widget_sub_object_add(parent, obj);
 510    elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
 511    elm_widget_data_set(obj, wd);
 512    elm_widget_del_hook_set(obj, _del_hook);
 513    elm_widget_theme_hook_set(obj, _theme_hook);
 514    elm_widget_disable_hook_set(obj, _disable_hook);
 515    elm_widget_can_focus_set(obj, EINA_TRUE);
 516    elm_widget_event_hook_set(obj, _event_hook);
 517
 518    wd->horizontal = EINA_TRUE;
 519    wd->indicator_show = EINA_TRUE;
 520    wd->val = 0.0;
 521    wd->val_min = 0.0;
 522    wd->val_max = 1.0;
 523
 524    wd->slider = edje_object_add(e);
 525    _elm_theme_object_set(obj, wd->slider, "slider", "horizontal", "default");
 526    elm_widget_resize_object_set(obj, wd->slider);
 527    edje_object_signal_callback_add(wd->slider, "drag", "*", _drag, obj);
 528    edje_object_signal_callback_add(wd->slider, "drag,start", "*", _drag_start, obj);
 529    edje_object_signal_callback_add(wd->slider, "drag,stop", "*", _drag_stop, obj);
 530    edje_object_signal_callback_add(wd->slider, "drag,step", "*", _drag_step, obj);
 531    edje_object_signal_callback_add(wd->slider, "drag,page", "*", _drag_stop, obj);
 532 //   edje_object_signal_callback_add(wd->slider, "drag,set", "*", _drag_stop, obj);
 533    edje_object_part_drag_value_set(wd->slider, "elm.dragable.slider", 0.0, 0.0);
 534
 535    wd->spacer = evas_object_rectangle_add(e);
 536    evas_object_color_set(wd->spacer, 0, 0, 0, 0);
 537    evas_object_pass_events_set(wd->spacer, EINA_TRUE);
 538    elm_widget_sub_object_add(obj, wd->spacer);
 539    edje_object_part_swallow(wd->slider, "elm.swallow.bar", wd->spacer);
 540    evas_object_event_callback_add(wd->spacer, EVAS_CALLBACK_MOUSE_DOWN, _spacer_cb, obj);
 541    evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
 542
 543    _mirrored_set(obj, elm_widget_mirrored_get(obj));
 544    _sizing_eval(obj);
 545
 546    // TODO: convert Elementary to subclassing of Evas_Smart_Class
 547    // TODO: and save some bytes, making descriptions per-class and not instance!
 548    evas_object_smart_callbacks_descriptions_set(obj, _signals);
 549    return obj;
 550 }
 551
 552 /**
 553  * Set the label of the slider
 554  *
 555  * @param obj The slider object
 556  * @param label The text label string in UTF-8
 557  *
 558  * @ingroup Slider
 559  */
 560 EAPI void
 561 elm_slider_label_set(Evas_Object *obj, const char *label)
 562 {
 563    ELM_CHECK_WIDTYPE(obj, widtype);
 564    Widget_Data *wd = elm_widget_data_get(obj);
 565    if (!wd) return;
 566    eina_stringshare_replace(&wd->label, label);
 567    if (label)
 568      {
 569         edje_object_signal_emit(wd->slider, "elm,state,text,visible", "elm");
 570         edje_object_message_signal_process(wd->slider);
 571      }
 572    else
 573      {
 574         edje_object_signal_emit(wd->slider, "elm,state,text,hidden", "elm");
 575         edje_object_message_signal_process(wd->slider);
 576      }
 577    edje_object_part_text_set(wd->slider, "elm.text", label);
 578    _sizing_eval(obj);
 579 }
 580
 581 /**
 582  * Get the label of the slider
 583  *
 584  * @param obj The slider object
 585  * @return The text label string in UTF-8
 586  *
 587  * @ingroup Slider
 588  */
 589 EAPI const char *
 590 elm_slider_label_get(const Evas_Object *obj)
 591 {
 592    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 593    Widget_Data *wd = elm_widget_data_get(obj);
 594    if (!wd) return NULL;
 595    return wd->label;
 596 }
 597
 598 /**
 599  * Set the icon object (leftmost widget) of the slider object.
 600  *
 601  * Once the icon object is set, a previously set one will be deleted.
 602  * If you want to keep that old content object, use the
 603  * elm_slider_icon_unset() function.
 604  *
 605  * @param obj The slider object
 606  * @param icon The icon object
 607  *
 608  * @note If the object being set does not have minimum size hints set,
 609  * it won't get properly displayed.
 610  *
 611  * @ingroup Slider
 612  */
 613 EAPI void
 614 elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon)
 615 {
 616    ELM_CHECK_WIDTYPE(obj, widtype);
 617    Widget_Data *wd = elm_widget_data_get(obj);
 618    if (!wd) return;
 619    if (wd->icon == icon) return;
 620    if (wd->icon) evas_object_del(wd->icon);
 621    wd->icon = icon;
 622    if (icon)
 623      {
 624         elm_widget_sub_object_add(obj, icon);
 625         evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
 626                                        _changed_size_hints, obj);
 627         edje_object_part_swallow(wd->slider, "elm.swallow.icon", icon);
 628         edje_object_signal_emit(wd->slider, "elm,state,icon,visible", "elm");
 629         edje_object_message_signal_process(wd->slider);
 630      }
 631    _sizing_eval(obj);
 632 }
 633
 634 /**
 635  * Unset the leftmost widget of the slider, unparenting and
 636  * returning it.
 637  *
 638  * @param obj The slider object
 639  * @return the previously set icon sub-object of this slider, on
 640  * success.
 641  *
 642  * @see elm_slider_icon_set()
 643  *
 644  * @ingroup Slider
 645  */
 646 EAPI Evas_Object *
 647 elm_slider_icon_unset(Evas_Object *obj)
 648 {
 649    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 650    Widget_Data *wd = elm_widget_data_get(obj);
 651    Evas_Object *ret = NULL;
 652    if (!wd) return NULL;
 653    if (wd->icon)
 654      {
 655         elm_widget_sub_object_del(obj, wd->icon);
 656         ret = wd->icon;
 657         edje_object_part_unswallow(wd->slider, wd->icon);
 658         edje_object_signal_emit(wd->slider, "elm,state,icon,hidden", "elm");
 659         wd->icon = NULL;
 660         _sizing_eval(obj);
 661      }
 662    return ret;
 663 }
 664
 665 /**
 666  * Get the icon object of the slider object. This object is owned by
 667  * the scrolled entry and should not be modified.
 668  *
 669  * @param obj The slider object
 670  * @return The icon object
 671  *
 672  * @ingroup Slider
 673  */
 674 EAPI Evas_Object *
 675 elm_slider_icon_get(const Evas_Object *obj)
 676 {
 677    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 678    Widget_Data *wd = elm_widget_data_get(obj);
 679    if (!wd) return NULL;
 680    return wd->icon;
 681 }
 682
 683 /**
 684  * Set the length of the dragable region of the slider
 685  *
 686  * This sets the minimum width or height (depending on orientation) of the
 687  * area of the slider that allows the slider to be dragged around. This in
 688  * turn affects the objects minimum size (along with icon label and unit
 689  * text). Note that this will also get multiplied by the scale factor.
 690  *
 691  * @param obj The slider object
 692  * @param size The length of the slider area
 693  *
 694  * @ingroup Slider
 695  */
 696 EAPI void
 697 elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size)
 698 {
 699    ELM_CHECK_WIDTYPE(obj, widtype);
 700    Widget_Data *wd = elm_widget_data_get(obj);
 701    if (!wd) return;
 702    if (wd->size == size) return;
 703    wd->size = size;
 704    if (wd->horizontal)
 705      evas_object_size_hint_min_set(wd->spacer, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale, 1);
 706    else
 707      evas_object_size_hint_min_set(wd->spacer, 1, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale);
 708    if (wd->indicator_show)
 709        edje_object_signal_emit(wd->slider, "elm,state,val,show", "elm");
 710    else
 711        edje_object_signal_emit(wd->slider, "elm,state,val,hide", "elm");
 712    edje_object_part_swallow(wd->slider, "elm.swallow.bar", wd->spacer);
 713    _sizing_eval(obj);
 714 }
 715
 716 /**
 717  * Get the length of the dragable region of the slider
 718  *
 719  * This gets the minimum width or height (depending on orientation) of
 720  * the area of the slider that allows the slider to be dragged
 721  * around. Note that this will also get multiplied by the scale
 722  * factor.
 723  *
 724  * @param obj The slider object
 725  * @return The length of the slider area
 726  *
 727  * @ingroup Slider
 728  */
 729 EAPI Evas_Coord
 730 elm_slider_span_size_get(const Evas_Object *obj)
 731 {
 732    ELM_CHECK_WIDTYPE(obj, widtype) 0;
 733    Widget_Data *wd = elm_widget_data_get(obj);
 734    if (!wd) return 0;
 735    return wd->size;
 736 }
 737
 738 /**
 739  * Set the format string of the unit area
 740  *
 741  * If NULL, this disabls the unit area display. If not it sets the format
 742  * string for the unit text. The unit text is provided a floating point
 743  * value, so the unit text can display up to 1 floating point value. Note that
 744  * this is optional. Use a format string such as "%1.2f meters" for example.
 745  *
 746  * @param obj The slider object
 747  * @param units The format string for the units display
 748  *
 749  * @ingroup Slider
 750  */
 751 EAPI void
 752 elm_slider_unit_format_set(Evas_Object *obj, const char *units)
 753 {
 754    ELM_CHECK_WIDTYPE(obj, widtype);
 755    Widget_Data *wd = elm_widget_data_get(obj);
 756    if (!wd) return;
 757    eina_stringshare_replace(&wd->units, units);
 758    if (units)
 759      {
 760         edje_object_signal_emit(wd->slider, "elm,state,units,visible", "elm");
 761         edje_object_message_signal_process(wd->slider);
 762      }
 763    else
 764      {
 765         edje_object_signal_emit(wd->slider, "elm,state,units,hidden", "elm");
 766         edje_object_message_signal_process(wd->slider);
 767      }
 768    _units_set(obj);
 769    _sizing_eval(obj);
 770 }
 771
 772 /**
 773  * Get the format string for the unit area
 774  *
 775  * The slider may also display a value (the value of the slider) somewhere
 776  * (for example above the slider knob that is dragged around). This sets the
 777  * format string for this. See elm_slider_unit_format_set() for more
 778  * information on how this works.
 779  *
 780  * @param obj The slider object
 781  * @return The format string for the unit display.
 782  *
 783  * @ingroup Slider
 784  */
 785 EAPI const char *
 786 elm_slider_unit_format_get(const Evas_Object *obj)
 787 {
 788    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 789    Widget_Data *wd = elm_widget_data_get(obj);
 790    if (!wd) return NULL;
 791    return wd->units;
 792 }
 793
 794 /**
 795  * Set the format string for the indicator area
 796  *
 797  * The slider may also display a value (the value of the slider) somewhere
 798  * (for example above the slider knob that is dragged around). This sets the
 799  * format string for this. See elm_slider_unit_format_set() for more
 800  * information on how this works.
 801  *
 802  * @param obj The slider object
 803  * @param indicator The format string for the indicator display
 804  *
 805  * @ingroup Slider
 806  */
 807 EAPI void
 808 elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator)
 809 {
 810    ELM_CHECK_WIDTYPE(obj, widtype);
 811    Widget_Data *wd = elm_widget_data_get(obj);
 812    if (!wd) return;
 813    eina_stringshare_replace(&wd->indicator, indicator);
 814    _indicator_set(obj);
 815 }
 816
 817 /**
 818  * Get the format string for the indicator area
 819  *
 820  * The slider may also display a value (the value of the slider) somewhere
 821  * (for example above the slider knob that is dragged around). This sets the
 822  * format string for this. See elm_slider_indicator_format_set() for more
 823  * information on how this works.
 824  *
 825  * @param obj The slider object
 826  * @return The format string for the indicator display.
 827  *
 828  * @ingroup Slider
 829  */
 830 EAPI const char *
 831 elm_slider_indicator_format_get(const Evas_Object *obj)
 832 {
 833    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
 834    Widget_Data *wd = elm_widget_data_get(obj);
 835    if (!wd) return NULL;
 836    return wd->indicator;
 837 }
 838
 839 /**
 840  * Set orientation of the slider
 841  *
 842  * @param obj The slider object
 843  * @param horizontal If set, the slider will be horizontal
 844  *
 845  * @ingroup Slider
 846  */
 847 EAPI void
 848 elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
 849 {
 850    ELM_CHECK_WIDTYPE(obj, widtype);
 851    Widget_Data *wd = elm_widget_data_get(obj);
 852    if (!wd) return;
 853    horizontal = !!horizontal;
 854    if (wd->horizontal == horizontal) return;
 855    wd->horizontal = horizontal;
 856    _theme_hook(obj);
 857 }
 858
 859 /**
 860  * Get orientation of the slider
 861  *
 862  * @param obj The slider object
 863  * @return If @c EINA_TRUE the slider will be horizontal, else it is
 864  *         vertical.
 865  * @ingroup Slider
 866  */
 867 EAPI Eina_Bool
 868 elm_slider_horizontal_get(const Evas_Object *obj)
 869 {
 870    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
 871    Widget_Data *wd = elm_widget_data_get(obj);
 872    if (!wd) return EINA_FALSE;
 873    return wd->horizontal;
 874 }
 875
 876 /**
 877  * Set the minimum and maximum values for the slider
 878  *
 879  * Maximum mut be greater than minimum.
 880  *
 881  * @param obj The slider object
 882  * @param min The minimum value
 883  * @param max The maximum value
 884  *
 885  * @ingroup Slider
 886  */
 887 EAPI void
 888 elm_slider_min_max_set(Evas_Object *obj, double min, double max)
 889 {
 890    ELM_CHECK_WIDTYPE(obj, widtype);
 891    Widget_Data *wd = elm_widget_data_get(obj);
 892    if (!wd) return;
 893    if ((wd->val_min == min) && (wd->val_max == max)) return;
 894    wd->val_min = min;
 895    wd->val_max = max;
 896    if (wd->val < wd->val_min) wd->val = wd->val_min;
 897    if (wd->val > wd->val_max) wd->val = wd->val_max;
 898    _val_set(obj);
 899    _units_set(obj);
 900    _indicator_set(obj);
 901 }
 902
 903 /**
 904  * Get the minimum and maximum values for the slider
 905  *
 906  * @param obj The slider object
 907  * @param min The pointer to store minimum value, may be @c NULL.
 908  * @param max The pointer to store maximum value, may be @c NULL.
 909  *
 910  * @ingroup Slider
 911  */
 912 EAPI void
 913 elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max)
 914 {
 915    if (min) *min = 0.0;
 916    if (max) *max = 0.0;
 917    ELM_CHECK_WIDTYPE(obj, widtype);
 918    Widget_Data *wd = elm_widget_data_get(obj);
 919    if (!wd) return;
 920    if (min) *min = wd->val_min;
 921    if (max) *max = wd->val_max;
 922 }
 923
 924 /**
 925  * Set the value the slider indicates
 926  *
 927  * @param obj The slider object
 928  * @param val The value (must be between min and max for the slider)
 929  *
 930  * @ingroup Slider
 931  */
 932 EAPI void
 933 elm_slider_value_set(Evas_Object *obj, double val)
 934 {
 935    ELM_CHECK_WIDTYPE(obj, widtype);
 936    Widget_Data *wd = elm_widget_data_get(obj);
 937    if (!wd) return;
 938    if (wd->val == val) return;
 939    wd->val = val;
 940    if (wd->val < wd->val_min) wd->val = wd->val_min;
 941    if (wd->val > wd->val_max) wd->val = wd->val_max;
 942    _val_set(obj);
 943    _units_set(obj);
 944    _indicator_set(obj);
 945 }
 946
 947 /**
 948  * Get the value the slider has
 949  *
 950  * @param obj The slider object
 951  * @return The value of the slider
 952  *
 953  * @ingroup Slider
 954  */
 955 EAPI double
 956 elm_slider_value_get(const Evas_Object *obj)
 957 {
 958    ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
 959    Widget_Data *wd = elm_widget_data_get(obj);
 960    if (!wd) return 0.0;
 961    return wd->val;
 962 }
 963
 964 /**
 965  * Invert the slider display
 966  *
 967  * Normally the slider will display and interpret values from low to high
 968  * and when horizontal that is left to right. When vertical that is top
 969  * to bottom. This inverts this (so from right to left or bottom to top) if
 970  * inverted is set to 1.
 971  *
 972  * @param obj The slider object
 973  * @param inverted The inverted flag. 1 == inverted, 0 == normal
 974  *
 975  * @ingroup Slider
 976  */
 977 EAPI void
 978 elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted)
 979 {
 980    ELM_CHECK_WIDTYPE(obj, widtype);
 981    Widget_Data *wd = elm_widget_data_get(obj);
 982    if (!wd) return;
 983    inverted = !!inverted;
 984    if (wd->inverted == inverted) return;
 985    wd->inverted = inverted;
 986    if (wd->inverted)
 987      edje_object_signal_emit(wd->slider, "elm,state,inverted,on", "elm");
 988    else
 989      edje_object_signal_emit(wd->slider, "elm,state,inverted,off", "elm");
 990    edje_object_message_signal_process(wd->slider);
 991    _val_set(obj);
 992    _units_set(obj);
 993    _indicator_set(obj);
 994 }
 995
 996 /**
 997  * Get if the slider display is inverted (backwards)
 998  *
 999  * @param obj The slider object
1000  * @return If @c EINA_TRUE the slider will be inverted.
1001  * @ingroup Slider
1002  */
1003 EAPI Eina_Bool
1004 elm_slider_inverted_get(const Evas_Object *obj)
1005 {
1006    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
1007    Widget_Data *wd = elm_widget_data_get(obj);
1008    if (!wd) return EINA_FALSE;
1009    return wd->inverted;
1010 }
1011
1012 /**
1013  * Set the format function pointer for the inducator area
1014  *
1015  * Set the callback function to format the indicator string.
1016  * See elm_slider_indicator_format_set() for more info on how this works.
1017  *
1018  * @param obj The slider object
1019  * @param indicator The format string for the indicator display
1020  * @param func The indicator format function
1021  *
1022  * @ingroup Slider
1023  */
1024 EAPI void
1025 elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val))
1026 {
1027    ELM_CHECK_WIDTYPE(obj, widtype);
1028    Widget_Data *wd = elm_widget_data_get(obj);
1029    if (!wd) return;
1030    wd->indicator_format_func = func;
1031    _indicator_set(obj);
1032 }
1033
1034 /**
1035  * Set the end object (rightmost widget) of the slider object.
1036  *
1037  * Once the end object is set, a previously set one will be deleted.
1038  * If you want to keep that old content object, use the
1039  * elm_button_end_unset() function.
1040  *
1041  * @param obj The slider object
1042  * @param end The end object
1043  *
1044  * @note If the object being set does not have minimum size hints set,
1045  * it won't get properly displayed.
1046  *
1047  * @ingroup Slider
1048  */
1049 EAPI void
1050 elm_slider_end_set(Evas_Object *obj, Evas_Object *end)
1051 {
1052    ELM_CHECK_WIDTYPE(obj, widtype);
1053    Widget_Data *wd = elm_widget_data_get(obj);
1054    if (!wd) return;
1055    if (wd->end == end) return;
1056    if (wd->end) evas_object_del(wd->end);
1057    wd->end = end;
1058    if (end)
1059      {
1060         elm_widget_sub_object_add(obj, end);
1061         evas_object_event_callback_add(end, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
1062                                        _changed_size_hints, obj);
1063         edje_object_part_swallow(wd->slider, "elm.swallow.end", end);
1064         edje_object_signal_emit(wd->slider, "elm,state,end,visible", "elm");
1065         edje_object_message_signal_process(wd->slider);
1066      }
1067    _sizing_eval(obj);
1068 }
1069
1070 /**
1071  * Unset the rightmost widget of the slider, unparenting and
1072  * returning it.
1073  *
1074  * @param obj The slider object
1075  * @return the previously set end sub-object of this slider, on
1076  * success.
1077  *
1078  * @see elm_slider_end_set()
1079  *
1080  * @ingroup Slider
1081  */
1082 EAPI Evas_Object *
1083 elm_slider_end_unset(Evas_Object *obj)
1084 {
1085    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
1086    Widget_Data *wd = elm_widget_data_get(obj);
1087    Evas_Object *ret = NULL;
1088    if (!wd) return NULL;
1089    if (wd->end)
1090      {
1091         elm_widget_sub_object_del(obj, wd->end);
1092         ret = wd->end;
1093         edje_object_part_unswallow(wd->slider, wd->end);
1094         edje_object_signal_emit(wd->slider, "elm,state,end,hidden", "elm");
1095         wd->end = NULL;
1096         _sizing_eval(obj);
1097      }
1098    return ret;
1099 }
1100
1101 /**
1102  * Get the end icon object of the slider object. This object is owned
1103  * by the scrolled entry and should not be modified.
1104  *
1105  * @param obj The slider object
1106  * @return The end icon object
1107  *
1108  * @ingroup Slider
1109  */
1110 EAPI Evas_Object *
1111 elm_slider_end_get(const Evas_Object *obj)
1112 {
1113    ELM_CHECK_WIDTYPE(obj, widtype) NULL;
1114    Widget_Data *wd = elm_widget_data_get(obj);
1115    if (!wd) return NULL;
1116    return wd->end;
1117 }
1118
1119 /**
1120  * Set whether to the slider indicator (augmented knob) at all.
1121  *
1122  * @param obj The slider object
1123  * @param show @c EINA_TRUE will make it show it, @c EINA_FALSE will
1124  * let the knob alwayes at default size.
1125  *
1126  * @note It will conflict with elm_slider_indicator_format_set(), if
1127  * you wanted those effects.
1128  *
1129  * @ingroup Slider
1130  */
1131 EAPI void
1132 elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show)
1133 {
1134    ELM_CHECK_WIDTYPE(obj, widtype);
1135    Widget_Data *wd = elm_widget_data_get(obj);
1136    if (show) {
1137       wd->indicator_show = EINA_TRUE;
1138       edje_object_signal_emit(wd->slider, "elm,state,val,show", "elm");
1139    }
1140    else {
1141       wd->indicator_show = EINA_FALSE;
1142       edje_object_signal_emit(wd->slider, "elm,state,val,hide", "elm");
1143    }
1144 }
1145
1146 /**
1147  * Get the state of indicator in the slider (if it's being shown or
1148  * not).
1149  *
1150  * @param obj The slider object
1151  * @return @c EINA_TRUE if the indicator is being shown, @c EINA_FALSE
1152  * otherwise.
1153  *
1154  *  @ingroup Slider
1155  */
1156 EAPI Eina_Bool
1157 elm_slider_indicator_show_get(const Evas_Object *obj)
1158 {
1159    ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
1160    Widget_Data *wd = elm_widget_data_get(obj);
1161    if (!wd) return EINA_FALSE;
1162    return wd->indicator_show;
1163 }
1164