1 typedef enum _Elm_Text_Format
3 ELM_TEXT_FORMAT_PLAIN_UTF8,
4 ELM_TEXT_FORMAT_MARKUP_UTF8
10 typedef enum _Elm_Wrap_Type
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. */
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 // XXX: remove this so we can expand
30 } Elm_Input_Panel_Layout;
34 ELM_AUTOCAPITAL_TYPE_NONE,
35 ELM_AUTOCAPITAL_TYPE_WORD,
36 ELM_AUTOCAPITAL_TYPE_SENTENCE,
37 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
38 } Elm_Autocapital_Type;
41 * @defgroup Entry Entry
43 * @image html img/widget/entry/preview-00.png
44 * @image latex img/widget/entry/preview-00.eps width=\textwidth
45 * @image html img/widget/entry/preview-01.png
46 * @image latex img/widget/entry/preview-01.eps width=\textwidth
47 * @image html img/widget/entry/preview-02.png
48 * @image latex img/widget/entry/preview-02.eps width=\textwidth
49 * @image html img/widget/entry/preview-03.png
50 * @image latex img/widget/entry/preview-03.eps width=\textwidth
52 * An entry is a convenience widget which shows a box that the user can
53 * enter text into. Entries by default don't scroll, so they grow to
54 * accomodate the entire text, resizing the parent window as needed. This
55 * can be changed with the elm_entry_scrollable_set() function.
57 * They can also be single line or multi line (the default) and when set
58 * to multi line mode they support text wrapping in any of the modes
59 * indicated by #Elm_Wrap_Type.
61 * Other features include password mode, filtering of inserted text with
62 * elm_entry_text_filter_append() and related functions, inline "items" and
63 * formatted markup text.
65 * @section entry-markup Formatted text
67 * The markup tags supported by the Entry are defined by the theme, but
68 * even when writing new themes or extensions it's a good idea to stick to
69 * a sane default, to maintain coherency and avoid application breakages.
70 * Currently defined by the default theme are the following tags:
71 * @li \<br\>: Inserts a line break.
72 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
74 * @li \<tab\>: Inserts a tab.
75 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
77 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
78 * @li \<link\>...\</link\>: Underlines the enclosed text.
79 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
81 * @section entry-special Special markups
83 * Besides those used to format text, entries support two special markup
84 * tags used to insert clickable portions of text or items inlined within
87 * @subsection entry-anchors Anchors
89 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
90 * \</a\> tags and an event will be generated when this text is clicked,
94 * This text is outside <a href=anc-01>but this one is an anchor</a>
97 * The @c href attribute in the opening tag gives the name that will be
98 * used to identify the anchor and it can be any valid utf8 string.
100 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
101 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
102 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
103 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
106 * @subsection entry-items Items
108 * Inlined in the text, any other @c Evas_Object can be inserted by using
109 * \<item\> tags this way:
112 * <item size=16x16 vsize=full href=emoticon/haha></item>
115 * Just like with anchors, the @c href identifies each item, but these need,
116 * in addition, to indicate their size, which is done using any one of
117 * @c size, @c absize or @c relsize attributes. These attributes take their
118 * value in the WxH format, where W is the width and H the height of the
121 * @li absize: Absolute pixel size for the item. Whatever value is set will
122 * be the item's size regardless of any scale value the object may have
123 * been set to. The final line height will be adjusted to fit larger items.
124 * @li size: Similar to @c absize, but it's adjusted to the scale value set
126 * @li relsize: Size is adjusted for the item to fit within the current
129 * Besides their size, items are specificed a @c vsize value that affects
130 * how their final size and position are calculated. The possible values
132 * @li ascent: Item will be placed within the line's baseline and its
133 * ascent. That is, the height between the line where all characters are
134 * positioned and the highest point in the line. For @c size and @c absize
135 * items, the descent value will be added to the total line height to make
136 * them fit. @c relsize items will be adjusted to fit within this space.
137 * @li full: Items will be placed between the descent and ascent, or the
138 * lowest point in the line and its highest.
140 * The next image shows different configurations of items and how
141 * the previously mentioned options affect their sizes. In all cases,
142 * the green line indicates the ascent, blue for the baseline and red for
145 * @image html entry_item.png
146 * @image latex entry_item.eps width=\textwidth
148 * And another one to show how size differs from absize. In the first one,
149 * the scale value is set to 1.0, while the second one is using one of 2.0.
151 * @image html entry_item_scale.png
152 * @image latex entry_item_scale.eps width=\textwidth
154 * After the size for an item is calculated, the entry will request an
155 * object to place in its space. For this, the functions set with
156 * elm_entry_item_provider_append() and related functions will be called
157 * in order until one of them returns a @c non-NULL value. If no providers
158 * are available, or all of them return @c NULL, then the entry falls back
159 * to one of the internal defaults, provided the name matches with one of
162 * All of the following are currently supported:
165 * - emoticon/angry-shout
166 * - emoticon/crazy-laugh
167 * - emoticon/evil-laugh
169 * - emoticon/goggle-smile
171 * - emoticon/grumpy-smile
173 * - emoticon/guilty-smile
175 * - emoticon/half-smile
176 * - emoticon/happy-panting
178 * - emoticon/indifferent
180 * - emoticon/knowing-grin
182 * - emoticon/little-bit-sorry
183 * - emoticon/love-lots
185 * - emoticon/minimal-smile
186 * - emoticon/not-happy
187 * - emoticon/not-impressed
189 * - emoticon/opensmile
192 * - emoticon/squint-laugh
193 * - emoticon/surprised
194 * - emoticon/suspicious
195 * - emoticon/tongue-dangling
196 * - emoticon/tongue-poke
199 * - emoticon/very-sorry
205 * Alternatively, an item may reference an image by its path, using
206 * the URI form @c file:///path/to/an/image.png and the entry will then
207 * use that image for the item.
209 * @section entry-files Loading and saving files
211 * Entries have convinience functions to load text from a file and save
212 * changes back to it after a short delay. The automatic saving is enabled
213 * by default, but can be disabled with elm_entry_autosave_set() and files
214 * can be loaded directly as plain text or have any markup in them
215 * recognized. See elm_entry_file_set() for more details.
217 * @section entry-signals Emitted signals
219 * This widget emits the following signals:
221 * @li "changed": The text within the entry was changed.
222 * @li "changed,user": The text within the entry was changed because of user interaction.
223 * @li "activated": The enter key was pressed on a single line entry.
224 * @li "press": A mouse button has been pressed on the entry.
225 * @li "longpressed": A mouse button has been pressed and held for a couple
227 * @li "clicked": The entry has been clicked (mouse press and release).
228 * @li "clicked,double": The entry has been double clicked.
229 * @li "clicked,triple": The entry has been triple clicked.
230 * @li "focused": The entry has received focus.
231 * @li "unfocused": The entry has lost focus.
232 * @li "selection,paste": A paste of the clipboard contents was requested.
233 * @li "selection,copy": A copy of the selected text into the clipboard was
235 * @li "selection,cut": A cut of the selected text into the clipboard was
237 * @li "selection,start": A selection has begun and no previous selection
239 * @li "selection,changed": The current selection has changed.
240 * @li "selection,cleared": The current selection has been cleared.
241 * @li "cursor,changed": The cursor has changed position.
242 * @li "anchor,clicked": An anchor has been clicked. The event_info
243 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
244 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
245 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
246 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
247 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
248 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
249 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
250 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
251 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
252 * @li "preedit,changed": The preedit string has changed.
253 * @li "language,changed": Program language changed.
255 * @section entry-examples
257 * An overview of the Entry API can be seen in @ref entry_example_01
263 * @typedef Elm_Entry_Anchor_Info
265 * The info sent in the callback for the "anchor,clicked" signals emitted
268 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
271 * @struct _Elm_Entry_Anchor_Info
273 * The info sent in the callback for the "anchor,clicked" signals emitted
276 struct _Elm_Entry_Anchor_Info
278 const char *name; /**< The name of the anchor, as stated in its href */
279 int button; /**< The mouse button used to click on it */
280 Evas_Coord x, /**< Anchor geometry, relative to canvas */
281 y, /**< Anchor geometry, relative to canvas */
282 w, /**< Anchor geometry, relative to canvas */
283 h; /**< Anchor geometry, relative to canvas */
287 * @typedef Elm_Entry_Filter_Cb
288 * This callback type is used by entry filters to modify text.
289 * @param data The data specified as the last param when adding the filter
290 * @param entry The entry object
291 * @param text A pointer to the location of the text being filtered. This data can be modified,
292 * but any additional allocations must be managed by the user.
293 * @see elm_entry_text_filter_append
294 * @see elm_entry_text_filter_prepend
296 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
299 * @typedef Elm_Entry_Change_Info
300 * This corresponds to Edje_Entry_Change_Info. Includes information about
301 * a change in the entry.
303 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
307 * This adds an entry to @p parent object.
309 * By default, entries are:
313 * @li autosave is enabled
315 * @param parent The parent object
316 * @return The new object or NULL if it cannot be created
318 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
321 * Sets the entry to single line mode.
323 * In single line mode, entries don't ever wrap when the text reaches the
324 * edge, and instead they keep growing horizontally. Pressing the @c Enter
325 * key will generate an @c "activate" event instead of adding a new line.
327 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
328 * and pressing enter will break the text into a different line
329 * without generating any events.
331 * @param obj The entry object
332 * @param single_line If true, the text in the entry
333 * will be on a single line.
335 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
338 * Gets whether the entry is set to be single line.
340 * @param obj The entry object
341 * @return single_line If true, the text in the entry is set to display
344 * @see elm_entry_single_line_set()
346 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
349 * Sets the entry to password mode.
351 * In password mode, entries are implicitly single line and the display of
352 * any text in them is replaced with asterisks (*).
354 * @param obj The entry object
355 * @param password If true, password mode is enabled.
357 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
360 * Gets whether the entry is set to password mode.
362 * @param obj The entry object
363 * @return If true, the entry is set to display all characters
366 * @see elm_entry_password_set()
368 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
371 * This sets the text displayed within the entry to @p entry.
373 * @param obj The entry object
374 * @param entry The text to be displayed
376 * @deprecated Use elm_object_text_set() instead.
377 * @note Using this function bypasses text filters
379 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
382 * This returns the text currently shown in object @p entry.
383 * See also elm_entry_entry_set().
385 * @param obj The entry object
386 * @return The currently displayed text or NULL on failure
388 * @deprecated Use elm_object_text_get() instead.
390 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
393 * Appends @p entry to the text of the entry.
395 * Adds the text in @p entry to the end of any text already present in the
398 * The appended text is subject to any filters set for the widget.
400 * @param obj The entry object
401 * @param entry The text to be displayed
403 * @see elm_entry_text_filter_append()
405 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
408 * Gets whether the entry is empty.
410 * Empty means no text at all. If there are any markup tags, like an item
411 * tag for which no provider finds anything, and no text is displayed, this
412 * function still returns EINA_FALSE.
414 * @param obj The entry object
415 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
417 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
420 * Gets any selected text within the entry.
422 * If there's any selected text in the entry, this function returns it as
423 * a string in markup format. NULL is returned if no selection exists or
424 * if an error occurred.
426 * The returned value points to an internal string and should not be freed
427 * or modified in any way. If the @p entry object is deleted or its
428 * contents are changed, the returned pointer should be considered invalid.
430 * @param obj The entry object
431 * @return The selected text within the entry or NULL on failure
433 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
436 * Returns the actual textblock object of the entry.
438 * This function exposes the internal textblock object that actually
439 * contains and draws the text. This should be used for low-level
440 * manipulations that are otherwise not possible.
442 * Changing the textblock directly from here will not notify edje/elm to
443 * recalculate the textblock size automatically, so any modifications
444 * done to the textblock returned by this function should be followed by
445 * a call to elm_entry_calc_force().
447 * The return value is marked as const as an additional warning.
448 * One should not use the returned object with any of the generic evas
449 * functions (geometry_get/resize/move and etc), but only with the textblock
450 * functions; The former will either not work at all, or break the correct
453 * IMPORTANT: Many functions may change (i.e delete and create a new one)
454 * the internal textblock object. Do NOT cache the returned object, and try
455 * not to mix calls on this object with regular elm_entry calls (which may
456 * change the internal textblock object). This applies to all cursors
457 * returned from textblock calls, and all the other derivative values.
459 * @param obj The entry object
460 * @return The textblock object.
462 EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
465 * Forces calculation of the entry size and text layouting.
467 * This should be used after modifying the textblock object directly. See
468 * elm_entry_textblock_get() for more information.
470 * @param obj The entry object
472 * @see elm_entry_textblock_get()
474 EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
477 * Inserts the given text into the entry at the current cursor position.
479 * This inserts text at the cursor position as if it was typed
480 * by the user (note that this also allows markup which a user
481 * can't just "type" as it would be converted to escaped text, so this
482 * call can be used to insert things like emoticon items or bold push/pop
483 * tags, other font and color change tags etc.)
485 * If any selection exists, it will be replaced by the inserted text.
487 * The inserted text is subject to any filters set for the widget.
489 * @param obj The entry object
490 * @param entry The text to insert
492 * @see elm_entry_text_filter_append()
494 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
497 * Set the line wrap type to use on multi-line entries.
499 * Sets the wrap type used by the entry to any of the specified in
500 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
501 * line (without inserting a line break or paragraph separator) when it
502 * reaches the far edge of the widget.
504 * Note that this only makes sense for multi-line entries. A widget set
505 * to be single line will never wrap.
507 * @param obj The entry object
508 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
510 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
513 * Gets the wrap mode the entry was set to use.
515 * @param obj The entry object
518 * @see also elm_entry_line_wrap_set()
520 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
523 * Sets if the entry is to be editable or not.
525 * By default, entries are editable and when focused, any text input by the
526 * user will be inserted at the current cursor position. But calling this
527 * function with @p editable as EINA_FALSE will prevent the user from
528 * inputting text into the entry.
530 * The only way to change the text of a non-editable entry is to use
531 * elm_object_text_set(), elm_entry_entry_insert() and other related
534 * @param obj The entry object
535 * @param editable If EINA_TRUE, user input will be inserted in the entry,
536 * if not, the entry is read-only and no user input is allowed.
538 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
541 * Gets whether the entry is editable or not.
543 * @param obj The entry object
544 * @return If true, the entry is editable by the user.
545 * If false, it is not editable by the user
547 * @see elm_entry_editable_set()
549 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
552 * This drops any existing text selection within the entry.
554 * @param obj The entry object
556 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
559 * This selects all text within the entry.
561 * @param obj The entry object
563 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
566 * This moves the cursor one place to the right within the entry.
568 * @param obj The entry object
569 * @return EINA_TRUE upon success, EINA_FALSE upon failure
571 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
574 * This moves the cursor one place to the left within the entry.
576 * @param obj The entry object
577 * @return EINA_TRUE upon success, EINA_FALSE upon failure
579 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
582 * This moves the cursor one line up within the entry.
584 * @param obj The entry object
585 * @return EINA_TRUE upon success, EINA_FALSE upon failure
587 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
590 * This moves the cursor one line down within the entry.
592 * @param obj The entry object
593 * @return EINA_TRUE upon success, EINA_FALSE upon failure
595 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
598 * This moves the cursor to the beginning of the entry.
600 * @param obj The entry object
602 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
605 * This moves the cursor to the end of the entry.
607 * @param obj The entry object
609 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
612 * This moves the cursor to the beginning of the current line.
614 * @param obj The entry object
616 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
619 * This moves the cursor to the end of the current line.
621 * @param obj The entry object
623 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
626 * This begins a selection within the entry as though
627 * the user were holding down the mouse button to make a selection.
629 * @param obj The entry object
631 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
634 * This ends a selection within the entry as though
635 * the user had just released the mouse button while making a selection.
637 * @param obj The entry object
639 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
642 * Gets whether a format node exists at the current cursor position.
644 * A format node is anything that defines how the text is rendered. It can
645 * be a visible format node, such as a line break or a paragraph separator,
646 * or an invisible one, such as bold begin or end tag.
647 * This function returns whether any format node exists at the current
650 * @param obj The entry object
651 * @return EINA_TRUE if the current cursor position contains a format node,
652 * EINA_FALSE otherwise.
654 * @see elm_entry_cursor_is_visible_format_get()
656 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
659 * Gets if the current cursor position holds a visible format node.
661 * @param obj The entry object
662 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
663 * if it's an invisible one or no format exists.
665 * @see elm_entry_cursor_is_format_get()
667 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
670 * Gets the character pointed by the cursor at its current position.
672 * This function returns a string with the utf8 character stored at the
673 * current cursor position.
674 * Only the text is returned, any format that may exist will not be part
675 * of the return value.
677 * @param obj The entry object
678 * @return The text pointed by the cursors.
680 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
683 * This function returns the geometry of the cursor.
685 * It's useful if you want to draw something on the cursor (or where it is),
686 * or for example in the case of scrolled entry where you want to show the
689 * @param obj The entry object
690 * @param x returned geometry
691 * @param y returned geometry
692 * @param w returned geometry
693 * @param h returned geometry
694 * @return EINA_TRUE upon success, EINA_FALSE upon failure
696 EAPI Eina_Bool elm_entry_cursor_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
699 * Sets the cursor position in the entry to the given value
701 * The value in @p pos is the index of the character position within the
702 * contents of the string as returned by elm_entry_cursor_pos_get().
704 * @param obj The entry object
705 * @param pos The position of the cursor
707 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
710 * Retrieves the current position of the cursor in the entry
712 * @param obj The entry object
713 * @return The cursor position
715 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
718 * This executes a "cut" action on the selected text in the entry.
720 * @param obj The entry object
722 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
725 * This executes a "copy" action on the selected text in the entry.
727 * @param obj The entry object
729 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
732 * This executes a "paste" action in the entry.
734 * @param obj The entry object
736 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
739 * This clears and frees the items in a entry's contextual (longpress)
742 * @param obj The entry object
744 * @see elm_entry_context_menu_item_add()
746 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
749 * This adds an item to the entry's contextual menu.
751 * A longpress on an entry will make the contextual menu show up, if this
752 * hasn't been disabled with elm_entry_context_menu_disabled_set().
753 * By default, this menu provides a few options like enabling selection mode,
754 * which is useful on embedded devices that need to be explicit about it,
755 * and when a selection exists it also shows the copy and cut actions.
757 * With this function, developers can add other options to this menu to
758 * perform any action they deem necessary.
760 * @param obj The entry object
761 * @param label The item's text label
762 * @param icon_file The item's icon file
763 * @param icon_type The item's icon type
764 * @param func The callback to execute when the item is clicked
765 * @param data The data to associate with the item for related functions
767 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) EINA_ARG_NONNULL(1);
770 * This disables the entry's contextual (longpress) menu.
772 * @param obj The entry object
773 * @param disabled If true, the menu is disabled
775 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
778 * This returns whether the entry's contextual (longpress) menu is
781 * @param obj The entry object
782 * @return If true, the menu is disabled
784 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
787 * This appends a custom item provider to the list for that entry
789 * This appends the given callback. The list is walked from beginning to end
790 * with each function called given the item href string in the text. If the
791 * function returns an object handle other than NULL (it should create an
792 * object to do this), then this object is used to replace that item. If
793 * not the next provider is called until one provides an item object, or the
794 * default provider in entry does.
796 * @param obj The entry object
797 * @param func The function called to provide the item object
798 * @param data The data passed to @p func
800 * @see @ref entry-items
802 EAPI void elm_entry_item_provider_append(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
805 * This prepends a custom item provider to the list for that entry
807 * This prepends the given callback. See elm_entry_item_provider_append() for
810 * @param obj The entry object
811 * @param func The function called to provide the item object
812 * @param data The data passed to @p func
814 EAPI void elm_entry_item_provider_prepend(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
817 * This removes a custom item provider to the list for that entry
819 * This removes the given callback. See elm_entry_item_provider_append() for
822 * @param obj The entry object
823 * @param func The function called to provide the item object
824 * @param data The data passed to @p func
826 EAPI void elm_entry_item_provider_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
829 * Append a filter function for text inserted in the entry
831 * Append the given callback to the list. This functions will be called
832 * whenever any text is inserted into the entry, with the text to be inserted
833 * as a parameter. The callback function is free to alter the text in any way
834 * it wants, but it must remember to free the given pointer and update it.
835 * If the new text is to be discarded, the function can free it and set its
836 * text parameter to NULL. This will also prevent any following filters from
839 * @param obj The entry object
840 * @param func The function to use as text filter
841 * @param data User data to pass to @p func
843 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
846 * Prepend a filter function for text insdrted in the entry
848 * Prepend the given callback to the list. See elm_entry_text_filter_append()
849 * for more information
851 * @param obj The entry object
852 * @param func The function to use as text filter
853 * @param data User data to pass to @p func
855 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
858 * Remove a filter from the list
860 * Removes the given callback from the filter list. See
861 * elm_entry_text_filter_append() for more information.
863 * @param obj The entry object
864 * @param func The filter function to remove
865 * @param data The user data passed when adding the function
867 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
870 * This converts a markup (HTML-like) string into UTF-8.
872 * The returned string is a malloc'ed buffer and it should be freed when
873 * not needed anymore.
875 * @param s The string (in markup) to be converted
876 * @return The converted string (in UTF-8). It should be freed.
878 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
881 * This converts a UTF-8 string into markup (HTML-like).
883 * The returned string is a malloc'ed buffer and it should be freed when
884 * not needed anymore.
886 * @param s The string (in UTF-8) to be converted
887 * @return The converted string (in markup). It should be freed.
889 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
892 * This sets the file (and implicitly loads it) for the text to display and
893 * then edit. All changes are written back to the file after a short delay if
894 * the entry object is set to autosave (which is the default).
896 * If the entry had any other file set previously, any changes made to it
897 * will be saved if the autosave feature is enabled, otherwise, the file
898 * will be silently discarded and any non-saved changes will be lost.
900 * @param obj The entry object
901 * @param file The path to the file to load and save
902 * @param format The file format
904 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
907 * Gets the file being edited by the entry.
909 * This function can be used to retrieve any file set on the entry for
910 * edition, along with the format used to load and save it.
912 * @param obj The entry object
913 * @param file The path to the file to load and save
914 * @param format The file format
916 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
919 * This function writes any changes made to the file set with
920 * elm_entry_file_set()
922 * @param obj The entry object
924 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
927 * This sets the entry object to 'autosave' the loaded text file or not.
929 * @param obj The entry object
930 * @param autosave Autosave the loaded file or not
932 * @see elm_entry_file_set()
934 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
937 * This gets the entry object's 'autosave' status.
939 * @param obj The entry object
940 * @return Autosave the loaded file or not
942 * @see elm_entry_file_set()
944 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
947 * Control pasting of text and images for the widget.
949 * Normally the entry allows both text and images to be pasted. By setting
950 * textonly to be true, this prevents images from being pasted.
952 * Note this only changes the behaviour of text.
954 * @param obj The entry object
955 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
958 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
961 * Getting elm_entry text paste/drop mode.
963 * In textonly mode, only text may be pasted or dropped into the widget.
965 * @param obj The entry object
966 * @return If the widget only accepts text from pastes.
968 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
971 * Enable or disable scrolling in entry
973 * Normally the entry is not scrollable unless you enable it with this call.
975 * @param obj The entry object
976 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
978 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
981 * Get the scrollable state of the entry
983 * Normally the entry is not scrollable. This gets the scrollable state
984 * of the entry. See elm_entry_scrollable_set() for more information.
986 * @param obj The entry object
987 * @return The scrollable state
989 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
992 * This sets a widget to be displayed to the left of a scrolled entry.
994 * @param obj The scrolled entry object
995 * @param icon The widget to display on the left side of the scrolled
998 * @note A previously set widget will be destroyed.
999 * @note If the object being set does not have minimum size hints set,
1000 * it won't get properly displayed.
1002 * @see elm_entry_end_set()
1004 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
1007 * Gets the leftmost widget of the scrolled entry. This object is
1008 * owned by the scrolled entry and should not be modified.
1010 * @param obj The scrolled entry object
1011 * @return the left widget inside the scroller
1013 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
1016 * Unset the leftmost widget of the scrolled entry, unparenting and
1019 * @param obj The scrolled entry object
1020 * @return the previously set icon sub-object of this entry, on
1023 * @see elm_entry_icon_set()
1025 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
1028 * Sets the visibility of the left-side widget of the scrolled entry,
1029 * set by elm_entry_icon_set().
1031 * @param obj The scrolled entry object
1032 * @param setting EINA_TRUE if the object should be displayed,
1033 * EINA_FALSE if not.
1035 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
1038 * This sets a widget to be displayed to the end of a scrolled entry.
1040 * @param obj The scrolled entry object
1041 * @param end The widget to display on the right side of the scrolled
1044 * @note A previously set widget will be destroyed.
1045 * @note If the object being set does not have minimum size hints set,
1046 * it won't get properly displayed.
1048 * @see elm_entry_icon_set
1050 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
1053 * Gets the endmost widget of the scrolled entry. This object is owned
1054 * by the scrolled entry and should not be modified.
1056 * @param obj The scrolled entry object
1057 * @return the right widget inside the scroller
1059 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
1062 * Unset the endmost widget of the scrolled entry, unparenting and
1065 * @param obj The scrolled entry object
1066 * @return the previously set icon sub-object of this entry, on
1069 * @see elm_entry_icon_set()
1071 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
1074 * Sets the visibility of the end widget of the scrolled entry, set by
1075 * elm_entry_end_set().
1077 * @param obj The scrolled entry object
1078 * @param setting EINA_TRUE if the object should be displayed,
1079 * EINA_FALSE if not.
1081 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
1084 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
1087 * Setting an entry to single-line mode with elm_entry_single_line_set()
1088 * will automatically disable the display of scrollbars when the entry
1089 * moves inside its scroller.
1091 * @param obj The scrolled entry object
1092 * @param h The horizontal scrollbar policy to apply
1093 * @param v The vertical scrollbar policy to apply
1095 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
1098 * This enables/disables bouncing within the entry.
1100 * This function sets whether the entry will bounce when scrolling reaches
1101 * the end of the contained entry.
1103 * @param obj The scrolled entry object
1104 * @param h The horizontal bounce state
1105 * @param v The vertical bounce state
1107 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
1110 * Get the bounce mode
1112 * @param obj The Entry object
1113 * @param h_bounce Allow bounce horizontally
1114 * @param v_bounce Allow bounce vertically
1116 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
1118 /* pre-made filters for entries */
1120 * @typedef Elm_Entry_Filter_Limit_Size
1122 * Data for the elm_entry_filter_limit_size() entry filter.
1124 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
1127 * @struct _Elm_Entry_Filter_Limit_Size
1129 * Data for the elm_entry_filter_limit_size() entry filter.
1131 struct _Elm_Entry_Filter_Limit_Size
1133 int max_char_count; /**< The maximum number of characters allowed. */
1134 int max_byte_count; /**< The maximum number of bytes allowed*/
1138 * Filter inserted text based on user defined character and byte limits
1140 * Add this filter to an entry to limit the characters that it will accept
1141 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
1142 * The funtion works on the UTF-8 representation of the string, converting
1143 * it from the set markup, thus not accounting for any format in it.
1145 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
1146 * it as data when setting the filter. In it, it's possible to set limits
1147 * by character count or bytes (any of them is disabled if 0), and both can
1148 * be set at the same time. In that case, it first checks for characters,
1151 * The function will cut the inserted text in order to allow only the first
1152 * number of characters that are still allowed. The cut is made in
1153 * characters, even when limiting by bytes, in order to always contain
1154 * valid ones and avoid half unicode characters making it in.
1156 * This filter, like any others, does not apply when setting the entry text
1157 * directly with elm_object_text_set() (or the deprecated
1158 * elm_entry_entry_set()).
1160 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
1163 * @typedef Elm_Entry_Filter_Accept_Set
1165 * Data for the elm_entry_filter_accept_set() entry filter.
1167 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
1170 * @struct _Elm_Entry_Filter_Accept_Set
1172 * Data for the elm_entry_filter_accept_set() entry filter.
1174 struct _Elm_Entry_Filter_Accept_Set
1176 const char *accepted; /**< Set of characters accepted in the entry. */
1177 const char *rejected; /**< Set of characters rejected from the entry. */
1181 * Filter inserted text based on accepted or rejected sets of characters
1183 * Add this filter to an entry to restrict the set of accepted characters
1184 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
1185 * This structure contains both accepted and rejected sets, but they are
1186 * mutually exclusive.
1188 * The @c accepted set takes preference, so if it is set, the filter will
1189 * only work based on the accepted characters, ignoring anything in the
1190 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
1192 * In both cases, the function filters by matching utf8 characters to the
1193 * raw markup text, so it can be used to remove formatting tags.
1195 * This filter, like any others, does not apply when setting the entry text
1196 * directly with elm_object_text_set() (or the deprecated
1197 * elm_entry_entry_set()).
1199 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
1201 * Set the input panel layout of the entry
1203 * @param obj The entry object
1204 * @param layout layout type
1206 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
1209 * Get the input panel layout of the entry
1211 * @param obj The entry object
1212 * @return layout type
1214 * @see elm_entry_input_panel_layout_set
1216 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
1219 * Set the autocapitalization type on the immodule.
1221 * @param obj The entry object
1222 * @param autocapital_type The type of autocapitalization
1224 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
1227 * Retrieve the autocapitalization type on the immodule.
1229 * @param obj The entry object
1230 * @return autocapitalization type
1232 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
1235 * Sets the attribute to show the input panel automatically.
1237 * @param obj The entry object
1238 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
1240 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
1243 * Retrieve the attribute to show the input panel automatically.
1245 * @param obj The entry object
1246 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
1248 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);