2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @defgroup Multibuttonentry Multibuttonentry
|
|
|
|
*
|
2012-03-05 17:45:25 -08:00
|
|
|
* A Multibuttonentry is a widget to allow a user enter text and manage it as a number
|
|
|
|
* 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.
|
2011-12-29 23:20:48 -08:00
|
|
|
* Backspace removes the focus.
|
2012-03-05 17:45:25 -08:00
|
|
|
* When the Multibuttonentry loses focus items longer than one line are shrunk
|
|
|
|
* to one line.
|
|
|
|
*
|
|
|
|
* Typical use case of multibuttonentry is, composing emails/messages to a group
|
|
|
|
* of addresses, each of which is an item that can be clicked for further actions.
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* Smart callbacks one can register:
|
2012-03-06 04:06:52 -08:00
|
|
|
* XXX: remove "item,selected". use callback from item_append/prepend instead. (discussed with MBE contributor)
|
2011-12-29 23:20:48 -08:00
|
|
|
* - @c "item,selected" - when item is selected. May be called on backspace key.
|
|
|
|
* - @c "item,added" - when a new multibuttonentry item is added.
|
|
|
|
* - @c "item,deleted" - when a multibuttonentry item is deleted.
|
2012-03-06 04:06:52 -08:00
|
|
|
* XXX: remove "item,clicked". use callback from item_append/prepend instead. (discussed with MBE contributor)
|
2011-12-29 23:20:48 -08:00
|
|
|
* - @c "item,clicked" - selected item of multibuttonentry is clicked.
|
|
|
|
* - @c "clicked" - when multibuttonentry is clicked.
|
|
|
|
* - @c "focused" - when multibuttonentry is focused.
|
|
|
|
* - @c "unfocused" - when multibuttonentry is unfocused.
|
|
|
|
* - @c "expanded" - when multibuttonentry is expanded.
|
2012-03-02 22:11:50 -08:00
|
|
|
* - @c "contracted" - when multibuttonentry is contracted.
|
2012-03-06 04:06:52 -08:00
|
|
|
* XXX: change "shrink,state,changed" to "expand,state,changed"
|
2012-03-02 22:11:50 -08:00
|
|
|
* - @c "shrink,state,changed" - when shrink mode state of multibuttonentry is
|
2012-01-02 02:40:17 -08:00
|
|
|
* changed.
|
|
|
|
*
|
|
|
|
* Default text parts of the multibuttonentry widget that you can use for are:
|
|
|
|
* @li "default" - A label of the multibuttonentry
|
|
|
|
*
|
|
|
|
* Default text parts of the multibuttonentry items that you can use for are:
|
|
|
|
* @li "default" - A label of the multibuttonentry item
|
|
|
|
*
|
2012-01-02 04:53:29 -08:00
|
|
|
* Supported elm_object common APIs.
|
|
|
|
* @li elm_object_signal_emit
|
|
|
|
* @li elm_object_part_text_set
|
|
|
|
* @li elm_object_part_text_get
|
|
|
|
*
|
|
|
|
* Supported elm_object_item common APIs.
|
|
|
|
* @li elm_object_item_part_text_set
|
|
|
|
* @li elm_object_item_part_text_get
|
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @addtogroup Multibuttonentry
|
|
|
|
* @{
|
|
|
|
*/
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2012-03-06 02:59:29 -08:00
|
|
|
// XXX: typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_Cb)(Evas_Object *obj, const char *item_label, void *item_data, void *data);
|
|
|
|
// XXX: need documentation.
|
2011-12-29 23:20:48 -08:00
|
|
|
typedef Eina_Bool (*Elm_Multibuttonentry_Item_Filter_callback)(Evas_Object *obj, const char *item_label, void *item_data, void *data);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @brief Add a new multibuttonentry to the parent
|
|
|
|
*
|
|
|
|
* @param parent The parent object
|
|
|
|
* @return The new object or NULL if it cannot be created
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
*
|
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Get the entry of the multibuttonentry object
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @return The entry object, or NULL if none
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
2012-03-05 17:45:25 -08:00
|
|
|
* Get the value of expanded state.
|
|
|
|
* In expanded state, the complete entry will be displayed.
|
|
|
|
* Otherwise, only single line of the entry will be displayed.
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
2012-03-05 17:45:25 -08:00
|
|
|
* @return EINA_TRUE if the widget is in expanded state. EINA_FALSE if not.
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-05 17:45:25 -08:00
|
|
|
EAPI Eina_Bool elm_multibuttonentry_expanded_get(const Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
2012-03-05 17:45:25 -08:00
|
|
|
* Set/Unset the multibuttonentry to expanded state.
|
|
|
|
* In expanded state, the complete entry will be displayed.
|
|
|
|
* Otherwise, only single line of the entry will be displayed.
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
2012-03-05 17:45:25 -08:00
|
|
|
* @param expanded the value of expanded state.
|
|
|
|
* Set this to EINA_TRUE for expanded state.
|
|
|
|
* Set this to EINA_FALSE for single line state.
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-05 17:45:25 -08:00
|
|
|
EAPI void elm_multibuttonentry_expanded_set(Evas_Object *obj, Eina_Bool expanded);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Prepend a new item to the multibuttonentry
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @param label The label of new item
|
2012-03-05 23:01:09 -08:00
|
|
|
* @param func The callback function to be invoked when this item is pressed.
|
2012-02-14 00:50:20 -08:00
|
|
|
* @param data The pointer to the data to be attached
|
2011-12-29 23:20:48 -08:00
|
|
|
* @return A handle to the item added or NULL if not possible
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-06 04:14:35 -08:00
|
|
|
EAPI Elm_Object_Item *elm_multibuttonentry_item_prepend(Evas_Object *obj, const char *label, void *data);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Append a new item to the multibuttonentry
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @param label The label of new item
|
2012-03-05 23:01:09 -08:00
|
|
|
* @param func The callback function to be invoked when this item is pressed.
|
2012-02-14 00:50:20 -08:00
|
|
|
* @param data The pointer to the data to be attached
|
2011-12-29 23:20:48 -08:00
|
|
|
* @return A handle to the item added or NULL if not possible
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-06 04:14:35 -08:00
|
|
|
EAPI Elm_Object_Item *elm_multibuttonentry_item_append(Evas_Object *obj, const char *label, void *data);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Add a new item to the multibuttonentry before the indicated object
|
|
|
|
*
|
|
|
|
* reference.
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @param before The item before which to add it
|
|
|
|
* @param label The label of new item
|
2012-03-05 23:01:09 -08:00
|
|
|
* @param func The callback function to be invoked when this item is pressed.
|
2012-02-14 00:50:20 -08:00
|
|
|
* @param data The pointer to the data to be attached
|
2011-12-29 23:20:48 -08:00
|
|
|
* @return A handle to the item added or NULL if not possible
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-06 04:14:35 -08:00
|
|
|
EAPI Elm_Object_Item *elm_multibuttonentry_item_insert_before(Evas_Object *obj, Elm_Object_Item *before, const char *label, void *data);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Add a new item to the multibuttonentry after the indicated object
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @param after The item after which to add it
|
|
|
|
* @param label The label of new item
|
2012-03-05 23:01:09 -08:00
|
|
|
* @param func The callback function to be invoked when this item is pressed.
|
2012-02-14 00:50:20 -08:00
|
|
|
* @param data The pointer to the data to be attached
|
2011-12-29 23:20:48 -08:00
|
|
|
* @return A handle to the item added or NULL if not possible
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-06 04:14:35 -08:00
|
|
|
EAPI Elm_Object_Item *elm_multibuttonentry_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *label, void *data);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Get a list of items in the multibuttonentry
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @return The list of items, or NULL if none
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Get the first item in the multibuttonentry
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @return The first item, or NULL if none
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-01-02 02:10:23 -08:00
|
|
|
EAPI Elm_Object_Item *elm_multibuttonentry_first_item_get(const Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Get the last item in the multibuttonentry
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @return The last item, or NULL if none
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-01-02 02:10:23 -08:00
|
|
|
EAPI Elm_Object_Item *elm_multibuttonentry_last_item_get(const Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Get the selected item in the multibuttonentry
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @return The selected item, or NULL if none
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-01-02 02:10:23 -08:00
|
|
|
EAPI Elm_Object_Item *elm_multibuttonentry_selected_item_get(const Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Set the selected state of an item
|
|
|
|
*
|
2012-01-02 02:40:17 -08:00
|
|
|
* @param it The item
|
2011-12-29 23:20:48 -08:00
|
|
|
* @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-06 02:59:29 -08:00
|
|
|
// XXX: EAPI void elm_multibuttonentry_item_selected_set(Elm_Object_Item *it, Eina_Bool selected);
|
2012-01-02 02:10:23 -08:00
|
|
|
EAPI void elm_multibuttonentry_item_select(Elm_Object_Item *it, Eina_Bool selected);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2012-03-06 02:59:29 -08:00
|
|
|
// XXX: Add EAPI Eina_Bool elm_multibuttonentry_item_selected_get(const Elm_Object_Item *it);
|
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* unselect all items.
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-06 02:59:29 -08:00
|
|
|
// XXX: deprecated this. only one item can be selected but why this does unselect all?
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Remove all items in the multibuttonentry.
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI void elm_multibuttonentry_clear(Evas_Object *obj);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Get the previous item in the multibuttonentry
|
|
|
|
*
|
2012-01-02 02:10:23 -08:00
|
|
|
* @param it The item
|
|
|
|
* @return The item before the item @p it
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-01-02 02:10:23 -08:00
|
|
|
EAPI Elm_Object_Item *elm_multibuttonentry_item_prev_get(const Elm_Object_Item *it);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Get the next item in the multibuttonentry
|
|
|
|
*
|
2012-01-02 02:10:23 -08:00
|
|
|
* @param it The item
|
|
|
|
* @return The item after the item @p it
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-01-02 02:10:23 -08:00
|
|
|
EAPI Elm_Object_Item *elm_multibuttonentry_item_next_get(const Elm_Object_Item *it);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
2012-03-04 21:31:49 -08:00
|
|
|
* Append an item filter function for text inserted in the Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* Append the given callback to the list. This functions will be called
|
|
|
|
* whenever any text is inserted into the Multibuttonentry, with the text to be inserted
|
|
|
|
* as a parameter. The callback function is free to alter the text in any way
|
|
|
|
* it wants, but it must remember to free the given pointer and update it.
|
|
|
|
* If the new text is to be discarded, the function can free it and set it text
|
|
|
|
* parameter to NULL. This will also prevent any following filters from being
|
|
|
|
* called.
|
|
|
|
*
|
2012-02-14 00:50:20 -08:00
|
|
|
* @param obj The multibuttonentry object
|
2011-12-29 23:20:48 -08:00
|
|
|
* @param func The function to use as item filter
|
|
|
|
* @param data User data to pass to @p func
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-06 02:59:29 -08:00
|
|
|
// XXX: EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_CB func, void *data);
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI void elm_multibuttonentry_item_filter_append(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
2012-02-14 00:50:20 -08:00
|
|
|
* Prepend a filter function for text inserted in the Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* Prepend the given callback to the list. See elm_multibuttonentry_item_filter_append()
|
|
|
|
* for more information
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @param func The function to use as text filter
|
|
|
|
* @param data User data to pass to @p func
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-06 02:59:29 -08:00
|
|
|
// XXX: EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_Cb func, void *data);
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI void elm_multibuttonentry_item_filter_prepend(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Remove a filter from the list
|
|
|
|
*
|
|
|
|
* Removes the given callback from the filter list. See elm_multibuttonentry_item_filter_append()
|
|
|
|
* for more information.
|
|
|
|
*
|
|
|
|
* @param obj The multibuttonentry object
|
|
|
|
* @param func The filter function to remove
|
|
|
|
* @param data The user data passed when adding the function
|
|
|
|
*
|
2012-02-05 19:20:39 -08:00
|
|
|
* @ingroup Multibuttonentry
|
2011-12-29 23:20:48 -08:00
|
|
|
*/
|
2012-03-06 02:59:29 -08:00
|
|
|
// XXX: EAPI void elm_multibuttonentry_item_filter_del(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_Cb func, void *data); --> api name and callback changes.
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI void elm_multibuttonentry_item_filter_remove(Evas_Object *obj, Elm_Multibuttonentry_Item_Filter_callback func, void *data);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|