Rotary Selector is based on elm_layout, and an item can be selected by rotary event or user item click.

This widget emits the following signals.

"item,selected": When the user selected an item.
"item,clicked": When selecting again the alredy selected item or selecting a selector.
"item,deleted": When the user deleted an item.
"item,reordered": When the user reordered an item.
"editing,entered": When the user entered to the editing mode.
"editing,exited": When the user exited from the editing mode.

Functions
Evas_Object *	eext_rotary_selector_add (Evas_Object *parent)
	Add a new Rotary Selector.
Eext_Object_Item *	eext_rotary_selector_item_append (Evas_Object *obj)
	Append a new item to a rotary selector.
Eext_Object_Item *	eext_rotary_selector_item_prepend (Evas_Object *obj)
	Prepend a new item to a rotary selector.
Eext_Object_Item *	eext_rotary_selector_item_insert_after (Evas_Object obj, Eext_Object_Item after)
	Insert a new item into a rotary selector after rotary selector item after.
Eext_Object_Item *	eext_rotary_selector_item_insert_before (Evas_Object obj, Eext_Object_Item before)
	Insert a new item into a rotary selector before rotary selector item before.
void	eext_rotary_selector_item_del (Eext_Object_Item *item)
	Delete an item which is the given rotary selector item.
void	eext_rotary_selector_items_clear (Evas_Object *obj)
	Remove all items from a given rotary selector object.
void	eext_rotary_selector_item_part_text_set (Eext_Object_Item item, const char part_name, const char *text)
	Set the text of a rotary selector object.
const char *	eext_rotary_selector_item_part_text_get (const Eext_Object_Item item, const char part_name)
	Set the text of a rotary selector object.
void	eext_rotary_selector_item_domain_translatable_part_text_set (Eext_Object_Item item, const char part_name, const char domain, const char text)
	Set the translatable text of a rotary selector object.
void	eext_rotary_selector_item_part_content_set (Eext_Object_Item item, const char part_name, Eext_Rotary_Selector_Item_State state, Evas_Object *content)
	Set the content at a part of a given container widget.
Evas_Object *	eext_rotary_selector_item_part_content_get (const Eext_Object_Item item, const char part_name, Eext_Rotary_Selector_Item_State state)
	Get the content at a part of a given container widget.
void	eext_rotary_selector_part_content_set (Evas_Object obj, const char part_name, Eext_Rotary_Selector_Selector_State state, Evas_Object *content)
	Set the content at a part of a given container widget.
Evas_Object *	eext_rotary_selector_part_content_get (const Evas_Object obj, const char part_name, Eext_Rotary_Selector_Selector_State state)
	Get the content from the part of the given container widget.
void	eext_rotary_selector_item_part_color_set (Eext_Object_Item item, const char part_name, Eext_Rotary_Selector_Item_State state, int r, int g, int b, int a)
	Set the item part color of a rotary selector object.
void	eext_rotary_selector_item_part_color_get (const Eext_Object_Item item, const char part_name, Eext_Rotary_Selector_Item_State state, int r, int g, int b, int a)
	Get the item part color of a rotary selector object.
void	eext_rotary_selector_part_color_set (Evas_Object obj, const char part_name, Eext_Rotary_Selector_Selector_State state, int r, int g, int b, int a)
	Set the selector part color of a rotary selector object.
void	eext_rotary_selector_part_color_get (const Evas_Object obj, const char part_name, Eext_Rotary_Selector_Selector_State state, int r, int g, int b, int a)
	Get the selector part color of a rotary selector object.
void	eext_rotary_selector_selected_item_set (Evas_Object obj, Eext_Object_Item item)
	Set the selected item of a rotary selector object.
Eext_Object_Item *	eext_rotary_selector_selected_item_get (const Evas_Object *obj)
	Get the selected item of a rotary selector object.
const Eina_List *	eext_rotary_selector_items_get (const Evas_Object *obj)
	Get the rotary selector item list of a rotary selector object.
Eina_Bool	eext_rotary_selector_editing_enabled_get (const Evas_Object *obj)
	Get whether the rotary selector edit mode is enabled or not.
void	eext_rotary_selector_editing_enabled_set (Evas_Object *obj, Eina_Bool enabled)
	Set whether the rotary selector edit mode is enabled or not.
Eina_Bool	eext_rotary_selector_add_item_enabled_get (const Evas_Object *obj)
	Get whether item(s) can be added in the edit mode or not.
void	eext_rotary_selector_add_item_enabled_set (Evas_Object *obj, Eina_Bool enabled)
	Set whether item(s) can be added in the edit mode or not.
void	eext_rotary_selector_item_delete_enabled_set (Eext_Object_Item *item, Eina_Bool enabled)
	Set whether the item can be deleted in the edit mode or not.
Eina_Bool	eext_rotary_selector_item_delete_enabled_get (const Eext_Object_Item *item)
	Get whether the item can be deleted in the edit mode or not.

Enumeration Type Documentation

enum Eext_Rotary_Selector_Item_State

Enumeration of Rotary Selector item state.

Enumerator:

EEXT_ROTARY_SELECTOR_ITEM_STATE_NORMAL	Selector Item is normal state
EEXT_ROTARY_SELECTOR_ITEM_STATE_PRESSED	Selector Item is pressed state
EEXT_ROTARY_SELECTOR_ITEM_STATE_DISABLED	Selector Item is disabled state
EEXT_ROTARY_SELECTOR_ITEM_STATE_NORMAL	Selector Item is normal state
EEXT_ROTARY_SELECTOR_ITEM_STATE_PRESSED	Selector Item is pressed state
EEXT_ROTARY_SELECTOR_ITEM_STATE_DISABLED	Selector Item is disabled state

enum Eext_Rotary_Selector_Item_State

Enumeration of Rotary Selector item state.

Enumerator:

EEXT_ROTARY_SELECTOR_ITEM_STATE_NORMAL	Selector Item is normal state
EEXT_ROTARY_SELECTOR_ITEM_STATE_PRESSED	Selector Item is pressed state
EEXT_ROTARY_SELECTOR_ITEM_STATE_DISABLED	Selector Item is disabled state
EEXT_ROTARY_SELECTOR_ITEM_STATE_NORMAL	Selector Item is normal state
EEXT_ROTARY_SELECTOR_ITEM_STATE_PRESSED	Selector Item is pressed state
EEXT_ROTARY_SELECTOR_ITEM_STATE_DISABLED	Selector Item is disabled state

enum Eext_Rotary_Selector_Selector_State

Enumeration of Rotary Selector state.

Enumerator:

EEXT_ROTARY_SELECTOR_SELECTOR_STATE_NORMAL	Selector is normal state
EEXT_ROTARY_SELECTOR_SELECTOR_STATE_PRESSED	Selector is pressed state
EEXT_ROTARY_SELECTOR_SELECTOR_STATE_DISABLED	Selector is disabled state
EEXT_ROTARY_SELECTOR_SELECTOR_STATE_NORMAL	Selector is normal state
EEXT_ROTARY_SELECTOR_SELECTOR_STATE_PRESSED	Selector is pressed state
EEXT_ROTARY_SELECTOR_SELECTOR_STATE_DISABLED	Selector is disabled state

enum Eext_Rotary_Selector_Selector_State

Enumeration of Rotary Selector state.

Enumerator:

EEXT_ROTARY_SELECTOR_SELECTOR_STATE_NORMAL	Selector is normal state
EEXT_ROTARY_SELECTOR_SELECTOR_STATE_PRESSED	Selector is pressed state
EEXT_ROTARY_SELECTOR_SELECTOR_STATE_DISABLED	Selector is disabled state
EEXT_ROTARY_SELECTOR_SELECTOR_STATE_NORMAL	Selector is normal state
EEXT_ROTARY_SELECTOR_SELECTOR_STATE_PRESSED	Selector is pressed state
EEXT_ROTARY_SELECTOR_SELECTOR_STATE_DISABLED	Selector is disabled state

Function Documentation

Evas_Object * eext_rotary_selector_add ( Evas_Object * parent )

Add a new Rotary Selector.

Because the return value is the elm_layout handle, the elm_layout APIs can be applicable to rotary selector handle.

Parameters:

[in] parent The parent object

Returns:: A new rotary selector handle, otherwise NULL if it cannot be created

Since :: 2.3.1

Eina_Bool eext_rotary_selector_add_item_enabled_get ( const Evas_Object * obj )

Get whether item(s) can be added in the edit mode or not.

Parameters:

[in] obj The rotary selector

See also:: eext_rotary_selector_add_item_enabled_set(); eext_rotary_selector_editing_enabled_set(); eext_rotary_selector_editing_enabled_get()

Returns:: EINA_TRUE if item(s) can be added, otherwise EINA_FALSE

When add item is enabled, in the editing mode, the add item is shown at the end of the item list. If users click the add item, the "add_item,clicked" signal is emitted.

Since :: 4.0

void eext_rotary_selector_add_item_enabled_set	(	Evas_Object *	obj,
		Eina_Bool	enabled
	)

Set whether item(s) can be added in the edit mode or not.

Parameters:

[in]	obj	The rotary selector
[in]	enabled	enable showing add item in editing mode

See also:: eext_rotary_selector_add_item_enabled_get(); eext_rotary_selector_editing_enabled_set(); eext_rotary_selector_editing_enabled_get()

When add item is enabled, in the editing mode, the add item is shown at the end of the item list. If users click the add item, the "add_item,clicked" signal is emitted.

Since :: 4.0

Eina_Bool eext_rotary_selector_editing_enabled_get ( const Evas_Object * obj )

Get whether the rotary selector edit mode is enabled or not.

Parameters:

[in] obj The rotary selector

See also:: eext_rotary_selector_editing_enabled_set()

Returns:: enabling of the rotary selector's editing mode

Since :: 4.0

void eext_rotary_selector_editing_enabled_set	(	Evas_Object *	obj,
		Eina_Bool	enabled
	)

Set whether the rotary selector edit mode is enabled or not.

Parameters:

[in]	obj	The rotary selector
[in]	enabled	enable editing mode

See also:: eext_rotary_selector_editing_enabled_get()

Since :: 4.0

Eext_Object_Item * eext_rotary_selector_item_append ( Evas_Object * obj )

Append a new item to a rotary selector.

Parameters:

[in] obj The rotary selector

Returns:: A handle to the item added, otherwise NULL in case of an error

See also:: Eext_Object_Item

Since :: 2.3.1

void eext_rotary_selector_item_del ( Eext_Object_Item * item )

Delete an item which is the given rotary selector item.

Parameters:

[in] item The rotary selector item

Since :: 2.3.1

Eina_Bool eext_rotary_selector_item_delete_enabled_get ( const Eext_Object_Item * item )

Get whether the item can be deleted in the edit mode or not.

Parameters:

[in] item The rotary selector item

See also:: eext_rotary_selector_item_delete_enabled_set(); eext_rotary_selector_editing_enabled_set(); eext_rotary_selector_editing_enabled_get()

Returns:: EINA_TRUE if item can be deleted, otherwise EINA_FALSE

Since :: 4.0

void eext_rotary_selector_item_delete_enabled_set	(	Eext_Object_Item *	item,
		Eina_Bool	enabled
	)

Set whether the item can be deleted in the edit mode or not.

Parameters:

[in]	item	The rotary selector item
[in]	enabled	enable delete item in the edit mode

See also:: eext_rotary_selector_item_delete_enabled_get(); eext_rotary_selector_editing_enabled_set(); eext_rotary_selector_editing_enabled_get()

Since :: 4.0

void eext_rotary_selector_item_domain_translatable_part_text_set	(	Eext_Object_Item *	item,
		const char *	part_name,
		const char *	domain,
		const char *	text
	)

Set the translatable text of a rotary selector object.

Parameters:

[in]	item	The rotary selector item
[in]	part_name	The text part name to set (`NULL` for the default part)
[in]	domain	The name of the domain which contains translatable text
[in]	text	ID of the new translatable text

This api supports following part names by default.

"selector,main_text": Selector main text.
"selector,sub_text": Selector sub text.

See also:: eext_rotary_selector_item_part_text_get()

Since :: 2.3.1

Eext_Object_Item * eext_rotary_selector_item_insert_after	(	Evas_Object *	obj,
		Eext_Object_Item *	after
	)

Insert a new item into a rotary selector after rotary selector item after.

Parameters:

[in]	obj	The rotary selector
[in]	after	The rotary selector item to insert after

Returns:: A handle to the item added, otherwise NULL in case of an error

See also:: Eext_Object_Item

Since :: 2.3.1

Eext_Object_Item * eext_rotary_selector_item_insert_before	(	Evas_Object *	obj,
		Eext_Object_Item *	before
	)

Insert a new item into a rotary selector before rotary selector item before.

Parameters:

[in]	obj	The rotary selector
[in]	before	The rotary selector item to insert before

Returns:: A handle to the item added, otherwise NULL in case of an error

See also:: Eext_Object_Item

Since :: 2.3.1

void eext_rotary_selector_item_part_color_get	(	const Eext_Object_Item *	item,
		const char *	part_name,
		Eext_Rotary_Selector_Item_State	state,
		int *	r,
		int *	g,
		int *	b,
		int *	a
	)

Get the item part color of a rotary selector object.

Parameters:

[in]	item	The rotary selector item
[in]	part_name	The item part name to get
[in]	state	The rotary selector item part
[out]	r	A pointer to Red (0 - 255)
[out]	g	A pointer to Green (0 - 255)
[out]	b	A pointer to Blue (0 - 255)
[out]	a	A pointer to Alpha (0 - 255)

See also:: eext_rotary_selector_item_part_color_set()

This api supports following part names by default.

"item,bg_image": Selector Item background image
"item,icon": Selector item icon
"selector,icon": Selector icon
"selector,content": Selector content
"selector,main_text": Selector main text.
"selector,sub_text": Selector sub text.

See also:: eext_rotary_selector_item_part_color_get()

Since :: 2.3.1

void eext_rotary_selector_item_part_color_set	(	Eext_Object_Item *	item,
		const char *	part_name,
		Eext_Rotary_Selector_Item_State	state,
		int	r,
		int	g,
		int	b,
		int	a
	)

Set the item part color of a rotary selector object.

Parameters:

[in]	item	The rotary selector item
[in]	part_name	The item part name to set
[in]	state	The rotary selector item part
[in]	r	Red (0 - 255)
[in]	g	Green (0 - 255)
[in]	b	Blue (0 - 255)
[in]	a	Alpha (0 - 255)

This api supports following part names by default.

"item,bg_image": Selector Item background image
"item,icon": Selector item icon
"selector,icon": Selector icon
"selector,content": Selector content
"selector,main_text": Selector main text.
"selector,sub_text": Selector sub text.

See also:: eext_rotary_selector_item_part_color_get()

Since :: 2.3.1

Evas_Object * eext_rotary_selector_item_part_content_get	(	const Eext_Object_Item *	item,
		const char *	part_name,
		Eext_Rotary_Selector_Item_State	state
	)

Get the content at a part of a given container widget.

Parameters:

[in]	item	The rotary selector item
[in]	part_name	The rotary selector item's part name to get
[in]	state	The rotary selector item part

Returns:: The content of the object at the given part, otherwise NULL in case of an error

This api supports following part names by default.

"item,bg_image": Selector Item background image
"item,icon": Selector item icon
"selector,icon": Selector icon
"selector,content": Selector content

See also:: eext_rotary_selector_item_part_content_set()

Since :: 2.3.1

void eext_rotary_selector_item_part_content_set	(	Eext_Object_Item *	item,
		const char *	part_name,
		Eext_Rotary_Selector_Item_State	state,
		Evas_Object *	content
	)

Set the content at a part of a given container widget.

Remarks:: The rotary selector item may hold child objects as its contents in given parts. This new content to a given part. If any object is already set as a content object in the given part, the previous object is automatically deleted with this call.

Parameters:

[in]	item	The rotary selector item
[in]	part_name	The rotary selector item's part name to set
[in]	state	The rotary selector item part
[in]	content	The new content for that part

This api supports following part names by default.

"item,bg_image": Selector Item background image
"item,icon": Selector item icon
"selector,icon": Selector icon
"selector,content": Selector content

See also:: eext_rotary_selector_item_part_content_get()

Since :: 2.3.1

const char * eext_rotary_selector_item_part_text_get	(	const Eext_Object_Item *	item,
		const char *	part_name
	)

Set the text of a rotary selector object.

Parameters:

[in]	item	The rotary selector item
[in]	part_name	The text part name to get (`NULL` for the default part)

Returns:: The text of the part, otherwise NULL for any error

This api supports following part names by default.

"selector,main_text": Selector main text.
"selector,sub_text": Selector sub text.

See also:: eext_rotary_selector_item_part_text_set()

Since :: 2.3.1

void eext_rotary_selector_item_part_text_set	(	Eext_Object_Item *	item,
		const char *	part_name,
		const char *	text
	)

Set the text of a rotary selector object.

Parameters:

[in]	item	The rotary selector item
[in]	part_name	The text part name to set (`NULL` for the default part)
[in]	text	The new text of the part

This api supports following part names by default.

"selector,main_text": Selector main text.
"selector,sub_text": Selector sub text.

See also:: eext_rotary_selector_item_part_text_get()

Since :: 2.3.1

Eext_Object_Item * eext_rotary_selector_item_prepend ( Evas_Object * obj )

Prepend a new item to a rotary selector.

Parameters:

[in] obj The rotary selector

Returns:: A handle to the item added, otherwise NULL in case of an error

See also:: Eext_Object_Item

Since :: 2.3.1

void eext_rotary_selector_items_clear ( Evas_Object * obj )

Remove all items from a given rotary selector object.

Parameters:

[in] obj The rotary selector

Since :: 2.3.1

const Eina_List * eext_rotary_selector_items_get ( const Evas_Object * obj )

Get the rotary selector item list of a rotary selector object.

Parameters:

[in] obj The rotary selector

Returns:: A rotary selector item list handle, otherwise NULL if it cannot be created

Since :: 2.3.1

void eext_rotary_selector_part_color_get	(	const Evas_Object *	obj,
		const char *	part_name,
		Eext_Rotary_Selector_Selector_State	state,
		int *	r,
		int *	g,
		int *	b,
		int *	a
	)

Get the selector part color of a rotary selector object.

Parameters:

[in]	obj	The rotary selector
[in]	part_name	The selector part name to get
[in]	state	The selector part
[out]	r	A pointer to Red (0 - 255)
[out]	g	A pointer to Green (0 - 255)
[out]	b	A pointer to Blue (0 - 255)
[out]	a	A pointer to Alpha (0 - 255)

See also:: eext_rotary_selector_item_part_color_set()

This api default support part names.

"selector,bg_image": Selector background image.

Since :: 2.3.1

void eext_rotary_selector_part_color_set	(	Evas_Object *	obj,
		const char *	part_name,
		Eext_Rotary_Selector_Selector_State	state,
		int	r,
		int	g,
		int	b,
		int	a
	)

Set the selector part color of a rotary selector object.

Parameters:

[in]	obj	The rotary selector
[in]	part_name	The selector part name to set
[in]	state	The selector part
[in]	r	Red (0 - 255)
[in]	g	Green (0 - 255)
[in]	b	Blue (0 - 255)
[in]	a	Alpha (0 - 255)

This api default support part names.

"selector,bg_image": Selector background image.

See also:: eext_rotary_selector_part_color_get()

Since :: 2.3.1

Evas_Object * eext_rotary_selector_part_content_get	(	const Evas_Object *	obj,
		const char *	part_name,
		Eext_Rotary_Selector_Selector_State	state
	)

Get the content from the part of the given container widget.

Parameters:

[in]	obj	The rotary selector.
[in]	part_name	The rotary selector part name to set
[in]	state	The selector part

Returns:: The content of the object at the given part, otherwise NULL in case of an error

This api supports following part names by default.

"selector,bg_image": Selector background image.

See also:: eext_rotary_selector_selector_part_content_set()

Since :: 2.3.1

void eext_rotary_selector_part_content_set	(	Evas_Object *	obj,
		const char *	part_name,
		Eext_Rotary_Selector_Selector_State	state,
		Evas_Object *	content
	)

Set the content at a part of a given container widget.

Remarks:: The rotary selector may hold child objects as its contents in given parts. This sets a new content to a given part. If any object is already set as a content object in the given part, the previous object is automatically deleted with this call.

Parameters:

[in]	obj	The rotary selector
[in]	part_name	The rotary selector part name to set
[in]	state	The selector part
[in]	content	The new content for that part

This api supports following part names by default.

"selector,bg_image": Selector background image.

See also:: eext_rotary_selector_selector_part_content_get()

Since :: 2.3.1

Eext_Object_Item * eext_rotary_selector_selected_item_get ( const Evas_Object * obj )

Get the selected item of a rotary selector object.

Parameters:

[in] obj The rotary selector

See also:: eext_rotary_selector_selected_item_set()

Returns:: A selected item handle, otherwise NULL if it cannot be created

Since :: 2.3.1

void eext_rotary_selector_selected_item_set	(	Evas_Object *	obj,
		Eext_Object_Item *	item
	)

Set the selected item of a rotary selector object.

Parameters:

[in]	obj	The rotary selector
[in]	item	The rotary selector item

See also:: eext_rotary_selector_selected_item_get()

Since :: 2.3.1

Functions

Enumeration Type Documentation

Function Documentation