-typedef enum
-{
- ELM_TEXT_FORMAT_PLAIN_UTF8,
- ELM_TEXT_FORMAT_MARKUP_UTF8
-} Elm_Text_Format;
-
-/**
- * Line wrapping types.
- */
-typedef enum
-{
- ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
- ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
- ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
- ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
- ELM_WRAP_LAST
-} Elm_Wrap_Type; /**< Type of word or character wrapping to use */
-
-typedef enum
-{
- ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
- ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
- ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
- ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
- ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
- ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
- ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
- ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
- ELM_INPUT_PANEL_LAYOUT_INVALID // XXX: remove this so we can expand
-} Elm_Input_Panel_Layout; /**< Type of input panel (virtual keyboard) to use */
-
-typedef enum
-{
- ELM_AUTOCAPITAL_TYPE_NONE, /**< No auto-capitalization when typing */
- ELM_AUTOCAPITAL_TYPE_WORD, /**< Autocapitalize each word typed */
- ELM_AUTOCAPITAL_TYPE_SENTENCE, /**< Autocapitalize the start of each sentence */
- ELM_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters */
-} Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
-
/**
* @defgroup Entry Entry
+ * @ingroup Elementary
*
* @image html img/widget/entry/preview-00.png
* @image latex img/widget/entry/preview-00.eps width=\textwidth
*
* An entry is a convenience widget which shows a box that the user can
* enter text into. Entries by default don't scroll, so they grow to
- * accomodate the entire text, resizing the parent window as needed. This
+ * accommodate the entire text, resizing the parent window as needed. This
* can be changed with the elm_entry_scrollable_set() function.
*
* They can also be single line or multi line (the default) and when set
* to multi line mode they support text wrapping in any of the modes
- * indicated by Elm_Wrap_Type.
+ * indicated by #Elm_Wrap_Type.
*
* Other features include password mode, filtering of inserted text with
- * elm_entry_text_filter_append() and related functions, inline "items" and
+ * elm_entry_markup_filter_append() and related functions, inline "items" and
* formatted markup text.
*
* @section entry-markup Formatted text
* enclosed text.
* @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
* @li \<link\>...\</link\>: Underlines the enclosed text.
- * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
+ * @li \<hilight\>...\</hilight\>: Highlights the enclosed text.
*
* @section entry-special Special markups
*
* Besides those used to format text, entries support two special markup
- * tags used to insert clickable portions of text or items inlined within
+ * tags used to insert click-able portions of text or items inlined within
* the text.
*
* @subsection entry-anchors Anchors
* @li relsize: Size is adjusted for the item to fit within the current
* line height.
*
- * Besides their size, items are specificed a @c vsize value that affects
+ * Besides their size, items are specified a @c vsize value that affects
* how their final size and position are calculated. The possible values
* are:
* @li ascent: Item will be placed within the line's baseline and its
*
* @section entry-files Loading and saving files
*
- * Entries have convinience functions to load text from a file and save
+ * Entries have convenience functions to load text from a file and save
* changes back to it after a short delay. The automatic saving is enabled
* by default, but can be disabled with elm_entry_autosave_set() and files
* can be loaded directly as plain text or have any markup in them
* @li "preedit,changed": The preedit string has changed.
* @li "language,changed": Program language changed.
*
+ * Default content parts of the entry items that you can use for are:
+ * @li "icon" - An icon in the entry
+ * @li "end" - A content in the end of the entry
+ *
+ * Default text parts of the entry that you can use for are:
+ * @li "default" - text of the entry
+ *
+ * Supported elm_object common APIs.
+ * @li @ref elm_object_signal_emit
+ * @li @ref elm_object_part_text_set
+ * @li @ref elm_object_part_text_get
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
+ * @li @ref elm_object_signal_callback_add
+ * @li @ref elm_object_signal_callback_del
+ * @li @ref elm_object_disabled_set
+ * @li @ref elm_object_disabled_get
+ *
* @section entry-examples
*
- * An overview of the Entry API can be seen in @ref entry_example_01
+ * An overview of the Entry API can be seen in @ref entry_example
*
* @{
*/
/**
+ * @typedef Elm_Text_Format
+ *
+ * Text Format types.
+ *
+ * @see elm_entry_file_set()
+ */
+typedef enum
+{
+ ELM_TEXT_FORMAT_PLAIN_UTF8, /**< Plain UTF8 type */
+ ELM_TEXT_FORMAT_MARKUP_UTF8 /**< Markup UTF8 type */
+} Elm_Text_Format;
+
+/**
+ * @typedef Elm_Wrap_Type
+ *
+ * Line wrapping types.
+ *
+ * @see elm_entry_line_wrap_set()
+ */
+typedef enum
+{
+ ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
+ ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
+ ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
+ ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
+ ELM_WRAP_LAST
+} Elm_Wrap_Type; /**< Type of word or character wrapping to use */
+
+/**
+ * @typedef Elm_Input_Panel_Layout
+ *
+ * Input panel (virtual keyboard) layout types.
+ *
+ * @see elm_entry_input_panel_layout_set()
+ */
+typedef enum
+{
+ ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
+ ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
+ ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
+ ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
+ ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
+ ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
+ ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
+ ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
+ ELM_INPUT_PANEL_LAYOUT_INVALID, /**< Never use this */
+ ELM_INPUT_PANEL_LAYOUT_HEX, /**< Hexadecimal layout */
+ ELM_INPUT_PANEL_LAYOUT_TERMINAL, /**< Command-line terminal layout */
+ ELM_INPUT_PANEL_LAYOUT_PASSWORD /**< Like normal, but no auto-correct, no auto-capitalization etc. */
+} Elm_Input_Panel_Layout; /**< Type of input panel (virtual keyboard) to use - this is a hint and may not provide exactly what is desired. */
+
+/**
+ * @typedef Elm_Input_Panel_Lang
+ *
+ * Input panel (virtual keyboard) language modes.
+ *
+ * @see elm_entry_input_panel_language_set()
+ */
+typedef enum
+{
+ ELM_INPUT_PANEL_LANG_AUTOMATIC, /**< Automatic */
+ ELM_INPUT_PANEL_LANG_ALPHABET /**< Alphabet */
+} Elm_Input_Panel_Lang;
+
+/**
+ * @typedef Elm_Autocapital_Type
+ *
+ * Autocapitalization Types.
+ *
+ * @see elm_entry_autocapital_type_set()
+ */
+typedef enum
+{
+ ELM_AUTOCAPITAL_TYPE_NONE, /**< No auto-capitalization when typing */
+ ELM_AUTOCAPITAL_TYPE_WORD, /**< Autocapitalize each word typed */
+ ELM_AUTOCAPITAL_TYPE_SENTENCE, /**< Autocapitalize the start of each sentence */
+ ELM_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters */
+} Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
+
+/**
+ * @typedef Elm_Input_Panel_Return_Key_Type
+ *
+ * "Return" Key types on the input panel (virtual keyboard).
+ *
+ * @see elm_entry_input_panel_return_key_type_set()
+ */
+typedef enum
+{
+ ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT, /**< Default */
+ ELM_INPUT_PANEL_RETURN_KEY_TYPE_DONE, /**< Done */
+ ELM_INPUT_PANEL_RETURN_KEY_TYPE_GO, /**< Go */
+ ELM_INPUT_PANEL_RETURN_KEY_TYPE_JOIN, /**< Join */
+ ELM_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN, /**< Login */
+ ELM_INPUT_PANEL_RETURN_KEY_TYPE_NEXT, /**< Next */
+ ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH, /**< Search string or magnifier icon */
+ ELM_INPUT_PANEL_RETURN_KEY_TYPE_SEND /**< Send */
+} Elm_Input_Panel_Return_Key_Type;
+
+/**
* @typedef Elm_Entry_Anchor_Info
*
* The info sent in the callback for the "anchor,clicked" signals emitted
};
/**
+ * @typedef Elm_Entry_Anchor_Hover_Info
+ *
+ * The info sent in the callback for "anchor,clicked" signals emitted by
+ * the Anchor_Hover widget.
+ */
+typedef struct _Elm_Entry_Anchor_Hover_Info Elm_Entry_Anchor_Hover_Info;
+
+/**
+ * @struct _Elm_Entry_Anchor_Hover_Info
+ *
+ * The info sent in the callback for "anchor,clicked" signals emitted by
+ * the Anchor_Hover widget.
+ */
+struct _Elm_Entry_Anchor_Hover_Info
+{
+ const Elm_Entry_Anchor_Info *anchor_info; /**< The actual anchor info. */
+ Evas_Object *hover; /**< The hover object to use for the popup */
+ struct
+ {
+ Evas_Coord x, y, w, h;
+ } hover_parent; /**< Geometry of the object used as parent by the
+ hover */
+ Eina_Bool hover_left : 1; /**< Hint indicating if there's space
+ for content on the left side of
+ the hover. Before calling the
+ callback, the widget will make the
+ necessary calculations to check
+ which sides are fit to be set with
+ content, based on the position the
+ hover is activated and its distance
+ to the edges of its parent object
+ */
+ Eina_Bool hover_right : 1; /**< Hint indicating content fits on
+ the right side of the hover.
+ See @ref hover_left */
+ Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
+ of the hover. See @ref hover_left */
+ Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
+ below the hover. See @ref
+ hover_left */
+};
+
+/**
+ * @typedef Elm_Entry_Item_Provider_Cb
+ * This callback type is used to provide items.
+ * If it returns an object handle other than NULL (it should create an
+ * object to do this), then this object is used to replace the current item.
+ * If not the next provider is called until one provides an item object, or the
+ * default provider in entry does.
+ * @param data The data specified as the last param when adding the provider
+ * @param entry The entry object
+ * @param text A pointer to the item href string in the text
+ * @return The object to be placed in the entry like an icon, or other element
+ * @see elm_entry_item_provider_append
+ * @see elm_entry_item_provider_prepend
+ * @see elm_entry_item_provider_remove
+ */
+typedef Evas_Object * (*Elm_Entry_Item_Provider_Cb)(void *data, Evas_Object * entry, const char *item);
+
+/**
* @typedef Elm_Entry_Filter_Cb
* This callback type is used by entry filters to modify text.
* @param data The data specified as the last param when adding the filter
* @param entry The entry object
- * @param text A pointer to the location of the text being filtered. This data can be modified,
- * but any additional allocations must be managed by the user.
- * @see elm_entry_text_filter_append
- * @see elm_entry_text_filter_prepend
+ * @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.
+ * @see elm_entry_markup_filter_append
+ * @see elm_entry_markup_filter_prepend
+ * @see elm_entry_markup_filter_remove
*/
typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Entry
+ */
+EAPI Evas_Object *elm_entry_add(Evas_Object *parent);
+
+/**
+ * Push the style to the top of user style stack.
+ * If there is styles in the user style stack, the properties in the top style
+ * of user style stack will replace the properties in current theme.
+ * The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold').
+ *
+ * @param obj The entry object
+ * @param style The style user to push
+ */
+EAPI void elm_entry_text_style_user_push(Evas_Object *obj, const char *style);
+
+/**
+ * Remove the style in the top of user style stack.
+ *
+ * @param obj The entry object
+ *
+ * @see elm_entry_text_style_user_push()
+ */
+EAPI void elm_entry_text_style_user_pop(Evas_Object *obj);
+
+/**
+ * Retrieve the style on the top of user style stack.
+ *
+ * @param obj The entry object
+ * @return style on the top of user style stack if exist, otherwise NULL.
+ *
+ * @see elm_entry_text_style_user_push()
*/
-EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+EAPI const char* elm_entry_text_style_user_peek(const Evas_Object *obj);
/**
* Sets the entry to single line mode.
* @param obj The entry object
* @param single_line If true, the text in the entry
* will be on a single line.
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
/**
* Gets whether the entry is set to be single line.
* on a single line.
*
* @see elm_entry_single_line_set()
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj);
/**
* Sets the entry to password mode.
*
* @param obj The entry object
* @param password If true, password mode is enabled.
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password);
/**
* Gets whether the entry is set to password mode.
* as asterisks (*).
*
* @see elm_entry_password_set()
+ *
+ * @ingroup Entry
+ */
+EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj);
+
+/**
+ * This sets the text displayed within the entry to @p entry.
+ *
+ * @param obj The entry object
+ * @param entry The text to be displayed
+ *
+ * @note Using this function bypasses text filters
+ *
+ * @ingroup Entry
+ */
+EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry);
+
+/**
+ * This returns the text currently shown in object @p entry.
+ * See also elm_entry_entry_set().
+ *
+ * @param obj The entry object
+ * @return The currently displayed text or NULL on failure
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI const char *elm_entry_entry_get(const Evas_Object *obj);
/**
* Appends @p entry to the text of the entry.
* @param obj The entry object
* @param entry The text to be displayed
*
- * @see elm_entry_text_filter_append()
+ * @see elm_entry_markup_filter_append()
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry);
/**
* Gets whether the entry is empty.
*
* @param obj The entry object
* @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj);
/**
* Gets any selected text within the entry.
*
* @param obj The entry object
* @return The selected text within the entry or NULL on failure
+ *
+ * @ingroup Entry
*/
-EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI const char *elm_entry_selection_get(const Evas_Object *obj);
/**
* Returns the actual textblock object of the entry.
*
* @param obj The entry object
* @return The textblock object.
+ *
+ * @ingroup Entry
*/
-EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Object * elm_entry_textblock_get(Evas_Object *obj);
/**
* Forces calculation of the entry size and text layouting.
* @param obj The entry object
*
* @see elm_entry_textblock_get()
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_calc_force(Evas_Object *obj);
/**
* Inserts the given text into the entry at the current cursor position.
* @param obj The entry object
* @param entry The text to insert
*
- * @see elm_entry_text_filter_append()
+ * @see elm_entry_markup_filter_append()
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry);
/**
* Set the line wrap type to use on multi-line entries.
* @param obj The entry object
* @param wrap The wrap mode to use. See Elm_Wrap_Type for details on them
*/
-EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap);
/**
* Gets the wrap mode the entry was set to use.
* @return Wrap type
*
* @see also elm_entry_line_wrap_set()
+ *
+ * @ingroup Entry
*/
-EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj);
/**
* Sets if the entry is to be editable or not.
* @param obj The entry object
* @param editable If EINA_TRUE, user input will be inserted in the entry,
* if not, the entry is read-only and no user input is allowed.
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable);
/**
* Gets whether the entry is editable or not.
* If false, it is not editable by the user
*
* @see elm_entry_editable_set()
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj);
/**
* This drops any existing text selection within the entry.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_select_none(Evas_Object *obj);
/**
* This selects all text within the entry.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_select_all(Evas_Object *obj);
/**
* This moves the cursor one place to the right within the entry.
*
* @param obj The entry object
* @return EINA_TRUE upon success, EINA_FALSE upon failure
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj);
/**
* This moves the cursor one place to the left within the entry.
*
* @param obj The entry object
* @return EINA_TRUE upon success, EINA_FALSE upon failure
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj);
/**
* This moves the cursor one line up within the entry.
*
* @param obj The entry object
* @return EINA_TRUE upon success, EINA_FALSE upon failure
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj);
/**
* This moves the cursor one line down within the entry.
*
* @param obj The entry object
* @return EINA_TRUE upon success, EINA_FALSE upon failure
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj);
/**
* This moves the cursor to the beginning of the entry.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_cursor_begin_set(Evas_Object *obj);
/**
* This moves the cursor to the end of the entry.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_cursor_end_set(Evas_Object *obj);
/**
* This moves the cursor to the beginning of the current line.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj);
/**
* This moves the cursor to the end of the current line.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj);
/**
* This begins a selection within the entry as though
* the user were holding down the mouse button to make a selection.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj);
/**
* This ends a selection within the entry as though
* the user had just released the mouse button while making a selection.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_cursor_selection_end(Evas_Object *obj);
/**
* Gets whether a format node exists at the current cursor position.
* EINA_FALSE otherwise.
*
* @see elm_entry_cursor_is_visible_format_get()
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj);
/**
* Gets if the current cursor position holds a visible format node.
* if it's an invisible one or no format exists.
*
* @see elm_entry_cursor_is_format_get()
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj);
/**
* Gets the character pointed by the cursor at its current position.
* This function returns a string with the utf8 character stored at the
* current cursor position.
* Only the text is returned, any format that may exist will not be part
- * of the return value.
+ * of the return value. You must free the string when done with free().
*
* @param obj The entry object
* @return The text pointed by the cursors.
+ *
+ * @ingroup Entry
*/
-EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI char *elm_entry_cursor_content_get(const Evas_Object *obj);
/**
* This function returns the geometry of the cursor.
* @param w returned geometry
* @param h returned geometry
* @return EINA_TRUE upon success, EINA_FALSE upon failure
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_cursor_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_cursor_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
/**
* Sets the cursor position in the entry to the given value
*
* @param obj The entry object
* @param pos The position of the cursor
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos);
/**
* Retrieves the current position of the cursor in the entry
*
* @param obj The entry object
* @return The cursor position
+ *
+ * @ingroup Entry
*/
-EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj);
/**
* This executes a "cut" action on the selected text in the entry.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_selection_cut(Evas_Object *obj);
/**
* This executes a "copy" action on the selected text in the entry.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_selection_copy(Evas_Object *obj);
/**
* This executes a "paste" action in the entry.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_selection_paste(Evas_Object *obj);
/**
* This clears and frees the items in a entry's contextual (longpress)
* @param obj The entry object
*
* @see elm_entry_context_menu_item_add()
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_context_menu_clear(Evas_Object *obj);
/**
* This adds an item to the entry's contextual menu.
* @param icon_type The item's icon type
* @param func The callback to execute when the item is clicked
* @param data The data to associate with the item for related functions
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_context_menu_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
+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);
/**
* This disables the entry's contextual (longpress) menu.
*
* @param obj The entry object
* @param disabled If true, the menu is disabled
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled);
/**
* This returns whether the entry's contextual (longpress) menu is
*
* @param obj The entry object
* @return If true, the menu is disabled
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj);
/**
* This appends a custom item provider to the list for that entry
* @param data The data passed to @p func
*
* @see @ref entry-items
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_item_provider_append(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+EAPI void elm_entry_item_provider_append(Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data);
/**
* This prepends a custom item provider to the list for that entry
* @param obj The entry object
* @param func The function called to provide the item object
* @param data The data passed to @p func
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_item_provider_prepend(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+EAPI void elm_entry_item_provider_prepend(Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data);
/**
* This removes a custom item provider to the list for that entry
* @param obj The entry object
* @param func The function called to provide the item object
* @param data The data passed to @p func
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_item_provider_remove(Evas_Object *obj, Evas_Object * (*func)(void *data, Evas_Object * entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
+EAPI void elm_entry_item_provider_remove(Evas_Object *obj, Elm_Entry_Item_Provider_Cb func, void *data);
/**
- * Append a filter function for text inserted in the entry
+ * Append a markup filter function for text inserted in the entry
*
* Append the given callback to the list. This functions will be called
* whenever any text is inserted into the entry, with the text to be inserted
- * as a parameter. The callback function is free to alter the text in any way
- * it wants, but it must remember to free the given pointer and update it.
+ * as a parameter. The type of given text is always markup.
+ * The callback function is free to alter the text in any way it wants, but
+ * it must remember to free the given pointer and update it.
* If the new text is to be discarded, the function can free it and set its
* text parameter to NULL. This will also prevent any following filters from
* being called.
* @param obj The entry object
* @param func The function to use as text filter
* @param data User data to pass to @p func
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+EAPI void elm_entry_markup_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
/**
- * Prepend a filter function for text insdrted in the entry
+ * Prepend a markup filter function for text inserted in the entry
*
- * Prepend the given callback to the list. See elm_entry_text_filter_append()
+ * Prepend the given callback to the list. See elm_entry_markup_filter_append()
* for more information
*
* @param obj The entry object
* @param func The function to use as text filter
* @param data User data to pass to @p func
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+EAPI void elm_entry_markup_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
/**
- * Remove a filter from the list
+ * Remove a markup filter from the list
*
* Removes the given callback from the filter list. See
- * elm_entry_text_filter_append() for more information.
+ * elm_entry_markup_filter_append() for more information.
*
* @param obj The entry object
* @param func The filter function to remove
* @param data The user data passed when adding the function
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
+EAPI void elm_entry_markup_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
/**
* This converts a markup (HTML-like) string into UTF-8.
*
* @param s The string (in markup) to be converted
* @return The converted string (in UTF-8). It should be freed.
+ *
+ * @ingroup Entry
*/
-EAPI char *elm_entry_markup_to_utf8(const char *s)
-EINA_MALLOC EINA_WARN_UNUSED_RESULT;
+EAPI char *elm_entry_markup_to_utf8(const char *s);
/**
* This converts a UTF-8 string into markup (HTML-like).
*
* @param s The string (in UTF-8) to be converted
* @return The converted string (in markup). It should be freed.
+ *
+ * @ingroup Entry
*/
-EAPI char *elm_entry_utf8_to_markup(const char *s)
-EINA_MALLOC EINA_WARN_UNUSED_RESULT;
+EAPI char *elm_entry_utf8_to_markup(const char *s);
/**
* This sets the file (and implicitly loads it) for the text to display and
* @param obj The entry object
* @param file The path to the file to load and save
* @param format The file format
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format);
/**
* Gets the file being edited by the entry.
* @param obj The entry object
* @param file The path to the file to load and save
* @param format The file format
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format);
/**
* This function writes any changes made to the file set with
* elm_entry_file_set()
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_file_save(Evas_Object *obj);
/**
* This sets the entry object to 'autosave' the loaded text file or not.
* @param autosave Autosave the loaded file or not
*
* @see elm_entry_file_set()
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave);
/**
* This gets the entry object's 'autosave' status.
* @return Autosave the loaded file or not
*
* @see elm_entry_file_set()
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj);
/**
- * Control pasting of text and images for the widget.
+ * Enable or disable scrolling in entry
*
- * Normally the entry allows both text and images to be pasted. By setting
- * textonly to be true, this prevents images from being pasted.
+ * Normally the entry is not scrollable unless you enable it with this call.
+ *
+ * @param obj The entry object
+ * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
+ *
+ * @ingroup Entry
+ */
+EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
+
+/**
+ * Get the scrollable state of the entry
*
- * Note this only changes the behaviour of text.
+ * Normally the entry is not scrollable. This gets the scrollable state
+ * of the entry. See elm_entry_scrollable_set() for more information.
*
* @param obj The entry object
- * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
- * text+image+other.
+ * @return The scrollable state
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
/**
- * Getting elm_entry text paste/drop mode.
+ * Sets the visibility of the left-side widget of the entry,
+ * set by elm_object_part_content_set().
*
- * In textonly mode, only text may be pasted or dropped into the widget.
+ * @param obj The entry object
+ * @param setting EINA_TRUE if the object should be displayed,
+ * EINA_FALSE if not.
+ *
+ * @ingroup Entry
+ */
+EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
+
+/**
+ * Sets the visibility of the end widget of the entry, set by
+ * elm_object_part_content_set(ent, "end", content).
*
* @param obj The entry object
- * @return If the widget only accepts text from pastes.
+ * @param setting EINA_TRUE if the object should be displayed,
+ * EINA_FALSE if not.
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
/**
- * Enable or disable scrolling in entry
+ * This sets the entry's scrollbar policy (i.e. enabling/disabling
+ * them).
*
- * Normally the entry is not scrollable unless you enable it with this call.
+ * Setting an entry to single-line mode with elm_entry_single_line_set()
+ * will automatically disable the display of scrollbars when the entry
+ * moves inside its scroller.
*
* @param obj The entry object
- * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
+ * @param h The horizontal scrollbar policy to apply
+ * @param v The vertical scrollbar policy to apply
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
+EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
/**
- * Get the scrollable state of the entry
+ * This enables/disables bouncing within the entry.
*
- * Normally the entry is not scrollable. This gets the scrollable state
- * of the entry. See elm_entry_scrollable_set() for more information.
+ * This function sets whether the entry will bounce when scrolling reaches
+ * the end of the contained entry.
*
* @param obj The entry object
- * @return The scrollable state
+ * @param h_bounce The horizontal bounce state
+ * @param v_bounce The vertical bounce state
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
+EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
/**
- * This sets a widget to be displayed to the left of a scrolled entry.
+ * Get the bounce mode
*
- * @param obj The scrolled entry object
- * @param icon The widget to display on the left side of the scrolled
- * entry.
+ * @param obj The Entry object
+ * @param h_bounce Allow bounce horizontally
+ * @param v_bounce Allow bounce vertically
+ *
+ * @ingroup Entry
+ */
+EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
+
+/**
+ * Set the input panel layout of the entry
*
- * @note A previously set widget will be destroyed.
- * @note If the object being set does not have minimum size hints set,
- * it won't get properly displayed.
+ * @param obj The entry object
+ * @param layout layout type
*
- * @see elm_entry_end_set()
+ * @ingroup Entry
*/
-EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
+EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
/**
- * Gets the leftmost widget of the scrolled entry. This object is
- * owned by the scrolled entry and should not be modified.
+ * Get the input panel layout of the entry
+ *
+ * @param obj The entry object
+ * @return layout type
*
- * @param obj The scrolled entry object
- * @return the left widget inside the scroller
+ * @see elm_entry_input_panel_layout_set
+ *
+ * @ingroup Entry
*/
-EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
+EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(const Evas_Object *obj);
/**
- * Unset the leftmost widget of the scrolled entry, unparenting and
- * returning it.
+ * Set the autocapitalization type on the immodule.
*
- * @param obj The scrolled entry object
- * @return the previously set icon sub-object of this entry, on
- * success.
+ * @param obj The entry object
+ * @param autocapital_type The type of autocapitalization
*
- * @see elm_entry_icon_set()
+ * @ingroup Entry
*/
-EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
+EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type);
/**
- * Sets the visibility of the left-side widget of the scrolled entry,
- * set by elm_entry_icon_set().
+ * Retrieve the autocapitalization type on the immodule.
*
- * @param obj The scrolled entry object
- * @param setting EINA_TRUE if the object should be displayed,
- * EINA_FALSE if not.
+ * @param obj The entry object
+ * @return autocapitalization type
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
+EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(const Evas_Object *obj);
+
+/**
+ * Sets the attribute to show the input panel automatically.
+ *
+ * @param obj The entry object
+ * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
+ *
+ * @ingroup Entry
+ */
+EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
/**
- * This sets a widget to be displayed to the end of a scrolled entry.
+ * Retrieve the attribute to show the input panel automatically.
*
- * @param obj The scrolled entry object
- * @param end The widget to display on the right side of the scrolled
- * entry.
+ * @param obj The entry object
+ * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
*
- * @note A previously set widget will be destroyed.
- * @note If the object being set does not have minimum size hints set,
- * it won't get properly displayed.
+ * @ingroup Entry
+ */
+EAPI Eina_Bool elm_entry_input_panel_enabled_get(const Evas_Object *obj);
+
+/**
+ * Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
*
- * @see elm_entry_icon_set
+ * Note that input panel is shown or hidden automatically according to the focus state of entry widget.
+ * This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE).
+ *
+ * @param obj The entry object
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
+EAPI void elm_entry_input_panel_show(Evas_Object *obj);
/**
- * Gets the endmost widget of the scrolled entry. This object is owned
- * by the scrolled entry and should not be modified.
+ * Hide the input panel (virtual keyboard).
+ *
+ * Note that input panel is shown or hidden automatically according to the focus state of entry widget.
+ * This API can be used in the case of manually controlling by using elm_entry_input_panel_enabled_set(en, EINA_FALSE)
+ *
+ * @param obj The entry object
*
- * @param obj The scrolled entry object
- * @return the right widget inside the scroller
+ * @ingroup Entry
*/
-EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
+EAPI void elm_entry_input_panel_hide(Evas_Object *obj);
/**
- * Unset the endmost widget of the scrolled entry, unparenting and
- * returning it.
+ * Set the language mode of the input panel.
*
- * @param obj The scrolled entry object
- * @return the previously set icon sub-object of this entry, on
- * success.
+ * This API can be used if you want to show the alphabet keyboard mode.
*
- * @see elm_entry_icon_set()
+ * @param obj The entry object
+ * @param lang language to be set to the input panel.
+ *
+ * @ingroup Entry
*/
-EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
+EAPI void elm_entry_input_panel_language_set(Evas_Object *obj, Elm_Input_Panel_Lang lang);
/**
- * Sets the visibility of the end widget of the scrolled entry, set by
- * elm_entry_end_set().
+ * Get the language mode of the input panel.
*
- * @param obj The scrolled entry object
- * @param setting EINA_TRUE if the object should be displayed,
- * EINA_FALSE if not.
+ * See @ref elm_entry_input_panel_language_set for more details.
+ *
+ * @param obj The entry object
+ * @return input panel language type
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
+EAPI Elm_Input_Panel_Lang elm_entry_input_panel_language_get(const Evas_Object *obj);
/**
- * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
- * them).
+ * Set the input panel-specific data to deliver to the input panel.
*
- * Setting an entry to single-line mode with elm_entry_single_line_set()
- * will automatically disable the display of scrollbars when the entry
- * moves inside its scroller.
+ * This API is used by applications to deliver specific data to the input panel.
+ * The data format MUST be negotiated by both application and the input panel.
+ * The size and format of data are defined by the input panel.
*
- * @param obj The scrolled entry object
- * @param h The horizontal scrollbar policy to apply
- * @param v The vertical scrollbar policy to apply
+ * @param obj The entry object
+ * @param data The specific data to be set to the input panel.
+ * @param len the length of data, in bytes, to send to the input panel
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
+EAPI void elm_entry_input_panel_imdata_set(Evas_Object *obj, const void *data, int len);
/**
- * This enables/disables bouncing within the entry.
+ * Get the specific data of the current input panel.
*
- * This function sets whether the entry will bounce when scrolling reaches
- * the end of the contained entry.
+ * See @ref elm_entry_input_panel_imdata_set for more details.
*
- * @param obj The scrolled entry object
- * @param h_bounce The horizontal bounce state
- * @param v_bounce The vertical bounce state
+ * @param obj The entry object
+ * @param data The specific data to be got from the input panel
+ * @param len The length of data
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
+EAPI void elm_entry_input_panel_imdata_get(const Evas_Object *obj, void *data, int *len);
/**
- * Get the bounce mode
+ * Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
*
- * @param obj The Entry object
- * @param h_bounce Allow bounce horizontally
- * @param v_bounce Allow bounce vertically
+ * An input panel displays the string or icon associated with this type
+ *
+ * @param obj The entry object
+ * @param return_key_type The type of "return" key on the input panel
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
+EAPI void elm_entry_input_panel_return_key_type_set(Evas_Object *obj, Elm_Input_Panel_Return_Key_Type return_key_type);
+
+/**
+ * Get the "return" key type.
+ *
+ * @see elm_entry_input_panel_return_key_type_set() for more details
+ *
+ * @param obj The entry object
+ * @return The type of "return" key on the input panel
+ *
+ * @ingroup Entry
+ */
+EAPI Elm_Input_Panel_Return_Key_Type elm_entry_input_panel_return_key_type_get(const Evas_Object *obj);
+
+/**
+ * Set the return key on the input panel to be disabled.
+ *
+ * @param obj The entry object
+ * @param disabled The state to put in in: @c EINA_TRUE for
+ * disabled, @c EINA_FALSE for enabled
+ *
+ * @ingroup Entry
+ */
+EAPI void elm_entry_input_panel_return_key_disabled_set(Evas_Object *obj, Eina_Bool disabled);
+
+/**
+ * Get whether the return key on the input panel should be disabled or not.
+ *
+ * @param obj The entry object
+ * @return EINA_TRUE if it should be disabled
+ *
+ * @ingroup Entry
+ */
+EAPI Eina_Bool elm_entry_input_panel_return_key_disabled_get(const Evas_Object *obj);
+
+/**
+ * Set whether the return key on the input panel is disabled automatically when entry has no text.
+ *
+ * If @p enabled is EINA_TRUE, The return key on input panel is disabled when the entry has no text.
+ * The return key on the input panel is automatically enabled when the entry has text.
+ * The default value is EINA_FALSE.
+ *
+ * @param obj The entry object
+ * @param enabled If @p enabled is EINA_TRUE, the return key is automatically disabled when the entry has no text.
+ *
+ * @ingroup Entry
+ */
+EAPI void elm_entry_input_panel_return_key_autoenabled_set(Evas_Object *obj, Eina_Bool enabled);
+
+/**
+ * Reset the input method context of the entry if needed.
+ *
+ * This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.
+ * This will typically cause the Input Method Context to clear the preedit state.
+ * @param obj The entry object
+ *
+ * @ingroup Entry
+ */
+EAPI void elm_entry_imf_context_reset(Evas_Object *obj);
+
+/**
+ * Set whether the entry should allow to use the text prediction.
+ *
+ * @param obj The entry object
+ * @param prediction Whether the entry should allow to use the text prediction.
+ *
+ * @ingroup Entry
+ */
+EAPI void elm_entry_prediction_allow_set(Evas_Object *obj, Eina_Bool prediction);
+
+/**
+ * Get whether the entry should allow to use the text prediction.
+ *
+ * @param obj The entry object
+ * @return EINA_TRUE if it allows to use the text prediction, otherwise EINA_FALSE.
+ *
+ * @ingroup Entry
+ */
+EAPI Eina_Bool elm_entry_prediction_allow_get(const Evas_Object *obj);
/* pre-made filters for entries */
+
/**
* @typedef Elm_Entry_Filter_Limit_Size
*
* Filter inserted text based on user defined character and byte limits
*
* Add this filter to an entry to limit the characters that it will accept
- * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
- * The funtion works on the UTF-8 representation of the string, converting
+ * based the contents of the provided #Elm_Entry_Filter_Limit_Size.
+ * The function works on the UTF-8 representation of the string, converting
* it from the set markup, thus not accounting for any format in it.
*
* The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
* it as data when setting the filter. In it, it's possible to set limits
* by character count or bytes (any of them is disabled if 0), and both can
* be set at the same time. In that case, it first checks for characters,
- * then bytes.
+ * then bytes. The #Elm_Entry_Filter_Limit_Size structure must be alive and
+ * valid for as long as the entry is alive AND the elm_entry_filter_limit_size
+ * filter is set.
*
* The function will cut the inserted text in order to allow only the first
* number of characters that are still allowed. The cut is made in
*
* This filter, like any others, does not apply when setting the entry text
* directly with elm_object_text_set().
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
+EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text);
/**
* @typedef Elm_Entry_Filter_Accept_Set
* Add this filter to an entry to restrict the set of accepted characters
* based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
* This structure contains both accepted and rejected sets, but they are
- * mutually exclusive.
+ * mutually exclusive. This structure must be available for as long as
+ * the entry is alive AND the elm_entry_filter_accept_set is being used.
*
* The @c accepted set takes preference, so if it is set, the filter will
* only work based on the accepted characters, ignoring anything in the
*
* This filter, like any others, does not apply when setting the entry text
* directly with elm_object_text_set()
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
+EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text);
+
/**
- * Set the input panel layout of the entry
+ * Returns the input method context of the entry.
+ *
+ * This function exposes the internal input method context.
+ *
+ * IMPORTANT: Many functions may change (i.e delete and create a new one)
+ * the internal input method context. Do NOT cache the returned object.
*
* @param obj The entry object
- * @param layout layout type
+ * @return The input method context (Ecore_IMF_Context *) in entry.
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
+EAPI void *elm_entry_imf_context_get(Evas_Object *obj);
/**
- * Get the input panel layout of the entry
+ * @typedef Elm_Cnp_Mode
+ * Enum of entry's copy & paste policy.
+ *
+ * @see elm_entry_cnp_mode_set()
+ * @see elm_entry_cnp_mode_get()
+ */
+typedef enum {
+ ELM_CNP_MODE_MARKUP, /**< copy & paste text with markup tag */
+ ELM_CNP_MODE_NO_IMAGE, /**< copy & paste text without item(image) tag */
+ ELM_CNP_MODE_PLAINTEXT /**< copy & paste text without markup tag */
+} Elm_Cnp_Mode;
+
+/**
+ * Control pasting of text and images for the widget.
+ *
+ * Normally the entry allows both text and images to be pasted.
+ * By setting cnp_mode to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
+ * By setting cnp_mode to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
+ *
+ * @note this only changes the behaviour of text.
*
* @param obj The entry object
- * @return layout type
+ * @param cnp_mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP,
+ * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
*
- * @see elm_entry_input_panel_layout_set
+ * @ingroup Entry
*/
-EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_cnp_mode_set(Evas_Object *obj, Elm_Cnp_Mode cnp_mode);
/**
- * Set the autocapitalization type on the immodule.
+ * Getting elm_entry text paste/drop mode.
+ *
+ * Normally the entry allows both text and images to be pasted.
+ * This gets the copy & paste mode of the entry.
*
* @param obj The entry object
- * @param autocapital_type The type of autocapitalization
+ * @return mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP,
+ * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
+EAPI Elm_Cnp_Mode elm_entry_cnp_mode_get(const Evas_Object *obj);
/**
- * Retrieve the autocapitalization type on the immodule.
+ * Set the parent of the hover popup
+ *
+ * Sets the parent object to use by the hover created by the entry
+ * when an anchor is clicked. See @ref Hover for more details on this.
*
* @param obj The entry object
- * @return autocapitalization type
+ * @param parent The object to use as parent for the hover
+ *
+ * @ingroup Entry
*/
-EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_anchor_hover_parent_set(Evas_Object *obj, Evas_Object *parent);
/**
- * Sets the attribute to show the input panel automatically.
+ * Get the parent of the hover popup
+ *
+ * Get the object used as parent for the hover created by the entry
+ * widget. See @ref Hover for more details on this.
+ * If no parent is set, the same entry object will be used.
*
* @param obj The entry object
- * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
+ * @return The object used as parent for the hover, NULL if none is set.
+ *
+ * @ingroup Entry
*/
-EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_entry_anchor_hover_parent_get(const Evas_Object *obj);
/**
- * Retrieve the attribute to show the input panel automatically.
+ * Set the style that the hover should use
+ *
+ * When creating the popup hover, entry will request that it's
+ * themed according to @p style.
+ *
+ * Setting style no NULL means disabling automatic hover.
*
* @param obj The entry object
- * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
+ * @param style The style to use for the underlying hover
+ *
+ * @see elm_object_style_set()
+ *
+ * @ingroup Entry
*/
-EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI void elm_entry_anchor_hover_style_set(Evas_Object *obj, const char *style);
+
+/**
+ * Get the style that the hover should use
+ *
+ * Get the style, the hover created by entry will use.
+ *
+ * @param obj The entry object
+ * @return The style to use by the hover. NULL means the default is used.
+ *
+ * @see elm_object_style_set()
+ *
+ * @ingroup Entry
+ */
+EAPI const char *elm_entry_anchor_hover_style_get(const Evas_Object *obj);
+
+/**
+ * Ends the hover popup in the entry
+ *
+ * When an anchor is clicked, the entry widget will create a hover
+ * object to use as a popup with user provided content. This function
+ * terminates this popup, returning the entry to its normal state.
+ *
+ * @param obj The entry object
+ *
+ * @ingroup Entry
+ */
+EAPI void elm_entry_anchor_hover_end(Evas_Object *obj);
+
+/**
+ * This disables the entry's magnifer feature.
+ *
+ * @param obj The entry object
+ * @param disabled If true, the magnifier is not displayed
+ */
+
+EAPI void elm_entry_magnifier_disabled_set(Evas_Object *obj, Eina_Bool disabled);
+/**
+ * This returns whether the entry's magnifier feature is disabled.
+ *
+ * @param obj The entry object
+ * @return If true, the feature is disabled
+ */
+EAPI Eina_Bool elm_entry_magnifier_disabled_get(const Evas_Object *obj);
+
+EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type);
/**
* @}