1 #include <Elementary.h>
5 * @defgroup SegmentControl SegmentControl
7 * SegmentControl Widget is a horizontal control made of multiple segment items,
8 * each segment item functioning similar to discrete two state button. A segment
9 * control groups the the items together and provides compact single button with
10 * multiple equal size segments. Segment item size is determined by base widget
11 * size and the number of items added.
12 * Only one Segment item can be at selected state. A segment item can display
13 * combination of Text and any Evas_Object like Images or other widget.
15 * Signals that you can add callbacks for are:
17 * "changed" -when the user clicks on a segment item which is not previously
18 * selected and get selected. The event_info parameter is the
21 typedef struct _Widget_Data Widget_Data;
29 Elm_Segment_Item *selected_item;
33 struct _Elm_Segment_Item
41 static const char *widtype = NULL;
42 static void _sizing_eval(Evas_Object *obj);
43 static void _del_hook(Evas_Object *obj);
44 static void _theme_hook(Evas_Object *obj);
45 static void _disable_hook(Evas_Object *obj);
46 static void _item_free(Elm_Segment_Item *it);
47 static void _segment_off(Elm_Segment_Item *it);
48 static void _segment_on(Elm_Segment_Item *it);
49 static void _position_items(Widget_Data *wd);
50 static void _on_move_resize(void *data, Evas *e __UNUSED__, Evas_Object *obj
51 __UNUSED__, void *event_info __UNUSED__);
52 static void _mouse_up(void *data, Evas *e __UNUSED__, Evas_Object *obj
53 __UNUSED__, void *event_info __UNUSED__);
54 static void _mouse_down(void *data, Evas *e __UNUSED__, Evas_Object *obj
55 __UNUSED__, void *event_info __UNUSED__);
56 static void _swallow_item_objects(Elm_Segment_Item *it);
57 static void _update_list(Widget_Data *wd);
58 static Elm_Segment_Item * _item_find(const Evas_Object *obj, int index);
59 static Elm_Segment_Item* _item_new(Evas_Object *obj, Evas_Object *icon,
62 static const char SIG_CHANGED[] = "changed";
64 static const Evas_Smart_Cb_Description _signals[] = {
70 _sizing_eval(Evas_Object *obj)
73 Evas_Coord minw = -1, minh = -1;
76 wd = elm_widget_data_get(obj);
79 elm_coords_finger_size_adjust(wd->item_count, &minw, 1, &minh);
80 edje_object_size_min_restricted_calc(wd->base, &minw, &minh, minw, minh);
81 elm_coords_finger_size_adjust(wd->item_count, &minw, 1, &minh);
83 evas_object_size_hint_min_get(obj, &w, &h);
84 if (w > minw) minw = w;
85 if (h > minh) minh = h;
86 evas_object_size_hint_min_set(obj, minw, minh);
90 _del_hook(Evas_Object *obj)
95 wd = elm_widget_data_get(obj);
98 EINA_LIST_FREE(wd->seg_items, it) _item_free(it);
104 _theme_hook(Evas_Object *obj)
108 Elm_Segment_Item *it;
111 wd = elm_widget_data_get(obj);
114 _elm_widget_mirrored_reload(obj);
115 rtl = elm_widget_mirrored_get(obj);
116 edje_object_mirrored_set(wd->base, rtl);
118 _elm_theme_object_set(obj, wd->base, "segment_control", "base",
119 elm_widget_style_get(obj));
120 edje_object_scale_set(wd->base, elm_widget_scale_get(wd->base)
121 *_elm_config->scale);
123 EINA_LIST_FOREACH(wd->seg_items, l, it)
125 _elm_theme_object_set(obj, it->base.view, "segment_control",
126 "item", elm_widget_style_get(obj));
127 edje_object_scale_set(it->base.view, elm_widget_scale_get(it->base.view)
128 *_elm_config->scale);
129 edje_object_mirrored_set(it->base.view, rtl);
136 _disable_hook(Evas_Object *obj)
140 wd = elm_widget_data_get(obj);
145 // TODO: Elm_widget elm_widget_focus_list_next_get supports only Elm_widget list,
146 // Not the Elm_Widget_item. Focus switching with in widget not supported until
147 // it is supported in elm_widget
150 _elm_list_data_get(const Eina_List *list)
152 Elm_Segment_Item *it = eina_list_data_get(list);
156 edje_object_signal_emit(it->base.view, "elm,state,segment,selected", "elm");
157 return it->base.view;
161 _focus_next_hook(const Evas_Object *obj, Elm_Focus_Direction dir,
166 const Eina_List *items;
167 void *(*list_data_get) (const Eina_List *list);
169 wd = elm_widget_data_get(obj);
170 if ((!wd)) return EINA_FALSE;
173 /* TODO: Change this to use other chain */
174 if ((items = elm_widget_focus_custom_chain_get(obj)))
175 list_data_get = eina_list_data_get;
178 items = wd->seg_items;
179 list_data_get = _elm_list_data_get;
180 if (!items) return EINA_FALSE;
182 return elm_widget_focus_list_next_get(obj, items, list_data_get, dir, next);
187 _item_free(Elm_Segment_Item *it)
193 wd = elm_widget_item_data_get(it);
196 if (wd->selected_item == it) wd->selected_item = NULL;
197 if (wd->seg_items) wd->seg_items = eina_list_remove(wd->seg_items, it);
199 elm_widget_item_pre_notify_del(it);
201 if (it->icon) evas_object_del(it->icon);
202 if (it->label) eina_stringshare_del(it->label);
204 elm_widget_item_del(it);
208 _segment_off(Elm_Segment_Item *it)
214 wd = elm_widget_item_data_get(it);
217 edje_object_signal_emit(it->base.view, "elm,state,segment,normal", "elm");
219 if (wd->selected_item == it) wd->selected_item = NULL;
223 _segment_on(Elm_Segment_Item *it)
229 wd = elm_widget_item_data_get(it);
231 if (it == wd->selected_item) return;
233 if (wd->selected_item) _segment_off(wd->selected_item);
235 edje_object_signal_emit(it->base.view, "elm,state,segment,selected", "elm");
237 wd->selected_item = it;
238 evas_object_smart_callback_call(wd->obj, SIG_CHANGED, (void *)(unsigned long)it->seg_index);
242 _position_items(Widget_Data *wd)
245 Elm_Segment_Item *it;
247 int bx, by, bw, bh, pos;
249 wd->item_count = eina_list_count(wd->seg_items);
250 if (wd->item_count <= 0) return;
252 evas_object_geometry_get(wd->base, &bx, &by, &bw, &bh);
253 wd->item_width = bw / wd->item_count;
254 rtl = elm_widget_mirrored_get(wd->obj);
257 pos = bx + bw - wd->item_width;
261 EINA_LIST_FOREACH(wd->seg_items, l, it)
263 evas_object_move(it->base.view, pos, by);
264 evas_object_resize(it->base.view, wd->item_width, bh);
266 pos -= wd->item_width;
268 pos += wd->item_width;
270 _sizing_eval(wd->obj);
274 _on_move_resize(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
275 void *event_info __UNUSED__)
279 wd = elm_widget_data_get(data);
287 _mouse_up(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
291 Elm_Segment_Item *it;
292 Evas_Event_Mouse_Up *ev;
293 Evas_Coord x, y, w, h;
298 wd = elm_widget_item_data_get(it);
301 if (elm_widget_disabled_get(wd->obj)) return;
303 if (it == wd->selected_item) return;
306 evas_object_geometry_get(it->base.view, &x, &y, &w, &h);
308 if ((ev->output.x >= x) && (ev->output.x <= (x + w)) && (ev->output.y >= y)
309 && (ev->output.y <= (y + h)))
312 edje_object_signal_emit(it->base.view, "elm,state,segment,normal", "elm");
316 _mouse_down(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
317 void *event_info __UNUSED__)
320 Elm_Segment_Item *it;
325 wd = elm_widget_item_data_get(it);
328 if (elm_widget_disabled_get(wd->obj)) return;
330 if (it == wd->selected_item) return;
332 edje_object_signal_emit(it->base.view, "elm,state,segment,pressed", "elm");
336 _swallow_item_objects(Elm_Segment_Item *it)
342 edje_object_part_swallow(it->base.view, "elm.swallow.icon", it->icon);
343 edje_object_signal_emit(it->base.view, "elm,state,icon,visible", "elm");
346 edje_object_signal_emit(it->base.view, "elm,state,icon,hidden", "elm");
349 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
351 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
352 edje_object_message_signal_process(it->base.view);
356 _update_list(Widget_Data *wd)
359 Elm_Segment_Item *it;
365 if (wd->item_count == 1)
367 it = eina_list_nth(wd->seg_items, 0);
370 //Set the segment type
371 edje_object_signal_emit(it->base.view,
372 "elm,type,segment,single", "elm");
374 //Set the segment state
375 if (wd->selected_item == it)
376 edje_object_signal_emit(it->base.view,
377 "elm,state,segment,selected", "elm");
379 edje_object_signal_emit(it->base.view,
380 "elm,state,segment,normal", "elm");
382 if (elm_widget_disabled_get(wd->obj))
383 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
385 _swallow_item_objects(it);
389 rtl = elm_widget_mirrored_get(wd->obj);
390 EINA_LIST_FOREACH(wd->seg_items, l, it)
394 //Set the segment type
398 edje_object_signal_emit(it->base.view,
399 "elm,type,segment,right", "elm");
401 edje_object_signal_emit(it->base.view,
402 "elm,type,segment,left", "elm");
404 else if (idx == (wd->item_count - 1))
407 edje_object_signal_emit(it->base.view,
408 "elm,type,segment,left", "elm");
410 edje_object_signal_emit(it->base.view,
411 "elm,type,segment,right", "elm");
414 edje_object_signal_emit(it->base.view,
415 "elm,type,segment,middle", "elm");
417 //Set the segment state
418 if (wd->selected_item == it)
419 edje_object_signal_emit(it->base.view,
420 "elm,state,segment,selected", "elm");
422 edje_object_signal_emit(it->base.view,
423 "elm,state,segment,normal", "elm");
425 if (elm_widget_disabled_get(wd->obj))
426 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
428 _swallow_item_objects(it);
433 static Elm_Segment_Item *
434 _item_find(const Evas_Object *obj, int idx)
437 Elm_Segment_Item *it;
439 wd = elm_widget_data_get(obj);
440 if (!wd) return NULL;
442 it = eina_list_nth(wd->seg_items, idx);
446 static Elm_Segment_Item*
447 _item_new(Evas_Object *obj, Evas_Object *icon, const char *label)
449 Elm_Segment_Item *it;
452 wd = elm_widget_data_get(obj);
453 if (!wd) return NULL;
455 it = elm_widget_item_new(obj, Elm_Segment_Item);
456 if (!it) return NULL;
457 elm_widget_item_data_set(it, wd);
459 it->base.view = edje_object_add(evas_object_evas_get(obj));
460 edje_object_scale_set(it->base.view, elm_widget_scale_get(it->base.view)
461 *_elm_config->scale);
462 evas_object_smart_member_add(it->base.view, obj);
463 elm_widget_sub_object_add(obj, it->base.view);
464 _elm_theme_object_set(obj, it->base.view, "segment_control", "item",
465 elm_object_style_get(obj));
466 edje_object_mirrored_set(it->base.view,
467 elm_widget_mirrored_get(it->base.widget));
470 eina_stringshare_replace(&it->label, label);
472 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
474 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
475 edje_object_message_signal_process(it->base.view);
476 edje_object_part_text_set(it->base.view, "elm.text", label);
479 if (it->icon) elm_widget_sub_object_add(it->base.view, it->icon);
480 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_DOWN,
482 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_UP,
484 evas_object_show(it->base.view);
490 * Create new SegmentControl.
491 * @param [in] parent The parent object
492 * @return The new object or NULL if it cannot be created
494 * @ingroup SegmentControl
497 elm_segment_control_add(Evas_Object *parent)
503 ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
505 ELM_SET_WIDTYPE(widtype, "segment_control");
506 elm_widget_type_set(obj, "segment_control");
507 elm_widget_sub_object_add(parent, obj);
508 elm_widget_data_set(obj, wd);
509 elm_widget_del_hook_set(obj, _del_hook);
510 elm_widget_theme_hook_set(obj, _theme_hook);
511 elm_widget_disable_hook_set(obj, _disable_hook);
513 // TODO: Focus switch support to Elm_widget_Item not supported yet.
515 elm_widget_focus_next_hook_set(obj, _focus_next_hook);
520 wd->base = edje_object_add(e);
521 edje_object_scale_set(wd->base, elm_widget_scale_get(wd->base)
522 *_elm_config->scale);
523 _elm_theme_object_set(obj, wd->base, "segment_control", "base", "default");
524 elm_widget_resize_object_set(obj, wd->base);
526 evas_object_event_callback_add(obj, EVAS_CALLBACK_RESIZE,
527 _on_move_resize, obj);
528 evas_object_event_callback_add(obj, EVAS_CALLBACK_MOVE,
529 _on_move_resize, obj);
531 evas_object_smart_callbacks_descriptions_set(obj, _signals);
537 * Add new segment item to SegmentControl.
538 * @param [in] obj The SegmentControl object
539 * @param [in] icon Any Objects like icon, Label, layout etc
540 * @param [in] label The label for added segment item.
541 * Note that, NULL is different from empty string "".
542 * @return The new segment item or NULL if it cannot be created
544 * @ingroup SegmentControl
546 EAPI Elm_Segment_Item *
547 elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon,
550 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
551 Elm_Segment_Item *it;
554 wd = elm_widget_data_get(obj);
555 if (!wd) return NULL;
557 it = _item_new(obj, icon, label);
558 if (!it) return NULL;
560 wd->seg_items = eina_list_append(wd->seg_items, it);
567 * Insert a new segment item to SegmentControl.
568 * @param [in] obj The SegmentControl object
569 * @param [in] icon Any Objects like icon, Label, layout etc
570 * @param [in] label The label for added segment item.
571 * Note that, NULL is different from empty string "".
572 * @param [in] index Segment item location. Value should be between 0 and
573 * Existing total item count( @see elm_segment_control_item_count_get() )
574 * @return The new segment item or NULL if it cannot be created
576 * @ingroup SegmentControl
578 EAPI Elm_Segment_Item *
579 elm_segment_control_item_insert_at(Evas_Object *obj, Evas_Object *icon,
580 const char *label, int idx)
582 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
583 Elm_Segment_Item *it, *it_rel;
586 wd = elm_widget_data_get(obj);
587 if (!wd) return NULL;
588 if (idx < 0) idx = 0;
590 it = _item_new(obj, icon, label);
591 if (!it) return NULL;
593 it_rel = _item_find(obj, idx);
595 wd->seg_items = eina_list_prepend_relative(wd->seg_items, it, it_rel);
597 wd->seg_items = eina_list_append(wd->seg_items, it);
604 * Delete a segment item from SegmentControl
605 * @param [in] obj The SegmentControl object
606 * @param [in] it The segment item to be deleted
608 * @ingroup SegmentControl
611 elm_segment_control_item_del(Elm_Segment_Item *it)
613 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
616 wd = elm_widget_item_data_get(it);
624 * Delete a segment item of given index from SegmentControl
625 * @param [in] obj The SegmentControl object
626 * @param [in] index The position at which segment item to be deleted.
628 * @ingroup SegmentControl
631 elm_segment_control_item_del_at(Evas_Object *obj, int idx)
633 ELM_CHECK_WIDTYPE(obj, widtype);
634 Elm_Segment_Item *it;
637 wd = elm_widget_data_get(obj);
640 it = _item_find(obj, idx);
647 * Get the label of a segment item.
648 * @param [in] obj The SegmentControl object
649 * @param [in] index The index of the segment item
650 * @return The label of the segment item
652 * @ingroup SegmentControl
655 elm_segment_control_item_label_get(const Evas_Object *obj, int idx)
657 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
658 Elm_Segment_Item *it;
660 it = _item_find(obj, idx);
661 if (it) return it->label;
667 * Set the label of a segment item.
668 * @param [in] it The SegmentControl Item
669 * @param [in] label New label text.
671 * @ingroup SegmentControl
674 elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label)
676 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
679 wd = elm_widget_item_data_get(it);
682 eina_stringshare_replace(&it->label, label);
684 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
686 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
687 edje_object_message_signal_process(it->base.view);
688 //label can be NULL also.
689 edje_object_part_text_set(it->base.view, "elm.text", it->label);
693 * Get the icon of a segment item of SegmentControl
694 * @param [in] obj The SegmentControl object
695 * @param [in] index The index of the segment item
696 * @return The icon object.
698 * @ingroup SegmentControl
701 elm_segment_control_item_icon_get(const Evas_Object *obj, int idx)
703 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
704 Elm_Segment_Item *it;
706 it = _item_find(obj, idx);
707 if (it) return it->icon;
713 * Set the Icon to the segment item
714 * @param [in] it The SegmentControl Item
715 * @param [in] icon Objects like Layout, Icon, Label etc...
717 * @ingroup SegmentControl
720 elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon)
722 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
724 //Remove the existing icon
727 edje_object_part_unswallow(it->base.view, it->icon);
728 evas_object_del(it->icon);
735 elm_widget_sub_object_add(it->base.view, it->icon);
736 edje_object_part_swallow(it->base.view, "elm.swallow.icon", it->icon);
737 edje_object_signal_emit(it->base.view, "elm,state,icon,visible", "elm");
740 edje_object_signal_emit(it->base.view, "elm,state,icon,hidden", "elm");
744 * Get the Segment items count from SegmentControl
745 * @param [in] obj The SegmentControl object
746 * @return Segment items count.
748 * @ingroup SegmentControl
751 elm_segment_control_item_count_get(const Evas_Object *obj)
753 ELM_CHECK_WIDTYPE(obj, widtype) 0;
756 wd = elm_widget_data_get(obj);
759 return eina_list_count(wd->seg_items);
763 * Get the base object of segment item.
764 * @param [in] it The Segment item
765 * @return obj The base object of the segment item.
767 * @ingroup SegmentControl
770 elm_segment_control_item_object_get(const Elm_Segment_Item *it)
772 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, NULL);
774 return it->base.view;
778 * Get the selected segment item in the SegmentControl
779 * @param [in] obj The SegmentControl object
780 * @return Selected Segment Item. NULL if none of segment item is selected.
782 * @ingroup SegmentControl
784 EAPI Elm_Segment_Item*
785 elm_segment_control_item_selected_get(const Evas_Object *obj)
787 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
790 wd = elm_widget_data_get(obj);
791 if (!wd) return NULL;
793 return wd->selected_item;
797 * Select/unselect a particular segment item of SegmentControl
798 * @param [in] it The Segment item that is to be selected or unselected.
799 * @param [in] select Passing EINA_TRUE will select the segment item and
800 * EINA_FALSE will unselect.
802 * @ingroup SegmentControl
805 elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool selected)
807 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
810 wd = elm_widget_item_data_get(it);
813 if (it == wd->selected_item)
815 //already in selected state.
816 if (selected) return;
828 * Get the Segment Item from the specified Index.
829 * @param [in] obj The Segment Control object.
830 * @param [in] index The index of the segment item.
831 * @return The Segment item.
833 * @ingroup SegmentControl
835 EAPI Elm_Segment_Item *
836 elm_segment_control_item_get(const Evas_Object *obj, int idx)
838 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
839 Elm_Segment_Item *it;
841 it = _item_find(obj, idx);
847 * Get the index of a Segment item in the SegmentControl
848 * @param [in] it The Segment Item.
849 * @return Segment Item index.
851 * @ingroup SegmentControl
854 elm_segment_control_item_index_get(const Elm_Segment_Item *it)
856 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, -1);
858 return it->seg_index;