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,
63 _sizing_eval(Evas_Object *obj)
66 Evas_Coord minw = -1, minh = -1;
69 wd = elm_widget_data_get(obj);
72 elm_coords_finger_size_adjust(wd->item_count, &minw, 1, &minh);
73 edje_object_size_min_restricted_calc(wd->base, &minw, &minh, minw, minh);
74 elm_coords_finger_size_adjust(wd->item_count, &minw, 1, &minh);
76 evas_object_size_hint_min_get(obj, &w, &h);
77 if (w > minw) minw = w;
78 if (h > minh) minh = h;
79 evas_object_size_hint_min_set(obj, minw, minh);
83 _del_hook(Evas_Object *obj)
88 wd = elm_widget_data_get(obj);
91 EINA_LIST_FREE(wd->seg_items, it) _item_free(it);
97 _theme_hook(Evas_Object *obj)
101 Elm_Segment_Item *it;
104 wd = elm_widget_data_get(obj);
107 _elm_widget_mirrored_reload(obj);
108 rtl = elm_widget_mirrored_get(obj);
109 edje_object_mirrored_set(wd->base, rtl);
111 _elm_theme_object_set(obj, wd->base, "segment_control", "base",
112 elm_widget_style_get(obj));
113 edje_object_scale_set(wd->base, elm_widget_scale_get(wd->base)
114 *_elm_config->scale);
116 EINA_LIST_FOREACH(wd->seg_items, l, it)
118 _elm_theme_object_set(obj, it->base.view, "segment_control",
119 "item", elm_widget_style_get(obj));
120 edje_object_scale_set(it->base.view, elm_widget_scale_get(it->base.view)
121 *_elm_config->scale);
122 edje_object_mirrored_set(it->base.view, rtl);
129 _disable_hook(Evas_Object *obj)
133 wd = elm_widget_data_get(obj);
138 // TODO: Elm_widget elm_widget_focus_list_next_get supports only Elm_widget list,
139 // Not the Elm_Widget_item. Focus switching with in widget not supported until
140 // it is supported in elm_widget
143 _elm_list_data_get(const Eina_List *list)
145 Elm_Segment_Item *it = eina_list_data_get(list);
149 edje_object_signal_emit(it->base.view, "elm,state,segment,selected", "elm");
150 return it->base.view;
154 _focus_next_hook(const Evas_Object *obj, Elm_Focus_Direction dir,
159 const Eina_List *items;
160 void *(*list_data_get) (const Eina_List *list);
162 wd = elm_widget_data_get(obj);
163 if ((!wd)) return EINA_FALSE;
166 /* TODO: Change this to use other chain */
167 if ((items = elm_widget_focus_custom_chain_get(obj)))
168 list_data_get = eina_list_data_get;
171 items = wd->seg_items;
172 list_data_get = _elm_list_data_get;
173 if (!items) return EINA_FALSE;
175 return elm_widget_focus_list_next_get(obj, items, list_data_get, dir, next);
180 _item_free(Elm_Segment_Item *it)
186 wd = elm_widget_item_data_get(it);
189 if (wd->selected_item == it) wd->selected_item = NULL;
190 if (wd->seg_items) wd->seg_items = eina_list_remove(wd->seg_items, it);
192 elm_widget_item_pre_notify_del(it);
194 if (it->icon) evas_object_del(it->icon);
195 if (it->label) eina_stringshare_del(it->label);
197 elm_widget_item_del(it);
201 _segment_off(Elm_Segment_Item *it)
207 wd = elm_widget_item_data_get(it);
210 edje_object_signal_emit(it->base.view, "elm,state,segment,normal", "elm");
212 if (wd->selected_item == it) wd->selected_item = NULL;
216 _segment_on(Elm_Segment_Item *it)
222 wd = elm_widget_item_data_get(it);
224 if (it == wd->selected_item) return;
226 if (wd->selected_item) _segment_off(wd->selected_item);
228 edje_object_signal_emit(it->base.view, "elm,state,segment,selected", "elm");
230 wd->selected_item = it;
231 evas_object_smart_callback_call(wd->obj, "changed", (void*) it->seg_index);
235 _position_items(Widget_Data *wd)
238 Elm_Segment_Item *it;
240 int bx, by, bw, bh, pos;
242 wd->item_count = eina_list_count(wd->seg_items);
243 if (wd->item_count <= 0) return;
245 evas_object_geometry_get(wd->base, &bx, &by, &bw, &bh);
246 wd->item_width = bw / wd->item_count;
247 rtl = elm_widget_mirrored_get(wd->obj);
250 pos = bx + bw - wd->item_width;
254 EINA_LIST_FOREACH(wd->seg_items, l, it)
256 evas_object_move(it->base.view, pos, by);
257 evas_object_resize(it->base.view, wd->item_width, bh);
259 pos -= wd->item_width;
261 pos += wd->item_width;
263 _sizing_eval(wd->obj);
267 _on_move_resize(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
268 void *event_info __UNUSED__)
272 wd = elm_widget_data_get(data);
280 _mouse_up(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
284 Elm_Segment_Item *it;
285 Evas_Event_Mouse_Up *ev;
286 Evas_Coord x, y, w, h;
291 wd = elm_widget_item_data_get(it);
294 if (elm_widget_disabled_get(wd->obj)) return;
296 if (it == wd->selected_item) return;
299 evas_object_geometry_get(it->base.view, &x, &y, &w, &h);
301 if ((ev->output.x >= x) && (ev->output.x <= (x + w)) && (ev->output.y >= y)
302 && (ev->output.y <= (y + h)))
305 edje_object_signal_emit(it->base.view, "elm,state,segment,normal", "elm");
309 _mouse_down(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__,
310 void *event_info __UNUSED__)
313 Elm_Segment_Item *it;
318 wd = elm_widget_item_data_get(it);
321 if (elm_widget_disabled_get(wd->obj)) return;
323 if (it == wd->selected_item) return;
325 edje_object_signal_emit(it->base.view, "elm,state,segment,pressed", "elm");
329 _swallow_item_objects(Elm_Segment_Item *it)
335 edje_object_part_swallow(it->base.view, "elm.swallow.icon", it->icon);
336 edje_object_signal_emit(it->base.view, "elm,state,icon,visible", "elm");
339 edje_object_signal_emit(it->base.view, "elm,state,icon,hidden", "elm");
342 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
344 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
345 edje_object_message_signal_process(it->base.view);
349 _update_list(Widget_Data *wd)
352 Elm_Segment_Item *it;
358 if (wd->item_count == 1)
360 it = eina_list_nth(wd->seg_items, 0);
363 //Set the segment type
364 edje_object_signal_emit(it->base.view,
365 "elm,type,segment,single", "elm");
367 //Set the segment state
368 if (wd->selected_item == it)
369 edje_object_signal_emit(it->base.view,
370 "elm,state,segment,selected", "elm");
372 edje_object_signal_emit(it->base.view,
373 "elm,state,segment,normal", "elm");
375 if (elm_widget_disabled_get(wd->obj))
376 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
378 _swallow_item_objects(it);
382 rtl = elm_widget_mirrored_get(wd->obj);
383 EINA_LIST_FOREACH(wd->seg_items, l, it)
385 it->seg_index = index;
387 //Set the segment type
391 edje_object_signal_emit(it->base.view,
392 "elm,type,segment,right", "elm");
394 edje_object_signal_emit(it->base.view,
395 "elm,type,segment,left", "elm");
397 else if (index == (wd->item_count - 1))
400 edje_object_signal_emit(it->base.view,
401 "elm,type,segment,left", "elm");
403 edje_object_signal_emit(it->base.view,
404 "elm,type,segment,right", "elm");
407 edje_object_signal_emit(it->base.view,
408 "elm,type,segment,middle", "elm");
410 //Set the segment state
411 if (wd->selected_item == it)
412 edje_object_signal_emit(it->base.view,
413 "elm,state,segment,selected", "elm");
415 edje_object_signal_emit(it->base.view,
416 "elm,state,segment,normal", "elm");
418 if (elm_widget_disabled_get(wd->obj))
419 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
421 _swallow_item_objects(it);
426 static Elm_Segment_Item *
427 _item_find(const Evas_Object *obj, int index)
430 Elm_Segment_Item *it;
432 wd = elm_widget_data_get(obj);
433 if (!wd) return NULL;
435 it = eina_list_nth(wd->seg_items, index);
439 static Elm_Segment_Item*
440 _item_new(Evas_Object *obj, Evas_Object *icon, const char *label)
442 Elm_Segment_Item *it;
445 wd = elm_widget_data_get(obj);
446 if (!wd) return NULL;
448 it = elm_widget_item_new(obj, Elm_Segment_Item);
449 if (!it) return NULL;
450 elm_widget_item_data_set(it, wd);
452 it->base.view = edje_object_add(evas_object_evas_get(obj));
453 edje_object_scale_set(it->base.view, elm_widget_scale_get(it->base.view)
454 *_elm_config->scale);
455 evas_object_smart_member_add(it->base.view, obj);
456 elm_widget_sub_object_add(obj, it->base.view);
457 _elm_theme_object_set(obj, it->base.view, "segment_control", "item",
458 elm_object_style_get(obj));
459 edje_object_mirrored_set(it->base.view,
460 elm_widget_mirrored_get(it->base.widget));
463 eina_stringshare_replace(&it->label, label);
465 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
467 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
468 edje_object_message_signal_process(it->base.view);
469 edje_object_part_text_set(it->base.view, "elm.text", label);
472 if (it->icon) elm_widget_sub_object_add(it->base.view, it->icon);
473 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_DOWN,
475 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_UP,
477 evas_object_show(it->base.view);
483 * Create new SegmentControl.
484 * @param [in] parent The parent object
485 * @return The new object or NULL if it cannot be created
487 * @ingroup SegmentControl
490 elm_segment_control_add(Evas_Object *parent)
496 ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
498 ELM_SET_WIDTYPE(widtype, "segment_control");
499 elm_widget_type_set(obj, "segment_control");
500 elm_widget_sub_object_add(parent, obj);
501 elm_widget_data_set(obj, wd);
502 elm_widget_del_hook_set(obj, _del_hook);
503 elm_widget_theme_hook_set(obj, _theme_hook);
504 elm_widget_disable_hook_set(obj, _disable_hook);
506 // TODO: Focus switch support to Elm_widget_Item not supported yet.
508 elm_widget_focus_next_hook_set(obj, _focus_next_hook);
513 wd->base = edje_object_add(e);
514 edje_object_scale_set(wd->base, elm_widget_scale_get(wd->base)
515 *_elm_config->scale);
516 _elm_theme_object_set(obj, wd->base, "segment_control", "base", "default");
517 elm_widget_resize_object_set(obj, wd->base);
519 evas_object_event_callback_add(obj, EVAS_CALLBACK_RESIZE,
520 _on_move_resize, obj);
521 evas_object_event_callback_add(obj, EVAS_CALLBACK_MOVE,
522 _on_move_resize, obj);
527 * Add new segment item to SegmentControl.
528 * @param [in] obj The SegmentControl object
529 * @param [in] icon Any Objects like icon, Label, layout etc
530 * @param [in] label The label for added segment item.
531 * Note that, NULL is different from empty string "".
532 * @return The new segment item or NULL if it cannot be created
534 * @ingroup SegmentControl
536 EAPI Elm_Segment_Item *
537 elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon,
540 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
541 Elm_Segment_Item *it;
544 wd = elm_widget_data_get(obj);
545 if (!wd) return NULL;
547 it = _item_new(obj, icon, label);
548 if (!it) return NULL;
550 wd->seg_items = eina_list_append(wd->seg_items, it);
557 * Insert a new segment item to SegmentControl.
558 * @param [in] obj The SegmentControl object
559 * @param [in] icon Any Objects like icon, Label, layout etc
560 * @param [in] label The label for added segment item.
561 * Note that, NULL is different from empty string "".
562 * @param [in] index Segment item location. Value should be between 0 and
563 * Existing total item count( @see elm_segment_control_item_count_get() )
564 * @return The new segment item or NULL if it cannot be created
566 * @ingroup SegmentControl
568 EAPI Elm_Segment_Item *
569 elm_segment_control_item_insert_at(Evas_Object *obj, Evas_Object *icon,
570 const char *label, int index)
572 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
573 Elm_Segment_Item *it, *it_rel;
576 wd = elm_widget_data_get(obj);
577 if (!wd) return NULL;
578 if (index < 0) index = 0;
580 it = _item_new(obj, icon, label);
581 if (!it) return NULL;
583 it_rel = _item_find(obj, index);
585 wd->seg_items = eina_list_prepend_relative(wd->seg_items, it, it_rel);
587 wd->seg_items = eina_list_append(wd->seg_items, it);
594 * Delete a segment item from SegmentControl
595 * @param [in] obj The SegmentControl object
596 * @param [in] it The segment item to be deleted
598 * @ingroup SegmentControl
601 elm_segment_control_item_del(Elm_Segment_Item *it)
603 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
606 wd = elm_widget_item_data_get(it);
614 * Delete a segment item of given index from SegmentControl
615 * @param [in] obj The SegmentControl object
616 * @param [in] index The position at which segment item to be deleted.
618 * @ingroup SegmentControl
621 elm_segment_control_item_del_at(Evas_Object *obj, int index)
623 ELM_CHECK_WIDTYPE(obj, widtype);
624 Elm_Segment_Item *it;
627 wd = elm_widget_data_get(obj);
630 it = _item_find(obj, index);
637 * Get the label of a segment item.
638 * @param [in] obj The SegmentControl object
639 * @param [in] index The index of the segment item
640 * @return The label of the segment item
642 * @ingroup SegmentControl
645 elm_segment_control_item_label_get(const Evas_Object *obj, int index)
647 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
648 Elm_Segment_Item *it;
650 it = _item_find(obj, index);
651 if (it) return it->label;
657 * Set the label of a segment item.
658 * @param [in] it The SegmentControl Item
659 * @param [in] label New label text.
661 * @ingroup SegmentControl
664 elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label)
666 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
669 wd = elm_widget_item_data_get(it);
672 eina_stringshare_replace(&it->label, label);
674 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
676 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
677 edje_object_message_signal_process(it->base.view);
678 //label can be NULL also.
679 edje_object_part_text_set(it->base.view, "elm.text", it->label);
683 * Get the icon of a segment item of SegmentControl
684 * @param [in] obj The SegmentControl object
685 * @param [in] index The index of the segment item
686 * @return The icon object.
688 * @ingroup SegmentControl
691 elm_segment_control_item_icon_get(const Evas_Object *obj, int index)
693 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
694 Elm_Segment_Item *it;
696 it = _item_find(obj, index);
697 if (it) return it->icon;
703 * Set the Icon to the segment item
704 * @param [in] it The SegmentControl Item
705 * @param [in] icon Objects like Layout, Icon, Label etc...
707 * @ingroup SegmentControl
710 elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon)
712 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
714 //Remove the existing icon
717 edje_object_part_unswallow(it->base.view, it->icon);
718 evas_object_del(it->icon);
725 elm_widget_sub_object_add(it->base.view, it->icon);
726 edje_object_part_swallow(it->base.view, "elm.swallow.icon", it->icon);
727 edje_object_signal_emit(it->base.view, "elm,state,icon,visible", "elm");
730 edje_object_signal_emit(it->base.view, "elm,state,icon,hidden", "elm");
734 * Get the Segment items count from SegmentControl
735 * @param [in] obj The SegmentControl object
736 * @return Segment items count.
738 * @ingroup SegmentControl
741 elm_segment_control_item_count_get(const Evas_Object *obj)
743 ELM_CHECK_WIDTYPE(obj, widtype) 0;
746 wd = elm_widget_data_get(obj);
749 return eina_list_count(wd->seg_items);
753 * Get the base object of segment item.
754 * @param [in] it The Segment item
755 * @return obj The base object of the segment item.
757 * @ingroup SegmentControl
760 elm_segment_control_item_object_get(const Elm_Segment_Item *it)
762 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, NULL);
764 return it->base.view;
768 * Get the selected segment item in the SegmentControl
769 * @param [in] obj The SegmentControl object
770 * @return Selected Segment Item. NULL if none of segment item is selected.
772 * @ingroup SegmentControl
774 EAPI Elm_Segment_Item*
775 elm_segment_control_item_selected_get(const Evas_Object *obj)
777 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
780 wd = elm_widget_data_get(obj);
781 if (!wd) return NULL;
783 return wd->selected_item;
787 * Select/unselect a particular segment item of SegmentControl
788 * @param [in] it The Segment item that is to be selected or unselected.
789 * @param [in] select Passing EINA_TRUE will select the segment item and
790 * EINA_FALSE will unselect.
792 * @ingroup SegmentControl
795 elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select)
797 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
800 wd = elm_widget_item_data_get(it);
803 if (it == wd->selected_item)
805 //already in selected state.
818 * Get the Segment Item from the specified Index.
819 * @param [in] obj The Segment Control object.
820 * @param [in] index The index of the segment item.
821 * @return The Segment item.
823 * @ingroup SegmentControl
825 EAPI Elm_Segment_Item *
826 elm_segment_control_item_get(const Evas_Object *obj, int index)
828 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
829 Elm_Segment_Item *it;
831 it = _item_find(obj, index);
837 * Get the index of a Segment item in the SegmentControl
838 * @param [in] it The Segment Item.
839 * @return Segment Item index.
841 * @ingroup SegmentControl
844 elm_segment_control_item_index_get(const Elm_Segment_Item *it)
846 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, -1);
848 return it->seg_index;