Entry

Data Structures | Typedefs | Enumerations | Functions
Entry

## Data Structures
struct | _Elm_Entry_Anchor_Info
| The info sent in the callback for the "anchor,clicked" signals emitted by entries. More...
struct | _Elm_Entry_Anchor_Hover_Info
| The info sent in the callback for "anchor,clicked" signals emitted by the Anchor_Hover widget. More...
struct | _Elm_Entry_Filter_Limit_Size
| Data for the elm_entry_filter_limit_size() entry filter. More...
struct | _Elm_Entry_Filter_Accept_Set
| Data for the elm_entry_filter_accept_set() entry filter. More...

## Typedefs
typedef struct _Elm_Entry_Anchor_Info | Elm_Entry_Anchor_Info
| The info sent in the callback for the "anchor,clicked" signals emitted by entries.
typedef struct _Elm_Entry_Anchor_Hover_Info | Elm_Entry_Anchor_Hover_Info
| The info sent in the callback for "anchor,clicked" signals emitted by the Anchor_Hover widget.
typedef struct _Elm_Entry_Context_Menu_Item | Elm_Entry_Context_Menu_Item
| Type of contextual item that can be added in to long press menu. More...
typedef Evas_Object *(* | Elm_Entry_Item_Provider_Cb) (void *data, Evas_Object *entry, const char *item)
| This callback type is used to provide items. More...
typedef void(* | Elm_Entry_Filter_Cb) (void *data, Evas_Object *entry, char **text)
| This callback type is used by entry filters to modify text. More...
typedef Edje_Entry_Change_Info | Elm_Entry_Change_Info
| This corresponds to Edje_Entry_Change_Info. More...
typedef struct _Elm_Entry_Filter_Limit_Size | Elm_Entry_Filter_Limit_Size
| Data for the elm_entry_filter_limit_size() entry filter.
typedef struct _Elm_Entry_Filter_Accept_Set | Elm_Entry_Filter_Accept_Set
| Data for the elm_entry_filter_accept_set() entry filter.

## Enumerations
enum | { ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_NORMAL, ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_FILENAME, ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_PERSON_NAME }
enum | { ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_NORMAL, ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED, ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_DECIMAL, ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED_AND_DECIMAL }
enum | { ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NORMAL, ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NUMBERONLY }
enum | Elm_Cnp_Mode { ELM_CNP_MODE_MARKUP, ELM_CNP_MODE_NO_IMAGE, ELM_CNP_MODE_PLAINTEXT }
| Enum of entry's copy & paste policy. More...

## Functions
Eina_Bool | elm_config_context_menu_disabled_get (void)
| Get enable status of context menu disabled. More...
void | elm_config_context_menu_disabled_set (Eina_Bool disabled)
| Enable or disable the context menu in entries. More...
EINA_DEPRECATED void | elm_entry_scrollbar_policy_set (Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v)
| This sets the entry's scrollbar policy (i.e. More...
EINA_DEPRECATED void | elm_entry_bounce_set (Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce)
| This enables/disables bouncing within the entry. More...
EINA_DEPRECATED void | elm_entry_bounce_get (const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce)
| Get the bounce mode. More...
EOAPI void | elm_obj_entry_scrollable_set (Eina_Bool scroll)
| Enable or disable scrolling in entry. More...
EOAPI Eina_Bool | elm_obj_entry_scrollable_get (void)
| Get the scrollable state of the entry. More...
EOAPI void | elm_obj_entry_input_panel_show_on_demand_set (Eina_Bool ondemand)
| Set the attribute to show the input panel in case of only an user's explicit Mouse Up event. More...
EOAPI Eina_Bool | elm_obj_entry_input_panel_show_on_demand_get (void)
| Get the attribute to show the input panel in case of only an user's explicit Mouse Up event. More...
EOAPI void | elm_obj_entry_context_menu_disabled_set (Eina_Bool disabled)
| This disables the entry's contextual (longpress) menu. More...
EOAPI Eina_Bool | elm_obj_entry_context_menu_disabled_get (void)
| This returns whether the entry's contextual (longpress) menu is disabled. More...
EOAPI void | elm_obj_entry_cnp_mode_set (Elm_Cnp_Mode cnp_mode)
| Control pasting of text and images for the widget. More...
EOAPI Elm_Cnp_Mode | elm_obj_entry_cnp_mode_get (void)
| Getting elm_entry text paste/drop mode. More...
EOAPI void | elm_obj_entry_file_text_format_set (Elm_Text_Format format)
| Text format used to load and save the file, which could be plain text or markup text. More...
EOAPI void | elm_obj_entry_input_panel_language_set (Elm_Input_Panel_Lang lang)
| Set the language mode of the input panel. More...
EOAPI Elm_Input_Panel_Lang | elm_obj_entry_input_panel_language_get (void)
| Get the language mode of the input panel. More...
EOAPI void | elm_obj_entry_selection_handler_disabled_set (Eina_Bool disabled)
| This disabled the entry's selection handlers. More...
EOAPI Eina_Bool | elm_obj_entry_selection_handler_disabled_get (void)
| This returns whether the entry's selection handlers are disabled. More...
EOAPI void | elm_obj_entry_input_panel_layout_variation_set (int variation)
| Set the input panel layout variation of the entry. More...
EOAPI int | elm_obj_entry_input_panel_layout_variation_get (void)
| Get the input panel layout variation of the entry. More...
EOAPI void | elm_obj_entry_autocapital_type_set (Elm_Autocapital_Type autocapital_type)
| Set the autocapitalization type on the immodule. More...
EOAPI Elm_Autocapital_Type | elm_obj_entry_autocapital_type_get (void)
| Get the autocapitalization type on the immodule. More...
EOAPI void | elm_obj_entry_editable_set (Eina_Bool editable)
| Sets if the entry is to be editable or not. More...
EOAPI Eina_Bool | elm_obj_entry_editable_get (void)
| Get whether the entry is editable or not. More...
EOAPI void | elm_obj_entry_anchor_hover_style_set (const char *style)
| Set the style that the hover should use. More...
EOAPI const char * | elm_obj_entry_anchor_hover_style_get (void)
| Get the style that the hover should use. More...
EOAPI void | elm_obj_entry_single_line_set (Eina_Bool single_line)
| Sets the entry to single line mode. More...
EOAPI Eina_Bool | elm_obj_entry_single_line_get (void)
| Get whether the entry is set to be single line. More...
EOAPI void | elm_obj_entry_password_set (Eina_Bool password)
| Sets the entry to password mode. More...
EOAPI Eina_Bool | elm_obj_entry_password_get (void)
| Get whether the entry is set to password mode. More...
EOAPI void | elm_obj_entry_input_panel_return_key_disabled_set (Eina_Bool disabled)
| Set the return key on the input panel to be disabled. More...
EOAPI Eina_Bool | elm_obj_entry_input_panel_return_key_disabled_get (void)
| Get whether the return key on the input panel should be disabled or not. More...
EOAPI void | elm_obj_entry_autosave_set (Eina_Bool auto_save)
| This sets the entry object to 'autosave' the loaded text file or not. More...
EOAPI Eina_Bool | elm_obj_entry_autosave_get (void)
| This gets the entry object's 'autosave' status. More...
EOAPI void | elm_obj_entry_anchor_hover_parent_set (Evas_Object *parent)
| Set the parent of the hover popup. More...
EOAPI Evas_Object * | elm_obj_entry_anchor_hover_parent_get (void)
| Get the parent of the hover popup. More...
EOAPI void | elm_obj_entry_prediction_allow_set (Eina_Bool prediction)
| Set whether the entry should allow to use the text prediction. More...
EOAPI Eina_Bool | elm_obj_entry_prediction_allow_get (void)
| Get whether the entry should allow to use the text prediction. More...
EOAPI void | elm_obj_entry_input_hint_set (Elm_Input_Hints hints)
| Sets the input hint which allows input methods to fine-tune their behavior. More...
EOAPI Elm_Input_Hints | elm_obj_entry_input_hint_get (void)
| Gets the value of input hint. More...
EOAPI void | elm_obj_entry_input_panel_layout_set (Elm_Input_Panel_Layout layout)
| Set the input panel layout of the entry. More...
EOAPI Elm_Input_Panel_Layout | elm_obj_entry_input_panel_layout_get (void)
| Get the input panel layout of the entry. More...
EOAPI void | elm_obj_entry_input_panel_return_key_type_set (Elm_Input_Panel_Return_Key_Type return_key_type)
| Set the "return" key type. More...
EOAPI Elm_Input_Panel_Return_Key_Type | elm_obj_entry_input_panel_return_key_type_get (void)
| Get the "return" key type. More...
EOAPI void | elm_obj_entry_input_panel_enabled_set (Eina_Bool enabled)
| Sets the attribute to show the input panel automatically. More...
EOAPI Eina_Bool | elm_obj_entry_input_panel_enabled_get (void)
| Get the attribute to show the input panel automatically. More...
EOAPI void | elm_obj_entry_line_wrap_set (Elm_Wrap_Type wrap)
| Set the line wrap type to use on multi-line entries. More...
EOAPI Elm_Wrap_Type | elm_obj_entry_line_wrap_get (void)
| Get the wrap mode the entry was set to use. More...
EOAPI void | elm_obj_entry_cursor_pos_set (int pos)
| Sets the cursor position in the entry to the given value. More...
EOAPI int | elm_obj_entry_cursor_pos_get (void)
| Get the current position of the cursor in the entry. More...
EOAPI void | elm_obj_entry_icon_visible_set (Eina_Bool setting)
| Sets the visibility of the left-side widget of the entry, set by elm_object_part_content_set. More...
EOAPI void | elm_obj_entry_cursor_line_end_set (void)
| This moves the cursor to the end of the current line.
EOAPI void | elm_obj_entry_select_region_set (int start, int end)
| This selects a region of text within the entry. More...
EOAPI void | elm_obj_entry_input_panel_return_key_autoenabled_set (Eina_Bool enabled)
| Set whether the return key on the input panel is disabled automatically when entry has no text. More...
EOAPI void | elm_obj_entry_end_visible_set (Eina_Bool setting)
| Sets the visibility of the end widget of the entry, set by elm_object_part_content_set(ent, "end", content). More...
EOAPI void | elm_obj_entry_cursor_begin_set (void)
| This moves the cursor to the beginning of the entry.
EOAPI void | elm_obj_entry_cursor_line_begin_set (void)
| This moves the cursor to the beginning of the current line.
EOAPI void | elm_obj_entry_cursor_end_set (void)
| This moves the cursor to the end of the entry.
EOAPI Evas_Object * | elm_obj_entry_textblock_get (void)
| Returns the actual textblock object of the entry. More...
EOAPI Eina_Bool | elm_obj_entry_cursor_geometry_get (Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
| This function returns the geometry of the cursor. More...
EOAPI void * | elm_obj_entry_imf_context_get (void)
| Returns the input method context of the entry. More...
EOAPI Eina_Bool | elm_obj_entry_cursor_is_format_get (void)
| Get whether a format node exists at the current cursor position. More...
EOAPI char * | elm_obj_entry_cursor_content_get (void)
| Get the character pointed by the cursor at its current position. More...
EOAPI const char * | elm_obj_entry_selection_get (void)
| Get any selected text within the entry. More...
EOAPI Eina_Bool | elm_obj_entry_cursor_is_visible_format_get (void)
| Get if the current cursor position holds a visible format node.
EOAPI Eina_Bool | elm_obj_entry_cursor_prev (void)
| This moves the cursor one place to the left within the entry.
EOAPI void | elm_obj_entry_text_style_user_pop (void)
| Remove the style in the top of user style stack. More...
EOAPI void | elm_obj_entry_item_provider_prepend (Elm_Entry_Item_Provider_Cb func, void *data)
| This prepends a custom item provider to the list for that entry. More...
EOAPI void | elm_obj_entry_input_panel_show (void)
| Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on. More...
EOAPI void | elm_obj_entry_imf_context_reset (void)
| Reset the input method context of the entry if needed. More...
EOAPI void | elm_obj_entry_calc_force (void)
| Forces calculation of the entry size and text layouting. More...
EOAPI void | elm_obj_entry_anchor_hover_end (void)
| Ends the hover popup in the entry. More...
EOAPI void | elm_obj_entry_cursor_selection_begin (void)
| This begins a selection within the entry as though the user were holding down the mouse button to make a selection.
EOAPI Eina_Bool | elm_obj_entry_cursor_down (void)
| This moves the cursor one line down within the entry.
EOAPI void | elm_obj_entry_file_save (void)
| This function writes any changes made to the file set with elm_entry_file_set.
EOAPI void | elm_obj_entry_selection_copy (void)
| This executes a "copy" action on the selected text in the entry.
EOAPI void | elm_obj_entry_text_style_user_push (const char *style)
| Push the style to the top of user style stack. More...
EOAPI void | elm_obj_entry_item_provider_remove (Elm_Entry_Item_Provider_Cb func, void *data)
| This removes a custom item provider to the list for that entry. More...
EOAPI const char * | elm_obj_entry_text_style_user_peek (void)
| Get the style on the top of user style stack. More...
EOAPI void | elm_obj_entry_context_menu_clear (void)
| This clears and frees the items in a entry's contextual (longpress) menu. More...
EOAPI Eina_Bool | elm_obj_entry_cursor_up (void)
| This moves the cursor one line up within the entry.
EOAPI void | elm_obj_entry_insert (const char *entry)
| Inserts the given text into the entry at the current cursor position. More...
EOAPI void | elm_obj_entry_input_panel_imdata_set (const void *data, int len)
| Set the input panel-specific data to deliver to the input panel. More...
EOAPI void | elm_obj_entry_input_panel_imdata_get (void *data, int *len)
| Get the specific data of the current input panel. More...
EOAPI void | elm_obj_entry_selection_paste (void)
| This executes a "paste" action in the entry.
EOAPI Eina_Bool | elm_obj_entry_cursor_next (void)
| This moves the cursor one place to the right within the entry.
EOAPI void | elm_obj_entry_select_none (void)
| This drops any existing text selection within the entry.
EOAPI void | elm_obj_entry_input_panel_hide (void)
| Hide the input panel (virtual keyboard). More...
EOAPI void | elm_obj_entry_select_all (void)
| This selects all text within the entry.
EOAPI void | elm_obj_entry_cursor_selection_end (void)
| This ends a selection within the entry as though the user had just released the mouse button while making a selection.
EOAPI void | elm_obj_entry_selection_cut (void)
| This executes a "cut" action on the selected text in the entry.
EOAPI Eina_Bool | elm_obj_entry_is_empty (void)
| Get whether the entry is empty. More...
EOAPI void | elm_obj_entry_markup_filter_remove (Elm_Entry_Filter_Cb func, void *data)
| Remove a markup filter from the list. More...
EOAPI void | elm_obj_entry_item_provider_append (Elm_Entry_Item_Provider_Cb func, void *data)
| This appends a custom item provider to the list for that entry. More...
EOAPI void | elm_obj_entry_markup_filter_append (Elm_Entry_Filter_Cb func, void *data)
| Append a markup filter function for text inserted in the entry. More...
EOAPI void | elm_obj_entry_append (const char *str)
| Appends `str` to the text of the entry. More...
EOAPI void | elm_obj_entry_context_menu_item_add (const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data)
| This adds an item to the entry's contextual menu. More...
EOAPI void | elm_obj_entry_markup_filter_prepend (Elm_Entry_Filter_Cb func, void *data)
| Prepend a markup filter function for text inserted in the entry. More...
void | elm_entry_scrollable_set (Elm_Entry *obj, Eina_Bool scroll)
| Enable or disable scrolling in entry. More...
Eina_Bool | elm_entry_scrollable_get (const Elm_Entry *obj)
| Get the scrollable state of the entry. More...
void | elm_entry_input_panel_show_on_demand_set (Elm_Entry *obj, Eina_Bool ondemand)
| Set the attribute to show the input panel in case of only an user's explicit Mouse Up event. More...
Eina_Bool | elm_entry_input_panel_show_on_demand_get (const Elm_Entry *obj)
| Get the attribute to show the input panel in case of only an user's explicit Mouse Up event. More...
void | elm_entry_context_menu_disabled_set (Elm_Entry *obj, Eina_Bool disabled)
| This disables the entry's contextual (longpress) menu. More...
Eina_Bool | elm_entry_context_menu_disabled_get (const Elm_Entry *obj)
| This returns whether the entry's contextual (longpress) menu is disabled. More...
void | elm_entry_cnp_mode_set (Elm_Entry *obj, Elm_Cnp_Mode cnp_mode)
| Control pasting of text and images for the widget. More...
Elm_Cnp_Mode | elm_entry_cnp_mode_get (const Elm_Entry *obj)
| Getting elm_entry text paste/drop mode. More...
void | elm_entry_file_text_format_set (Elm_Entry *obj, Elm_Text_Format format)
| Text format used to load and save the file, which could be plain text or markup text. More...
void | elm_entry_input_panel_language_set (Elm_Entry *obj, Elm_Input_Panel_Lang lang)
| Set the language mode of the input panel. More...
Elm_Input_Panel_Lang | elm_entry_input_panel_language_get (const Elm_Entry *obj)
| Get the language mode of the input panel. More...
void | elm_entry_selection_handler_disabled_set (Elm_Entry *obj, Eina_Bool disabled)
| This disabled the entry's selection handlers. More...
void | elm_entry_input_panel_layout_variation_set (Elm_Entry *obj, int variation)
| Set the input panel layout variation of the entry. More...
int | elm_entry_input_panel_layout_variation_get (const Elm_Entry *obj)
| Get the input panel layout variation of the entry. More...
void | elm_entry_autocapital_type_set (Elm_Entry *obj, Elm_Autocapital_Type autocapital_type)
| Set the autocapitalization type on the immodule. More...
Elm_Autocapital_Type | elm_entry_autocapital_type_get (const Elm_Entry *obj)
| Get the autocapitalization type on the immodule. More...
void | elm_entry_editable_set (Elm_Entry *obj, Eina_Bool editable)
| Sets if the entry is to be editable or not. More...
Eina_Bool | elm_entry_editable_get (const Elm_Entry *obj)
| Get whether the entry is editable or not. More...
void | elm_entry_anchor_hover_style_set (Elm_Entry *obj, const char *style)
| Set the style that the hover should use. More...
const char * | elm_entry_anchor_hover_style_get (const Elm_Entry *obj)
| Get the style that the hover should use. More...
void | elm_entry_single_line_set (Elm_Entry *obj, Eina_Bool single_line)
| Sets the entry to single line mode. More...
Eina_Bool | elm_entry_single_line_get (const Elm_Entry *obj)
| Get whether the entry is set to be single line. More...
void | elm_entry_password_set (Elm_Entry *obj, Eina_Bool password)
| Sets the entry to password mode. More...
Eina_Bool | elm_entry_password_get (const Elm_Entry *obj)
| Get whether the entry is set to password mode. More...
void | elm_entry_input_panel_return_key_disabled_set (Elm_Entry *obj, Eina_Bool disabled)
| Set the return key on the input panel to be disabled. More...
Eina_Bool | elm_entry_input_panel_return_key_disabled_get (const Elm_Entry *obj)
| Get whether the return key on the input panel should be disabled or not. More...
void | elm_entry_autosave_set (Elm_Entry *obj, Eina_Bool auto_save)
| This sets the entry object to 'autosave' the loaded text file or not. More...
Eina_Bool | elm_entry_autosave_get (const Elm_Entry *obj)
| This gets the entry object's 'autosave' status. More...
void | elm_entry_anchor_hover_parent_set (Elm_Entry *obj, Evas_Object *parent)
| Set the parent of the hover popup. More...
Evas_Object * | elm_entry_anchor_hover_parent_get (const Elm_Entry *obj)
| Get the parent of the hover popup. More...
void | elm_entry_prediction_allow_set (Elm_Entry *obj, Eina_Bool prediction)
| Set whether the entry should allow to use the text prediction. More...
Eina_Bool | elm_entry_prediction_allow_get (const Elm_Entry *obj)
| Get whether the entry should allow to use the text prediction. More...
void | elm_entry_input_hint_set (Elm_Entry *obj, Elm_Input_Hints hints)
| Sets the input hint which allows input methods to fine-tune their behavior. More...
Elm_Input_Hints | elm_entry_input_hint_get (const Elm_Entry *obj)
| Gets the value of input hint. More...
void | elm_entry_input_panel_layout_set (Elm_Entry *obj, Elm_Input_Panel_Layout layout)
| Set the input panel layout of the entry. More...
Elm_Input_Panel_Layout | elm_entry_input_panel_layout_get (const Elm_Entry *obj)
| Get the input panel layout of the entry. More...
void | elm_entry_input_panel_return_key_type_set (Elm_Entry *obj, Elm_Input_Panel_Return_Key_Type return_key_type)
| Set the "return" key type. More...
Elm_Input_Panel_Return_Key_Type | elm_entry_input_panel_return_key_type_get (const Elm_Entry *obj)
| Get the "return" key type. More...
void | elm_entry_input_panel_enabled_set (Elm_Entry *obj, Eina_Bool enabled)
| Sets the attribute to show the input panel automatically. More...
Eina_Bool | elm_entry_input_panel_enabled_get (const Elm_Entry *obj)
| Get the attribute to show the input panel automatically. More...
void | elm_entry_line_wrap_set (Elm_Entry *obj, Elm_Wrap_Type wrap)
| Set the line wrap type to use on multi-line entries. More...
Elm_Wrap_Type | elm_entry_line_wrap_get (const Elm_Entry *obj)
| Get the wrap mode the entry was set to use. More...
void | elm_entry_cursor_pos_set (Elm_Entry *obj, int pos)
| Sets the cursor position in the entry to the given value. More...
int | elm_entry_cursor_pos_get (const Elm_Entry *obj)
| Get the current position of the cursor in the entry. More...
void | elm_entry_icon_visible_set (Elm_Entry *obj, Eina_Bool setting)
| Sets the visibility of the left-side widget of the entry, set by elm_object_part_content_set. More...
void | elm_entry_cursor_line_end_set (Elm_Entry *obj)
| This moves the cursor to the end of the current line.
void | elm_entry_select_region_set (Elm_Entry *obj, int start, int end)
| This selects a region of text within the entry. More...
void | elm_entry_input_panel_return_key_autoenabled_set (Elm_Entry *obj, Eina_Bool enabled)
| Set whether the return key on the input panel is disabled automatically when entry has no text. More...
void | elm_entry_end_visible_set (Elm_Entry *obj, Eina_Bool setting)
| Sets the visibility of the end widget of the entry, set by elm_object_part_content_set(ent, "end", content). More...
void | elm_entry_cursor_begin_set (Elm_Entry *obj)
| This moves the cursor to the beginning of the entry.
void | elm_entry_cursor_line_begin_set (Elm_Entry *obj)
| This moves the cursor to the beginning of the current line.
void | elm_entry_cursor_end_set (Elm_Entry *obj)
| This moves the cursor to the end of the entry.
Evas_Object * | elm_entry_textblock_get (const Elm_Entry *obj)
| Returns the actual textblock object of the entry. More...
Eina_Bool | elm_entry_cursor_geometry_get (const Elm_Entry *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
| This function returns the geometry of the cursor. More...
void * | elm_entry_imf_context_get (const Elm_Entry *obj)
| Returns the input method context of the entry. More...
Eina_Bool | elm_entry_cursor_is_format_get (const Elm_Entry *obj)
| Get whether a format node exists at the current cursor position. More...
char * | elm_entry_cursor_content_get (const Elm_Entry *obj)
| Get the character pointed by the cursor at its current position. More...
const char * | elm_entry_selection_get (const Elm_Entry *obj)
| Get any selected text within the entry. More...
Eina_Bool | elm_entry_cursor_is_visible_format_get (const Elm_Entry *obj)
| Get if the current cursor position holds a visible format node.
Eina_Bool | elm_entry_cursor_prev (Elm_Entry *obj)
| This moves the cursor one place to the left within the entry.
void | elm_entry_text_style_user_pop (Elm_Entry *obj)
| Remove the style in the top of user style stack. More...
void | elm_entry_item_provider_prepend (Elm_Entry *obj, Elm_Entry_Item_Provider_Cb func, void *data)
| This prepends a custom item provider to the list for that entry. More...
void | elm_entry_input_panel_show (Elm_Entry *obj)
| Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on. More...
void | elm_entry_imf_context_reset (Elm_Entry *obj)
| Reset the input method context of the entry if needed. More...
void | elm_entry_calc_force (Elm_Entry *obj)
| Forces calculation of the entry size and text layouting. More...
void | elm_entry_anchor_hover_end (Elm_Entry *obj)
| Ends the hover popup in the entry. More...
void | elm_entry_cursor_selection_begin (Elm_Entry *obj)
| This begins a selection within the entry as though the user were holding down the mouse button to make a selection.
Eina_Bool | elm_entry_cursor_down (Elm_Entry *obj)
| This moves the cursor one line down within the entry.
void | elm_entry_file_save (Elm_Entry *obj)
| This function writes any changes made to the file set with elm_entry_file_set.
void | elm_entry_selection_copy (Elm_Entry *obj)
| This executes a "copy" action on the selected text in the entry.
void | elm_entry_text_style_user_push (Elm_Entry *obj, const char *style)
| Push the style to the top of user style stack. More...
void | elm_entry_item_provider_remove (Elm_Entry *obj, Elm_Entry_Item_Provider_Cb func, void *data)
| This removes a custom item provider to the list for that entry. More...
const char * | elm_entry_text_style_user_peek (const Elm_Entry *obj)
| Get the style on the top of user style stack. More...
void | elm_entry_context_menu_clear (Elm_Entry *obj)
| This clears and frees the items in a entry's contextual (longpress) menu. More...
Eina_Bool | elm_entry_cursor_up (Elm_Entry *obj)
| This moves the cursor one line up within the entry.
void | elm_entry_entry_insert (Elm_Entry *obj, const char *entry)
| Inserts the given text into the entry at the current cursor position. More...
void | elm_entry_input_panel_imdata_set (Elm_Entry *obj, const void *data, int len)
| Set the input panel-specific data to deliver to the input panel. More...
void | elm_entry_input_panel_imdata_get (const Elm_Entry *obj, void *data, int *len)
| Get the specific data of the current input panel. More...
void | elm_entry_selection_paste (Elm_Entry *obj)
| This executes a "paste" action in the entry.
Eina_Bool | elm_entry_cursor_next (Elm_Entry *obj)
| This moves the cursor one place to the right within the entry.
void | elm_entry_select_none (Elm_Entry *obj)
| This drops any existing text selection within the entry.
void | elm_entry_input_panel_hide (Elm_Entry *obj)
| Hide the input panel (virtual keyboard). More...
void | elm_entry_select_all (Elm_Entry *obj)
| This selects all text within the entry.
void | elm_entry_cursor_selection_end (Elm_Entry *obj)
| This ends a selection within the entry as though the user had just released the mouse button while making a selection.
void | elm_entry_selection_cut (Elm_Entry *obj)
| This executes a "cut" action on the selected text in the entry.
Eina_Bool | elm_entry_is_empty (const Elm_Entry *obj)
| Get whether the entry is empty. More...
void | elm_entry_markup_filter_remove (Elm_Entry *obj, Elm_Entry_Filter_Cb func, void *data)
| Remove a markup filter from the list. More...
void | elm_entry_item_provider_append (Elm_Entry *obj, Elm_Entry_Item_Provider_Cb func, void *data)
| This appends a custom item provider to the list for that entry. More...
void | elm_entry_markup_filter_append (Elm_Entry *obj, Elm_Entry_Filter_Cb func, void *data)
| Append a markup filter function for text inserted in the entry. More...
void | elm_entry_entry_append (Elm_Entry *obj, const char *str)
| Appends `str` to the text of the entry. More...
void | elm_entry_context_menu_item_add (Elm_Entry *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data)
| This adds an item to the entry's contextual menu. More...
void | elm_entry_markup_filter_prepend (Elm_Entry *obj, Elm_Entry_Filter_Cb func, void *data)
| Prepend a markup filter function for text inserted in the entry. More...
char * | elm_entry_markup_to_utf8 (const char *s)
| This converts a markup (HTML-like) string into UTF-8. More...
char * | elm_entry_utf8_to_markup (const char *s)
| This converts a UTF-8 string into markup (HTML-like). More...
void | elm_entry_filter_limit_size (void *data, Evas_Object *entry, char **text)
| Filter inserted text based on user defined character and byte limits. More...
void | elm_entry_filter_accept_set (void *data, Evas_Object *entry, char **text)
| Filter inserted text based on accepted or rejected sets of characters. More...
const char * | elm_entry_context_menu_item_label_get (const Elm_Entry_Context_Menu_Item *item)
| Get the text of the contextual menu item of entry. More...
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)
| Get the icon object packed in the contextual menu item of entry. More...
Evas_Object * | elm_entry_add (Evas_Object *parent)
| This adds an entry to `parent` object. More...
void | elm_entry_entry_set (Evas_Object *obj, const char *entry)
| This sets the text displayed within the entry to `entry`. More...
const char * | elm_entry_entry_get (const Evas_Object *obj)
| This returns the text currently shown in object `entry`. More...
Eina_Bool | elm_entry_file_set (Evas_Object *obj, const char *file, Elm_Text_Format format)
| This sets the file (and implicitly loads it) for the text to display and then edit. More...
void | elm_entry_file_get (const Evas_Object *obj, const char **file, Elm_Text_Format *format)
| Get the file being edited by the entry. More...

## Detailed Description

An entry is a convenience widget which shows a box that the user can enter text into. Entries by default don't scroll, so they grow to accommodate the entire text, resizing the parent window as needed. This can be changed with the elm_entry_scrollable_set() function.

They can also be single line or multi line (the default) and when set to multi line mode they support text wrapping in any of the modes indicated by #Elm_Wrap_Type.

Other features include password mode, filtering of inserted text with elm_entry_markup_filter_append() and related functions, inline "items" and formatted markup text.

This widget inherits from the Layout one, so that all the functions acting on it also work for entry objects (since 1.8).

This widget implements the elm-scrollable-interface interface, so that all (non-deprecated) functions for the base Scroller widget also work for entries (since 1.8).

Some calls on the entry's API are marked as deprecated, as they just wrap the scrollable widgets counterpart functions. Use the ones we point you to, for each case of deprecation here, instead – eventually the deprecated ones will be discarded (next major release).

# Formatted text

The markup tags supported by the Entry are defined by the theme, but even when writing new themes or extensions it's a good idea to stick to a sane default, to maintain coherency and avoid application breakages. Currently defined by the default theme are the following tags:

- <br>: Inserts a line break.
- <ps>: Inserts a paragraph separator. This is preferred over line breaks.
- <tab>: Inserts a tab.
- <em>...</em>: Emphasis. Sets the oblique style for the enclosed text.
- <b>...</b>: Sets the bold style for the enclosed text.
- <link>...</link>: Underlines the enclosed text.
- <hilight>...</hilight>: Highlights the enclosed text.
- <title>...</title>: Main title.
- <subtitle>...</subtitle>: Secondary level title.
- <bigger>...</bigger>: A really big text, not so big as the titles.
- <big>...</big>: Big text.
- <small>...</small>: Small text.
- <smaller>...</smaller>: Really small text, at the point of unreadability.

Entry also support tags for code syntax highlight. Note that this does not mean that the entry will automatically perform code highlight, application are responsable of applying the correct tag to code blocks. The default theme define the following tags:

- <code>...</code>: Monospace font without shadows.
- <comment>...</comment>: Code comments.
- <string>...</string>: Strings of text.
- <number>...</number>: Numeric expression (ex: 1, 2, 0.34, etc)
- <brace>...</brace>: Braces used for code syntax.
- <type>...</type>: Variables types (ex: int, float, char, Evas_Object, etc)
- <class>...</class>: Class names, when defined, not when used.
- <function>...</function>: Function names, when defined, not called.
- <param>...</param>: Generic parameters.
- <keyword>...</keyword>: Language keywords (ex: return, NULL, while, for, etc)
- <preprocessor>...</preprocessor>: Preprocessors definitions.
- <line_added>...</line_added>: Diff addeded lines.
- <line_removed>...</line_removed>: Diff removed lines.
- <line_changed>...</line_changed>: Diff changed lines.

# Special markups

Besides those used to format text, entries support two special markup tags used to insert click-able portions of text or items inlined within the text.

## Anchors

Anchors are similar to HTML anchors. Text can be surrounded by <a> and </a> tags and an event will be generated when this text is clicked, like this:

This text is outside <a href=anc-01>but this one is an anchor</a>

The `href` attribute in the opening tag gives the name that will be used to identify the anchor and it can be any valid utf8 string.

When an anchor is clicked, an `"anchor,clicked"` signal is emitted with an Elm_Entry_Anchor_Info in the `event_info` parameter for the callback function. The same applies for "anchor,in" (mouse in), "anchor,out" (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on an anchor.

## Items

Inlined in the text, any other `Evas_Object` can be inserted by using <item> tags this way:

<item size=16x16 vsize=full href=emoticon/haha></item>

Just like with anchors, the `href` identifies each item, but these need, in addition, to indicate their size, which is done using any one of `size`, `absize` or `relsize` attributes. These attributes take their value in the WxH format, where W is the width and H the height of the item.

- absize: Absolute pixel size for the item. Whatever value is set will be the item's size regardless of any scale value the object may have been set to. The final line height will be adjusted to fit larger items.
- size: Similar to `absize`, but it's adjusted to the scale value set for the object.
- relsize: Size is adjusted for the item to fit within the current line height.

Besides their size, items are specified a `vsize` value that affects how their final size and position are calculated. The possible values are:

- ascent: Item will be placed within the line's baseline and its ascent. That is, the height between the line where all characters are positioned and the highest point in the line. For `size` and `absize` items, the descent value will be added to the total line height to make them fit. `relsize` items will be adjusted to fit within this space.
- full: Items will be placed between the descent and ascent, or the lowest point in the line and its highest.

The next image shows different configurations of items and how the previously mentioned options affect their sizes. In all cases, the green line indicates the ascent, blue for the baseline and red for the descent.

And another one to show how size differs from absize. In the first one, the scale value is set to 1.0, while the second one is using one of 2.0.

After the size for an item is calculated, the entry will request an object to place in its space. For this, the functions set with elm_entry_item_provider_append() and related functions will be called in order until one of them returns a `non-NULL` value. If no providers are available, or all of them return `NULL`, then the entry falls back to one of the internal defaults, provided the name matches with one of them.

All of the following are currently supported:

- emoticon/angry
- emoticon/angry-shout
- emoticon/crazy-laugh
- emoticon/evil-laugh
- emoticon/evil
- emoticon/goggle-smile
- emoticon/grumpy
- emoticon/grumpy-smile
- emoticon/guilty
- emoticon/guilty-smile
- emoticon/haha
- emoticon/half-smile
- emoticon/happy-panting
- emoticon/happy
- emoticon/indifferent
- emoticon/kiss
- emoticon/knowing-grin
- emoticon/laugh
- emoticon/little-bit-sorry
- emoticon/love-lots
- emoticon/love
- emoticon/minimal-smile
- emoticon/not-happy
- emoticon/not-impressed
- emoticon/omg
- emoticon/opensmile
- emoticon/smile
- emoticon/sorry
- emoticon/squint-laugh
- emoticon/surprised
- emoticon/suspicious
- emoticon/tongue-dangling
- emoticon/tongue-poke
- emoticon/uh
- emoticon/unhappy
- emoticon/very-sorry
- emoticon/what
- emoticon/wink
- emoticon/worried
- emoticon/wtf

Alternatively, an item may reference an image by its path, using the URI form `file:///path/to/an/image.png` and the entry will then use that image for the item.

# Setting entry's style

There are 2 major ways to change the entry's style:

- Theme - set the "base" field to the desired style.
- User style - Pushing overrides to the theme style to the textblock object by using evas_object_textblock_style_user_push().

You should modify the theme when you would like to change the style for aesthetic reasons. While the user style should be changed when you would like to change the style to something specific defined at run-time, e.g, setting font or font size in a text editor.

# Loading and saving files

Entries have convenience functions to load text from a file and save changes back to it after a short delay. The automatic saving is enabled by default, but can be disabled with elm_entry_autosave_set() and files can be loaded directly as plain text or have any markup in them recognized. See elm_entry_file_set() for more details.

# Emitted signals

This widget emits the following signals, besides the ones sent from Layout:

- "aborted": The escape key was pressed on a single line entry. (since 1.7)
- "activated": The enter key was pressed on a single line entry.
- "anchor,clicked": An anchor has been clicked. The event_info parameter for the callback will be an Elm_Entry_Anchor_Info.
- "anchor,down": Mouse button has been pressed on an anchor. The event_info parameter for the callback will be an Elm_Entry_Anchor_Info.
- "anchor,hover,opened": The anchor is clicked.
- "anchor,in": Mouse cursor has moved into an anchor. The event_info parameter for the callback will be an Elm_Entry_Anchor_Info.
- "anchor,out": Mouse cursor has moved out of an anchor. The event_info parameter for the callback will be an Elm_Entry_Anchor_Info.
- "anchor,up": Mouse button has been unpressed on an anchor. The event_info parameter for the callback will be an Elm_Entry_Anchor_Info.
- "changed": The text within the entry was changed.
- "changed,user": The text within the entry was changed because of user interaction.
- "clicked": The entry has been clicked (mouse press and release).
- "clicked,double": The entry has been double clicked.
- "clicked,triple": The entry has been triple clicked.
- "cursor,changed": The cursor has changed position.
- "cursor,changed,manual": The cursor has changed position manually.
- "focused": The entry has received focus.
- "unfocused": The entry has lost focus.
- "language,changed": Program language changed.
- "longpressed": A mouse button has been pressed and held for a couple
- "maxlength,reached": Called when a maximum length is reached.
- "preedit,changed": The preedit string has changed.
- "press": A mouse button has been pressed on the entry. seconds.
- "redo,request": Called on redo request.
- "selection,changed": The current selection has changed.
- "selection,cleared": The current selection has been cleared.
- "selection,copy": A copy of the selected text into the clipboard was requested.
- "selection,cut": A cut of the selected text into the clipboard was requested.
- "selection,paste": A paste of the clipboard contents was requested.
- "selection,start": A selection has begun and no previous selection existed.
- "text,set,done": Whole text has been set to the entry.
- "theme,changed": Called when the theme is changed.
- "undo,request": Called on undo request.
- "rejected": Called when some of inputs are rejected by the filter. (since 1.9)
- "validate": Called when entry text ready to validate. (since 1.14)

Default content parts of the entry items that you can use for are:

- "icon" - An icon in the entry
- "end" - A content in the end of the entry

Default text parts of the entry that you can use for are:

- "default" - A text of the entry
- "guide" - A placeholder of the entry

Supported elm_object common APIs.

- elm_object_signal_emit
- elm_object_part_text_set
- elm_object_part_text_get
- elm_object_part_content_set
- elm_object_part_content_get
- elm_object_part_content_unset
- elm_object_signal_callback_add
- elm_object_signal_callback_del
- elm_object_disabled_set
- elm_object_disabled_get

# entry-examples

An overview of the Entry API can be seen in Entry - Example of simple editing

## Typedef Documentation

## ◆ Elm_Entry_Change_Info

typedef Edje_Entry_Change_Info Elm_Entry_Change_Info

This corresponds to Edje_Entry_Change_Info.

Includes information about a change in the entry.

## ◆ Elm_Entry_Context_Menu_Item

typedef struct _Elm_Entry_Context_Menu_Item Elm_Entry_Context_Menu_Item

Type of contextual item that can be added in to long press menu.

Since
  1.8

## ◆ Elm_Entry_Filter_Cb

typedef void(* Elm_Entry_Filter_Cb) (void *data, Evas_Object *entry, char **text)

This callback type is used by entry filters to modify text.

Parameters

  data | The data specified as the last param when adding the filter
  entry | The entry object
  text | A pointer to the location of the text being filtered. The type of text is always markup. This data can be modified, but any additional allocations must be managed by the user.

See also
  elm_entry_markup_filter_append
  elm_entry_markup_filter_prepend
  elm_entry_markup_filter_remove

## ◆ Elm_Entry_Item_Provider_Cb

typedef Evas_Object*(* Elm_Entry_Item_Provider_Cb) (void *data, Evas_Object *entry, const char *item)

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. If not the next provider is called until one provides an item object, or the default provider in entry does.

Parameters

  data | The data specified as the last param when adding the provider
  entry | The entry object
  text | A pointer to the item href string in the text

Returns
  The object to be placed in the entry like an icon, or other element

See also
  elm_entry_item_provider_append
  elm_entry_item_provider_prepend
  elm_entry_item_provider_remove

## Enumeration Type Documentation

## ◆ anonymous enum

anonymous enum

Enumerator
ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_NORMAL | The plain normal layout. Since 1.12
ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_FILENAME | Filename layout. Symbols such as '/' should be disabled. Since 1.12
ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_PERSON_NAME | The name of a person. Since 1.12

## ◆ anonymous enum

anonymous enum

Enumerator
ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_NORMAL | The plain normal number layout. Since 1.8
ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED | The number layout to allow a positive or negative sign at the start. Since 1.8
ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_DECIMAL | The number layout to allow decimal point to provide fractional value. Since 1.8
ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED_AND_DECIMAL | The number layout to allow decimal point and negative sign. Since 1.8

## ◆ anonymous enum

anonymous enum

Enumerator
ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NORMAL | The normal password layout. Since 1.12
ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NUMBERONLY | The password layout to allow only number. Since 1.12

## ◆ Elm_Cnp_Mode

enum Elm_Cnp_Mode

Enum of entry's copy & paste policy.

See also
  elm_entry_cnp_mode_set()
  elm_entry_cnp_mode_get()

Enumerator
ELM_CNP_MODE_MARKUP | copy & paste text with markup tag
ELM_CNP_MODE_NO_IMAGE | copy & paste text without item(image) tag
ELM_CNP_MODE_PLAINTEXT | copy & paste text without markup tag

## Function Documentation

## ◆ elm_config_context_menu_disabled_get()

Eina_Bool elm_config_context_menu_disabled_get | ( | void |  | ) |

Get enable status of context menu disabled.

See also
  elm_config_context_menu_disabled_set()

Since
  1.17

## ◆ elm_config_context_menu_disabled_set()

void elm_config_context_menu_disabled_set | ( | Eina_Bool | disabled | ) |

Enable or disable the context menu in entries.

Parameters

  disabled | disable context menu if `EINA_TRUE`, enable otherwise

See also
  elm_config_context_menu_disabled_get()

Since
  1.17

## ◆ elm_entry_add()

Evas_Object* elm_entry_add | ( | Evas_Object * | parent | ) |

This adds an entry to `parent` object.

By default, entries are:

- not scrolled
- multi-line
- word wrapped
- autosave is enabled

Parameters

  parent | The parent object

Returns
  The new object or NULL if it cannot be created

References ELM_CNP_MODE_MARKUP, ELM_CNP_MODE_NO_IMAGE, elm_drop_target_add(), elm_drop_target_del(), elm_entry_cnp_mode_get(), elm_entry_cnp_mode_set(), elm_entry_input_hint_set(), elm_entry_markup_filter_append(), elm_entry_markup_filter_remove(), elm_layout_sizing_eval(), and ELM_SCROLLER_POLICY_OFF.

## ◆ elm_entry_anchor_hover_end()

void elm_entry_anchor_hover_end | ( | Elm_Entry * | obj | ) |

Ends the hover popup in the entry.

When an anchor is clicked, the entry widget will create a hover object to use as a popup with user provided content. This function terminates this popup, returning the entry to its normal state.

References elm_obj_entry_anchor_hover_end().

## ◆ elm_entry_anchor_hover_parent_get()

Evas_Object* elm_entry_anchor_hover_parent_get | ( | const Elm_Entry * | obj | ) |

Get the parent of the hover popup.

Get the object used as parent for the hover created by the entry widget. If no parent is set, the same entry object will be used.

Returns
  The object to use as parent for the hover.

References elm_obj_entry_anchor_hover_parent_get().

## ◆ elm_entry_anchor_hover_parent_set()

void elm_entry_anchor_hover_parent_set | ( | Elm_Entry * | obj,
|  | Evas_Object * | parent
| ) |  |

Set the parent of the hover popup.

Sets the parent object to use by the hover created by the entry when an anchor is clicked.

Parameters

  [in] | parent | The object to use as parent for the hover.

References elm_obj_entry_anchor_hover_parent_set().

## ◆ elm_entry_anchor_hover_style_get()

const char* elm_entry_anchor_hover_style_get | ( | const Elm_Entry * | obj | ) |

Get the style that the hover should use.

Returns
  The style to use for the underlying hover.

References elm_obj_entry_anchor_hover_style_get().

## ◆ elm_entry_anchor_hover_style_set()

void elm_entry_anchor_hover_style_set | ( | Elm_Entry * | obj,
|  | const char * | style
| ) |  |

Set the style that the hover should use.

When creating the popup hover, entry will request that it's themed according to `style`.

Setting style no `null` means disabling automatic hover.

Parameters

  [in] | style | The style to use for the underlying hover.

References elm_obj_entry_anchor_hover_style_set().

## ◆ elm_entry_autocapital_type_get()

Elm_Autocapital_Type elm_entry_autocapital_type_get | ( | const Elm_Entry * | obj | ) |

Get the autocapitalization type on the immodule.

Returns
  The type of autocapitalization.

References elm_obj_entry_autocapital_type_get().

## ◆ elm_entry_autocapital_type_set()

void elm_entry_autocapital_type_set | ( | Elm_Entry * | obj,
|  | Elm_Autocapital_Type | autocapital_type
| ) |  |

Set the autocapitalization type on the immodule.

Parameters

  [in] | autocapital_type | The type of autocapitalization.

References elm_obj_entry_autocapital_type_set().

## ◆ elm_entry_autosave_get()

Eina_Bool elm_entry_autosave_get | ( | const Elm_Entry * | obj | ) |

This gets the entry object's 'autosave' status.

Returns
  Autosave the loaded file or not.

References elm_obj_entry_autosave_get().

## ◆ elm_entry_autosave_set()

void elm_entry_autosave_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | auto_save
| ) |  |

This sets the entry object to 'autosave' the loaded text file or not.

Parameters

  [in] | auto_save | Autosave the loaded file or not.

References elm_obj_entry_autosave_set().

## ◆ elm_entry_bounce_get()

EINA_DEPRECATED void elm_entry_bounce_get | ( | const Evas_Object * | obj,
|  | Eina_Bool * | h_bounce,
|  | Eina_Bool * | v_bounce
| ) |  |

Get the bounce mode.

Parameters

  obj | The Entry object
  h_bounce | Allow bounce horizontally
  v_bounce | Allow bounce vertically

Deprecated:
  Use elm_scroller_bounce_get() instead.

References elm_entry_input_hint_set().

## ◆ elm_entry_bounce_set()

EINA_DEPRECATED void elm_entry_bounce_set | ( | Evas_Object * | obj,
|  | Eina_Bool | h_bounce,
|  | Eina_Bool | v_bounce
| ) |  |

This enables/disables bouncing within the entry.

This function sets whether the entry will bounce when scrolling reaches the end of the contained entry.

Parameters

  obj | The entry object
  h_bounce | The horizontal bounce state
  v_bounce | The vertical bounce state

Deprecated:
  Use elm_scroller_bounce_set() instead.

## ◆ elm_entry_calc_force()

void elm_entry_calc_force | ( | Elm_Entry * | obj | ) |

Forces calculation of the entry size and text layouting.

This should be used after modifying the textblock object directly. See elm_entry_textblock_get for more information.

References elm_obj_entry_calc_force().

## ◆ elm_entry_cnp_mode_get()

Elm_Cnp_Mode elm_entry_cnp_mode_get | ( | const Elm_Entry * | obj | ) |

Getting elm_entry text paste/drop mode.

Normally the entry allows both text and images to be pasted. This gets the copy & paste mode of the entry.

Returns
  One of Elm_Cnp_Mode: ELM_CNP_MODE_MARKUP, ELM_CNP_MODE_NO_IMAGE, ELM_CNP_MODE_PLAINTEXT.

References elm_obj_entry_cnp_mode_get().

Referenced by elm_entry_add(), and elm_entry_file_get().

## ◆ elm_entry_cnp_mode_set()

void elm_entry_cnp_mode_set | ( | Elm_Entry * | obj,
|  | Elm_Cnp_Mode | cnp_mode
| ) |  |

Control pasting of text and images for the widget.

Normally the entry allows both text and images to be pasted. By setting cnp_mode to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past. By setting cnp_mode to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .

Note
  This only changes the behaviour of text.

Parameters

  [in] | cnp_mode | One of Elm_Cnp_Mode: ELM_CNP_MODE_MARKUP, ELM_CNP_MODE_NO_IMAGE, ELM_CNP_MODE_PLAINTEXT.

References elm_obj_entry_cnp_mode_set().

Referenced by elm_entry_add(), and elm_entry_file_get().

## ◆ elm_entry_context_menu_clear()

void elm_entry_context_menu_clear | ( | Elm_Entry * | obj | ) |

This clears and frees the items in a entry's contextual (longpress) menu.

See also elm_entry_context_menu_item_add.

References elm_obj_entry_context_menu_clear().

## ◆ elm_entry_context_menu_disabled_get()

Eina_Bool elm_entry_context_menu_disabled_get | ( | const Elm_Entry * | obj | ) |

This returns whether the entry's contextual (longpress) menu is disabled.

Returns
  If `true`, the menu is disabled.

References elm_obj_entry_context_menu_disabled_get().

## ◆ elm_entry_context_menu_disabled_set()

void elm_entry_context_menu_disabled_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | disabled
| ) |  |

This disables the entry's contextual (longpress) menu.

Parameters

  [in] | disabled | If `true`, the menu is disabled.

References elm_obj_entry_context_menu_disabled_set().

## ◆ elm_entry_context_menu_item_add()

void elm_entry_context_menu_item_add | ( | Elm_Entry * | obj,
|  | const char * | label,
|  | const char * | icon_file,
|  | Elm_Icon_Type | icon_type,
|  | Evas_Smart_Cb | func,
|  | const void * | data
| ) |  |

This adds an item to the entry's contextual menu.

A longpress on an entry will make the contextual menu show up, if this hasn't been disabled with elm_entry_context_menu_disabled_set. By default, this menu provides a few options like enabling selection mode, which is useful on embedded devices that need to be explicit about it, and when a selection exists it also shows the copy and cut actions.

With this function, developers can add other options to this menu to perform any action they deem necessary.

Parameters

  [in] | icon_file | The item's icon file.
  [in] | icon_type | The item's icon type.
  [in] | func | The callback to execute when the item is clicked.
  [in] | data | The data to associate with the item for related functions.

References elm_obj_entry_context_menu_item_add().

## ◆ elm_entry_context_menu_item_icon_get()

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
| ) |  |

Get the icon object packed in the contextual menu item of entry.

Parameters

  item | The item to get the icon from
  icon_file | The image file path on disk used for the icon or standard icon name
  icon_group | The edje group used if `icon_file` is an edje file. NULL if the icon is not an edje file
  icon_type | The icon type

See also
  elm_entry_context_menu_item_add()

Since
  1.8

## ◆ elm_entry_context_menu_item_label_get()

const char* elm_entry_context_menu_item_label_get | ( | const Elm_Entry_Context_Menu_Item * | item | ) |

Get the text of the contextual menu item of entry.

Parameters

  item | The item to get the label

Returns
  The text of contextual menu item

See also
  elm_entry_context_menu_item_add()

Since
  1.8

## ◆ elm_entry_cursor_content_get()

char* elm_entry_cursor_content_get | ( | const Elm_Entry * | obj | ) |

Get the character pointed by the cursor at its current position.

This function returns a string with the utf8 character stored at the current cursor position. Only the text is returned, any format that may exist will not be part of the return value. You must free the string when done with free.

References elm_obj_entry_cursor_content_get().

## ◆ elm_entry_cursor_geometry_get()

Eina_Bool elm_entry_cursor_geometry_get | ( | const Elm_Entry * | obj,
|  | Evas_Coord * | x,
|  | Evas_Coord * | y,
|  | Evas_Coord * | w,
|  | Evas_Coord * | h
| ) |  |

This function returns the geometry of the cursor.

It's useful if you want to draw something on the cursor (or where it is), or for example in the case of scrolled entry where you want to show the cursor.

Parameters

  [out] | x | returned geometry.
  [out] | y | returned geometry.
  [out] | w | returned geometry.
  [out] | h | returned geometry.

References elm_obj_entry_cursor_geometry_get().

## ◆ elm_entry_cursor_is_format_get()

Eina_Bool elm_entry_cursor_is_format_get | ( | const Elm_Entry * | obj | ) |

Get whether a format node exists at the current cursor position.

A format node is anything that defines how the text is rendered. It can be a visible format node, such as a line break or a paragraph separator, or an invisible one, such as bold begin or end tag. This function returns whether any format node exists at the current cursor position.

References elm_obj_entry_cursor_is_format_get().

## ◆ elm_entry_cursor_pos_get()

int elm_entry_cursor_pos_get | ( | const Elm_Entry * | obj | ) |

Get the current position of the cursor in the entry.

Returns
  The position of the cursor.

References elm_obj_entry_cursor_pos_get().

## ◆ elm_entry_cursor_pos_set()

void elm_entry_cursor_pos_set | ( | Elm_Entry * | obj,
|  | int | pos
| ) |  |

Sets the cursor position in the entry to the given value.

The value in `pos` is the index of the character position within the contents of the string as returned by elm_entry_cursor_pos_get.

Parameters

  [in] | pos | The position of the cursor.

References elm_obj_entry_cursor_pos_set().

## ◆ elm_entry_editable_get()

Eina_Bool elm_entry_editable_get | ( | const Elm_Entry * | obj | ) |

Get whether the entry is editable or not.

Returns
  If `true`, user input will be inserted in the entry, if not, the entry is read-only and no user input is allowed.

References elm_obj_entry_editable_get().

## ◆ elm_entry_editable_set()

void elm_entry_editable_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | editable
| ) |  |

Sets if the entry is to be editable or not.

By default, entries are editable and when focused, any text input by the user will be inserted at the current cursor position. But calling this function with `editable` as `false` will prevent the user from inputting text into the entry.

The only way to change the text of a non-editable entry is to use elm_object_text_set, elm_entry_entry_insert and other related functions.

Parameters

  [in] | editable | If `true`, user input will be inserted in the entry, if not, the entry is read-only and no user input is allowed.

References elm_obj_entry_editable_set().

## ◆ elm_entry_end_visible_set()

void elm_entry_end_visible_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | setting
| ) |  |

Sets the visibility of the end widget of the entry, set by elm_object_part_content_set(ent, "end", content).

Parameters

  [in] | setting | true if the object should be displayed, false if not.

References elm_obj_entry_end_visible_set().

## ◆ elm_entry_entry_append()

void elm_entry_entry_append | ( | Elm_Entry * | obj,
|  | const char * | str
| ) |  |

Appends `str` to the text of the entry.

Adds the text in `str` to the end of any text already present in the widget.

The appended text is subject to any filters set for the widget.

See also elm_entry_markup_filter_append.

Parameters

  [in] | str | The text to be appended.

References elm_obj_entry_append().

## ◆ elm_entry_entry_get()

const char* elm_entry_entry_get | ( | const Evas_Object * | obj | ) |

This returns the text currently shown in object `entry`.

See also elm_entry_entry_set().

Parameters

  obj | The entry object

Returns
  The currently displayed text or NULL on failure

References elm_drop_target_add(), elm_drop_target_del(), elm_layout_sizing_eval(), and elm_obj_layout_text_get().

## ◆ elm_entry_entry_insert()

void elm_entry_entry_insert | ( | Elm_Entry * | obj,
|  | const char * | entry
| ) |  |

Inserts the given text into the entry at the current cursor position.

This inserts text at the cursor position as if it was typed by the user (note that this also allows markup which a user can't just "type" as it would be converted to escaped text, so this call can be used to insert things like emoticon items or bold push/pop tags, other font and color change tags etc.)

If any selection exists, it will be replaced by the inserted text.

The inserted text is subject to any filters set for the widget.

See also elm_entry_markup_filter_append.

Parameters

  [in] | entry | The text to insert.

References elm_obj_entry_insert().

## ◆ elm_entry_entry_set()

void elm_entry_entry_set | ( | Evas_Object * | obj,
|  | const char * | entry
| ) |  |

This sets the text displayed within the entry to `entry`.

Parameters

  obj | The entry object
  entry | The text to be displayed

Note
  Using this function bypasses text filters

References elm_obj_layout_text_set().

## ◆ elm_entry_file_get()

void elm_entry_file_get | ( | const Evas_Object * | obj,
|  | const char ** | file,
|  | Elm_Text_Format * | format
| ) |  |

Get the file being edited by the entry.

This function can be used to retrieve any file set on the entry for edition, along with the format used to load and save it.

Parameters

  [out] | file | The path to the file to load and save
  [out] | format | The file format

References ELM_CNP_MODE_MARKUP, ELM_CNP_MODE_NO_IMAGE, ELM_CNP_MODE_PLAINTEXT, elm_drop_target_add(), elm_drop_target_del(), elm_entry_cnp_mode_get(), elm_entry_cnp_mode_set(), elm_layout_content_get(), elm_layout_signal_emit(), elm_layout_sizing_eval(), ELM_SCROLLER_POLICY_OFF, ELM_SEL_FORMAT_IMAGE, ELM_SEL_FORMAT_MARKUP, and ELM_SEL_FORMAT_TEXT.

## ◆ elm_entry_file_set()

Eina_Bool elm_entry_file_set | ( | Evas_Object * | obj,
|  | const char * | file,
|  | Elm_Text_Format | format
| ) |  |

This sets the file (and implicitly loads it) for the text to display and then edit.

All changes are written back to the file after a short delay if the entry object is set to autosave (which is the default).

If the entry had any other file set previously, any changes made to it will be saved if the autosave feature is enabled, otherwise, the file will be silently discarded and any non-saved changes will be lost.

Returns
  `EINA_TRUE` on success, `EINA_FALSE` otherwise

Parameters

  [in] | file | The path to the file to load and save
  [in] | format | The file format

References elm_obj_entry_file_text_format_set().

## ◆ elm_entry_file_text_format_set()

void elm_entry_file_text_format_set | ( | Elm_Entry * | obj,
|  | Elm_Text_Format | format
| ) |  |

Text format used to load and save the file, which could be plain text or markup text.

Default is `ELM_TEXT_FORMAT_PLAIN_UTF8`, if you want to use `ELM_TEXT_FORMAT_MARKUP_UTF8` then you need to set the text format before calling Efl.File.file.set.

You could also set it before a call to elm_entry_file_save in order to save with the given format.

Use it before calling Efl.File.file.set or elm_entry_file_save.

Parameters

  [in] | format | The file format

References elm_obj_entry_file_text_format_set().

## ◆ elm_entry_filter_accept_set()

void elm_entry_filter_accept_set | ( | void * | data,
|  | Evas_Object * | entry,
|  | char ** | text
| ) |  |

Filter inserted text based on accepted or rejected sets of characters.

Add this filter to an entry to restrict the set of accepted characters based on the sets in the provided Elm_Entry_Filter_Accept_Set. This structure contains both accepted and rejected sets, but they are mutually exclusive. This structure must be available for as long as the entry is alive AND the elm_entry_filter_accept_set is being used.

The `accepted` set takes preference, so if it is set, the filter will only work based on the accepted characters, ignoring anything in the `rejected` value. If `accepted` is `NULL`, then `rejected` is used.

In both cases, the function filters by matching utf8 characters to the raw markup text, so it can be used to remove formatting tags.

This filter, like any others, does not apply when setting the entry text directly with elm_object_text_set()

References _Elm_Entry_Filter_Accept_Set::accepted, elm_entry_markup_to_utf8(), and _Elm_Entry_Filter_Accept_Set::rejected.

## ◆ elm_entry_filter_limit_size()

void elm_entry_filter_limit_size | ( | void * | data,
|  | Evas_Object * | entry,
|  | char ** | text
| ) |  |

Filter inserted text based on user defined character and byte limits.

Add this filter to an entry to limit the characters that it will accept based the contents of the provided Elm_Entry_Filter_Limit_Size. The function works on the UTF-8 representation of the string, converting it from the set markup, thus not accounting for any format in it.

The user must create an Elm_Entry_Filter_Limit_Size structure and pass it as data when setting the filter. In it, it's possible to set limits by character count or bytes (any of them is disabled if 0), and both can be set at the same time. In that case, it first checks for characters, then bytes. The Elm_Entry_Filter_Limit_Size structure must be alive and valid for as long as the entry is alive AND the elm_entry_filter_limit_size filter is set.

The function will cut the inserted text in order to allow only the first number of characters that are still allowed. The cut is made in characters, even when limiting by bytes, in order to always contain valid ones and avoid half unicode characters making it in.

This filter, like any others, does not apply when setting the entry text directly with elm_object_text_set().

References elm_entry_markup_to_utf8().

## ◆ elm_entry_icon_visible_set()

void elm_entry_icon_visible_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | setting
| ) |  |

Sets the visibility of the left-side widget of the entry, set by elm_object_part_content_set.

Parameters

  [in] | setting | `true` if the object should be displayed, `false` if not.

References elm_obj_entry_icon_visible_set().

## ◆ elm_entry_imf_context_get()

void* elm_entry_imf_context_get | ( | const Elm_Entry * | obj | ) |

Returns the input method context of the entry.

This function exposes the internal input method context.

IMPORTANT: Many functions may change (i.e delete and create a new one) the internal input method context. Do NOT cache the returned object.

References elm_obj_entry_imf_context_get().

## ◆ elm_entry_imf_context_reset()

void elm_entry_imf_context_reset | ( | Elm_Entry * | obj | ) |

Reset the input method context of the entry if needed.

This can be necessary in the case where modifying the buffer would confuse on-going input method behavior. This will typically cause the Input Method Context to clear the preedit state.

References elm_obj_entry_imf_context_reset().

## ◆ elm_entry_input_hint_get()

Elm_Input_Hints elm_entry_input_hint_get | ( | const Elm_Entry * | obj | ) |

Gets the value of input hint.

Returns
  Input hint.

References elm_obj_entry_input_hint_get().

## ◆ elm_entry_input_hint_set()

void elm_entry_input_hint_set | ( | Elm_Entry * | obj,
|  | Elm_Input_Hints | hints
| ) |  |

Sets the input hint which allows input methods to fine-tune their behavior.

Parameters

  [in] | hints | Input hint.

References elm_obj_entry_input_hint_set().

Referenced by elm_entry_add(), and elm_entry_bounce_get().

## ◆ elm_entry_input_panel_enabled_get()

Eina_Bool elm_entry_input_panel_enabled_get | ( | const Elm_Entry * | obj | ) |

Get the attribute to show the input panel automatically.

Returns
  If true, the input panel is appeared when entry is clicked or has a focus.

References elm_obj_entry_input_panel_enabled_get().

## ◆ elm_entry_input_panel_enabled_set()

void elm_entry_input_panel_enabled_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | enabled
| ) |  |

Sets the attribute to show the input panel automatically.

Parameters

  [in] | enabled | If true, the input panel is appeared when entry is clicked or has a focus.

References elm_obj_entry_input_panel_enabled_set().

## ◆ elm_entry_input_panel_hide()

void elm_entry_input_panel_hide | ( | Elm_Entry * | obj | ) |

Hide the input panel (virtual keyboard).

Note that input panel is shown or hidden automatically according to the focus state of entry widget. This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, `false`)

References elm_obj_entry_input_panel_hide().

## ◆ elm_entry_input_panel_imdata_get()

void elm_entry_input_panel_imdata_get | ( | const Elm_Entry * | obj,
|  | void * | data,
|  | int * | len
| ) |  |

Get the specific data of the current input panel.

Parameters

  [out] | len | The length of data.

References elm_obj_entry_input_panel_imdata_get().

## ◆ elm_entry_input_panel_imdata_set()

void elm_entry_input_panel_imdata_set | ( | Elm_Entry * | obj,
|  | const void * | data,
|  | int | len
| ) |  |

Set the input panel-specific data to deliver to the input panel.

This API is used by applications to deliver specific data to the input panel. The data format MUST be negotiated by both application and the input panel. The size and format of data are defined by the input panel.

Parameters

  [in] | len | The length of data, in bytes, to send to the input panel.

References elm_obj_entry_input_panel_imdata_set().

## ◆ elm_entry_input_panel_language_get()

Elm_Input_Panel_Lang elm_entry_input_panel_language_get | ( | const Elm_Entry * | obj | ) |

Get the language mode of the input panel.

Returns
  language to be set to the input panel.

References elm_obj_entry_input_panel_language_get().

## ◆ elm_entry_input_panel_language_set()

void elm_entry_input_panel_language_set | ( | Elm_Entry * | obj,
|  | Elm_Input_Panel_Lang | lang
| ) |  |

Set the language mode of the input panel.

This API can be used if you want to show the alphabet keyboard mode.

Parameters

  [in] | lang | language to be set to the input panel.

References elm_obj_entry_input_panel_language_set().

## ◆ elm_entry_input_panel_layout_get()

Elm_Input_Panel_Layout elm_entry_input_panel_layout_get | ( | const Elm_Entry * | obj | ) |

Get the input panel layout of the entry.

Returns
  layout type.

References elm_obj_entry_input_panel_layout_get().

## ◆ elm_entry_input_panel_layout_set()

void elm_entry_input_panel_layout_set | ( | Elm_Entry * | obj,
|  | Elm_Input_Panel_Layout | layout
| ) |  |

Set the input panel layout of the entry.

Parameters

  [in] | layout | layout type.

References elm_obj_entry_input_panel_layout_set().

## ◆ elm_entry_input_panel_layout_variation_get()

int elm_entry_input_panel_layout_variation_get | ( | const Elm_Entry * | obj | ) |

Get the input panel layout variation of the entry.

Returns
  layout variation type.

Since
  1.8

References elm_obj_entry_input_panel_layout_variation_get().

## ◆ elm_entry_input_panel_layout_variation_set()

void elm_entry_input_panel_layout_variation_set | ( | Elm_Entry * | obj,
|  | int | variation
| ) |  |

Set the input panel layout variation of the entry.

Parameters

  [in] | variation | layout variation type.

Since
  1.8

References elm_obj_entry_input_panel_layout_variation_set().

## ◆ elm_entry_input_panel_return_key_autoenabled_set()

void elm_entry_input_panel_return_key_autoenabled_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | enabled
| ) |  |

Set whether the return key on the input panel is disabled automatically when entry has no text.

If `enabled` is `true`, The return key on input panel is disabled when the entry has no text. The return key on the input panel is automatically enabled when the entry has text. The default value is `false`.

Parameters

  [in] | enabled | If `enabled` is true, the return key is automatically disabled when the entry has no text.

References elm_obj_entry_input_panel_return_key_autoenabled_set().

## ◆ elm_entry_input_panel_return_key_disabled_get()

Eina_Bool elm_entry_input_panel_return_key_disabled_get | ( | const Elm_Entry * | obj | ) |

Get whether the return key on the input panel should be disabled or not.

Returns
  The state to put in in: `true` for disabled, `false` for enabled.

References elm_obj_entry_input_panel_return_key_disabled_get().

## ◆ elm_entry_input_panel_return_key_disabled_set()

void elm_entry_input_panel_return_key_disabled_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | disabled
| ) |  |

Set the return key on the input panel to be disabled.

Parameters

  [in] | disabled | The state to put in in: `true` for disabled, `false` for enabled.

References elm_obj_entry_input_panel_return_key_disabled_set().

## ◆ elm_entry_input_panel_return_key_type_get()

Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get | ( | const Elm_Entry * | obj | ) |

Get the "return" key type.

Returns
  The type of "return" key on the input panel.

References elm_obj_entry_input_panel_return_key_type_get().

## ◆ elm_entry_input_panel_return_key_type_set()

void elm_entry_input_panel_return_key_type_set | ( | Elm_Entry * | obj,
|  | Elm_Input_Panel_Return_Key_Type | return_key_type
| ) |  |

Set the "return" key type.

This type is used to set string or icon on the "return" key of the input panel.

An input panel displays the string or icon associated with this type.

Parameters

  [in] | return_key_type | The type of "return" key on the input panel.

References elm_obj_entry_input_panel_return_key_type_set().

## ◆ elm_entry_input_panel_show()

void elm_entry_input_panel_show | ( | Elm_Entry * | obj | ) |

Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.

Note that input panel is shown or hidden automatically according to the focus state of entry widget. This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, `false`).

References elm_obj_entry_input_panel_show().

## ◆ elm_entry_input_panel_show_on_demand_get()

Eina_Bool elm_entry_input_panel_show_on_demand_get | ( | const Elm_Entry * | obj | ) |

Get the attribute to show the input panel in case of only an user's explicit Mouse Up event.

Returns
  If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)

Since
  1.9

References elm_obj_entry_input_panel_show_on_demand_get().

## ◆ elm_entry_input_panel_show_on_demand_set()

void elm_entry_input_panel_show_on_demand_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | ondemand
| ) |  |

Set the attribute to show the input panel in case of only an user's explicit Mouse Up event.

It doesn't request to show the input panel even though it has focus.

Parameters

  [in] | ondemand | If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)

Since
  1.9

References elm_obj_entry_input_panel_show_on_demand_set().

## ◆ elm_entry_is_empty()

Eina_Bool elm_entry_is_empty | ( | const Elm_Entry * | obj | ) |

Get whether the entry is empty.

Empty means no text at all. If there are any markup tags, like an item tag for which no provider finds anything, and no text is displayed, this function still returns `false`.

References elm_obj_entry_is_empty().

## ◆ elm_entry_item_provider_append()

void elm_entry_item_provider_append | ( | Elm_Entry * | obj,
|  | Elm_Entry_Item_Provider_Cb | func,
|  | void * | data
| ) |  |

This appends a custom item provider to the list for that entry.

This appends the given callback. The list is walked from beginning to end with each function called given the item href string in the text. If the function returns an object handle other than `null` (it should create an object to do this), then this object is used to replace that item. If not the next provider is called until one provides an item object, or the default provider in entry does.

See also Items.

Parameters

  [in] | data | The data passed to `func`.

References elm_obj_entry_item_provider_append().

## ◆ elm_entry_item_provider_prepend()

void elm_entry_item_provider_prepend | ( | Elm_Entry * | obj,
|  | Elm_Entry_Item_Provider_Cb | func,
|  | void * | data
| ) |  |

This prepends a custom item provider to the list for that entry.

This prepends the given callback.

Parameters

  [in] | data | The data passed to `func`.

References elm_obj_entry_item_provider_prepend().

## ◆ elm_entry_item_provider_remove()

void elm_entry_item_provider_remove | ( | Elm_Entry * | obj,
|  | Elm_Entry_Item_Provider_Cb | func,
|  | void * | data
| ) |  |

This removes a custom item provider to the list for that entry.

This removes the given callback. See elm_entry_item_provider_append for more information

Parameters

  [in] | data | The data passed to `func`.

References elm_obj_entry_item_provider_remove().

## ◆ elm_entry_line_wrap_get()

Elm_Wrap_Type elm_entry_line_wrap_get | ( | const Elm_Entry * | obj | ) |

Get the wrap mode the entry was set to use.

Returns
  The wrap mode to use. See Elm_Wrap_Type for details on them.

References elm_obj_entry_line_wrap_get().

## ◆ elm_entry_line_wrap_set()

void elm_entry_line_wrap_set | ( | Elm_Entry * | obj,
|  | Elm_Wrap_Type | wrap
| ) |  |

Set the line wrap type to use on multi-line entries.

Sets the wrap type used by the entry to any of the specified in Elm_Wrap_Type. This tells how the text will be implicitly cut into a new line (without inserting a line break or paragraph separator) when it reaches the far edge of the widget.

Note that this only makes sense for multi-line entries. A widget set to be single line will never wrap.

Parameters

  [in] | wrap | The wrap mode to use. See Elm_Wrap_Type for details on them.

References elm_obj_entry_line_wrap_set().

## ◆ elm_entry_markup_filter_append()

void elm_entry_markup_filter_append | ( | Elm_Entry * | obj,
|  | Elm_Entry_Filter_Cb | func,
|  | void * | data
| ) |  |

Append a markup filter function for text inserted in the entry.

Append the given callback to the list. This functions will be called whenever any text is inserted into the entry, with the text to be inserted as a parameter. The type of given text is always markup. 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 its text parameter to `null`. This will also prevent any following filters from being called.

Parameters

  [in] | data | User data to pass to `func`.

References elm_obj_entry_markup_filter_append().

Referenced by elm_entry_add().

## ◆ elm_entry_markup_filter_prepend()

void elm_entry_markup_filter_prepend | ( | Elm_Entry * | obj,
|  | Elm_Entry_Filter_Cb | func,
|  | void * | data
| ) |  |

Prepend a markup filter function for text inserted in the entry.

Prepend the given callback to the list.

Parameters

  [in] | data | User data to pass to `func`.

References elm_obj_entry_markup_filter_prepend().

## ◆ elm_entry_markup_filter_remove()

void elm_entry_markup_filter_remove | ( | Elm_Entry * | obj,
|  | Elm_Entry_Filter_Cb | func,
|  | void * | data
| ) |  |

Remove a markup filter from the list.

Removes the given callback from the filter list. See elm_entry_markup_filter_append for more information.

Parameters

  [in] | data | The user data passed when adding the function.

References elm_obj_entry_markup_filter_remove().

Referenced by elm_entry_add().

## ◆ elm_entry_markup_to_utf8()

char* elm_entry_markup_to_utf8 | ( | const char * | s | ) |

This converts a markup (HTML-like) string into UTF-8.

The returned string is a malloc'ed buffer and it should be freed when not needed anymore.

Parameters

  s | The string (in markup) to be converted

Returns
  The converted string (in UTF-8). It should be freed.

Referenced by elm_entry_filter_accept_set(), elm_entry_filter_limit_size(), and elm_fileselector_entry_path_get().

## ◆ elm_entry_password_get()

Eina_Bool elm_entry_password_get | ( | const Elm_Entry * | obj | ) |

Get whether the entry is set to password mode.

Returns
  If true, password mode is enabled.

References elm_obj_entry_password_get().

## ◆ elm_entry_password_set()

void elm_entry_password_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | password
| ) |  |

Sets the entry to password mode.

In password mode, entries are implicitly single line and the display of any text in them is replaced with asterisks (*).

Parameters

  [in] | password | If true, password mode is enabled.

References elm_obj_entry_password_set().

## ◆ elm_entry_prediction_allow_get()

Eina_Bool elm_entry_prediction_allow_get | ( | const Elm_Entry * | obj | ) |

Get whether the entry should allow to use the text prediction.

Returns
  Whether the entry should allow to use the text prediction.

References elm_obj_entry_prediction_allow_get().

## ◆ elm_entry_prediction_allow_set()

void elm_entry_prediction_allow_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | prediction
| ) |  |

Set whether the entry should allow to use the text prediction.

Parameters

  [in] | prediction | Whether the entry should allow to use the text prediction.

References elm_obj_entry_prediction_allow_set().

## ◆ elm_entry_scrollable_get()

Eina_Bool elm_entry_scrollable_get | ( | const Elm_Entry * | obj | ) |

Get the scrollable state of the entry.

Normally the entry is not scrollable. This gets the scrollable state of the entry.

Returns
  `true` if it is to be scrollable, `false` otherwise.

References elm_obj_entry_scrollable_get().

## ◆ elm_entry_scrollable_set()

void elm_entry_scrollable_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | scroll
| ) |  |

Enable or disable scrolling in entry.

Normally the entry is not scrollable unless you enable it with this call.

Parameters

  [in] | scroll | `true` if it is to be scrollable, `false` otherwise.

References elm_obj_entry_scrollable_set().

## ◆ elm_entry_scrollbar_policy_set()

EINA_DEPRECATED void elm_entry_scrollbar_policy_set | ( | Evas_Object * | obj,
|  | Elm_Scroller_Policy | h,
|  | Elm_Scroller_Policy | v
| ) |  |

This sets the entry's scrollbar policy (i.e.

enabling/disabling them).

Setting an entry to single-line mode with elm_entry_single_line_set() will automatically disable the display of scrollbars when the entry moves inside its scroller.

Parameters

  obj | The entry object
  h | The horizontal scrollbar policy to apply
  v | The vertical scrollbar policy to apply

Deprecated:
  Use elm_scroller_policy_set() instead.

## ◆ elm_entry_select_region_set()

void elm_entry_select_region_set | ( | Elm_Entry * | obj,
|  | int | start,
|  | int | end
| ) |  |

This selects a region of text within the entry.

Parameters

  [in] | start | The starting position.
  [in] | end | The end position.

Since
  1.9

References elm_obj_entry_select_region_set().

## ◆ elm_entry_selection_get()

const char* elm_entry_selection_get | ( | const Elm_Entry * | obj | ) |

Get any selected text within the entry.

If there's any selected text in the entry, this function returns it as a string in markup format. `null` is returned if no selection exists or if an error occurred.

The returned value points to an internal string and should not be freed or modified in any way. If the `entry` object is deleted or its contents are changed, the returned pointer should be considered invalid.

References elm_obj_entry_selection_get().

## ◆ elm_entry_selection_handler_disabled_set()

void elm_entry_selection_handler_disabled_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | disabled
| ) |  |

This disabled the entry's selection handlers.

Parameters

  [in] | disabled | If `true`, the selection handlers are disabled.

References elm_obj_entry_selection_handler_disabled_set().

## ◆ elm_entry_single_line_get()

Eina_Bool elm_entry_single_line_get | ( | const Elm_Entry * | obj | ) |

Get whether the entry is set to be single line.

Returns
  If true, the text in the entry will be on a single line.

References elm_obj_entry_single_line_get().

## ◆ elm_entry_single_line_set()

void elm_entry_single_line_set | ( | Elm_Entry * | obj,
|  | Eina_Bool | single_line
| ) |  |

Sets the entry to single line mode.

In single line mode, entries don't ever wrap when the text reaches the edge, and instead they keep growing horizontally. Pressing the `Enter` key will generate an $"activate" event instead of adding a new line.

When `single_line` is `false`, line wrapping takes effect again and pressing enter will break the text into a different line without generating any events.

Parameters

  [in] | single_line | If true, the text in the entry will be on a single line.

References elm_obj_entry_single_line_set().

## ◆ elm_entry_text_style_user_peek()

const char* elm_entry_text_style_user_peek | ( | const Elm_Entry * | obj | ) |

Get the style on the top of user style stack.

See also elm_entry_text_style_user_push.

Since
  1.7

References elm_obj_entry_text_style_user_peek().

## ◆ elm_entry_text_style_user_pop()

void elm_entry_text_style_user_pop | ( | Elm_Entry * | obj | ) |

Remove the style in the top of user style stack.

Since
  1.7

References elm_obj_entry_text_style_user_pop().

## ◆ elm_entry_text_style_user_push()

void elm_entry_text_style_user_push | ( | Elm_Entry * | obj,
|  | const char * | style
| ) |  |

Push the style to the top of user style stack.

If there is styles in the user style stack, the properties in the top style of user style stack will replace the properties in current theme. The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').

Parameters

  [in] | style | The style user to push.

Since
  1.7

References elm_obj_entry_text_style_user_push().

## ◆ elm_entry_textblock_get()

Evas_Object* elm_entry_textblock_get | ( | const Elm_Entry * | obj | ) |

Returns the actual textblock object of the entry.

This function exposes the internal textblock object that actually contains and draws the text. This should be used for low-level manipulations that are otherwise not possible.

Changing the textblock directly from here will not notify edje/elm to recalculate the textblock size automatically, so any modifications done to the textblock returned by this function should be followed by a call to elm_entry_calc_force.

The return value is marked as const as an additional warning. One should not use the returned object with any of the generic evas functions (geometry_get/resize/move and etc), but only with the textblock functions; The former will either not work at all, or break the correct functionality.

IMPORTANT: Many functions may change (i.e delete and create a new one) the internal textblock object. Do NOT cache the returned object, and try not to mix calls on this object with regular elm_entry calls (which may change the internal textblock object). This applies to all cursors returned from textblock calls, and all the other derivative values.

References elm_obj_entry_textblock_get().

## ◆ elm_entry_utf8_to_markup()

char* elm_entry_utf8_to_markup | ( | const char * | s | ) |

This converts a UTF-8 string into markup (HTML-like).

The returned string is a malloc'ed buffer and it should be freed when not needed anymore.

Parameters

  s | The string (in UTF-8) to be converted

Returns
  The converted string (in markup). It should be freed.

For example, passing "<align=center>hello</align>&gt;" will return "&lt;align=center&gt;hello&lt;/align&gt; &amp;gt;". This is useful when you want to display "&" in label, entry, and some widgets which use textblock internally.

Referenced by elm_fileselector_entry_path_set().

## ◆ elm_obj_entry_anchor_hover_end()

EOAPI void elm_obj_entry_anchor_hover_end | ( | void |  | ) |

Ends the hover popup in the entry.

When an anchor is clicked, the entry widget will create a hover object to use as a popup with user provided content. This function terminates this popup, returning the entry to its normal state.

Referenced by elm_entry_anchor_hover_end().

## ◆ elm_obj_entry_anchor_hover_parent_get()

EOAPI Evas_Object* elm_obj_entry_anchor_hover_parent_get | ( | void |  | ) |

Get the parent of the hover popup.

Get the object used as parent for the hover created by the entry widget. If no parent is set, the same entry object will be used.

Returns
  The object to use as parent for the hover.

Referenced by elm_entry_anchor_hover_parent_get().

## ◆ elm_obj_entry_anchor_hover_parent_set()

EOAPI void elm_obj_entry_anchor_hover_parent_set | ( | Evas_Object * | parent | ) |

Set the parent of the hover popup.

Sets the parent object to use by the hover created by the entry when an anchor is clicked.

Parameters

  [in] | parent | The object to use as parent for the hover.

Referenced by elm_entry_anchor_hover_parent_set().

## ◆ elm_obj_entry_anchor_hover_style_get()

EOAPI const char* elm_obj_entry_anchor_hover_style_get | ( | void |  | ) |

Get the style that the hover should use.

Returns
  The style to use for the underlying hover.

Referenced by elm_entry_anchor_hover_style_get().

## ◆ elm_obj_entry_anchor_hover_style_set()

EOAPI void elm_obj_entry_anchor_hover_style_set | ( | const char * | style | ) |

Set the style that the hover should use.

When creating the popup hover, entry will request that it's themed according to `style`.

Setting style no `null` means disabling automatic hover.

Parameters

  [in] | style | The style to use for the underlying hover.

Referenced by elm_entry_anchor_hover_style_set().

## ◆ elm_obj_entry_append()

EOAPI void elm_obj_entry_append | ( | const char * | str | ) |

Appends `str` to the text of the entry.

Adds the text in `str` to the end of any text already present in the widget.

The appended text is subject to any filters set for the widget.

See also elm_obj_entry_markup_filter_append.

Parameters

  [in] | str | The text to be appended.

Referenced by elm_entry_entry_append().

## ◆ elm_obj_entry_autocapital_type_get()

EOAPI Elm_Autocapital_Type elm_obj_entry_autocapital_type_get | ( | void |  | ) |

Get the autocapitalization type on the immodule.

Returns
  The type of autocapitalization.

Referenced by elm_entry_autocapital_type_get().

## ◆ elm_obj_entry_autocapital_type_set()

EOAPI void elm_obj_entry_autocapital_type_set | ( | Elm_Autocapital_Type | autocapital_type | ) |

Set the autocapitalization type on the immodule.

Parameters

  [in] | autocapital_type | The type of autocapitalization.

Referenced by elm_entry_autocapital_type_set().

## ◆ elm_obj_entry_autosave_get()

EOAPI Eina_Bool elm_obj_entry_autosave_get | ( | void |  | ) |

This gets the entry object's 'autosave' status.

Returns
  Autosave the loaded file or not.

Referenced by elm_entry_autosave_get().

## ◆ elm_obj_entry_autosave_set()

EOAPI void elm_obj_entry_autosave_set | ( | Eina_Bool | auto_save | ) |

This sets the entry object to 'autosave' the loaded text file or not.

Parameters

  [in] | auto_save | Autosave the loaded file or not.

Referenced by elm_entry_autosave_set().

## ◆ elm_obj_entry_calc_force()

EOAPI void elm_obj_entry_calc_force | ( | void |  | ) |

Forces calculation of the entry size and text layouting.

This should be used after modifying the textblock object directly. See elm_obj_entry_textblock_get for more information.

Referenced by elm_entry_calc_force().

## ◆ elm_obj_entry_cnp_mode_get()

EOAPI Elm_Cnp_Mode elm_obj_entry_cnp_mode_get | ( | void |  | ) |

Getting elm_entry text paste/drop mode.

Normally the entry allows both text and images to be pasted. This gets the copy & paste mode of the entry.

Returns
  One of Elm_Cnp_Mode: ELM_CNP_MODE_MARKUP, ELM_CNP_MODE_NO_IMAGE, ELM_CNP_MODE_PLAINTEXT.

Referenced by elm_entry_cnp_mode_get().

## ◆ elm_obj_entry_cnp_mode_set()

EOAPI void elm_obj_entry_cnp_mode_set | ( | Elm_Cnp_Mode | cnp_mode | ) |

Control pasting of text and images for the widget.

Normally the entry allows both text and images to be pasted. By setting cnp_mode to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past. By setting cnp_mode to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .

Note
  This only changes the behaviour of text.

Parameters

  [in] | cnp_mode | One of Elm_Cnp_Mode: ELM_CNP_MODE_MARKUP, ELM_CNP_MODE_NO_IMAGE, ELM_CNP_MODE_PLAINTEXT.

Referenced by elm_entry_cnp_mode_set().

## ◆ elm_obj_entry_context_menu_clear()

EOAPI void elm_obj_entry_context_menu_clear | ( | void |  | ) |

This clears and frees the items in a entry's contextual (longpress) menu.

See also elm_obj_entry_context_menu_item_add.

Referenced by elm_entry_context_menu_clear().

## ◆ elm_obj_entry_context_menu_disabled_get()

EOAPI Eina_Bool elm_obj_entry_context_menu_disabled_get | ( | void |  | ) |

This returns whether the entry's contextual (longpress) menu is disabled.

Returns
  If `true`, the menu is disabled.

Referenced by elm_entry_context_menu_disabled_get().

## ◆ elm_obj_entry_context_menu_disabled_set()

EOAPI void elm_obj_entry_context_menu_disabled_set | ( | Eina_Bool | disabled | ) |

This disables the entry's contextual (longpress) menu.

Parameters

  [in] | disabled | If `true`, the menu is disabled.

Referenced by elm_entry_context_menu_disabled_set().

## ◆ elm_obj_entry_context_menu_item_add()

EOAPI void elm_obj_entry_context_menu_item_add | ( | const char * | label,
|  | const char * | icon_file,
|  | Elm_Icon_Type | icon_type,
|  | Evas_Smart_Cb | func,
|  | const void * | data
| ) |  |

This adds an item to the entry's contextual menu.

A longpress on an entry will make the contextual menu show up, if this hasn't been disabled with elm_obj_entry_context_menu_disabled_set. By default, this menu provides a few options like enabling selection mode, which is useful on embedded devices that need to be explicit about it, and when a selection exists it also shows the copy and cut actions.

With this function, developers can add other options to this menu to perform any action they deem necessary.

Parameters

  [in] | icon_file | The item's icon file.
  [in] | icon_type | The item's icon type.
  [in] | func | The callback to execute when the item is clicked.
  [in] | data | The data to associate with the item for related functions.

Referenced by elm_entry_context_menu_item_add().

## ◆ elm_obj_entry_cursor_content_get()

EOAPI char* elm_obj_entry_cursor_content_get | ( | void |  | ) |

Get the character pointed by the cursor at its current position.

This function returns a string with the utf8 character stored at the current cursor position. Only the text is returned, any format that may exist will not be part of the return value. You must free the string when done with free.

Referenced by elm_entry_cursor_content_get().

## ◆ elm_obj_entry_cursor_geometry_get()

EOAPI Eina_Bool elm_obj_entry_cursor_geometry_get | ( | Evas_Coord * | x,
|  | Evas_Coord * | y,
|  | Evas_Coord * | w,
|  | Evas_Coord * | h
| ) |  |

This function returns the geometry of the cursor.

It's useful if you want to draw something on the cursor (or where it is), or for example in the case of scrolled entry where you want to show the cursor.

Parameters

  [out] | x | returned geometry.
  [out] | y | returned geometry.
  [out] | w | returned geometry.
  [out] | h | returned geometry.

Referenced by elm_entry_cursor_geometry_get().

## ◆ elm_obj_entry_cursor_is_format_get()

EOAPI Eina_Bool elm_obj_entry_cursor_is_format_get | ( | void |  | ) |

Get whether a format node exists at the current cursor position.

A format node is anything that defines how the text is rendered. It can be a visible format node, such as a line break or a paragraph separator, or an invisible one, such as bold begin or end tag. This function returns whether any format node exists at the current cursor position.

Referenced by elm_entry_cursor_is_format_get().

## ◆ elm_obj_entry_cursor_pos_get()

EOAPI int elm_obj_entry_cursor_pos_get | ( | void |  | ) |

Get the current position of the cursor in the entry.

Returns
  The position of the cursor.

Referenced by elm_entry_cursor_pos_get().

## ◆ elm_obj_entry_cursor_pos_set()

EOAPI void elm_obj_entry_cursor_pos_set | ( | int | pos | ) |

Sets the cursor position in the entry to the given value.

The value in `pos` is the index of the character position within the contents of the string as returned by elm_obj_entry_cursor_pos_get.

Parameters

  [in] | pos | The position of the cursor.

Referenced by elm_entry_cursor_pos_set().

## ◆ elm_obj_entry_editable_get()

EOAPI Eina_Bool elm_obj_entry_editable_get | ( | void |  | ) |

Get whether the entry is editable or not.

Returns
  If `true`, user input will be inserted in the entry, if not, the entry is read-only and no user input is allowed.

Referenced by elm_entry_editable_get().

## ◆ elm_obj_entry_editable_set()

EOAPI void elm_obj_entry_editable_set | ( | Eina_Bool | editable | ) |

Sets if the entry is to be editable or not.

By default, entries are editable and when focused, any text input by the user will be inserted at the current cursor position. But calling this function with `editable` as `false` will prevent the user from inputting text into the entry.

The only way to change the text of a non-editable entry is to use elm_object_text_set, elm_entry_entry_insert and other related functions.

Parameters

  [in] | editable | If `true`, user input will be inserted in the entry, if not, the entry is read-only and no user input is allowed.

Referenced by elm_entry_editable_set().

## ◆ elm_obj_entry_end_visible_set()

EOAPI void elm_obj_entry_end_visible_set | ( | Eina_Bool | setting | ) |

Sets the visibility of the end widget of the entry, set by elm_object_part_content_set(ent, "end", content).

Parameters

  [in] | setting | true if the object should be displayed, false if not.

Referenced by elm_entry_end_visible_set().

## ◆ elm_obj_entry_file_text_format_set()

EOAPI void elm_obj_entry_file_text_format_set | ( | Elm_Text_Format | format | ) |

Text format used to load and save the file, which could be plain text or markup text.

Default is `ELM_TEXT_FORMAT_PLAIN_UTF8`, if you want to use `ELM_TEXT_FORMAT_MARKUP_UTF8` then you need to set the text format before calling efl_file_set.

You could also set it before a call to elm_obj_entry_file_save in order to save with the given format.

Use it before calling efl_file_set or elm_obj_entry_file_save.

Parameters

  [in] | format | The file format

Referenced by elm_entry_file_set(), and elm_entry_file_text_format_set().

## ◆ elm_obj_entry_icon_visible_set()

EOAPI void elm_obj_entry_icon_visible_set | ( | Eina_Bool | setting | ) |

Sets the visibility of the left-side widget of the entry, set by elm_object_part_content_set.

Parameters

  [in] | setting | `true` if the object should be displayed, `false` if not.

Referenced by elm_entry_icon_visible_set().

## ◆ elm_obj_entry_imf_context_get()

EOAPI void* elm_obj_entry_imf_context_get | ( | void |  | ) |

Returns the input method context of the entry.

This function exposes the internal input method context.

IMPORTANT: Many functions may change (i.e delete and create a new one) the internal input method context. Do NOT cache the returned object.

Referenced by elm_entry_imf_context_get().

## ◆ elm_obj_entry_imf_context_reset()

EOAPI void elm_obj_entry_imf_context_reset | ( | void |  | ) |

Reset the input method context of the entry if needed.

This can be necessary in the case where modifying the buffer would confuse on-going input method behavior. This will typically cause the Input Method Context to clear the preedit state.

Referenced by elm_entry_imf_context_reset().

## ◆ elm_obj_entry_input_hint_get()

EOAPI Elm_Input_Hints elm_obj_entry_input_hint_get | ( | void |  | ) |

Gets the value of input hint.

Returns
  Input hint.

Referenced by elm_entry_input_hint_get().

## ◆ elm_obj_entry_input_hint_set()

EOAPI void elm_obj_entry_input_hint_set | ( | Elm_Input_Hints | hints | ) |

Sets the input hint which allows input methods to fine-tune their behavior.

Parameters

  [in] | hints | Input hint.

Referenced by elm_entry_input_hint_set().

## ◆ elm_obj_entry_input_panel_enabled_get()

EOAPI Eina_Bool elm_obj_entry_input_panel_enabled_get | ( | void |  | ) |

Get the attribute to show the input panel automatically.

Returns
  If true, the input panel is appeared when entry is clicked or has a focus.

Referenced by elm_entry_input_panel_enabled_get().

## ◆ elm_obj_entry_input_panel_enabled_set()

EOAPI void elm_obj_entry_input_panel_enabled_set | ( | Eina_Bool | enabled | ) |

Sets the attribute to show the input panel automatically.

Parameters

  [in] | enabled | If true, the input panel is appeared when entry is clicked or has a focus.

Referenced by elm_entry_input_panel_enabled_set().

## ◆ elm_obj_entry_input_panel_hide()

EOAPI void elm_obj_entry_input_panel_hide | ( | void |  | ) |

Hide the input panel (virtual keyboard).

Note that input panel is shown or hidden automatically according to the focus state of entry widget. This API can be used in the case of manually controlling by using elm_obj_entry_input_panel_enabled_set(en, `false`)

Referenced by elm_entry_input_panel_hide().

## ◆ elm_obj_entry_input_panel_imdata_get()

EOAPI void elm_obj_entry_input_panel_imdata_get | ( | void * | data,
|  | int * | len
| ) |  |

Get the specific data of the current input panel.

Parameters

  [out] | len | The length of data.

Referenced by elm_entry_input_panel_imdata_get().

## ◆ elm_obj_entry_input_panel_imdata_set()

EOAPI void elm_obj_entry_input_panel_imdata_set | ( | const void * | data,
|  | int | len
| ) |  |

Set the input panel-specific data to deliver to the input panel.

This API is used by applications to deliver specific data to the input panel. The data format MUST be negotiated by both application and the input panel. The size and format of data are defined by the input panel.

Parameters

  [in] | len | The length of data, in bytes, to send to the input panel.

Referenced by elm_entry_input_panel_imdata_set().

## ◆ elm_obj_entry_input_panel_language_get()

EOAPI Elm_Input_Panel_Lang elm_obj_entry_input_panel_language_get | ( | void |  | ) |

Get the language mode of the input panel.

Returns
  language to be set to the input panel.

Referenced by elm_entry_input_panel_language_get().

## ◆ elm_obj_entry_input_panel_language_set()

EOAPI void elm_obj_entry_input_panel_language_set | ( | Elm_Input_Panel_Lang | lang | ) |

Set the language mode of the input panel.

This API can be used if you want to show the alphabet keyboard mode.

Parameters

  [in] | lang | language to be set to the input panel.

Referenced by elm_entry_input_panel_language_set().

## ◆ elm_obj_entry_input_panel_layout_get()

EOAPI Elm_Input_Panel_Layout elm_obj_entry_input_panel_layout_get | ( | void |  | ) |

Get the input panel layout of the entry.

Returns
  layout type.

Referenced by elm_entry_input_panel_layout_get().

## ◆ elm_obj_entry_input_panel_layout_set()

EOAPI void elm_obj_entry_input_panel_layout_set | ( | Elm_Input_Panel_Layout | layout | ) |

Set the input panel layout of the entry.

Parameters

  [in] | layout | layout type.

Referenced by elm_entry_input_panel_layout_set().

## ◆ elm_obj_entry_input_panel_layout_variation_get()

EOAPI int elm_obj_entry_input_panel_layout_variation_get | ( | void |  | ) |

Get the input panel layout variation of the entry.

Returns
  layout variation type.

Since
  1.8

Referenced by elm_entry_input_panel_layout_variation_get().

## ◆ elm_obj_entry_input_panel_layout_variation_set()

EOAPI void elm_obj_entry_input_panel_layout_variation_set | ( | int | variation | ) |

Set the input panel layout variation of the entry.

Parameters

  [in] | variation | layout variation type.

Since
  1.8

Referenced by elm_entry_input_panel_layout_variation_set().

## ◆ elm_obj_entry_input_panel_return_key_autoenabled_set()

EOAPI void elm_obj_entry_input_panel_return_key_autoenabled_set | ( | Eina_Bool | enabled | ) |

Set whether the return key on the input panel is disabled automatically when entry has no text.

If `enabled` is `true`, The return key on input panel is disabled when the entry has no text. The return key on the input panel is automatically enabled when the entry has text. The default value is `false`.

Parameters

  [in] | enabled | If `enabled` is true, the return key is automatically disabled when the entry has no text.

Referenced by elm_entry_input_panel_return_key_autoenabled_set().

## ◆ elm_obj_entry_input_panel_return_key_disabled_get()

EOAPI Eina_Bool elm_obj_entry_input_panel_return_key_disabled_get | ( | void |  | ) |

Get whether the return key on the input panel should be disabled or not.

Returns
  The state to put in in: `true` for disabled, `false` for enabled.

Referenced by elm_entry_input_panel_return_key_disabled_get().

## ◆ elm_obj_entry_input_panel_return_key_disabled_set()

EOAPI void elm_obj_entry_input_panel_return_key_disabled_set | ( | Eina_Bool | disabled | ) |

Set the return key on the input panel to be disabled.

Parameters

  [in] | disabled | The state to put in in: `true` for disabled, `false` for enabled.

Referenced by elm_entry_input_panel_return_key_disabled_set().

## ◆ elm_obj_entry_input_panel_return_key_type_get()

EOAPI Elm_Input_Panel_Return_Key_Type elm_obj_entry_input_panel_return_key_type_get | ( | void |  | ) |

Get the "return" key type.

Returns
  The type of "return" key on the input panel.

Referenced by elm_entry_input_panel_return_key_type_get().

## ◆ elm_obj_entry_input_panel_return_key_type_set()

EOAPI void elm_obj_entry_input_panel_return_key_type_set | ( | Elm_Input_Panel_Return_Key_Type | return_key_type | ) |

Set the "return" key type.

This type is used to set string or icon on the "return" key of the input panel.

An input panel displays the string or icon associated with this type.

Parameters

  [in] | return_key_type | The type of "return" key on the input panel.

Referenced by elm_entry_input_panel_return_key_type_set().

## ◆ elm_obj_entry_input_panel_show()

EOAPI void elm_obj_entry_input_panel_show | ( | void |  | ) |

Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.

Note that input panel is shown or hidden automatically according to the focus state of entry widget. This API can be used in the case of manually controlling by using elm_obj_entry_input_panel_enabled_set(en, `false`).

Referenced by elm_entry_input_panel_show().

## ◆ elm_obj_entry_input_panel_show_on_demand_get()

EOAPI Eina_Bool elm_obj_entry_input_panel_show_on_demand_get | ( | void |  | ) |

Get the attribute to show the input panel in case of only an user's explicit Mouse Up event.

Returns
  If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)

Since
  1.9

Referenced by elm_entry_input_panel_show_on_demand_get().

## ◆ elm_obj_entry_input_panel_show_on_demand_set()

EOAPI void elm_obj_entry_input_panel_show_on_demand_set | ( | Eina_Bool | ondemand | ) |

Set the attribute to show the input panel in case of only an user's explicit Mouse Up event.

It doesn't request to show the input panel even though it has focus.

Parameters

  [in] | ondemand | If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)

Since
  1.9

Referenced by elm_entry_input_panel_show_on_demand_set().

## ◆ elm_obj_entry_insert()

EOAPI void elm_obj_entry_insert | ( | const char * | entry | ) |

Inserts the given text into the entry at the current cursor position.

This inserts text at the cursor position as if it was typed by the user (note that this also allows markup which a user can't just "type" as it would be converted to escaped text, so this call can be used to insert things like emoticon items or bold push/pop tags, other font and color change tags etc.)

If any selection exists, it will be replaced by the inserted text.

The inserted text is subject to any filters set for the widget.

See also elm_obj_entry_markup_filter_append.

Parameters

  [in] | entry | The text to insert.

Referenced by elm_entry_entry_insert().

## ◆ elm_obj_entry_is_empty()

EOAPI Eina_Bool elm_obj_entry_is_empty | ( | void |  | ) |

Get whether the entry is empty.

Empty means no text at all. If there are any markup tags, like an item tag for which no provider finds anything, and no text is displayed, this function still returns `false`.

Referenced by elm_entry_is_empty().

## ◆ elm_obj_entry_item_provider_append()

EOAPI void elm_obj_entry_item_provider_append | ( | Elm_Entry_Item_Provider_Cb | func,
|  | void * | data
| ) |  |

This appends a custom item provider to the list for that entry.

This appends the given callback. The list is walked from beginning to end with each function called given the item href string in the text. If the function returns an object handle other than `null` (it should create an object to do this), then this object is used to replace that item. If not the next provider is called until one provides an item object, or the default provider in entry does.

See also Items.

Parameters

  [in] | data | The data passed to `func`.

Referenced by elm_entry_item_provider_append().

## ◆ elm_obj_entry_item_provider_prepend()

EOAPI void elm_obj_entry_item_provider_prepend | ( | Elm_Entry_Item_Provider_Cb | func,
|  | void * | data
| ) |  |

This prepends a custom item provider to the list for that entry.

This prepends the given callback.

Parameters

  [in] | data | The data passed to `func`.

Referenced by elm_entry_item_provider_prepend().

## ◆ elm_obj_entry_item_provider_remove()

EOAPI void elm_obj_entry_item_provider_remove | ( | Elm_Entry_Item_Provider_Cb | func,
|  | void * | data
| ) |  |

This removes a custom item provider to the list for that entry.

This removes the given callback. See elm_obj_entry_item_provider_append for more information

Parameters

  [in] | data | The data passed to `func`.

Referenced by elm_entry_item_provider_remove().

## ◆ elm_obj_entry_line_wrap_get()

EOAPI Elm_Wrap_Type elm_obj_entry_line_wrap_get | ( | void |  | ) |

Get the wrap mode the entry was set to use.

Returns
  The wrap mode to use. See Elm_Wrap_Type for details on them.

Referenced by elm_entry_line_wrap_get().

## ◆ elm_obj_entry_line_wrap_set()

EOAPI void elm_obj_entry_line_wrap_set | ( | Elm_Wrap_Type | wrap | ) |

Set the line wrap type to use on multi-line entries.

Sets the wrap type used by the entry to any of the specified in Elm_Wrap_Type. This tells how the text will be implicitly cut into a new line (without inserting a line break or paragraph separator) when it reaches the far edge of the widget.

Note that this only makes sense for multi-line entries. A widget set to be single line will never wrap.

Parameters

  [in] | wrap | The wrap mode to use. See Elm_Wrap_Type for details on them.

Referenced by elm_entry_line_wrap_set().

## ◆ elm_obj_entry_markup_filter_append()

EOAPI void elm_obj_entry_markup_filter_append | ( | Elm_Entry_Filter_Cb | func,
|  | void * | data
| ) |  |

Append a markup filter function for text inserted in the entry.

Append the given callback to the list. This functions will be called whenever any text is inserted into the entry, with the text to be inserted as a parameter. The type of given text is always markup. 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 its text parameter to `null`. This will also prevent any following filters from being called.

Parameters

  [in] | data | User data to pass to `func`.

Referenced by elm_entry_markup_filter_append().

## ◆ elm_obj_entry_markup_filter_prepend()

EOAPI void elm_obj_entry_markup_filter_prepend | ( | Elm_Entry_Filter_Cb | func,
|  | void * | data
| ) |  |

Prepend a markup filter function for text inserted in the entry.

Prepend the given callback to the list.

Parameters

  [in] | data | User data to pass to `func`.

Referenced by elm_entry_markup_filter_prepend().

## ◆ elm_obj_entry_markup_filter_remove()

EOAPI void elm_obj_entry_markup_filter_remove | ( | Elm_Entry_Filter_Cb | func,
|  | void * | data
| ) |  |

Remove a markup filter from the list.

Removes the given callback from the filter list. See elm_obj_entry_markup_filter_append for more information.

Parameters

  [in] | data | The user data passed when adding the function.

Referenced by elm_entry_markup_filter_remove().

## ◆ elm_obj_entry_password_get()

EOAPI Eina_Bool elm_obj_entry_password_get | ( | void |  | ) |

Get whether the entry is set to password mode.

Returns
  If true, password mode is enabled.

Referenced by elm_entry_password_get().

## ◆ elm_obj_entry_password_set()

EOAPI void elm_obj_entry_password_set | ( | Eina_Bool | password | ) |

Sets the entry to password mode.

In password mode, entries are implicitly single line and the display of any text in them is replaced with asterisks (*).

Parameters

  [in] | password | If true, password mode is enabled.

Referenced by elm_entry_password_set().

## ◆ elm_obj_entry_prediction_allow_get()

EOAPI Eina_Bool elm_obj_entry_prediction_allow_get | ( | void |  | ) |

Get whether the entry should allow to use the text prediction.

Returns
  Whether the entry should allow to use the text prediction.

Referenced by elm_entry_prediction_allow_get().

## ◆ elm_obj_entry_prediction_allow_set()

EOAPI void elm_obj_entry_prediction_allow_set | ( | Eina_Bool | prediction | ) |

Set whether the entry should allow to use the text prediction.

Parameters

  [in] | prediction | Whether the entry should allow to use the text prediction.

Referenced by elm_entry_prediction_allow_set().

## ◆ elm_obj_entry_scrollable_get()

EOAPI Eina_Bool elm_obj_entry_scrollable_get | ( | void |  | ) |

Get the scrollable state of the entry.

Normally the entry is not scrollable. This gets the scrollable state of the entry.

Returns
  `true` if it is to be scrollable, `false` otherwise.

Referenced by elm_entry_scrollable_get().

## ◆ elm_obj_entry_scrollable_set()

EOAPI void elm_obj_entry_scrollable_set | ( | Eina_Bool | scroll | ) |

Enable or disable scrolling in entry.

Normally the entry is not scrollable unless you enable it with this call.

Parameters

  [in] | scroll | `true` if it is to be scrollable, `false` otherwise.

Referenced by elm_entry_scrollable_set().

## ◆ elm_obj_entry_select_region_set()

EOAPI void elm_obj_entry_select_region_set | ( | int | start,
|  | int | end
| ) |  |

This selects a region of text within the entry.

Parameters

  [in] | start | The starting position.
  [in] | end | The end position.

Since
  1.9

Referenced by elm_entry_select_region_set().

## ◆ elm_obj_entry_selection_get()

EOAPI const char* elm_obj_entry_selection_get | ( | void |  | ) |

Get any selected text within the entry.

If there's any selected text in the entry, this function returns it as a string in markup format. `null` is returned if no selection exists or if an error occurred.

The returned value points to an internal string and should not be freed or modified in any way. If the `entry` object is deleted or its contents are changed, the returned pointer should be considered invalid.

Referenced by elm_entry_selection_get().

## ◆ elm_obj_entry_selection_handler_disabled_get()

EOAPI Eina_Bool elm_obj_entry_selection_handler_disabled_get | ( | void |  | ) |

This returns whether the entry's selection handlers are disabled.

Returns
  If `true`, the selection handlers are disabled.

## ◆ elm_obj_entry_selection_handler_disabled_set()

EOAPI void elm_obj_entry_selection_handler_disabled_set | ( | Eina_Bool | disabled | ) |

This disabled the entry's selection handlers.

Parameters

  [in] | disabled | If `true`, the selection handlers are disabled.

Referenced by elm_entry_selection_handler_disabled_set().

## ◆ elm_obj_entry_single_line_get()

EOAPI Eina_Bool elm_obj_entry_single_line_get | ( | void |  | ) |

Get whether the entry is set to be single line.

Returns
  If true, the text in the entry will be on a single line.

Referenced by elm_entry_single_line_get().

## ◆ elm_obj_entry_single_line_set()

EOAPI void elm_obj_entry_single_line_set | ( | Eina_Bool | single_line | ) |

Sets the entry to single line mode.

In single line mode, entries don't ever wrap when the text reaches the edge, and instead they keep growing horizontally. Pressing the `Enter` key will generate an $"activate" event instead of adding a new line.

When `single_line` is `false`, line wrapping takes effect again and pressing enter will break the text into a different line without generating any events.

Parameters

  [in] | single_line | If true, the text in the entry will be on a single line.

Referenced by elm_entry_single_line_set().

## ◆ elm_obj_entry_text_style_user_peek()

EOAPI const char* elm_obj_entry_text_style_user_peek | ( | void |  | ) |

Get the style on the top of user style stack.

See also elm_obj_entry_text_style_user_push.

Since
  1.7

Referenced by elm_entry_text_style_user_peek().

## ◆ elm_obj_entry_text_style_user_pop()

EOAPI void elm_obj_entry_text_style_user_pop | ( | void |  | ) |

Remove the style in the top of user style stack.

Since
  1.7

Referenced by elm_entry_text_style_user_pop().

## ◆ elm_obj_entry_text_style_user_push()

EOAPI void elm_obj_entry_text_style_user_push | ( | const char * | style | ) |

Push the style to the top of user style stack.

If there is styles in the user style stack, the properties in the top style of user style stack will replace the properties in current theme. The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').

Parameters

  [in] | style | The style user to push.

Since
  1.7

Referenced by elm_entry_text_style_user_push().

## ◆ elm_obj_entry_textblock_get()

EOAPI Evas_Object* elm_obj_entry_textblock_get | ( | void |  | ) |

Returns the actual textblock object of the entry.

This function exposes the internal textblock object that actually contains and draws the text. This should be used for low-level manipulations that are otherwise not possible.

Changing the textblock directly from here will not notify edje/elm to recalculate the textblock size automatically, so any modifications done to the textblock returned by this function should be followed by a call to elm_entry_calc_force.

The return value is marked as const as an additional warning. One should not use the returned object with any of the generic evas functions (geometry_get/resize/move and etc), but only with the textblock functions; The former will either not work at all, or break the correct functionality.

IMPORTANT: Many functions may change (i.e delete and create a new one) the internal textblock object. Do NOT cache the returned object, and try not to mix calls on this object with regular elm_entry calls (which may change the internal textblock object). This applies to all cursors returned from textblock calls, and all the other derivative values.

Referenced by elm_entry_textblock_get().