Tizen Native API

An entry is a convenience widget that shows a box in which the user can enter text.

entry_inheritance_tree.png

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 the multi line mode they support text wrapping in any of the modes indicated by Elm_Wrap_Type.

Other features include the 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 (EFL) :
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 (EFL) :
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 mentioned for each case of deprecation here. Eventually the deprecated ones are discarded (next major release).

Formatted text

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

  • <br>: Inserts a line break.
  • <ps>: Inserts a paragraph separator. This is preferred over line breaks.
  • <tab>: Inserts a tab.
  • <em>...</em>: Emphasizes text. 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.

Special markups

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

Anchors

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

 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 is used to identify the anchor. It can be any valid UTF8 string.

When an anchor is clicked, an "anchor,clicked" signal is emitted with Elm_Entry_Anchor_Info in the event_info parameter for the callback function. The same applies for the "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, for example:

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

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

  • absize: Absolute pixel size for the item. Whatever value is set becomes the item's size regardless of any scale value the object may have been set to. The final line height is 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 given a vsize value that affects how their final size and position is calculated. The possible values are:

  • ascent: Item is 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 is added to the total line height to make them fit. relsize items are adjusted to fit within this space.
  • full: Items are placed between the descent and ascent, or the lowest and highest point in the line.

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 indicates the baseline, and red indicates the descent.

entry_item.png

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 2.0.

entry_item_scale.png

After the size for an item is calculated, the entry requests an object to place in its space. For this, the functions set with elm_entry_item_provider_append() and other related functions are 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 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 then uses that image for the item.

Setting entry's style

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

You should modify the theme when you want to change the style for aesthetic reasons. While the user style should be changed when you want to change the style to something specifically 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(). Files can be loaded directly as plain text or can have any recognized markup in them. See elm_entry_file_set() for more details.

Emitted signals

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

  • "changed": The text within the entry is changed.
  • "changed,user": The text within the entry is changed because of user interaction.
  • "activated": The enter key is pressed on a single line entry.
  • "aborted": The escape key is pressed on a single line entry. (since 1.7)
  • "press": A mouse button has been pressed on the entry.
  • "longpressed": A mouse button has been pressed and held for a couple of seconds.
  • "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.
  • "focused": The entry has received focus.
  • "unfocused": The entry has lost focus.
  • "selection,paste": A paste of the clipboard contents has been requested.
  • "selection,copy": A copy of the selected text into the clipboard has been requested.
  • "selection,cut": A cut of the selected text into the clipboard has been requested.
  • "selection,start": A selection has begun and no previous selection existed.
  • "selection,changed": The current selection has changed.
  • "selection,cleared": The current selection has been cleared.
  • "cursor,changed": The cursor has changed position.
  • "anchor,clicked": An anchor has been clicked. The event_info parameter for the callback is Elm_Entry_Anchor_Info.
  • "anchor,in": The mouse cursor has moved into an anchor. The event_info parameter for the callback is Elm_Entry_Anchor_Info.
  • "anchor,out": The mouse cursor has moved out of an anchor. The event_info parameter for the callback is Elm_Entry_Anchor_Info.
  • "anchor,up": The mouse button has been unpressed on an anchor. The event_info parameter for the callback is Elm_Entry_Anchor_Info.
  • "anchor,down": The muse button has been pressed on an anchor. The event_info parameter for the callback is Elm_Entry_Anchor_Info.
  • "preedit,changed": The preedit string has changed.
  • "language,changed": The program language has changed.

The default content parts of the entry items that you can use are:

  • "icon" - An icon in the entry
  • "end" - Content at the end of the entry

The default text parts of the entry that you can use are:

  • "default" - Text of the entry

Supported common elm_object APIs.

Functions

Evas_Objectelm_entry_add (Evas_Object *parent)
 Adds an entry to the parent object.
void elm_entry_text_style_user_push (Evas_Object *obj, const char *style)
 Pushes the style to the top of the user style stack.
void elm_entry_text_style_user_pop (Evas_Object *obj)
 Removes the style at the top of the user style stack.
const char * elm_entry_text_style_user_peek (const Evas_Object *obj)
 Retrieves the style on the top of the user style stack.
void elm_entry_single_line_set (Evas_Object *obj, Eina_Bool single_line)
 Sets the entry to the single line mode.
Eina_Bool elm_entry_single_line_get (const Evas_Object *obj)
 Gets whether the entry is set to be on a single line.
void elm_entry_password_set (Evas_Object *obj, Eina_Bool password)
 Sets the entry to the password mode.
Eina_Bool elm_entry_password_get (const Evas_Object *obj)
 Gets whether the entry is set to the password mode.
void elm_entry_entry_set (Evas_Object *obj, const char *entry)
 Sets the text displayed within the entry to entry.
const char * elm_entry_entry_get (const Evas_Object *obj)
 Returns the text currently shown in the object entry.
void elm_entry_entry_append (Evas_Object *obj, const char *entry)
 Appends entry to the text of the entry.
Eina_Bool elm_entry_is_empty (const Evas_Object *obj)
 Gets whether the entry is empty.
const char * elm_entry_selection_get (const Evas_Object *obj)
 Gets any selected text within the entry.
Evas_Objectelm_entry_textblock_get (Evas_Object *obj)
 Returns the actual textblock object of the entry.
void elm_entry_calc_force (Evas_Object *obj)
 Forces calculation of the entry size and text layouting.
void elm_entry_entry_insert (Evas_Object *obj, const char *entry)
 Inserts the given text into the entry at the current cursor position.
void elm_entry_line_wrap_set (Evas_Object *obj, Elm_Wrap_Type wrap)
 Sets the line wrap type to use on multi-line entries.
Elm_Wrap_Type elm_entry_line_wrap_get (const Evas_Object *obj)
 Gets the wrap mode that the entry is set to use.
void elm_entry_editable_set (Evas_Object *obj, Eina_Bool editable)
 Sets whether the entry is editable.
Eina_Bool elm_entry_editable_get (const Evas_Object *obj)
 Gets whether the entry is editable.
void elm_entry_select_none (Evas_Object *obj)
 Drops any existing text selection within the entry.
void elm_entry_select_all (Evas_Object *obj)
 Selects all the text within the entry.
Eina_Bool elm_entry_cursor_next (Evas_Object *obj)
 Moves the cursor by one position to the right within the entry.
Eina_Bool elm_entry_cursor_prev (Evas_Object *obj)
 Moves the cursor one place to the left within the entry.
Eina_Bool elm_entry_cursor_up (Evas_Object *obj)
 Moves the cursor one line up within the entry.
Eina_Bool elm_entry_cursor_down (Evas_Object *obj)
 Moves the cursor one line down within the entry.
void elm_entry_cursor_begin_set (Evas_Object *obj)
 Moves the cursor to the beginning of the entry.
void elm_entry_cursor_end_set (Evas_Object *obj)
 Moves the cursor to the end of the entry.
void elm_entry_cursor_line_begin_set (Evas_Object *obj)
 Moves the cursor to the beginning of the current line.
void elm_entry_cursor_line_end_set (Evas_Object *obj)
 Moves the cursor to the end of the current line.
void elm_entry_cursor_selection_begin (Evas_Object *obj)
 Begins a selection within the entry as though the user were holding down the mouse button to make a selection.
void elm_entry_cursor_selection_end (Evas_Object *obj)
 Ends a selection within the entry as though the user had just released the mouse button while making a selection.
Eina_Bool elm_entry_cursor_is_format_get (const Evas_Object *obj)
 Gets whether a format node exists at the current cursor position.
Eina_Bool elm_entry_cursor_is_visible_format_get (const Evas_Object *obj)
 Gets if the current cursor position holds a visible format node.
char * elm_entry_cursor_content_get (const Evas_Object *obj)
 Gets the character pointed by the cursor at its current position.
Eina_Bool elm_entry_cursor_geometry_get (const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
 Returns the geometry of the cursor.
void elm_entry_cursor_pos_set (Evas_Object *obj, int pos)
 Sets the cursor position in the entry to the given value.
int elm_entry_cursor_pos_get (const Evas_Object *obj)
 Retrieves the current position of the cursor in the entry.
void elm_entry_selection_cut (Evas_Object *obj)
 Executes a "cut" action on the selected text in the entry.
void elm_entry_selection_copy (Evas_Object *obj)
 Executes a "copy" action on the selected text in the entry.
void elm_entry_selection_paste (Evas_Object *obj)
 Executes a "paste" action in the entry.
void elm_entry_context_menu_clear (Evas_Object *obj)
 Clears and frees the items in a entry's contextual (longpress) menu.
void elm_entry_context_menu_item_add (Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data)
 Adds an item to the entry's contextual menu.
void elm_entry_context_menu_disabled_set (Evas_Object *obj, Eina_Bool disabled)
 Disables the entry's contextual (longpress) menu.
Eina_Bool elm_entry_context_menu_disabled_get (const Evas_Object *obj)
 Returns whether the entry's contextual (longpress) menu is disabled.
void elm_entry_item_provider_append (Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data)
 Appends a custom item provider to the list for that entry.
void elm_entry_item_provider_prepend (Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data)
 Prepends a custom item provider to the list for that entry.
void elm_entry_item_provider_remove (Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data)
 Removes a custom item provider to the list for that entry.
void elm_entry_markup_filter_append (Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data)
 Appends a markup filter function for text inserted in the entry.
void elm_entry_markup_filter_prepend (Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data)
 Prepends a markup filter function for text inserted in the entry.
void elm_entry_markup_filter_remove (Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data)
 Removes a markup filter from the list.
char * elm_entry_markup_to_utf8 (const char *s)
 Converts a markup (HTML-like) string into UTF-8.
char * elm_entry_utf8_to_markup (const char *s)
 Converts a UTF-8 string into markup (HTML-like).
Eina_Bool elm_entry_file_set (Evas_Object *obj, const char *file, Elm_Text_Format format)
 Sets the file (and implicitly loads it) for the text to display and then allow 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).
void elm_entry_file_get (const Evas_Object *obj, const char **file, Elm_Text_Format *format)
 Gets the file being edited by the entry.
void elm_entry_file_save (Evas_Object *obj)
 Writes any changes made to the file that is set by elm_entry_file_set().
void elm_entry_autosave_set (Evas_Object *obj, Eina_Bool autosave)
 Sets the entry object to 'autosave' the loaded text file.
Eina_Bool elm_entry_autosave_get (const Evas_Object *obj)
 Gets the entry object's 'autosave' status.
void elm_entry_scrollable_set (Evas_Object *obj, Eina_Bool scroll)
 Enables or disables scrolling in the entry.
Eina_Bool elm_entry_scrollable_get (const Evas_Object *obj)
 Gets the scrollable state of the entry.
void elm_entry_icon_visible_set (Evas_Object *obj, Eina_Bool setting)
 Sets the visibility of the left-side widget of the entry that is set by elm_object_part_content_set().
void elm_entry_input_panel_layout_set (Evas_Object *obj, Elm_Input_Panel_Layout layout)
 Sets the input panel layout of the entry.
Elm_Input_Panel_Layout elm_entry_input_panel_layout_get (const Evas_Object *obj)
 Gets the input panel layout of the entry.
void elm_entry_input_panel_layout_variation_set (Evas_Object *obj, int variation)
 Sets the input panel layout variation of the entry.
int elm_entry_input_panel_layout_variation_get (const Evas_Object *obj)
 Gets the input panel layout variation of the entry.
void elm_entry_autocapital_type_set (Evas_Object *obj, Elm_Autocapital_Type autocapital_type)
 Sets the autocapitalization type on the immodule.
Elm_Autocapital_Type elm_entry_autocapital_type_get (const Evas_Object *obj)
 Retrieves the autocapitalization type on the immodule.
void elm_entry_input_panel_enabled_set (Evas_Object *obj, Eina_Bool enabled)
 Sets the attribute to show the input panel automatically.
Eina_Bool elm_entry_input_panel_enabled_get (const Evas_Object *obj)
 Retrieves the attribute to show the input panel automatically.
void elm_entry_input_panel_show (Evas_Object *obj)
 Shows the input panel (virtual keyboard) based on the input panel property of the entry such as layout, autocapital types, and so on.
void elm_entry_input_panel_hide (Evas_Object *obj)
 Hides the input panel (virtual keyboard).
void elm_entry_input_panel_language_set (Evas_Object *obj, Elm_Input_Panel_Lang lang)
 Sets the language mode of the input panel.
Elm_Input_Panel_Lang elm_entry_input_panel_language_get (const Evas_Object *obj)
 Gets the language mode of the input panel.
void elm_entry_input_panel_imdata_set (Evas_Object *obj, const void *data, int len)
 Sets the input panel specific data to deliver to the input panel.
void elm_entry_input_panel_imdata_get (const Evas_Object *obj, void *data, int *len)
 Gets the specific data of the current input panel.
void elm_entry_input_panel_return_key_type_set (Evas_Object *obj, Elm_Input_Panel_Return_Key_Type return_key_type)
 Sets the "return" key type. This type is used to set the string or icon on the "return" key of the input panel.
Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get (const Evas_Object *obj)
 Gets the "return" key type.
void elm_entry_input_panel_return_key_disabled_set (Evas_Object *obj, Eina_Bool disabled)
 Sets the return key to be disabled on the input panel.
Eina_Bool elm_entry_input_panel_return_key_disabled_get (const Evas_Object *obj)
 Gets whether the return key on the input panel should be disabled.
void elm_entry_input_panel_return_key_autoenabled_set (Evas_Object *obj, Eina_Bool enabled)
 Sets whether the return key on the input panel is disabled automatically when the entry has no text.
void elm_entry_input_panel_show_on_demand_set (Evas_Object *obj, Eina_Bool ondemand)
 Sets the attribute to show the input panel in case of a user's explicit Mouse Up event.
Eina_Bool elm_entry_input_panel_show_on_demand_get (const Evas_Object *obj)
 Gets the attribute to show the input panel in case of a user's explicit Mouse Up event.
void elm_entry_input_hint_set (Evas_Object *obj, Elm_Input_Hints hints)
 Sets the input hint which allows input methods to fine-tune their behavior.
Elm_Input_Hints elm_entry_input_hint_get (const Evas_Object *obj)
 Gets the value of input hint.
void elm_entry_imf_context_reset (Evas_Object *obj)
 Resets the input method context of the entry if needed.
void elm_entry_prediction_allow_set (Evas_Object *obj, Eina_Bool prediction)
 Sets whether the entry should allow the use of text prediction.
Eina_Bool elm_entry_prediction_allow_get (const Evas_Object *obj)
 Gets whether the entry should allow the use of text prediction.
void elm_entry_filter_limit_size (void *data, Evas_Object *entry, char **text)
 Filters the inserted text based on user defined character and byte limits.
void elm_entry_filter_accept_set (void *data, Evas_Object *entry, char **text)
 Filters inserted text based on accepted or rejected sets of characters.
void * elm_entry_imf_context_get (Evas_Object *obj)
 Returns the input method context of the entry.
void elm_entry_cnp_mode_set (Evas_Object *obj, Elm_Cnp_Mode cnp_mode)
 Controls pasting of text and images for the widget.
Elm_Cnp_Mode elm_entry_cnp_mode_get (const Evas_Object *obj)
 Gets the elm_entry text paste/drop mode.
void elm_entry_anchor_hover_parent_set (Evas_Object *obj, Evas_Object *parent)
 Sets the parent of the hover popup.
Evas_Objectelm_entry_anchor_hover_parent_get (const Evas_Object *obj)
 Gets the parent of the hover popup.
void elm_entry_anchor_hover_style_set (Evas_Object *obj, const char *style)
 Sets the style that the hover should use.
const char * elm_entry_anchor_hover_style_get (const Evas_Object *obj)
 Gets the style that the hover should use.
void elm_entry_anchor_hover_end (Evas_Object *obj)
 Ends the hover popup in the entry.
void elm_entry_select_region_set (Evas_Object *obj, int start, int end)
 This selects a region of text within the entry.

Typedefs

typedef struct
_Elm_Entry_Anchor_Info 
Elm_Entry_Anchor_Info
 The information 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 information sent in the callback for "anchor,clicked" signals emitted by the Anchor_Hover widget.
typedef Evas_Object *(* Elm_Entry_Item_Provider_Cb )(void *data, Evas_Object *entry, const char *item)
 Called to provide items.
typedef void(* Elm_Entry_Filter_Cb )(void *data, Evas_Object *entry, char **text)
 Called by entry filters to modify text.
typedef Edje_Entry_Change_Info Elm_Entry_Change_Info
 This corresponds to Edje_Entry_Change_Info. It includes information about a change in the entry.
typedef struct
_Elm_Entry_Filter_Limit_Size 
Elm_Entry_Filter_Limit_Size
 The data for the elm_entry_filter_limit_size() entry filter.
typedef struct
_Elm_Entry_Filter_Accept_Set 
Elm_Entry_Filter_Accept_Set
 The data for the elm_entry_filter_accept_set() entry filter.

Typedef Documentation

Called by entry filters to modify text.

Since :
2.3.1
Parameters:
dataThe data specified as the last parameter when adding the filter
entryThe entry object
textA 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

Called to provide items.

Since :
2.3.1
Remarks:
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, then the next provider is called until it provides an item object, or the default provider in entry does.
Parameters:
[in]dataThe data specified as the last parameter when adding the provider
[in]entryThe entry object
[in]textA pointer to the item href string in the text
Returns:
The object to be placed in the entry like an icon, or another element
See also:
elm_entry_item_provider_append
elm_entry_item_provider_prepend
elm_entry_item_provider_remove

Enumeration Type Documentation

anonymous enum
Enumerator:
ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_NORMAL 

The plain normal layout

Since (EFL) :
1.12
ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_FILENAME 

Filename layout. Symbols such as '/' should be disabled.

Since (EFL) :
1.12
ELM_INPUT_PANEL_LAYOUT_NORMAL_VARIATION_PERSON_NAME 

The name of a person.

Since (EFL) :
1.12
anonymous enum
Enumerator:
ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_NORMAL 

The plain normal number layout

Since (EFL) :
1.8
ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED 

The number layout to allow a positive or negative sign at the start

Since (EFL) :
1.8
ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_DECIMAL 

The number layout to allow decimal point to provide fractional value

Since (EFL) :
1.8
ELM_INPUT_PANEL_LAYOUT_NUMBERONLY_VARIATION_SIGNED_AND_DECIMAL 

The number layout to allow decimal point and negative sign

Since (EFL) :
1.8
anonymous enum
Enumerator:
ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NORMAL 

The normal password layout

Since (EFL) :
1.12
ELM_INPUT_PANEL_LAYOUT_PASSWORD_VARIATION_NUMBERONLY 

The password layout to allow only number

Since (EFL) :
1.12

Enumeration that defines the autocapitalization types.

See also:
elm_entry_autocapital_type_set()
Enumerator:
ELM_AUTOCAPITAL_TYPE_NONE 

No autocapitalization when typing

ELM_AUTOCAPITAL_TYPE_WORD 

Autocapitalize each typed word

ELM_AUTOCAPITAL_TYPE_SENTENCE 

Autocapitalize the start of each sentence

ELM_AUTOCAPITAL_TYPE_ALLCHARACTER 

Autocapitalize all letters

Enumeration that defines the 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

Enumeration that defines the types of Input Hints.

Since (EFL) :
1.12
Enumerator:
ELM_INPUT_HINT_NONE 

No active hints

Since (EFL) :
1.12
ELM_INPUT_HINT_AUTO_COMPLETE 

suggest word auto completion

Since (EFL) :
1.12
ELM_INPUT_HINT_SENSITIVE_DATA 

typed text should not be stored.

Since (EFL) :
1.12

Enumeration that defines the input panel (virtual keyboard) language modes.

See also:
elm_entry_input_panel_language_set()
Enumerator:
ELM_INPUT_PANEL_LANG_AUTOMATIC 

Automatic language mode

ELM_INPUT_PANEL_LANG_ALPHABET 

Alphabet language mode

Enumeration that defines the input panel (virtual keyboard) layout types.

See also:
elm_entry_input_panel_layout_set()
Enumerator:
ELM_INPUT_PANEL_LAYOUT_NORMAL 

Default layout

ELM_INPUT_PANEL_LAYOUT_NUMBER 

Number layout

ELM_INPUT_PANEL_LAYOUT_EMAIL 

Email layout

ELM_INPUT_PANEL_LAYOUT_URL 

URL layout

ELM_INPUT_PANEL_LAYOUT_PHONENUMBER 

Phone number layout

ELM_INPUT_PANEL_LAYOUT_IP 

IP layout

ELM_INPUT_PANEL_LAYOUT_MONTH 

Month layout

ELM_INPUT_PANEL_LAYOUT_NUMBERONLY 

Number only layout

ELM_INPUT_PANEL_LAYOUT_INVALID 

Invalid layout(not recommended)

ELM_INPUT_PANEL_LAYOUT_HEX 

Hexadecimal layout

ELM_INPUT_PANEL_LAYOUT_TERMINAL 

Command-line terminal layout including the esc, alt, ctrl key and so on (no auto-correct, no auto-capitalization)

ELM_INPUT_PANEL_LAYOUT_PASSWORD 

Like normal, but no auto-correct, no auto-capitalization

ELM_INPUT_PANEL_LAYOUT_DATETIME 

Date and time layout

Since (EFL) :
1.8
ELM_INPUT_PANEL_LAYOUT_EMOTICON 

Emoticon layout

Since (EFL) :
1.10

Enumeration that defines the "Return" key types on the input panel (virtual keyboard).

See also:
elm_entry_input_panel_return_key_type_set()
Enumerator:
ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT 

Default key type

ELM_INPUT_PANEL_RETURN_KEY_TYPE_DONE 

Done key type

ELM_INPUT_PANEL_RETURN_KEY_TYPE_GO 

Go key type

ELM_INPUT_PANEL_RETURN_KEY_TYPE_JOIN 

Join key type

ELM_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN 

Login key type

ELM_INPUT_PANEL_RETURN_KEY_TYPE_NEXT 

Next key type

ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH 

Search string or magnifier icon key type

ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEND 

Send key type

ELM_INPUT_PANEL_RETURN_KEY_TYPE_SIGNIN 

Sign-in key type

Since (EFL) :
1.8

Enumeration that defines the text format types.

See also:
elm_entry_file_set()
Enumerator:
ELM_TEXT_FORMAT_PLAIN_UTF8 

Plain UTF8 type

ELM_TEXT_FORMAT_MARKUP_UTF8 

Markup UTF8 type

Enumeration that defines the line wrapping types.

See also:
elm_entry_line_wrap_set()
Enumerator:
ELM_WRAP_NONE 

No wrap - value is zero

ELM_WRAP_CHAR 

Char wrap - wrap between characters

ELM_WRAP_WORD 

Word wrap - wrap within the allowed wrapping points (as defined in the unicode standard)

ELM_WRAP_MIXED 

Mixed wrap - Word wrap, if that fails, char wrap


Function Documentation

Adds an entry to the parent object.

Since :
2.3.1
Remarks:
By default, entries are as follows:
  • not scrolled
  • multi-line
  • word wrapped
  • autosave is enabled
Parameters:
[in]parentThe parent object
Returns:
The new object, otherwise NULL if it cannot be created

Ends the hover popup in the entry.

Since :
2.3.1
Remarks:
When an anchor is clicked, the entry widget creates a hover object to use as a popup with user provided content. This function terminates this popup, returning the entry to its normal state.
Parameters:
[in]objThe entry object

Gets the parent of the hover popup.

This gets the object used as parent for the hover created by the entry widget. If no parent is set, the same entry object is used.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The object used as parent for the hover, otherwise NULL if none are set
See also:
Hover

Sets the parent of the hover popup.

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

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]parentThe object to use as a parent for the hover
See also:
Hover
const char* elm_entry_anchor_hover_style_get ( const Evas_Object obj)

Gets the style that the hover should use.

This gets the style that the hover created by the entry uses.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The style to use by the hover
NULL means the default is used.
See also:
elm_object_style_set()
void elm_entry_anchor_hover_style_set ( Evas_Object obj,
const char *  style 
)

Sets the style that the hover should use.

Since :
2.3.1
Remarks:
When creating the popup hover, the entry requests that it be themed according to style.
Setting style to NULL means disabling automatic hover.
Parameters:
[in]objThe entry object
[in]styleThe style to use for the underlying hover
See also:
elm_object_style_set()

Retrieves the autocapitalization type on the immodule.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The autocapitalization type
void elm_entry_autocapital_type_set ( Evas_Object obj,
Elm_Autocapital_Type  autocapital_type 
)

Sets the autocapitalization type on the immodule.

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]autocapital_typeThe type of autocapitalization

Gets the entry object's 'autosave' status.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The boolean value that indicates whether the loaded file is autosaved
See also:
elm_entry_file_set()
void elm_entry_autosave_set ( Evas_Object obj,
Eina_Bool  autosave 
)

Sets the entry object to 'autosave' the loaded text file.

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]autosaveThe boolean value that indicates whether the loaded file is autosaved
See also:
elm_entry_file_set()

Forces calculation of the entry size and text layouting.

Since :
2.3.1
Remarks:
This should be used after modifying the textblock object directly. See elm_entry_textblock_get() for more information.
Parameters:
[in]objThe entry object
See also:
elm_entry_textblock_get()

Gets the elm_entry text paste/drop mode.

Since :
2.3.1
Remarks:
Normally the entry allows both text and images to be pasted. This gets the copy & paste mode of the entry.
Parameters:
[in]objThe entry object
Returns:
mode One Elm_Cnp_Mode: ELM_CNP_MODE_MARKUP, ELM_CNP_MODE_NO_IMAGE, ELM_CNP_MODE_PLAINTEXT.
void elm_entry_cnp_mode_set ( Evas_Object obj,
Elm_Cnp_Mode  cnp_mode 
)

Controls pasting of text and images for the widget.

Since :
2.3.1
Remarks:
Normally the entry allows both text and images to be pasted. Setting cnp_mode to ELM_CNP_MODE_NO_IMAGE, prevents images from being copied or pasted. Setting cnp_mode to ELM_CNP_MODE_PLAINTEXT, removes all tags in the text.
Parameters:
[in]objThe entry object
[in]cnp_modeOne Elm_Cnp_Mode: ELM_CNP_MODE_MARKUP, ELM_CNP_MODE_NO_IMAGE, ELM_CNP_MODE_PLAINTEXT
Remarks:
This only changes the behaviour of the text.

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

Since :
2.3.1
Parameters:
[in]objThe entry object
See also:
elm_entry_context_menu_item_add()

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

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
true if the menu is disabled, otherwise false

Disables the entry's contextual (longpress) menu.

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]disabledIf true the menu is disabled, otherwise false to enable it
void elm_entry_context_menu_item_add ( Evas_Object obj,
const char *  label,
const char *  icon_file,
Elm_Icon_Type  icon_type,
Evas_Smart_Cb  func,
const void *  data 
)

Adds an item to the entry's contextual menu.

Since :
2.3.1
Remarks:
A longpress on an entry makes 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 the 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]objThe entry object
[in]labelThe item's text label
[in]icon_fileThe item's icon file
[in]icon_typeThe item's icon type
[in]funcThe callback to execute when the item is clicked
[in]dataThe data to associate with the item for related functions

Moves the cursor to the beginning of the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
char* elm_entry_cursor_content_get ( const Evas_Object obj)

Gets 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 is not going to be a part of the return value. The string must be released with free() by you.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The text pointed by the cursor

Moves the cursor one line down within the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE on success, otherwise EINA_FALSE on failure

Moves the cursor to the end of the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object

Returns the geometry of the cursor.

Since :
2.3.1
Remarks:
It's useful if you want to draw something on the cursor (or where it is), or for example in case of a scrolled entry where you want to show the cursor.
Parameters:
[in]objThe entry object
[out]xThe returned geometry
[out]yThe returned geometry
[out]wThe returned geometry
[out]hThe returned geometry
Returns:
EINA_TRUE upon success, otherwise EINA_FALSE on failure

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

Since :
2.3.1
Remarks:
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.
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE if the current cursor position contains a format node, otherwise EINA_FALSE
See also:
elm_entry_cursor_is_visible_format_get()

Gets if the current cursor position holds a visible format node.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE if the current cursor is a visible format, otherwise EINA_FALSE if it's an invisible one or no format exists
See also:
elm_entry_cursor_is_format_get()

Moves the cursor to the beginning of the current line.

Since :
2.3.1
Parameters:
[in]objThe entry object

Moves the cursor to the end of the current line.

Since :
2.3.1
Parameters:
[in]objThe entry object

Moves the cursor by one position to the right within the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE on success, otherwise EINA_FALSE on failure
int elm_entry_cursor_pos_get ( const Evas_Object obj)

Retrieves the current position of the cursor in the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The cursor position
void elm_entry_cursor_pos_set ( Evas_Object obj,
int  pos 
)

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

Since :
2.3.1
Remarks:
The value in pos is the index of the character position within the content of the string as returned by elm_entry_cursor_pos_get().
Parameters:
[in]objThe entry object
[in]posThe position of the cursor

Moves the cursor one place to the left within the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE on success, otherwise EINA_FALSE on failure

Begins a selection within the entry as though the user were holding down the mouse button to make a selection.

Since :
2.3.1
Parameters:
[in]objThe entry object

Ends a selection within the entry as though the user had just released the mouse button while making a selection.

Since :
2.3.1
Parameters:
[in]objThe entry object

Moves the cursor one line up within the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE on success, otherwise EINA_FALSE on failure

Gets whether the entry is editable.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
true if the entry is editable by the user, otherwise @ false if it is not editable by the user
See also:
elm_entry_editable_set()
void elm_entry_editable_set ( Evas_Object obj,
Eina_Bool  editable 
)

Sets whether the entry is editable.

Since :
2.3.1
Remarks:
By default, entries are editable and when focused, any text input by the user is inserted at the current cursor position. But calling this function with editable as EINA_FALSE prevents the user from inputing 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]objThe entry object
[in]editableIf EINA_TRUE user input is inserted in the entry, otherwise EINA_FALSE if the entry is read-only and no user input is allowed
void elm_entry_entry_append ( Evas_Object obj,
const char *  entry 
)

Appends entry to the text of the entry.

This adds the text in entry to the end of any text already present in the widget.

Since :
2.3.1
Remarks:
The appended text is subject to any filters set for the widget.
Parameters:
[in]objThe entry object
[in]entryThe text to be displayed
See also:
elm_entry_markup_filter_append()
const char* elm_entry_entry_get ( const Evas_Object obj)

Returns the text currently shown in the object entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The currently displayed text, otherwise NULL on failure
See also:
elm_entry_entry_set()
void elm_entry_entry_insert ( Evas_Object 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 is 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.)

Since :
2.3.1
Remarks:
If any selection exists, it is replaced by the inserted text.
The inserted text is subject to any filters set for the widget.
Parameters:
[in]objThe entry object
[in]entryThe text to insert
See also:
elm_entry_markup_filter_append()
void elm_entry_entry_set ( Evas_Object obj,
const char *  entry 
)

Sets the text displayed within the entry to entry.

Since :
2.3.1
Remarks:
Using this function bypasses text filters
Parameters:
[in]objThe entry object
[in]entryThe text to be displayed
void elm_entry_file_get ( const Evas_Object obj,
const char **  file,
Elm_Text_Format format 
)

Gets 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.

Since :
2.3.1
Parameters:
[in]objThe entry object
[out]fileThe path to the file to load and save
[out]formatThe file format

Writes any changes made to the file that is set by elm_entry_file_set().

Since :
2.3.1
Parameters:
[in]objThe entry object
Eina_Bool elm_entry_file_set ( Evas_Object obj,
const char *  file,
Elm_Text_Format  format 
)

Sets the file (and implicitly loads it) for the text to display and then allow 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).

Since :
2.3.1
Remarks:
If the entry has any other file set previously, any changes made to it are saved if the autosave feature is enabled, otherwise, the file is silently discarded and any non-saved changes are lost.
Parameters:
[in]objThe entry object
[in]fileThe path to the file to load and save
[in]formatThe file format
Returns:
EINA_TRUE on success, otherwise EINA_FALSE on failure
void elm_entry_filter_accept_set ( void *  data,
Evas_Object entry,
char **  text 
)

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

This adds this filter to an entry to restrict the set of accepted characters based on 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.

Since :
2.3.1
Remarks:
The accepted set takes preference, so if it is set, the filter only works 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 with the raw markup text, so it can be used to remove formatted tags.
This filter, like any other, does not apply when setting the entry text directly using elm_object_text_set().
Do not call this function directly. This function should be used for parameterfor as Elm_Entry_Filter_Cb.
Parameters:
dataThe data specified as the last parameter when adding the filter
entryThe entry object
textA 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()
void elm_entry_filter_limit_size ( void *  data,
Evas_Object entry,
char **  text 
)

Filters the inserted text based on user defined character and byte limits.

This adds this filter to an entry to limit the characters that it accepts based on the content 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.

Since :
2.3.1
Remarks:
The user must create an Elm_Entry_Filter_Limit_Size structure and pass it as data when setting the filter. Within it, it's possible to set limits based 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 cuts the inserted text in order to allow only the first few 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.
This filter, like any other, does not apply when setting the entry text directly using elm_object_text_set().
Do not call this function directly. This function should be used for parameterfor as Elm_Entry_Filter_Cb.
Parameters:
dataThe data specified as the last parameter when adding the filter
entryThe entry object
textA 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()
void elm_entry_icon_visible_set ( Evas_Object obj,
Eina_Bool  setting 
)

Sets the visibility of the left-side widget of the entry that is set by elm_object_part_content_set().

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]settingIf EINA_TRUE the object should be displayed, otherwise EINA_FALSE if not

Returns the input method context of the entry.

This function exposes the internal input method context.

Since :
2.3.1
Remarks:
IMPORTANT: Many functions may change (i.e delete and create a new one) the internal input method context. Do NOT cache the returned object.
Parameters:
[in]objThe entry object
Returns:
The input method context (Ecore_IMF_Context *) in the entry

Resets the input method context of the entry if needed.

Since :
2.3.1
Remarks:
This can be necessary in a case where modifying the buffer would confuse an on-going input method behavior. This typically causes the Input Method Context to clear the pre-edit state.
Parameters:
[in]objThe entry object

Gets the value of input hint.

Since (EFL) :
1.12
Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
the value of input hint.

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

Since (EFL) :
1.12
Since :
2.3.1
Parameters:
[in]objThe entry object
[in]hintsinput hint

Retrieves the attribute to show the input panel automatically.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE if the input panel appears when the entry is clicked or has a focus, otherwise EINA_FALSE

Sets the attribute to show the input panel automatically.

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]enabledIf true the input panel appears when the entry is clicked or has focus, otherwise false

Hides the input panel (virtual keyboard).

Since :
2.3.1
Remarks:
Note that the input panel is shown or hidden automatically according to the focus state of the entry widget. This API can be used in case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE)
Parameters:
[in]objThe entry object
void elm_entry_input_panel_imdata_get ( const Evas_Object obj,
void *  data,
int *  len 
)

Gets the specific data of the current input panel.

Since :
2.3.1
Parameters:
[in]objThe entry object
[out]dataThe specific data to be obtained from the input panel
[out]lenThe length of the data
See also:
elm_entry_input_panel_imdata_set
void elm_entry_input_panel_imdata_set ( Evas_Object obj,
const void *  data,
int  len 
)

Sets the input panel specific data to deliver to the input panel.

Since :
2.3.1
Remarks:
This API is used by applications to deliver specific data to the input panel. The data format MUST be negotiated by both the application and the input panel. The size and format of data is defined by the input panel.
Parameters:
[in]objThe entry object
[in]dataThe specific data to be set for the input panel
[in]lenThe length of the data, in bytes, to send to the input panel

Gets the language mode of the input panel.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The input panel language type
See also:
elm_entry_input_panel_language_set

Sets the language mode of the input panel.

Since :
2.3.1
Remarks:
This API can be used if you want to show the alphabet keyboard mode.
Parameters:
[in]objThe entry object
[in]langThe language to be set for the input panel

Gets the input panel layout of the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The layout type
See also:
elm_entry_input_panel_layout_set

Sets the input panel layout of the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]layoutThe layout type

Gets the input panel layout variation of the entry.

Since (EFL) :
1.8
Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The layout variation type
See also:
elm_entry_input_panel_layout_variation_set
void elm_entry_input_panel_layout_variation_set ( Evas_Object obj,
int  variation 
)

Sets the input panel layout variation of the entry.

Since (EFL) :
1.8
Since :
2.3.1
Parameters:
[in]objThe entry object
[in]variationThe layout variation type

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

Since :
2.3.1
Remarks:
If enabled is EINA_TRUE, the return key on the 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 EINA_FALSE.
Parameters:
[in]objThe entry object
[in]enabledIf enabled is EINA_TRUE, the return key is automatically disabled when the entry has no text, otherwise EINA_FALSE

Gets whether the return key on the input panel should be disabled.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE if the return key should be disabled, otherwise EINA_FALSE

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

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]disabledIf EINA_TRUE the return key is disabled, otherwise EINA_FALSE if it is enabled

Gets the "return" key type.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The type of "return" key on the input panel
See also:
elm_entry_input_panel_return_key_type_set()

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

Since :
2.3.1
Remarks:
An input panel displays the string or icon associated with this type.
Parameters:
[in]objThe entry object
[in]return_key_typeThe type of "return" key on the input panel

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

Since :
2.3.1
Remarks:
Note that the input panel is shown or hidden automatically according to the focus state of the entry widget. This API can be used in case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE).
Parameters:
[in]objThe entry object

Gets the attribute to show the input panel in case of a user's explicit Mouse Up event.

Since (EFL) :
1.8
Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE if the input panel is shown in case of a Mouse up event, otherwise EINA_FALSE

Sets the attribute to show the input panel in case of a user's explicit Mouse Up event.

Since (EFL) :
1.8
Since :
2.3.1
Remarks:
It doesn't request to show the input panel even though it has focus.
Parameters:
[in]objThe entry object
[in]ondemandIf true, the input panel is shown in case of a Mouse up event (Focus event is ignored), otherwise false

Gets whether the entry is empty.

Since :
2.3.1
Remarks:
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 EINA_FALSE.
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE if the entry is empty, otherwise EINA_FALSE
void elm_entry_item_provider_append ( Evas_Object obj,
Elm_Entry_Item_Provider_Cb  func,
void *  data 
)

Appends a custom item provider to the list for that entry.

This appends the given callback. The list is walked through from beginning till the end with each function being 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, then the next provider is called until it provides an item object, or the default provider in the entry does.

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]funcThe function that is called to provide the item object
[in]dataThe data passed to func
See also:
Items
void elm_entry_item_provider_prepend ( Evas_Object obj,
Elm_Entry_Item_Provider_Cb  func,
void *  data 
)

Prepends a custom item provider to the list for that entry.

This prepends the given callback. For more details, see elm_entry_item_provider_append().

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]funcThe function that is called to provide the item object
[in]dataThe data passed to func
See also:
elm_entry_item_provider_append()
void elm_entry_item_provider_remove ( Evas_Object obj,
Elm_Entry_Item_Provider_Cb  func,
void *  data 
)

Removes a custom item provider to the list for that entry.

This removes the given callback. For more details, see elm_entry_item_provider_append().

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]funcThe function that is called to provide the item object
[in]dataThe data passed to func

Gets the wrap mode that the entry is set to use.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The wrap type
See also:
elm_entry_line_wrap_set()

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

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

Since :
2.3.1
Remarks:
Note that this only makes sense for multi-line entries. A widget set to be a single line never wraps.
Parameters:
[in]objThe entry object
[in]wrapThe wrap mode to use
For more details, see Elm_Wrap_Type
void elm_entry_markup_filter_append ( Evas_Object obj,
Elm_Entry_Filter_Cb  func,
void *  data 
)

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

This appends the given callback to the list. This functions is called whenever any text is inserted into the entry, provided the text to be inserted is a parameter. The type of the 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 prevents any future filters from being called.

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]funcThe function to use as a text filter
[in]dataThe data to pass to func
void elm_entry_markup_filter_prepend ( Evas_Object obj,
Elm_Entry_Filter_Cb  func,
void *  data 
)

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

This prepends the given callback to the list. For more details, see elm_entry_markup_filter_append().

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]funcThe function to use as a text filter
[in]dataThe data to pass to func
void elm_entry_markup_filter_remove ( Evas_Object obj,
Elm_Entry_Filter_Cb  func,
void *  data 
)

Removes a markup filter from the list.

This removes the given callback from the filter list. For more details, see elm_entry_markup_filter_append().

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]funcThe filter function to remove
[in]dataThe data to pass to func
char* elm_entry_markup_to_utf8 ( const char *  s)

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

Since :
2.3.1
Remarks:
The returned string is a malloc'ed buffer and it should be freed when not needed.
Parameters:
[in]sThe string (in markup) to be converted
Returns:
The converted string (in UTF-8)
It should be freed.

Gets whether the entry is set to the password mode.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
true if the entry is set to display all characters as asterisks (*), otherwise false
See also:
elm_entry_password_set()
void elm_entry_password_set ( Evas_Object obj,
Eina_Bool  password 
)

Sets the entry to the password mode.

Since :
2.3.1
Remarks:
In the password mode, entries are implicitly on a single line and the display of any text in them is replaced with asterisks (*).
Parameters:
[in]objThe entry object
[in]passwordIf true the password mode is enabled, otherwise false to disable it

Gets whether the entry should allow the use of text prediction.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
EINA_TRUE if it allows the use of text prediction, otherwise EINA_FALSE
void elm_entry_prediction_allow_set ( Evas_Object obj,
Eina_Bool  prediction 
)

Sets whether the entry should allow the use of text prediction.

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]predictionThe boolean value that indicates whether the entry should allow the use of text prediction

Gets the scrollable state of the entry.

Since :
2.3.1
Remarks:
Normally, the entry is not scrollable. This gets the scrollable state of the entry. For more details, see elm_entry_scrollable_set().
Parameters:
[in]objThe entry object
Returns:
The scrollable state
void elm_entry_scrollable_set ( Evas_Object obj,
Eina_Bool  scroll 
)

Enables or disables scrolling in the entry.

Since :
2.3.1
Remarks:
Normally, the entry is not scrollable unless you enable it with this call.
Parameters:
[in]objThe entry object
[in]scrollIf EINA_TRUE it is scrollable, otherwise EINA_FALSE

Selects all the text within the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object

Drops any existing text selection within the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
void elm_entry_select_region_set ( Evas_Object obj,
int  start,
int  end 
)

This selects a region of text within the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
[in]startThe starting position
[in]endThe end position

Executes a "copy" action on the selected text in the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object

Executes a "cut" action on the selected text in the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object
const char* elm_entry_selection_get ( const Evas_Object obj)

Gets any selected text within the entry.

Since :
2.3.1
Remarks:
If there's any selected text in the entry, this function returns it as a string in the markup format. NULL is returned if no selection exists or if an error occurs.
The returned value points to an internal string 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.
Parameters:
[in]objThe entry object
Returns:
The selected text within the entry, otherwise NULL on failure

Executes a "paste" action in the entry.

Since :
2.3.1
Parameters:
[in]objThe entry object

Gets whether the entry is set to be on a single line.

Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
single_line true if the text in the entry is set to display on a single line, otherwise false
See also:
elm_entry_single_line_set()
void elm_entry_single_line_set ( Evas_Object obj,
Eina_Bool  single_line 
)

Sets the entry to the single line mode.

Since :
2.3.1
Remarks:
In the single line mode, entries don't wrap when the text reaches the edge, instead they keep growing horizontally. Pressing the Enter key generates an "activate" event instead of adding a new line.
When single_line is EINA_FALSE, line wrapping takes effect again and pressing enter breaks the text into a different line without generating any events.
Parameters:
[in]objThe entry object
[in]single_lineIf true, the text in the entry is on a single line, otherwise false
const char* elm_entry_text_style_user_peek ( const Evas_Object obj)

Retrieves the style on the top of the user style stack.

Since (EFL) :
1.7
Since :
2.3.1
Parameters:
[in]objThe entry object
Returns:
The style on the top of the user style stack if it exists, otherwise NULL
See also:
elm_entry_text_style_user_push()

Removes the style at the top of the user style stack.

Since (EFL) :
1.7
Since :
2.3.1
Parameters:
[in]objThe entry object
See also:
elm_entry_text_style_user_push()
void elm_entry_text_style_user_push ( Evas_Object obj,
const char *  style 
)

Pushes the style to the top of the user style stack.

Since :
2.3.1
Remarks:
If there are styles in the user style stack, the properties in the top style of the user style stack replace the properties in the current theme. The input style is specified in the format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').
Parameters:
[in]objThe entry object
[in]styleThe style user to push
Since (EFL) :
1.7

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.

Since :
2.3.1
Remarks:
Changing the textblock directly from here does not notify edje/elm to recalculate the textblock size automatically, so any modifications done to the textblock and returned by this function should be followed by a call to elm_entry_calc_force().
The return value is marked as const so as to serve as an additional warning. One should not use the returned object with any of the generic evas functions (geometry_get/resize/move and so on), but only with the textblock functions; the former either does not work at all, or breaks 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.
Parameters:
[in]objThe entry object
Returns:
The textblock object
char* elm_entry_utf8_to_markup ( const char *  s)

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

Since :
2.3.1
Remarks:
The returned string is a malloc'ed buffer and it should be freed when not needed.
Parameters:
[in]sThe string (in UTF-8) to be converted
Returns:
The converted string (in markup)
It should be freed.