1 #include <Elementary.h>
5 * @defgroup Slider Slider
8 * The slider adds a dragable “slider” widget for selecting the value of
9 * something within a range.
12 * A slider can be horizontal or vertical. It can contain an Icon and has a
13 * primary label as well as a units label (that is formatted with floating
14 * point values and thus accepts a printf-style format string, like
15 * “%1.2f units”. There is also an indicator string that may be somewhere
16 * else (like on the slider itself) that also accepts a format string like
17 * units. Label, Icon Unit and Indicator strings/objects are optional.
19 * A slider may be inverted which means values invert, with high vales being
20 * on the left or top and low values on the right or bottom (as opposed to
21 * normally being low on the left or top and high on the bottom and right).
23 * The slider should have its minimum and maximum values set by the
24 * application with elm_slider_min_max_set() and value should also be set by
25 * the application before use with elm_slider_value_set(). The span of the
26 * slider is its length (horizontally or vertically). This will be scaled by
27 * the object or applications scaling factor. At any point code can query the
28 * slider for its value with elm_slider_value_get().
30 * Signals that you can add callbacks for are:
32 * "changed" - Whenever the slider value is changed by the user.
33 * "slider,drag,start" - dragging the slider indicator around has started
34 * "slider,drag,stop" - dragging the slider indicator around has stopped
35 * "delay,changed" - A short time after the value is changed by the user.
36 * This will be called only when the user stops dragging for
37 * a very short period or when they release their
38 * finger/mouse, so it avoids possibly expensive reactions to
42 typedef struct _Widget_Data Widget_Data;
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;
58 double val, val_min, val_max;
63 #define ELM_SLIDER_INVERTED_FACTOR (-1.0)
65 static const char *widtype = NULL;
66 static void _del_hook(Evas_Object *obj);
67 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
68 static void _theme_hook(Evas_Object *obj);
69 static void _disable_hook(Evas_Object *obj);
70 static void _sizing_eval(Evas_Object *obj);
71 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
72 static void _sub_del(void *data, Evas_Object *obj, void *event_info);
73 static void _units_set(Evas_Object *obj);
74 static void _val_set(Evas_Object *obj);
75 static void _indicator_set(Evas_Object *obj);
76 static void _on_focus_hook(void *data, Evas_Object *obj);
77 static void _drag_up(void *data, Evas_Object *obj,
78 const char *emission, const char *source);
79 static void _drag_down(void *data, Evas_Object *obj,
80 const char *emission, const char *source);
81 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
82 Evas_Callback_Type type, void *event_info);
83 static void _spacer_cb(void *data, Evas * e, Evas_Object * obj, void *event_info);
85 static const char SIG_CHANGED[] = "changed";
86 static const char SIG_DELAY_CHANGED[] = "delay,changed";
87 static const char SIG_DRAG_START[] = "slider,drag,start";
88 static const char SIG_DRAG_STOP[] = "slider,drag,stop";
89 static const Evas_Smart_Cb_Description _signals[] = {
91 {SIG_DELAY_CHANGED, ""},
98 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
100 Evas_Event_Mouse_Wheel *mev;
101 Evas_Event_Key_Down *ev;
104 wd = elm_widget_data_get(obj);
105 if (!wd) return EINA_FALSE;
106 if (elm_widget_disabled_get(obj)) return EINA_FALSE;
108 if (type == EVAS_CALLBACK_KEY_DOWN) goto key_down;
109 else if (type != EVAS_CALLBACK_MOUSE_WHEEL) return EINA_FALSE;
112 if (mev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
113 if (elm_widget_disabled_get(obj)) return EINA_FALSE;
115 if (mev->z < 0) _drag_up(obj, NULL, NULL, NULL);
116 else _drag_down(obj, NULL, NULL, NULL);
117 mev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
122 if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
123 if (elm_widget_disabled_get(obj)) return EINA_FALSE;
124 if ((!strcmp(ev->keyname, "Left"))
125 || (!strcmp(ev->keyname, "KP_Left")))
127 if (!wd->horizontal) return EINA_FALSE;
128 if (!wd->inverted) _drag_down(obj, NULL, NULL, NULL);
129 else _drag_up(obj, NULL, NULL, NULL);
130 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
133 else if ((!strcmp(ev->keyname, "Right"))
134 || (!strcmp(ev->keyname, "KP_Right")))
136 if (!wd->horizontal) return EINA_FALSE;
137 if (!wd->inverted) _drag_up(obj, NULL, NULL, NULL);
138 else _drag_down(obj, NULL, NULL, NULL);
139 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
142 else if ((!strcmp(ev->keyname, "Up")) || (!strcmp(ev->keyname, "KP_Up")))
144 if (wd->horizontal) return EINA_FALSE;
145 if (wd->inverted) _drag_up(obj, NULL, NULL, NULL);
146 else _drag_down(obj, NULL, NULL, NULL);
147 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
150 else if ((!strcmp(ev->keyname, "Down")) || (!strcmp(ev->keyname, "KP_Down")))
152 if (wd->horizontal) return EINA_FALSE;
153 if (wd->inverted) _drag_down(obj, NULL, NULL, NULL);
154 else _drag_up(obj, NULL, NULL, NULL);
155 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
158 else return EINA_FALSE;
162 _del_hook(Evas_Object *obj)
164 Widget_Data *wd = elm_widget_data_get(obj);
166 if (wd->label) eina_stringshare_del(wd->label);
167 if (wd->indicator) eina_stringshare_del(wd->units);
168 if (wd->delay) ecore_timer_del(wd->delay);
173 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
175 Widget_Data *wd = elm_widget_data_get(obj);
177 if (elm_widget_focus_get(obj))
179 edje_object_signal_emit(wd->slider, "elm,action,focus", "elm");
180 evas_object_focus_set(wd->slider, EINA_TRUE);
184 edje_object_signal_emit(wd->slider, "elm,action,unfocus", "elm");
185 evas_object_focus_set(wd->slider, EINA_FALSE);
190 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
192 Widget_Data *wd = elm_widget_data_get(obj);
194 edje_object_mirrored_set(wd->slider, rtl);
198 _theme_hook(Evas_Object *obj)
200 Widget_Data *wd = elm_widget_data_get(obj);
202 _elm_widget_mirrored_reload(obj);
203 _mirrored_set(obj, elm_widget_mirrored_get(obj));
205 _elm_theme_object_set(obj, wd->slider, "slider", "horizontal", elm_widget_style_get(obj));
207 _elm_theme_object_set(obj, wd->slider, "slider", "vertical", elm_widget_style_get(obj));
208 if (elm_widget_disabled_get(obj))
209 edje_object_signal_emit(wd->slider, "elm,state,disabled", "elm");
211 edje_object_signal_emit(wd->slider, "elm,state,enabled", "elm");
214 edje_object_part_swallow(wd->slider, "elm.swallow.content", wd->icon);
215 edje_object_signal_emit(wd->slider, "elm,state,icon,visible", "elm");
218 edje_object_signal_emit(wd->slider, "elm,state,end,visible", "elm");
220 edje_object_signal_emit(wd->slider, "elm,state,end,hidden", "elm");
223 edje_object_part_text_set(wd->slider, "elm.text", wd->label);
224 edje_object_signal_emit(wd->slider, "elm,state,text,visible", "elm");
228 edje_object_signal_emit(wd->slider, "elm,state,units,visible", "elm");
231 evas_object_size_hint_min_set(wd->spacer, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale, 1);
233 evas_object_size_hint_min_set(wd->spacer, 1, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale);
236 edje_object_signal_emit(wd->slider, "elm,state,inverted,on", "elm");
238 edje_object_part_swallow(wd->slider, "elm.swallow.bar", wd->spacer);
241 edje_object_message_signal_process(wd->slider);
242 edje_object_scale_set(wd->slider, elm_widget_scale_get(obj) * _elm_config->scale);
248 _disable_hook(Evas_Object *obj)
250 Widget_Data *wd = elm_widget_data_get(obj);
252 if (elm_widget_disabled_get(obj))
253 edje_object_signal_emit(wd->slider, "elm,state,disabled", "elm");
255 edje_object_signal_emit(wd->slider, "elm,state,enabled", "elm");
259 _sizing_eval(Evas_Object *obj)
261 Widget_Data *wd = elm_widget_data_get(obj);
262 Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
264 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
265 edje_object_size_min_restricted_calc(wd->slider, &minw, &minh, minw, minh);
266 elm_coords_finger_size_adjust(1, &minw, 1, &minh);
267 evas_object_size_hint_min_set(obj, minw, minh);
268 evas_object_size_hint_max_set(obj, maxw, maxh);
272 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj, void *event_info __UNUSED__)
274 Widget_Data *wd = elm_widget_data_get(data);
276 if ((obj != wd->icon) && (obj != wd->end)) return;
281 _sub_del(void *data __UNUSED__, Evas_Object *obj, void *event_info)
283 Widget_Data *wd = elm_widget_data_get(obj);
284 Evas_Object *sub = event_info;
288 edje_object_signal_emit(wd->slider, "elm,state,icon,hidden", "elm");
289 evas_object_event_callback_del_full
290 (sub, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
292 edje_object_message_signal_process(wd->slider);
297 edje_object_signal_emit(wd->slider, "elm,state,end,hidden", "elm");
298 evas_object_event_callback_del_full(sub,
299 EVAS_CALLBACK_CHANGED_SIZE_HINTS,
300 _changed_size_hints, obj);
302 edje_object_message_signal_process(wd->slider);
308 _delay_change(void *data)
310 Widget_Data *wd = elm_widget_data_get(data);
311 if (!wd) return ECORE_CALLBACK_CANCEL;
313 evas_object_smart_callback_call(data, SIG_DELAY_CHANGED, NULL);
314 return ECORE_CALLBACK_CANCEL;
318 _val_fetch(Evas_Object *obj)
321 Widget_Data *wd = elm_widget_data_get(obj);
322 double posx = 0.0, posy = 0.0, pos = 0.0, val;
324 edje_object_part_drag_value_get(wd->slider, "elm.dragable.slider",
326 if (wd->horizontal) pos = posx;
329 rtl = elm_widget_mirrored_get(obj);
330 if ((!rtl && wd->inverted) || (rtl &&
331 ((!wd->horizontal && wd->inverted) ||
332 (wd->horizontal && !wd->inverted)))) pos = 1.0 - pos;
333 val = (pos * (wd->val_max - wd->val_min)) + wd->val_min;
337 evas_object_smart_callback_call(obj, SIG_CHANGED, NULL);
338 if (wd->delay) ecore_timer_del(wd->delay);
339 wd->delay = ecore_timer_add(0.2, _delay_change, obj);
344 _val_set(Evas_Object *obj)
347 Widget_Data *wd = elm_widget_data_get(obj);
350 if (wd->val_max > wd->val_min)
351 pos = (wd->val - wd->val_min) / (wd->val_max - wd->val_min);
354 if (pos < 0.0) pos = 0.0;
355 else if (pos > 1.0) pos = 1.0;
357 rtl = elm_widget_mirrored_get(obj);
358 if ((!rtl && wd->inverted) || (rtl &&
359 ((!wd->horizontal && wd->inverted) ||
360 (wd->horizontal && !wd->inverted)))) pos = 1.0 - pos;
361 edje_object_part_drag_value_set(wd->slider, "elm.dragable.slider", pos, pos);
365 _units_set(Evas_Object *obj)
367 Widget_Data *wd = elm_widget_data_get(obj);
373 snprintf(buf, sizeof(buf), wd->units, wd->val);
374 edje_object_part_text_set(wd->slider, "elm.units", buf);
377 edje_object_part_text_set(wd->slider, "elm.units", NULL);
381 _indicator_set(Evas_Object *obj)
383 Widget_Data *wd = elm_widget_data_get(obj);
385 if (wd->indicator_format_func)
388 buf = wd->indicator_format_func(wd->val);
389 edje_object_part_text_set(wd->slider, "elm.dragable.slider:elm.indicator", buf);
391 else if (wd->indicator)
394 snprintf(buf, sizeof(buf), wd->indicator, wd->val);
395 edje_object_part_text_set(wd->slider, "elm.dragable.slider:elm.indicator", buf);
398 edje_object_part_text_set(wd->slider, "elm.dragable.slider:elm.indicator", NULL);
402 _drag(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
404 Widget_Data *wd = elm_widget_data_get((Evas_Object*)data);
405 if (elm_widget_disabled_get(data)) return;
406 edje_object_signal_emit(wd->slider, "elm,state,drag", "elm");
407 edje_object_message_signal_process(wd->slider);
410 _indicator_set(data);
414 _drag_start(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
416 Widget_Data *wd = elm_widget_data_get((Evas_Object*)data);
417 if (elm_widget_disabled_get(data)) return;
419 evas_object_smart_callback_call(data, SIG_DRAG_START, NULL);
420 edje_object_signal_emit(wd->slider, "elm,state,drag", "elm");
421 edje_object_message_signal_process(wd->slider);
423 _indicator_set(data);
424 elm_widget_scroll_freeze_push(data);
428 _drag_stop(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
430 if (elm_widget_disabled_get(data)) return;
432 evas_object_smart_callback_call(data, SIG_DRAG_STOP, NULL);
434 _indicator_set(data);
435 elm_widget_scroll_freeze_pop(data);
439 _drag_step(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
441 if (elm_widget_disabled_get(data)) return;
444 _indicator_set(data);
448 _drag_up(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
452 if (elm_widget_disabled_get(data)) return;
454 wd = elm_widget_data_get(data);
457 if (wd->inverted) step *= ELM_SLIDER_INVERTED_FACTOR;
459 edje_object_part_drag_step(wd->slider, "elm.dragable.slider", step, step);
463 _drag_down(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
467 if (elm_widget_disabled_get(data)) return;
469 wd = elm_widget_data_get(data);
472 if (wd->inverted) step *= ELM_SLIDER_INVERTED_FACTOR;
474 edje_object_part_drag_step(wd->slider, "elm.dragable.slider", step, step);
478 _spacer_cb(void *data, Evas *e, Evas_Object *obj __UNUSED__, void *event_info)
480 Widget_Data *wd = elm_widget_data_get(data);
481 Evas_Event_Mouse_Down *ev = event_info;
482 Evas_Coord x, y, w, h;
483 double button_x, button_y;
484 if (elm_widget_disabled_get(data)) return;
486 evas_object_geometry_get(wd->spacer, &x, &y, &w, &h);
487 edje_object_part_drag_value_get(wd->slider, "elm.dragable.slider", &button_x, &button_y);
490 button_x = ((double)ev->output.x - (double)x) / (double)w;
491 if (button_x > 1) button_x = 1;
492 if (button_x < 0) button_x = 0;
496 button_y = ((double)ev->output.y - (double)y) / (double)h;
497 if (button_y > 1) button_y = 1;
498 if (button_y < 0) button_y = 0;
500 edje_object_part_drag_value_set(wd->slider, "elm.dragable.slider", button_x, button_y);
501 evas_event_feed_mouse_cancel(e, 0, NULL);
504 evas_event_feed_mouse_down(e, 1, EVAS_BUTTON_NONE, 0, NULL);
509 * Add a new slider to the parent
511 * @param parent The parent object
512 * @return The new object or NULL if it cannot be created
517 elm_slider_add(Evas_Object *parent)
523 ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
525 ELM_SET_WIDTYPE(widtype, "slider");
526 elm_widget_type_set(obj, "slider");
527 elm_widget_sub_object_add(parent, obj);
528 elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
529 elm_widget_data_set(obj, wd);
530 elm_widget_del_hook_set(obj, _del_hook);
531 elm_widget_theme_hook_set(obj, _theme_hook);
532 elm_widget_disable_hook_set(obj, _disable_hook);
533 elm_widget_can_focus_set(obj, EINA_TRUE);
534 elm_widget_event_hook_set(obj, _event_hook);
536 wd->horizontal = EINA_TRUE;
537 wd->indicator_show = EINA_TRUE;
543 wd->slider = edje_object_add(e);
544 _elm_theme_object_set(obj, wd->slider, "slider", "horizontal", "default");
545 elm_widget_resize_object_set(obj, wd->slider);
546 edje_object_signal_callback_add(wd->slider, "drag", "*", _drag, obj);
547 edje_object_signal_callback_add(wd->slider, "drag,start", "*", _drag_start, obj);
548 edje_object_signal_callback_add(wd->slider, "drag,stop", "*", _drag_stop, obj);
549 edje_object_signal_callback_add(wd->slider, "drag,step", "*", _drag_step, obj);
550 edje_object_signal_callback_add(wd->slider, "drag,page", "*", _drag_stop, obj);
551 // edje_object_signal_callback_add(wd->slider, "drag,set", "*", _drag_stop, obj);
552 edje_object_part_drag_value_set(wd->slider, "elm.dragable.slider", 0.0, 0.0);
554 wd->spacer = evas_object_rectangle_add(e);
555 evas_object_color_set(wd->spacer, 0, 0, 0, 0);
556 evas_object_pass_events_set(wd->spacer, EINA_TRUE);
557 elm_widget_sub_object_add(obj, wd->spacer);
558 edje_object_part_swallow(wd->slider, "elm.swallow.bar", wd->spacer);
559 evas_object_event_callback_add(wd->spacer, EVAS_CALLBACK_MOUSE_DOWN, _spacer_cb, obj);
560 evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
562 _mirrored_set(obj, elm_widget_mirrored_get(obj));
565 // TODO: convert Elementary to subclassing of Evas_Smart_Class
566 // TODO: and save some bytes, making descriptions per-class and not instance!
567 evas_object_smart_callbacks_descriptions_set(obj, _signals);
572 * Set the label of the slider
574 * @param obj The slider object
575 * @param label The text label string in UTF-8
580 elm_slider_label_set(Evas_Object *obj, const char *label)
582 ELM_CHECK_WIDTYPE(obj, widtype);
583 Widget_Data *wd = elm_widget_data_get(obj);
585 eina_stringshare_replace(&wd->label, label);
588 edje_object_signal_emit(wd->slider, "elm,state,text,visible", "elm");
589 edje_object_message_signal_process(wd->slider);
593 edje_object_signal_emit(wd->slider, "elm,state,text,hidden", "elm");
594 edje_object_message_signal_process(wd->slider);
596 edje_object_part_text_set(wd->slider, "elm.text", label);
601 * Get the label of the slider
603 * @param obj The slider object
604 * @return The text label string in UTF-8
609 elm_slider_label_get(const Evas_Object *obj)
611 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
612 Widget_Data *wd = elm_widget_data_get(obj);
613 if (!wd) return NULL;
618 * Set the icon object (leftmost widget) of the slider object.
620 * Once the icon object is set, a previously set one will be deleted.
621 * If you want to keep that old content object, use the
622 * elm_slider_icon_unset() function.
624 * @param obj The slider object
625 * @param icon The icon object
627 * @note If the object being set does not have minimum size hints set,
628 * it won't get properly displayed.
633 elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon)
635 ELM_CHECK_WIDTYPE(obj, widtype);
636 Widget_Data *wd = elm_widget_data_get(obj);
638 if (wd->icon == icon) return;
639 if (wd->icon) evas_object_del(wd->icon);
643 elm_widget_sub_object_add(obj, icon);
644 evas_object_event_callback_add(icon, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
645 _changed_size_hints, obj);
646 edje_object_part_swallow(wd->slider, "elm.swallow.icon", icon);
647 edje_object_signal_emit(wd->slider, "elm,state,icon,visible", "elm");
648 edje_object_message_signal_process(wd->slider);
654 * Unset the leftmost widget of the slider, unparenting and
657 * @param obj The slider object
658 * @return the previously set icon sub-object of this slider, on
661 * @see elm_slider_icon_set()
666 elm_slider_icon_unset(Evas_Object *obj)
668 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
669 Widget_Data *wd = elm_widget_data_get(obj);
670 Evas_Object *ret = NULL;
671 if (!wd) return NULL;
674 elm_widget_sub_object_del(obj, wd->icon);
676 edje_object_part_unswallow(wd->slider, wd->icon);
677 edje_object_signal_emit(wd->slider, "elm,state,icon,hidden", "elm");
685 * Get the icon object of the slider object. This object is owned by
686 * the scrolled entry and should not be modified.
688 * @param obj The slider object
689 * @return The icon object
694 elm_slider_icon_get(const Evas_Object *obj)
696 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
697 Widget_Data *wd = elm_widget_data_get(obj);
698 if (!wd) return NULL;
703 * Set the length of the dragable region of the slider
705 * This sets the minimum width or height (depending on orientation) of the
706 * area of the slider that allows the slider to be dragged around. This in
707 * turn affects the objects minimum size (along with icon label and unit
708 * text). Note that this will also get multiplied by the scale factor.
710 * @param obj The slider object
711 * @param size The length of the slider area
716 elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size)
718 ELM_CHECK_WIDTYPE(obj, widtype);
719 Widget_Data *wd = elm_widget_data_get(obj);
721 if (wd->size == size) return;
724 evas_object_size_hint_min_set(wd->spacer, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale, 1);
726 evas_object_size_hint_min_set(wd->spacer, 1, (double)wd->size * elm_widget_scale_get(obj) * _elm_config->scale);
727 if (wd->indicator_show)
728 edje_object_signal_emit(wd->slider, "elm,state,val,show", "elm");
730 edje_object_signal_emit(wd->slider, "elm,state,val,hide", "elm");
731 edje_object_part_swallow(wd->slider, "elm.swallow.bar", wd->spacer);
736 * Get the length of the dragable region of the slider
738 * This gets the minimum width or height (depending on orientation) of
739 * the area of the slider that allows the slider to be dragged
740 * around. Note that this will also get multiplied by the scale
743 * @param obj The slider object
744 * @return The length of the slider area
749 elm_slider_span_size_get(const Evas_Object *obj)
751 ELM_CHECK_WIDTYPE(obj, widtype) 0;
752 Widget_Data *wd = elm_widget_data_get(obj);
758 * Set the format string of the unit area
760 * If NULL, this disabls the unit area display. If not it sets the format
761 * string for the unit text. The unit text is provided a floating point
762 * value, so the unit text can display up to 1 floating point value. Note that
763 * this is optional. Use a format string such as "%1.2f meters" for example.
765 * @param obj The slider object
766 * @param units The format string for the units display
771 elm_slider_unit_format_set(Evas_Object *obj, const char *units)
773 ELM_CHECK_WIDTYPE(obj, widtype);
774 Widget_Data *wd = elm_widget_data_get(obj);
776 eina_stringshare_replace(&wd->units, units);
779 edje_object_signal_emit(wd->slider, "elm,state,units,visible", "elm");
780 edje_object_message_signal_process(wd->slider);
784 edje_object_signal_emit(wd->slider, "elm,state,units,hidden", "elm");
785 edje_object_message_signal_process(wd->slider);
792 * Get the format string for the unit area
794 * The slider may also display a value (the value of the slider) somewhere
795 * (for example above the slider knob that is dragged around). This sets the
796 * format string for this. See elm_slider_unit_format_set() for more
797 * information on how this works.
799 * @param obj The slider object
800 * @return The format string for the unit display.
805 elm_slider_unit_format_get(const Evas_Object *obj)
807 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
808 Widget_Data *wd = elm_widget_data_get(obj);
809 if (!wd) return NULL;
814 * Set the format string for the indicator area
816 * The slider may also display a value (the value of the slider) somewhere
817 * (for example above the slider knob that is dragged around). This sets the
818 * format string for this. See elm_slider_unit_format_set() for more
819 * information on how this works.
821 * @param obj The slider object
822 * @param indicator The format string for the indicator display
827 elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator)
829 ELM_CHECK_WIDTYPE(obj, widtype);
830 Widget_Data *wd = elm_widget_data_get(obj);
832 eina_stringshare_replace(&wd->indicator, indicator);
837 * Get the format string for the indicator area
839 * The slider may also display a value (the value of the slider) somewhere
840 * (for example above the slider knob that is dragged around). This sets the
841 * format string for this. See elm_slider_indicator_format_set() for more
842 * information on how this works.
844 * @param obj The slider object
845 * @return The format string for the indicator display.
850 elm_slider_indicator_format_get(const Evas_Object *obj)
852 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
853 Widget_Data *wd = elm_widget_data_get(obj);
854 if (!wd) return NULL;
855 return wd->indicator;
859 * Set orientation of the slider
861 * @param obj The slider object
862 * @param horizontal If set, the slider will be horizontal
867 elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal)
869 ELM_CHECK_WIDTYPE(obj, widtype);
870 Widget_Data *wd = elm_widget_data_get(obj);
872 horizontal = !!horizontal;
873 if (wd->horizontal == horizontal) return;
874 wd->horizontal = horizontal;
879 * Get orientation of the slider
881 * @param obj The slider object
882 * @return If @c EINA_TRUE the slider will be horizontal, else it is
887 elm_slider_horizontal_get(const Evas_Object *obj)
889 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
890 Widget_Data *wd = elm_widget_data_get(obj);
891 if (!wd) return EINA_FALSE;
892 return wd->horizontal;
896 * Set the minimum and maximum values for the slider
898 * Maximum mut be greater than minimum.
900 * @param obj The slider object
901 * @param min The minimum value
902 * @param max The maximum value
907 elm_slider_min_max_set(Evas_Object *obj, double min, double max)
909 ELM_CHECK_WIDTYPE(obj, widtype);
910 Widget_Data *wd = elm_widget_data_get(obj);
912 if ((wd->val_min == min) && (wd->val_max == max)) return;
915 if (wd->val < wd->val_min) wd->val = wd->val_min;
916 if (wd->val > wd->val_max) wd->val = wd->val_max;
923 * Get the minimum and maximum values for the slider
925 * @param obj The slider object
926 * @param min The pointer to store minimum value, may be @c NULL.
927 * @param max The pointer to store maximum value, may be @c NULL.
932 elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max)
936 ELM_CHECK_WIDTYPE(obj, widtype);
937 Widget_Data *wd = elm_widget_data_get(obj);
939 if (min) *min = wd->val_min;
940 if (max) *max = wd->val_max;
944 * Set the value the slider indicates
946 * @param obj The slider object
947 * @param val The value (must be between min and max for the slider)
952 elm_slider_value_set(Evas_Object *obj, double val)
954 ELM_CHECK_WIDTYPE(obj, widtype);
955 Widget_Data *wd = elm_widget_data_get(obj);
957 if (wd->val == val) return;
959 if (wd->val < wd->val_min) wd->val = wd->val_min;
960 if (wd->val > wd->val_max) wd->val = wd->val_max;
961 edje_object_signal_emit(wd->slider, "elm,state,drag", "elm");
968 * Get the value the slider has
970 * @param obj The slider object
971 * @return The value of the slider
976 elm_slider_value_get(const Evas_Object *obj)
978 ELM_CHECK_WIDTYPE(obj, widtype) 0.0;
979 Widget_Data *wd = elm_widget_data_get(obj);
985 * Invert the slider display
987 * Normally the slider will display and interpret values from low to high
988 * and when horizontal that is left to right. When vertical that is top
989 * to bottom. This inverts this (so from right to left or bottom to top) if
990 * inverted is set to 1.
992 * @param obj The slider object
993 * @param inverted The inverted flag. 1 == inverted, 0 == normal
998 elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted)
1000 ELM_CHECK_WIDTYPE(obj, widtype);
1001 Widget_Data *wd = elm_widget_data_get(obj);
1003 inverted = !!inverted;
1004 if (wd->inverted == inverted) return;
1005 wd->inverted = inverted;
1007 edje_object_signal_emit(wd->slider, "elm,state,inverted,on", "elm");
1009 edje_object_signal_emit(wd->slider, "elm,state,inverted,off", "elm");
1010 edje_object_message_signal_process(wd->slider);
1013 _indicator_set(obj);
1017 * Get if the slider display is inverted (backwards)
1019 * @param obj The slider object
1020 * @return If @c EINA_TRUE the slider will be inverted.
1024 elm_slider_inverted_get(const Evas_Object *obj)
1026 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
1027 Widget_Data *wd = elm_widget_data_get(obj);
1028 if (!wd) return EINA_FALSE;
1029 return wd->inverted;
1033 * Set the format function pointer for the inducator area
1035 * Set the callback function to format the indicator string.
1036 * See elm_slider_indicator_format_set() for more info on how this works.
1038 * @param obj The slider object
1039 * @param indicator The format string for the indicator display
1040 * @param func The indicator format function
1045 elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val))
1047 ELM_CHECK_WIDTYPE(obj, widtype);
1048 Widget_Data *wd = elm_widget_data_get(obj);
1050 wd->indicator_format_func = func;
1051 _indicator_set(obj);
1055 * Set the end object (rightmost widget) of the slider object.
1057 * Once the end object is set, a previously set one will be deleted.
1058 * If you want to keep that old content object, use the
1059 * elm_button_end_unset() function.
1061 * @param obj The slider object
1062 * @param end The end object
1064 * @note If the object being set does not have minimum size hints set,
1065 * it won't get properly displayed.
1070 elm_slider_end_set(Evas_Object *obj, Evas_Object *end)
1072 ELM_CHECK_WIDTYPE(obj, widtype);
1073 Widget_Data *wd = elm_widget_data_get(obj);
1075 if (wd->end == end) return;
1076 if (wd->end) evas_object_del(wd->end);
1080 elm_widget_sub_object_add(obj, end);
1081 evas_object_event_callback_add(end, EVAS_CALLBACK_CHANGED_SIZE_HINTS,
1082 _changed_size_hints, obj);
1083 edje_object_part_swallow(wd->slider, "elm.swallow.end", end);
1084 edje_object_signal_emit(wd->slider, "elm,state,end,visible", "elm");
1085 edje_object_message_signal_process(wd->slider);
1091 * Unset the rightmost widget of the slider, unparenting and
1094 * @param obj The slider object
1095 * @return the previously set end sub-object of this slider, on
1098 * @see elm_slider_end_set()
1103 elm_slider_end_unset(Evas_Object *obj)
1105 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
1106 Widget_Data *wd = elm_widget_data_get(obj);
1107 Evas_Object *ret = NULL;
1108 if (!wd) return NULL;
1111 elm_widget_sub_object_del(obj, wd->end);
1113 edje_object_part_unswallow(wd->slider, wd->end);
1114 edje_object_signal_emit(wd->slider, "elm,state,end,hidden", "elm");
1122 * Get the end icon object of the slider object. This object is owned
1123 * by the scrolled entry and should not be modified.
1125 * @param obj The slider object
1126 * @return The end icon object
1131 elm_slider_end_get(const Evas_Object *obj)
1133 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
1134 Widget_Data *wd = elm_widget_data_get(obj);
1135 if (!wd) return NULL;
1140 * Set whether to the slider indicator (augmented knob) at all.
1142 * @param obj The slider object
1143 * @param show @c EINA_TRUE will make it show it, @c EINA_FALSE will
1144 * let the knob alwayes at default size.
1146 * @note It will conflict with elm_slider_indicator_format_set(), if
1147 * you wanted those effects.
1152 elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show)
1154 ELM_CHECK_WIDTYPE(obj, widtype);
1155 Widget_Data *wd = elm_widget_data_get(obj);
1157 wd->indicator_show = EINA_TRUE;
1158 edje_object_signal_emit(wd->slider, "elm,state,val,show", "elm");
1161 wd->indicator_show = EINA_FALSE;
1162 edje_object_signal_emit(wd->slider, "elm,state,val,hide", "elm");
1167 * Get the state of indicator in the slider (if it's being shown or
1170 * @param obj The slider object
1171 * @return @c EINA_TRUE if the indicator is being shown, @c EINA_FALSE
1177 elm_slider_indicator_show_get(const Evas_Object *obj)
1179 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
1180 Widget_Data *wd = elm_widget_data_get(obj);
1181 if (!wd) return EINA_FALSE;
1182 return wd->indicator_show;