Tizen Native API
Functions | Typedefs
Entry
Elementary Widgets

Functions

void elm_entry_scrollable_set (Elm_Entry *obj, Eina_Bool scroll)
 Enable or disable scrolling in entry.
Eina_Bool elm_entry_scrollable_get (const Elm_Entry *obj)
 Get the scrollable state of the entry.
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.
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.
void elm_entry_context_menu_disabled_set (Elm_Entry *obj, Eina_Bool disabled)
 This disables the entry's contextual (longpress) menu.
Eina_Bool elm_entry_context_menu_disabled_get (const Elm_Entry *obj)
 This returns whether the entry's contextual (longpress) menu is disabled.
void elm_entry_cnp_mode_set (Elm_Entry *obj, Elm_Cnp_Mode cnp_mode)
 Control pasting of text and images for the widget.
Elm_Cnp_Mode elm_entry_cnp_mode_get (const Elm_Entry *obj)
 Getting elm_entry text paste/drop mode.
void elm_entry_input_panel_language_set (Elm_Entry *obj, Elm_Input_Panel_Lang lang)
 Set the language mode of the input panel.
Elm_Input_Panel_Lang elm_entry_input_panel_language_get (const Elm_Entry *obj)
 Get the language mode of the input panel.
void elm_entry_input_panel_layout_variation_set (Elm_Entry *obj, int variation)
 Set the input panel layout variation of the entry.
int elm_entry_input_panel_layout_variation_get (const Elm_Entry *obj)
 Get the input panel layout variation of the entry.
void elm_entry_autocapital_type_set (Elm_Entry *obj, Elm_Autocapital_Type autocapital_type)
 Set the autocapitalization type on the immodule.
Elm_Autocapital_Type elm_entry_autocapital_type_get (const Elm_Entry *obj)
 Get the autocapitalization type on the immodule.
void elm_entry_editable_set (Elm_Entry *obj, Eina_Bool editable)
 Sets if the entry is to be editable or not.
Eina_Bool elm_entry_editable_get (const Elm_Entry *obj)
 Get whether the entry is editable or not.
void elm_entry_anchor_hover_style_set (Elm_Entry *obj, const char *style)
 Set the style that the hover should use.
const char * elm_entry_anchor_hover_style_get (const Elm_Entry *obj)
 Get the style that the hover should use.
void elm_entry_single_line_set (Elm_Entry *obj, Eina_Bool single_line)
 Sets the entry to single line mode.
Eina_Bool elm_entry_single_line_get (const Elm_Entry *obj)
 Get whether the entry is set to be single line.
void elm_entry_password_set (Elm_Entry *obj, Eina_Bool password)
 Sets the entry to password mode.
Eina_Bool elm_entry_password_get (const Elm_Entry *obj)
 Get whether the entry is set to password mode.
Eina_Bool elm_entry_file_set (Elm_Entry *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).
void elm_entry_file_get (const Elm_Entry *obj, const char **file, Elm_Text_Format *format)
 Get the file being edited by the entry.
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.
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.
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.
Eina_Bool elm_entry_autosave_get (const Elm_Entry *obj)
 This gets the entry object's 'autosave' status.
void elm_entry_anchor_hover_parent_set (Elm_Entry *obj, Evas_Object *parent)
 Set the parent of the hover popup.
Evas_Object * elm_entry_anchor_hover_parent_get (const Elm_Entry *obj)
 Get the parent of the hover popup.
void elm_entry_prediction_allow_set (Elm_Entry *obj, Eina_Bool prediction)
 Set whether the entry should allow to use the text prediction.
Eina_Bool elm_entry_prediction_allow_get (const Elm_Entry *obj)
 Get whether the entry should allow to use the text prediction.
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.
Elm_Input_Hints elm_entry_input_hint_get (const Elm_Entry *obj)
 Gets the value of input hint.
void elm_entry_input_panel_layout_set (Elm_Entry *obj, Elm_Input_Panel_Layout layout)
 Set the input panel layout of the entry.
Elm_Input_Panel_Layout elm_entry_input_panel_layout_get (const Elm_Entry *obj)
 Get the input panel layout of the entry.
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.
Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get (const Elm_Entry *obj)
 Get the "return" key type.
void elm_entry_input_panel_enabled_set (Elm_Entry *obj, Eina_Bool enabled)
 Sets the attribute to show the input panel automatically.
Eina_Bool elm_entry_input_panel_enabled_get (const Elm_Entry *obj)
 Get the attribute to show the input panel automatically.
void elm_entry_line_wrap_set (Elm_Entry *obj, Elm_Wrap_Type wrap)
 Set the line wrap type to use on multi-line entries.
Elm_Wrap_Type elm_entry_line_wrap_get (const Elm_Entry *obj)
 Get the wrap mode the entry was set to use.
void elm_entry_cursor_pos_set (Elm_Entry *obj, int pos)
 Sets the cursor position in the entry to the given value.
int elm_entry_cursor_pos_get (const Elm_Entry *obj)
 Get the current position of the cursor in the entry.
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().
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)
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.
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)
Evas_Object * elm_entry_textblock_get (const Elm_Entry *obj)
 Returns the actual textblock object of the entry.
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.
void * elm_entry_imf_context_get (const Elm_Entry *obj)
 Returns the input method context of the entry.
Eina_Bool elm_entry_cursor_is_format_get (const Elm_Entry *obj)
 Get whether a format node exists at the current cursor position.
char * elm_entry_cursor_content_get (const Elm_Entry *obj)
 Get the character pointed by the cursor at its current position.
const char * elm_entry_selection_get (const Elm_Entry *obj)
 Get any selected text within the entry.
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.
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.
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.
void elm_entry_imf_context_reset (Elm_Entry *obj)
 Reset the input method context of the entry if needed.
void elm_entry_calc_force (Elm_Entry *obj)
 Forces calculation of the entry size and text layouting.
void elm_entry_anchor_hover_end (Elm_Entry *obj)
 Ends the hover popup in the entry.
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.
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.
const char * elm_entry_text_style_user_peek (const Elm_Entry *obj)
 Get the style on the top of user style stack.
void elm_entry_context_menu_clear (Elm_Entry *obj)
 This clears and frees the items in a entry's contextual (longpress) menu.
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.
void elm_entry_input_panel_imdata_set (Elm_Entry *obj, const void *data, int len)
void elm_entry_input_panel_imdata_get (const Elm_Entry *obj, void *data, int *len)
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).
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.
void elm_entry_markup_filter_remove (Elm_Entry *obj, Elm_Entry_Filter_Cb func, void *data)
 Remove a markup filter from the list.
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.
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.
void elm_entry_entry_append (Elm_Entry *obj, const char *str)
 Appends str to the text of the entry.
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.
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.
char * elm_entry_markup_to_utf8 (const char *s)
 This converts a markup (HTML-like) string into UTF-8.
char * elm_entry_utf8_to_markup (const char *s)
 This converts a UTF-8 string into markup (HTML-like).
void elm_entry_filter_limit_size (void *data, Evas_Object *entry, char **text)
 Filter inserted text based on user defined character and byte limits.
void elm_entry_filter_accept_set (void *data, Evas_Object *entry, char **text)
 Filter inserted text based on accepted or rejected sets of characters.
Evas_Object * elm_entry_add (Evas_Object *parent)
 This adds an entry to parent object.
void elm_entry_entry_set (Evas_Object *obj, const char *entry)
 This sets the text displayed within the entry to entry.
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().

Typedefs

typedef struct
_Elm_Entry_Anchor_Info 		Elm_Entry_Anchor_Info
typedef struct
_Elm_Entry_Anchor_Hover_Info 		Elm_Entry_Anchor_Hover_Info
typedef struct
_Elm_Entry_Context_Menu_Item 		Elm_Entry_Context_Menu_Item
typedef Evas_Object *(* Elm_Entry_Item_Provider_Cb )(void *data, Evas_Object *entry, const char *item)
typedef void(* Elm_Entry_Filter_Cb )(void *data, Evas_Object *entry, char **text)
typedef Edje_Entry_Change_Info Elm_Entry_Change_Info
typedef struct
_Elm_Entry_Filter_Limit_Size 		Elm_Entry_Filter_Limit_Size
typedef struct
_Elm_Entry_Filter_Accept_Set 		Elm_Entry_Filter_Accept_Set

entry_inheritance_tree.png

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.

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

entry_item_scale.png

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:

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)

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.

Typedef Documentation

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_Anchor_Info Elm_Entry_Anchor_Info

The info sent in the callback for the "anchor,clicked" signals emitted by entries.

typedef Edje_Entry_Change_Info Elm_Entry_Change_Info

This corresponds to Edje_Entry_Change_Info. Includes information about a change in the entry.

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 (EFL) :
1.8
typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set

Data for the elm_entry_filter_accept_set() entry filter.

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:
dataThe data specified as the last param 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
typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size

Data for the elm_entry_filter_limit_size() entry filter.

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:
dataThe data specified as the last param when adding the provider
entryThe entry object
textA 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
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
enum Elm_Autocapital_Type

Autocapitalization Types.

See also:
elm_entry_autocapital_type_set()
Enumerator:
ELM_AUTOCAPITAL_TYPE_NONE 

No auto-capitalization when typing

ELM_AUTOCAPITAL_TYPE_WORD 

Autocapitalize each word typed

ELM_AUTOCAPITAL_TYPE_SENTENCE 

Autocapitalize the start of each sentence

ELM_AUTOCAPITAL_TYPE_ALLCHARACTER 

Autocapitalize all letters

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

enum Elm_Input_Hints

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
enum Elm_Input_Panel_Lang

Input panel (virtual keyboard) language modes.

See also:
elm_entry_input_panel_language_set()
Enumerator:
ELM_INPUT_PANEL_LANG_AUTOMATIC 

Automatic

ELM_INPUT_PANEL_LANG_ALPHABET 

Alphabet

enum Elm_Input_Panel_Layout

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 

Never use this

ELM_INPUT_PANEL_LAYOUT_HEX 

Hexadecimal layout

ELM_INPUT_PANEL_LAYOUT_TERMINAL 

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

ELM_INPUT_PANEL_LAYOUT_PASSWORD 

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

ELM_INPUT_PANEL_LAYOUT_DATETIME 

Date and time layout

Since (EFL) :
1.8
ELM_INPUT_PANEL_LAYOUT_EMOTICON 

Emoticon layout

Since (EFL) :
1.10
enum Elm_Input_Panel_Return_Key_Type

"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

ELM_INPUT_PANEL_RETURN_KEY_TYPE_DONE 

Done

ELM_INPUT_PANEL_RETURN_KEY_TYPE_GO 

Go

ELM_INPUT_PANEL_RETURN_KEY_TYPE_JOIN 

Join

ELM_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN 

Login

ELM_INPUT_PANEL_RETURN_KEY_TYPE_NEXT 

Next

ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH 

Search string or magnifier icon

ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEND 

Send

ELM_INPUT_PANEL_RETURN_KEY_TYPE_SIGNIN 

Sign-in

Since (EFL) :
1.8
enum Elm_Text_Format

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

enum Elm_Wrap_Type

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 in allowed wrapping points (as defined in the unicode standard)

ELM_WRAP_MIXED 

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

Function Documentation

Evas_Object* elm_entry_add ( Evas_Object *  parent)

This adds an entry to parent object.

Since :
2.3
Remarks:
By default, entries are:
  • not scrolled
  • multi-line
  • word wrapped
  • autosave is enabled
Parameters:
[in]parentThe parent object
Returns:
The new object or NULL if it cannot be created
void elm_entry_anchor_hover_end ( Elm_Entry *  obj)

Ends the hover popup in the entry.

Since :
2.3
Remarks:
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.
Parameters:
[in]objThe elm entry object
Evas_Object* elm_entry_anchor_hover_parent_get ( const Elm_Entry *  obj)

Get the parent of the hover popup.

Since :
2.3
Remarks:
Get the object used as parent for the hover created by the entry widget. See Hover for more details on this. If no parent is set, the same entry object will be used.
Returns:
The object used as parent for the hover, NULL if none is set.
Parameters:
[in]objThe elm entry object
void elm_entry_anchor_hover_parent_set ( Elm_Entry *  obj,
Evas_Object *  parent 
)

Set the parent of the hover popup.

Since :
2.3
Remarks:
Sets the parent object to use by the hover created by the entry when an anchor is clicked. See Hover for more details on this.
Parameters:
[in]objThe elm entry object
[in]parentThe object to use as parent for the hover
const char* elm_entry_anchor_hover_style_get ( const Elm_Entry *  obj)

Get the style that the hover should use.

Since :
2.3
Remarks:
Get the style, the hover created by entry will use.
Returns:
The style to use by the hover. NULL means the default is used.
See also:
elm_object_style_set()
Parameters:
[in]objThe elm entry object
void elm_entry_anchor_hover_style_set ( Elm_Entry *  obj,
const char *  style 
)

Set the style that the hover should use.

Since :
2.3
Remarks:
When creating the popup hover, entry will request that it's themed according to style.
Setting style no NULL means disabling automatic hover.
See also:
elm_object_style_set()
Parameters:
[in]objThe elm entry object
[in]styleThe style to use for the underlying hover
Elm_Autocapital_Type elm_entry_autocapital_type_get ( const Elm_Entry *  obj)

Get the autocapitalization type on the immodule.

Since :
2.3
Returns:
autocapitalization type
Parameters:
[in]objThe elm entry object
void elm_entry_autocapital_type_set ( Elm_Entry *  obj,
Elm_Autocapital_Type  autocapital_type 
)

Set the autocapitalization type on the immodule.

Since :
2.3
Parameters:
[in]objThe elm entry object
[in]autocapital_typeThe type of autocapitalization
Eina_Bool elm_entry_autosave_get ( const Elm_Entry *  obj)

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

Since :
2.3
Returns:
Autosave the loaded file or not
See also:
elm_entry_file_set()
Parameters:
[in]objThe elm entry object
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.

Since :
2.3
See also:
elm_entry_file_set()
Parameters:
[in]objThe elm entry object
[in]auto_saveAutosave the loaded file or not
void elm_entry_calc_force ( Elm_Entry *  obj)

Forces calculation of the entry size and text layouting.

Since :
2.3
Remarks:
This should be used after modifying the textblock object directly. See elm_entry_textblock_get() for more information.
See also:
elm_entry_textblock_get()
Parameters:
[in]objThe elm entry object
Elm_Cnp_Mode elm_entry_cnp_mode_get ( const Elm_Entry *  obj)

Getting elm_entry text paste/drop mode.

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

Control pasting of text and images for the widget.

Since :
2.3
Remarks:
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 .
this only changes the behaviour of text.
Parameters:
[in]objThe elm entry object
[in]cnp_modeOne of Elm_Cnp_Mode: ELM_CNP_MODE_MARKUP, ELM_CNP_MODE_NO_IMAGE, ELM_CNP_MODE_PLAINTEXT.
void elm_entry_context_menu_clear ( Elm_Entry *  obj)

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

Since :
2.3
See also:
elm_entry_context_menu_item_add()
Parameters:
[in]objThe elm entry object
Eina_Bool elm_entry_context_menu_disabled_get ( const Elm_Entry *  obj)

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

Since :
2.3
Returns:
If true, the menu is disabled
Parameters:
[in]objThe elm entry object
void elm_entry_context_menu_disabled_set ( Elm_Entry *  obj,
Eina_Bool  disabled 
)

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

Since :
2.3
Parameters:
[in]objThe elm entry object
[in]disabledIf true, the menu is disabled
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.

Since :
2.3
Remarks:
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]objThe elm 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
void elm_entry_cursor_begin_set ( Elm_Entry *  obj)

This moves the cursor to the beginning of the entry.

Since :
2.3
Parameters:
[in]objThe elm entry object
char* elm_entry_cursor_content_get ( const Elm_Entry *  obj)

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

Since :
2.3
Remarks:
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().
Returns:
The text pointed by the cursors.
Parameters:
[in]objThe elm entry object
Eina_Bool elm_entry_cursor_down ( Elm_Entry *  obj)

This moves the cursor one line down within the entry.

Since :
2.3
Returns:
EINA_TRUE upon success, EINA_FALSE upon failure
Parameters:
[in]objThe elm entry object
void elm_entry_cursor_end_set ( Elm_Entry *  obj)

This moves the cursor to the end of the entry.

Since :
2.3
Parameters:
[in]objThe elm entry object
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.

Since :
2.3
Remarks:
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.
Returns:
EINA_TRUE upon success, EINA_FALSE upon failure
Parameters:
[in]objThe elm entry object
[out]xreturned geometry
[out]yreturned geometry
[out]wreturned geometry
[out]hreturned geometry
Eina_Bool elm_entry_cursor_is_format_get ( const Elm_Entry *  obj)

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

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

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

Since :
2.3
Returns:
EINA_TRUE if the current cursor is a visible format, EINA_FALSE if it's an invisible one or no format exists.
See also:
elm_entry_cursor_is_format_get()
Parameters:
[in]objThe elm entry object
void elm_entry_cursor_line_begin_set ( Elm_Entry *  obj)

This moves the cursor to the beginning of the current line.

Since :
2.3
Parameters:
[in]objThe elm entry object
void elm_entry_cursor_line_end_set ( Elm_Entry *  obj)

This moves the cursor to the end of the current line.

Since :
2.3
Parameters:
[in]objThe elm entry object
Eina_Bool elm_entry_cursor_next ( Elm_Entry *  obj)

This moves the cursor one place to the right within the entry.

Since :
2.3
Returns:
EINA_TRUE upon success, EINA_FALSE upon failure
Parameters:
[in]objThe elm entry object
int elm_entry_cursor_pos_get ( const Elm_Entry *  obj)

Get the current position of the cursor in the entry.

Since :
2.3
Returns:
The cursor position
Parameters:
[in]objThe elm entry object
void elm_entry_cursor_pos_set ( Elm_Entry *  obj,
int  pos 
)

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

Since :
2.3
Remarks:
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]objThe elm entry object
[in]posThe position of the cursor
Eina_Bool elm_entry_cursor_prev ( Elm_Entry *  obj)

This moves the cursor one place to the left within the entry.

Since :
2.3
Returns:
EINA_TRUE upon success, EINA_FALSE upon failure
Parameters:
[in]objThe elm entry object
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.

Since :
2.3
Parameters:
[in]objThe elm entry object
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.

Since :
2.3
Parameters:
[in]objThe elm entry object
Eina_Bool elm_entry_cursor_up ( Elm_Entry *  obj)

This moves the cursor one line up within the entry.

Since :
2.3
Returns:
EINA_TRUE upon success, EINA_FALSE upon failure
Parameters:
[in]objThe elm entry object
Eina_Bool elm_entry_editable_get ( const Elm_Entry *  obj)

Get whether the entry is editable or not.

Since :
2.3
Returns:
If true, the entry is editable by the user. If false, it is not editable by the user
See also:
elm_entry_editable_set()
Parameters:
[in]objThe elm entry object
void elm_entry_editable_set ( Elm_Entry *  obj,
Eina_Bool  editable 
)

Sets if the entry is to be editable or not.

Since :
2.3
Remarks:
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 EINA_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]objThe elm entry object
[in]editableIf EINA_TRUE, user input will be inserted in the entry, if not, the entry is read-only and no user input is allowed.
void elm_entry_entry_append ( Elm_Entry *  obj,
const char *  str 
)

Appends str to the text of the entry.

Since :
2.3
Remarks:
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]objThe elm entry object
[in]strThe text to be appended
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().

Since :
2.3
Parameters:
[in]objThe entry object
Returns:
The currently displayed text or NULL on failure
void elm_entry_entry_insert ( Elm_Entry *  obj,
const char *  entry 
)

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

Since :
2.3
Remarks:
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]objThe elm entry object
[in]entryThe text to insert
void elm_entry_entry_set ( Evas_Object *  obj,
const char *  entry 
)

This sets the text displayed within the entry to entry.

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

Get the file being edited by the entry.

Since :
2.3
Remarks:
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:
[in]objThe elm entry object
[out]fileThe path to the file to load and save
[out]formatThe file format
void elm_entry_file_save ( Elm_Entry *  obj)

This function writes any changes made to the file set with elm_entry_file_set()

Since :
2.3
Parameters:
[in]objThe elm entry object
Eina_Bool elm_entry_file_set ( Elm_Entry *  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).

Since :
2.3
Remarks:
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]objThe elm entry object
[in]fileThe path to the file to load and save
[in]formatThe file format
void elm_entry_filter_accept_set ( void *  data,
Evas_Object *  entry,
char **  text 
)

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

Since :
2.3
Parameters:
[in]dataElm_Entry_Filter_Limit_Size structure.
[in]entryThe entry object.
[in]textThe inserted text.
Remarks:
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()
void elm_entry_filter_limit_size ( void *  data,
Evas_Object *  entry,
char **  text 
)

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

Since :
2.3
Parameters:
[in]dataElm_Entry_Filter_Limit_Size structure.
[in]entryThe entry object.
[in]textThe inserted text.
Remarks:
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().
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().

Since :
2.3
Parameters:
[in]objThe elm entry object
[in]settingEINA_TRUE if the object should be displayed, EINA_FALSE if not.
void* elm_entry_imf_context_get ( const Elm_Entry *  obj)

Returns the input method context of the entry.

Since :
2.3
Remarks:
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.
Returns:
The input method context (Ecore_IMF_Context *) in entry.
Parameters:
[in]objThe elm entry object
void elm_entry_imf_context_reset ( Elm_Entry *  obj)

Reset the input method context of the entry if needed.

Since :
2.3
Remarks:
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.
Parameters:
[in]objThe elm entry object
Elm_Input_Hints elm_entry_input_hint_get ( const Elm_Entry *  obj)

Gets the value of input hint.

Since :
2.3
Returns:
the value of input hint.
See also:
elm_entry_input_hint_set
Parameters:
[in]objThe elm entry object
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.

Since :
2.3
Parameters:
[in]objThe elm entry object
[in]hintsinput hint.
Eina_Bool elm_entry_input_panel_enabled_get ( const Elm_Entry *  obj)

Get the attribute to show the input panel automatically.

Since :
2.3
Returns:
EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
Parameters:
[in]objThe elm entry object
void elm_entry_input_panel_enabled_set ( Elm_Entry *  obj,
Eina_Bool  enabled 
)

Sets the attribute to show the input panel automatically.

Since :
2.3
Parameters:
[in]objThe elm entry object
[in]enabledIf true, the input panel is appeared when entry is clicked or has a focus
void elm_entry_input_panel_hide ( Elm_Entry *  obj)

Hide the input panel (virtual keyboard).

Since :
2.3
Remarks:
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, EINA_FALSE)
Parameters:
[in]objThe elm entry object
void elm_entry_input_panel_imdata_get ( const Elm_Entry *  obj,
void *  data,
int *  len 
)

Get the specific data of the current input panel.

See elm_entry_input_panel_imdata_set for more details.

Since :
2.3
Parameters:
[in]objThe elm entry object
[out]dataThe specific data to be got from the input panel
[out]lenThe length of data
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.

Since :
2.3
Parameters:
[in]objThe elm entry object
[in]dataThe specific data to be set to the input panel.
[in]lenthe length of data, in bytes, to send to the input panel
Elm_Input_Panel_Lang elm_entry_input_panel_language_get ( const Elm_Entry *  obj)

Get the language mode of the input panel.

Since :
2.3
Remarks:
See elm_entry_input_panel_language_set for more details.
Returns:
input panel language type
Parameters:
[in]objThe elm entry object
void elm_entry_input_panel_language_set ( Elm_Entry *  obj,
Elm_Input_Panel_Lang  lang 
)

Set the language mode of the input panel.

Since :
2.3
Remarks:
This API can be used if you want to show the alphabet keyboard mode.
Parameters:
[in]objThe elm entry object
[in]langlanguage to be set to the input panel.
Elm_Input_Panel_Layout elm_entry_input_panel_layout_get ( const Elm_Entry *  obj)

Get the input panel layout of the entry.

Since :
2.3
Returns:
layout type. It returns ELM_INPUT_PANEL_LAYOUT_INVALID(8) when it fails.
See also:
elm_entry_input_panel_layout_set
Parameters:
[in]objThe elm entry object
void elm_entry_input_panel_layout_set ( Elm_Entry *  obj,
Elm_Input_Panel_Layout  layout 
)

Set the input panel layout of the entry.

Since :
2.3
Parameters:
[in]objThe elm entry object
[in]layoutlayout type
int elm_entry_input_panel_layout_variation_get ( const Elm_Entry *  obj)

Get the input panel layout variation of the entry.

Since :
2.3
Returns:
layout variation type
See also:
elm_entry_input_panel_layout_variation_set
Since (EFL) :
1.8
Parameters:
[in]objThe elm entry object
void elm_entry_input_panel_layout_variation_set ( Elm_Entry *  obj,
int  variation 
)

Set the input panel layout variation of the entry.

Since :
2.3
Since (EFL) :
1.8
Parameters:
[in]objThe elm entry object
[in]variationlayout variation type
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.

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

Since :
2.3
Returns:
EINA_TRUE if it should be disabled
Parameters:
[in]objThe elm entry object
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.

Since :
2.3
Parameters:
[in]objThe elm entry object
[in]disabledThe state to put in in: EINA_TRUE for disabled, EINA_FALSE for enabled
Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get ( const Elm_Entry *  obj)

Get the "return" key type.

Since :
2.3
See also:
elm_entry_input_panel_return_key_type_set() for more details
Returns:
The type of "return" key on the input panel
Parameters:
[in]objThe elm entry object
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.

Since :
2.3
Remarks:
An input panel displays the string or icon associated with this type
Parameters:
[in]objThe elm entry object
[in]return_key_typeThe type of "return" key on the input panel
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.

Since :
2.3
Remarks:
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, EINA_FALSE).
Parameters:
[in]objThe elm entry object
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.

Since :
2.3
Returns:
EINA_TRUE if the input panel will be shown in case of only Mouse up event.
Since (EFL) :
1.9
Parameters:
[in]objThe elm entry object
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.

Since :
2.3
Remarks:
It doesn't request to show the input panel even though it has focus.
Parameters:
[in]objThe elm entry object
[in]ondemandIf true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)
Since (EFL) :
1.9
Eina_Bool elm_entry_is_empty ( const Elm_Entry *  obj)

Get whether the entry is empty.

Since :
2.3
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.
Returns:
EINA_TRUE if the entry text is empty or entry is NULL, EINA_FALSE otherwise.
Parameters:
[in]objThe elm entry object
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.

Since :
2.3
Remarks:
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]objThe elm entry object
[in]funcThe function called to provide the item object
[in]dataThe data passed to func
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.

Since :
2.3
Remarks:
This prepends the given callback. See elm_entry_item_provider_append() for more information
Parameters:
[in]objThe elm entry object
[in]funcThe function called to provide the item object
[in]dataThe data passed to func
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.

Since :
2.3
Remarks:
This removes the given callback. See elm_entry_item_provider_append() for more information
Parameters:
[in]objThe elm entry object
[in]funcThe function called to provide the item object
[in]dataThe data passed to func
Elm_Wrap_Type elm_entry_line_wrap_get ( const Elm_Entry *  obj)

Get the wrap mode the entry was set to use.

Since :
2.3
Returns:
Wrap type
See also:
also elm_entry_line_wrap_set()
Parameters:
[in]objThe elm entry object
void elm_entry_line_wrap_set ( Elm_Entry *  obj,
Elm_Wrap_Type  wrap 
)

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

Since :
2.3
Remarks:
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]objThe elm entry object
[in]wrapThe wrap mode to use. See Elm_Wrap_Type for details on them
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.

Since :
2.3
Remarks:
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]objThe elm entry object
[in]funcThe function to use as text filter
[in]dataUser data to pass to func
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.

Since :
2.3
Remarks:
Prepend the given callback to the list. See elm_entry_markup_filter_append() for more information
Parameters:
[in]objThe elm entry object
[in]funcThe function to use as text filter
[in]dataUser data to pass to func
void elm_entry_markup_filter_remove ( Elm_Entry *  obj,
Elm_Entry_Filter_Cb  func,
void *  data 
)

Remove a markup filter from the list.

Since :
2.3
Remarks:
Removes the given callback from the filter list. See elm_entry_markup_filter_append() for more information.
Parameters:
[in]objThe elm entry object
[in]funcThe filter function to remove
[in]dataThe user data passed when adding the function
char* elm_entry_markup_to_utf8 ( const char *  s)

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

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

Get whether the entry is set to password mode.

Since :
2.3
Returns:
If true, the entry is set to display all characters as asterisks (*).
See also:
elm_entry_password_set()
Parameters:
[in]objThe elm entry object
void elm_entry_password_set ( Elm_Entry *  obj,
Eina_Bool  password 
)

Sets the entry to password mode.

Since :
2.3
Remarks:
In password mode, entries are implicitly single line and the display of any text in them is replaced with asterisks (*).
Parameters:
[in]objThe elm entry object
[in]passwordIf true, password mode is enabled.
Eina_Bool elm_entry_prediction_allow_get ( const Elm_Entry *  obj)

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

Since :
2.3
Returns:
EINA_TRUE if it allows to use the text prediction, otherwise EINA_FALSE.
Parameters:
[in]objThe elm entry object
void elm_entry_prediction_allow_set ( Elm_Entry *  obj,
Eina_Bool  prediction 
)

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

Since :
2.3
Parameters:
[in]objThe elm entry object
[in]predictionWhether the entry should allow to use the text prediction.
Eina_Bool elm_entry_scrollable_get ( const Elm_Entry *  obj)

Get the scrollable state of the entry.

Since :
2.3
Remarks:
Normally the entry is not scrollable. This gets the scrollable state of the entry. See elm_entry_scrollable_set() for more information.
Returns:
The scrollable state
Parameters:
[in]objThe elm entry object
void elm_entry_scrollable_set ( Elm_Entry *  obj,
Eina_Bool  scroll 
)

Enable or disable scrolling in entry.

Since :
2.3
Remarks:
Normally the entry is not scrollable unless you enable it with this call.
Parameters:
[in]objThe elm entry object
[in]scrollEINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
void elm_entry_select_all ( Elm_Entry *  obj)

This selects all text within the entry.

Since :
2.3
Parameters:
[in]objThe elm entry object
void elm_entry_select_none ( Elm_Entry *  obj)

This drops any existing text selection within the entry.

Since :
2.3
Parameters:
[in]objThe elm entry object
void elm_entry_select_region_set ( Elm_Entry *  obj,
int  start,
int  end 
)

This selects a region of text within the entry.

Since :
2.4
Since (EFL) :
1.9
Parameters:
[in]objThe elm entry object
[in]startThe starting position
[in]endThe end position
void elm_entry_selection_copy ( Elm_Entry *  obj)

This executes a "copy" action on the selected text in the entry.

Since :
2.3
Parameters:
[in]objThe elm entry object
void elm_entry_selection_cut ( Elm_Entry *  obj)

This executes a "cut" action on the selected text in the entry.

Since :
2.3
Parameters:
[in]objThe elm entry object
const char* elm_entry_selection_get ( const Elm_Entry *  obj)

Get any selected text within the entry.

Since :
2.3
Remarks:
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.
Returns:
The selected text within the entry or NULL on failure
Parameters:
[in]objThe elm entry object
void elm_entry_selection_paste ( Elm_Entry *  obj)

This executes a "paste" action in the entry.

Since :
2.3
Parameters:
[in]objThe elm entry object
Eina_Bool elm_entry_single_line_get ( const Elm_Entry *  obj)

Get whether the entry is set to be single line.

Since :
2.3
Returns:
single_line If true, the text in the entry is set to display on a single line.
See also:
elm_entry_single_line_set()
Parameters:
[in]objThe elm entry object
void elm_entry_single_line_set ( Elm_Entry *  obj,
Eina_Bool  single_line 
)

Sets the entry to single line mode.

Since :
2.3
Remarks:
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 EINA_FALSE, line wrapping takes effect again and pressing enter will break the text into a different line without generating any events.
Parameters:
[in]objThe elm entry object
[in]single_lineIf true, the text in the entry will be on a single line.
const char* elm_entry_text_style_user_peek ( const Elm_Entry *  obj)

Get the style on the top of user style stack.

Since :
2.3
Returns:
style on the top of user style stack if exist, otherwise NULL.
See also:
elm_entry_text_style_user_push()
Since (EFL) :
1.7
Parameters:
[in]objThe elm entry object
void elm_entry_text_style_user_pop ( Elm_Entry *  obj)

Remove the style in the top of user style stack.

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

Push the style to the top of user style stack.

Since :
2.3
Remarks:
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').
Since (EFL) :
1.7
Parameters:
[in]objThe elm entry object
[in]styleThe style user to push
Evas_Object* elm_entry_textblock_get ( const Elm_Entry *  obj)

Returns the actual textblock object of the entry.

Since :
2.3
Remarks:
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.
Returns:
The textblock object.
Parameters:
[in]objThe elm entry object
char* elm_entry_utf8_to_markup ( const char *  s)

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

Since :
2.3
Remarks:
The returned string is a malloc'ed buffer and it should be freed when not needed anymore.
Parameters:
[in]sThe string (in UTF-8) to be converted
Returns:
The converted string (in markup). It should be freed.
Remarks:
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.