1 #include <Elementary.h>
5 * @defgroup SegmentControl SegmentControl
8 * SegmentControl Widget is a horizontal control made of multiple segment items,
9 * each segment item functioning similar to discrete two state button. A segment
10 * control groups the the items together and provides compact single button with
11 * multiple equal size segments. Segment item size is determined by base widget
12 * size and the number of items added.
13 * Only one Segment item can be at selected state. A segment item can display
14 * combination of Text and any Evas_Object like Images or other widget.
16 * Signals that you can add callbacks for are:
18 * "changed" -when the user clicks on a segment item which is not previously
19 * selected and get selected. The event_info parameter is the
22 typedef struct _Widget_Data Widget_Data;
30 Elm_Segment_Item *selected_item;
34 struct _Elm_Segment_Item
42 static const char *widtype = NULL;
43 static void _sizing_eval(Evas_Object *obj);
44 static void _del_hook(Evas_Object *obj);
45 static void _theme_hook(Evas_Object *obj);
46 static void _disable_hook(Evas_Object *obj);
47 static void _item_free(Elm_Segment_Item *it);
48 static void _segment_off(Elm_Segment_Item *it);
49 static void _segment_on(Elm_Segment_Item *it);
50 static void _position_items(Widget_Data *wd);
51 static void _on_move_resize(void *data, Evas *e __UNUSED__, Evas_Object *obj
52 __UNUSED__, void *event_info __UNUSED__);
53 static void _mouse_up(void *data, Evas *e __UNUSED__, Evas_Object *obj
54 __UNUSED__, void *event_info __UNUSED__);
55 static void _mouse_down(void *data, Evas *e __UNUSED__, Evas_Object *obj
56 __UNUSED__, void *event_info __UNUSED__);
57 static void _swallow_item_objects(Elm_Segment_Item *it);
58 static void _update_list(Widget_Data *wd);
59 static Elm_Segment_Item * _item_find(const Evas_Object *obj, int index);
60 static Elm_Segment_Item* _item_new(Evas_Object *obj, Evas_Object *icon,
63 static const char SIG_CHANGED[] = "changed";
65 static const Evas_Smart_Cb_Description _signals[] = {
71 _sizing_eval(Evas_Object *obj)
74 Evas_Coord minw = -1, minh = -1;
77 wd = elm_widget_data_get(obj);
80 elm_coords_finger_size_adjust(wd->item_count, &minw, 1, &minh);
81 edje_object_size_min_restricted_calc(wd->base, &minw, &minh, minw, minh);
82 elm_coords_finger_size_adjust(wd->item_count, &minw, 1, &minh);
84 evas_object_size_hint_min_get(obj, &w, &h);
85 if (w > minw) minw = w;
86 if (h > minh) minh = h;
87 evas_object_size_hint_min_set(obj, minw, minh);
91 _del_hook(Evas_Object *obj)
96 wd = elm_widget_data_get(obj);
99 EINA_LIST_FREE(wd->seg_items, it) _item_free(it);
105 _theme_hook(Evas_Object *obj)
109 Elm_Segment_Item *it;
112 wd = elm_widget_data_get(obj);
115 _elm_widget_mirrored_reload(obj);
116 rtl = elm_widget_mirrored_get(obj);
117 edje_object_mirrored_set(wd->base, rtl);
119 _elm_theme_object_set(obj, wd->base, "segment_control", "base",
120 elm_widget_style_get(obj));
121 edje_object_scale_set(wd->base, elm_widget_scale_get(wd->base)
122 *_elm_config->scale);
124 EINA_LIST_FOREACH(wd->seg_items, l, it)
126 _elm_theme_object_set(obj, it->base.view, "segment_control",
127 "item", elm_widget_style_get(obj));
128 edje_object_scale_set(it->base.view, elm_widget_scale_get(it->base.view)
129 *_elm_config->scale);
130 edje_object_mirrored_set(it->base.view, rtl);
137 _disable_hook(Evas_Object *obj)
141 wd = elm_widget_data_get(obj);
146 // TODO: Elm_widget elm_widget_focus_list_next_get supports only Elm_widget list,
147 // Not the Elm_Widget_item. Focus switching with in widget not supported until
148 // it is supported in elm_widget
151 _elm_list_data_get(const Eina_List *list)
153 Elm_Segment_Item *it = eina_list_data_get(list);
157 edje_object_signal_emit(it->base.view, "elm,state,segment,selected", "elm");
158 return it->base.view;
162 _focus_next_hook(const Evas_Object *obj, Elm_Focus_Direction dir,
167 const Eina_List *items;
168 void *(*list_data_get) (const Eina_List *list);
170 wd = elm_widget_data_get(obj);
171 if ((!wd)) return EINA_FALSE;
174 /* TODO: Change this to use other chain */
175 if ((items = elm_widget_focus_custom_chain_get(obj)))
176 list_data_get = eina_list_data_get;
179 items = wd->seg_items;
180 list_data_get = _elm_list_data_get;
181 if (!items) return EINA_FALSE;
183 return elm_widget_focus_list_next_get(obj, items, list_data_get, dir, next);
188 _item_free(Elm_Segment_Item *it)
194 wd = elm_widget_item_data_get(it);
197 if (wd->selected_item == it) wd->selected_item = NULL;
198 if (wd->seg_items) wd->seg_items = eina_list_remove(wd->seg_items, it);
200 elm_widget_item_pre_notify_del(it);
202 if (it->icon) evas_object_del(it->icon);
203 if (it->label) eina_stringshare_del(it->label);
205 elm_widget_item_del(it);
209 _segment_off(Elm_Segment_Item *it)
215 wd = elm_widget_item_data_get(it);
218 edje_object_signal_emit(it->base.view, "elm,state,segment,normal", "elm");
220 if (wd->selected_item == it) wd->selected_item = NULL;
224 _segment_on(Elm_Segment_Item *it)
230 wd = elm_widget_item_data_get(it);
232 if (it == wd->selected_item) return;
234 if (wd->selected_item) _segment_off(wd->selected_item);
236 edje_object_signal_emit(it->base.view, "elm,state,segment,selected", "elm");
238 wd->selected_item = it;
239 evas_object_smart_callback_call(wd->obj, SIG_CHANGED,
240 (void *)(unsigned long)it->seg_index);
244 _position_items(Widget_Data *wd)
247 Elm_Segment_Item *it;
249 int bx, by, bw, bh, pos;
251 wd->item_count = eina_list_count(wd->seg_items);
252 if (wd->item_count <= 0) return;
254 evas_object_geometry_get(wd->base, &bx, &by, &bw, &bh);
255 wd->item_width = bw / wd->item_count;
257 rtl = elm_widget_mirrored_get(wd->obj);
260 pos = bx + bw - wd->item_width;
264 EINA_LIST_FOREACH(wd->seg_items, l, it)
266 evas_object_move(it->base.view, pos, by);
267 evas_object_resize(it->base.view, wd->item_width, bh);
269 pos -= wd->item_width;
271 pos += wd->item_width;
273 ll = eina_list_last(wd->seg_items);
275 evas_object_resize(it->base.view,
276 (bw - ((wd->item_count - 1) * wd->item_width)),
278 _sizing_eval(wd->obj);
282 _on_move_resize(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
283 void *event_info __UNUSED__)
287 wd = elm_widget_data_get(data);
295 _mouse_up(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
299 Elm_Segment_Item *it;
300 Evas_Event_Mouse_Up *ev;
301 Evas_Coord x, y, w, h;
306 wd = elm_widget_item_data_get(it);
309 if (elm_widget_disabled_get(wd->obj)) return;
311 if (it == wd->selected_item) return;
314 evas_object_geometry_get(it->base.view, &x, &y, &w, &h);
316 if ((ev->canvas.x >= x) && (ev->output.x <= (x + w)) && (ev->canvas.y >= y)
317 && (ev->canvas.y <= (y + h)))
320 edje_object_signal_emit(it->base.view, "elm,state,segment,normal", "elm");
324 _mouse_down(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
325 void *event_info __UNUSED__)
328 Elm_Segment_Item *it;
333 wd = elm_widget_item_data_get(it);
336 if (elm_widget_disabled_get(wd->obj)) return;
338 if (it == wd->selected_item) return;
340 edje_object_signal_emit(it->base.view, "elm,state,segment,pressed", "elm");
344 _swallow_item_objects(Elm_Segment_Item *it)
350 edje_object_part_swallow(it->base.view, "elm.swallow.icon", it->icon);
351 edje_object_signal_emit(it->base.view, "elm,state,icon,visible", "elm");
354 edje_object_signal_emit(it->base.view, "elm,state,icon,hidden", "elm");
358 edje_object_part_text_set(it->base.view, "elm.text", it->label);
359 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
362 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
363 edje_object_message_signal_process(it->base.view);
367 _update_list(Widget_Data *wd)
370 Elm_Segment_Item *it;
376 if (wd->item_count == 1)
378 it = eina_list_nth(wd->seg_items, 0);
381 //Set the segment type
382 edje_object_signal_emit(it->base.view,
383 "elm,type,segment,single", "elm");
385 //Set the segment state
386 if (wd->selected_item == it)
387 edje_object_signal_emit(it->base.view,
388 "elm,state,segment,selected", "elm");
390 edje_object_signal_emit(it->base.view,
391 "elm,state,segment,normal", "elm");
393 if (elm_widget_disabled_get(wd->obj))
394 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
396 edje_object_signal_emit(it->base.view, "elm,state,enabled", "elm");
398 _swallow_item_objects(it);
402 rtl = elm_widget_mirrored_get(wd->obj);
403 EINA_LIST_FOREACH(wd->seg_items, l, it)
407 //Set the segment type
411 edje_object_signal_emit(it->base.view,
412 "elm,type,segment,right", "elm");
414 edje_object_signal_emit(it->base.view,
415 "elm,type,segment,left", "elm");
417 else if (idx == (wd->item_count - 1))
420 edje_object_signal_emit(it->base.view,
421 "elm,type,segment,left", "elm");
423 edje_object_signal_emit(it->base.view,
424 "elm,type,segment,right", "elm");
427 edje_object_signal_emit(it->base.view,
428 "elm,type,segment,middle", "elm");
430 //Set the segment state
431 if (wd->selected_item == it)
432 edje_object_signal_emit(it->base.view,
433 "elm,state,segment,selected", "elm");
435 edje_object_signal_emit(it->base.view,
436 "elm,state,segment,normal", "elm");
438 if (elm_widget_disabled_get(wd->obj))
439 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
441 edje_object_signal_emit(it->base.view, "elm,state,enabled", "elm");
443 _swallow_item_objects(it);
448 static Elm_Segment_Item *
449 _item_find(const Evas_Object *obj, int idx)
452 Elm_Segment_Item *it;
454 wd = elm_widget_data_get(obj);
455 if (!wd) return NULL;
457 it = eina_list_nth(wd->seg_items, idx);
461 static Elm_Segment_Item*
462 _item_new(Evas_Object *obj, Evas_Object *icon, const char *label)
464 Elm_Segment_Item *it;
467 wd = elm_widget_data_get(obj);
468 if (!wd) return NULL;
470 it = elm_widget_item_new(obj, Elm_Segment_Item);
471 if (!it) return NULL;
472 elm_widget_item_data_set(it, wd);
474 it->base.view = edje_object_add(evas_object_evas_get(obj));
475 edje_object_scale_set(it->base.view, elm_widget_scale_get(it->base.view)
476 *_elm_config->scale);
477 evas_object_smart_member_add(it->base.view, obj);
478 elm_widget_sub_object_add(obj, it->base.view);
479 evas_object_clip_set(it->base.view, evas_object_clip_get(obj));
481 _elm_theme_object_set(obj, it->base.view, "segment_control", "item",
482 elm_object_style_get(obj));
483 edje_object_mirrored_set(it->base.view,
484 elm_widget_mirrored_get(it->base.widget));
487 eina_stringshare_replace(&it->label, label);
489 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
491 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
492 edje_object_message_signal_process(it->base.view);
493 edje_object_part_text_set(it->base.view, "elm.text", label);
496 if (it->icon) elm_widget_sub_object_add(it->base.view, it->icon);
497 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_DOWN,
499 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_UP,
501 evas_object_show(it->base.view);
507 * Create new SegmentControl.
508 * @param [in] parent The parent object
509 * @return The new object or NULL if it cannot be created
511 * @ingroup SegmentControl
514 elm_segment_control_add(Evas_Object *parent)
520 ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
522 ELM_SET_WIDTYPE(widtype, "segment_control");
523 elm_widget_type_set(obj, "segment_control");
524 elm_widget_sub_object_add(parent, obj);
525 elm_widget_data_set(obj, wd);
526 elm_widget_del_hook_set(obj, _del_hook);
527 elm_widget_theme_hook_set(obj, _theme_hook);
528 elm_widget_disable_hook_set(obj, _disable_hook);
530 // TODO: Focus switch support to Elm_widget_Item not supported yet.
532 elm_widget_focus_next_hook_set(obj, _focus_next_hook);
537 wd->base = edje_object_add(e);
538 edje_object_scale_set(wd->base, elm_widget_scale_get(wd->base)
539 *_elm_config->scale);
540 _elm_theme_object_set(obj, wd->base, "segment_control", "base", "default");
541 elm_widget_resize_object_set(obj, wd->base);
543 evas_object_event_callback_add(obj, EVAS_CALLBACK_RESIZE,
544 _on_move_resize, obj);
545 evas_object_event_callback_add(obj, EVAS_CALLBACK_MOVE,
546 _on_move_resize, obj);
548 evas_object_smart_callbacks_descriptions_set(obj, _signals);
554 * Add new segment item to SegmentControl.
555 * @param [in] obj The SegmentControl object
556 * @param [in] icon Any Objects like icon, Label, layout etc
557 * @param [in] label The label for added segment item.
558 * Note that, NULL is different from empty string "".
559 * @return The new segment item or NULL if it cannot be created
561 * @ingroup SegmentControl
563 EAPI Elm_Segment_Item *
564 elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon,
567 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
568 Elm_Segment_Item *it;
571 wd = elm_widget_data_get(obj);
572 if (!wd) return NULL;
574 it = _item_new(obj, icon, label);
575 if (!it) return NULL;
577 wd->seg_items = eina_list_append(wd->seg_items, it);
584 * Insert a new segment item to SegmentControl.
585 * @param [in] obj The SegmentControl object
586 * @param [in] icon Any Objects like icon, Label, layout etc
587 * @param [in] label The label for added segment item.
588 * Note that, NULL is different from empty string "".
589 * @param [in] index Segment item location. Value should be between 0 and
590 * Existing total item count( @see elm_segment_control_item_count_get() )
591 * @return The new segment item or NULL if it cannot be created
593 * @ingroup SegmentControl
595 EAPI Elm_Segment_Item *
596 elm_segment_control_item_insert_at(Evas_Object *obj, Evas_Object *icon,
597 const char *label, int idx)
599 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
600 Elm_Segment_Item *it, *it_rel;
603 wd = elm_widget_data_get(obj);
604 if (!wd) return NULL;
605 if (idx < 0) idx = 0;
607 it = _item_new(obj, icon, label);
608 if (!it) return NULL;
610 it_rel = _item_find(obj, idx);
613 wd->seg_items = eina_list_prepend_relative(wd->seg_items, it, it_rel);
615 wd->seg_items = eina_list_append(wd->seg_items, it);
622 * Delete a segment item from SegmentControl
623 * @param [in] obj The SegmentControl object
624 * @param [in] it The segment item to be deleted
626 * @ingroup SegmentControl
629 elm_segment_control_item_del(Elm_Segment_Item *it)
631 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
634 wd = elm_widget_item_data_get(it);
642 * Delete a segment item of given index from SegmentControl
643 * @param [in] obj The SegmentControl object
644 * @param [in] index The position at which segment item to be deleted.
646 * @ingroup SegmentControl
649 elm_segment_control_item_del_at(Evas_Object *obj, int idx)
651 ELM_CHECK_WIDTYPE(obj, widtype);
652 Elm_Segment_Item *it;
655 wd = elm_widget_data_get(obj);
658 it = _item_find(obj, idx);
666 * Get the label of a segment item.
667 * @param [in] obj The SegmentControl object
668 * @param [in] index The index of the segment item
669 * @return The label of the segment item
671 * @ingroup SegmentControl
674 elm_segment_control_item_label_get(const Evas_Object *obj, int idx)
676 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
677 Elm_Segment_Item *it;
679 it = _item_find(obj, idx);
681 if (it) return it->label;
687 * Set the label of a segment item.
688 * @param [in] it The SegmentControl Item
689 * @param [in] label New label text.
691 * @ingroup SegmentControl
694 elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label)
696 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
699 wd = elm_widget_item_data_get(it);
702 eina_stringshare_replace(&it->label, label);
704 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
706 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
707 edje_object_message_signal_process(it->base.view);
708 //label can be NULL also.
709 edje_object_part_text_set(it->base.view, "elm.text", it->label);
713 * Get the icon of a segment item of SegmentControl
714 * @param [in] obj The SegmentControl object
715 * @param [in] index The index of the segment item
716 * @return The icon object.
718 * @ingroup SegmentControl
721 elm_segment_control_item_icon_get(const Evas_Object *obj, int idx)
723 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
724 Elm_Segment_Item *it;
726 it = _item_find(obj, idx);
728 if (it) return it->icon;
734 * Set the Icon to the segment item
735 * @param [in] it The SegmentControl Item
736 * @param [in] icon Objects like Layout, Icon, Label etc...
738 * @ingroup SegmentControl
741 elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon)
743 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
745 //Remove the existing icon
748 edje_object_part_unswallow(it->base.view, it->icon);
749 evas_object_del(it->icon);
756 elm_widget_sub_object_add(it->base.view, it->icon);
757 edje_object_part_swallow(it->base.view, "elm.swallow.icon", it->icon);
758 edje_object_signal_emit(it->base.view, "elm,state,icon,visible", "elm");
761 edje_object_signal_emit(it->base.view, "elm,state,icon,hidden", "elm");
765 * Get the Segment items count from SegmentControl
766 * @param [in] obj The SegmentControl object
767 * @return Segment items count.
769 * @ingroup SegmentControl
772 elm_segment_control_item_count_get(const Evas_Object *obj)
774 ELM_CHECK_WIDTYPE(obj, widtype) 0;
777 wd = elm_widget_data_get(obj);
780 return eina_list_count(wd->seg_items);
784 * Get the base object of segment item.
785 * @param [in] it The Segment item
786 * @return obj The base object of the segment item.
788 * @ingroup SegmentControl
791 elm_segment_control_item_object_get(const Elm_Segment_Item *it)
793 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, NULL);
795 return it->base.view;
799 * Get the selected segment item in the SegmentControl
800 * @param [in] obj The SegmentControl object
801 * @return Selected Segment Item. NULL if none of segment item is selected.
803 * @ingroup SegmentControl
805 EAPI Elm_Segment_Item*
806 elm_segment_control_item_selected_get(const Evas_Object *obj)
808 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
811 wd = elm_widget_data_get(obj);
812 if (!wd) return NULL;
814 return wd->selected_item;
818 * Select/unselect a particular segment item of SegmentControl
819 * @param [in] it The Segment item that is to be selected or unselected.
820 * @param [in] select Passing EINA_TRUE will select the segment item and
821 * EINA_FALSE will unselect.
823 * @ingroup SegmentControl
826 elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool selected)
828 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
831 wd = elm_widget_item_data_get(it);
834 if (it == wd->selected_item)
836 //already in selected state.
837 if (selected) return;
849 * Get the Segment Item from the specified Index.
850 * @param [in] obj The Segment Control object.
851 * @param [in] index The index of the segment item.
852 * @return The Segment item.
854 * @ingroup SegmentControl
856 EAPI Elm_Segment_Item *
857 elm_segment_control_item_get(const Evas_Object *obj, int idx)
859 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
860 Elm_Segment_Item *it;
862 it = _item_find(obj, idx);
868 * Get the index of a Segment item in the SegmentControl
869 * @param [in] it The Segment Item.
870 * @return Segment Item index.
872 * @ingroup SegmentControl
875 elm_segment_control_item_index_get(const Elm_Segment_Item *it)
877 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, -1);
879 return it->seg_index;