/**
* @defgroup Entry Entry
+ * @ingroup Elementary
*
* @image html img/widget/entry/preview-00.png
* @image latex img/widget/entry/preview-00.eps width=\textwidth
* @li "default" - text of the entry
*
* Supported elm_object common APIs.
- * @li elm_object_signal_emit
- * @li elm_object_part_text_set
- * @li elm_object_part_text_get
- * @li elm_object_part_content_set
- * @li elm_object_part_content_get
- * @li elm_object_part_content_unset
- * @li elm_object_signal_callback_add
- * @li elm_object_signal_callback_del
- * @li elm_object_disabled_set
- * @li elm_object_disabled_get
+ * @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
*
* @{
*/
/**
- * @enum _Elm_Text_Format
* @typedef Elm_Text_Format
*
* Text Format types.
- *
+ *
* @see elm_entry_file_set()
*/
typedef enum
} Elm_Text_Format;
/**
- * @enum _Elm_Wrap_Type
* @typedef Elm_Wrap_Type
*
* Line wrapping types.
- *
+ *
* @see elm_entry_line_wrap_set()
*/
typedef enum
} Elm_Wrap_Type; /**< Type of word or character wrapping to use */
/**
- * @enum _Elm_Input_Panel_Layout
* @typedef Elm_Input_Panel_Layout
*
* Input panel (virtual keyboard) layout types.
- *
+ *
* @see elm_entry_input_panel_layout_set()
*/
typedef enum
} Elm_Input_Panel_Layout; /**< Type of input panel (virtual keyboard) to use - this is a hint and may not provide exactly what is desired. */
/**
- * @enum _Elm_Input_Panel_Lang
* @typedef Elm_Input_Panel_Lang
*
* Input panel (virtual keyboard) language modes.
- *
+ *
* @see elm_entry_input_panel_language_set()
*/
typedef enum
} Elm_Input_Panel_Lang;
/**
- * @enum _Elm_Autocapital_Type
* @typedef Elm_Autocapital_Type
*
* Autocapitalization Types.
- *
+ *
* @see elm_entry_autocapital_type_set()
*/
typedef enum
} Elm_Autocapital_Type; /**< Choose method of auto-capitalization */
/**
- * @enum _Elm_Input_Panel_Return_Key_Type
* @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
};
/**
+ * @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. The type of text is always markup. This data can be modified,
- * but any additional allocations must be managed by the user.
+ * @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 const char* elm_entry_text_style_user_peek(const Evas_Object *obj);
+
+/**
* Sets the entry to single line mode.
*
* In single line mode, entries don't ever wrap when the text reaches the
* @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);
* on a single line.
*
* @see elm_entry_single_line_set()
+ *
+ * @ingroup Entry
*/
EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj);
*
* @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);
* as asterisks (*).
*
* @see elm_entry_password_set()
+ *
+ * @ingroup Entry
*/
EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj);
* @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);
*
* @param obj The entry object
* @return The currently displayed text or NULL on failure
+ *
+ * @ingroup Entry
*/
EAPI const char *elm_entry_entry_get(const Evas_Object *obj);
* @param entry The text to be displayed
*
* @see elm_entry_markup_filter_append()
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry);
*
* @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);
*
* @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);
*
* @param obj The entry object
* @return The textblock object.
+ *
+ * @ingroup Entry
*/
EAPI Evas_Object * elm_entry_textblock_get(Evas_Object *obj);
* @param obj The entry object
*
* @see elm_entry_textblock_get()
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_calc_force(Evas_Object *obj);
* @param entry The text to insert
*
* @see elm_entry_markup_filter_append()
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry);
* @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);
* @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);
* 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);
* 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);
* This selects all text within the entry.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_select_all(Evas_Object *obj);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
* 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);
* 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);
* 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);
* 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);
* 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);
* 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_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);
* 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);
*
* @param obj The entry object
* @return The text pointed by the cursors.
+ *
+ * @ingroup Entry
*/
EAPI char *elm_entry_cursor_content_get(const Evas_Object *obj);
* @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);
*
* @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);
*
* @param obj The entry object
* @return The cursor position
+ *
+ * @ingroup Entry
*/
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);
* 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);
* This executes a "paste" action in the entry.
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_selection_paste(Evas_Object *obj);
* @param obj The entry object
*
* @see elm_entry_context_menu_item_add()
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_context_menu_clear(Evas_Object *obj);
* @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);
*
* @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);
*
* @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);
* @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);
+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);
+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);
+EAPI void elm_entry_item_provider_remove(Evas_Object *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
+ * 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
* @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_markup_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
* @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_markup_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
* @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_markup_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data);
*
* @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);
*
* @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);
* @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 Eina_Bool elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format);
* @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);
* elm_entry_file_set()
*
* @param obj The entry object
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_file_save(Evas_Object *obj);
* @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);
* @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);
*
* @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);
*
* @param obj The entry object
* @return The scrollable state
+ *
+ * @ingroup Entry
*/
EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
/**
- * Sets the visibility of the left-side widget of the scrolled entry,
- * set by elm_entry_icon_set().
+ * Sets the visibility of the left-side widget of the entry,
+ * set by elm_object_part_content_set().
*
- * @param obj The scrolled entry object
+ * @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 scrolled entry, set by
+ * Sets the visibility of the end widget of the entry, set by
* elm_object_part_content_set(ent, "end", content).
*
- * @param obj The scrolled entry object
+ * @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_end_visible_set(Evas_Object *obj, Eina_Bool setting);
/**
- * This sets the scrolled entry's scrollbar policy (i.e. enabling/disabling
+ * This sets the entry's scrollbar policy (i.e. enabling/disabling
* them).
*
* 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 scrolled entry object
+ * @param obj The entry object
* @param h The horizontal scrollbar policy to apply
* @param v The vertical scrollbar policy to apply
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
* This function sets whether the entry will bounce when scrolling reaches
* the end of the contained entry.
*
- * @param obj The scrolled entry object
+ * @param obj The entry object
* @param h_bounce The horizontal bounce state
* @param v_bounce The vertical bounce state
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
* @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);
*
* @param obj The entry object
* @param layout layout type
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
* @return layout type
*
* @see elm_entry_input_panel_layout_set
+ *
+ * @ingroup Entry
*/
EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(const Evas_Object *obj);
*
* @param obj The entry object
* @param autocapital_type The type of autocapitalization
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type);
*
* @param obj The entry object
* @return autocapitalization type
+ *
+ * @ingroup Entry
*/
EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(const Evas_Object *obj);
*
* @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);
*
* @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
+ *
+ * @ingroup Entry
*/
EAPI Eina_Bool elm_entry_input_panel_enabled_get(const Evas_Object *obj);
* 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_input_panel_show(Evas_Object *obj);
* 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_input_panel_hide(Evas_Object *obj);
/**
* Set the language mode of the input panel.
*
- * This API can be used if you want to show the alphabet keyboard mode.
+ * This API can be used if you want to show the alphabet keyboard mode.
*
* @param obj The entry object
* @param lang language to be set to the input panel.
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_input_panel_language_set(Evas_Object *obj, Elm_Input_Panel_Lang lang);
*
* @param obj The entry object
* @return input panel language type
+ *
+ * @ingroup Entry
*/
EAPI Elm_Input_Panel_Lang elm_entry_input_panel_language_get(const Evas_Object *obj);
* @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_input_panel_imdata_set(Evas_Object *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.
+ * See @ref elm_entry_input_panel_imdata_set for more details.
*
* @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_input_panel_imdata_get(const Evas_Object *obj, void *data, int *len);
*
* @param obj The entry object
* @param return_key_type The type of "return" key on the input panel
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_input_panel_return_key_type_set(Evas_Object *obj, Elm_Input_Panel_Return_Key_Type return_key_type);
*
* @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);
*
* @param obj The entry object
* @param disabled The state to put in in: @c EINA_TRUE for
- * disabled, @c EINA_FALSE for enabled
+ * disabled, @c EINA_FALSE for enabled
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_input_panel_return_key_disabled_set(Evas_Object *obj, Eina_Bool disabled);
*
* @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);
*
* @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.
+ * 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 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);
*
* @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);
*
* @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);
* 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.
+ * 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.
*
* 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. The #Elm_Entry_Filter_Limit_Size structure must be alive and
- * valid for as long as the entyr is alive AND the elm_entry_filter_limit_size
+ * 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
*
* 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);
*
* 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);
*
* @param obj The entry object
* @return The input method context (Ecore_IMF_Context *) in entry.
+ *
+ * @ingroup Entry
*/
EAPI void *elm_entry_imf_context_get(Evas_Object *obj);
/**
- * @enum _Elm_Cnp_Mode
* @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 {
+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 */
* @note this only changes the behaviour of text.
*
* @param obj The entry object
- * @param mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP,
+ * @param cnp_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_cnp_mode_set(Evas_Object *obj, Elm_Cnp_Mode cnp_mode);
* @param obj The entry object
* @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 Evas_Object *obj);
*
* @param obj The entry object
* @param parent The object to use as parent for the hover
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_anchor_hover_parent_set(Evas_Object *obj, Evas_Object *parent);
*
* @param obj The entry object
* @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 Evas_Object *obj);
* @param style The style to use for the underlying hover
*
* @see elm_object_style_set()
+ *
+ * @ingroup Entry
*/
EAPI void elm_entry_anchor_hover_style_set(Evas_Object *obj, const char *style);
* @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);
* 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);
+
+/**
* @}
*/