diff options
Diffstat (limited to 'src/lib/elm_entry_common.h')
| -rw-r--r-- | src/lib/elm_entry_common.h | 93 |
1 files changed, 49 insertions, 44 deletions
diff --git a/src/lib/elm_entry_common.h b/src/lib/elm_entry_common.h index 4b5215d36..013f5c31d 100644 --- a/src/lib/elm_entry_common.h +++ b/src/lib/elm_entry_common.h @@ -1,9 +1,14 @@ /** - * @typedef Elm_Text_Format + * @addtogroup Entry * + * @{ + */ + +/** * Text Format types. * * @see elm_entry_file_set() + * @ingroup Entry */ typedef enum { @@ -12,11 +17,11 @@ typedef enum } Elm_Text_Format; /** - * @typedef Elm_Wrap_Type - * - * Line wrapping types. - * + * @enum Elm_Wrap_Type + * aAbrief Line wrapping types. + * @details Type of word or character wrapping to use * @see elm_entry_line_wrap_set() + * @ingroup Entry */ typedef enum { @@ -24,12 +29,10 @@ typedef enum ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */ ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */ ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */ - ELM_WRAP_LAST -} Elm_Wrap_Type; /**< Type of word or character wrapping to use */ + ELM_WRAP_LAST /**< WTF */ +} Elm_Wrap_Type; /** - * @typedef Elm_Input_Panel_Layout - * * Input panel (virtual keyboard) layout types. * * @see elm_entry_input_panel_layout_set() @@ -74,8 +77,6 @@ enum }; /** - * @typedef Elm_Input_Panel_Lang - * * Input panel (virtual keyboard) language modes. * * @see elm_entry_input_panel_language_set() @@ -87,8 +88,6 @@ typedef enum } Elm_Input_Panel_Lang; /** - * @typedef Elm_Autocapital_Type - * * Autocapitalization Types. * * @see elm_entry_autocapital_type_set() @@ -102,8 +101,6 @@ typedef enum } Elm_Autocapital_Type; /**< Choose method of auto-capitalization */ /** - * @typedef Elm_Input_Panel_Return_Key_Type - * * "Return" Key types on the input panel (virtual keyboard). * * @see elm_entry_input_panel_return_key_type_set() @@ -121,10 +118,16 @@ typedef enum ELM_INPUT_PANEL_RETURN_KEY_TYPE_SIGNIN /**< Sign-in @since 1.8 */ } Elm_Input_Panel_Return_Key_Type; + +/** + * @} + */ + /** - * @typedef Elm_Input_Hints * @brief Enumeration that defines the types of Input Hints. * @since 1.12 + * + * @ingroup Entry */ typedef enum { @@ -134,18 +137,18 @@ typedef enum } Elm_Input_Hints; /** - * @typedef Elm_Entry_Anchor_Info - * * The info sent in the callback for the "anchor,clicked" signals emitted * by entries. + * + * @ingroup Entry */ typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info; /** - * @struct _Elm_Entry_Anchor_Info - * * The info sent in the callback for the "anchor,clicked" signals emitted * by entries. + * + * @ingroup Entry */ struct _Elm_Entry_Anchor_Info { @@ -158,26 +161,26 @@ struct _Elm_Entry_Anchor_Info }; /** - * @typedef Elm_Entry_Anchor_Hover_Info - * * The info sent in the callback for "anchor,clicked" signals emitted by * the Anchor_Hover widget. + * + * @ingroup Entry */ typedef struct _Elm_Entry_Anchor_Hover_Info Elm_Entry_Anchor_Hover_Info; /** - * @typedef Elm_Entry_Context_Menu_Item - * * Type of contextual item that can be added in to long press menu. * @since 1.8 + * + * @ingroup Entry */ typedef struct _Elm_Entry_Context_Menu_Item Elm_Entry_Context_Menu_Item; /** - * @struct _Elm_Entry_Anchor_Hover_Info - * * The info sent in the callback for "anchor,clicked" signals emitted by * the Anchor_Hover widget. + * + * @ingroup Entry */ struct _Elm_Entry_Anchor_Hover_Info { @@ -209,7 +212,6 @@ struct _Elm_Entry_Anchor_Hover_Info }; /** - * @typedef Elm_Entry_Item_Provider_Cb * This callback type is used to provide items. * If it returns an object handle other than NULL (it should create an * object to do this), then this object is used to replace the current item. @@ -222,11 +224,12 @@ struct _Elm_Entry_Anchor_Hover_Info * @see elm_entry_item_provider_append * @see elm_entry_item_provider_prepend * @see elm_entry_item_provider_remove + * + * @ingroup Entry */ typedef Evas_Object * (*Elm_Entry_Item_Provider_Cb)(void *data, Evas_Object * entry, const char *item); /** - * @typedef Elm_Entry_Filter_Cb * This callback type is used by entry filters to modify text. * @param data The data specified as the last param when adding the filter * @param entry The entry object @@ -234,13 +237,16 @@ typedef Evas_Object * (*Elm_Entry_Item_Provider_Cb)(void *data, Evas_Object * en * @see elm_entry_markup_filter_append * @see elm_entry_markup_filter_prepend * @see elm_entry_markup_filter_remove + * + * @ingroup Entry */ typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text); /** - * @typedef Elm_Entry_Change_Info * This corresponds to Edje_Entry_Change_Info. Includes information about * a change in the entry. + * + * @ingroup Entry */ typedef Edje_Entry_Change_Info Elm_Entry_Change_Info; @@ -280,16 +286,16 @@ EAPI char *elm_entry_utf8_to_markup(const char *s); /* pre-made filters for entries */ /** - * @typedef Elm_Entry_Filter_Limit_Size - * * Data for the elm_entry_filter_limit_size() entry filter. + * + * @ingroup Entry */ typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size; /** - * @struct _Elm_Entry_Filter_Limit_Size - * * Data for the elm_entry_filter_limit_size() entry filter. + * + * @ingroup Entry */ struct _Elm_Entry_Filter_Limit_Size { @@ -326,16 +332,16 @@ struct _Elm_Entry_Filter_Limit_Size EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text); /** - * @typedef Elm_Entry_Filter_Accept_Set - * * Data for the elm_entry_filter_accept_set() entry filter. + * + * @ingroup Entry */ typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set; /** - * @struct _Elm_Entry_Filter_Accept_Set - * * Data for the elm_entry_filter_accept_set() entry filter. + * + * @ingroup Entry */ struct _Elm_Entry_Filter_Accept_Set { @@ -367,11 +373,12 @@ struct _Elm_Entry_Filter_Accept_Set EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text); /** - * @typedef Elm_Cnp_Mode * Enum of entry's copy & paste policy. * * @see elm_entry_cnp_mode_set() * @see elm_entry_cnp_mode_get() + * + * @ingroup Entry */ typedef enum { ELM_CNP_MODE_MARKUP, /**< copy & paste text with markup tag */ @@ -380,22 +387,19 @@ typedef enum { } Elm_Cnp_Mode; /** - * Get the text of the contextual menu item. - * * Get the text of the contextual menu item of entry. * * @param item The item to get the label * @return The text of contextual menu item * * @see elm_entry_context_menu_item_add() - * @ingroup Entry * @since 1.8 + * + * @ingroup Entry */ EAPI const char *elm_entry_context_menu_item_label_get(const Elm_Entry_Context_Menu_Item *item); /** - * Get the icon object of the contextual menu item. - * * Get the icon object packed in the contextual menu item of entry. * * @param item The item to get the icon from @@ -406,8 +410,9 @@ EAPI const char *elm_entry_context_menu_item_label_get(const El * @param icon_type The icon type * * @see elm_entry_context_menu_item_add() - * @ingroup Entry * @since 1.8 + * + * @ingroup Entry */ EAPI void elm_entry_context_menu_item_icon_get(const Elm_Entry_Context_Menu_Item *item, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type); |