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;
256 rtl = elm_widget_mirrored_get(wd->obj);
259 pos = bx + bw - wd->item_width;
263 EINA_LIST_FOREACH(wd->seg_items, l, it)
265 evas_object_move(it->base.view, pos, by);
266 evas_object_resize(it->base.view, wd->item_width, bh);
268 pos -= wd->item_width;
270 pos += wd->item_width;
272 _sizing_eval(wd->obj);
276 _on_move_resize(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
277 void *event_info __UNUSED__)
281 wd = elm_widget_data_get(data);
289 _mouse_up(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
293 Elm_Segment_Item *it;
294 Evas_Event_Mouse_Up *ev;
295 Evas_Coord x, y, w, h;
300 wd = elm_widget_item_data_get(it);
303 if (elm_widget_disabled_get(wd->obj)) return;
305 if (it == wd->selected_item) return;
308 evas_object_geometry_get(it->base.view, &x, &y, &w, &h);
310 if ((ev->canvas.x >= x) && (ev->output.x <= (x + w)) && (ev->canvas.y >= y)
311 && (ev->canvas.y <= (y + h)))
314 edje_object_signal_emit(it->base.view, "elm,state,segment,normal", "elm");
318 _mouse_down(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
319 void *event_info __UNUSED__)
322 Elm_Segment_Item *it;
327 wd = elm_widget_item_data_get(it);
330 if (elm_widget_disabled_get(wd->obj)) return;
332 if (it == wd->selected_item) return;
334 edje_object_signal_emit(it->base.view, "elm,state,segment,pressed", "elm");
338 _swallow_item_objects(Elm_Segment_Item *it)
344 edje_object_part_swallow(it->base.view, "elm.swallow.icon", it->icon);
345 edje_object_signal_emit(it->base.view, "elm,state,icon,visible", "elm");
348 edje_object_signal_emit(it->base.view, "elm,state,icon,hidden", "elm");
352 edje_object_part_text_set(it->base.view, "elm.text", it->label);
353 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
356 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
357 edje_object_message_signal_process(it->base.view);
361 _update_list(Widget_Data *wd)
364 Elm_Segment_Item *it;
370 if (wd->item_count == 1)
372 it = eina_list_nth(wd->seg_items, 0);
375 //Set the segment type
376 edje_object_signal_emit(it->base.view,
377 "elm,type,segment,single", "elm");
379 //Set the segment state
380 if (wd->selected_item == it)
381 edje_object_signal_emit(it->base.view,
382 "elm,state,segment,selected", "elm");
384 edje_object_signal_emit(it->base.view,
385 "elm,state,segment,normal", "elm");
387 if (elm_widget_disabled_get(wd->obj))
388 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
390 edje_object_signal_emit(it->base.view, "elm,state,enabled", "elm");
392 _swallow_item_objects(it);
396 rtl = elm_widget_mirrored_get(wd->obj);
397 EINA_LIST_FOREACH(wd->seg_items, l, it)
401 //Set the segment type
405 edje_object_signal_emit(it->base.view,
406 "elm,type,segment,right", "elm");
408 edje_object_signal_emit(it->base.view,
409 "elm,type,segment,left", "elm");
411 else if (idx == (wd->item_count - 1))
414 edje_object_signal_emit(it->base.view,
415 "elm,type,segment,left", "elm");
417 edje_object_signal_emit(it->base.view,
418 "elm,type,segment,right", "elm");
421 edje_object_signal_emit(it->base.view,
422 "elm,type,segment,middle", "elm");
424 //Set the segment state
425 if (wd->selected_item == it)
426 edje_object_signal_emit(it->base.view,
427 "elm,state,segment,selected", "elm");
429 edje_object_signal_emit(it->base.view,
430 "elm,state,segment,normal", "elm");
432 if (elm_widget_disabled_get(wd->obj))
433 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
435 edje_object_signal_emit(it->base.view, "elm,state,enabled", "elm");
437 _swallow_item_objects(it);
442 static Elm_Segment_Item *
443 _item_find(const Evas_Object *obj, int idx)
446 Elm_Segment_Item *it;
448 wd = elm_widget_data_get(obj);
449 if (!wd) return NULL;
451 it = eina_list_nth(wd->seg_items, idx);
455 static Elm_Segment_Item*
456 _item_new(Evas_Object *obj, Evas_Object *icon, const char *label)
458 Elm_Segment_Item *it;
461 wd = elm_widget_data_get(obj);
462 if (!wd) return NULL;
464 it = elm_widget_item_new(obj, Elm_Segment_Item);
465 if (!it) return NULL;
466 elm_widget_item_data_set(it, wd);
468 it->base.view = edje_object_add(evas_object_evas_get(obj));
469 edje_object_scale_set(it->base.view, elm_widget_scale_get(it->base.view)
470 *_elm_config->scale);
471 evas_object_smart_member_add(it->base.view, obj);
472 elm_widget_sub_object_add(obj, it->base.view);
473 evas_object_clip_set(it->base.view, evas_object_clip_get(obj));
475 _elm_theme_object_set(obj, it->base.view, "segment_control", "item",
476 elm_object_style_get(obj));
477 edje_object_mirrored_set(it->base.view,
478 elm_widget_mirrored_get(it->base.widget));
481 eina_stringshare_replace(&it->label, label);
483 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
485 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
486 edje_object_message_signal_process(it->base.view);
487 edje_object_part_text_set(it->base.view, "elm.text", label);
490 if (it->icon) elm_widget_sub_object_add(it->base.view, it->icon);
491 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_DOWN,
493 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_UP,
495 evas_object_show(it->base.view);
501 * Create new SegmentControl.
502 * @param [in] parent The parent object
503 * @return The new object or NULL if it cannot be created
505 * @ingroup SegmentControl
508 elm_segment_control_add(Evas_Object *parent)
514 ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
516 ELM_SET_WIDTYPE(widtype, "segment_control");
517 elm_widget_type_set(obj, "segment_control");
518 elm_widget_sub_object_add(parent, obj);
519 elm_widget_data_set(obj, wd);
520 elm_widget_del_hook_set(obj, _del_hook);
521 elm_widget_theme_hook_set(obj, _theme_hook);
522 elm_widget_disable_hook_set(obj, _disable_hook);
524 // TODO: Focus switch support to Elm_widget_Item not supported yet.
526 elm_widget_focus_next_hook_set(obj, _focus_next_hook);
531 wd->base = edje_object_add(e);
532 edje_object_scale_set(wd->base, elm_widget_scale_get(wd->base)
533 *_elm_config->scale);
534 _elm_theme_object_set(obj, wd->base, "segment_control", "base", "default");
535 elm_widget_resize_object_set(obj, wd->base);
537 evas_object_event_callback_add(obj, EVAS_CALLBACK_RESIZE,
538 _on_move_resize, obj);
539 evas_object_event_callback_add(obj, EVAS_CALLBACK_MOVE,
540 _on_move_resize, obj);
542 evas_object_smart_callbacks_descriptions_set(obj, _signals);
548 * Add new segment item to SegmentControl.
549 * @param [in] obj The SegmentControl object
550 * @param [in] icon Any Objects like icon, Label, layout etc
551 * @param [in] label The label for added segment item.
552 * Note that, NULL is different from empty string "".
553 * @return The new segment item or NULL if it cannot be created
555 * @ingroup SegmentControl
557 EAPI Elm_Segment_Item *
558 elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon,
561 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
562 Elm_Segment_Item *it;
565 wd = elm_widget_data_get(obj);
566 if (!wd) return NULL;
568 it = _item_new(obj, icon, label);
569 if (!it) return NULL;
571 wd->seg_items = eina_list_append(wd->seg_items, it);
578 * Insert a new segment item to SegmentControl.
579 * @param [in] obj The SegmentControl object
580 * @param [in] icon Any Objects like icon, Label, layout etc
581 * @param [in] label The label for added segment item.
582 * Note that, NULL is different from empty string "".
583 * @param [in] index Segment item location. Value should be between 0 and
584 * Existing total item count( @see elm_segment_control_item_count_get() )
585 * @return The new segment item or NULL if it cannot be created
587 * @ingroup SegmentControl
589 EAPI Elm_Segment_Item *
590 elm_segment_control_item_insert_at(Evas_Object *obj, Evas_Object *icon,
591 const char *label, int idx)
593 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
594 Elm_Segment_Item *it, *it_rel;
597 wd = elm_widget_data_get(obj);
598 if (!wd) return NULL;
599 if (idx < 0) idx = 0;
601 it = _item_new(obj, icon, label);
602 if (!it) return NULL;
604 it_rel = _item_find(obj, idx);
607 wd->seg_items = eina_list_prepend_relative(wd->seg_items, it, it_rel);
609 wd->seg_items = eina_list_append(wd->seg_items, it);
616 * Delete a segment item from SegmentControl
617 * @param [in] obj The SegmentControl object
618 * @param [in] it The segment item to be deleted
620 * @ingroup SegmentControl
623 elm_segment_control_item_del(Elm_Segment_Item *it)
625 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
628 wd = elm_widget_item_data_get(it);
636 * Delete a segment item of given index from SegmentControl
637 * @param [in] obj The SegmentControl object
638 * @param [in] index The position at which segment item to be deleted.
640 * @ingroup SegmentControl
643 elm_segment_control_item_del_at(Evas_Object *obj, int idx)
645 ELM_CHECK_WIDTYPE(obj, widtype);
646 Elm_Segment_Item *it;
649 wd = elm_widget_data_get(obj);
652 it = _item_find(obj, idx);
660 * Get the label of a segment item.
661 * @param [in] obj The SegmentControl object
662 * @param [in] index The index of the segment item
663 * @return The label of the segment item
665 * @ingroup SegmentControl
668 elm_segment_control_item_label_get(const Evas_Object *obj, int idx)
670 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
671 Elm_Segment_Item *it;
673 it = _item_find(obj, idx);
675 if (it) return it->label;
681 * Set the label of a segment item.
682 * @param [in] it The SegmentControl Item
683 * @param [in] label New label text.
685 * @ingroup SegmentControl
688 elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label)
690 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
693 wd = elm_widget_item_data_get(it);
696 eina_stringshare_replace(&it->label, label);
698 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
700 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
701 edje_object_message_signal_process(it->base.view);
702 //label can be NULL also.
703 edje_object_part_text_set(it->base.view, "elm.text", it->label);
707 * Get the icon of a segment item of SegmentControl
708 * @param [in] obj The SegmentControl object
709 * @param [in] index The index of the segment item
710 * @return The icon object.
712 * @ingroup SegmentControl
715 elm_segment_control_item_icon_get(const Evas_Object *obj, int idx)
717 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
718 Elm_Segment_Item *it;
720 it = _item_find(obj, idx);
722 if (it) return it->icon;
728 * Set the Icon to the segment item
729 * @param [in] it The SegmentControl Item
730 * @param [in] icon Objects like Layout, Icon, Label etc...
732 * @ingroup SegmentControl
735 elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon)
737 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
739 //Remove the existing icon
742 edje_object_part_unswallow(it->base.view, it->icon);
743 evas_object_del(it->icon);
750 elm_widget_sub_object_add(it->base.view, it->icon);
751 edje_object_part_swallow(it->base.view, "elm.swallow.icon", it->icon);
752 edje_object_signal_emit(it->base.view, "elm,state,icon,visible", "elm");
755 edje_object_signal_emit(it->base.view, "elm,state,icon,hidden", "elm");
759 * Get the Segment items count from SegmentControl
760 * @param [in] obj The SegmentControl object
761 * @return Segment items count.
763 * @ingroup SegmentControl
766 elm_segment_control_item_count_get(const Evas_Object *obj)
768 ELM_CHECK_WIDTYPE(obj, widtype) 0;
771 wd = elm_widget_data_get(obj);
774 return eina_list_count(wd->seg_items);
778 * Get the base object of segment item.
779 * @param [in] it The Segment item
780 * @return obj The base object of the segment item.
782 * @ingroup SegmentControl
785 elm_segment_control_item_object_get(const Elm_Segment_Item *it)
787 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, NULL);
789 return it->base.view;
793 * Get the selected segment item in the SegmentControl
794 * @param [in] obj The SegmentControl object
795 * @return Selected Segment Item. NULL if none of segment item is selected.
797 * @ingroup SegmentControl
799 EAPI Elm_Segment_Item*
800 elm_segment_control_item_selected_get(const Evas_Object *obj)
802 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
805 wd = elm_widget_data_get(obj);
806 if (!wd) return NULL;
808 return wd->selected_item;
812 * Select/unselect a particular segment item of SegmentControl
813 * @param [in] it The Segment item that is to be selected or unselected.
814 * @param [in] select Passing EINA_TRUE will select the segment item and
815 * EINA_FALSE will unselect.
817 * @ingroup SegmentControl
820 elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool selected)
822 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
825 wd = elm_widget_item_data_get(it);
828 if (it == wd->selected_item)
830 //already in selected state.
831 if (selected) return;
843 * Get the Segment Item from the specified Index.
844 * @param [in] obj The Segment Control object.
845 * @param [in] index The index of the segment item.
846 * @return The Segment item.
848 * @ingroup SegmentControl
850 EAPI Elm_Segment_Item *
851 elm_segment_control_item_get(const Evas_Object *obj, int idx)
853 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
854 Elm_Segment_Item *it;
856 it = _item_find(obj, idx);
862 * Get the index of a Segment item in the SegmentControl
863 * @param [in] it The Segment Item.
864 * @return Segment Item index.
866 * @ingroup SegmentControl
869 elm_segment_control_item_index_get(const Elm_Segment_Item *it)
871 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, -1);
873 return it->seg_index;