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