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->canvas.x >= x) && (ev->output.x <= (x + w)) && (ev->canvas.y >= y)
309 && (ev->canvas.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");
350 edje_object_part_text_set(it->base.view, "elm.text", it->label);
351 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
354 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
355 edje_object_message_signal_process(it->base.view);
359 _update_list(Widget_Data *wd)
362 Elm_Segment_Item *it;
368 if (wd->item_count == 1)
370 it = eina_list_nth(wd->seg_items, 0);
373 //Set the segment type
374 edje_object_signal_emit(it->base.view,
375 "elm,type,segment,single", "elm");
377 //Set the segment state
378 if (wd->selected_item == it)
379 edje_object_signal_emit(it->base.view,
380 "elm,state,segment,selected", "elm");
382 edje_object_signal_emit(it->base.view,
383 "elm,state,segment,normal", "elm");
385 if (elm_widget_disabled_get(wd->obj))
386 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
388 _swallow_item_objects(it);
392 rtl = elm_widget_mirrored_get(wd->obj);
393 EINA_LIST_FOREACH(wd->seg_items, l, it)
397 //Set the segment type
401 edje_object_signal_emit(it->base.view,
402 "elm,type,segment,right", "elm");
404 edje_object_signal_emit(it->base.view,
405 "elm,type,segment,left", "elm");
407 else if (idx == (wd->item_count - 1))
410 edje_object_signal_emit(it->base.view,
411 "elm,type,segment,left", "elm");
413 edje_object_signal_emit(it->base.view,
414 "elm,type,segment,right", "elm");
417 edje_object_signal_emit(it->base.view,
418 "elm,type,segment,middle", "elm");
420 //Set the segment state
421 if (wd->selected_item == it)
422 edje_object_signal_emit(it->base.view,
423 "elm,state,segment,selected", "elm");
425 edje_object_signal_emit(it->base.view,
426 "elm,state,segment,normal", "elm");
428 if (elm_widget_disabled_get(wd->obj))
429 edje_object_signal_emit(it->base.view, "elm,state,disabled", "elm");
431 _swallow_item_objects(it);
436 static Elm_Segment_Item *
437 _item_find(const Evas_Object *obj, int idx)
440 Elm_Segment_Item *it;
442 wd = elm_widget_data_get(obj);
443 if (!wd) return NULL;
445 it = eina_list_nth(wd->seg_items, idx);
449 static Elm_Segment_Item*
450 _item_new(Evas_Object *obj, Evas_Object *icon, const char *label)
452 Elm_Segment_Item *it;
455 wd = elm_widget_data_get(obj);
456 if (!wd) return NULL;
458 it = elm_widget_item_new(obj, Elm_Segment_Item);
459 if (!it) return NULL;
460 elm_widget_item_data_set(it, wd);
462 it->base.view = edje_object_add(evas_object_evas_get(obj));
463 edje_object_scale_set(it->base.view, elm_widget_scale_get(it->base.view)
464 *_elm_config->scale);
465 evas_object_smart_member_add(it->base.view, obj);
466 elm_widget_sub_object_add(obj, it->base.view);
467 evas_object_clip_set(it->base.view, evas_object_clip_get(obj));
469 _elm_theme_object_set(obj, it->base.view, "segment_control", "item",
470 elm_object_style_get(obj));
471 edje_object_mirrored_set(it->base.view,
472 elm_widget_mirrored_get(it->base.widget));
475 eina_stringshare_replace(&it->label, label);
477 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
479 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
480 edje_object_message_signal_process(it->base.view);
481 edje_object_part_text_set(it->base.view, "elm.text", label);
484 if (it->icon) elm_widget_sub_object_add(it->base.view, it->icon);
485 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_DOWN,
487 evas_object_event_callback_add(it->base.view, EVAS_CALLBACK_MOUSE_UP,
489 evas_object_show(it->base.view);
495 * Create new SegmentControl.
496 * @param [in] parent The parent object
497 * @return The new object or NULL if it cannot be created
499 * @ingroup SegmentControl
502 elm_segment_control_add(Evas_Object *parent)
508 ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
510 ELM_SET_WIDTYPE(widtype, "segment_control");
511 elm_widget_type_set(obj, "segment_control");
512 elm_widget_sub_object_add(parent, obj);
513 elm_widget_data_set(obj, wd);
514 elm_widget_del_hook_set(obj, _del_hook);
515 elm_widget_theme_hook_set(obj, _theme_hook);
516 elm_widget_disable_hook_set(obj, _disable_hook);
518 // TODO: Focus switch support to Elm_widget_Item not supported yet.
520 elm_widget_focus_next_hook_set(obj, _focus_next_hook);
525 wd->base = edje_object_add(e);
526 edje_object_scale_set(wd->base, elm_widget_scale_get(wd->base)
527 *_elm_config->scale);
528 _elm_theme_object_set(obj, wd->base, "segment_control", "base", "default");
529 elm_widget_resize_object_set(obj, wd->base);
531 evas_object_event_callback_add(obj, EVAS_CALLBACK_RESIZE,
532 _on_move_resize, obj);
533 evas_object_event_callback_add(obj, EVAS_CALLBACK_MOVE,
534 _on_move_resize, obj);
536 evas_object_smart_callbacks_descriptions_set(obj, _signals);
542 * Add new segment item to SegmentControl.
543 * @param [in] obj The SegmentControl object
544 * @param [in] icon Any Objects like icon, Label, layout etc
545 * @param [in] label The label for added segment item.
546 * Note that, NULL is different from empty string "".
547 * @return The new segment item or NULL if it cannot be created
549 * @ingroup SegmentControl
551 EAPI Elm_Segment_Item *
552 elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon,
555 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
556 Elm_Segment_Item *it;
559 wd = elm_widget_data_get(obj);
560 if (!wd) return NULL;
562 it = _item_new(obj, icon, label);
563 if (!it) return NULL;
565 wd->seg_items = eina_list_append(wd->seg_items, it);
572 * Insert a new segment item to SegmentControl.
573 * @param [in] obj The SegmentControl object
574 * @param [in] icon Any Objects like icon, Label, layout etc
575 * @param [in] label The label for added segment item.
576 * Note that, NULL is different from empty string "".
577 * @param [in] index Segment item location. Value should be between 0 and
578 * Existing total item count( @see elm_segment_control_item_count_get() )
579 * @return The new segment item or NULL if it cannot be created
581 * @ingroup SegmentControl
583 EAPI Elm_Segment_Item *
584 elm_segment_control_item_insert_at(Evas_Object *obj, Evas_Object *icon,
585 const char *label, int idx)
587 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
588 Elm_Segment_Item *it, *it_rel;
591 wd = elm_widget_data_get(obj);
592 if (!wd) return NULL;
593 if (idx < 0) idx = 0;
595 it = _item_new(obj, icon, label);
596 if (!it) return NULL;
598 it_rel = _item_find(obj, idx);
600 wd->seg_items = eina_list_prepend_relative(wd->seg_items, it, it_rel);
602 wd->seg_items = eina_list_append(wd->seg_items, it);
609 * Delete a segment item from SegmentControl
610 * @param [in] obj The SegmentControl object
611 * @param [in] it The segment item to be deleted
613 * @ingroup SegmentControl
616 elm_segment_control_item_del(Elm_Segment_Item *it)
618 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
621 wd = elm_widget_item_data_get(it);
629 * Delete a segment item of given index from SegmentControl
630 * @param [in] obj The SegmentControl object
631 * @param [in] index The position at which segment item to be deleted.
633 * @ingroup SegmentControl
636 elm_segment_control_item_del_at(Evas_Object *obj, int idx)
638 ELM_CHECK_WIDTYPE(obj, widtype);
639 Elm_Segment_Item *it;
642 wd = elm_widget_data_get(obj);
645 it = _item_find(obj, idx);
652 * Get the label of a segment item.
653 * @param [in] obj The SegmentControl object
654 * @param [in] index The index of the segment item
655 * @return The label of the segment item
657 * @ingroup SegmentControl
660 elm_segment_control_item_label_get(const Evas_Object *obj, int idx)
662 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
663 Elm_Segment_Item *it;
665 it = _item_find(obj, idx);
666 if (it) return it->label;
672 * Set the label of a segment item.
673 * @param [in] it The SegmentControl Item
674 * @param [in] label New label text.
676 * @ingroup SegmentControl
679 elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label)
681 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
684 wd = elm_widget_item_data_get(it);
687 eina_stringshare_replace(&it->label, label);
689 edje_object_signal_emit(it->base.view, "elm,state,text,visible", "elm");
691 edje_object_signal_emit(it->base.view, "elm,state,text,hidden", "elm");
692 edje_object_message_signal_process(it->base.view);
693 //label can be NULL also.
694 edje_object_part_text_set(it->base.view, "elm.text", it->label);
698 * Get the icon of a segment item of SegmentControl
699 * @param [in] obj The SegmentControl object
700 * @param [in] index The index of the segment item
701 * @return The icon object.
703 * @ingroup SegmentControl
706 elm_segment_control_item_icon_get(const Evas_Object *obj, int idx)
708 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
709 Elm_Segment_Item *it;
711 it = _item_find(obj, idx);
712 if (it) return it->icon;
718 * Set the Icon to the segment item
719 * @param [in] it The SegmentControl Item
720 * @param [in] icon Objects like Layout, Icon, Label etc...
722 * @ingroup SegmentControl
725 elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon)
727 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
729 //Remove the existing icon
732 edje_object_part_unswallow(it->base.view, it->icon);
733 evas_object_del(it->icon);
740 elm_widget_sub_object_add(it->base.view, it->icon);
741 edje_object_part_swallow(it->base.view, "elm.swallow.icon", it->icon);
742 edje_object_signal_emit(it->base.view, "elm,state,icon,visible", "elm");
745 edje_object_signal_emit(it->base.view, "elm,state,icon,hidden", "elm");
749 * Get the Segment items count from SegmentControl
750 * @param [in] obj The SegmentControl object
751 * @return Segment items count.
753 * @ingroup SegmentControl
756 elm_segment_control_item_count_get(const Evas_Object *obj)
758 ELM_CHECK_WIDTYPE(obj, widtype) 0;
761 wd = elm_widget_data_get(obj);
764 return eina_list_count(wd->seg_items);
768 * Get the base object of segment item.
769 * @param [in] it The Segment item
770 * @return obj The base object of the segment item.
772 * @ingroup SegmentControl
775 elm_segment_control_item_object_get(const Elm_Segment_Item *it)
777 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, NULL);
779 return it->base.view;
783 * Get the selected segment item in the SegmentControl
784 * @param [in] obj The SegmentControl object
785 * @return Selected Segment Item. NULL if none of segment item is selected.
787 * @ingroup SegmentControl
789 EAPI Elm_Segment_Item*
790 elm_segment_control_item_selected_get(const Evas_Object *obj)
792 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
795 wd = elm_widget_data_get(obj);
796 if (!wd) return NULL;
798 return wd->selected_item;
802 * Select/unselect a particular segment item of SegmentControl
803 * @param [in] it The Segment item that is to be selected or unselected.
804 * @param [in] select Passing EINA_TRUE will select the segment item and
805 * EINA_FALSE will unselect.
807 * @ingroup SegmentControl
810 elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool selected)
812 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it);
815 wd = elm_widget_item_data_get(it);
818 if (it == wd->selected_item)
820 //already in selected state.
821 if (selected) return;
833 * Get the Segment Item from the specified Index.
834 * @param [in] obj The Segment Control object.
835 * @param [in] index The index of the segment item.
836 * @return The Segment item.
838 * @ingroup SegmentControl
840 EAPI Elm_Segment_Item *
841 elm_segment_control_item_get(const Evas_Object *obj, int idx)
843 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
844 Elm_Segment_Item *it;
846 it = _item_find(obj, idx);
852 * Get the index of a Segment item in the SegmentControl
853 * @param [in] it The Segment Item.
854 * @return Segment Item index.
856 * @ingroup SegmentControl
859 elm_segment_control_item_index_get(const Elm_Segment_Item *it)
861 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, -1);
863 return it->seg_index;