aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/libraries/elementary/src/lib/elm_entry.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--libraries/elementary/src/lib/elm_entry.h1730
1 files changed, 1730 insertions, 0 deletions
diff --git a/libraries/elementary/src/lib/elm_entry.h b/libraries/elementary/src/lib/elm_entry.h
new file mode 100644
index 0000000..0621caa
--- /dev/null
+++ b/libraries/elementary/src/lib/elm_entry.h
@@ -0,0 +1,1730 @@
1/**
2 * @defgroup Entry Entry
3 * @ingroup Elementary
4 *
5 * @image html img/widget/entry/preview-00.png
6 * @image latex img/widget/entry/preview-00.eps width=\textwidth
7 * @image html img/widget/entry/preview-01.png
8 * @image latex img/widget/entry/preview-01.eps width=\textwidth
9 * @image html img/widget/entry/preview-02.png
10 * @image latex img/widget/entry/preview-02.eps width=\textwidth
11 * @image html img/widget/entry/preview-03.png
12 * @image latex img/widget/entry/preview-03.eps width=\textwidth
13 *
14 * An entry is a convenience widget which shows a box that the user can
15 * enter text into. Entries by default don't scroll, so they grow to
16 * accommodate the entire text, resizing the parent window as needed. This
17 * can be changed with the elm_entry_scrollable_set() function.
18 *
19 * They can also be single line or multi line (the default) and when set
20 * to multi line mode they support text wrapping in any of the modes
21 * indicated by #Elm_Wrap_Type.
22 *
23 * Other features include password mode, filtering of inserted text with
24 * elm_entry_markup_filter_append() and related functions, inline "items" and
25 * formatted markup text.
26 *
27 * @section entry-markup Formatted text
28 *
29 * The markup tags supported by the Entry are defined by the theme, but
30 * even when writing new themes or extensions it's a good idea to stick to
31 * a sane default, to maintain coherency and avoid application breakages.
32 * Currently defined by the default theme are the following tags:
33 * @li \<br\>: Inserts a line break.
34 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
35 * breaks.
36 * @li \<tab\>: Inserts a tab.
37 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
38 * enclosed text.
39 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
40 * @li \<link\>...\</link\>: Underlines the enclosed text.
41 * @li \<hilight\>...\</hilight\>: Highlights the enclosed text.
42 *
43 * @section entry-special Special markups
44 *
45 * Besides those used to format text, entries support two special markup
46 * tags used to insert click-able portions of text or items inlined within
47 * the text.
48 *
49 * @subsection entry-anchors Anchors
50 *
51 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
52 * \</a\> tags and an event will be generated when this text is clicked,
53 * like this:
54 *
55 * @code
56 * This text is outside <a href=anc-01>but this one is an anchor</a>
57 * @endcode
58 *
59 * The @c href attribute in the opening tag gives the name that will be
60 * used to identify the anchor and it can be any valid utf8 string.
61 *
62 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
63 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
64 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
65 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
66 * an anchor.
67 *
68 * @subsection entry-items Items
69 *
70 * Inlined in the text, any other @c Evas_Object can be inserted by using
71 * \<item\> tags this way:
72 *
73 * @code
74 * <item size=16x16 vsize=full href=emoticon/haha></item>
75 * @endcode
76 *
77 * Just like with anchors, the @c href identifies each item, but these need,
78 * in addition, to indicate their size, which is done using any one of
79 * @c size, @c absize or @c relsize attributes. These attributes take their
80 * value in the WxH format, where W is the width and H the height of the
81 * item.
82 *
83 * @li absize: Absolute pixel size for the item. Whatever value is set will
84 * be the item's size regardless of any scale value the object may have
85 * been set to. The final line height will be adjusted to fit larger items.
86 * @li size: Similar to @c absize, but it's adjusted to the scale value set
87 * for the object.
88 * @li relsize: Size is adjusted for the item to fit within the current
89 * line height.
90 *
91 * Besides their size, items are specified a @c vsize value that affects
92 * how their final size and position are calculated. The possible values
93 * are:
94 * @li ascent: Item will be placed within the line's baseline and its
95 * ascent. That is, the height between the line where all characters are
96 * positioned and the highest point in the line. For @c size and @c absize
97 * items, the descent value will be added to the total line height to make
98 * them fit. @c relsize items will be adjusted to fit within this space.
99 * @li full: Items will be placed between the descent and ascent, or the
100 * lowest point in the line and its highest.
101 *
102 * The next image shows different configurations of items and how
103 * the previously mentioned options affect their sizes. In all cases,
104 * the green line indicates the ascent, blue for the baseline and red for
105 * the descent.
106 *
107 * @image html entry_item.png
108 * @image latex entry_item.eps width=\textwidth
109 *
110 * And another one to show how size differs from absize. In the first one,
111 * the scale value is set to 1.0, while the second one is using one of 2.0.
112 *
113 * @image html entry_item_scale.png
114 * @image latex entry_item_scale.eps width=\textwidth
115 *
116 * After the size for an item is calculated, the entry will request an
117 * object to place in its space. For this, the functions set with
118 * elm_entry_item_provider_append() and related functions will be called
119 * in order until one of them returns a @c non-NULL value. If no providers
120 * are available, or all of them return @c NULL, then the entry falls back
121 * to one of the internal defaults, provided the name matches with one of
122 * them.
123 *
124 * All of the following are currently supported:
125 *
126 * - emoticon/angry
127 * - emoticon/angry-shout
128 * - emoticon/crazy-laugh
129 * - emoticon/evil-laugh
130 * - emoticon/evil
131 * - emoticon/goggle-smile
132 * - emoticon/grumpy
133 * - emoticon/grumpy-smile
134 * - emoticon/guilty
135 * - emoticon/guilty-smile
136 * - emoticon/haha
137 * - emoticon/half-smile
138 * - emoticon/happy-panting
139 * - emoticon/happy
140 * - emoticon/indifferent
141 * - emoticon/kiss
142 * - emoticon/knowing-grin
143 * - emoticon/laugh
144 * - emoticon/little-bit-sorry
145 * - emoticon/love-lots
146 * - emoticon/love
147 * - emoticon/minimal-smile
148 * - emoticon/not-happy
149 * - emoticon/not-impressed
150 * - emoticon/omg
151 * - emoticon/opensmile
152 * - emoticon/smile
153 * - emoticon/sorry
154 * - emoticon/squint-laugh
155 * - emoticon/surprised
156 * - emoticon/suspicious
157 * - emoticon/tongue-dangling
158 * - emoticon/tongue-poke
159 * - emoticon/uh
160 * - emoticon/unhappy
161 * - emoticon/very-sorry
162 * - emoticon/what
163 * - emoticon/wink
164 * - emoticon/worried
165 * - emoticon/wtf
166 *
167 * Alternatively, an item may reference an image by its path, using
168 * the URI form @c file:///path/to/an/image.png and the entry will then
169 * use that image for the item.
170 *
171 * @section entry-files Loading and saving files
172 *
173 * Entries have convenience functions to load text from a file and save
174 * changes back to it after a short delay. The automatic saving is enabled
175 * by default, but can be disabled with elm_entry_autosave_set() and files
176 * can be loaded directly as plain text or have any markup in them
177 * recognized. See elm_entry_file_set() for more details.
178 *
179 * @section entry-signals Emitted signals
180 *
181 * This widget emits the following signals:
182 *
183 * @li "changed": The text within the entry was changed.
184 * @li "changed,user": The text within the entry was changed because of user interaction.
185 * @li "activated": The enter key was pressed on a single line entry.
186 * @li "press": A mouse button has been pressed on the entry.
187 * @li "longpressed": A mouse button has been pressed and held for a couple
188 * seconds.
189 * @li "clicked": The entry has been clicked (mouse press and release).
190 * @li "clicked,double": The entry has been double clicked.
191 * @li "clicked,triple": The entry has been triple clicked.
192 * @li "focused": The entry has received focus.
193 * @li "unfocused": The entry has lost focus.
194 * @li "selection,paste": A paste of the clipboard contents was requested.
195 * @li "selection,copy": A copy of the selected text into the clipboard was
196 * requested.
197 * @li "selection,cut": A cut of the selected text into the clipboard was
198 * requested.
199 * @li "selection,start": A selection has begun and no previous selection
200 * existed.
201 * @li "selection,changed": The current selection has changed.
202 * @li "selection,cleared": The current selection has been cleared.
203 * @li "cursor,changed": The cursor has changed position.
204 * @li "anchor,clicked": An anchor has been clicked. The event_info
205 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
206 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
207 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
208 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
209 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
210 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
211 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
212 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
213 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
214 * @li "preedit,changed": The preedit string has changed.
215 * @li "language,changed": Program language changed.
216 *
217 * Default content parts of the entry items that you can use for are:
218 * @li "icon" - An icon in the entry
219 * @li "end" - A content in the end of the entry
220 *
221 * Default text parts of the entry that you can use for are:
222 * @li "default" - text of the entry
223 *
224 * Supported elm_object common APIs.
225 * @li @ref elm_object_signal_emit
226 * @li @ref elm_object_part_text_set
227 * @li @ref elm_object_part_text_get
228 * @li @ref elm_object_part_content_set
229 * @li @ref elm_object_part_content_get
230 * @li @ref elm_object_part_content_unset
231 * @li @ref elm_object_signal_callback_add
232 * @li @ref elm_object_signal_callback_del
233 * @li @ref elm_object_disabled_set
234 * @li @ref elm_object_disabled_get
235 *
236 * @section entry-examples
237 *
238 * An overview of the Entry API can be seen in @ref entry_example
239 *
240 * @{
241 */
242
243/**
244 * @typedef Elm_Text_Format
245 *
246 * Text Format types.
247 *
248 * @see elm_entry_file_set()
249 */
250typedef enum
251{
252 ELM_TEXT_FORMAT_PLAIN_UTF8, /**< Plain UTF8 type */
253 ELM_TEXT_FORMAT_MARKUP_UTF8 /**< Markup UTF8 type */
254} Elm_Text_Format;
255
256/**
257 * @typedef Elm_Wrap_Type
258 *
259 * Line wrapping types.
260 *
261 * @see elm_entry_line_wrap_set()
262 */
263typedef enum
264{
265 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
266 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
267 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
268 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
269 ELM_WRAP_LAST
270} Elm_Wrap_Type; /**< Type of word or character wrapping to use */
271
272/**
273 * @typedef Elm_Input_Panel_Layout
274 *
275 * Input panel (virtual keyboard) layout types.
276 *
277 * @see elm_entry_input_panel_layout_set()
278 */
279typedef enum
280{
281 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
282 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
283 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
284 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
285 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
286 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
287 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
288 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
289 ELM_INPUT_PANEL_LAYOUT_INVALID, /**< Never use this */
290 ELM_INPUT_PANEL_LAYOUT_HEX, /**< Hexadecimal layout */
291 ELM_INPUT_PANEL_LAYOUT_TERMINAL, /**< Command-line terminal layout */
292 ELM_INPUT_PANEL_LAYOUT_PASSWORD /**< Like normal, but no auto-correct, no auto-capitalization etc. */
293} Elm_Input_Panel_Layout; /**< Type of input panel (virtual keyboard) to use - this is a hint and may not provide exactly what is desired. */
294
295/**
296 * @typedef Elm_Input_Panel_Lang
297 *
298 * Input panel (virtual keyboard) language modes.
299 *
300 * @see elm_entry_input_panel_language_set()
301 */
302typedef enum
303{
304 ELM_INPUT_PANEL_LANG_AUTOMATIC, /**< Automatic */
305 ELM_INPUT_PANEL_LANG_ALPHABET /**< Alphabet */
306} Elm_Input_Panel_Lang;
307
308/**
309 * @typedef Elm_Autocapital_Type
310 *
311 * Autocapitalization Types.
312 *
313 * @see elm_entry_autocapital_type_set()
314 */
315typedef enum
316{
317 ELM_AUTOCAPITAL_TYPE_NONE, /**< No auto-capitalization when typing */
318 ELM_AUTOCAPITAL_TYPE_WORD, /**< Autocapitalize each word typed */
319 ELM_AUTOCAPITAL_TYPE_SENTENCE, /**< Autocapitalize the start of each sentence */
320 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters */
321} Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
322
323/**
324 * @typedef Elm_Input_Panel_Return_Key_Type
325 *
326 * "Return" Key types on the input panel (virtual keyboard).
327 *
328 * @see elm_entry_input_panel_return_key_type_set()
329 */
330typedef enum
331{
332 ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT, /**< Default */
333 ELM_INPUT_PANEL_RETURN_KEY_TYPE_DONE, /**< Done */
334 ELM_INPUT_PANEL_RETURN_KEY_TYPE_GO, /**< Go */
335 ELM_INPUT_PANEL_RETURN_KEY_TYPE_JOIN, /**< Join */
336 ELM_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN, /**< Login */
337 ELM_INPUT_PANEL_RETURN_KEY_TYPE_NEXT, /**< Next */
338 ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH, /**< Search string or magnifier icon */
339 ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEND /**< Send */
340} Elm_Input_Panel_Return_Key_Type;
341
342/**
343 * @typedef Elm_Entry_Anchor_Info
344 *
345 * The info sent in the callback for the "anchor,clicked" signals emitted
346 * by entries.
347 */
348typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
349
350/**
351 * @struct _Elm_Entry_Anchor_Info
352 *
353 * The info sent in the callback for the "anchor,clicked" signals emitted
354 * by entries.
355 */
356struct _Elm_Entry_Anchor_Info
357{
358 const char *name; /**< The name of the anchor, as stated in its href */
359 int button; /**< The mouse button used to click on it */
360 Evas_Coord x, /**< Anchor geometry, relative to canvas */
361 y, /**< Anchor geometry, relative to canvas */
362 w, /**< Anchor geometry, relative to canvas */
363 h; /**< Anchor geometry, relative to canvas */
364};
365
366/**
367 * @typedef Elm_Entry_Anchor_Hover_Info
368 *
369 * The info sent in the callback for "anchor,clicked" signals emitted by
370 * the Anchor_Hover widget.
371 */
372typedef struct _Elm_Entry_Anchor_Hover_Info Elm_Entry_Anchor_Hover_Info;
373
374/**
375 * @struct _Elm_Entry_Anchor_Hover_Info
376 *
377 * The info sent in the callback for "anchor,clicked" signals emitted by
378 * the Anchor_Hover widget.
379 */
380struct _Elm_Entry_Anchor_Hover_Info
381{
382 const Elm_Entry_Anchor_Info *anchor_info; /**< The actual anchor info. */
383 Evas_Object *hover; /**< The hover object to use for the popup */
384 struct
385 {
386 Evas_Coord x, y, w, h;
387 } hover_parent; /**< Geometry of the object used as parent by the
388 hover */
389 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
390 for content on the left side of
391 the hover. Before calling the
392 callback, the widget will make the
393 necessary calculations to check
394 which sides are fit to be set with
395 content, based on the position the
396 hover is activated and its distance
397 to the edges of its parent object
398 */
399 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
400 the right side of the hover.
401 See @ref hover_left */
402 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
403 of the hover. See @ref hover_left */
404 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
405 below the hover. See @ref
406 hover_left */
407};
408
409/**
410 * @typedef Elm_Entry_Item_Provider_Cb
411 * This callback type is used to provide items.
412 * If it returns an object handle other than NULL (it should create an
413 * object to do this), then this object is used to replace the current item.
414 * If not the next provider is called until one provides an item object, or the
415 * default provider in entry does.
416 * @param data The data specified as the last param when adding the provider
417 * @param entry The entry object
418 * @param text A pointer to the item href string in the text
419 * @return The object to be placed in the entry like an icon, or other element
420 * @see elm_entry_item_provider_append
421 * @see elm_entry_item_provider_prepend
422 * @see elm_entry_item_provider_remove
423 */
424typedef Evas_Object * (*Elm_Entry_Item_Provider_Cb)(void *data, Evas_Object * entry, const char *item);
425
426/**
427 * @typedef Elm_Entry_Filter_Cb
428 * This callback type is used by entry filters to modify text.
429 * @param data The data specified as the last param when adding the filter
430 * @param entry The entry object
431 * @param text A pointer to the location of the text being filtered. The type of text is always markup. This data can be modified, but any additional allocations must be managed by the user.
432 * @see elm_entry_markup_filter_append
433 * @see elm_entry_markup_filter_prepend
434 * @see elm_entry_markup_filter_remove
435 */
436typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
437
438/**
439 * @typedef Elm_Entry_Change_Info
440 * This corresponds to Edje_Entry_Change_Info. Includes information about
441 * a change in the entry.
442 */
443typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
444
445/**
446 * This adds an entry to @p parent object.
447 *
448 * By default, entries are:
449 * @li not scrolled
450 * @li multi-line
451 * @li word wrapped
452 * @li autosave is enabled
453 *
454 * @param parent The parent object
455 * @return The new object or NULL if it cannot be created
456 *
457 * @ingroup Entry
458 */
459EAPI Evas_Object *elm_entry_add(Evas_Object *parent);
460
461/**
462 * Sets the entry to single line mode.
463 *
464 * In single line mode, entries don't ever wrap when the text reaches the
465 * edge, and instead they keep growing horizontally. Pressing the @c Enter
466 * key will generate an @c "activate" event instead of adding a new line.
467 *
468 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
469 * and pressing enter will break the text into a different line
470 * without generating any events.
471 *
472 * @param obj The entry object
473 * @param single_line If true, the text in the entry
474 * will be on a single line.
475 *
476 * @ingroup Entry
477 */
478EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
479
480/**
481 * Gets whether the entry is set to be single line.
482 *
483 * @param obj The entry object
484 * @return single_line If true, the text in the entry is set to display
485 * on a single line.
486 *
487 * @see elm_entry_single_line_set()
488 *
489 * @ingroup Entry
490 */
491EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj);
492
493/**
494 * Sets the entry to password mode.
495 *
496 * In password mode, entries are implicitly single line and the display of
497 * any text in them is replaced with asterisks (*).
498 *
499 * @param obj The entry object
500 * @param password If true, password mode is enabled.
501 *
502 * @ingroup Entry
503 */
504EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password);
505
506/**
507 * Gets whether the entry is set to password mode.
508 *
509 * @param obj The entry object
510 * @return If true, the entry is set to display all characters
511 * as asterisks (*).
512 *
513 * @see elm_entry_password_set()
514 *
515 * @ingroup Entry
516 */
517EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj);
518
519/**
520 * This sets the text displayed within the entry to @p entry.
521 *
522 * @param obj The entry object
523 * @param entry The text to be displayed
524 *
525 * @note Using this function bypasses text filters
526 *
527 * @ingroup Entry
528 */
529EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry);
530
531/**
532 * This returns the text currently shown in object @p entry.
533 * See also elm_entry_entry_set().
534 *
535 * @param obj The entry object
536 * @return The currently displayed text or NULL on failure
537 *
538 * @ingroup Entry
539 */
540EAPI const char *elm_entry_entry_get(const Evas_Object *obj);
541
542/**
543 * Appends @p entry to the text of the entry.
544 *
545 * Adds the text in @p entry to the end of any text already present in the
546 * widget.
547 *
548 * The appended text is subject to any filters set for the widget.
549 *
550 * @param obj The entry object
551 * @param entry The text to be displayed
552 *
553 * @see elm_entry_markup_filter_append()
554 *
555 * @ingroup Entry
556 */
557EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry);
558
559/**
560 * Gets whether the entry is empty.
561 *
562 * Empty means no text at all. If there are any markup tags, like an item
563 * tag for which no provider finds anything, and no text is displayed, this
564 * function still returns EINA_FALSE.
565 *
566 * @param obj The entry object
567 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
568 *
569 * @ingroup Entry
570 */
571EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj);
572
573/**
574 * Gets any selected text within the entry.
575 *
576 * If there's any selected text in the entry, this function returns it as
577 * a string in markup format. NULL is returned if no selection exists or
578 * if an error occurred.
579 *
580 * The returned value points to an internal string and should not be freed
581 * or modified in any way. If the @p entry object is deleted or its
582 * contents are changed, the returned pointer should be considered invalid.
583 *
584 * @param obj The entry object
585 * @return The selected text within the entry or NULL on failure
586 *
587 * @ingroup Entry
588 */
589EAPI const char *elm_entry_selection_get(const Evas_Object *obj);
590
591/**
592 * Returns the actual textblock object of the entry.
593 *
594 * This function exposes the internal textblock object that actually
595 * contains and draws the text. This should be used for low-level
596 * manipulations that are otherwise not possible.
597 *
598 * Changing the textblock directly from here will not notify edje/elm to
599 * recalculate the textblock size automatically, so any modifications
600 * done to the textblock returned by this function should be followed by
601 * a call to elm_entry_calc_force().
602 *
603 * The return value is marked as const as an additional warning.
604 * One should not use the returned object with any of the generic evas
605 * functions (geometry_get/resize/move and etc), but only with the textblock
606 * functions; The former will either not work at all, or break the correct
607 * functionality.
608 *
609 * IMPORTANT: Many functions may change (i.e delete and create a new one)
610 * the internal textblock object. Do NOT cache the returned object, and try
611 * not to mix calls on this object with regular elm_entry calls (which may
612 * change the internal textblock object). This applies to all cursors
613 * returned from textblock calls, and all the other derivative values.
614 *
615 * @param obj The entry object
616 * @return The textblock object.
617 *
618 * @ingroup Entry
619 */
620EAPI Evas_Object * elm_entry_textblock_get(Evas_Object *obj);
621
622/**
623 * Forces calculation of the entry size and text layouting.
624 *
625 * This should be used after modifying the textblock object directly. See
626 * elm_entry_textblock_get() for more information.
627 *
628 * @param obj The entry object
629 *
630 * @see elm_entry_textblock_get()
631 *
632 * @ingroup Entry
633 */
634EAPI void elm_entry_calc_force(Evas_Object *obj);
635
636/**
637 * Inserts the given text into the entry at the current cursor position.
638 *
639 * This inserts text at the cursor position as if it was typed
640 * by the user (note that this also allows markup which a user
641 * can't just "type" as it would be converted to escaped text, so this
642 * call can be used to insert things like emoticon items or bold push/pop
643 * tags, other font and color change tags etc.)
644 *
645 * If any selection exists, it will be replaced by the inserted text.
646 *
647 * The inserted text is subject to any filters set for the widget.
648 *
649 * @param obj The entry object
650 * @param entry The text to insert
651 *
652 * @see elm_entry_markup_filter_append()
653 *
654 * @ingroup Entry
655 */
656EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry);
657
658/**
659 * Set the line wrap type to use on multi-line entries.
660 *
661 * Sets the wrap type used by the entry to any of the specified in
662 * Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
663 * line (without inserting a line break or paragraph separator) when it
664 * reaches the far edge of the widget.
665 *
666 * Note that this only makes sense for multi-line entries. A widget set
667 * to be single line will never wrap.
668 *
669 * @param obj The entry object
670 * @param wrap The wrap mode to use. See Elm_Wrap_Type for details on them
671 */
672EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap);
673
674/**
675 * Gets the wrap mode the entry was set to use.
676 *
677 * @param obj The entry object
678 * @return Wrap type
679 *
680 * @see also elm_entry_line_wrap_set()
681 *
682 * @ingroup Entry
683 */
684EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj);
685
686/**
687 * Sets if the entry is to be editable or not.
688 *
689 * By default, entries are editable and when focused, any text input by the
690 * user will be inserted at the current cursor position. But calling this
691 * function with @p editable as EINA_FALSE will prevent the user from
692 * inputting text into the entry.
693 *
694 * The only way to change the text of a non-editable entry is to use
695 * elm_object_text_set(), elm_entry_entry_insert() and other related
696 * functions.
697 *
698 * @param obj The entry object
699 * @param editable If EINA_TRUE, user input will be inserted in the entry,
700 * if not, the entry is read-only and no user input is allowed.
701 *
702 * @ingroup Entry
703 */
704EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable);
705
706/**
707 * Gets whether the entry is editable or not.
708 *
709 * @param obj The entry object
710 * @return If true, the entry is editable by the user.
711 * If false, it is not editable by the user
712 *
713 * @see elm_entry_editable_set()
714 *
715 * @ingroup Entry
716 */
717EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj);
718
719/**
720 * This drops any existing text selection within the entry.
721 *
722 * @param obj The entry object
723 *
724 * @ingroup Entry
725 */
726EAPI void elm_entry_select_none(Evas_Object *obj);
727
728/**
729 * This selects all text within the entry.
730 *
731 * @param obj The entry object
732 *
733 * @ingroup Entry
734 */
735EAPI void elm_entry_select_all(Evas_Object *obj);
736
737/**
738 * This moves the cursor one place to the right within the entry.
739 *
740 * @param obj The entry object
741 * @return EINA_TRUE upon success, EINA_FALSE upon failure
742 *
743 * @ingroup Entry
744 */
745EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj);
746
747/**
748 * This moves the cursor one place to the left within the entry.
749 *
750 * @param obj The entry object
751 * @return EINA_TRUE upon success, EINA_FALSE upon failure
752 *
753 * @ingroup Entry
754 */
755EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj);
756
757/**
758 * This moves the cursor one line up within the entry.
759 *
760 * @param obj The entry object
761 * @return EINA_TRUE upon success, EINA_FALSE upon failure
762 *
763 * @ingroup Entry
764 */
765EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj);
766
767/**
768 * This moves the cursor one line down within the entry.
769 *
770 * @param obj The entry object
771 * @return EINA_TRUE upon success, EINA_FALSE upon failure
772 *
773 * @ingroup Entry
774 */
775EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj);
776
777/**
778 * This moves the cursor to the beginning of the entry.
779 *
780 * @param obj The entry object
781 *
782 * @ingroup Entry
783 */
784EAPI void elm_entry_cursor_begin_set(Evas_Object *obj);
785
786/**
787 * This moves the cursor to the end of the entry.
788 *
789 * @param obj The entry object
790 *
791 * @ingroup Entry
792 */
793EAPI void elm_entry_cursor_end_set(Evas_Object *obj);
794
795/**
796 * This moves the cursor to the beginning of the current line.
797 *
798 * @param obj The entry object
799 *
800 * @ingroup Entry
801 */
802EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj);
803
804/**
805 * This moves the cursor to the end of the current line.
806 *
807 * @param obj The entry object
808 *
809 * @ingroup Entry
810 */
811EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj);
812
813/**
814 * This begins a selection within the entry as though
815 * the user were holding down the mouse button to make a selection.
816 *
817 * @param obj The entry object
818 *
819 * @ingroup Entry
820 */
821EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj);
822
823/**
824 * This ends a selection within the entry as though
825 * the user had just released the mouse button while making a selection.
826 *
827 * @param obj The entry object
828 *
829 * @ingroup Entry
830 */
831EAPI void elm_entry_cursor_selection_end(Evas_Object *obj);
832
833/**
834 * Gets whether a format node exists at the current cursor position.
835 *
836 * A format node is anything that defines how the text is rendered. It can
837 * be a visible format node, such as a line break or a paragraph separator,
838 * or an invisible one, such as bold begin or end tag.
839 * This function returns whether any format node exists at the current
840 * cursor position.
841 *
842 * @param obj The entry object
843 * @return EINA_TRUE if the current cursor position contains a format node,
844 * EINA_FALSE otherwise.
845 *
846 * @see elm_entry_cursor_is_visible_format_get()
847 *
848 * @ingroup Entry
849 */
850EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj);
851
852/**
853 * Gets if the current cursor position holds a visible format node.
854 *
855 * @param obj The entry object
856 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
857 * if it's an invisible one or no format exists.
858 *
859 * @see elm_entry_cursor_is_format_get()
860 *
861 * @ingroup Entry
862 */
863EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj);
864
865/**
866 * Gets the character pointed by the cursor at its current position.
867 *
868 * This function returns a string with the utf8 character stored at the
869 * current cursor position.
870 * Only the text is returned, any format that may exist will not be part
871 * of the return value. You must free the string when done with free().
872 *
873 * @param obj The entry object
874 * @return The text pointed by the cursors.
875 *
876 * @ingroup Entry
877 */
878EAPI char *elm_entry_cursor_content_get(const Evas_Object *obj);
879
880/**
881 * This function returns the geometry of the cursor.
882 *
883 * It's useful if you want to draw something on the cursor (or where it is),
884 * or for example in the case of scrolled entry where you want to show the
885 * cursor.
886 *
887 * @param obj The entry object
888 * @param x returned geometry
889 * @param y returned geometry
890 * @param w returned geometry
891 * @param h returned geometry
892 * @return EINA_TRUE upon success, EINA_FALSE upon failure
893 *
894 * @ingroup Entry
895 */
896EAPI Eina_Bool elm_entry_cursor_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
897
898/**
899 * Sets the cursor position in the entry to the given value
900 *
901 * The value in @p pos is the index of the character position within the
902 * contents of the string as returned by elm_entry_cursor_pos_get().
903 *
904 * @param obj The entry object
905 * @param pos The position of the cursor
906 *
907 * @ingroup Entry
908 */
909EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos);
910
911/**
912 * Retrieves the current position of the cursor in the entry
913 *
914 * @param obj The entry object
915 * @return The cursor position
916 *
917 * @ingroup Entry
918 */
919EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj);
920
921/**
922 * This executes a "cut" action on the selected text in the entry.
923 *
924 * @param obj The entry object
925 *
926 * @ingroup Entry
927 */
928EAPI void elm_entry_selection_cut(Evas_Object *obj);
929
930/**
931 * This executes a "copy" action on the selected text in the entry.
932 *
933 * @param obj The entry object
934 *
935 * @ingroup Entry
936 */
937EAPI void elm_entry_selection_copy(Evas_Object *obj);
938
939/**
940 * This executes a "paste" action in the entry.
941 *
942 * @param obj The entry object
943 *
944 * @ingroup Entry
945 */
946EAPI void elm_entry_selection_paste(Evas_Object *obj);
947
948/**
949 * This clears and frees the items in a entry's contextual (longpress)
950 * menu.
951 *
952 * @param obj The entry object
953 *
954 * @see elm_entry_context_menu_item_add()
955 *
956 * @ingroup Entry
957 */
958EAPI void elm_entry_context_menu_clear(Evas_Object *obj);
959
960/**
961 * This adds an item to the entry's contextual menu.
962 *
963 * A longpress on an entry will make the contextual menu show up, if this
964 * hasn't been disabled with elm_entry_context_menu_disabled_set().
965 * By default, this menu provides a few options like enabling selection mode,
966 * which is useful on embedded devices that need to be explicit about it,
967 * and when a selection exists it also shows the copy and cut actions.
968 *
969 * With this function, developers can add other options to this menu to
970 * perform any action they deem necessary.
971 *
972 * @param obj The entry object
973 * @param label The item's text label
974 * @param icon_file The item's icon file
975 * @param icon_type The item's icon type
976 * @param func The callback to execute when the item is clicked
977 * @param data The data to associate with the item for related functions
978 *
979 * @ingroup Entry
980 */
981EAPI 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);
982
983/**
984 * This disables the entry's contextual (longpress) menu.
985 *
986 * @param obj The entry object
987 * @param disabled If true, the menu is disabled
988 *
989 * @ingroup Entry
990 */
991EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled);
992
993/**
994 * This returns whether the entry's contextual (longpress) menu is
995 * disabled.
996 *
997 * @param obj The entry object
998 * @return If true, the menu is disabled
999 *
1000 * @ingroup Entry
1001 */
1002EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj);
1003
1004/**
1005 * This appends a custom item provider to the list for that entry
1006 *
1007 * This appends the given callback. The list is walked from beginning to end
1008 * with each function called given the item href string in the text. If the
1009 * function returns an object handle other than NULL (it should create an
1010 * object to do this), then this object is used to replace that item. If
1011 * not the next provider is called until one provides an item object, or the
1012 * default provider in entry does.
1013 *
1014 * @param obj The entry object
1015 * @param func The function called to provide the item object
1016 * @param data The data passed to @p func
1017 *
1018 * @see @ref entry-items
1019 *
1020 * @ingroup Entry
1021 */
1022EAPI void elm_entry_item_provider_append(Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data);
1023
1024/**
1025 * This prepends a custom item provider to the list for that entry
1026 *
1027 * This prepends the given callback. See elm_entry_item_provider_append() for
1028 * more information
1029 *
1030 * @param obj The entry object
1031 * @param func The function called to provide the item object
1032 * @param data The data passed to @p func
1033 *
1034 * @ingroup Entry
1035 */
1036EAPI void elm_entry_item_provider_prepend(Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data);
1037
1038/**
1039 * This removes a custom item provider to the list for that entry
1040 *
1041 * This removes the given callback. See elm_entry_item_provider_append() for
1042 * more information
1043 *
1044 * @param obj The entry object
1045 * @param func The function called to provide the item object
1046 * @param data The data passed to @p func
1047 *
1048 * @ingroup Entry
1049 */
1050EAPI void elm_entry_item_provider_remove(Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data);
1051
1052/**
1053 * Append a markup filter function for text inserted in the entry
1054 *
1055 * Append the given callback to the list. This functions will be called
1056 * whenever any text is inserted into the entry, with the text to be inserted
1057 * as a parameter. The type of given text is always markup.
1058 * The callback function is free to alter the text in any way it wants, but
1059 * it must remember to free the given pointer and update it.
1060 * If the new text is to be discarded, the function can free it and set its
1061 * text parameter to NULL. This will also prevent any following filters from
1062 * being called.
1063 *
1064 * @param obj The entry object
1065 * @param func The function to use as text filter
1066 * @param data User data to pass to @p func
1067 *
1068 * @ingroup Entry
1069 */
1070EAPI void elm_entry_markup_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
1071
1072/**
1073 * Prepend a markup filter function for text inserted in the entry
1074 *
1075 * Prepend the given callback to the list. See elm_entry_markup_filter_append()
1076 * for more information
1077 *
1078 * @param obj The entry object
1079 * @param func The function to use as text filter
1080 * @param data User data to pass to @p func
1081 *
1082 * @ingroup Entry
1083 */
1084EAPI void elm_entry_markup_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
1085
1086/**
1087 * Remove a markup filter from the list
1088 *
1089 * Removes the given callback from the filter list. See
1090 * elm_entry_markup_filter_append() for more information.
1091 *
1092 * @param obj The entry object
1093 * @param func The filter function to remove
1094 * @param data The user data passed when adding the function
1095 *
1096 * @ingroup Entry
1097 */
1098EAPI void elm_entry_markup_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
1099
1100/**
1101 * This converts a markup (HTML-like) string into UTF-8.
1102 *
1103 * The returned string is a malloc'ed buffer and it should be freed when
1104 * not needed anymore.
1105 *
1106 * @param s The string (in markup) to be converted
1107 * @return The converted string (in UTF-8). It should be freed.
1108 *
1109 * @ingroup Entry
1110 */
1111EAPI char *elm_entry_markup_to_utf8(const char *s);
1112
1113/**
1114 * This converts a UTF-8 string into markup (HTML-like).
1115 *
1116 * The returned string is a malloc'ed buffer and it should be freed when
1117 * not needed anymore.
1118 *
1119 * @param s The string (in UTF-8) to be converted
1120 * @return The converted string (in markup). It should be freed.
1121 *
1122 * @ingroup Entry
1123 */
1124EAPI char *elm_entry_utf8_to_markup(const char *s);
1125
1126/**
1127 * This sets the file (and implicitly loads it) for the text to display and
1128 * then edit. All changes are written back to the file after a short delay if
1129 * the entry object is set to autosave (which is the default).
1130 *
1131 * If the entry had any other file set previously, any changes made to it
1132 * will be saved if the autosave feature is enabled, otherwise, the file
1133 * will be silently discarded and any non-saved changes will be lost.
1134 *
1135 * @param obj The entry object
1136 * @param file The path to the file to load and save
1137 * @param format The file format
1138 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
1139 *
1140 * @ingroup Entry
1141 */
1142EAPI Eina_Bool elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format);
1143
1144/**
1145 * Gets the file being edited by the entry.
1146 *
1147 * This function can be used to retrieve any file set on the entry for
1148 * edition, along with the format used to load and save it.
1149 *
1150 * @param obj The entry object
1151 * @param file The path to the file to load and save
1152 * @param format The file format
1153 *
1154 * @ingroup Entry
1155 */
1156EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format);
1157
1158/**
1159 * This function writes any changes made to the file set with
1160 * elm_entry_file_set()
1161 *
1162 * @param obj The entry object
1163 *
1164 * @ingroup Entry
1165 */
1166EAPI void elm_entry_file_save(Evas_Object *obj);
1167
1168/**
1169 * This sets the entry object to 'autosave' the loaded text file or not.
1170 *
1171 * @param obj The entry object
1172 * @param autosave Autosave the loaded file or not
1173 *
1174 * @see elm_entry_file_set()
1175 *
1176 * @ingroup Entry
1177 */
1178EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave);
1179
1180/**
1181 * This gets the entry object's 'autosave' status.
1182 *
1183 * @param obj The entry object
1184 * @return Autosave the loaded file or not
1185 *
1186 * @see elm_entry_file_set()
1187 *
1188 * @ingroup Entry
1189 */
1190EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj);
1191
1192/**
1193 * Enable or disable scrolling in entry
1194 *
1195 * Normally the entry is not scrollable unless you enable it with this call.
1196 *
1197 * @param obj The entry object
1198 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
1199 *
1200 * @ingroup Entry
1201 */
1202EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
1203
1204/**
1205 * Get the scrollable state of the entry
1206 *
1207 * Normally the entry is not scrollable. This gets the scrollable state
1208 * of the entry. See elm_entry_scrollable_set() for more information.
1209 *
1210 * @param obj The entry object
1211 * @return The scrollable state
1212 *
1213 * @ingroup Entry
1214 */
1215EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
1216
1217/**
1218 * Sets the visibility of the left-side widget of the entry,
1219 * set by elm_object_part_content_set().
1220 *
1221 * @param obj The entry object
1222 * @param setting EINA_TRUE if the object should be displayed,
1223 * EINA_FALSE if not.
1224 *
1225 * @ingroup Entry
1226 */
1227EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
1228
1229/**
1230 * Sets the visibility of the end widget of the entry, set by
1231 * elm_object_part_content_set(ent, "end", content).
1232 *
1233 * @param obj The entry object
1234 * @param setting EINA_TRUE if the object should be displayed,
1235 * EINA_FALSE if not.
1236 *
1237 * @ingroup Entry
1238 */
1239EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
1240
1241/**
1242 * This sets the entry's scrollbar policy (i.e. enabling/disabling
1243 * them).
1244 *
1245 * Setting an entry to single-line mode with elm_entry_single_line_set()
1246 * will automatically disable the display of scrollbars when the entry
1247 * moves inside its scroller.
1248 *
1249 * @param obj The entry object
1250 * @param h The horizontal scrollbar policy to apply
1251 * @param v The vertical scrollbar policy to apply
1252 *
1253 * @ingroup Entry
1254 */
1255EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
1256
1257/**
1258 * This enables/disables bouncing within the entry.
1259 *
1260 * This function sets whether the entry will bounce when scrolling reaches
1261 * the end of the contained entry.
1262 *
1263 * @param obj The entry object
1264 * @param h_bounce The horizontal bounce state
1265 * @param v_bounce The vertical bounce state
1266 *
1267 * @ingroup Entry
1268 */
1269EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
1270
1271/**
1272 * Get the bounce mode
1273 *
1274 * @param obj The Entry object
1275 * @param h_bounce Allow bounce horizontally
1276 * @param v_bounce Allow bounce vertically
1277 *
1278 * @ingroup Entry
1279 */
1280EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
1281
1282/**
1283 * Set the input panel layout of the entry
1284 *
1285 * @param obj The entry object
1286 * @param layout layout type
1287 *
1288 * @ingroup Entry
1289 */
1290EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
1291
1292/**
1293 * Get the input panel layout of the entry
1294 *
1295 * @param obj The entry object
1296 * @return layout type
1297 *
1298 * @see elm_entry_input_panel_layout_set
1299 *
1300 * @ingroup Entry
1301 */
1302EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(const Evas_Object *obj);
1303
1304/**
1305 * Set the autocapitalization type on the immodule.
1306 *
1307 * @param obj The entry object
1308 * @param autocapital_type The type of autocapitalization
1309 *
1310 * @ingroup Entry
1311 */
1312EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type);
1313
1314/**
1315 * Retrieve the autocapitalization type on the immodule.
1316 *
1317 * @param obj The entry object
1318 * @return autocapitalization type
1319 *
1320 * @ingroup Entry
1321 */
1322EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(const Evas_Object *obj);
1323
1324/**
1325 * Sets the attribute to show the input panel automatically.
1326 *
1327 * @param obj The entry object
1328 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
1329 *
1330 * @ingroup Entry
1331 */
1332EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
1333
1334/**
1335 * Retrieve the attribute to show the input panel automatically.
1336 *
1337 * @param obj The entry object
1338 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
1339 *
1340 * @ingroup Entry
1341 */
1342EAPI Eina_Bool elm_entry_input_panel_enabled_get(const Evas_Object *obj);
1343
1344/**
1345 * Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
1346 *
1347 * Note that input panel is shown or hidden automatically according to the focus state of entry widget.
1348 * This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE).
1349 *
1350 * @param obj The entry object
1351 *
1352 * @ingroup Entry
1353 */
1354EAPI void elm_entry_input_panel_show(Evas_Object *obj);
1355
1356/**
1357 * Hide the input panel (virtual keyboard).
1358 *
1359 * Note that input panel is shown or hidden automatically according to the focus state of entry widget.
1360 * This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE)
1361 *
1362 * @param obj The entry object
1363 *
1364 * @ingroup Entry
1365 */
1366EAPI void elm_entry_input_panel_hide(Evas_Object *obj);
1367
1368/**
1369 * Set the language mode of the input panel.
1370 *
1371 * This API can be used if you want to show the alphabet keyboard mode.
1372 *
1373 * @param obj The entry object
1374 * @param lang language to be set to the input panel.
1375 *
1376 * @ingroup Entry
1377 */
1378EAPI void elm_entry_input_panel_language_set(Evas_Object *obj, Elm_Input_Panel_Lang lang);
1379
1380/**
1381 * Get the language mode of the input panel.
1382 *
1383 * See @ref elm_entry_input_panel_language_set for more details.
1384 *
1385 * @param obj The entry object
1386 * @return input panel language type
1387 *
1388 * @ingroup Entry
1389 */
1390EAPI Elm_Input_Panel_Lang elm_entry_input_panel_language_get(const Evas_Object *obj);
1391
1392/**
1393 * Set the input panel-specific data to deliver to the input panel.
1394 *
1395 * This API is used by applications to deliver specific data to the input panel.
1396 * The data format MUST be negotiated by both application and the input panel.
1397 * The size and format of data are defined by the input panel.
1398 *
1399 * @param obj The entry object
1400 * @param data The specific data to be set to the input panel.
1401 * @param len the length of data, in bytes, to send to the input panel
1402 *
1403 * @ingroup Entry
1404 */
1405EAPI void elm_entry_input_panel_imdata_set(Evas_Object *obj, const void *data, int len);
1406
1407/**
1408 * Get the specific data of the current input panel.
1409 *
1410 * See @ref elm_entry_input_panel_imdata_set for more details.
1411 *
1412 * @param obj The entry object
1413 * @param data The specific data to be got from the input panel
1414 * @param len The length of data
1415 *
1416 * @ingroup Entry
1417 */
1418EAPI void elm_entry_input_panel_imdata_get(const Evas_Object *obj, void *data, int *len);
1419
1420/**
1421 * Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
1422 *
1423 * An input panel displays the string or icon associated with this type
1424 *
1425 * @param obj The entry object
1426 * @param return_key_type The type of "return" key on the input panel
1427 *
1428 * @ingroup Entry
1429 */
1430EAPI void elm_entry_input_panel_return_key_type_set(Evas_Object *obj, Elm_Input_Panel_Return_Key_Type return_key_type);
1431
1432/**
1433 * Get the "return" key type.
1434 *
1435 * @see elm_entry_input_panel_return_key_type_set() for more details
1436 *
1437 * @param obj The entry object
1438 * @return The type of "return" key on the input panel
1439 *
1440 * @ingroup Entry
1441 */
1442EAPI Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get(const Evas_Object *obj);
1443
1444/**
1445 * Set the return key on the input panel to be disabled.
1446 *
1447 * @param obj The entry object
1448 * @param disabled The state to put in in: @c EINA_TRUE for
1449 * disabled, @c EINA_FALSE for enabled
1450 *
1451 * @ingroup Entry
1452 */
1453EAPI void elm_entry_input_panel_return_key_disabled_set(Evas_Object *obj, Eina_Bool disabled);
1454
1455/**
1456 * Get whether the return key on the input panel should be disabled or not.
1457 *
1458 * @param obj The entry object
1459 * @return EINA_TRUE if it should be disabled
1460 *
1461 * @ingroup Entry
1462 */
1463EAPI Eina_Bool elm_entry_input_panel_return_key_disabled_get(const Evas_Object *obj);
1464
1465/**
1466 * Set whether the return key on the input panel is disabled automatically when entry has no text.
1467 *
1468 * If @p enabled is EINA_TRUE, The return key on input panel is disabled when the entry has no text.
1469 * The return key on the input panel is automatically enabled when the entry has text.
1470 * The default value is EINA_FALSE.
1471 *
1472 * @param obj The entry object
1473 * @param enabled If @p enabled is EINA_TRUE, the return key is automatically disabled when the entry has no text.
1474 *
1475 * @ingroup Entry
1476 */
1477EAPI void elm_entry_input_panel_return_key_autoenabled_set(Evas_Object *obj, Eina_Bool enabled);
1478
1479/**
1480 * Reset the input method context of the entry if needed.
1481 *
1482 * This can be necessary in the case where modifying the buffer would confuse on-going input method behavior
1483 * @param obj The entry object
1484 *
1485 * @ingroup Entry
1486 */
1487EAPI void elm_entry_imf_context_reset(Evas_Object *obj);
1488
1489/**
1490 * Set whether the entry should allow to use the text prediction.
1491 *
1492 * @param obj The entry object
1493 * @param prediction Whether the entry should allow to use the text prediction.
1494 *
1495 * @ingroup Entry
1496 */
1497EAPI void elm_entry_prediction_allow_set(Evas_Object *obj, Eina_Bool prediction);
1498
1499/**
1500 * Get whether the entry should allow to use the text prediction.
1501 *
1502 * @param obj The entry object
1503 * @return EINA_TRUE if it allows to use the text prediction, otherwise EINA_FALSE.
1504 *
1505 * @ingroup Entry
1506 */
1507EAPI Eina_Bool elm_entry_prediction_allow_get(const Evas_Object *obj);
1508
1509/* pre-made filters for entries */
1510
1511/**
1512 * @typedef Elm_Entry_Filter_Limit_Size
1513 *
1514 * Data for the elm_entry_filter_limit_size() entry filter.
1515 */
1516typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
1517
1518/**
1519 * @struct _Elm_Entry_Filter_Limit_Size
1520 *
1521 * Data for the elm_entry_filter_limit_size() entry filter.
1522 */
1523struct _Elm_Entry_Filter_Limit_Size
1524{
1525 int max_char_count; /**< The maximum number of characters allowed. */
1526 int max_byte_count; /**< The maximum number of bytes allowed*/
1527};
1528
1529/**
1530 * Filter inserted text based on user defined character and byte limits
1531 *
1532 * Add this filter to an entry to limit the characters that it will accept
1533 * based the contents of the provided #Elm_Entry_Filter_Limit_Size.
1534 * The function works on the UTF-8 representation of the string, converting
1535 * it from the set markup, thus not accounting for any format in it.
1536 *
1537 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
1538 * it as data when setting the filter. In it, it's possible to set limits
1539 * by character count or bytes (any of them is disabled if 0), and both can
1540 * be set at the same time. In that case, it first checks for characters,
1541 * then bytes. The #Elm_Entry_Filter_Limit_Size structure must be alive and
1542 * valid for as long as the entry is alive AND the elm_entry_filter_limit_size
1543 * filter is set.
1544 *
1545 * The function will cut the inserted text in order to allow only the first
1546 * number of characters that are still allowed. The cut is made in
1547 * characters, even when limiting by bytes, in order to always contain
1548 * valid ones and avoid half unicode characters making it in.
1549 *
1550 * This filter, like any others, does not apply when setting the entry text
1551 * directly with elm_object_text_set().
1552 *
1553 * @ingroup Entry
1554 */
1555EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text);
1556
1557/**
1558 * @typedef Elm_Entry_Filter_Accept_Set
1559 *
1560 * Data for the elm_entry_filter_accept_set() entry filter.
1561 */
1562typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
1563
1564/**
1565 * @struct _Elm_Entry_Filter_Accept_Set
1566 *
1567 * Data for the elm_entry_filter_accept_set() entry filter.
1568 */
1569struct _Elm_Entry_Filter_Accept_Set
1570{
1571 const char *accepted; /**< Set of characters accepted in the entry. */
1572 const char *rejected; /**< Set of characters rejected from the entry. */
1573};
1574
1575/**
1576 * Filter inserted text based on accepted or rejected sets of characters
1577 *
1578 * Add this filter to an entry to restrict the set of accepted characters
1579 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
1580 * This structure contains both accepted and rejected sets, but they are
1581 * mutually exclusive. This structure must be available for as long as
1582 * the entry is alive AND the elm_entry_filter_accept_set is being used.
1583 *
1584 * The @c accepted set takes preference, so if it is set, the filter will
1585 * only work based on the accepted characters, ignoring anything in the
1586 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
1587 *
1588 * In both cases, the function filters by matching utf8 characters to the
1589 * raw markup text, so it can be used to remove formatting tags.
1590 *
1591 * This filter, like any others, does not apply when setting the entry text
1592 * directly with elm_object_text_set()
1593 *
1594 * @ingroup Entry
1595 */
1596EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text);
1597
1598/**
1599 * Returns the input method context of the entry.
1600 *
1601 * This function exposes the internal input method context.
1602 *
1603 * IMPORTANT: Many functions may change (i.e delete and create a new one)
1604 * the internal input method context. Do NOT cache the returned object.
1605 *
1606 * @param obj The entry object
1607 * @return The input method context (Ecore_IMF_Context *) in entry.
1608 *
1609 * @ingroup Entry
1610 */
1611EAPI void *elm_entry_imf_context_get(Evas_Object *obj);
1612
1613/**
1614 * @typedef Elm_Cnp_Mode
1615 * Enum of entry's copy & paste policy.
1616 *
1617 * @see elm_entry_cnp_mode_set()
1618 * @see elm_entry_cnp_mode_get()
1619 */
1620typedef enum {
1621 ELM_CNP_MODE_MARKUP, /**< copy & paste text with markup tag */
1622 ELM_CNP_MODE_NO_IMAGE, /**< copy & paste text without item(image) tag */
1623 ELM_CNP_MODE_PLAINTEXT /**< copy & paste text without markup tag */
1624} Elm_Cnp_Mode;
1625
1626/**
1627 * Control pasting of text and images for the widget.
1628 *
1629 * Normally the entry allows both text and images to be pasted.
1630 * By setting cnp_mode to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
1631 * By setting cnp_mode to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
1632 *
1633 * @note this only changes the behaviour of text.
1634 *
1635 * @param obj The entry object
1636 * @param cnp_mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP,
1637 * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
1638 *
1639 * @ingroup Entry
1640 */
1641EAPI void elm_entry_cnp_mode_set(Evas_Object *obj, Elm_Cnp_Mode cnp_mode);
1642
1643/**
1644 * Getting elm_entry text paste/drop mode.
1645 *
1646 * Normally the entry allows both text and images to be pasted.
1647 * This gets the copy & paste mode of the entry.
1648 *
1649 * @param obj The entry object
1650 * @return mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP,
1651 * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
1652 *
1653 * @ingroup Entry
1654 */
1655EAPI Elm_Cnp_Mode elm_entry_cnp_mode_get(const Evas_Object *obj);
1656
1657/**
1658 * Set the parent of the hover popup
1659 *
1660 * Sets the parent object to use by the hover created by the entry
1661 * when an anchor is clicked. See @ref Hover for more details on this.
1662 *
1663 * @param obj The entry object
1664 * @param parent The object to use as parent for the hover
1665 *
1666 * @ingroup Entry
1667 */
1668EAPI void elm_entry_anchor_hover_parent_set(Evas_Object *obj, Evas_Object *parent);
1669
1670/**
1671 * Get the parent of the hover popup
1672 *
1673 * Get the object used as parent for the hover created by the entry
1674 * widget. See @ref Hover for more details on this.
1675 * If no parent is set, the same entry object will be used.
1676 *
1677 * @param obj The entry object
1678 * @return The object used as parent for the hover, NULL if none is set.
1679 *
1680 * @ingroup Entry
1681 */
1682EAPI Evas_Object *elm_entry_anchor_hover_parent_get(const Evas_Object *obj);
1683
1684/**
1685 * Set the style that the hover should use
1686 *
1687 * When creating the popup hover, entry will request that it's
1688 * themed according to @p style.
1689 *
1690 * Setting style no NULL means disabling automatic hover.
1691 *
1692 * @param obj The entry object
1693 * @param style The style to use for the underlying hover
1694 *
1695 * @see elm_object_style_set()
1696 *
1697 * @ingroup Entry
1698 */
1699EAPI void elm_entry_anchor_hover_style_set(Evas_Object *obj, const char *style);
1700
1701/**
1702 * Get the style that the hover should use
1703 *
1704 * Get the style, the hover created by entry will use.
1705 *
1706 * @param obj The entry object
1707 * @return The style to use by the hover. NULL means the default is used.
1708 *
1709 * @see elm_object_style_set()
1710 *
1711 * @ingroup Entry
1712 */
1713EAPI const char *elm_entry_anchor_hover_style_get(const Evas_Object *obj);
1714
1715/**
1716 * Ends the hover popup in the entry
1717 *
1718 * When an anchor is clicked, the entry widget will create a hover
1719 * object to use as a popup with user provided content. This function
1720 * terminates this popup, returning the entry to its normal state.
1721 *
1722 * @param obj The entry object
1723 *
1724 * @ingroup Entry
1725 */
1726EAPI void elm_entry_anchor_hover_end(Evas_Object *obj);
1727
1728/**
1729 * @}
1730 */
generated by cgit v1.1 at 2024-11-10 05:50:30 +0000