Tizen Native API
5.0
|
More option is composed of the toggle(cue button) and more option view, and more option can change a visibility through the toggle.
More option is based on elm_panel, but more option is different from elm_panel in that the former does not set the scrollable option. To show the more option view, select the toggle or manually use eext_more_option_opened_set(). To hide the more option view, trigger the back event or manually use eext_more_option_opened_set(). Additionally, the toggle disappears when more option view appears. On the other hand, the toggle appears when more option view disappears. The more option view can be manually set by eext_more_option_opened_set() API. An item of more option object can be selected by rotary event.
This widget emits the following signals:
- "item,selected": When the user selects an item.
- "item,clicked": When the user selects the already selected item again or selects a selector.
- "more,option,opened": When more option view is shown.
- "more,option,closed": When more option view is hidden.
Functions | |
Evas_Object * | eext_more_option_add (Evas_Object *parent) |
Add a new more option. | |
void | eext_more_option_direction_set (Evas_Object *obj, Eext_More_Option_Direction direction) |
Set the direction of more option. | |
Eext_More_Option_Direction | eext_more_option_direction_get (const Evas_Object *obj) |
Get Eext_More_Option_Direction. | |
Eext_Object_Item * | eext_more_option_item_append (Evas_Object *obj) |
Append a new item to a more option. | |
Eext_Object_Item * | eext_more_option_item_prepend (Evas_Object *obj) |
prepend a new item to a more option. | |
Eext_Object_Item * | eext_more_option_item_insert_after (Evas_Object *obj, Eext_Object_Item *after) |
Insert a new item into the more option after more option item after. | |
Eext_Object_Item * | eext_more_option_item_insert_before (Evas_Object *obj, Eext_Object_Item *before) |
Insert a new item into the more option before more option item before. | |
void | eext_more_option_item_del (Eext_Object_Item *item) |
Delete an item which is the given more option item item. | |
void | eext_more_option_items_clear (Evas_Object *obj) |
Remove all items from a given more option object. | |
void | eext_more_option_item_part_text_set (Eext_Object_Item *item, const char *part_name, const char *text) |
Set the text of a more option object. | |
const char * | eext_more_option_item_part_text_get (const Eext_Object_Item *item, const char *part_name) |
Set the text of a more option object. | |
void | eext_more_option_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 more option object. | |
void | eext_more_option_item_part_content_set (Eext_Object_Item *item, const char *part_name, Evas_Object *content) |
Set the content to the part of a given container widget. | |
Evas_Object * | eext_more_option_item_part_content_get (const Eext_Object_Item *item, const char *part_name) |
Get the content from the part of a given container widget. | |
void | eext_more_option_opened_set (Evas_Object *obj, Eina_Bool opened) |
Set the visibility of more option view. | |
Eina_Bool | eext_more_option_opened_get (Evas_Object *obj) |
Get whether the more option is set to be shown or to be hidden. | |
const Eina_List * | eext_more_option_items_get (const Evas_Object *obj) |
Get the list of all items from a given more option object. | |
Eina_Bool | eext_more_option_editing_enabled_get (const Evas_Object *obj) |
Get whether the more option object edit mode is enabled or not. | |
void | eext_more_option_editing_enabled_set (Evas_Object *obj, Eina_Bool enabled) |
Set whether the more option object edit mode is enabled or not. | |
Eina_Bool | eext_more_option_add_item_enabled_get (const Evas_Object *obj) |
Get whether item(s) can be added in the edit mode or not. | |
void | eext_more_option_add_item_enabled_set (Evas_Object *obj, Eina_Bool enabled) |
Set whether item(s) can be added in the edit mode or not. | |
Eina_Bool | eext_more_option_item_delete_enabled_get (const Eext_Object_Item *item) |
Get whether the item can be deleted in the edit mode or not. | |
void | eext_more_option_item_delete_enabled_set (Eext_Object_Item *item, Eina_Bool enabled) |
Set whether the item can be deleted in the edit mode or not. By default, it is enabled. |
Enumeration Type Documentation
Enumeration of More Option Direction type.
- Enumerator:
Enumeration of More Option Direction type.
- Enumerator:
Function Documentation
Evas_Object * eext_more_option_add | ( | Evas_Object * | parent | ) |
Add a new more option.
Because the return value is the elm_layout handle, the elm_layout APIs can be applicable to more option handle.
- Parameters:
-
[in] parent The parent object
- Returns:
- A new more option handle, otherwise
NULL
if it cannot be created
- Since :
- 2.3.1
Eina_Bool eext_more_option_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 more option object
- See also:
- eext_more_option_add_item_enabled_set()
- eext_more_option_editing_enabled_get()
- eext_more_option_editing_enabled_set()
- 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_more_option_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 more option object [in] enabled enable delete item in the edit mode
- See also:
- eext_more_option_add_item_enabled_get()
- eext_more_option_editing_enabled_get()
- eext_more_option_editing_enabled_set()
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
Eext_More_Option_Direction eext_more_option_direction_get | ( | const Evas_Object * | obj | ) |
Get Eext_More_Option_Direction.
- Parameters:
-
[in] obj The more option
- Returns:
- A direction of more option
- Since :
- 2.3.1
void eext_more_option_direction_set | ( | Evas_Object * | obj, |
Eext_More_Option_Direction | direction | ||
) |
Set the direction of more option.
- Parameters:
-
[in] obj The more option [in] direction The direction of more option
- Since :
- 2.3.1
Eina_Bool eext_more_option_editing_enabled_get | ( | const Evas_Object * | obj | ) |
Get whether the more option object edit mode is enabled or not.
- Parameters:
-
[in] obj The more option object
- Returns:
- enabling of the more option object's editing mode
- Since :
- 4.0
void eext_more_option_editing_enabled_set | ( | Evas_Object * | obj, |
Eina_Bool | enabled | ||
) |
Set whether the more option object edit mode is enabled or not.
- Parameters:
-
[in] obj The more option object [in] enabled enable editing mode
- Since :
- 4.0
Append a new item to a more option.
- Parameters:
-
[in] obj The more option
- 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_more_option_item_del | ( | Eext_Object_Item * | item | ) |
Delete an item which is the given more option item item.
- Parameters:
-
[in] item The more option item
- Since :
- 2.3.1
Eina_Bool eext_more_option_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 more option object item
- See also:
- eext_more_option_item_delete_enabled_set()
- eext_more_option_editing_enabled_get()
- eext_more_option_editing_enabled_set()
- Returns:
- EINA_TRUE if item can be deleted, otherwise EINA_FALSE
- Since :
- 4.0
void eext_more_option_item_delete_enabled_set | ( | Eext_Object_Item * | item, |
Eina_Bool | enabled | ||
) |
Set whether the item can be deleted in the edit mode or not. By default, it is enabled.
- Parameters:
-
[in] item The more option object item [in] enabled enable delete item in the edit mode
- See also:
- eext_more_option_item_delete_enabled_get()
- eext_more_option_editing_enabled_get()
- eext_more_option_editing_enabled_set()
- Since :
- 4.0
void eext_more_option_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 more option object.
The part name exists with the next.
- "selector,main_text": This locates in the middle of the selector.
- "selector,sub_text": This locates under the main_text.
- Parameters:
-
[in] item The more option 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
- Since :
- 2.3.1
Eext_Object_Item * eext_more_option_item_insert_after | ( | Evas_Object * | obj, |
Eext_Object_Item * | after | ||
) |
Insert a new item into the more option after more option item after.
- Parameters:
-
[in] obj The more option [in] after The more option 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_more_option_item_insert_before | ( | Evas_Object * | obj, |
Eext_Object_Item * | before | ||
) |
Insert a new item into the more option before more option item before.
- Parameters:
-
[in] obj The more option [in] before The more option 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
Evas_Object * eext_more_option_item_part_content_get | ( | const Eext_Object_Item * | item, |
const char * | part_name | ||
) |
Get the content from the part of a given container widget.
The part name exists with the next.
- "item,icon": This locates in the middle of the selector.
- Parameters:
-
[in] item The more option item [in] part_name The more option item's part name to get
- Returns:
- The content of the object at the given part, otherwise
NULL
in case of an error
- Since :
- 2.3.1
void eext_more_option_item_part_content_set | ( | Eext_Object_Item * | item, |
const char * | part_name, | ||
Evas_Object * | content | ||
) |
Set the content to the part of a given container widget.
The part name exists with the next.
- "item,icon": This locates in the middle of the selector.
- Remarks:
- The more option item may hold child objects as content at given parts. This sets new content to a given part. If any object is already set as a content object in the same part, the previous object is automatically deleted. with this call.
- Parameters:
-
[in] item The more option item [in] part_name The more option item's part name to set [in] content The new content for that part
- Since :
- 2.3.1
const char * eext_more_option_item_part_text_get | ( | const Eext_Object_Item * | item, |
const char * | part_name | ||
) |
Set the text of a more option object.
The part name exists with the next.
- "selector,main_text": This locates in the middle of the selector.
- "selector,sub_text": This locates under the main_text.
- Parameters:
-
[in] item The more option item [in] part_name The text part name to get ( NULL
for the default part)
- Returns:
- The text of the part, otherwise
NULL
in case of an error
- Since :
- 2.3.1
void eext_more_option_item_part_text_set | ( | Eext_Object_Item * | item, |
const char * | part_name, | ||
const char * | text | ||
) |
Set the text of a more option object.
The part name exists with the next.
- "selector,main_text": This locates in the middle of the selector.
- "selector,sub_text": This locates under the main_text.
- Parameters:
-
[in] item The more option item [in] part_name The text part name to set ( NULL
for the default part)[in] text The new text of the part
- Since :
- 2.3.1
prepend a new item to a more option.
- Parameters:
-
[in] obj The more option
- 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_more_option_items_clear | ( | Evas_Object * | obj | ) |
Remove all items from a given more option object.
- Parameters:
-
[in] obj The more option
- Since :
- 2.3.1
const Eina_List * eext_more_option_items_get | ( | const Evas_Object * | obj | ) |
Get the list of all items from a given more option object.
- Parameters:
-
[in] obj The more option object
- Returns:
- All item lists of the more option..
- Since :
- 2.3.1
Get whether the more option is set to be shown or to be hidden.
- Parameters:
-
[in] obj The more option object
- Returns:
- If
EINA_TRUE
, more option is shown. OtherwiseEINA_FALSE
, more option is hidden.
- See also:
- eext_more_option_opened_set()
- Since :
- 2.3.1
void eext_more_option_opened_set | ( | Evas_Object * | obj, |
Eina_Bool | opened | ||
) |
Set the visibility of more option view.
If opened is EINA_TRUE
, more option view in which the rotary selector is included disappears and toggle appears. If opened is EINA_FALSE
, more option view in which the rotary selector is included appears and toggle disappear.
- Remarks:
- When more option is closed and opened again, the first item is always selected.
- Parameters:
-
[in] obj The more option object [in] opened If EINA_TRUE
, the more option runs the animation to appear, IfEINA_FALSE
, the more option runs the animation to disappear
- See also:
- eext_more_option_opened_get()
- Since :
- 2.3.1