SegmentControl

Functions

Evas_Object * elm_segment_control_add (Evas_Object *parent)
 Add a new segment control widget to the given parent Elementary (container) object.
Elm_Object_Itemelm_segment_control_item_add (Evas_Object *obj, Evas_Object *icon, const char *label)
 Append a new item to the segment control object.
Elm_Object_Itemelm_segment_control_item_insert_at (Evas_Object *obj, Evas_Object *icon, const char *label, int index)
 Insert a new item to the segment control object at specified position.
void elm_segment_control_item_del_at (Evas_Object *obj, int index)
 Remove a segment control item at given index from its parent, deleting it.
int elm_segment_control_item_count_get (const Evas_Object *obj)
 Get the Segment items count from segment control.
Elm_Object_Itemelm_segment_control_item_get (const Evas_Object *obj, int index)
 Get the item placed at specified index.
const char * elm_segment_control_item_label_get (const Evas_Object *obj, int index)
 Get the label of item.
Evas_Object * elm_segment_control_item_icon_get (const Evas_Object *obj, int index)
 Get the icon associated to the item.
int elm_segment_control_item_index_get (const Elm_Object_Item *it)
 Get the index of an item.
Evas_Object * elm_segment_control_item_object_get (const Elm_Object_Item *it)
 Get the base object of the item.
Elm_Object_Itemelm_segment_control_item_selected_get (const Evas_Object *obj)
 Get the selected item.
void elm_segment_control_item_selected_set (Elm_Object_Item *it, Eina_Bool select)
 Set the selected state of an item.

Detailed Description

segment_control_inheritance_tree.png
preview-00.png
segment_control.png

Segment control widget is a horizontal control made of multiple segment items, each segment item functioning similar to discrete two state button. A segment control groups the items together and provides compact single button with multiple equal size segments.

Segment item size is determined by base widget size and the number of items added. Only one segment item can be at selected state. A segment item can display combination of Text and any Evas_Object like Images or other widget.

This widget inherits from the Layout one, so that all the functions acting on it also work for segment control objects.

This widget emits the following signals, besides the ones sent from Layout:

  • "changed" - When the user clicks on a segment item which is not previously selected and get selected. The event_info parameter is the segment item pointer.

Available styles for it:

  • "default"

Default content parts of the segment control items that you can use for are:

  • "icon" - An icon in a segment control item

Default text parts of the segment control items that you can use for are:

  • "default" - Title label in a segment control item

Supported elm_object common APIs.

  • elm_object_disabled_set
  • elm_object_disabled_get

Supported elm_object_item common APIs.

Here is an example on its usage:


Function Documentation

Evas_Object* elm_segment_control_add ( Evas_Object *  parent)

Add a new segment control widget to the given parent Elementary (container) object.

Parameters:
parentThe parent object.
Returns:
a new segment control widget handle or NULL, on errors.

This function inserts a new segment control widget on the canvas.

Elm_Object_Item* elm_segment_control_item_add ( Evas_Object *  obj,
Evas_Object *  icon,
const char *  label 
)

Append a new item to the segment control object.

Parameters:
objThe segment control object.
iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
labelThe label of the item. Note that, NULL is different from empty string "".
Returns:
The created item or NULL upon failure.

A new item will be created and appended to the segment control, i.e., will be set as last item.

If it should be inserted at another position, elm_segment_control_item_insert_at() should be used instead.

Items created with this function can be deleted with function elm_object_item_del() or elm_object_item_del_at().

Note:
label set to NULL is different from empty string "". If an item only has icon, it will be displayed bigger and centered. If it has icon and label, even that an empty string, icon will be smaller and positioned at left.

Simple example:

 sc = elm_segment_control_add(win);
 ic = elm_icon_add(win);
 elm_image_file_set(ic, "path/to/image", NULL);
 elm_icon_resizable_set(ic, EINA_TRUE, EINA_TRUE);
 elm_segment_control_item_add(sc, ic, "label");
 evas_object_show(sc);
See also:
elm_segment_control_item_insert_at()
elm_object_item_del()
int elm_segment_control_item_count_get ( const Evas_Object *  obj)

Get the Segment items count from segment control.

Parameters:
objThe segment control object.
Returns:
Segment items count.

It will just return the number of items added to segment control obj.

void elm_segment_control_item_del_at ( Evas_Object *  obj,
int  index 
)

Remove a segment control item at given index from its parent, deleting it.

Parameters:
objThe segment control object.
indexThe position of the segment control item to be deleted.

Items can be added with elm_segment_control_item_add() or elm_segment_control_item_insert_at().

References elm_object_item_del().

Elm_Object_Item* elm_segment_control_item_get ( const Evas_Object *  obj,
int  index 
)

Get the item placed at specified index.

Parameters:
objThe segment control object.
indexThe index of the segment item.
Returns:
The segment control item or NULL on failure.

Index is the position of an item in segment control widget. Its range is from 0 to count - 1 . Count is the number of items, that can be get with elm_segment_control_item_count_get().

Evas_Object* elm_segment_control_item_icon_get ( const Evas_Object *  obj,
int  index 
)

Get the icon associated to the item.

Parameters:
objThe segment control object.
indexThe index of the segment item.
Returns:
The left side icon associated to the item at index.

The return value is a pointer to the icon associated to the item when it was created, with function elm_segment_control_item_add(), or later with function elm_object_item_part_content_set(). If no icon was passed as argument, it will return NULL.

See also:
elm_segment_control_item_add()
elm_object_item_part_content_set()
int elm_segment_control_item_index_get ( const Elm_Object_Item it)

Get the index of an item.

Parameters:
itThe segment control item.
Returns:
The position of item in segment control widget.

Index is the position of an item in segment control widget. Its range is from 0 to count - 1 . Count is the number of items, that can be get with elm_segment_control_item_count_get().

Elm_Object_Item* elm_segment_control_item_insert_at ( Evas_Object *  obj,
Evas_Object *  icon,
const char *  label,
int  index 
)

Insert a new item to the segment control object at specified position.

Parameters:
objThe segment control object.
iconThe icon object to use for the left side of the item. An icon can be any Evas object, but usually it is an icon created with elm_icon_add().
labelThe label of the item.
indexItem position. Value should be between 0 and items count.
Returns:
The created item or NULL upon failure.

Index values must be between 0, when item will be prepended to segment control, and items count, that can be get with elm_segment_control_item_count_get(), case when item will be appended to segment control, just like elm_segment_control_item_add().

Items created with this function can be deleted with function elm_object_item_del() or elm_segment_control_item_del_at().

Note:
label set to NULL is different from empty string "". If an item only has icon, it will be displayed bigger and centered. If it has icon and label, even that an empty string, icon will be smaller and positioned at left.
See also:
elm_segment_control_item_add()
elm_segment_control_item_count_get()
elm_object_item_del()
const char* elm_segment_control_item_label_get ( const Evas_Object *  obj,
int  index 
)

Get the label of item.

Parameters:
objThe segment control object.
indexThe index of the segment item.
Returns:
The label of the item at index.

The return value is a pointer to the label associated to the item when it was created, with function elm_segment_control_item_add(), or later with function elm_object_item_text_set. If no label was passed as argument, it will return NULL.

See also:
elm_object_item_text_set() for more details.
elm_segment_control_item_add()
Evas_Object* elm_segment_control_item_object_get ( const Elm_Object_Item it)

Get the base object of the item.

Parameters:
itThe segment control item.
Returns:
The base object associated with it.

Base object is the Evas_Object that represents that item.

Elm_Object_Item* elm_segment_control_item_selected_get ( const Evas_Object *  obj)

Get the selected item.

Parameters:
objThe segment control object.
Returns:
The selected item or NULL if none of segment items is selected.

The selected item can be unselected with function elm_segment_control_item_selected_set().

The selected item always will be highlighted on segment control.

void elm_segment_control_item_selected_set ( Elm_Object_Item it,
Eina_Bool  select 
)

Set the selected state of an item.

Parameters:
itThe segment control item
selectThe selected state

This sets the selected state of the given item it. EINA_TRUE for selected, EINA_FALSE for not selected.

If a new item is selected the previously selected will be unselected. Selected item can be got with function elm_segment_control_item_selected_get().

The selected item always will be highlighted on segment control.

See also:
elm_segment_control_item_selected_get()