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 _swallow_item_objects(it);
394 rtl = elm_widget_mirrored_get(wd->obj);
395 EINA_LIST_FOREACH(wd->seg_items, l, it)
399 //Set the segment type
403 edje_object_signal_emit(it->base.view,
404 "elm,type,segment,right", "elm");
406 edje_object_signal_emit(it->base.view,
407 "elm,type,segment,left", "elm");
409 else if (idx == (wd->item_count - 1))
412 edje_object_signal_emit(it->base.view,
413 "elm,type,segment,left", "elm");
415 edje_object_signal_emit(it->base.view,
416 "elm,type,segment,right", "elm");
419 edje_object_signal_emit(it->base.view,
420 "elm,type,segment,middle", "elm");
422 //Set the segment state
423 if (wd->selected_item == it)
424 edje_object_signal_emit(it->base.view,
425 "elm,state,segment,selected", "elm");
427 edje_object_signal_emit(it->base.view,
428 "elm,state,segment,normal", "elm");
430 if (elm_widget_disabled_get(wd->obj))
431 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
433 _swallow_item_objects(it);
438 static Elm_Segment_Item *
439 _item_find(const Evas_Object *obj, int idx)
442 Elm_Segment_Item *it;
444 wd = elm_widget_data_get(obj);
445 if (!wd) return NULL;
447 it = eina_list_nth(wd->seg_items, idx);
451 static Elm_Segment_Item*
452 _item_new(Evas_Object *obj, Evas_Object *icon, const char *label)
454 Elm_Segment_Item *it;
457 wd = elm_widget_data_get(obj);
458 if (!wd) return NULL;
460 it = elm_widget_item_new(obj, Elm_Segment_Item);
461 if (!it) return NULL;
462 elm_widget_item_data_set(it, wd);
464 it->base.view = edje_object_add(evas_object_evas_get(obj));
465 edje_object_scale_set(it->base.view, elm_widget_scale_get(it->base.view)
466 *_elm_config->scale);
467 evas_object_smart_member_add(it->base.view, obj);
468 elm_widget_sub_object_add(obj, it->base.view);
469 evas_object_clip_set(it->base.view, evas_object_clip_get(obj));
471 _elm_theme_object_set(obj, it->base.view, "segment_control", "item",
472 elm_object_style_get(obj));
473 edje_object_mirrored_set(it->base.view,
474 elm_widget_mirrored_get(it->base.widget));
477 eina_stringshare_replace(&it->label, label);
479 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
481 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
482 edje_object_message_signal_process(it->base.view);
483 edje_object_part_text_set(it->base.view, "elm.text", label);
486 if (it->icon) elm_widget_sub_object_add(it->base.view, it->icon);
487 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_DOWN,
489 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_UP,
491 evas_object_show(it->base.view);
497 * Create new SegmentControl.
498 * @param [in] parent The parent object
499 * @return The new object or NULL if it cannot be created
501 * @ingroup SegmentControl
504 elm_segment_control_add(Evas_Object *parent)
510 ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
512 ELM_SET_WIDTYPE(widtype, "segment_control");
513 elm_widget_type_set(obj, "segment_control");
514 elm_widget_sub_object_add(parent, obj);
515 elm_widget_data_set(obj, wd);
516 elm_widget_del_hook_set(obj, _del_hook);
517 elm_widget_theme_hook_set(obj, _theme_hook);
518 elm_widget_disable_hook_set(obj, _disable_hook);
520 // TODO: Focus switch support to Elm_widget_Item not supported yet.
522 elm_widget_focus_next_hook_set(obj, _focus_next_hook);
527 wd->base = edje_object_add(e);
528 edje_object_scale_set(wd->base, elm_widget_scale_get(wd->base)
529 *_elm_config->scale);
530 _elm_theme_object_set(obj, wd->base, "segment_control", "base", "default");
531 elm_widget_resize_object_set(obj, wd->base);
533 evas_object_event_callback_add(obj, EVAS_CALLBACK_RESIZE,
534 _on_move_resize, obj);
535 evas_object_event_callback_add(obj, EVAS_CALLBACK_MOVE,
536 _on_move_resize, obj);
538 evas_object_smart_callbacks_descriptions_set(obj, _signals);
544 * Add new segment item to SegmentControl.
545 * @param [in] obj The SegmentControl object
546 * @param [in] icon Any Objects like icon, Label, layout etc
547 * @param [in] label The label for added segment item.
548 * Note that, NULL is different from empty string "".
549 * @return The new segment item or NULL if it cannot be created
551 * @ingroup SegmentControl
553 EAPI Elm_Segment_Item *
554 elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon,
557 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
558 Elm_Segment_Item *it;
561 wd = elm_widget_data_get(obj);
562 if (!wd) return NULL;
564 it = _item_new(obj, icon, label);
565 if (!it) return NULL;
567 wd->seg_items = eina_list_append(wd->seg_items, it);
574 * Insert a new segment item to SegmentControl.
575 * @param [in] obj The SegmentControl object
576 * @param [in] icon Any Objects like icon, Label, layout etc
577 * @param [in] label The label for added segment item.
578 * Note that, NULL is different from empty string "".
579 * @param [in] index Segment item location. Value should be between 0 and
580 * Existing total item count( @see elm_segment_control_item_count_get() )
581 * @return The new segment item or NULL if it cannot be created
583 * @ingroup SegmentControl
585 EAPI Elm_Segment_Item *
586 elm_segment_control_item_insert_at(Evas_Object *obj, Evas_Object *icon,
587 const char *label, int idx)
589 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
590 Elm_Segment_Item *it, *it_rel;
593 wd = elm_widget_data_get(obj);
594 if (!wd) return NULL;
595 if (idx < 0) idx = 0;
597 it = _item_new(obj, icon, label);
598 if (!it) return NULL;
600 it_rel = _item_find(obj, idx);
603 wd->seg_items = eina_list_prepend_relative(wd->seg_items, it, it_rel);
605 wd->seg_items = eina_list_append(wd->seg_items, it);
612 * Delete a segment item from SegmentControl
613 * @param [in] obj The SegmentControl object
614 * @param [in] it The segment item to be deleted
616 * @ingroup SegmentControl
619 elm_segment_control_item_del(Elm_Segment_Item *it)
621 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
624 wd = elm_widget_item_data_get(it);
632 * Delete a segment item of given index from SegmentControl
633 * @param [in] obj The SegmentControl object
634 * @param [in] index The position at which segment item to be deleted.
636 * @ingroup SegmentControl
639 elm_segment_control_item_del_at(Evas_Object *obj, int idx)
641 ELM_CHECK_WIDTYPE(obj, widtype);
642 Elm_Segment_Item *it;
645 wd = elm_widget_data_get(obj);
648 it = _item_find(obj, idx);
656 * Get the label of a segment item.
657 * @param [in] obj The SegmentControl object
658 * @param [in] index The index of the segment item
659 * @return The label of the segment item
661 * @ingroup SegmentControl
664 elm_segment_control_item_label_get(const Evas_Object *obj, int idx)
666 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
667 Elm_Segment_Item *it;
669 it = _item_find(obj, idx);
671 if (it) return it->label;
677 * Set the label of a segment item.
678 * @param [in] it The SegmentControl Item
679 * @param [in] label New label text.
681 * @ingroup SegmentControl
684 elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label)
686 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
689 wd = elm_widget_item_data_get(it);
692 eina_stringshare_replace(&it->label, label);
694 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
696 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
697 edje_object_message_signal_process(it->base.view);
698 //label can be NULL also.
699 edje_object_part_text_set(it->base.view, "elm.text", it->label);
703 * Get the icon of a segment item of SegmentControl
704 * @param [in] obj The SegmentControl object
705 * @param [in] index The index of the segment item
706 * @return The icon object.
708 * @ingroup SegmentControl
711 elm_segment_control_item_icon_get(const Evas_Object *obj, int idx)
713 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
714 Elm_Segment_Item *it;
716 it = _item_find(obj, idx);
718 if (it) return it->icon;
724 * Set the Icon to the segment item
725 * @param [in] it The SegmentControl Item
726 * @param [in] icon Objects like Layout, Icon, Label etc...
728 * @ingroup SegmentControl
731 elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon)
733 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
735 //Remove the existing icon
738 edje_object_part_unswallow(it->base.view, it->icon);
739 evas_object_del(it->icon);
746 elm_widget_sub_object_add(it->base.view, it->icon);
747 edje_object_part_swallow(it->base.view, "elm.swallow.icon", it->icon);
748 edje_object_signal_emit(it->base.view, "elm,state,icon,visible", "elm");
751 edje_object_signal_emit(it->base.view, "elm,state,icon,hidden", "elm");
755 * Get the Segment items count from SegmentControl
756 * @param [in] obj The SegmentControl object
757 * @return Segment items count.
759 * @ingroup SegmentControl
762 elm_segment_control_item_count_get(const Evas_Object *obj)
764 ELM_CHECK_WIDTYPE(obj, widtype) 0;
767 wd = elm_widget_data_get(obj);
770 return eina_list_count(wd->seg_items);
774 * Get the base object of segment item.
775 * @param [in] it The Segment item
776 * @return obj The base object of the segment item.
778 * @ingroup SegmentControl
781 elm_segment_control_item_object_get(const Elm_Segment_Item *it)
783 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, NULL);
785 return it->base.view;
789 * Get the selected segment item in the SegmentControl
790 * @param [in] obj The SegmentControl object
791 * @return Selected Segment Item. NULL if none of segment item is selected.
793 * @ingroup SegmentControl
795 EAPI Elm_Segment_Item*
796 elm_segment_control_item_selected_get(const Evas_Object *obj)
798 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
801 wd = elm_widget_data_get(obj);
802 if (!wd) return NULL;
804 return wd->selected_item;
808 * Select/unselect a particular segment item of SegmentControl
809 * @param [in] it The Segment item that is to be selected or unselected.
810 * @param [in] select Passing EINA_TRUE will select the segment item and
811 * EINA_FALSE will unselect.
813 * @ingroup SegmentControl
816 elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool selected)
818 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
821 wd = elm_widget_item_data_get(it);
824 if (it == wd->selected_item)
826 //already in selected state.
827 if (selected) return;
839 * Get the Segment Item from the specified Index.
840 * @param [in] obj The Segment Control object.
841 * @param [in] index The index of the segment item.
842 * @return The Segment item.
844 * @ingroup SegmentControl
846 EAPI Elm_Segment_Item *
847 elm_segment_control_item_get(const Evas_Object *obj, int idx)
849 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
850 Elm_Segment_Item *it;
852 it = _item_find(obj, idx);
858 * Get the index of a Segment item in the SegmentControl
859 * @param [in] it The Segment Item.
860 * @return Segment Item index.
862 * @ingroup SegmentControl
865 elm_segment_control_item_index_get(const Elm_Segment_Item *it)
867 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, -1);
869 return it->seg_index;