Merge "[Genlist][Nabi] Bug fix : S1-1321,S1-1341. BS was occurred after clicking...
[framework/uifw/elementary.git] / src / lib / elm_entry.h
1 typedef enum
2 {
3    ELM_TEXT_FORMAT_PLAIN_UTF8,
4    ELM_TEXT_FORMAT_MARKUP_UTF8
5 } Elm_Text_Format;
6
7 /**
8  * Line wrapping types.
9  */
10 typedef enum
11 {
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. */
16    ELM_WRAP_LAST
17 } Elm_Wrap_Type; /**< Type of word or character wrapping to use */
18
19 typedef enum
20 {
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. */
34
35 typedef enum
36 {
37    ELM_INPUT_PANEL_LANG_AUTOMATIC,    /**< Automatic */
38    ELM_INPUT_PANEL_LANG_ALPHABET      /**< Alphabet */
39 } Elm_Input_Panel_Lang;
40
41 typedef enum
42 {
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 */
48
49 typedef enum
50 {
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;
60
61 /**
62     * @enum _Elm_CNP_Mode
63     * @typedef Elm_CNP_Mode
64     * Enum of entry's copy & paste policy.
65     *
66     * @see elm_entry_cnp_mode_set()
67     * @see elm_entry_cnp_mode_get()
68     */
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 */
73    } Elm_CNP_Mode;
74
75 /**
76  * @defgroup Entry Entry
77  *
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
86  *
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.
91  *
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.
95  *
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.
99  *
100  * @section entry-markup Formatted text
101  *
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
108  * breaks.
109  * @li \<tab\>: Inserts a tab.
110  * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
111  * enclosed text.
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.
115  *
116  * @section entry-special Special markups
117  *
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
120  * the text.
121  *
122  * @subsection entry-anchors Anchors
123  *
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,
126  * like this:
127  *
128  * @code
129  * This text is outside <a href=anc-01>but this one is an anchor</a>
130  * @endcode
131  *
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.
134  *
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
139  * an anchor.
140  *
141  * @subsection entry-items Items
142  *
143  * Inlined in the text, any other @c Evas_Object can be inserted by using
144  * \<item\> tags this way:
145  *
146  * @code
147  * <item size=16x16 vsize=full href=emoticon/haha></item>
148  * @endcode
149  *
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
154  * item.
155  *
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
160  * for the object.
161  * @li relsize: Size is adjusted for the item to fit within the current
162  * line height.
163  *
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
166  * are:
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.
174  *
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
178  * the descent.
179  *
180  * @image html entry_item.png
181  * @image latex entry_item.eps width=\textwidth
182  *
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.
185  *
186  * @image html entry_item_scale.png
187  * @image latex entry_item_scale.eps width=\textwidth
188  *
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
195  * them.
196  *
197  * All of the following are currently supported:
198  *
199  * - emoticon/angry
200  * - emoticon/angry-shout
201  * - emoticon/crazy-laugh
202  * - emoticon/evil-laugh
203  * - emoticon/evil
204  * - emoticon/goggle-smile
205  * - emoticon/grumpy
206  * - emoticon/grumpy-smile
207  * - emoticon/guilty
208  * - emoticon/guilty-smile
209  * - emoticon/haha
210  * - emoticon/half-smile
211  * - emoticon/happy-panting
212  * - emoticon/happy
213  * - emoticon/indifferent
214  * - emoticon/kiss
215  * - emoticon/knowing-grin
216  * - emoticon/laugh
217  * - emoticon/little-bit-sorry
218  * - emoticon/love-lots
219  * - emoticon/love
220  * - emoticon/minimal-smile
221  * - emoticon/not-happy
222  * - emoticon/not-impressed
223  * - emoticon/omg
224  * - emoticon/opensmile
225  * - emoticon/smile
226  * - emoticon/sorry
227  * - emoticon/squint-laugh
228  * - emoticon/surprised
229  * - emoticon/suspicious
230  * - emoticon/tongue-dangling
231  * - emoticon/tongue-poke
232  * - emoticon/uh
233  * - emoticon/unhappy
234  * - emoticon/very-sorry
235  * - emoticon/what
236  * - emoticon/wink
237  * - emoticon/worried
238  * - emoticon/wtf
239  *
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.
243  *
244  * @section entry-files Loading and saving files
245  *
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.
251  *
252  * @section entry-signals Emitted signals
253  *
254  * This widget emits the following signals:
255  *
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
261  * seconds.
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
269  * requested.
270  * @li "selection,cut": A cut of the selected text into the clipboard was
271  * requested.
272  * @li "selection,start": A selection has begun and no previous selection
273  * existed.
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.
289  *
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
293  *
294  * Default text parts of the entry that you can use for are:
295  * @li "default" - text of the entry
296  *
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
308  *
309  * @section entry-examples
310  *
311  * An overview of the Entry API can be seen in @ref entry_example_01
312  *
313  * @{
314  */
315
316 /**
317  * @typedef Elm_Entry_Anchor_Info
318  *
319  * The info sent in the callback for the "anchor,clicked" signals emitted
320  * by entries.
321  */
322 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
323
324 /**
325  * @struct _Elm_Entry_Anchor_Info
326  *
327  * The info sent in the callback for the "anchor,clicked" signals emitted
328  * by entries.
329  */
330 struct _Elm_Entry_Anchor_Info
331 {
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 */
338 };
339
340 /**
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
349  */
350 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
351
352 /**
353  * @typedef Elm_Entry_Change_Info
354  * This corresponds to Edje_Entry_Change_Info. Includes information about
355  * a change in the entry.
356  */
357 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
358
359 /**
360  * This adds an entry to @p parent object.
361  *
362  * By default, entries are:
363  * @li not scrolled
364  * @li multi-line
365  * @li word wrapped
366  * @li autosave is enabled
367  *
368  * @param parent The parent object
369  * @return The new object or NULL if it cannot be created
370  */
371 EAPI Evas_Object       *elm_entry_add(Evas_Object *parent);
372
373 /**
374  * Sets the entry to single line mode.
375  *
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.
379  *
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.
383  *
384  * @param obj The entry object
385  * @param single_line If true, the text in the entry
386  * will be on a single line.
387  */
388 EAPI void               elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
389
390 /**
391  * Gets whether the entry is set to be single line.
392  *
393  * @param obj The entry object
394  * @return single_line If true, the text in the entry is set to display
395  * on a single line.
396  *
397  * @see elm_entry_single_line_set()
398  */
399 EAPI Eina_Bool          elm_entry_single_line_get(const Evas_Object *obj);
400
401 /**
402  * Sets the entry to password mode.
403  *
404  * In password mode, entries are implicitly single line and the display of
405  * any text in them is replaced with asterisks (*).
406  *
407  * @param obj The entry object
408  * @param password If true, password mode is enabled.
409  */
410 EAPI void               elm_entry_password_set(Evas_Object *obj, Eina_Bool password);
411
412 /**
413  * Gets whether the entry is set to password mode.
414  *
415  * @param obj The entry object
416  * @return If true, the entry is set to display all characters
417  * as asterisks (*).
418  *
419  * @see elm_entry_password_set()
420  */
421 EAPI Eina_Bool          elm_entry_password_get(const Evas_Object *obj);
422
423 /**
424  * This sets the text displayed within the entry to @p entry.
425  *
426  * @param obj The entry object
427  * @param entry The text to be displayed
428  *
429  * @note Using this function bypasses text filters
430  */
431 EAPI void               elm_entry_entry_set(Evas_Object *obj, const char *entry);
432
433 /**
434  * This returns the text currently shown in object @p entry.
435  * See also elm_entry_entry_set().
436  *
437  * @param obj The entry object
438  * @return The currently displayed text or NULL on failure
439  */
440 EAPI const char        *elm_entry_entry_get(const Evas_Object *obj);
441
442 /**
443  * Appends @p entry to the text of the entry.
444  *
445  * Adds the text in @p entry to the end of any text already present in the
446  * widget.
447  *
448  * The appended text is subject to any filters set for the widget.
449  *
450  * @param obj The entry object
451  * @param entry The text to be displayed
452  *
453  * @see elm_entry_text_filter_append()
454  */
455 EAPI void               elm_entry_entry_append(Evas_Object *obj, const char *entry);
456
457 /**
458  * Gets whether the entry is empty.
459  *
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.
463  *
464  * @param obj The entry object
465  * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
466  */
467 EAPI Eina_Bool          elm_entry_is_empty(const Evas_Object *obj);
468
469 /**
470  * Gets any selected text within the entry.
471  *
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.
475  *
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.
479  *
480  * @param obj The entry object
481  * @return The selected text within the entry or NULL on failure
482  */
483 EAPI const char        *elm_entry_selection_get(const Evas_Object *obj);
484
485 /**
486  * Returns the actual textblock object of the entry.
487  *
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.
491  *
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().
496  *
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
501  * functionality.
502  *
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.
508  *
509  * @param obj The entry object
510  * @return The textblock object.
511  */
512 EAPI Evas_Object *      elm_entry_textblock_get(Evas_Object *obj);
513
514 /**
515  * Forces calculation of the entry size and text layouting.
516  *
517  * This should be used after modifying the textblock object directly. See
518  * elm_entry_textblock_get() for more information.
519  *
520  * @param obj The entry object
521  *
522  * @see elm_entry_textblock_get()
523  */
524 EAPI void               elm_entry_calc_force(Evas_Object *obj);
525
526 /**
527  * Inserts the given text into the entry at the current cursor position.
528  *
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.)
534  *
535  * If any selection exists, it will be replaced by the inserted text.
536  *
537  * The inserted text is subject to any filters set for the widget.
538  *
539  * @param obj The entry object
540  * @param entry The text to insert
541  *
542  * @see elm_entry_text_filter_append()
543  */
544 EAPI void               elm_entry_entry_insert(Evas_Object *obj, const char *entry);
545
546 /**
547  * Set the line wrap type to use on multi-line entries.
548  *
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.
553  *
554  * Note that this only makes sense for multi-line entries. A widget set
555  * to be single line will never wrap.
556  *
557  * @param obj The entry object
558  * @param wrap The wrap mode to use. See Elm_Wrap_Type for details on them
559  */
560 EAPI void               elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap);
561
562 /**
563  * Gets the wrap mode the entry was set to use.
564  *
565  * @param obj The entry object
566  * @return Wrap type
567  *
568  * @see also elm_entry_line_wrap_set()
569  */
570 EAPI Elm_Wrap_Type      elm_entry_line_wrap_get(const Evas_Object *obj);
571
572 /**
573  * Sets if the entry is to be editable or not.
574  *
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.
579  *
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
582  * functions.
583  *
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.
587  */
588 EAPI void               elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable);
589
590 /**
591  * Gets whether the entry is editable or not.
592  *
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
596  *
597  * @see elm_entry_editable_set()
598  */
599 EAPI Eina_Bool          elm_entry_editable_get(const Evas_Object *obj);
600
601 /**
602  * This drops any existing text selection within the entry.
603  *
604  * @param obj The entry object
605  */
606 EAPI void               elm_entry_select_none(Evas_Object *obj);
607
608 /**
609  * This selects all text within the entry.
610  *
611  * @param obj The entry object
612  */
613 EAPI void               elm_entry_select_all(Evas_Object *obj);
614
615 /**
616  * This moves the cursor one place to the right within the entry.
617  *
618  * @param obj The entry object
619  * @return EINA_TRUE upon success, EINA_FALSE upon failure
620  */
621 EAPI Eina_Bool          elm_entry_cursor_next(Evas_Object *obj);
622
623 /**
624  * This moves the cursor one place to the left within the entry.
625  *
626  * @param obj The entry object
627  * @return EINA_TRUE upon success, EINA_FALSE upon failure
628  */
629 EAPI Eina_Bool          elm_entry_cursor_prev(Evas_Object *obj);
630
631 /**
632  * This moves the cursor one line up within the entry.
633  *
634  * @param obj The entry object
635  * @return EINA_TRUE upon success, EINA_FALSE upon failure
636  */
637 EAPI Eina_Bool          elm_entry_cursor_up(Evas_Object *obj);
638
639 /**
640  * This moves the cursor one line down within the entry.
641  *
642  * @param obj The entry object
643  * @return EINA_TRUE upon success, EINA_FALSE upon failure
644  */
645 EAPI Eina_Bool          elm_entry_cursor_down(Evas_Object *obj);
646
647 /**
648  * This moves the cursor to the beginning of the entry.
649  *
650  * @param obj The entry object
651  */
652 EAPI void               elm_entry_cursor_begin_set(Evas_Object *obj);
653
654 /**
655  * This moves the cursor to the end of the entry.
656  *
657  * @param obj The entry object
658  */
659 EAPI void               elm_entry_cursor_end_set(Evas_Object *obj);
660
661 /**
662  * This moves the cursor to the beginning of the current line.
663  *
664  * @param obj The entry object
665  */
666 EAPI void               elm_entry_cursor_line_begin_set(Evas_Object *obj);
667
668 /**
669  * This moves the cursor to the end of the current line.
670  *
671  * @param obj The entry object
672  */
673 EAPI void               elm_entry_cursor_line_end_set(Evas_Object *obj);
674
675 /**
676  * This begins a selection within the entry as though
677  * the user were holding down the mouse button to make a selection.
678  *
679  * @param obj The entry object
680  */
681 EAPI void               elm_entry_cursor_selection_begin(Evas_Object *obj);
682
683 /**
684  * This ends a selection within the entry as though
685  * the user had just released the mouse button while making a selection.
686  *
687  * @param obj The entry object
688  */
689 EAPI void               elm_entry_cursor_selection_end(Evas_Object *obj);
690
691 /**
692  * Gets whether a format node exists at the current cursor position.
693  *
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
698  * cursor position.
699  *
700  * @param obj The entry object
701  * @return EINA_TRUE if the current cursor position contains a format node,
702  * EINA_FALSE otherwise.
703  *
704  * @see elm_entry_cursor_is_visible_format_get()
705  */
706 EAPI Eina_Bool          elm_entry_cursor_is_format_get(const Evas_Object *obj);
707
708 /**
709  * Gets if the current cursor position holds a visible format node.
710  *
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.
714  *
715  * @see elm_entry_cursor_is_format_get()
716  */
717 EAPI Eina_Bool          elm_entry_cursor_is_visible_format_get(const Evas_Object *obj);
718
719 /**
720  * Gets the character pointed by the cursor at its current position.
721  *
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().
726  *
727  * @param obj The entry object
728  * @return The text pointed by the cursors.
729  */
730 EAPI char              *elm_entry_cursor_content_get(const Evas_Object *obj);
731
732 /**
733  * This function returns the geometry of the cursor.
734  *
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
737  * cursor.
738  *
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
745  */
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);
747
748 /**
749  * Sets the cursor position in the entry to the given value
750  *
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().
753  *
754  * @param obj The entry object
755  * @param pos The position of the cursor
756  */
757 EAPI void               elm_entry_cursor_pos_set(Evas_Object *obj, int pos);
758
759 /**
760  * Retrieves the current position of the cursor in the entry
761  *
762  * @param obj The entry object
763  * @return The cursor position
764  */
765 EAPI int                elm_entry_cursor_pos_get(const Evas_Object *obj);
766
767 /**
768  * This executes a "cut" action on the selected text in the entry.
769  *
770  * @param obj The entry object
771  */
772 EAPI void               elm_entry_selection_cut(Evas_Object *obj);
773
774 /**
775  * This executes a "copy" action on the selected text in the entry.
776  *
777  * @param obj The entry object
778  */
779 EAPI void               elm_entry_selection_copy(Evas_Object *obj);
780
781 /**
782  * This executes a "paste" action in the entry.
783  *
784  * @param obj The entry object
785  */
786 EAPI void               elm_entry_selection_paste(Evas_Object *obj);
787
788 /**
789  * This clears and frees the items in a entry's contextual (longpress)
790  * menu.
791  *
792  * @param obj The entry object
793  *
794  * @see elm_entry_context_menu_item_add()
795  */
796 EAPI void               elm_entry_context_menu_clear(Evas_Object *obj);
797
798 /**
799  * This adds an item to the entry's contextual menu.
800  *
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.
806  *
807  * With this function, developers can add other options to this menu to
808  * perform any action they deem necessary.
809  *
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
816  */
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);
818
819 /**
820  * This disables the entry's contextual (longpress) menu.
821  *
822  * @param obj The entry object
823  * @param disabled If true, the menu is disabled
824  */
825 EAPI void               elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled);
826
827 /**
828  * This returns whether the entry's contextual (longpress) menu is
829  * disabled.
830  *
831  * @param obj The entry object
832  * @return If true, the menu is disabled
833  */
834 EAPI Eina_Bool          elm_entry_context_menu_disabled_get(const Evas_Object *obj);
835
836 /**
837  * This disables the entry's magnifer feature.
838  *
839  * @param obj The entry object
840  * @param disabled If true, the magnifier is not displayed
841  */
842
843 EAPI void         elm_entry_magnifier_disabled_set(Evas_Object *obj, Eina_Bool disabled);
844 /**
845  * This returns whether the entry's magnifier feature is disabled.
846  *
847  * @param obj The entry object
848  * @return If true, the feature is disabled
849  */
850 EAPI Eina_Bool    elm_entry_magnifier_disabled_get(const Evas_Object *obj);
851
852 /**
853  * This appends a custom item provider to the list for that entry
854  *
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.
861  *
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
865  *
866  * @see @ref entry-items
867  */
868 EAPI void               elm_entry_item_provider_append(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
869
870 /**
871  * This prepends a custom item provider to the list for that entry
872  *
873  * This prepends the given callback. See elm_entry_item_provider_append() for
874  * more information
875  *
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
879  */
880 EAPI void               elm_entry_item_provider_prepend(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
881
882 /**
883  * This removes a custom item provider to the list for that entry
884  *
885  * This removes the given callback. See elm_entry_item_provider_append() for
886  * more information
887  *
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
891  */
892 EAPI void               elm_entry_item_provider_remove(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data);
893
894 /**
895  * Append a filter function for text inserted in the entry
896  *
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
903  * being called.
904  *
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
908  */
909 EAPI void               elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
910
911 /**
912  * Prepend a filter function for text insdrted in the entry
913  *
914  * Prepend the given callback to the list. See elm_entry_text_filter_append()
915  * for more information
916  *
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
920  */
921 EAPI void               elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
922
923 /**
924  * Remove a filter from the list
925  *
926  * Removes the given callback from the filter list. See
927  * elm_entry_text_filter_append() for more information.
928  *
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
932  */
933 EAPI void               elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
934
935 /**
936  * This converts a markup (HTML-like) string into UTF-8.
937  *
938  * The returned string is a malloc'ed buffer and it should be freed when
939  * not needed anymore.
940  *
941  * @param s The string (in markup) to be converted
942  * @return The converted string (in UTF-8). It should be freed.
943  */
944 EAPI char              *elm_entry_markup_to_utf8(const char *s);
945
946 /**
947  * This converts a UTF-8 string into markup (HTML-like).
948  *
949  * The returned string is a malloc'ed buffer and it should be freed when
950  * not needed anymore.
951  *
952  * @param s The string (in UTF-8) to be converted
953  * @return The converted string (in markup). It should be freed.
954  */
955 EAPI char              *elm_entry_utf8_to_markup(const char *s);
956
957 /**
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).
961  *
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.
965  *
966  * @param obj The entry object
967  * @param file The path to the file to load and save
968  * @param format The file format
969  */
970 EAPI void               elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format);
971
972 /**
973  * Gets the file being edited by the entry.
974  *
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.
977  *
978  * @param obj The entry object
979  * @param file The path to the file to load and save
980  * @param format The file format
981  */
982 EAPI void               elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format);
983
984 /**
985  * This function writes any changes made to the file set with
986  * elm_entry_file_set()
987  *
988  * @param obj The entry object
989  */
990 EAPI void               elm_entry_file_save(Evas_Object *obj);
991
992 /**
993  * This sets the entry object to 'autosave' the loaded text file or not.
994  *
995  * @param obj The entry object
996  * @param autosave Autosave the loaded file or not
997  *
998  * @see elm_entry_file_set()
999  */
1000 EAPI void               elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave);
1001
1002 /**
1003  * This gets the entry object's 'autosave' status.
1004  *
1005  * @param obj The entry object
1006  * @return Autosave the loaded file or not
1007  *
1008  * @see elm_entry_file_set()
1009  */
1010 EAPI Eina_Bool          elm_entry_autosave_get(const Evas_Object *obj);
1011
1012 /**
1013  * Control pasting of text and images for the widget.
1014  *
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 .
1018  *
1019  * @note this only changes the behaviour of text.
1020  *
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.
1024  */
1025 EAPI void         elm_entry_cnp_mode_set(Evas_Object *obj, Elm_CNP_Mode cnp_mode);
1026
1027 /**
1028  * Getting elm_entry text paste/drop mode.
1029  *
1030  * Normally the entry allows both text and images to be pasted.
1031  * This gets the copy & paste mode of the entry.
1032  *
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.
1036  */
1037 EAPI Elm_CNP_Mode elm_entry_cnp_mode_get(const Evas_Object *obj);
1038
1039 /**
1040  * Control pasting of text and images for the widget.
1041  *
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.
1044  *
1045  * Note this only changes the behaviour of text.
1046  *
1047  * @param obj The entry object
1048  * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
1049  * text+image+other.
1050  */
1051
1052 /**
1053  * Control pasting of text and images for the widget.
1054  *
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.
1057  *
1058  * Note this only changes the behaviour of text.
1059  *
1060  * @param obj The entry object
1061  * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
1062  * text+image+other.
1063  */
1064 EAPI void               elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly);
1065
1066 /**
1067  * Getting elm_entry text paste/drop mode.
1068  *
1069  * In textonly mode, only text may be pasted or dropped into the widget.
1070  *
1071  * @param obj The entry object
1072  * @return If the widget only accepts text from pastes.
1073  */
1074 EAPI Eina_Bool          elm_entry_cnp_textonly_get(const Evas_Object *obj);
1075
1076 /**
1077  * Enable or disable scrolling in entry
1078  *
1079  * Normally the entry is not scrollable unless you enable it with this call.
1080  *
1081  * @param obj The entry object
1082  * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
1083  */
1084 EAPI void               elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
1085
1086 /**
1087  * Get the scrollable state of the entry
1088  *
1089  * Normally the entry is not scrollable. This gets the scrollable state
1090  * of the entry. See elm_entry_scrollable_set() for more information.
1091  *
1092  * @param obj The entry object
1093  * @return The scrollable state
1094  */
1095 EAPI Eina_Bool          elm_entry_scrollable_get(const Evas_Object *obj);
1096
1097 /**
1098  * Sets the visibility of the left-side widget of the scrolled entry,
1099  * set by elm_entry_icon_set().
1100  *
1101  * @param obj The scrolled entry object
1102  * @param setting EINA_TRUE if the object should be displayed,
1103  * EINA_FALSE if not.
1104  */
1105 EAPI void               elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
1106
1107 /**
1108  * Sets the visibility of the end widget of the scrolled entry, set by
1109  * elm_object_part_content_set(ent, "end", content).
1110  *
1111  * @param obj The scrolled entry object
1112  * @param setting EINA_TRUE if the object should be displayed,
1113  * EINA_FALSE if not.
1114  */
1115 EAPI void               elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
1116
1117 /**
1118  * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
1119  * them).
1120  *
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.
1124  *
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
1128  */
1129 EAPI void               elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
1130
1131 /**
1132  * This enables/disables bouncing within the entry.
1133  *
1134  * This function sets whether the entry will bounce when scrolling reaches
1135  * the end of the contained entry.
1136  *
1137  * @param obj The scrolled entry object
1138  * @param h_bounce The horizontal bounce state
1139  * @param v_bounce The vertical bounce state
1140  */
1141 EAPI void               elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
1142
1143 /**
1144  * Get the bounce mode
1145  *
1146  * @param obj The Entry object
1147  * @param h_bounce Allow bounce horizontally
1148  * @param v_bounce Allow bounce vertically
1149  */
1150 EAPI void               elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
1151
1152 /**
1153  * Set the input panel layout of the entry
1154  *
1155  * @param obj The entry object
1156  * @param layout layout type
1157  */
1158 EAPI void                   elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
1159
1160 /**
1161  * Get the input panel layout of the entry
1162  *
1163  * @param obj The entry object
1164  * @return layout type
1165  *
1166  * @see elm_entry_input_panel_layout_set
1167  */
1168 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(const Evas_Object *obj);
1169
1170 /**
1171  * Set the autocapitalization type on the immodule.
1172  *
1173  * @param obj The entry object
1174  * @param autocapital_type The type of autocapitalization
1175  */
1176 EAPI void                   elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type);
1177
1178 /**
1179  * Retrieve the autocapitalization type on the immodule.
1180  *
1181  * @param obj The entry object
1182  * @return autocapitalization type
1183  */
1184 EAPI Elm_Autocapital_Type   elm_entry_autocapital_type_get(const Evas_Object *obj);
1185
1186 /**
1187  * Sets the attribute to show the input panel automatically.
1188  *
1189  * @param obj The entry object
1190  * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
1191  */
1192 EAPI void                   elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
1193
1194 /**
1195  * Retrieve the attribute to show the input panel automatically.
1196  *
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
1199  */
1200 EAPI Eina_Bool              elm_entry_input_panel_enabled_get(const Evas_Object *obj);
1201
1202 /**
1203  * Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
1204  *
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)
1207  *
1208  * @param obj The entry object
1209  */
1210 EAPI void                   elm_entry_input_panel_show(Evas_Object *obj);
1211
1212 /**
1213  * Hide the input panel (virtual keyboard).
1214  *
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)
1217  *
1218  * @param obj The entry object
1219  */
1220 EAPI void                   elm_entry_input_panel_hide(Evas_Object *obj);
1221
1222 /**
1223  * Set the language mode of the input panel.
1224  *
1225  * This API can be used if you want to show the alphabet keyboard mode. 
1226  *
1227  * @param obj The entry object
1228  * @param lang language to be set to the input panel.
1229  */
1230 EAPI void                   elm_entry_input_panel_language_set(Evas_Object *obj, Elm_Input_Panel_Lang lang);
1231
1232 /**
1233  * Get the language mode of the input panel.
1234  *
1235  * See @ref elm_entry_input_panel_language_set for more details.
1236  *
1237  * @param obj The entry object
1238  * @return input panel language type
1239  */
1240 EAPI Elm_Input_Panel_Lang   elm_entry_input_panel_language_get(const Evas_Object *obj);
1241
1242 /**
1243  * Set the input panel-specific data to deliver to the input panel.
1244  *
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.
1248  *
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
1252  */
1253 EAPI void                   elm_entry_input_panel_imdata_set(Evas_Object *obj, const void *data, int len);
1254
1255 /**
1256  * Get the specific data of the current input panel.
1257  *
1258  * See @ref elm_entry_input_panel_imdata_set for more details. 
1259  *
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
1263  */
1264 EAPI void                   elm_entry_input_panel_imdata_get(const Evas_Object *obj, void *data, int *len);
1265
1266 /**
1267  * Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
1268  *
1269  * An input panel displays the string or icon associated with this type
1270  *
1271  * @param obj The entry object
1272  * @param return_key_type The type of "return" key on the input panel
1273  */
1274 EAPI void                   elm_entry_input_panel_return_key_type_set(Evas_Object *obj, Elm_Input_Panel_Return_Key_Type return_key_type);
1275
1276 /**
1277  * Get the "return" key type.
1278  *
1279  * @see elm_entry_input_panel_return_key_type_set() for more details
1280  *
1281  * @param obj The entry object
1282  * @return The type of "return" key on the input panel
1283  */
1284 EAPI Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get(const Evas_Object *obj);
1285
1286 /**
1287  * Set the return key on the input panel to be disabled.
1288  *
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 
1292  */
1293 EAPI void                   elm_entry_input_panel_return_key_disabled_set(Evas_Object *obj, Eina_Bool disabled);
1294
1295 /**
1296  * Get whether the return key on the input panel should be disabled or not.
1297  *
1298  * @param obj The entry object
1299  * @return EINA_TRUE if it should be disabled
1300  */
1301 EAPI Eina_Bool              elm_entry_input_panel_return_key_disabled_get(const Evas_Object *obj);
1302
1303 /**
1304  * Reset the input method context of the entry if needed. 
1305  *
1306  * This can be necessary in the case where modifying the buffer would confuse on-going input method behavior
1307  * @param obj The entry object
1308  */
1309 EAPI void                   elm_entry_imf_context_reset(Evas_Object *obj);
1310
1311 /**
1312  * Set whether the entry should allow to use the text prediction.
1313  *
1314  * @param obj The entry object
1315  * @param prediction Whether the entry should allow to use the text prediction.
1316  */
1317 EAPI void                   elm_entry_prediction_allow_set(Evas_Object *obj, Eina_Bool prediction);
1318
1319 /**
1320  * Get whether the entry should allow to use the text prediction.
1321  *
1322  * @param obj The entry object
1323  * @return EINA_TRUE if it allows to use the text prediction, otherwise EINA_FALSE.
1324  */
1325 EAPI Eina_Bool              elm_entry_prediction_allow_get(const Evas_Object *obj);
1326
1327 /* pre-made filters for entries */
1328
1329 /**
1330  * @typedef Elm_Entry_Filter_Limit_Size
1331  *
1332  * Data for the elm_entry_filter_limit_size() entry filter.
1333  */
1334 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
1335
1336 /**
1337  * @struct _Elm_Entry_Filter_Limit_Size
1338  *
1339  * Data for the elm_entry_filter_limit_size() entry filter.
1340  */
1341 struct _Elm_Entry_Filter_Limit_Size
1342 {
1343    int max_char_count;      /**< The maximum number of characters allowed. */
1344    int max_byte_count;      /**< The maximum number of bytes allowed*/
1345 };
1346
1347 /**
1348  * Filter inserted text based on user defined character and byte limits
1349  *
1350  * Add this filter to an entry to limit the characters that it will accept
1351  * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
1352  * The funtion works on the UTF-8 representation of the string, converting
1353  * it from the set markup, thus not accounting for any format in it.
1354  *
1355  * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
1356  * it as data when setting the filter. In it, it's possible to set limits
1357  * by character count or bytes (any of them is disabled if 0), and both can
1358  * be set at the same time. In that case, it first checks for characters,
1359  * then bytes.
1360  *
1361  * The function will cut the inserted text in order to allow only the first
1362  * number of characters that are still allowed. The cut is made in
1363  * characters, even when limiting by bytes, in order to always contain
1364  * valid ones and avoid half unicode characters making it in.
1365  *
1366  * This filter, like any others, does not apply when setting the entry text
1367  * directly with elm_object_text_set().
1368  */
1369 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text);
1370
1371 /**
1372  * @typedef Elm_Entry_Filter_Accept_Set
1373  *
1374  * Data for the elm_entry_filter_accept_set() entry filter.
1375  */
1376 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
1377
1378 /**
1379  * @struct _Elm_Entry_Filter_Accept_Set
1380  *
1381  * Data for the elm_entry_filter_accept_set() entry filter.
1382  */
1383 struct _Elm_Entry_Filter_Accept_Set
1384 {
1385    const char *accepted;      /**< Set of characters accepted in the entry. */
1386    const char *rejected;      /**< Set of characters rejected from the entry. */
1387 };
1388
1389 /**
1390  * Filter inserted text based on accepted or rejected sets of characters
1391  *
1392  * Add this filter to an entry to restrict the set of accepted characters
1393  * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
1394  * This structure contains both accepted and rejected sets, but they are
1395  * mutually exclusive.
1396  *
1397  * The @c accepted set takes preference, so if it is set, the filter will
1398  * only work based on the accepted characters, ignoring anything in the
1399  * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
1400  *
1401  * In both cases, the function filters by matching utf8 characters to the
1402  * raw markup text, so it can be used to remove formatting tags.
1403  *
1404  * This filter, like any others, does not apply when setting the entry text
1405  * directly with elm_object_text_set()
1406  */
1407 EAPI void                   elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text);
1408
1409 EAPI void                   elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
1410 EINA_DEPRECATED EAPI void   elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
1411 EINA_DEPRECATED EAPI void   elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
1412 EAPI Ecore_IMF_Context     *elm_entry_imf_context_get(Evas_Object *obj);
1413 EAPI void                   elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
1414 EAPI void                   elm_entry_magnifier_type_set(Evas_Object *obj, int type);
1415
1416 /**
1417  * @}
1418  */