Functions |
Evas_Object * | elm_multibuttonentry_add (Evas_Object *parent) |
| Add a new multibuttonentry to the parent.
|
Evas_Object * | elm_multibuttonentry_entry_get (const Evas_Object *obj) |
| Get the entry of the multibuttonentry object.
|
Eina_Bool | elm_multibuttonentry_expanded_get (const Evas_Object *obj) |
| Get the value of expanded state.
|
void | elm_multibuttonentry_expanded_set (Evas_Object *obj, Eina_Bool expanded) |
| Set/Unset the multibuttonentry to expanded state.
|
Elm_Object_Item * | elm_multibuttonentry_item_prepend (Evas_Object *obj, const char *label, Evas_Smart_Cb func, const void *data) |
| Prepend a new item to the multibuttonentry.
|
Elm_Object_Item * | elm_multibuttonentry_item_append (Evas_Object *obj, const char *label, Evas_Smart_Cb func, const void *data) |
| Append a new item to the multibuttonentry.
|
Elm_Object_Item * | elm_multibuttonentry_item_insert_before (Evas_Object *obj, Elm_Object_Item *before, const char *label, Evas_Smart_Cb func, const void *data) |
| Add a new item to the multibuttonentry before the indicated object.
|
Elm_Object_Item * | elm_multibuttonentry_item_insert_after (Evas_Object *obj, Elm_Object_Item *after, const char *label, Evas_Smart_Cb func, const void *data) |
| Add a new item to the multibuttonentry after the indicated object.
|
const Eina_List * | elm_multibuttonentry_items_get (const Evas_Object *obj) |
| Get a list of items in the multibuttonentry.
|
Elm_Object_Item * | elm_multibuttonentry_first_item_get (const Evas_Object *obj) |
| Get the first item in the multibuttonentry.
|
Elm_Object_Item * | elm_multibuttonentry_last_item_get (const Evas_Object *obj) |
| Get the last item in the multibuttonentry.
|
Elm_Object_Item * | elm_multibuttonentry_selected_item_get (const Evas_Object *obj) |
| Get the selected item in the multibuttonentry.
|
void | elm_multibuttonentry_item_selected_set (Elm_Object_Item *it, Eina_Bool selected) |
| Set the selected state of an item.
|
Eina_Bool | elm_multibuttonentry_item_selected_get (const Elm_Object_Item *it) |
| Get the selected state of an item.
|
void | elm_multibuttonentry_clear (Evas_Object *obj) |
| Remove all items in the multibuttonentry.
|
Elm_Object_Item * | elm_multibuttonentry_item_prev_get (const Elm_Object_Item *it) |
| Get the previous item in the multibuttonentry.
|
Elm_Object_Item * | elm_multibuttonentry_item_next_get (const Elm_Object_Item *it) |
| Get the next item in the multibuttonentry.
|
void | elm_multibuttonentry_item_filter_append (Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_Cb func, const void *data) |
| Append an item filter function for text inserted in the Multibuttonentry.
|
void | elm_multibuttonentry_item_filter_prepend (Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_Cb func, const void *data) |
| Prepend a filter function for text inserted in the Multibuttonentry.
|
void | elm_multibuttonentry_item_filter_remove (Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_Cb func, const void *data) |
| Remove a filter from the list.
|
void | elm_multibuttonentry_editable_set (Evas_Object *obj, Eina_Bool editable) |
| Sets if the multibuttonentry is to be editable or not.
|
Eina_Bool | elm_multibuttonentry_editable_get (const Evas_Object *obj) |
| Gets whether the multibuttonentry is editable or not.
|
Typedefs |
typedef Eina_Bool(* | Elm_Multibuttonentry_Item_Filter_Cb )(Evas_Object *obj, const char *item_label, const void *item_data, const void *data) |
| Callback to be invoked when an item is added to the multibuttonentry.
|
A multi-button entry is a widget letting an user enter text and each chunk of text managed as a set of buttons.
Each text button is inserted by pressing the "return" key. If there is no space in the current row, a new button is added to the next row. When a text button is pressed, it will become focused. Backspace removes the focus. When the multi-button entry loses focus, items longer than one line are shrunk to one line.
The typical use case of multi-button entry is composing emails/messages to a group of addresses, each of which is an item that can be clicked for further actions.
This widget inherits from the Layout one, so that all the functions acting on it also work for multi-button entry objects (
- Since (EFL) :
- 1.8).
This widget emits the following signals, besides the ones sent from Layout :
"item,selected"
- this is called when an item is selected by api, user interaction, and etc. this is also called when a user press back space while cursor is on the first field of entry.
"item,added"
- when a new multi-button entry item is added.
"item,deleted"
- when a multi-button entry item is deleted.
"item,clicked"
- this is called when an item is clicked by user interaction. Both "item,selected" and "item,clicked" are needed.
"clicked"
- when multi-button entry is clicked.
"focused"
- when multi-button entry is focused.
"unfocused"
- when multi-button entry is unfocused.
"expanded"
- when multi-button entry is expanded.
"contracted"
- when multi-button entry is contracted.
"expand,state,changed"
- when shrink mode state of multi-button entry is changed.
"longpressed"
- when multi-button entry is pressed for a long time.
Default text parts of the multi-button entry widget that you can use are:
- "default" - A label of the multi-button entry
Default text parts of multi-button entry items that you can use are:
- "default" - A label of the multi-button entry item
Supported elm_object_item common APIs.
Typedef Documentation
Callback to be invoked when an item is added to the multibuttonentry.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The parent object |
[in] | item_label | The label corresponding to the added item. |
[in] | item_data | data specific to this item. |
[in] | data | data specific to the multibuttonentry. |
- Returns:
- EINA_TRUE EINA_FALSE otherwise.
Function Documentation
Add a new multibuttonentry to the parent.
- Since :
- 2.3
- Parameters:
-
[in] | parent | The parent object |
- Returns:
- The new object or NULL if it cannot be created
Remove all items in the multibuttonentry.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
Gets whether the multibuttonentry is editable or not.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
- Returns:
- EINA_TRUE if the multibuttonentry is editable by the user. EINA_FALSE if not.
- Since (EFL) :
- 1.7
Sets if the multibuttonentry is to be editable or not.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
[in] | editable | If EINA_TRUE, user can add/delete item in multibuttonentry, if not, the multibuttonentry is non-editable. |
- Since (EFL) :
- 1.7
Get the entry of the multibuttonentry object.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
- Returns:
- The entry object, or NULL if none
Get the value of expanded state.
e
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
- Returns:
- EINA_TRUE if the widget is in expanded state. EINA_FALSE if not.
Set/Unset the multibuttonentry to expanded state.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
[in] | expanded | the value of expanded state. Set this to EINA_TRUE for expanded state. Set this to EINA_FALSE for single line state. |
Get the first item in the multibuttonentry.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
- Returns:
- The first item, or NULL if none
Append a new item to the multibuttonentry.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
[in] | label | The label of new item |
[in] | func | The callback function to be invoked when this item is pressed. |
[in] | data | The pointer to the data to be attached |
- Returns:
- A handle to the item added or NULL if not possible
- See also:
- Use elm_object_item_del() to delete the item.
Append an item filter function for text inserted in the Multibuttonentry.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
[in] | func | The function to use as item filter |
[in] | data | User data to pass to func |
Prepend a filter function for text inserted in the Multibuttonentry.
Prepend the given callback to the list.
- Since :
- 2.3
- See also:
- elm_multibuttonentry_item_filter_append()
- Parameters:
-
[in] | obj | The multibuttonentry object |
[in] | func | The function to use as text filter |
[in] | data | User data to pass to func |
Remove a filter from the list.
Removes the given callback from the filter list.
- Since :
- 2.3
- See also:
- elm_multibuttonentry_item_filter_append()
- Parameters:
-
[in] | obj | The multibuttonentry object |
[in] | func | The filter function to remove |
[in] | data | The user data passed when adding the function |
Add a new item to the multibuttonentry after the indicated object.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
[in] | after | The item after which to add it |
[in] | label | The label of new item |
[in] | func | The callback function to be invoked when this item is pressed. |
[in] | data | The pointer to the data to be attached |
- Returns:
- A handle to the item added or NULL if not possible
- See also:
- Use elm_object_item_del() to delete the item.
Add a new item to the multibuttonentry before the indicated object.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
[in] | before | The item before which to add it |
[in] | label | The label of new item |
[in] | func | The callback function to be invoked when this item is pressed. |
[in] | data | The pointer to the data to be attached |
- Returns:
- A handle to the item added or NULL if not possible
- See also:
- Use elm_object_item_del() to delete the item.
Get the next item in the multibuttonentry.
- Since :
- 2.3
- Parameters:
-
- Returns:
- The item after the item
it
Prepend a new item to the multibuttonentry.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
[in] | label | The label of new item |
[in] | func | The callback function to be invoked when this item is pressed. |
[in] | data | The pointer to the data to be attached |
- Returns:
- A handle to the item added or NULL if not possible
- See also:
- Use elm_object_item_del() to delete the item.
Get the previous item in the multibuttonentry.
- Since :
- 2.3
- Parameters:
-
- Returns:
- The item before the item
it
Get the selected state of an item.
- Since :
- 2.3
- Parameters:
-
- Returns:
- EINA_TRUE if the item is selected, EINA_FALSE otherwise.
Set the selected state of an item.
- Since :
- 2.3
- Parameters:
-
[in] | it | The item |
[in] | selected | if it's EINA_TRUE, select the item otherwise, unselect the item |
Get a list of items in the multibuttonentry.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
- Returns:
- The list of items, or NULL if none
Get the last item in the multibuttonentry.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
- Returns:
- The last item, or NULL if none
Get the selected item in the multibuttonentry.
- Since :
- 2.3
- Parameters:
-
[in] | obj | The multibuttonentry object |
- Returns:
- The selected item, or NULL if none