3 ELM_TEXT_FORMAT_PLAIN_UTF8,
4 ELM_TEXT_FORMAT_MARKUP_UTF8
12 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
13 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
14 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
15 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
17 } Elm_Wrap_Type; /**< Type of word or character wrapping to use */
21 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
22 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
23 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
24 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
25 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
26 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
27 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
28 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
29 ELM_INPUT_PANEL_LAYOUT_INVALID, /**< Never use this */
30 ELM_INPUT_PANEL_LAYOUT_HEX, /**< Hexadecimal layout */
31 ELM_INPUT_PANEL_LAYOUT_TERMINAL, /**< Command-line terminal layout */
32 ELM_INPUT_PANEL_LAYOUT_PASSWORD /**< Like normal, but no auto-correct, no auto-capitalization etc. */
33 } Elm_Input_Panel_Layout; /**< Type of input panel (virtual keyboard) to use - this is a hint and may not provide exactly what is desired. */
37 ELM_INPUT_PANEL_LANG_AUTOMATIC, /**< Automatic */
38 ELM_INPUT_PANEL_LANG_ALPHABET /**< Alphabet */
39 } Elm_Input_Panel_Lang;
43 ELM_AUTOCAPITAL_TYPE_NONE, /**< No auto-capitalization when typing */
44 ELM_AUTOCAPITAL_TYPE_WORD, /**< Autocapitalize each word typed */
45 ELM_AUTOCAPITAL_TYPE_SENTENCE, /**< Autocapitalize the start of each sentence */
46 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters */
47 } Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
51 ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT,
52 ELM_INPUT_PANEL_RETURN_KEY_TYPE_DONE,
53 ELM_INPUT_PANEL_RETURN_KEY_TYPE_GO,
54 ELM_INPUT_PANEL_RETURN_KEY_TYPE_JOIN,
55 ELM_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN,
56 ELM_INPUT_PANEL_RETURN_KEY_TYPE_NEXT,
57 ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH,
58 ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEND
59 } Elm_Input_Panel_Return_Key_Type;
63 * @typedef Elm_CNP_Mode
64 * Enum of entry's copy & paste policy.
66 * @see elm_entry_cnp_mode_set()
67 * @see elm_entry_cnp_mode_get()
69 typedef enum _Elm_CNP_Mode {
70 ELM_CNP_MODE_MARKUP = 0, /**< copy & paste text with markup tag */
71 ELM_CNP_MODE_NO_IMAGE = 1, /**< copy & paste text without item(image) tag */
72 ELM_CNP_MODE_PLAINTEXT = 2 /**< copy & paste text without markup tag */
76 * @defgroup Entry Entry
78 * @image html img/widget/entry/preview-00.png
79 * @image latex img/widget/entry/preview-00.eps width=\textwidth
80 * @image html img/widget/entry/preview-01.png
81 * @image latex img/widget/entry/preview-01.eps width=\textwidth
82 * @image html img/widget/entry/preview-02.png
83 * @image latex img/widget/entry/preview-02.eps width=\textwidth
84 * @image html img/widget/entry/preview-03.png
85 * @image latex img/widget/entry/preview-03.eps width=\textwidth
87 * An entry is a convenience widget which shows a box that the user can
88 * enter text into. Entries by default don't scroll, so they grow to
89 * accomodate the entire text, resizing the parent window as needed. This
90 * can be changed with the elm_entry_scrollable_set() function.
92 * They can also be single line or multi line (the default) and when set
93 * to multi line mode they support text wrapping in any of the modes
94 * indicated by Elm_Wrap_Type.
96 * Other features include password mode, filtering of inserted text with
97 * elm_entry_text_filter_append() and related functions, inline "items" and
98 * formatted markup text.
100 * @section entry-markup Formatted text
102 * The markup tags supported by the Entry are defined by the theme, but
103 * even when writing new themes or extensions it's a good idea to stick to
104 * a sane default, to maintain coherency and avoid application breakages.
105 * Currently defined by the default theme are the following tags:
106 * @li \<br\>: Inserts a line break.
107 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
109 * @li \<tab\>: Inserts a tab.
110 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
112 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
113 * @li \<link\>...\</link\>: Underlines the enclosed text.
114 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
116 * @section entry-special Special markups
118 * Besides those used to format text, entries support two special markup
119 * tags used to insert clickable portions of text or items inlined within
122 * @subsection entry-anchors Anchors
124 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
125 * \</a\> tags and an event will be generated when this text is clicked,
129 * This text is outside <a href=anc-01>but this one is an anchor</a>
132 * The @c href attribute in the opening tag gives the name that will be
133 * used to identify the anchor and it can be any valid utf8 string.
135 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
136 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
137 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
138 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
141 * @subsection entry-items Items
143 * Inlined in the text, any other @c Evas_Object can be inserted by using
144 * \<item\> tags this way:
147 * <item size=16x16 vsize=full href=emoticon/haha></item>
150 * Just like with anchors, the @c href identifies each item, but these need,
151 * in addition, to indicate their size, which is done using any one of
152 * @c size, @c absize or @c relsize attributes. These attributes take their
153 * value in the WxH format, where W is the width and H the height of the
156 * @li absize: Absolute pixel size for the item. Whatever value is set will
157 * be the item's size regardless of any scale value the object may have
158 * been set to. The final line height will be adjusted to fit larger items.
159 * @li size: Similar to @c absize, but it's adjusted to the scale value set
161 * @li relsize: Size is adjusted for the item to fit within the current
164 * Besides their size, items are specificed a @c vsize value that affects
165 * how their final size and position are calculated. The possible values
167 * @li ascent: Item will be placed within the line's baseline and its
168 * ascent. That is, the height between the line where all characters are
169 * positioned and the highest point in the line. For @c size and @c absize
170 * items, the descent value will be added to the total line height to make
171 * them fit. @c relsize items will be adjusted to fit within this space.
172 * @li full: Items will be placed between the descent and ascent, or the
173 * lowest point in the line and its highest.
175 * The next image shows different configurations of items and how
176 * the previously mentioned options affect their sizes. In all cases,
177 * the green line indicates the ascent, blue for the baseline and red for
180 * @image html entry_item.png
181 * @image latex entry_item.eps width=\textwidth
183 * And another one to show how size differs from absize. In the first one,
184 * the scale value is set to 1.0, while the second one is using one of 2.0.
186 * @image html entry_item_scale.png
187 * @image latex entry_item_scale.eps width=\textwidth
189 * After the size for an item is calculated, the entry will request an
190 * object to place in its space. For this, the functions set with
191 * elm_entry_item_provider_append() and related functions will be called
192 * in order until one of them returns a @c non-NULL value. If no providers
193 * are available, or all of them return @c NULL, then the entry falls back
194 * to one of the internal defaults, provided the name matches with one of
197 * All of the following are currently supported:
200 * - emoticon/angry-shout
201 * - emoticon/crazy-laugh
202 * - emoticon/evil-laugh
204 * - emoticon/goggle-smile
206 * - emoticon/grumpy-smile
208 * - emoticon/guilty-smile
210 * - emoticon/half-smile
211 * - emoticon/happy-panting
213 * - emoticon/indifferent
215 * - emoticon/knowing-grin
217 * - emoticon/little-bit-sorry
218 * - emoticon/love-lots
220 * - emoticon/minimal-smile
221 * - emoticon/not-happy
222 * - emoticon/not-impressed
224 * - emoticon/opensmile
227 * - emoticon/squint-laugh
228 * - emoticon/surprised
229 * - emoticon/suspicious
230 * - emoticon/tongue-dangling
231 * - emoticon/tongue-poke
234 * - emoticon/very-sorry
240 * Alternatively, an item may reference an image by its path, using
241 * the URI form @c file:///path/to/an/image.png and the entry will then
242 * use that image for the item.
244 * @section entry-files Loading and saving files
246 * Entries have convinience functions to load text from a file and save
247 * changes back to it after a short delay. The automatic saving is enabled
248 * by default, but can be disabled with elm_entry_autosave_set() and files
249 * can be loaded directly as plain text or have any markup in them
250 * recognized. See elm_entry_file_set() for more details.
252 * @section entry-signals Emitted signals
254 * This widget emits the following signals:
256 * @li "changed": The text within the entry was changed.
257 * @li "changed,user": The text within the entry was changed because of user interaction.
258 * @li "activated": The enter key was pressed on a single line entry.
259 * @li "press": A mouse button has been pressed on the entry.
260 * @li "longpressed": A mouse button has been pressed and held for a couple
262 * @li "clicked": The entry has been clicked (mouse press and release).
263 * @li "clicked,double": The entry has been double clicked.
264 * @li "clicked,triple": The entry has been triple clicked.
265 * @li "focused": The entry has received focus.
266 * @li "unfocused": The entry has lost focus.
267 * @li "selection,paste": A paste of the clipboard contents was requested.
268 * @li "selection,copy": A copy of the selected text into the clipboard was
270 * @li "selection,cut": A cut of the selected text into the clipboard was
272 * @li "selection,start": A selection has begun and no previous selection
274 * @li "selection,changed": The current selection has changed.
275 * @li "selection,cleared": The current selection has been cleared.
276 * @li "cursor,changed": The cursor has changed position.
277 * @li "anchor,clicked": An anchor has been clicked. The event_info
278 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
279 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
280 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
281 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
282 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
283 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
284 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
285 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
286 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
287 * @li "preedit,changed": The preedit string has changed.
288 * @li "language,changed": Program language changed.
290 * Default contents parts of the entry items that you can use for are:
291 * @li "icon" - An icon in the entry
292 * @li "end" - A content in the end of the entry
294 * Default text parts of the entry that you can use for are:
295 * @li "default" - text of the entry
297 * Supported elm_object common APIs.
298 * @li elm_object_signal_emit
299 * @li elm_object_part_text_set
300 * @li elm_object_part_text_get
301 * @li elm_object_part_content_set
302 * @li elm_object_part_content_get
303 * @li elm_object_part_content_unset
304 * @li elm_object_signal_callback_add
305 * @li elm_object_signal_callback_del
306 * @li elm_object_disabled_set
307 * @li elm_object_disabled_get
309 * @section entry-examples
311 * An overview of the Entry API can be seen in @ref entry_example_01
317 * @typedef Elm_Entry_Anchor_Info
319 * The info sent in the callback for the "anchor,clicked" signals emitted
322 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
325 * @struct _Elm_Entry_Anchor_Info
327 * The info sent in the callback for the "anchor,clicked" signals emitted
330 struct _Elm_Entry_Anchor_Info
332 const char *name; /**< The name of the anchor, as stated in its href */
333 int button; /**< The mouse button used to click on it */
334 Evas_Coord x, /**< Anchor geometry, relative to canvas */
335 y, /**< Anchor geometry, relative to canvas */
336 w, /**< Anchor geometry, relative to canvas */
337 h; /**< Anchor geometry, relative to canvas */
341 * @typedef Elm_Entry_Filter_Cb
342 * This callback type is used by entry filters to modify text.
343 * @param data The data specified as the last param when adding the filter
344 * @param entry The entry object
345 * @param text A pointer to the location of the text being filtered. This data can be modified,
346 * but any additional allocations must be managed by the user.
347 * @see elm_entry_text_filter_append
348 * @see elm_entry_text_filter_prepend
350 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
353 * @typedef Elm_Entry_Change_Info
354 * This corresponds to Edje_Entry_Change_Info. Includes information about
355 * a change in the entry.
357 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
360 * This adds an entry to @p parent object.
362 * By default, entries are:
366 * @li autosave is enabled
368 * @param parent The parent object
369 * @return The new object or NULL if it cannot be created
371 EAPI Evas_Object *elm_entry_add(Evas_Object *parent);
374 * Sets the entry to single line mode.
376 * In single line mode, entries don't ever wrap when the text reaches the
377 * edge, and instead they keep growing horizontally. Pressing the @c Enter
378 * key will generate an @c "activate" event instead of adding a new line.
380 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
381 * and pressing enter will break the text into a different line
382 * without generating any events.
384 * @param obj The entry object
385 * @param single_line If true, the text in the entry
386 * will be on a single line.
388 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
391 * Gets whether the entry is set to be single line.
393 * @param obj The entry object
394 * @return single_line If true, the text in the entry is set to display
397 * @see elm_entry_single_line_set()
399 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj);
402 * Sets the entry to password mode.
404 * In password mode, entries are implicitly single line and the display of
405 * any text in them is replaced with asterisks (*).
407 * @param obj The entry object
408 * @param password If true, password mode is enabled.
410 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password);
413 * Gets whether the entry is set to password mode.
415 * @param obj The entry object
416 * @return If true, the entry is set to display all characters
419 * @see elm_entry_password_set()
421 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj);
424 * This sets the text displayed within the entry to @p entry.
426 * @param obj The entry object
427 * @param entry The text to be displayed
429 * @note Using this function bypasses text filters
431 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry);
434 * This returns the text currently shown in object @p entry.
435 * See also elm_entry_entry_set().
437 * @param obj The entry object
438 * @return The currently displayed text or NULL on failure
440 EAPI const char *elm_entry_entry_get(const Evas_Object *obj);
443 * Appends @p entry to the text of the entry.
445 * Adds the text in @p entry to the end of any text already present in the
448 * The appended text is subject to any filters set for the widget.
450 * @param obj The entry object
451 * @param entry The text to be displayed
453 * @see elm_entry_text_filter_append()
455 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry);
458 * Gets whether the entry is empty.
460 * Empty means no text at all. If there are any markup tags, like an item
461 * tag for which no provider finds anything, and no text is displayed, this
462 * function still returns EINA_FALSE.
464 * @param obj The entry object
465 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
467 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj);
470 * Gets any selected text within the entry.
472 * If there's any selected text in the entry, this function returns it as
473 * a string in markup format. NULL is returned if no selection exists or
474 * if an error occurred.
476 * The returned value points to an internal string and should not be freed
477 * or modified in any way. If the @p entry object is deleted or its
478 * contents are changed, the returned pointer should be considered invalid.
480 * @param obj The entry object
481 * @return The selected text within the entry or NULL on failure
483 EAPI const char *elm_entry_selection_get(const Evas_Object *obj);
486 * Returns the actual textblock object of the entry.
488 * This function exposes the internal textblock object that actually
489 * contains and draws the text. This should be used for low-level
490 * manipulations that are otherwise not possible.
492 * Changing the textblock directly from here will not notify edje/elm to
493 * recalculate the textblock size automatically, so any modifications
494 * done to the textblock returned by this function should be followed by
495 * a call to elm_entry_calc_force().
497 * The return value is marked as const as an additional warning.
498 * One should not use the returned object with any of the generic evas
499 * functions (geometry_get/resize/move and etc), but only with the textblock
500 * functions; The former will either not work at all, or break the correct
503 * IMPORTANT: Many functions may change (i.e delete and create a new one)
504 * the internal textblock object. Do NOT cache the returned object, and try
505 * not to mix calls on this object with regular elm_entry calls (which may
506 * change the internal textblock object). This applies to all cursors
507 * returned from textblock calls, and all the other derivative values.
509 * @param obj The entry object
510 * @return The textblock object.
512 EAPI Evas_Object * elm_entry_textblock_get(Evas_Object *obj);
515 * Forces calculation of the entry size and text layouting.
517 * This should be used after modifying the textblock object directly. See
518 * elm_entry_textblock_get() for more information.
520 * @param obj The entry object
522 * @see elm_entry_textblock_get()
524 EAPI void elm_entry_calc_force(Evas_Object *obj);
527 * Inserts the given text into the entry at the current cursor position.
529 * This inserts text at the cursor position as if it was typed
530 * by the user (note that this also allows markup which a user
531 * can't just "type" as it would be converted to escaped text, so this
532 * call can be used to insert things like emoticon items or bold push/pop
533 * tags, other font and color change tags etc.)
535 * If any selection exists, it will be replaced by the inserted text.
537 * The inserted text is subject to any filters set for the widget.
539 * @param obj The entry object
540 * @param entry The text to insert
542 * @see elm_entry_text_filter_append()
544 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry);
547 * Set the line wrap type to use on multi-line entries.
549 * Sets the wrap type used by the entry to any of the specified in
550 * Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
551 * line (without inserting a line break or paragraph separator) when it
552 * reaches the far edge of the widget.
554 * Note that this only makes sense for multi-line entries. A widget set
555 * to be single line will never wrap.
557 * @param obj The entry object
558 * @param wrap The wrap mode to use. See Elm_Wrap_Type for details on them
560 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap);
563 * Gets the wrap mode the entry was set to use.
565 * @param obj The entry object
568 * @see also elm_entry_line_wrap_set()
570 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj);
573 * Sets if the entry is to be editable or not.
575 * By default, entries are editable and when focused, any text input by the
576 * user will be inserted at the current cursor position. But calling this
577 * function with @p editable as EINA_FALSE will prevent the user from
578 * inputting text into the entry.
580 * The only way to change the text of a non-editable entry is to use
581 * elm_object_text_set(), elm_entry_entry_insert() and other related
584 * @param obj The entry object
585 * @param editable If EINA_TRUE, user input will be inserted in the entry,
586 * if not, the entry is read-only and no user input is allowed.
588 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable);
591 * Gets whether the entry is editable or not.
593 * @param obj The entry object
594 * @return If true, the entry is editable by the user.
595 * If false, it is not editable by the user
597 * @see elm_entry_editable_set()
599 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj);
602 * This drops any existing text selection within the entry.
604 * @param obj The entry object
606 EAPI void elm_entry_select_none(Evas_Object *obj);
609 * This selects all text within the entry.
611 * @param obj The entry object
613 EAPI void elm_entry_select_all(Evas_Object *obj);
616 * This moves the cursor one place to the right within the entry.
618 * @param obj The entry object
619 * @return EINA_TRUE upon success, EINA_FALSE upon failure
621 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj);
624 * This moves the cursor one place to the left within the entry.
626 * @param obj The entry object
627 * @return EINA_TRUE upon success, EINA_FALSE upon failure
629 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj);
632 * This moves the cursor one line up within the entry.
634 * @param obj The entry object
635 * @return EINA_TRUE upon success, EINA_FALSE upon failure
637 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj);
640 * This moves the cursor one line down within the entry.
642 * @param obj The entry object
643 * @return EINA_TRUE upon success, EINA_FALSE upon failure
645 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj);
648 * This moves the cursor to the beginning of the entry.
650 * @param obj The entry object
652 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj);
655 * This moves the cursor to the end of the entry.
657 * @param obj The entry object
659 EAPI void elm_entry_cursor_end_set(Evas_Object *obj);
662 * This moves the cursor to the beginning of the current line.
664 * @param obj The entry object
666 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj);
669 * This moves the cursor to the end of the current line.
671 * @param obj The entry object
673 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj);
676 * This begins a selection within the entry as though
677 * the user were holding down the mouse button to make a selection.
679 * @param obj The entry object
681 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj);
684 * This ends a selection within the entry as though
685 * the user had just released the mouse button while making a selection.
687 * @param obj The entry object
689 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj);
692 * Gets whether a format node exists at the current cursor position.
694 * A format node is anything that defines how the text is rendered. It can
695 * be a visible format node, such as a line break or a paragraph separator,
696 * or an invisible one, such as bold begin or end tag.
697 * This function returns whether any format node exists at the current
700 * @param obj The entry object
701 * @return EINA_TRUE if the current cursor position contains a format node,
702 * EINA_FALSE otherwise.
704 * @see elm_entry_cursor_is_visible_format_get()
706 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj);
709 * Gets if the current cursor position holds a visible format node.
711 * @param obj The entry object
712 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
713 * if it's an invisible one or no format exists.
715 * @see elm_entry_cursor_is_format_get()
717 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj);
720 * Gets the character pointed by the cursor at its current position.
722 * This function returns a string with the utf8 character stored at the
723 * current cursor position.
724 * Only the text is returned, any format that may exist will not be part
725 * of the return value. You must free the string when done with free().
727 * @param obj The entry object
728 * @return The text pointed by the cursors.
730 EAPI char *elm_entry_cursor_content_get(const Evas_Object *obj);
733 * This function returns the geometry of the cursor.
735 * It's useful if you want to draw something on the cursor (or where it is),
736 * or for example in the case of scrolled entry where you want to show the
739 * @param obj The entry object
740 * @param x returned geometry
741 * @param y returned geometry
742 * @param w returned geometry
743 * @param h returned geometry
744 * @return EINA_TRUE upon success, EINA_FALSE upon failure
746 EAPI Eina_Bool elm_entry_cursor_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
749 * Sets the cursor position in the entry to the given value
751 * The value in @p pos is the index of the character position within the
752 * contents of the string as returned by elm_entry_cursor_pos_get().
754 * @param obj The entry object
755 * @param pos The position of the cursor
757 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos);
760 * Retrieves the current position of the cursor in the entry
762 * @param obj The entry object
763 * @return The cursor position
765 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj);
768 * This executes a "cut" action on the selected text in the entry.
770 * @param obj The entry object
772 EAPI void elm_entry_selection_cut(Evas_Object *obj);
775 * This executes a "copy" action on the selected text in the entry.
777 * @param obj The entry object
779 EAPI void elm_entry_selection_copy(Evas_Object *obj);
782 * This executes a "paste" action in the entry.
784 * @param obj The entry object
786 EAPI void elm_entry_selection_paste(Evas_Object *obj);
789 * This clears and frees the items in a entry's contextual (longpress)
792 * @param obj The entry object
794 * @see elm_entry_context_menu_item_add()
796 EAPI void elm_entry_context_menu_clear(Evas_Object *obj);
799 * This adds an item to the entry's contextual menu.
801 * A longpress on an entry will make the contextual menu show up, if this
802 * hasn't been disabled with elm_entry_context_menu_disabled_set().
803 * By default, this menu provides a few options like enabling selection mode,
804 * which is useful on embedded devices that need to be explicit about it,
805 * and when a selection exists it also shows the copy and cut actions.
807 * With this function, developers can add other options to this menu to
808 * perform any action they deem necessary.
810 * @param obj The entry object
811 * @param label The item's text label
812 * @param icon_file The item's icon file
813 * @param icon_type The item's icon type
814 * @param func The callback to execute when the item is clicked
815 * @param data The data to associate with the item for related functions
817 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);
820 * This disables the entry's contextual (longpress) menu.
822 * @param obj The entry object
823 * @param disabled If true, the menu is disabled
825 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled);
828 * This returns whether the entry's contextual (longpress) menu is
831 * @param obj The entry object
832 * @return If true, the menu is disabled
834 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj);
837 * This disables the entry's magnifer feature.
839 * @param obj The entry object
840 * @param disabled If true, the magnifier is not displayed
843 EAPI void elm_entry_magnifier_disabled_set(Evas_Object *obj, Eina_Bool disabled);
845 * This returns whether the entry's magnifier feature is disabled.
847 * @param obj The entry object
848 * @return If true, the feature is disabled
850 EAPI Eina_Bool elm_entry_magnifier_disabled_get(const Evas_Object *obj);
853 * This appends a custom item provider to the list for that entry
855 * This appends the given callback. The list is walked from beginning to end
856 * with each function called given the item href string in the text. If the
857 * function returns an object handle other than NULL (it should create an
858 * object to do this), then this object is used to replace that item. If
859 * not the next provider is called until one provides an item object, or the
860 * default provider in entry does.
862 * @param obj The entry object
863 * @param func The function called to provide the item object
864 * @param data The data passed to @p func
866 * @see @ref entry-items
868 EAPI void elm_entry_item_provider_append(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
871 * This prepends a custom item provider to the list for that entry
873 * This prepends the given callback. See elm_entry_item_provider_append() for
876 * @param obj The entry object
877 * @param func The function called to provide the item object
878 * @param data The data passed to @p func
880 EAPI void elm_entry_item_provider_prepend(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
883 * This removes a custom item provider to the list for that entry
885 * This removes the given callback. See elm_entry_item_provider_append() for
888 * @param obj The entry object
889 * @param func The function called to provide the item object
890 * @param data The data passed to @p func
892 EAPI void elm_entry_item_provider_remove(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
895 * Append a filter function for text inserted in the entry
897 * Append the given callback to the list. This functions will be called
898 * whenever any text is inserted into the entry, with the text to be inserted
899 * as a parameter. The callback function is free to alter the text in any way
900 * it wants, but it must remember to free the given pointer and update it.
901 * If the new text is to be discarded, the function can free it and set its
902 * text parameter to NULL. This will also prevent any following filters from
905 * @param obj The entry object
906 * @param func The function to use as text filter
907 * @param data User data to pass to @p func
909 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
912 * Prepend a filter function for text insdrted in the entry
914 * Prepend the given callback to the list. See elm_entry_text_filter_append()
915 * for more information
917 * @param obj The entry object
918 * @param func The function to use as text filter
919 * @param data User data to pass to @p func
921 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
924 * Remove a filter from the list
926 * Removes the given callback from the filter list. See
927 * elm_entry_text_filter_append() for more information.
929 * @param obj The entry object
930 * @param func The filter function to remove
931 * @param data The user data passed when adding the function
933 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
936 * This converts a markup (HTML-like) string into UTF-8.
938 * The returned string is a malloc'ed buffer and it should be freed when
939 * not needed anymore.
941 * @param s The string (in markup) to be converted
942 * @return The converted string (in UTF-8). It should be freed.
944 EAPI char *elm_entry_markup_to_utf8(const char *s);
947 * This converts a UTF-8 string into markup (HTML-like).
949 * The returned string is a malloc'ed buffer and it should be freed when
950 * not needed anymore.
952 * @param s The string (in UTF-8) to be converted
953 * @return The converted string (in markup). It should be freed.
955 EAPI char *elm_entry_utf8_to_markup(const char *s);
958 * This sets the file (and implicitly loads it) for the text to display and
959 * then edit. All changes are written back to the file after a short delay if
960 * the entry object is set to autosave (which is the default).
962 * If the entry had any other file set previously, any changes made to it
963 * will be saved if the autosave feature is enabled, otherwise, the file
964 * will be silently discarded and any non-saved changes will be lost.
966 * @param obj The entry object
967 * @param file The path to the file to load and save
968 * @param format The file format
970 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format);
973 * Gets the file being edited by the entry.
975 * This function can be used to retrieve any file set on the entry for
976 * edition, along with the format used to load and save it.
978 * @param obj The entry object
979 * @param file The path to the file to load and save
980 * @param format The file format
982 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format);
985 * This function writes any changes made to the file set with
986 * elm_entry_file_set()
988 * @param obj The entry object
990 EAPI void elm_entry_file_save(Evas_Object *obj);
993 * This sets the entry object to 'autosave' the loaded text file or not.
995 * @param obj The entry object
996 * @param autosave Autosave the loaded file or not
998 * @see elm_entry_file_set()
1000 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave);
1003 * This gets the entry object's 'autosave' status.
1005 * @param obj The entry object
1006 * @return Autosave the loaded file or not
1008 * @see elm_entry_file_set()
1010 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj);
1013 * Control pasting of text and images for the widget.
1015 * Normally the entry allows both text and images to be pasted.
1016 * By setting textonly to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
1017 * By setting textonly to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
1019 * @note this only changes the behaviour of text.
1021 * @param obj The entry object
1022 * @param mode One of #Elm_CNP_Mode: #ELM_CNP_MODE_MARKUP,
1023 * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
1025 EAPI void elm_entry_cnp_mode_set(Evas_Object *obj, Elm_CNP_Mode cnp_mode);
1028 * Getting elm_entry text paste/drop mode.
1030 * Normally the entry allows both text and images to be pasted.
1031 * This gets the copy & paste mode of the entry.
1033 * @param obj The entry object
1034 * @return mode One of #Elm_CNP_Mode: #ELM_CNP_MODE_MARKUP,
1035 * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
1037 EAPI Elm_CNP_Mode elm_entry_cnp_mode_get(const Evas_Object *obj);
1040 * Control pasting of text and images for the widget.
1042 * Normally the entry allows both text and images to be pasted. By setting
1043 * textonly to be true, this prevents images from being pasted.
1045 * Note this only changes the behaviour of text.
1047 * @param obj The entry object
1048 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
1053 * Control pasting of text and images for the widget.
1055 * Normally the entry allows both text and images to be pasted. By setting
1056 * textonly to be true, this prevents images from being pasted.
1058 * Note this only changes the behaviour of text.
1060 * @param obj The entry object
1061 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
1064 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly);
1067 * Getting elm_entry text paste/drop mode.
1069 * In textonly mode, only text may be pasted or dropped into the widget.
1071 * @param obj The entry object
1072 * @return If the widget only accepts text from pastes.
1074 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj);
1077 * Enable or disable scrolling in entry
1079 * Normally the entry is not scrollable unless you enable it with this call.
1081 * @param obj The entry object
1082 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
1084 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
1087 * Get the scrollable state of the entry
1089 * Normally the entry is not scrollable. This gets the scrollable state
1090 * of the entry. See elm_entry_scrollable_set() for more information.
1092 * @param obj The entry object
1093 * @return The scrollable state
1095 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
1098 * Sets the visibility of the left-side widget of the scrolled entry,
1099 * set by elm_entry_icon_set().
1101 * @param obj The scrolled entry object
1102 * @param setting EINA_TRUE if the object should be displayed,
1103 * EINA_FALSE if not.
1105 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
1108 * Sets the visibility of the end widget of the scrolled entry, set by
1109 * elm_object_part_content_set(ent, "end", content).
1111 * @param obj The scrolled entry object
1112 * @param setting EINA_TRUE if the object should be displayed,
1113 * EINA_FALSE if not.
1115 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
1118 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
1121 * Setting an entry to single-line mode with elm_entry_single_line_set()
1122 * will automatically disable the display of scrollbars when the entry
1123 * moves inside its scroller.
1125 * @param obj The scrolled entry object
1126 * @param h The horizontal scrollbar policy to apply
1127 * @param v The vertical scrollbar policy to apply
1129 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
1132 * This enables/disables bouncing within the entry.
1134 * This function sets whether the entry will bounce when scrolling reaches
1135 * the end of the contained entry.
1137 * @param obj The scrolled entry object
1138 * @param h_bounce The horizontal bounce state
1139 * @param v_bounce The vertical bounce state
1141 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
1144 * Get the bounce mode
1146 * @param obj The Entry object
1147 * @param h_bounce Allow bounce horizontally
1148 * @param v_bounce Allow bounce vertically
1150 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
1153 * Set the input panel layout of the entry
1155 * @param obj The entry object
1156 * @param layout layout type
1158 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
1161 * Get the input panel layout of the entry
1163 * @param obj The entry object
1164 * @return layout type
1166 * @see elm_entry_input_panel_layout_set
1168 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(const Evas_Object *obj);
1171 * Set the autocapitalization type on the immodule.
1173 * @param obj The entry object
1174 * @param autocapital_type The type of autocapitalization
1176 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type);
1179 * Retrieve the autocapitalization type on the immodule.
1181 * @param obj The entry object
1182 * @return autocapitalization type
1184 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(const Evas_Object *obj);
1187 * Sets the attribute to show the input panel automatically.
1189 * @param obj The entry object
1190 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
1192 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
1195 * Retrieve the attribute to show the input panel automatically.
1197 * @param obj The entry object
1198 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
1200 EAPI Eina_Bool elm_entry_input_panel_enabled_get(const Evas_Object *obj);
1203 * Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
1205 * Note that input panel is shown or hidden automatically according to the focus state of entry widget.
1206 * This API can be used in the case of manually controling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE)
1208 * @param obj The entry object
1210 EAPI void elm_entry_input_panel_show(Evas_Object *obj);
1213 * Hide the input panel (virtual keyboard).
1215 * Note that input panel is shown or hidden automatically according to the focus state of entry widget.
1216 * This API can be used in the case of manually controling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE)
1218 * @param obj The entry object
1220 EAPI void elm_entry_input_panel_hide(Evas_Object *obj);
1223 * Set the language mode of the input panel.
1225 * This API can be used if you want to show the alphabet keyboard mode.
1227 * @param obj The entry object
1228 * @param lang language to be set to the input panel.
1230 EAPI void elm_entry_input_panel_language_set(Evas_Object *obj, Elm_Input_Panel_Lang lang);
1233 * Get the language mode of the input panel.
1235 * See @ref elm_entry_input_panel_language_set for more details.
1237 * @param obj The entry object
1238 * @return input panel language type
1240 EAPI Elm_Input_Panel_Lang elm_entry_input_panel_language_get(const Evas_Object *obj);
1243 * Set the input panel-specific data to deliver to the input panel.
1245 * This API is used by applications to deliver specific data to the input panel.
1246 * The data format MUST be negotiated by both application and the input panel.
1247 * The size and format of data are defined by the input panel.
1249 * @param obj The entry object
1250 * @param data The specific data to be set to the input panel.
1251 * @param len the length of data, in bytes, to send to the input panel
1253 EAPI void elm_entry_input_panel_imdata_set(Evas_Object *obj, const void *data, int len);
1256 * Get the specific data of the current input panel.
1258 * See @ref elm_entry_input_panel_imdata_set for more details.
1260 * @param obj The entry object
1261 * @param data The specific data to be got from the input panel
1262 * @param len The length of data
1264 EAPI void elm_entry_input_panel_imdata_get(const Evas_Object *obj, void *data, int *len);
1267 * Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
1269 * An input panel displays the string or icon associated with this type
1271 * @param obj The entry object
1272 * @param return_key_type The type of "return" key on the input panel
1274 EAPI void elm_entry_input_panel_return_key_type_set(Evas_Object *obj, Elm_Input_Panel_Return_Key_Type return_key_type);
1277 * Get the "return" key type.
1279 * @see elm_entry_input_panel_return_key_type_set() for more details
1281 * @param obj The entry object
1282 * @return The type of "return" key on the input panel
1284 EAPI Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get(const Evas_Object *obj);
1287 * Set the return key on the input panel to be disabled.
1289 * @param obj The entry object
1290 * @param disabled The state to put in in: @c EINA_TRUE for
1291 * disabled, @c EINA_FALSE for enabled
1293 EAPI void elm_entry_input_panel_return_key_disabled_set(Evas_Object *obj, Eina_Bool disabled);
1296 * Get whether the return key on the input panel should be disabled or not.
1298 * @param obj The entry object
1299 * @return EINA_TRUE if it should be disabled
1301 EAPI Eina_Bool elm_entry_input_panel_return_key_disabled_get(const Evas_Object *obj);
1304 * Set whether the return key on the input panel is disabled automatically when entry has no text.
1306 * If @p on is EINA_TRUE, The return key on input panel is disabled when the entry has no text.
1307 * The return Key on the input panel is automatically enabled when the entry has text.
1308 * The default value is EINA_FALSE.
1310 * @param obj The entry object
1311 * @param on If @p on is EINA_TRUE, the return key is automatically disabled when the entry has no text.
1313 EAPI void elm_entry_input_panel_return_key_autoenabled_set(Evas_Object *obj, Eina_Bool on);
1316 * Reset the input method context of the entry if needed.
1318 * This can be necessary in the case where modifying the buffer would confuse on-going input method behavior
1319 * @param obj The entry object
1321 EAPI void elm_entry_imf_context_reset(Evas_Object *obj);
1324 * Set whether the entry should allow to use the text prediction.
1326 * @param obj The entry object
1327 * @param prediction Whether the entry should allow to use the text prediction.
1329 EAPI void elm_entry_prediction_allow_set(Evas_Object *obj, Eina_Bool prediction);
1332 * Get whether the entry should allow to use the text prediction.
1334 * @param obj The entry object
1335 * @return EINA_TRUE if it allows to use the text prediction, otherwise EINA_FALSE.
1337 EAPI Eina_Bool elm_entry_prediction_allow_get(const Evas_Object *obj);
1339 /* pre-made filters for entries */
1342 * @typedef Elm_Entry_Filter_Limit_Size
1344 * Data for the elm_entry_filter_limit_size() entry filter.
1346 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
1349 * @struct _Elm_Entry_Filter_Limit_Size
1351 * Data for the elm_entry_filter_limit_size() entry filter.
1353 struct _Elm_Entry_Filter_Limit_Size
1355 int max_char_count; /**< The maximum number of characters allowed. */
1356 int max_byte_count; /**< The maximum number of bytes allowed*/
1360 * Filter inserted text based on user defined character and byte limits
1362 * Add this filter to an entry to limit the characters that it will accept
1363 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
1364 * The funtion works on the UTF-8 representation of the string, converting
1365 * it from the set markup, thus not accounting for any format in it.
1367 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
1368 * it as data when setting the filter. In it, it's possible to set limits
1369 * by character count or bytes (any of them is disabled if 0), and both can
1370 * be set at the same time. In that case, it first checks for characters,
1373 * The function will cut the inserted text in order to allow only the first
1374 * number of characters that are still allowed. The cut is made in
1375 * characters, even when limiting by bytes, in order to always contain
1376 * valid ones and avoid half unicode characters making it in.
1378 * This filter, like any others, does not apply when setting the entry text
1379 * directly with elm_object_text_set().
1381 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text);
1384 * @typedef Elm_Entry_Filter_Accept_Set
1386 * Data for the elm_entry_filter_accept_set() entry filter.
1388 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
1391 * @struct _Elm_Entry_Filter_Accept_Set
1393 * Data for the elm_entry_filter_accept_set() entry filter.
1395 struct _Elm_Entry_Filter_Accept_Set
1397 const char *accepted; /**< Set of characters accepted in the entry. */
1398 const char *rejected; /**< Set of characters rejected from the entry. */
1402 * Filter inserted text based on accepted or rejected sets of characters
1404 * Add this filter to an entry to restrict the set of accepted characters
1405 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
1406 * This structure contains both accepted and rejected sets, but they are
1407 * mutually exclusive.
1409 * The @c accepted set takes preference, so if it is set, the filter will
1410 * only work based on the accepted characters, ignoring anything in the
1411 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
1413 * In both cases, the function filters by matching utf8 characters to the
1414 * raw markup text, so it can be used to remove formatting tags.
1416 * This filter, like any others, does not apply when setting the entry text
1417 * directly with elm_object_text_set()
1419 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text);
1421 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
1422 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type);