2 * @defgroup Entry Entry
4 * @image html img/widget/entry/preview-00.png
5 * @image latex img/widget/entry/preview-00.eps width=\textwidth
6 * @image html img/widget/entry/preview-01.png
7 * @image latex img/widget/entry/preview-01.eps width=\textwidth
8 * @image html img/widget/entry/preview-02.png
9 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10 * @image html img/widget/entry/preview-03.png
11 * @image latex img/widget/entry/preview-03.eps width=\textwidth
13 * An entry is a convenience widget which shows a box that the user can
14 * enter text into. Entries by default don't scroll, so they grow to
15 * accommodate the entire text, resizing the parent window as needed. This
16 * can be changed with the elm_entry_scrollable_set() function.
18 * They can also be single line or multi line (the default) and when set
19 * to multi line mode they support text wrapping in any of the modes
20 * indicated by #Elm_Wrap_Type.
22 * Other features include password mode, filtering of inserted text with
23 * elm_entry_markup_filter_append() and related functions, inline "items" and
24 * formatted markup text.
26 * @section entry-markup Formatted text
28 * The markup tags supported by the Entry are defined by the theme, but
29 * even when writing new themes or extensions it's a good idea to stick to
30 * a sane default, to maintain coherency and avoid application breakages.
31 * Currently defined by the default theme are the following tags:
32 * @li \<br\>: Inserts a line break.
33 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
35 * @li \<tab\>: Inserts a tab.
36 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
38 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
39 * @li \<link\>...\</link\>: Underlines the enclosed text.
40 * @li \<hilight\>...\</hilight\>: Highlights the enclosed text.
42 * @section entry-special Special markups
44 * Besides those used to format text, entries support two special markup
45 * tags used to insert click-able portions of text or items inlined within
48 * @subsection entry-anchors Anchors
50 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
51 * \</a\> tags and an event will be generated when this text is clicked,
55 * This text is outside <a href=anc-01>but this one is an anchor</a>
58 * The @c href attribute in the opening tag gives the name that will be
59 * used to identify the anchor and it can be any valid utf8 string.
61 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
62 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
63 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
64 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
67 * @subsection entry-items Items
69 * Inlined in the text, any other @c Evas_Object can be inserted by using
70 * \<item\> tags this way:
73 * <item size=16x16 vsize=full href=emoticon/haha></item>
76 * Just like with anchors, the @c href identifies each item, but these need,
77 * in addition, to indicate their size, which is done using any one of
78 * @c size, @c absize or @c relsize attributes. These attributes take their
79 * value in the WxH format, where W is the width and H the height of the
82 * @li absize: Absolute pixel size for the item. Whatever value is set will
83 * be the item's size regardless of any scale value the object may have
84 * been set to. The final line height will be adjusted to fit larger items.
85 * @li size: Similar to @c absize, but it's adjusted to the scale value set
87 * @li relsize: Size is adjusted for the item to fit within the current
90 * Besides their size, items are specified a @c vsize value that affects
91 * how their final size and position are calculated. The possible values
93 * @li ascent: Item will be placed within the line's baseline and its
94 * ascent. That is, the height between the line where all characters are
95 * positioned and the highest point in the line. For @c size and @c absize
96 * items, the descent value will be added to the total line height to make
97 * them fit. @c relsize items will be adjusted to fit within this space.
98 * @li full: Items will be placed between the descent and ascent, or the
99 * lowest point in the line and its highest.
101 * The next image shows different configurations of items and how
102 * the previously mentioned options affect their sizes. In all cases,
103 * the green line indicates the ascent, blue for the baseline and red for
106 * @image html entry_item.png
107 * @image latex entry_item.eps width=\textwidth
109 * And another one to show how size differs from absize. In the first one,
110 * the scale value is set to 1.0, while the second one is using one of 2.0.
112 * @image html entry_item_scale.png
113 * @image latex entry_item_scale.eps width=\textwidth
115 * After the size for an item is calculated, the entry will request an
116 * object to place in its space. For this, the functions set with
117 * elm_entry_item_provider_append() and related functions will be called
118 * in order until one of them returns a @c non-NULL value. If no providers
119 * are available, or all of them return @c NULL, then the entry falls back
120 * to one of the internal defaults, provided the name matches with one of
123 * All of the following are currently supported:
126 * - emoticon/angry-shout
127 * - emoticon/crazy-laugh
128 * - emoticon/evil-laugh
130 * - emoticon/goggle-smile
132 * - emoticon/grumpy-smile
134 * - emoticon/guilty-smile
136 * - emoticon/half-smile
137 * - emoticon/happy-panting
139 * - emoticon/indifferent
141 * - emoticon/knowing-grin
143 * - emoticon/little-bit-sorry
144 * - emoticon/love-lots
146 * - emoticon/minimal-smile
147 * - emoticon/not-happy
148 * - emoticon/not-impressed
150 * - emoticon/opensmile
153 * - emoticon/squint-laugh
154 * - emoticon/surprised
155 * - emoticon/suspicious
156 * - emoticon/tongue-dangling
157 * - emoticon/tongue-poke
160 * - emoticon/very-sorry
166 * Alternatively, an item may reference an image by its path, using
167 * the URI form @c file:///path/to/an/image.png and the entry will then
168 * use that image for the item.
170 * @section entry-files Loading and saving files
172 * Entries have convenience functions to load text from a file and save
173 * changes back to it after a short delay. The automatic saving is enabled
174 * by default, but can be disabled with elm_entry_autosave_set() and files
175 * can be loaded directly as plain text or have any markup in them
176 * recognized. See elm_entry_file_set() for more details.
178 * @section entry-signals Emitted signals
180 * This widget emits the following signals:
182 * @li "changed": The text within the entry was changed.
183 * @li "changed,user": The text within the entry was changed because of user interaction.
184 * @li "activated": The enter key was pressed on a single line entry.
185 * @li "press": A mouse button has been pressed on the entry.
186 * @li "longpressed": A mouse button has been pressed and held for a couple
188 * @li "clicked": The entry has been clicked (mouse press and release).
189 * @li "clicked,double": The entry has been double clicked.
190 * @li "clicked,triple": The entry has been triple clicked.
191 * @li "focused": The entry has received focus.
192 * @li "unfocused": The entry has lost focus.
193 * @li "selection,paste": A paste of the clipboard contents was requested.
194 * @li "selection,copy": A copy of the selected text into the clipboard was
196 * @li "selection,cut": A cut of the selected text into the clipboard was
198 * @li "selection,start": A selection has begun and no previous selection
200 * @li "selection,changed": The current selection has changed.
201 * @li "selection,cleared": The current selection has been cleared.
202 * @li "cursor,changed": The cursor has changed position.
203 * @li "anchor,clicked": An anchor has been clicked. The event_info
204 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
205 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
206 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
207 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
208 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
209 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
210 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
211 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
212 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
213 * @li "preedit,changed": The preedit string has changed.
214 * @li "language,changed": Program language changed.
216 * Default content parts of the entry items that you can use for are:
217 * @li "icon" - An icon in the entry
218 * @li "end" - A content in the end of the entry
220 * Default text parts of the entry that you can use for are:
221 * @li "default" - text of the entry
223 * Supported elm_object common APIs.
224 * @li elm_object_signal_emit
225 * @li elm_object_part_text_set
226 * @li elm_object_part_text_get
227 * @li elm_object_part_content_set
228 * @li elm_object_part_content_get
229 * @li elm_object_part_content_unset
230 * @li elm_object_signal_callback_add
231 * @li elm_object_signal_callback_del
232 * @li elm_object_disabled_set
233 * @li elm_object_disabled_get
235 * @section entry-examples
237 * An overview of the Entry API can be seen in @ref entry_example_01
243 * @enum _Elm_Text_Format
244 * @typedef Elm_Text_Format
248 * @see elm_entry_file_set()
252 ELM_TEXT_FORMAT_PLAIN_UTF8, /**< Plain UTF8 type */
253 ELM_TEXT_FORMAT_MARKUP_UTF8 /**< Markup UTF8 type */
257 * @enum _Elm_Wrap_Type
258 * @typedef Elm_Wrap_Type
260 * Line wrapping types.
262 * @see elm_entry_line_wrap_set()
266 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
267 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
268 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
269 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
271 } Elm_Wrap_Type; /**< Type of word or character wrapping to use */
274 * @enum _Elm_Input_Panel_Layout
275 * @typedef Elm_Input_Panel_Layout
277 * Input panel (virtual keyboard) layout types.
279 * @see elm_entry_input_panel_layout_set()
283 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
284 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
285 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
286 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
287 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
288 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
289 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
290 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
291 ELM_INPUT_PANEL_LAYOUT_INVALID, /**< Never use this */
292 ELM_INPUT_PANEL_LAYOUT_HEX, /**< Hexadecimal layout */
293 ELM_INPUT_PANEL_LAYOUT_TERMINAL, /**< Command-line terminal layout */
294 ELM_INPUT_PANEL_LAYOUT_PASSWORD /**< Like normal, but no auto-correct, no auto-capitalization etc. */
295 } Elm_Input_Panel_Layout; /**< Type of input panel (virtual keyboard) to use - this is a hint and may not provide exactly what is desired. */
298 * @enum _Elm_Input_Panel_Lang
299 * @typedef Elm_Input_Panel_Lang
301 * Input panel (virtual keyboard) language modes.
303 * @see elm_entry_input_panel_language_set()
307 ELM_INPUT_PANEL_LANG_AUTOMATIC, /**< Automatic */
308 ELM_INPUT_PANEL_LANG_ALPHABET /**< Alphabet */
309 } Elm_Input_Panel_Lang;
312 * @enum _Elm_Autocapital_Type
313 * @typedef Elm_Autocapital_Type
315 * Autocapitalization Types.
317 * @see elm_entry_autocapital_type_set()
321 ELM_AUTOCAPITAL_TYPE_NONE, /**< No auto-capitalization when typing */
322 ELM_AUTOCAPITAL_TYPE_WORD, /**< Autocapitalize each word typed */
323 ELM_AUTOCAPITAL_TYPE_SENTENCE, /**< Autocapitalize the start of each sentence */
324 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters */
325 } Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
328 * @enum _Elm_Input_Panel_Return_Key_Type
329 * @typedef Elm_Input_Panel_Return_Key_Type
331 * "Return" Key types on the input panel (virtual keyboard).
333 * @see elm_entry_input_panel_return_key_type_set()
337 ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT, /**< Default */
338 ELM_INPUT_PANEL_RETURN_KEY_TYPE_DONE, /**< Done */
339 ELM_INPUT_PANEL_RETURN_KEY_TYPE_GO, /**< Go */
340 ELM_INPUT_PANEL_RETURN_KEY_TYPE_JOIN, /**< Join */
341 ELM_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN, /**< Login */
342 ELM_INPUT_PANEL_RETURN_KEY_TYPE_NEXT, /**< Next */
343 ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH, /**< Search string or magnifier icon */
344 ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEND /**< Send */
345 } Elm_Input_Panel_Return_Key_Type;
348 * @typedef Elm_Entry_Anchor_Info
350 * The info sent in the callback for the "anchor,clicked" signals emitted
353 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
356 * @struct _Elm_Entry_Anchor_Info
358 * The info sent in the callback for the "anchor,clicked" signals emitted
361 struct _Elm_Entry_Anchor_Info
363 const char *name; /**< The name of the anchor, as stated in its href */
364 int button; /**< The mouse button used to click on it */
365 Evas_Coord x, /**< Anchor geometry, relative to canvas */
366 y, /**< Anchor geometry, relative to canvas */
367 w, /**< Anchor geometry, relative to canvas */
368 h; /**< Anchor geometry, relative to canvas */
372 * @typedef Elm_Entry_Anchor_Hover_Info
374 * The info sent in the callback for "anchor,clicked" signals emitted by
375 * the Anchor_Hover widget.
377 typedef struct _Elm_Entry_Anchor_Hover_Info Elm_Entry_Anchor_Hover_Info;
380 * @struct _Elm_Entry_Anchor_Hover_Info
382 * The info sent in the callback for "anchor,clicked" signals emitted by
383 * the Anchor_Hover widget.
385 struct _Elm_Entry_Anchor_Hover_Info
387 const Elm_Entry_Anchor_Info *anchor_info; /**< The actual anchor info. */
388 Evas_Object *hover; /**< The hover object to use for the popup */
391 Evas_Coord x, y, w, h;
392 } hover_parent; /**< Geometry of the object used as parent by the
394 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
395 for content on the left side of
396 the hover. Before calling the
397 callback, the widget will make the
398 necessary calculations to check
399 which sides are fit to be set with
400 content, based on the position the
401 hover is activated and its distance
402 to the edges of its parent object
404 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
405 the right side of the hover.
406 See @ref hover_left */
407 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
408 of the hover. See @ref hover_left */
409 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
410 below the hover. See @ref
415 * @typedef Elm_Entry_Filter_Cb
416 * This callback type is used by entry filters to modify text.
417 * @param data The data specified as the last param when adding the filter
418 * @param entry The entry object
419 * @param text A pointer to the location of the text being filtered. The type of text is always markup. This data can be modified,
420 * but any additional allocations must be managed by the user.
421 * @see elm_entry_markup_filter_append
422 * @see elm_entry_markup_filter_prepend
424 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
427 * @typedef Elm_Entry_Change_Info
428 * This corresponds to Edje_Entry_Change_Info. Includes information about
429 * a change in the entry.
431 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
434 * This adds an entry to @p parent object.
436 * By default, entries are:
440 * @li autosave is enabled
442 * @param parent The parent object
443 * @return The new object or NULL if it cannot be created
445 EAPI Evas_Object *elm_entry_add(Evas_Object *parent);
448 * Sets the entry to single line mode.
450 * In single line mode, entries don't ever wrap when the text reaches the
451 * edge, and instead they keep growing horizontally. Pressing the @c Enter
452 * key will generate an @c "activate" event instead of adding a new line.
454 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
455 * and pressing enter will break the text into a different line
456 * without generating any events.
458 * @param obj The entry object
459 * @param single_line If true, the text in the entry
460 * will be on a single line.
462 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
465 * Gets whether the entry is set to be single line.
467 * @param obj The entry object
468 * @return single_line If true, the text in the entry is set to display
471 * @see elm_entry_single_line_set()
473 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj);
476 * Sets the entry to password mode.
478 * In password mode, entries are implicitly single line and the display of
479 * any text in them is replaced with asterisks (*).
481 * @param obj The entry object
482 * @param password If true, password mode is enabled.
484 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password);
487 * Gets whether the entry is set to password mode.
489 * @param obj The entry object
490 * @return If true, the entry is set to display all characters
493 * @see elm_entry_password_set()
495 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj);
498 * This sets the text displayed within the entry to @p entry.
500 * @param obj The entry object
501 * @param entry The text to be displayed
503 * @note Using this function bypasses text filters
505 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry);
508 * This returns the text currently shown in object @p entry.
509 * See also elm_entry_entry_set().
511 * @param obj The entry object
512 * @return The currently displayed text or NULL on failure
514 EAPI const char *elm_entry_entry_get(const Evas_Object *obj);
517 * Appends @p entry to the text of the entry.
519 * Adds the text in @p entry to the end of any text already present in the
522 * The appended text is subject to any filters set for the widget.
524 * @param obj The entry object
525 * @param entry The text to be displayed
527 * @see elm_entry_markup_filter_append()
529 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry);
532 * Gets whether the entry is empty.
534 * Empty means no text at all. If there are any markup tags, like an item
535 * tag for which no provider finds anything, and no text is displayed, this
536 * function still returns EINA_FALSE.
538 * @param obj The entry object
539 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
541 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj);
544 * Gets any selected text within the entry.
546 * If there's any selected text in the entry, this function returns it as
547 * a string in markup format. NULL is returned if no selection exists or
548 * if an error occurred.
550 * The returned value points to an internal string and should not be freed
551 * or modified in any way. If the @p entry object is deleted or its
552 * contents are changed, the returned pointer should be considered invalid.
554 * @param obj The entry object
555 * @return The selected text within the entry or NULL on failure
557 EAPI const char *elm_entry_selection_get(const Evas_Object *obj);
560 * Returns the actual textblock object of the entry.
562 * This function exposes the internal textblock object that actually
563 * contains and draws the text. This should be used for low-level
564 * manipulations that are otherwise not possible.
566 * Changing the textblock directly from here will not notify edje/elm to
567 * recalculate the textblock size automatically, so any modifications
568 * done to the textblock returned by this function should be followed by
569 * a call to elm_entry_calc_force().
571 * The return value is marked as const as an additional warning.
572 * One should not use the returned object with any of the generic evas
573 * functions (geometry_get/resize/move and etc), but only with the textblock
574 * functions; The former will either not work at all, or break the correct
577 * IMPORTANT: Many functions may change (i.e delete and create a new one)
578 * the internal textblock object. Do NOT cache the returned object, and try
579 * not to mix calls on this object with regular elm_entry calls (which may
580 * change the internal textblock object). This applies to all cursors
581 * returned from textblock calls, and all the other derivative values.
583 * @param obj The entry object
584 * @return The textblock object.
586 EAPI Evas_Object * elm_entry_textblock_get(Evas_Object *obj);
589 * Forces calculation of the entry size and text layouting.
591 * This should be used after modifying the textblock object directly. See
592 * elm_entry_textblock_get() for more information.
594 * @param obj The entry object
596 * @see elm_entry_textblock_get()
598 EAPI void elm_entry_calc_force(Evas_Object *obj);
601 * Inserts the given text into the entry at the current cursor position.
603 * This inserts text at the cursor position as if it was typed
604 * by the user (note that this also allows markup which a user
605 * can't just "type" as it would be converted to escaped text, so this
606 * call can be used to insert things like emoticon items or bold push/pop
607 * tags, other font and color change tags etc.)
609 * If any selection exists, it will be replaced by the inserted text.
611 * The inserted text is subject to any filters set for the widget.
613 * @param obj The entry object
614 * @param entry The text to insert
616 * @see elm_entry_markup_filter_append()
618 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry);
621 * Set the line wrap type to use on multi-line entries.
623 * Sets the wrap type used by the entry to any of the specified in
624 * Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
625 * line (without inserting a line break or paragraph separator) when it
626 * reaches the far edge of the widget.
628 * Note that this only makes sense for multi-line entries. A widget set
629 * to be single line will never wrap.
631 * @param obj The entry object
632 * @param wrap The wrap mode to use. See Elm_Wrap_Type for details on them
634 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap);
637 * Gets the wrap mode the entry was set to use.
639 * @param obj The entry object
642 * @see also elm_entry_line_wrap_set()
644 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj);
647 * Sets if the entry is to be editable or not.
649 * By default, entries are editable and when focused, any text input by the
650 * user will be inserted at the current cursor position. But calling this
651 * function with @p editable as EINA_FALSE will prevent the user from
652 * inputting text into the entry.
654 * The only way to change the text of a non-editable entry is to use
655 * elm_object_text_set(), elm_entry_entry_insert() and other related
658 * @param obj The entry object
659 * @param editable If EINA_TRUE, user input will be inserted in the entry,
660 * if not, the entry is read-only and no user input is allowed.
662 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable);
665 * Gets whether the entry is editable or not.
667 * @param obj The entry object
668 * @return If true, the entry is editable by the user.
669 * If false, it is not editable by the user
671 * @see elm_entry_editable_set()
673 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj);
676 * This drops any existing text selection within the entry.
678 * @param obj The entry object
680 EAPI void elm_entry_select_none(Evas_Object *obj);
683 * This selects all text within the entry.
685 * @param obj The entry object
687 EAPI void elm_entry_select_all(Evas_Object *obj);
690 * This moves the cursor one place to the right within the entry.
692 * @param obj The entry object
693 * @return EINA_TRUE upon success, EINA_FALSE upon failure
695 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj);
698 * This moves the cursor one place to the left within the entry.
700 * @param obj The entry object
701 * @return EINA_TRUE upon success, EINA_FALSE upon failure
703 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj);
706 * This moves the cursor one line up within the entry.
708 * @param obj The entry object
709 * @return EINA_TRUE upon success, EINA_FALSE upon failure
711 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj);
714 * This moves the cursor one line down within the entry.
716 * @param obj The entry object
717 * @return EINA_TRUE upon success, EINA_FALSE upon failure
719 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj);
722 * This moves the cursor to the beginning of the entry.
724 * @param obj The entry object
726 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj);
729 * This moves the cursor to the end of the entry.
731 * @param obj The entry object
733 EAPI void elm_entry_cursor_end_set(Evas_Object *obj);
736 * This moves the cursor to the beginning of the current line.
738 * @param obj The entry object
740 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj);
743 * This moves the cursor to the end of the current line.
745 * @param obj The entry object
747 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj);
750 * This begins a selection within the entry as though
751 * the user were holding down the mouse button to make a selection.
753 * @param obj The entry object
755 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj);
758 * This ends a selection within the entry as though
759 * the user had just released the mouse button while making a selection.
761 * @param obj The entry object
763 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj);
766 * Gets whether a format node exists at the current cursor position.
768 * A format node is anything that defines how the text is rendered. It can
769 * be a visible format node, such as a line break or a paragraph separator,
770 * or an invisible one, such as bold begin or end tag.
771 * This function returns whether any format node exists at the current
774 * @param obj The entry object
775 * @return EINA_TRUE if the current cursor position contains a format node,
776 * EINA_FALSE otherwise.
778 * @see elm_entry_cursor_is_visible_format_get()
780 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj);
783 * Gets if the current cursor position holds a visible format node.
785 * @param obj The entry object
786 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
787 * if it's an invisible one or no format exists.
789 * @see elm_entry_cursor_is_format_get()
791 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj);
794 * Gets the character pointed by the cursor at its current position.
796 * This function returns a string with the utf8 character stored at the
797 * current cursor position.
798 * Only the text is returned, any format that may exist will not be part
799 * of the return value. You must free the string when done with free().
801 * @param obj The entry object
802 * @return The text pointed by the cursors.
804 EAPI char *elm_entry_cursor_content_get(const Evas_Object *obj);
807 * This function returns the geometry of the cursor.
809 * It's useful if you want to draw something on the cursor (or where it is),
810 * or for example in the case of scrolled entry where you want to show the
813 * @param obj The entry object
814 * @param x returned geometry
815 * @param y returned geometry
816 * @param w returned geometry
817 * @param h returned geometry
818 * @return EINA_TRUE upon success, EINA_FALSE upon failure
820 EAPI Eina_Bool elm_entry_cursor_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
823 * Sets the cursor position in the entry to the given value
825 * The value in @p pos is the index of the character position within the
826 * contents of the string as returned by elm_entry_cursor_pos_get().
828 * @param obj The entry object
829 * @param pos The position of the cursor
831 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos);
834 * Retrieves the current position of the cursor in the entry
836 * @param obj The entry object
837 * @return The cursor position
839 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj);
842 * This executes a "cut" action on the selected text in the entry.
844 * @param obj The entry object
846 EAPI void elm_entry_selection_cut(Evas_Object *obj);
849 * This executes a "copy" action on the selected text in the entry.
851 * @param obj The entry object
853 EAPI void elm_entry_selection_copy(Evas_Object *obj);
856 * This executes a "paste" action in the entry.
858 * @param obj The entry object
860 EAPI void elm_entry_selection_paste(Evas_Object *obj);
863 * This clears and frees the items in a entry's contextual (longpress)
866 * @param obj The entry object
868 * @see elm_entry_context_menu_item_add()
870 EAPI void elm_entry_context_menu_clear(Evas_Object *obj);
873 * This adds an item to the entry's contextual menu.
875 * A longpress on an entry will make the contextual menu show up, if this
876 * hasn't been disabled with elm_entry_context_menu_disabled_set().
877 * By default, this menu provides a few options like enabling selection mode,
878 * which is useful on embedded devices that need to be explicit about it,
879 * and when a selection exists it also shows the copy and cut actions.
881 * With this function, developers can add other options to this menu to
882 * perform any action they deem necessary.
884 * @param obj The entry object
885 * @param label The item's text label
886 * @param icon_file The item's icon file
887 * @param icon_type The item's icon type
888 * @param func The callback to execute when the item is clicked
889 * @param data The data to associate with the item for related functions
891 EAPI 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);
894 * This disables the entry's contextual (longpress) menu.
896 * @param obj The entry object
897 * @param disabled If true, the menu is disabled
899 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled);
902 * This returns whether the entry's contextual (longpress) menu is
905 * @param obj The entry object
906 * @return If true, the menu is disabled
908 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj);
911 * This appends a custom item provider to the list for that entry
913 * This appends the given callback. The list is walked from beginning to end
914 * with each function called given the item href string in the text. If the
915 * function returns an object handle other than NULL (it should create an
916 * object to do this), then this object is used to replace that item. If
917 * not the next provider is called until one provides an item object, or the
918 * default provider in entry does.
920 * @param obj The entry object
921 * @param func The function called to provide the item object
922 * @param data The data passed to @p func
924 * @see @ref entry-items
926 EAPI void elm_entry_item_provider_append(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
929 * This prepends a custom item provider to the list for that entry
931 * This prepends the given callback. See elm_entry_item_provider_append() for
934 * @param obj The entry object
935 * @param func The function called to provide the item object
936 * @param data The data passed to @p func
938 EAPI void elm_entry_item_provider_prepend(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
941 * This removes a custom item provider to the list for that entry
943 * This removes the given callback. See elm_entry_item_provider_append() for
946 * @param obj The entry object
947 * @param func The function called to provide the item object
948 * @param data The data passed to @p func
950 EAPI void elm_entry_item_provider_remove(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
953 * Append a markup filter function for text inserted in the entry
955 * Append the given callback to the list. This functions will be called
956 * whenever any text is inserted into the entry, with the text to be inserted
957 * as a parameter. The type of given text is always markup.
958 * The callback function is free to alter the text in any way it wants, but
959 * it must remember to free the given pointer and update it.
960 * If the new text is to be discarded, the function can free it and set its
961 * text parameter to NULL. This will also prevent any following filters from
964 * @param obj The entry object
965 * @param func The function to use as text filter
966 * @param data User data to pass to @p func
968 EAPI void elm_entry_markup_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
971 * Prepend a markup filter function for text inserted in the entry
973 * Prepend the given callback to the list. See elm_entry_markup_filter_append()
974 * for more information
976 * @param obj The entry object
977 * @param func The function to use as text filter
978 * @param data User data to pass to @p func
980 EAPI void elm_entry_markup_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
983 * Remove a markup filter from the list
985 * Removes the given callback from the filter list. See
986 * elm_entry_markup_filter_append() for more information.
988 * @param obj The entry object
989 * @param func The filter function to remove
990 * @param data The user data passed when adding the function
992 EAPI void elm_entry_markup_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
995 * This converts a markup (HTML-like) string into UTF-8.
997 * The returned string is a malloc'ed buffer and it should be freed when
998 * not needed anymore.
1000 * @param s The string (in markup) to be converted
1001 * @return The converted string (in UTF-8). It should be freed.
1003 EAPI char *elm_entry_markup_to_utf8(const char *s);
1006 * This converts a UTF-8 string into markup (HTML-like).
1008 * The returned string is a malloc'ed buffer and it should be freed when
1009 * not needed anymore.
1011 * @param s The string (in UTF-8) to be converted
1012 * @return The converted string (in markup). It should be freed.
1014 EAPI char *elm_entry_utf8_to_markup(const char *s);
1017 * This sets the file (and implicitly loads it) for the text to display and
1018 * then edit. All changes are written back to the file after a short delay if
1019 * the entry object is set to autosave (which is the default).
1021 * If the entry had any other file set previously, any changes made to it
1022 * will be saved if the autosave feature is enabled, otherwise, the file
1023 * will be silently discarded and any non-saved changes will be lost.
1025 * @param obj The entry object
1026 * @param file The path to the file to load and save
1027 * @param format The file format
1029 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format);
1032 * Gets the file being edited by the entry.
1034 * This function can be used to retrieve any file set on the entry for
1035 * edition, along with the format used to load and save it.
1037 * @param obj The entry object
1038 * @param file The path to the file to load and save
1039 * @param format The file format
1041 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format);
1044 * This function writes any changes made to the file set with
1045 * elm_entry_file_set()
1047 * @param obj The entry object
1049 EAPI void elm_entry_file_save(Evas_Object *obj);
1052 * This sets the entry object to 'autosave' the loaded text file or not.
1054 * @param obj The entry object
1055 * @param autosave Autosave the loaded file or not
1057 * @see elm_entry_file_set()
1059 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave);
1062 * This gets the entry object's 'autosave' status.
1064 * @param obj The entry object
1065 * @return Autosave the loaded file or not
1067 * @see elm_entry_file_set()
1069 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj);
1072 * Enable or disable scrolling in entry
1074 * Normally the entry is not scrollable unless you enable it with this call.
1076 * @param obj The entry object
1077 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
1079 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
1082 * Get the scrollable state of the entry
1084 * Normally the entry is not scrollable. This gets the scrollable state
1085 * of the entry. See elm_entry_scrollable_set() for more information.
1087 * @param obj The entry object
1088 * @return The scrollable state
1090 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
1093 * Sets the visibility of the left-side widget of the scrolled entry,
1094 * set by elm_entry_icon_set().
1096 * @param obj The scrolled entry object
1097 * @param setting EINA_TRUE if the object should be displayed,
1098 * EINA_FALSE if not.
1100 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
1103 * Sets the visibility of the end widget of the scrolled entry, set by
1104 * elm_object_part_content_set(ent, "end", content).
1106 * @param obj The scrolled entry object
1107 * @param setting EINA_TRUE if the object should be displayed,
1108 * EINA_FALSE if not.
1110 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
1113 * This sets the scrolled entry's scrollbar policy (i.e. enabling/disabling
1116 * Setting an entry to single-line mode with elm_entry_single_line_set()
1117 * will automatically disable the display of scrollbars when the entry
1118 * moves inside its scroller.
1120 * @param obj The scrolled entry object
1121 * @param h The horizontal scrollbar policy to apply
1122 * @param v The vertical scrollbar policy to apply
1124 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
1127 * This enables/disables bouncing within the entry.
1129 * This function sets whether the entry will bounce when scrolling reaches
1130 * the end of the contained entry.
1132 * @param obj The scrolled entry object
1133 * @param h_bounce The horizontal bounce state
1134 * @param v_bounce The vertical bounce state
1136 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
1139 * Get the bounce mode
1141 * @param obj The Entry object
1142 * @param h_bounce Allow bounce horizontally
1143 * @param v_bounce Allow bounce vertically
1145 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
1148 * Set the input panel layout of the entry
1150 * @param obj The entry object
1151 * @param layout layout type
1153 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
1156 * Get the input panel layout of the entry
1158 * @param obj The entry object
1159 * @return layout type
1161 * @see elm_entry_input_panel_layout_set
1163 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(const Evas_Object *obj);
1166 * Set the autocapitalization type on the immodule.
1168 * @param obj The entry object
1169 * @param autocapital_type The type of autocapitalization
1171 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type);
1174 * Retrieve the autocapitalization type on the immodule.
1176 * @param obj The entry object
1177 * @return autocapitalization type
1179 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(const Evas_Object *obj);
1182 * Sets the attribute to show the input panel automatically.
1184 * @param obj The entry object
1185 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
1187 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
1190 * Retrieve the attribute to show the input panel automatically.
1192 * @param obj The entry object
1193 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
1195 EAPI Eina_Bool elm_entry_input_panel_enabled_get(const Evas_Object *obj);
1198 * Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
1200 * Note that input panel is shown or hidden automatically according to the focus state of entry widget.
1201 * This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE).
1203 * @param obj The entry object
1205 EAPI void elm_entry_input_panel_show(Evas_Object *obj);
1208 * Hide the input panel (virtual keyboard).
1210 * Note that input panel is shown or hidden automatically according to the focus state of entry widget.
1211 * This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE)
1213 * @param obj The entry object
1215 EAPI void elm_entry_input_panel_hide(Evas_Object *obj);
1218 * Set the language mode of the input panel.
1220 * This API can be used if you want to show the alphabet keyboard mode.
1222 * @param obj The entry object
1223 * @param lang language to be set to the input panel.
1225 EAPI void elm_entry_input_panel_language_set(Evas_Object *obj, Elm_Input_Panel_Lang lang);
1228 * Get the language mode of the input panel.
1230 * See @ref elm_entry_input_panel_language_set for more details.
1232 * @param obj The entry object
1233 * @return input panel language type
1235 EAPI Elm_Input_Panel_Lang elm_entry_input_panel_language_get(const Evas_Object *obj);
1238 * Set the input panel-specific data to deliver to the input panel.
1240 * This API is used by applications to deliver specific data to the input panel.
1241 * The data format MUST be negotiated by both application and the input panel.
1242 * The size and format of data are defined by the input panel.
1244 * @param obj The entry object
1245 * @param data The specific data to be set to the input panel.
1246 * @param len the length of data, in bytes, to send to the input panel
1248 EAPI void elm_entry_input_panel_imdata_set(Evas_Object *obj, const void *data, int len);
1251 * Get the specific data of the current input panel.
1253 * See @ref elm_entry_input_panel_imdata_set for more details.
1255 * @param obj The entry object
1256 * @param data The specific data to be got from the input panel
1257 * @param len The length of data
1259 EAPI void elm_entry_input_panel_imdata_get(const Evas_Object *obj, void *data, int *len);
1262 * Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
1264 * An input panel displays the string or icon associated with this type
1266 * @param obj The entry object
1267 * @param return_key_type The type of "return" key on the input panel
1269 EAPI void elm_entry_input_panel_return_key_type_set(Evas_Object *obj, Elm_Input_Panel_Return_Key_Type return_key_type);
1272 * Get the "return" key type.
1274 * @see elm_entry_input_panel_return_key_type_set() for more details
1276 * @param obj The entry object
1277 * @return The type of "return" key on the input panel
1279 EAPI Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get(const Evas_Object *obj);
1282 * Set the return key on the input panel to be disabled.
1284 * @param obj The entry object
1285 * @param disabled The state to put in in: @c EINA_TRUE for
1286 * disabled, @c EINA_FALSE for enabled
1288 EAPI void elm_entry_input_panel_return_key_disabled_set(Evas_Object *obj, Eina_Bool disabled);
1291 * Get whether the return key on the input panel should be disabled or not.
1293 * @param obj The entry object
1294 * @return EINA_TRUE if it should be disabled
1296 EAPI Eina_Bool elm_entry_input_panel_return_key_disabled_get(const Evas_Object *obj);
1299 * Set whether the return key on the input panel is disabled automatically when entry has no text.
1301 * If @p enabled is EINA_TRUE, The return key on input panel is disabled when the entry has no text.
1302 * The return key on the input panel is automatically enabled when the entry has text.
1303 * The default value is EINA_FALSE.
1305 * @param obj The entry object
1306 * @param enabled If @p enabled is EINA_TRUE, the return key is automatically disabled when the entry has no text.
1308 EAPI void elm_entry_input_panel_return_key_autoenabled_set(Evas_Object *obj, Eina_Bool enabled);
1311 * Reset the input method context of the entry if needed.
1313 * This can be necessary in the case where modifying the buffer would confuse on-going input method behavior
1314 * @param obj The entry object
1316 EAPI void elm_entry_imf_context_reset(Evas_Object *obj);
1319 * Set whether the entry should allow to use the text prediction.
1321 * @param obj The entry object
1322 * @param prediction Whether the entry should allow to use the text prediction.
1324 EAPI void elm_entry_prediction_allow_set(Evas_Object *obj, Eina_Bool prediction);
1327 * Get whether the entry should allow to use the text prediction.
1329 * @param obj The entry object
1330 * @return EINA_TRUE if it allows to use the text prediction, otherwise EINA_FALSE.
1332 EAPI Eina_Bool elm_entry_prediction_allow_get(const Evas_Object *obj);
1334 /* pre-made filters for entries */
1337 * @typedef Elm_Entry_Filter_Limit_Size
1339 * Data for the elm_entry_filter_limit_size() entry filter.
1341 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
1344 * @struct _Elm_Entry_Filter_Limit_Size
1346 * Data for the elm_entry_filter_limit_size() entry filter.
1348 struct _Elm_Entry_Filter_Limit_Size
1350 int max_char_count; /**< The maximum number of characters allowed. */
1351 int max_byte_count; /**< The maximum number of bytes allowed*/
1355 * Filter inserted text based on user defined character and byte limits
1357 * Add this filter to an entry to limit the characters that it will accept
1358 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
1359 * The function works on the UTF-8 representation of the string, converting
1360 * it from the set markup, thus not accounting for any format in it.
1362 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
1363 * it as data when setting the filter. In it, it's possible to set limits
1364 * by character count or bytes (any of them is disabled if 0), and both can
1365 * be set at the same time. In that case, it first checks for characters,
1366 * then bytes. The #Elm_Entry_Filter_Limit_Size structure must be alive and
1367 * valid for as long as the entyr is alive AND the elm_entry_filter_limit_size
1370 * The function will cut the inserted text in order to allow only the first
1371 * number of characters that are still allowed. The cut is made in
1372 * characters, even when limiting by bytes, in order to always contain
1373 * valid ones and avoid half unicode characters making it in.
1375 * This filter, like any others, does not apply when setting the entry text
1376 * directly with elm_object_text_set().
1378 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text);
1381 * @typedef Elm_Entry_Filter_Accept_Set
1383 * Data for the elm_entry_filter_accept_set() entry filter.
1385 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
1388 * @struct _Elm_Entry_Filter_Accept_Set
1390 * Data for the elm_entry_filter_accept_set() entry filter.
1392 struct _Elm_Entry_Filter_Accept_Set
1394 const char *accepted; /**< Set of characters accepted in the entry. */
1395 const char *rejected; /**< Set of characters rejected from the entry. */
1399 * Filter inserted text based on accepted or rejected sets of characters
1401 * Add this filter to an entry to restrict the set of accepted characters
1402 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
1403 * This structure contains both accepted and rejected sets, but they are
1404 * mutually exclusive. This structure must be available for as long as
1405 * the entry is alive AND the elm_entry_filter_accept_set is being used.
1407 * The @c accepted set takes preference, so if it is set, the filter will
1408 * only work based on the accepted characters, ignoring anything in the
1409 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
1411 * In both cases, the function filters by matching utf8 characters to the
1412 * raw markup text, so it can be used to remove formatting tags.
1414 * This filter, like any others, does not apply when setting the entry text
1415 * directly with elm_object_text_set()
1417 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text);
1420 * Returns the input method context of the entry.
1422 * This function exposes the internal input method context.
1424 * IMPORTANT: Many functions may change (i.e delete and create a new one)
1425 * the internal input method context. Do NOT cache the returned object.
1427 * @param obj The entry object
1428 * @return The input method context (Ecore_IMF_Context *) in entry.
1430 EAPI void *elm_entry_imf_context_get(Evas_Object *obj);
1433 * @enum _Elm_Cnp_Mode
1434 * @typedef Elm_Cnp_Mode
1435 * Enum of entry's copy & paste policy.
1437 * @see elm_entry_cnp_mode_set()
1438 * @see elm_entry_cnp_mode_get()
1440 typedef enum _Elm_Cnp_Mode {
1441 ELM_CNP_MODE_MARKUP, /**< copy & paste text with markup tag */
1442 ELM_CNP_MODE_NO_IMAGE, /**< copy & paste text without item(image) tag */
1443 ELM_CNP_MODE_PLAINTEXT /**< copy & paste text without markup tag */
1447 * Control pasting of text and images for the widget.
1449 * Normally the entry allows both text and images to be pasted.
1450 * By setting cnp_mode to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
1451 * By setting cnp_mode to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
1453 * @note this only changes the behaviour of text.
1455 * @param obj The entry object
1456 * @param mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP,
1457 * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
1459 EAPI void elm_entry_cnp_mode_set(Evas_Object *obj, Elm_Cnp_Mode cnp_mode);
1462 * Getting elm_entry text paste/drop mode.
1464 * Normally the entry allows both text and images to be pasted.
1465 * This gets the copy & paste mode of the entry.
1467 * @param obj The entry object
1468 * @return mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP,
1469 * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
1471 EAPI Elm_Cnp_Mode elm_entry_cnp_mode_get(const Evas_Object *obj);
1474 * Set the parent of the hover popup
1476 * Sets the parent object to use by the hover created by the entry
1477 * when an anchor is clicked. See @ref Hover for more details on this.
1479 * @param obj The entry object
1480 * @param parent The object to use as parent for the hover
1482 EAPI void elm_entry_anchor_hover_parent_set(Evas_Object *obj, Evas_Object *parent);
1485 * Get the parent of the hover popup
1487 * Get the object used as parent for the hover created by the entry
1488 * widget. See @ref Hover for more details on this.
1489 * If no parent is set, the same entry object will be used.
1491 * @param obj The entry object
1492 * @return The object used as parent for the hover, NULL if none is set.
1494 EAPI Evas_Object *elm_entry_anchor_hover_parent_get(const Evas_Object *obj);
1497 * Set the style that the hover should use
1499 * When creating the popup hover, entry will request that it's
1500 * themed according to @p style.
1502 * Setting style no NULL means disabling automatic hover.
1504 * @param obj The entry object
1505 * @param style The style to use for the underlying hover
1507 * @see elm_object_style_set()
1509 EAPI void elm_entry_anchor_hover_style_set(Evas_Object *obj, const char *style);
1512 * Get the style that the hover should use
1514 * Get the style, the hover created by entry will use.
1516 * @param obj The entry object
1517 * @return The style to use by the hover. NULL means the default is used.
1519 * @see elm_object_style_set()
1521 EAPI const char *elm_entry_anchor_hover_style_get(const Evas_Object *obj);
1524 * Ends the hover popup in the entry
1526 * When an anchor is clicked, the entry widget will create a hover
1527 * object to use as a popup with user provided content. This function
1528 * terminates this popup, returning the entry to its normal state.
1530 * @param obj The entry object
1532 EAPI void elm_entry_anchor_hover_end(Evas_Object *obj);