src/lib/elm_slider.c

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