#ifndef _ELM_ENTRY_EO_LEGACY_H_
#define _ELM_ENTRY_EO_LEGACY_H_

#ifndef _ELM_ENTRY_EO_CLASS_TYPE
#define _ELM_ENTRY_EO_CLASS_TYPE

typedef Eo Elm_Entry;

#endif

#ifndef _ELM_ENTRY_EO_TYPES
#define _ELM_ENTRY_EO_TYPES

/**
 * @brief Text Format types.
 *
 * See also @ref elm_entry_file_text_format_set.
 *
 * @ingroup Elm
 */
typedef enum
{
  ELM_TEXT_FORMAT_PLAIN_UTF8 = 0, /** Plain UTF8 type */
  ELM_TEXT_FORMAT_MARKUP_UTF8 /** Markup UTF8 type */
} Elm_Text_Format;

/** Input panel (virtual keyboard) layout types. Type of input panel (virtual
 * keyboard) to use - this is a hint and may not provide exactly what is
 * desired. See also @ref elm_entry_input_panel_layout_set.
 *
 * @ingroup Elm_Input_Panel
 */
typedef enum
{
  ELM_INPUT_PANEL_LAYOUT_NORMAL = 0, /** 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 including
                                    * esc, alt, ctrl key, so on (no
                                    * auto-correct, no auto-capitalization). */
  ELM_INPUT_PANEL_LAYOUT_PASSWORD, /** Like normal, but no auto-correct, no
                                    * auto-capitalization etc. */
  ELM_INPUT_PANEL_LAYOUT_DATETIME, /** Date and time layout
                                    *
                                    * @since 1.8 */
  ELM_INPUT_PANEL_LAYOUT_EMOTICON /** Emoticon layout
                                   *
                                   * @since 1.10 */
} Elm_Input_Panel_Layout;

/**
 * @brief Input panel (virtual keyboard) language modes.
 *
 * See also @ref elm_entry_input_panel_language_set.
 *
 * @ingroup Elm_Input_Panel
 */
typedef enum
{
  ELM_INPUT_PANEL_LANG_AUTOMATIC = 0, /** Automatic */
  ELM_INPUT_PANEL_LANG_ALPHABET /** Alphabet */
} Elm_Input_Panel_Lang;

/**
 * @brief Autocapitalization Types. Choose method of auto-capitalization.
 *
 * See also @ref elm_entry_autocapital_type_set.
 *
 * @ingroup Elm_Autocapital
 */
typedef enum
{
  ELM_AUTOCAPITAL_TYPE_NONE = 0, /** 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;

/** "Return" Key types on the input panel (virtual keyboard). See also
 * @ref elm_entry_input_panel_return_key_type_set.
 *
 * @ingroup Elm_Input_Panel_Return_Key
 */
typedef enum
{
  ELM_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT = 0, /** 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_SIGNIN /** Sign-in
                                          *
                                          * @since 1.8 */
} Elm_Input_Panel_Return_Key_Type;

/** Enumeration that defines the types of Input Hints.
 *
 * @since 1.12
 *
 * @ingroup Elm_Input
 */
typedef enum
{
  ELM_INPUT_HINT_NONE = 0, /** No active hints
                            *
                            * @since 1.12 */
  ELM_INPUT_HINT_AUTO_COMPLETE = 1 /* 1 << 0 */, /** Suggest word auto
                                                  * completion
                                                  *
                                                  * @since 1.12 */
  ELM_INPUT_HINT_SENSITIVE_DATA = 2 /* 1 << 1 */ /** Typed text should not be
                                                  * stored.
                                                  *
                                                  * @since 1.12 */
} Elm_Input_Hints;


#endif

/**
 * Enable or disable scrolling in entry
 *
 * Normally the entry is not scrollable unless you enable it with this call.
 *
 * @ingroup Entry
 *
 * @param[in] scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
 */
EAPI void elm_entry_scrollable_set(Elm_Entry *obj, Eina_Bool scroll);

/**
 * Get the scrollable state of the entry
 *
 * Normally the entry is not scrollable. This gets the scrollable state
 * of the entry. See elm_entry_scrollable_set() for more information.
 *
 * @return The scrollable state
 *
 * @ingroup Entry
 */
EAPI Eina_Bool elm_entry_scrollable_get(const Elm_Entry *obj);

/**
 * Set the attribute to show the input panel in case of only an user's explicit Mouse Up event.
 * It doesn't request to show the input panel even though it has focus.
 *
 * @ingroup Entry
 *
 * @param[in] ondemand If true, the input panel will be shown in case of only Mouse up event.
(Focus event will be ignored.)
@since 1.9
 */
EAPI void elm_entry_input_panel_show_on_demand_set(Elm_Entry *obj, Eina_Bool ondemand);

/**
 * Get the attribute to show the input panel in case of only an user's explicit Mouse Up event.
 *
 * @return @c EINA_TRUE if the input panel will be shown in case of only Mouse up event.
 * @since 1.9
 *
 * @ingroup Entry
 */
EAPI Eina_Bool elm_entry_input_panel_show_on_demand_get(const Elm_Entry *obj);

/**
 * This disables the entry's contextual (longpress) menu.
 *
 * @ingroup Entry
 *
 * @param[in] disabled If true, the menu is disabled
 */
EAPI void elm_entry_context_menu_disabled_set(Elm_Entry *obj, Eina_Bool disabled);

/**
 * This returns whether the entry's contextual (longpress) menu is
 * disabled.
 *
 * @return If true, the menu is disabled
 *
 * @ingroup Entry
 */
EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Elm_Entry *obj);

/**
 * 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.
 *
 * @ingroup Entry
 *
 * @param[in] cnp_mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
 */
EAPI void elm_entry_cnp_mode_set(Elm_Entry *obj, Elm_Cnp_Mode cnp_mode);

/**
 * 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.
 *
 * @return mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
 *
 * @ingroup Entry
 */
EAPI Elm_Cnp_Mode elm_entry_cnp_mode_get(const Elm_Entry *obj);

/**
 * @brief Text format used to load and save the file, which could be plain text
 * or markup text.
 *
 * Default is @c ELM_TEXT_FORMAT_PLAIN_UTF8, if you want to use
 * @c ELM_TEXT_FORMAT_MARKUP_UTF8 then you need to set the text format before
 * calling @ref Efl.File.file.set.
 *
 * You could also set it before a call to @ref elm_entry_file_save in order to
 * save with the given format.
 *
 * Use it before calling @ref Efl.File.file.set or @ref elm_entry_file_save.
 *
 * @param[in] format The file format
 *
 * @ingroup Elm_Entry
 */
EAPI void elm_entry_file_text_format_set(Elm_Entry *obj, Elm_Text_Format format);

/**
 * Set the language mode of the input panel.
 *
 * This API can be used if you want to show the alphabet keyboard mode.
 *
 * @ingroup Entry
 *
 * @param[in] lang language to be set to the input panel.
 */
EAPI void elm_entry_input_panel_language_set(Elm_Entry *obj, Elm_Input_Panel_Lang lang);

/**
 * Get the language mode of the input panel.
 *
 * See @ref elm_entry_input_panel_language_set for more details.
 *
 * @return input panel language type
 *
 * @ingroup Entry
 */
EAPI Elm_Input_Panel_Lang elm_entry_input_panel_language_get(const Elm_Entry *obj);

/**
 * This disabled the entry's selection handlers.
 *
 * @ingroup Entry
 *
 * @param[in] disabled If true, the selection handlers are disabled.
 */
EAPI void elm_entry_selection_handler_disabled_set(Elm_Entry *obj, Eina_Bool disabled);

/**
 * Set the input panel layout variation of the entry
 *
 * @ingroup Entry
 * @since 1.8
 *
 * @param[in] variation layout variation type
 */
EAPI void elm_entry_input_panel_layout_variation_set(Elm_Entry *obj, int variation);

/**
 * Get the input panel layout variation of the entry
 *
 * @return layout variation type
 *
 * @see elm_entry_input_panel_layout_variation_set
 *
 * @ingroup Entry
 * @since 1.8
 */
EAPI int elm_entry_input_panel_layout_variation_get(const Elm_Entry *obj);

/**
 * Set the autocapitalization type on the immodule.
 *
 * @ingroup Entry
 *
 * @param[in] autocapital_type The type of autocapitalization
 */
EAPI void elm_entry_autocapital_type_set(Elm_Entry *obj, Elm_Autocapital_Type autocapital_type);

/**
 * Get the autocapitalization type on the immodule.
 *
 * @return autocapitalization type
 *
 * @ingroup Entry
 */
EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(const Elm_Entry *obj);

/**
 * Sets if the entry is to be editable or not.
 *
 * By default, entries are editable and when focused, any text input by the
 * user will be inserted at the current cursor position. But calling this
 * function with @p editable as EINA_FALSE will prevent the user from
 * inputting text into the entry.
 *
 * The only way to change the text of a non-editable entry is to use
 * elm_object_text_set(), elm_entry_entry_insert() and other related
 * functions.
 *
 * @ingroup Entry
 *
 * @param[in] 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.
 */
EAPI void elm_entry_editable_set(Elm_Entry *obj, Eina_Bool editable);

/**
 * Get whether the entry is editable or not.
 *
 * @return If true, the entry is editable by the user.
 * If false, it is not editable by the user
 *
 * @see elm_entry_editable_set()
 *
 * @ingroup Entry
 */
EAPI Eina_Bool elm_entry_editable_get(const Elm_Entry *obj);

/**
 * 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 @c NULL means disabling automatic hover.
 *
 * @see elm_object_style_set()
 *
 * @ingroup Entry
 *
 * @param[in] style The style to use for the underlying hover
 */
EAPI void elm_entry_anchor_hover_style_set(Elm_Entry *obj, const char *style);

/**
 * Get the style that the hover should use
 *
 * Get the style, the hover created by entry will use.
 *
 * @return The style to use by the hover. @c NULL means the default is used.
 *
 * @see elm_object_style_set()
 *
 * @ingroup Entry
 */
EAPI const char *elm_entry_anchor_hover_style_get(const Elm_Entry *obj);

/**
 * Sets the entry to single line mode.
 *
 * In single line mode, entries don't ever wrap when the text reaches the
 * edge, and instead they keep growing horizontally. Pressing the @c Enter
 * key will generate an @c "activate" event instead of adding a new line.
 *
 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
 * and pressing enter will break the text into a different line
 * without generating any events.
 *
 * @ingroup Entry
 *
 * @param[in] single_line If true, the text in the entry
will be on a single line.
 */
EAPI void elm_entry_single_line_set(Elm_Entry *obj, Eina_Bool single_line);

/**
 * Get whether the entry is set to be single line.
 *
 * @return single_line If true, the text in the entry is set to display
 * on a single line.
 *
 * @see elm_entry_single_line_set()
 *
 * @ingroup Entry
 */
EAPI Eina_Bool elm_entry_single_line_get(const Elm_Entry *obj);

/**
 * Sets the entry to password mode.
 *
 * In password mode, entries are implicitly single line and the display of
 * any text in them is replaced with asterisks (*).
 *
 * @ingroup Entry
 *
 * @param[in] password If true, password mode is enabled.
 */
EAPI void elm_entry_password_set(Elm_Entry *obj, Eina_Bool password);

/**
 * Get whether the entry is set to password mode.
 *
 * @return If true, the entry is set to display all characters
 * as asterisks (*).
 *
 * @see elm_entry_password_set()
 *
 * @ingroup Entry
 */
EAPI Eina_Bool elm_entry_password_get(const Elm_Entry *obj);

/**
 * Set the return key on the input panel to be disabled.
 *
 * @ingroup Entry
 *
 * @param[in] disabled The state to put in in: @c EINA_TRUE for
disabled, @c EINA_FALSE for enabled
 */
EAPI void elm_entry_input_panel_return_key_disabled_set(Elm_Entry *obj, Eina_Bool disabled);

/**
 * Get whether the return key on the input panel should be disabled or not.
 *
 * @return EINA_TRUE if it should be disabled
 *
 * @ingroup Entry
 */
EAPI Eina_Bool elm_entry_input_panel_return_key_disabled_get(const Elm_Entry *obj);

/**
 * This sets the entry object to 'autosave' the loaded text file or not.
 *
 * @see elm_entry_file_set()
 *
 * @ingroup Entry
 *
 * @param[in] auto_save Autosave the loaded file or not
 */
EAPI void elm_entry_autosave_set(Elm_Entry *obj, Eina_Bool auto_save);

/**
 * 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 Elm_Entry *obj);

/**
 * 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.
 *
 * @ingroup Entry
 *
 * @param[in] parent The object to use as parent for the hover
 */
EAPI void elm_entry_anchor_hover_parent_set(Elm_Entry *obj, Evas_Object *parent);

/**
 * 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.
 *
 * @return The object used as parent for the hover, NULL if none is set.
 *
 * @ingroup Entry
 */
EAPI Evas_Object *elm_entry_anchor_hover_parent_get(const Elm_Entry *obj);

/**
 * Set whether the entry should allow to use the text prediction.
 *
 * @ingroup Entry
 *
 * @param[in] prediction Whether the entry should allow to use the text prediction.
 */
EAPI void elm_entry_prediction_allow_set(Elm_Entry *obj, Eina_Bool prediction);

/**
 * Get whether the entry should allow to use the text prediction.
 *
 * @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 Elm_Entry *obj);

/**
 * Sets the input hint which allows input methods to fine-tune their behavior.
 *
 * @ingroup Entry
 *
 * @param[in] hints input hint.
 */
EAPI void elm_entry_input_hint_set(Elm_Entry *obj, Elm_Input_Hints hints);

/**
 * Gets the value of input hint.
 *
 * @return the value of input hint.
 *
 * @see elm_entry_input_hint_set
 *
 * @ingroup Entry
 */
EAPI Elm_Input_Hints elm_entry_input_hint_get(const Elm_Entry *obj);

/**
 * Set the input panel layout of the entry
 *
 * @ingroup Entry
 *
 * @param[in] layout layout type
 */
EAPI void elm_entry_input_panel_layout_set(Elm_Entry *obj, Elm_Input_Panel_Layout layout);

/**
 * Get the input panel layout of the entry
 *
 * @return layout type. It returns ELM_INPUT_PANEL_LAYOUT_INVALID(8) when it fails.
 *
 * @see elm_entry_input_panel_layout_set
 *
 * @ingroup Entry
 */
EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(const Elm_Entry *obj);

/**
 * Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
 *
 * An input panel displays the string or icon associated with this type
 *
 * @ingroup Entry
 *
 * @param[in] return_key_type The type of "return" key on the input panel
 */
EAPI void elm_entry_input_panel_return_key_type_set(Elm_Entry *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
 *
 * @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 Elm_Entry *obj);

/**
 * Sets the attribute to show the input panel automatically.
 *
 * @ingroup Entry
 *
 * @param[in] enabled If true, the input panel is appeared when entry is clicked or has a focus
 */
EAPI void elm_entry_input_panel_enabled_set(Elm_Entry *obj, Eina_Bool enabled);

/**
 * Get the attribute to show the input panel automatically.
 *
 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
 *
 * @ingroup Entry
 */
EAPI Eina_Bool elm_entry_input_panel_enabled_get(const Elm_Entry *obj);

/**
 * Set the line wrap type to use on multi-line entries.
 *
 * Sets the wrap type used by the entry to any of the specified in
 * Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
 * line (without inserting a line break or paragraph separator) when it
 * reaches the far edge of the widget.
 *
 * Note that this only makes sense for multi-line entries. A widget set
 * to be single line will never wrap.
 *
 * @ingroup Entry
 *
 * @param[in] wrap The wrap mode to use. See Elm_Wrap_Type for details on them
 */
EAPI void elm_entry_line_wrap_set(Elm_Entry *obj, Elm_Wrap_Type wrap);

/**
 * Get 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 Elm_Entry *obj);

/**
 * Sets the cursor position in the entry to the given value
 *
 * The value in @p pos is the index of the character position within the
 * contents of the string as returned by elm_entry_cursor_pos_get().
 *
 * @ingroup Entry
 *
 * @param[in] pos The position of the cursor
 */
EAPI void elm_entry_cursor_pos_set(Elm_Entry *obj, int pos);

/**
 * Get the current position of the cursor in the entry
 *
 * @return The cursor position
 *
 * @ingroup Entry
 */
EAPI int elm_entry_cursor_pos_get(const Elm_Entry *obj);

/**
 * Sets the visibility of the left-side widget of the entry,
 * set by elm_object_part_content_set().
 *
 * @ingroup Entry
 *
 * @param[in] setting EINA_TRUE if the object should be displayed,
EINA_FALSE if not.
 */
EAPI void elm_entry_icon_visible_set(Elm_Entry *obj, Eina_Bool setting);

/**
 * This moves the cursor to the end of the current line.
 *
 * @ingroup Entry
 */
EAPI void elm_entry_cursor_line_end_set(Elm_Entry *obj);

/**
 * This selects a region of text within the entry.
 *
 * @ingroup Entry
 * @since 1.9
 *
 * @param[in] start The starting position
 * @param[in] end The end position
 */
EAPI void elm_entry_select_region_set(Elm_Entry *obj, int start, int end);

/**
 * 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.
 *
 * @ingroup Entry
 *
 * @param[in] enabled If @p enabled is EINA_TRUE, the return key is automatically disabled when the entry has no text.
 */
EAPI void elm_entry_input_panel_return_key_autoenabled_set(Elm_Entry *obj, Eina_Bool enabled);

/**
 * Sets the visibility of the end widget of the entry, set by
 * elm_object_part_content_set(ent, "end", content).
 *
 * @ingroup Entry
 *
 * @param[in] setting EINA_TRUE if the object should be displayed,
EINA_FALSE if not.
 */
EAPI void elm_entry_end_visible_set(Elm_Entry *obj, Eina_Bool setting);

/**
 * This moves the cursor to the beginning of the entry.
 *
 * @ingroup Entry
 */
EAPI void elm_entry_cursor_begin_set(Elm_Entry *obj);

/**
 * This moves the cursor to the beginning of the current line.
 *
 * @ingroup Entry
 */
EAPI void elm_entry_cursor_line_begin_set(Elm_Entry *obj);

/**
 * This moves the cursor to the end of the entry.
 *
 * @ingroup Entry
 */
EAPI void elm_entry_cursor_end_set(Elm_Entry *obj);

/**
 * Returns the actual textblock object of the entry.
 *
 * This function exposes the internal textblock object that actually
 * contains and draws the text. This should be used for low-level
 * manipulations that are otherwise not possible.
 *
 * Changing the textblock directly from here will not notify edje/elm to
 * recalculate the textblock size automatically, so any modifications
 * done to the textblock returned by this function should be followed by
 * a call to elm_entry_calc_force().
 *
 * The return value is marked as const as an additional warning.
 * One should not use the returned object with any of the generic evas
 * functions (geometry_get/resize/move and etc), but only with the textblock
 * functions; The former will either not work at all, or break the correct
 * functionality.
 *
 * IMPORTANT: Many functions may change (i.e delete and create a new one)
 * the internal textblock object. Do NOT cache the returned object, and try
 * not to mix calls on this object with regular elm_entry calls (which may
 * change the internal textblock object). This applies to all cursors
 * returned from textblock calls, and all the other derivative values.
 *
 * @return The textblock object.
 *
 * @ingroup Entry
 */
EAPI Evas_Object *elm_entry_textblock_get(const Elm_Entry *obj);

/**
 * This function returns the geometry of the cursor.
 *
 * It's useful if you want to draw something on the cursor (or where it is),
 * or for example in the case of scrolled entry where you want to show the
 * cursor.
 *
 * @return EINA_TRUE upon success, EINA_FALSE upon failure
 *
 * @ingroup Entry
 *
 * @param[out] x returned geometry
 * @param[out] y returned geometry
 * @param[out] w returned geometry
 * @param[out] h returned geometry
 */
EAPI Eina_Bool elm_entry_cursor_geometry_get(const Elm_Entry *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);

/**
 * 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.
 *
 * @return The input method context (Ecore_IMF_Context *) in entry.
 *
 * @ingroup Entry
 */
EAPI void *elm_entry_imf_context_get(const Elm_Entry *obj);

/**
 * Get whether a format node exists at the current cursor position.
 *
 * A format node is anything that defines how the text is rendered. It can
 * be a visible format node, such as a line break or a paragraph separator,
 * or an invisible one, such as bold begin or end tag.
 * This function returns whether any format node exists at the current
 * cursor position.
 *
 * @return EINA_TRUE if the current cursor position contains a format node,
 * EINA_FALSE otherwise.
 *
 * @see elm_entry_cursor_is_visible_format_get()
 *
 * @ingroup Entry
 */
EAPI Eina_Bool elm_entry_cursor_is_format_get(const Elm_Entry *obj);

/**
 * Get 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. You must free the string when done with free().
 *
 * @return The text pointed by the cursors.
 *
 * @ingroup Entry
 */
EAPI char *elm_entry_cursor_content_get(const Elm_Entry *obj) EINA_WARN_UNUSED_RESULT;

/**
 * Get any selected text within the entry.
 *
 * If there's any selected text in the entry, this function returns it as
 * a string in markup format. NULL is returned if no selection exists or
 * if an error occurred.
 *
 * The returned value points to an internal string and should not be freed
 * or modified in any way. If the @p entry object is deleted or its
 * contents are changed, the returned pointer should be considered invalid.
 *
 * @return The selected text within the entry or NULL on failure
 *
 * @ingroup Entry
 */
EAPI const char *elm_entry_selection_get(const Elm_Entry *obj);

/**
 * Get if the current cursor position holds a visible format node.
 *
 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
 * 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 Elm_Entry *obj);

/**
 * This moves the cursor one place to the left within the entry.
 *
 * @return EINA_TRUE upon success, EINA_FALSE upon failure
 *
 * @ingroup Entry
 * 
 */
EAPI Eina_Bool elm_entry_cursor_prev(Elm_Entry *obj);

/**
 * Remove the style in the top of user style stack.
 *
 * @see elm_entry_text_style_user_push()
 *
 * @ingroup Entry
 * @since 1.7
 * 
 */
EAPI void elm_entry_text_style_user_pop(Elm_Entry *obj);

/**
 * This prepends a custom item provider to the list for that entry
 *
 * This prepends the given callback. See elm_entry_item_provider_append() for
 * more information
 *
 * @ingroup Entry
 * 
 *
 * @param[in] func The function called to provide the item object
 * @param[in] data The data passed to @p func
 */
EAPI void elm_entry_item_provider_prepend(Elm_Entry *obj, Elm_Entry_Item_Provider_Cb func, void *data);

/**
 * Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on.
 *
 * 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).
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_input_panel_show(Elm_Entry *obj);

/**
 * 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.
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_imf_context_reset(Elm_Entry *obj);

/**
 * Forces calculation of the entry size and text layouting.
 *
 * This should be used after modifying the textblock object directly. See
 * elm_entry_textblock_get() for more information.
 *
 * @see elm_entry_textblock_get()
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_calc_force(Elm_Entry *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.
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_anchor_hover_end(Elm_Entry *obj);

/**
 * This begins a selection within the entry as though
 * the user were holding down the mouse button to make a selection.
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_cursor_selection_begin(Elm_Entry *obj);

/**
 * This moves the cursor one line down within the entry.
 *
 * @return EINA_TRUE upon success, EINA_FALSE upon failure
 *
 * @ingroup Entry
 * 
 */
EAPI Eina_Bool elm_entry_cursor_down(Elm_Entry *obj);

/**
 * This function writes any changes made to the file set with
 * elm_entry_file_set()
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_file_save(Elm_Entry *obj);

/**
 * This executes a "copy" action on the selected text in the entry.
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_selection_copy(Elm_Entry *obj);

/**
 * 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').
 *
 * @ingroup Entry
 * @since 1.7
 * 
 *
 * @param[in] style The style user to push
 */
EAPI void elm_entry_text_style_user_push(Elm_Entry *obj, const char *style);

/**
 * This removes a custom item provider to the list for that entry
 *
 * This removes the given callback. See elm_entry_item_provider_append() for
 * more information
 *
 * @ingroup Entry
 * 
 *
 * @param[in] func The function called to provide the item object
 * @param[in] data The data passed to @p func
 */
EAPI void elm_entry_item_provider_remove(Elm_Entry *obj, Elm_Entry_Item_Provider_Cb func, void *data);

/**
 * Get the style on the top of user style stack.
 *
 * @return style on the top of user style stack if exist, otherwise NULL.
 *
 * @see elm_entry_text_style_user_push()
 *
 * @ingroup Entry
 * @since 1.7
 * 
 */
EAPI const char *elm_entry_text_style_user_peek(const Elm_Entry *obj);

/**
 * This clears and frees the items in a entry's contextual (longpress)
 * menu.
 *
 * @see elm_entry_context_menu_item_add()
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_context_menu_clear(Elm_Entry *obj);

/**
 * This moves the cursor one line up within the entry.
 *
 * @return EINA_TRUE upon success, EINA_FALSE upon failure
 *
 * @ingroup Entry
 * 
 */
EAPI Eina_Bool elm_entry_cursor_up(Elm_Entry *obj);

/**
 * Inserts the given text into the entry at the current cursor position.
 *
 * This inserts text at the cursor position as if it was typed
 * by the user (note that this also allows markup which a user
 * can't just "type" as it would be converted to escaped text, so this
 * call can be used to insert things like emoticon items or bold push/pop
 * tags, other font and color change tags etc.)
 *
 * If any selection exists, it will be replaced by the inserted text.
 *
 * The inserted text is subject to any filters set for the widget.
 *
 * @see elm_entry_markup_filter_append()
 *
 * @ingroup Entry
 * 
 *
 * @param[in] entry The text to insert
 */
EAPI void elm_entry_entry_insert(Elm_Entry *obj, const char *entry);

/**
 * Set the input panel-specific data to deliver to the input panel.
 *
 * 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.
 *
 * @ingroup Entry
 * 
 *
 * @param[in] data The specific data to be set to the input panel.
 * @param[in] len the length of data, in bytes, to send to the input panel
 */
EAPI void elm_entry_input_panel_imdata_set(Elm_Entry *obj, const void *data, int len);

/**
 * Get the specific data of the current input panel.
 *
 * See @ref elm_entry_input_panel_imdata_set for more details.
 *
 * @ingroup Entry
 * 
 *
 * @param[out] data The specific data to be got from the input panel
 * @param[out] len The length of data
 */
EAPI void elm_entry_input_panel_imdata_get(const Elm_Entry *obj, void *data, int *len);

/**
 * This executes a "paste" action in the entry.
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_selection_paste(Elm_Entry *obj);

/**
 * This moves the cursor one place to the right within the entry.
 *
 * @return EINA_TRUE upon success, EINA_FALSE upon failure
 *
 * @ingroup Entry
 * 
 */
EAPI Eina_Bool elm_entry_cursor_next(Elm_Entry *obj);

/**
 * This drops any existing text selection within the entry.
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_select_none(Elm_Entry *obj);

/**
 * 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)
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_input_panel_hide(Elm_Entry *obj);

/**
 * This selects all text within the entry.
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_select_all(Elm_Entry *obj);

/**
 * This ends a selection within the entry as though
 * the user had just released the mouse button while making a selection.
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_cursor_selection_end(Elm_Entry *obj);

/**
 * This executes a "cut" action on the selected text in the entry.
 *
 * @ingroup Entry
 * 
 */
EAPI void elm_entry_selection_cut(Elm_Entry *obj);

/**
 * Get whether the entry is empty.
 *
 * Empty means no text at all. If there are any markup tags, like an item
 * tag for which no provider finds anything, and no text is displayed, this
 * function still returns EINA_FALSE.
 *
 * @return @c EINA_TRUE if the entry text is empty or @p entry is NULL, @c EINA_FALSE otherwise.
 *
 * @ingroup Entry
 * 
 */
EAPI Eina_Bool elm_entry_is_empty(const Elm_Entry *obj);

/**
 * Remove a markup filter from the list
 *
 * Removes the given callback from the filter list. See
 * elm_entry_markup_filter_append() for more information.
 *
 * @ingroup Entry
 * 
 *
 * @param[in] func The filter function to remove
 * @param[in] data The user data passed when adding the function
 */
EAPI void elm_entry_markup_filter_remove(Elm_Entry *obj, Elm_Entry_Filter_Cb func, void *data);

/**
 * This appends a custom item provider to the list for that entry
 *
 * This appends the given callback. The list is walked from beginning to end
 * with each function called given the item href string in the text. If the
 * function returns an object handle other than NULL (it should create an
 * object to do this), then this object is used to replace that item. If
 * not the next provider is called until one provides an item object, or the
 * default provider in entry does.
 *
 * @see @ref entry-items
 *
 * @ingroup Entry
 * 
 *
 * @param[in] func The function called to provide the item object
 * @param[in] data The data passed to @p func
 */
EAPI void elm_entry_item_provider_append(Elm_Entry *obj, Elm_Entry_Item_Provider_Cb func, void *data);

/**
 * 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 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.
 *
 * @ingroup Entry
 * 
 *
 * @param[in] func The function to use as text filter
 * @param[in] data User data to pass to @p func
 */
EAPI void elm_entry_markup_filter_append(Elm_Entry *obj, Elm_Entry_Filter_Cb func, void *data);

/**
 * Appends @p str to the text of the entry.
 *
 * Adds the text in @p str to the end of any text already present in the
 * widget.
 *
 * The appended text is subject to any filters set for the widget.
 *
 * @see elm_entry_markup_filter_append()
 *
 * @ingroup Entry
 * 
 *
 * @param[in] str The text to be appended
 */
EAPI void elm_entry_entry_append(Elm_Entry *obj, const char *str);

/**
 * This adds an item to the entry's contextual menu.
 *
 * A longpress on an entry will make the contextual menu show up, if this
 * hasn't been disabled with elm_entry_context_menu_disabled_set().
 * By default, this menu provides a few options like enabling selection mode,
 * which is useful on embedded devices that need to be explicit about it,
 * and when a selection exists it also shows the copy and cut actions.
 *
 * With this function, developers can add other options to this menu to
 * perform any action they deem necessary.
 *
 * @ingroup Entry
 * 
 *
 * @param[in] label The item's text label
 * @param[in] icon_file The item's icon file
 * @param[in] icon_type The item's icon type
 * @param[in] func The callback to execute when the item is clicked
 * @param[in] data The data to associate with the item for related functions
 */
EAPI void elm_entry_context_menu_item_add(Elm_Entry *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data);

/**
 * Prepend a markup filter function for text inserted in the entry
 *
 * Prepend the given callback to the list. See elm_entry_markup_filter_append()
 * for more information
 *
 * @ingroup Entry
 * 
 *
 * @param[in] func The function to use as text filter
 * @param[in] data User data to pass to @p func
 */
EAPI void elm_entry_markup_filter_prepend(Elm_Entry *obj, Elm_Entry_Filter_Cb func, void *data);

#endif
