From a7f2d73203863851a670075c3942c697f46badd4 Mon Sep 17 00:00:00 2001 From: Mike McCormack Date: Thu, 24 Nov 2011 18:06:44 +0900 Subject: [PATCH] elementary: Add docs from upstream --- src/lib/Elementary.h.in | 252 +++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 238 insertions(+), 14 deletions(-) diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in index 32ce4bd..5546e64 100644 --- a/src/lib/Elementary.h.in +++ b/src/lib/Elementary.h.in @@ -29301,50 +29301,274 @@ extern "C" { */ - /* multibuttonentry */ + /** + * @defgroup Multibuttonenetry Multibuttonenetry + * + * @image html img/widget/flipselector/preview-00.png + * @image latex img/widget/flipselector/preview-00.eps + * + * A Multibuttonentry is a widget to allow a user to insert a text button. + * the text button is inserted by pressing the "return" key. If there is no space in the current row, + * the new button is entered in the next row. If the button is pressed, it will become focused. + * The focus can be removed by pressing the "backspace" key. + * when items are added over 1 lines, if Multibuttonentry lost focus, it becase shrink mode ( made it 1 line) + * + * Smart callbacks one can register to: + * - @c "item,selected" - when item is selected . it can be called by backspace key. + * - @c "item,added" - when a new multibuttonentry item is added. + * - @c "item,deleted" -when a multibuttonentry item is deleted. + * - @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 . + * - @c "shrank" - when multibuttonentry is shrank. + * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed. + * + * Here is an example on its usage: + * @li @ref multibuttonentry_example + */ + /** + * @addtogroup Multibuttonentry + * @{ + */ + typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item; typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data); + + /** + * @brief Add a new multibuttonentry to the parent + * + * @param parent The parent object + * @return The new object or NULL if it cannot be created + * + * @ingroup Multibuttonentry + */ EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent); + /** + * Get the label + * + * @param obj The multibuttonentry object + * @return The label, or NULL if none + * + * @ingroup Multibuttonentry + */ EAPI const char *elm_multibuttonentry_label_get(const Evas_Object *obj); + /** + * Set the label + * + * @param obj The multibuttonentry object + * @param label The text label string + * + * @ingroup Multibuttonentry + */ EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label); + /** + * Get the entry of the multibuttonentry object + * + * @param obj The multibuttonentry object + * @return The entry object, or NULL if none + * + * @ingroup Multibuttonentry + */ EAPI Evas_Object *elm_multibuttonentry_entry_get(const Evas_Object *obj); + /** + * Get the guide text + * + * @param obj The multibuttonentry object + * @return The guide text, or NULL if none + * + * @ingroup Multibuttonentry + */ EAPI const char * elm_multibuttonentry_guide_text_get(const Evas_Object *obj); + /** + * Set the guide text + * + * @param obj The multibuttonentry object + * @param label The guide text string + * + * @ingroup Multibuttonentry + */ EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext); + /** + * Get the value of shrink_mode state. + * + * @param obj The multibuttonentry object + * @param the value of shrink mode state. + * + * @ingroup Multibuttonentry + */ EAPI int elm_multibuttonentry_contracted_state_get(const Evas_Object *obj); + /** + * Set/Unset the multibuttonentry to shrink mode state of single line + * + * @param obj The multibuttonentry object + * @param the value of shrink_mode state. set this to 1 to set the multibuttonentry to shrink state of single line. set this to 0 to unset the contracted state. + * + * @ingroup Multibuttonentry + */ EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted); + /** + * Prepend a new item to the multibuttonentry + * + * @param obj The multibuttonentry object + * @param label The label of new item + * @param data The ponter to the data to be attached + * @return A handle to the item added or NULL if not possible + * + * @ingroup Multibuttonentry + */ EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data); + /** + * Append a new item to the multibuttonentry + * + * @param obj The multibuttonentry object + * @param label The label of new item + * @param data The ponter to the data to be attached + * @return A handle to the item added or NULL if not possible + * + * @ingroup Multibuttonentry + */ EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data); + /** + * 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 + * @param data The ponter to the data to be attached + * @return A handle to the item added or NULL if not possible + * + * @ingroup Multibuttonentry + */ EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data); + /** + * 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 + * @param data The ponter to the data to be attached + * @return A handle to the item added or NULL if not possible + * + * @ingroup Multibuttonentry + */ EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data); + /** + * Get a list of items in the multibuttonentry + * + * @param obj The multibuttonentry object + * @return The list of items, or NULL if none + * + * @ingroup Multibuttonentry + */ EAPI const Eina_List *elm_multibuttonentry_items_get(const Evas_Object *obj); + /** + * Get the first item in the multibuttonentry + * + * @param obj The multibuttonentry object + * @return The first item, or NULL if none + * + * @ingroup Multibuttonentry + */ EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj); + /** + * Get the last item in the multibuttonentry + * + * @param obj The multibuttonentry object + * @return The last item, or NULL if none + * + * @ingroup Multibuttonentry + */ EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj); + /** + * Get the selected item in the multibuttonentry + * + * @param obj The multibuttonentry object + * @return The selected item, or NULL if none + * + * @ingroup Multibuttonentry + */ EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj); + /** + * Set the selected state of an item + * + * @param item The item + * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item + * + * @ingroup Multibuttonentry + */ EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item); + /** + * unselect all of items. + * + * @param obj The multibuttonentry object + * + * @ingroup Multibuttonentry + */ EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj); + /** + * Delete a given item + * + * @param item The item + * + * @ingroup Multibuttonentry + */ EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item); + /** + * Remove all items in the multibuttonentry. + * + * @param obj The multibuttonentry object + * + * @ingroup Multibuttonentry + */ EAPI void elm_multibuttonentry_items_del(Evas_Object *obj); + /** + * Get the label of a given item + * + * @param item The item + * @return The label of a given item, or NULL if none + * + * @ingroup Multibuttonentry + */ EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item); + /** + * Set the label of a given item + * + * @param item The item + * @param label The text label string + * + * @ingroup Multibuttonentry + */ EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str); + /** + * Get the previous item in the multibuttonentry + * + * @param item The item + * @return The item before the item @p item + * + * @ingroup Multibuttonentry + */ EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item); + /** + * Get the next item in the multibuttonentry + * + * @param item The item + * @return The item after the item @p item + * + * @ingroup Multibuttonentry + */ EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item); + EAPI void *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item); EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data); EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data); - /* smart callback called: - * "selected" - This signal is emitted when the selected item of multibuttonentry is changed. - * "added" - This signal is emitted when a new multibuttonentry item is added. - * "deleted" - This signal is emitted when a multibuttonentry item is deleted. - * "expanded" - This signal is emitted when a multibuttonentry is expanded. - * "contracted" - This signal is emitted when a multibuttonentry is contracted. - * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed. - * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed. - * "item,added" - This signal is emitted when a new multibuttonentry item is added. - * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted. - * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked. - * "clicked" - This signal is emitted when a multibuttonentry is clicked. - * "unfocused" - This signal is emitted when a multibuttonentry is unfocused. + + /** + * @} */ + /* available styles: * default */ -- 2.7.4