/**
- * @defgroup Elm_Ctxpopup Ctxpopup
+ * @defgroup Elm_Ctxpopup_Group Ctxpopup
* @ingroup Elementary
*
* @image html ctxpopup_inheritance_tree.png
* @li @ref elm_object_item_focus_get
*
* @ref tutorial_ctxpopup shows the usage of a good deal of the API.
- * @{
+ *
*/
+/**
+ * @addtogroup Elm_Ctxpopup_Group
+ * @{
+ */
#ifndef EFL_NOLEGACY_API_SUPPORT
#include "elc_ctxpopup_legacy.h"
#endif
* @param parent Parent object
* @return New object or @c NULL, if it cannot be created
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent);
#endif
/** Elementary box class
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
#define ELM_BOX_CLASS elm_box_class_get()
* @param[in] obj The object.
* @param[in] homogeneous The homogeneous flag
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_homogeneous_set(Eo *obj, Eina_Bool homogeneous);
*
* @return The homogeneous flag
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI Eina_Bool elm_obj_box_homogeneous_get(const Eo *obj);
* @param[in] horizontal The horizontal alignment of elements
* @param[in] vertical The vertical alignment of elements
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_align_set(Eo *obj, double horizontal, double vertical);
* @param[out] horizontal The horizontal alignment of elements
* @param[out] vertical The vertical alignment of elements
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_align_get(const Eo *obj, double *horizontal, double *vertical);
* @param[in] obj The object.
* @param[in] horizontal The horizontal flag
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_horizontal_set(Eo *obj, Eina_Bool horizontal);
*
* @return The horizontal flag
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI Eina_Bool elm_obj_box_horizontal_get(const Eo *obj);
* @param[in] horizontal The horizontal space between elements
* @param[in] vertical The vertical space between elements
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_padding_set(Eo *obj, int horizontal, int vertical);
* @param[out] horizontal The horizontal space between elements
* @param[out] vertical The vertical space between elements
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_padding_get(const Eo *obj, int *horizontal, int *vertical);
*
* @return List of children
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI Eina_List *elm_obj_box_children_get(const Eo *obj) EINA_WARN_UNUSED_RESULT;
* @param[in] obj The object.
* @param[in] subobj The object to add to the box
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_pack_end(Eo *obj, Efl_Canvas_Object *subobj);
* See also @ref elm_obj_box_clear, @ref elm_obj_box_unpack.
* @param[in] obj The object.
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_unpack_all(Eo *obj);
* @param[in] obj The object.
* @param[in] subobj The object to unpack
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_unpack(Eo *obj, Efl_Canvas_Object *subobj);
* @param[in] subobj The object to add to the box
* @param[in] after The object after which to add it
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_pack_after(Eo *obj, Efl_Canvas_Object *subobj, Efl_Canvas_Object *after);
* @param[in] obj The object.
* @param[in] subobj The object to add to the box
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_pack_start(Eo *obj, Efl_Canvas_Object *subobj);
* position of a just added item you must force recalculate before doing so.
* @param[in] obj The object.
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_recalculate(Eo *obj);
* @param[in] subobj The object to add to the box
* @param[in] before The object before which to add it
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_pack_before(Eo *obj, Efl_Canvas_Object *subobj, Efl_Canvas_Object *before);
* See also @ref elm_obj_box_unpack, @ref elm_obj_box_unpack_all.
* @param[in] obj The object.
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
EOAPI void elm_obj_box_clear(Eo *obj);
/** Called when child was added
* @return Efl_Object *
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
#define ELM_BOX_EVENT_CHILD_ADDED (&(_ELM_BOX_EVENT_CHILD_ADDED))
/** Called when child was removed
* @return Efl_Object *
*
- * @ingroup Elm_Box
+ * @ingroup Elm_Box_Group
*/
#define ELM_BOX_EVENT_CHILD_REMOVED (&(_ELM_BOX_EVENT_CHILD_REMOVED))
*
* @return @c EINA_TRUE if context menu is disabled, otherwise @c EINA_FALSE.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
* @since 1.17
*/
EAPI Eina_Bool elm_config_context_menu_disabled_get(void);
* @param disabled disable context menu if @c EINA_TRUE, enable otherwise
*
* @see elm_config_context_menu_disabled_get()
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
* @since 1.17
*/
EAPI void elm_config_context_menu_disabled_set(Eina_Bool disabled);
* Get the duration for occurring long tap event of gesture layer.
*
* @return Timeout for long tap event of gesture layer.
- * @ingroup Elm_Gesture_Layer
+ * @ingroup Elm_Gesture_Layer_Group
* @since 1.8
*/
EAPI double elm_config_glayer_long_tap_start_timeout_get(void);
* Set the duration for occurring long tap event of gesture layer.
*
* @param long_tap_timeout Timeout for long tap event of gesture layer.
- * @ingroup Elm_Gesture_Layer
+ * @ingroup Elm_Gesture_Layer_Group
* @since 1.8
*/
EAPI void elm_config_glayer_long_tap_start_timeout_set(double long_tap_timeout);
* Get the duration for occurring double tap event of gesture layer.
*
* @return Timeout for double tap event of gesture layer.
- * @ingroup Elm_Gesture_Layer
+ * @ingroup Elm_Gesture_Layer_Group
* @since 1.8
*/
EAPI double elm_config_glayer_double_tap_timeout_get(void);
* Set the duration for occurring double tap event of gesture layer.
*
* @param double_tap_timeout Timeout for double tap event of gesture layer.
- * @ingroup Elm_Gesture_Layer
+ * @ingroup Elm_Gesture_Layer_Group
* @since 1.8
*/
EAPI void elm_config_glayer_double_tap_timeout_set(double double_tap_timeout);
/** Direction in which to show the popup.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
typedef enum
{
#endif
/** Elementary context popup class
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
#define ELM_CTXPOPUP_CLASS elm_ctxpopup_class_get()
*
* @return The selected item or @c null.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_selected_item_get(const Eo *obj);
*
* @return The first item or @c null.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_first_item_get(const Eo *obj);
*
* @return The last item or @c null.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_last_item_get(const Eo *obj);
*
* @return const list to widget items
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI const Eina_List *elm_obj_ctxpopup_items_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] horizontal @c true for horizontal mode, @c false for vertical.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI void elm_obj_ctxpopup_horizontal_set(Eo *obj, Eina_Bool horizontal);
*
* @return @c true for horizontal mode, @c false for vertical.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Eina_Bool elm_obj_ctxpopup_horizontal_get(const Eo *obj);
*
* @since 1.9
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI void elm_obj_ctxpopup_auto_hide_disabled_set(Eo *obj, Eina_Bool disabled);
*
* @since 1.9
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Eina_Bool elm_obj_ctxpopup_auto_hide_disabled_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] parent The parent to use.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI void elm_obj_ctxpopup_hover_parent_set(Eo *obj, Efl_Canvas_Object *parent);
*
* @return The parent to use.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Efl_Canvas_Object *elm_obj_ctxpopup_hover_parent_get(const Eo *obj);
* @param[in] third 3th priority of direction
* @param[in] fourth 4th priority of direction
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI void elm_obj_ctxpopup_direction_priority_set(Eo *obj, Elm_Ctxpopup_Direction first, Elm_Ctxpopup_Direction second, Elm_Ctxpopup_Direction third, Elm_Ctxpopup_Direction fourth);
* @param[out] third 3th priority of direction
* @param[out] fourth 4th priority of direction
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI void elm_obj_ctxpopup_direction_priority_get(const Eo *obj, Elm_Ctxpopup_Direction *first, Elm_Ctxpopup_Direction *second, Elm_Ctxpopup_Direction *third, Elm_Ctxpopup_Direction *fourth);
*
* @return Direction
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Elm_Ctxpopup_Direction elm_obj_ctxpopup_direction_get(const Eo *obj);
* be emitted.
* @param[in] obj The object.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI void elm_obj_ctxpopup_dismiss(Eo *obj);
/** Clear all items in the given ctxpopup object.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI void elm_obj_ctxpopup_clear(Eo *obj);
*
* @since 1.21
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_item_insert_before(Eo *obj, Elm_Widget_Item *before, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data);
*
* @since 1.21
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_item_insert_after(Eo *obj, Elm_Widget_Item *after, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data);
*
* @return A handle to the item added or @c null, on errors.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_item_append(Eo *obj, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data);
*
* @since 1.11
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_item_prepend(Eo *obj, const char *label, Efl_Canvas_Object *icon, Evas_Smart_Cb func, const void *data);
/** Called when context popup was dismissed
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
#define ELM_CTXPOPUP_EVENT_DISMISSED (&(_ELM_CTXPOPUP_EVENT_DISMISSED))
/** Called when context popup geometry was updated
* @return const Eina_Rect *
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
#define ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE (&(_ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE))
/** Direction in which to show the popup.
*
- * @ingroup Elm_Ctxpopup
+ * @ingroup Elm_Ctxpopup_Group
*/
typedef enum
{
#endif
-/** Elementary context popup item class
+/**
+ * Elementary context popup item class
+ *
+ * @defgroup Elm_Ctxpopup_Item_Group
+ * @ingroup Elm_Ctxpopup_Group
+ */
+
+/**
+ * @brief Get the context popup item class
*
- * @ingroup Elm_Ctxpopup_Item
+ * @ingroup Elm_Ctxpopup_Item_Group
*/
#define ELM_CTXPOPUP_ITEM_CLASS elm_ctxpopup_item_class_get()
* @return The item before the object in its parent's list. If there is no
* previous item or in case of error, @c null is returned.
*
- * @ingroup Elm_Ctxpopup_Item
+ * @ingroup Elm_Ctxpopup_Item_Group
*/
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_item_prev_get(const Eo *obj);
* @return The item after the object in its parent's list. If there is no next
* item or in case of error, @c null is returned.
*
- * @ingroup Elm_Ctxpopup_Item
+ * @ingroup Elm_Ctxpopup_Item_Group
*/
EOAPI Elm_Widget_Item *elm_obj_ctxpopup_item_next_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] selected The selection state.
*
- * @ingroup Elm_Ctxpopup_Item
+ * @ingroup Elm_Ctxpopup_Item_Group
*/
EOAPI void elm_obj_ctxpopup_item_selected_set(Eo *obj, Eina_Bool selected);
*
* @return The selection state.
*
- * @ingroup Elm_Ctxpopup_Item
+ * @ingroup Elm_Ctxpopup_Item_Group
*/
EOAPI Eina_Bool elm_obj_ctxpopup_item_selected_get(const Eo *obj);
* @param[in] func Smart callback function
* @param[in] data Data pointer
*
- * @ingroup Elm_Ctxpopup_Item
+ * @ingroup Elm_Ctxpopup_Item_Group
*/
EOAPI void elm_obj_ctxpopup_item_init(Eo *obj, Evas_Smart_Cb func, const void *data);
*
* @deprecated
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly);
*
* @deprecated
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj);
*
* @deprecated Use elm_scroller_policy_set() instead.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EINA_DEPRECATED EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
*
* @deprecated Use elm_scroller_bounce_set() instead.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EINA_DEPRECATED EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
*
* @deprecated Use elm_scroller_bounce_get() instead.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EINA_DEPRECATED EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
/**
- * @defgroup Elm_Entry Entry
+ * @defgroup Elm_Entry_Group Entry
* @ingroup Elementary
*
* @image html entry_inheritance_tree.png
#define ELM_ENTRY_COMMON_H_
/**
- * @addtogroup Elm_Entry
+ * @addtogroup Elm_Entry_Group
*
* @{
*/
#endif
/** Elementary entry class
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_CLASS elm_entry_class_get()
* @param[in] obj The object.
* @param[in] scroll @c true if it is to be scrollable, @c false otherwise.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_scrollable_set(Eo *obj, Eina_Bool scroll);
*
* @return @c true if it is to be scrollable, @c false otherwise.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_scrollable_get(const Eo *obj);
*
* @since 1.9
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_show_on_demand_set(Eo *obj, Eina_Bool ondemand);
*
* @since 1.9
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_input_panel_show_on_demand_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] disabled If @c true, the menu is disabled.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_context_menu_disabled_set(Eo *obj, Eina_Bool disabled);
*
* @return If @c true, the menu is disabled.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_context_menu_disabled_get(const Eo *obj);
* @param[in] cnp_mode One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP,
* #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_cnp_mode_set(Eo *obj, Elm_Cnp_Mode cnp_mode);
* @return One of #Elm_Cnp_Mode: #ELM_CNP_MODE_MARKUP, #ELM_CNP_MODE_NO_IMAGE,
* #ELM_CNP_MODE_PLAINTEXT.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Elm_Cnp_Mode elm_obj_entry_cnp_mode_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] format The file format
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_file_text_format_set(Eo *obj, Elm_Text_Format format);
* @param[in] obj The object.
* @param[in] lang Language to be set to the input panel.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_language_set(Eo *obj, Elm_Input_Panel_Lang lang);
*
* @return Language to be set to the input panel.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Elm_Input_Panel_Lang elm_obj_entry_input_panel_language_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] disabled If @c true, the selection handlers are disabled.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_selection_handler_disabled_set(Eo *obj, Eina_Bool disabled);
*
* @return If @c true, the selection handlers are disabled.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_selection_handler_disabled_get(const Eo *obj);
*
* @since 1.8
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_layout_variation_set(Eo *obj, int variation);
*
* @since 1.8
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI int elm_obj_entry_input_panel_layout_variation_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] autocapital_type The type of autocapitalization.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_autocapital_type_set(Eo *obj, Elm_Autocapital_Type autocapital_type);
*
* @return The type of autocapitalization.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Elm_Autocapital_Type elm_obj_entry_autocapital_type_get(const Eo *obj);
* @param[in] editable If @c true, user input will be inserted in the entry, if
* not, the entry is read-only and no user input is allowed.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_editable_set(Eo *obj, Eina_Bool editable);
* @return If @c true, user input will be inserted in the entry, if not, the
* entry is read-only and no user input is allowed.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_editable_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] style The style to use for the underlying hover.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_anchor_hover_style_set(Eo *obj, const char *style);
*
* @return The style to use for the underlying hover.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI const char *elm_obj_entry_anchor_hover_style_get(const Eo *obj);
* @param[in] single_line If @c true, the text in the entry will be on a single
* line.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_single_line_set(Eo *obj, Eina_Bool single_line);
*
* @return If @c true, the text in the entry will be on a single line.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_single_line_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] password If @c true, password mode is enabled.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_password_set(Eo *obj, Eina_Bool password);
*
* @return If @c true, password mode is enabled.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_password_get(const Eo *obj);
* @param[in] disabled The state to put in in: @c true for disabled, @c false
* for enabled.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_return_key_disabled_set(Eo *obj, Eina_Bool disabled);
*
* @return The state to put in in: @c true for disabled, @c false for enabled.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_input_panel_return_key_disabled_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] auto_save Autosave the loaded file or not.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_autosave_set(Eo *obj, Eina_Bool auto_save);
*
* @return Autosave the loaded file or not.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_autosave_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] parent The object to use as parent for the hover.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_anchor_hover_parent_set(Eo *obj, Efl_Canvas_Object *parent);
*
* @return The object to use as parent for the hover.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Efl_Canvas_Object *elm_obj_entry_anchor_hover_parent_get(const Eo *obj);
* @param[in] prediction Whether the entry should allow to use the text
* prediction.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_prediction_allow_set(Eo *obj, Eina_Bool prediction);
*
* @return Whether the entry should allow to use the text prediction.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_prediction_allow_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] hints Input hint.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_hint_set(Eo *obj, Elm_Input_Hints hints);
*
* @return Input hint.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Elm_Input_Hints elm_obj_entry_input_hint_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] layout Layout type.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_layout_set(Eo *obj, Elm_Input_Panel_Layout layout);
*
* @return Layout type.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Elm_Input_Panel_Layout elm_obj_entry_input_panel_layout_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] return_key_type The type of "return" key on the input panel.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_return_key_type_set(Eo *obj, Elm_Input_Panel_Return_Key_Type return_key_type);
*
* @return The type of "return" key on the input panel.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Elm_Input_Panel_Return_Key_Type elm_obj_entry_input_panel_return_key_type_get(const Eo *obj);
* @param[in] enabled If @c true, the input panel is appeared when entry is
* clicked or has a focus.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_enabled_set(Eo *obj, Eina_Bool enabled);
* @return If @c true, the input panel is appeared when entry is clicked or has
* a focus.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_input_panel_enabled_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] wrap The wrap mode to use. See Elm_Wrap_Type for details on them.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_line_wrap_set(Eo *obj, Elm_Wrap_Type wrap);
*
* @return The wrap mode to use. See Elm_Wrap_Type for details on them.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Elm_Wrap_Type elm_obj_entry_line_wrap_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] pos The position of the cursor.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_cursor_pos_set(Eo *obj, int pos);
*
* @return The position of the cursor.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI int elm_obj_entry_cursor_pos_get(const Eo *obj);
* @param[in] setting @c true if the object should be displayed, @c false if
* not.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_icon_visible_set(Eo *obj, Eina_Bool setting);
/** This moves the cursor to the end of the current line.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_cursor_line_end_set(Eo *obj);
*
* @since 1.9
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_select_region_set(Eo *obj, int start, int end);
*
* @since 1.18
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_select_region_get(const Eo *obj, int *start, int *end);
* @param[in] enabled If @c enabled is @c true, the return key is automatically
* disabled when the entry has no text.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_return_key_autoenabled_set(Eo *obj, Eina_Bool enabled);
* @param[in] obj The object.
* @param[in] setting @c true if the object should be displayed, false if not.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_end_visible_set(Eo *obj, Eina_Bool setting);
/** This moves the cursor to the beginning of the entry.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_cursor_begin_set(Eo *obj);
/** This moves the cursor to the beginning of the current line.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_cursor_line_begin_set(Eo *obj);
/** This moves the cursor to the end of the entry.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_cursor_end_set(Eo *obj);
*
* @return Textblock object
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Efl_Canvas_Object *elm_obj_entry_textblock_get(const Eo *obj);
*
* @return @c true on success, @c false otherwise
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_textblock_cursor_geometry_get(const Eo *obj, int *x, int *y, int *w, int *h);
*
* @return Input method context
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void *elm_obj_entry_imf_context_get(const Eo *obj);
*
* @return @c true if format node exists, @c false otherwise
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_cursor_is_format_get(const Eo *obj);
*
* @return Character
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI char *elm_obj_entry_textblock_cursor_content_get(const Eo *obj) EINA_WARN_UNUSED_RESULT;
*
* @return Selected string
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI const char *elm_obj_entry_selection_get(const Eo *obj);
*
* @return @c true if position has a visible format, @c false otherwise
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_cursor_is_visible_format_get(const Eo *obj);
*
* @since 1.18
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_select_allow_set(Eo *obj, Eina_Bool allow);
*
* @since 1.18
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_select_allow_get(const Eo *obj);
*
* @return @c true on success, @c false otherwise
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_cursor_prev(Eo *obj);
*
* @since 1.7
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_text_style_user_pop(Eo *obj);
* @param[in] func The function called to provide the item object.
* @param[in] data The data passed to @c func.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_item_provider_prepend(Eo *obj, Elm_Entry_Item_Provider_Cb func, void *data);
* @c false).
* @param[in] obj The object.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_show(Eo *obj);
* Context to clear the preedit state.
* @param[in] obj The object.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_imf_context_reset(Eo *obj);
* popup, returning the entry to its normal state.
* @param[in] obj The object.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_anchor_hover_end(Eo *obj);
/** This begins a selection within the entry as though the user were holding
* down the mouse button to make a selection.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_cursor_selection_begin(Eo *obj);
*
* @return @c true on success, @c false otherwise
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_cursor_down(Eo *obj);
/** This function writes any changes made to the file set with @ref
* elm_entry_file_set.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_file_save(Eo *obj);
/** This executes a "copy" action on the selected text in the entry.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_selection_copy(Eo *obj);
*
* @since 1.7
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_text_style_user_push(Eo *obj, const char *style);
* @param[in] func The function called to provide the item object.
* @param[in] data The data passed to @c func.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_item_provider_remove(Eo *obj, Elm_Entry_Item_Provider_Cb func, void *data);
*
* @since 1.7
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI const char *elm_obj_entry_text_style_user_peek(const Eo *obj);
* See also @ref elm_obj_entry_context_menu_item_add.
* @param[in] obj The object.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_context_menu_clear(Eo *obj);
*
* @return @c true on success, @c false otherwise
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_cursor_up(Eo *obj);
* @param[in] obj The object.
* @param[in] entry The text to insert.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_insert(Eo *obj, const char *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.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_imdata_set(Eo *obj, const void *data, int len);
* @param[out] data The specific data to be got from the input panel.
* @param[out] len The length of data.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_imdata_get(const Eo *obj, void *data, int *len);
/** This executes a "paste" action in the entry.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_selection_paste(Eo *obj);
*
* @return @c true on success, @c false otherwise
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_cursor_next(Eo *obj);
/** This drops any existing text selection within the entry.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_select_none(Eo *obj);
* @c false)
* @param[in] obj The object.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_input_panel_hide(Eo *obj);
/** This selects all text within the entry.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_select_all(Eo *obj);
/** This ends a selection within the entry as though the user had just released
* the mouse button while making a selection.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_cursor_selection_end(Eo *obj);
/** This executes a "cut" action on the selected text in the entry.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_selection_cut(Eo *obj);
*
* @return @c true if empty, @c false otherwise
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_is_empty(const Eo *obj);
* @param[in] func The filter function to remove.
* @param[in] data The user data passed when adding the function.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_markup_filter_remove(Eo *obj, Elm_Entry_Filter_Cb func, void *data);
* @param[in] func The function called to provide the item object.
* @param[in] data The data passed to @c func.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_item_provider_append(Eo *obj, Elm_Entry_Item_Provider_Cb func, void *data);
* @param[in] func The function to use as text filter.
* @param[in] data User data to pass to @c func.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_markup_filter_append(Eo *obj, Elm_Entry_Filter_Cb func, void *data);
* @param[in] obj The object.
* @param[in] str The text to be appended.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_append(Eo *obj, const char *str);
* @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.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_context_menu_item_add(Eo *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data);
* @param[in] func The function to use as text filter.
* @param[in] data User data to pass to @c func.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_markup_filter_prepend(Eo *obj, Elm_Entry_Filter_Cb func, void *data);
*
* @since 1.20
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI void elm_obj_entry_prediction_hint_set(Eo *obj, const char *prediction_hint);
*
* @since 1.21
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_prediction_hint_hash_set(Eo *obj, const char *key, const char *value);
*
* @since 1.21
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EOAPI Eina_Bool elm_obj_entry_prediction_hint_hash_del(Eo *obj, const char *key);
/** Called when entry got activated
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_ACTIVATED (&(_ELM_ENTRY_EVENT_ACTIVATED))
/** Called when entry changed
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_CHANGED (&(_ELM_ENTRY_EVENT_CHANGED))
/** Called when the object changed due to user interaction
* @return Elm_Entry_Change_Info
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_CHANGED_USER (&(_ELM_ENTRY_EVENT_CHANGED_USER))
/** Called when validating
* @return Elm_Validate_Content
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_VALIDATE (&(_ELM_ENTRY_EVENT_VALIDATE))
/** Called when context menu was opened
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_CONTEXT_OPEN (&(_ELM_ENTRY_EVENT_CONTEXT_OPEN))
/** Called when anchor was clicked
* @return Elm_Entry_Anchor_Info
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_ANCHOR_CLICKED (&(_ELM_ENTRY_EVENT_ANCHOR_CLICKED))
/** Called when entry was rejected
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_REJECTED (&(_ELM_ENTRY_EVENT_REJECTED))
/** Called when maximum entry length has been reached
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_MAXLENGTH_REACHED (&(_ELM_ENTRY_EVENT_MAXLENGTH_REACHED))
/** Called when entry preedit changed
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_PREEDIT_CHANGED (&(_ELM_ENTRY_EVENT_PREEDIT_CHANGED))
/** Called when entry pressed
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_PRESS (&(_ELM_ENTRY_EVENT_PRESS))
/** Called when redo was requested
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_REDO_REQUEST (&(_ELM_ENTRY_EVENT_REDO_REQUEST))
/** Called when undo was requested
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_UNDO_REQUEST (&(_ELM_ENTRY_EVENT_UNDO_REQUEST))
/** Called when text set finished
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_TEXT_SET_DONE (&(_ELM_ENTRY_EVENT_TEXT_SET_DONE))
/** Called when entry was aborted
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_ABORTED (&(_ELM_ENTRY_EVENT_ABORTED))
/** Called on anchor down
* @return Elm_Entry_Anchor_Info
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_ANCHOR_DOWN (&(_ELM_ENTRY_EVENT_ANCHOR_DOWN))
/** Called when hover opened
* @return Elm_Entry_Anchor_Hover_Info
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_ANCHOR_HOVER_OPENED (&(_ELM_ENTRY_EVENT_ANCHOR_HOVER_OPENED))
/** Called on anchor in
* @return Elm_Entry_Anchor_Info
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_ANCHOR_IN (&(_ELM_ENTRY_EVENT_ANCHOR_IN))
/** Called on anchor out
* @return Elm_Entry_Anchor_Info
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_ANCHOR_OUT (&(_ELM_ENTRY_EVENT_ANCHOR_OUT))
/** called on anchor up
* @return Elm_Entry_Anchor_Info
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_ANCHOR_UP (&(_ELM_ENTRY_EVENT_ANCHOR_UP))
/** Called on cursor changed
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_CURSOR_CHANGED (&(_ELM_ENTRY_EVENT_CURSOR_CHANGED))
/** Called on manual cursor change
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
#define ELM_ENTRY_EVENT_CURSOR_CHANGED_MANUAL (&(_ELM_ENTRY_EVENT_CURSOR_CHANGED_MANUAL))
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EAPI Evas_Object *elm_entry_add(Evas_Object *parent);
*
* @note Using this function bypasses text filters
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
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 Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EAPI const char *elm_entry_entry_get(const Evas_Object *obj);
*
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*
* @param[in] obj The entry object
* @param[in] file The path to the file to load and save
* This function can be used to retrieve any file set on the entry for
* edition, along with the format used to load and save it.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*
* @param[in] obj The entry object
* @param[out] file The path to the file to load and save
* @ref elm_entry_textblock_get for more information.
* @param[in] obj The object.
*
- * @ingroup Elm_Entry
+ * @ingroup Elm_Entry_Group
*/
EAPI void elm_entry_calc_force(Evas_Object *obj);
/** Defines if the item is of any special type (has subitems or it's the index
* of a group), or is just a simple item.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
typedef enum
{
/** Defines the type of the item part Used while updating item's parts It can
* be used at updating multi fields.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
typedef enum
{
/** Defines where to position the item in the genlist.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
typedef enum
{
/** Defines where to position the item in the genlist.
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
typedef enum
{
/** Defines the type of the item part Used while updating item's parts. It can
* be used at updating multi fields.
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
typedef enum
{
/**
- * @defgroup Elm_Gengrid Gengrid (Generic grid)
+ * @defgroup Elm_Gengrid_Group Gengrid (Generic grid)
* @ingroup Elementary
*
* @image html gengrid_inheritance_tree.png
*/
/**
- * @addtogroup Elm_Gengrid
+ * @addtogroup Elm_Gengrid_Group
* @{
*/
* @see elm_gengrid_item_class_free()
* @see elm_gengrid_item_append()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI Elm_Gengrid_Item_Class *elm_gengrid_item_class_new(void);
* @see elm_gengrid_item_class_ref()
* @see elm_gengrid_item_class_unref()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_item_class_free(Elm_Gengrid_Item_Class *itc);
*
* @see elm_gengrid_item_class_unref()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_item_class_ref(Elm_Gengrid_Item_Class *itc);
* @see elm_gengrid_item_class_ref()
* @see elm_gengrid_item_class_free()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_item_class_unref(Elm_Gengrid_Item_Class *itc);
* In order to set a content or something else as a tooltip, look at
* elm_gengrid_item_tooltip_content_cb_set().
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
*
* @see elm_gengrid_item_tooltip_style_get()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
*
* @see elm_gengrid_item_tooltip_style_set() for more details
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Object_Item *it);
* @see elm_gengrid_item_cursor_set() for more details
* @see elm_gengrid_item_cursor_unset()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI const char *elm_gengrid_item_cursor_get(const Elm_Object_Item *it);
* @see elm_object_cursor_unset()
* @see elm_gengrid_item_cursor_set() for more details
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_item_cursor_unset(Elm_Object_Item *it);
* @see elm_gengrid_item_cursor_engine_only_set()
* @see elm_gengrid_item_cursor_style_get()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_item_cursor_style_set(Elm_Object_Item *it, const char *style);
*
* @see elm_gengrid_item_cursor_style_set() for more details
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Object_Item *it);
* @note By default, cursors will only be looked for between those
* provided by the rendering engine.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
*
* @see elm_gengrid_item_cursor_engine_only_set(), for more details
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Object_Item *it);
* gengrid. For example, @c (0, 1) would stand for first row,
* second column.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_item_pos_get(const Elm_Object_Item *it, unsigned int *x, unsigned int *y);
*
* @see elm_gengrid_item_select_mode_get()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_item_select_mode_set(Elm_Object_Item *it, Elm_Object_Select_Mode mode);
*
* @see elm_gengrid_item_select_mode_set()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI Elm_Object_Select_Mode elm_gengrid_item_select_mode_get(const Elm_Object_Item *it);
/** Gengrid reorder modes
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
typedef enum
{
#endif
/** Elementary gengrid class
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_CLASS elm_gengrid_class_get()
* @param[in] align_x Alignment in the horizontal axis (0 <= align_x <= 1).
* @param[in] align_y Alignment in the vertical axis (0 <= align_y <= 1).
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_align_set(Eo *obj, double align_x, double align_y);
* @param[out] align_x Alignment in the horizontal axis (0 <= align_x <= 1).
* @param[out] align_y Alignment in the vertical axis (0 <= align_y <= 1).
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_align_get(const Eo *obj, double *align_x, double *align_y);
* @param[in] obj The object.
* @param[in] fill @c true if the grid is filled, @c false otherwise
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_filled_set(Eo *obj, Eina_Bool fill);
*
* @return @c true if the grid is filled, @c false otherwise
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Eina_Bool elm_obj_gengrid_filled_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] multi @c true if multislect is enabled, @c false otherwise
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_multi_select_set(Eo *obj, Eina_Bool multi);
*
* @return @c true if multislect is enabled, @c false otherwise
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Eina_Bool elm_obj_gengrid_multi_select_get(const Eo *obj);
* @param[in] w The group items' width.
* @param[in] h The group items' height.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_group_item_size_set(Eo *obj, int w, int h);
* @param[out] w The group items' width.
* @param[out] h The group items' height.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_group_item_size_get(const Eo *obj, int *w, int *h);
* @param[in] obj The object.
* @param[in] timeout Timeout in seconds. Default is elm config value (1.0).
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_longpress_timeout_set(Eo *obj, double timeout);
*
* @return Timeout in seconds. Default is elm config value (1.0).
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI double elm_obj_gengrid_longpress_timeout_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] mode The select mode.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_select_mode_set(Eo *obj, Elm_Object_Select_Mode mode);
*
* @return The select mode.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Object_Select_Mode elm_obj_gengrid_select_mode_get(const Eo *obj);
* @param[in] reorder_mode Use @c true to turn reordering on, @c false to turn
* it off.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_reorder_mode_set(Eo *obj, Eina_Bool reorder_mode);
*
* @return Use @c true to turn reordering on, @c false to turn it off.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Eina_Bool elm_obj_gengrid_reorder_mode_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] highlight @c true if item will be highlighted, @c false otherwise
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_highlight_mode_set(Eo *obj, Eina_Bool highlight);
*
* @return @c true if item will be highlighted, @c false otherwise
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Eina_Bool elm_obj_gengrid_highlight_mode_get(const Eo *obj);
*
* @since 1.11
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_reorder_type_set(Eo *obj, Elm_Gengrid_Reorder_Type type);
* @param[in] w The items' width.
* @param[in] h The items' height.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_item_size_set(Eo *obj, int w, int h);
* @param[out] w The items' width.
* @param[out] h The items' height.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_item_size_get(const Eo *obj, int *w, int *h);
*
* @since 1.8
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_multi_select_mode_set(Eo *obj, Elm_Object_Multi_Select_Mode mode);
*
* @since 1.8
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Object_Multi_Select_Mode elm_obj_gengrid_multi_select_mode_get(const Eo *obj);
* @param[in] horizontal @c true to make the gengrid expand horizontally,
* @c false to expand vertically.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_horizontal_set(Eo *obj, Eina_Bool horizontal);
* @return @c true to make the gengrid expand horizontally, @c false to expand
* vertically.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Eina_Bool elm_obj_gengrid_horizontal_get(const Eo *obj);
* @return The selected item's handle or @c null if none is selected at the
* moment (and on errors).
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_selected_item_get(const Eo *obj);
*
* @return The list of realized items or @c null if none are realized.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Eina_List *elm_obj_gengrid_realized_items_get(const Eo *obj) EINA_WARN_UNUSED_RESULT;
* @return The first item's handle or @c null, if there are no items in @c obj
* (and on errors)
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_first_item_get(const Eo *obj);
* @return The list of selected items or @c null, if none is selected at the
* moment (and on errors).
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI const Eina_List *elm_obj_gengrid_selected_items_get(const Eo *obj);
* @return The last item's handle or @c null if there are no items in @c obj
* (and on errors).
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_last_item_get(const Eo *obj);
*
* @return A handle to the item added or @c null on errors.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_item_insert_before(Eo *obj, const Elm_Gengrid_Item_Class *itc, const void *data, Elm_Widget_Item *relative, Evas_Smart_Cb func, const void *func_data);
* To update just one item, use @ref elm_gengrid_item_update.
* @param[in] obj The object.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_realized_items_update(Eo *obj);
*
* @return A handle to the item added or @c null on error.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_item_insert_after(Eo *obj, const Elm_Gengrid_Item_Class *itc, const void *data, Elm_Widget_Item *relative, Evas_Smart_Cb func, const void *func_data);
*
* @return Items in list
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI unsigned int elm_obj_gengrid_items_count(const Eo *obj);
*
* @return The item at the coordinates or @c null if none.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_at_xy_item_get(const Eo *obj, int x, int y, int *xposret, int *yposret);
*
* @return A handle to the item added or @c null on errors.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_item_append(Eo *obj, const Elm_Gengrid_Item_Class *itc, const void *data, Evas_Smart_Cb func, const void *func_data);
*
* @return A handle to the item added or @c null on errors.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_item_prepend(Eo *obj, const Elm_Gengrid_Item_Class *itc, const void *data, Evas_Smart_Cb func, const void *func_data);
* See @ref elm_gengrid_item_del to remove just one item.
* @param[in] obj The object.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_clear(Eo *obj);
*
* @return A handle to the item added or @c null on errors.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_item_sorted_insert(Eo *obj, const Elm_Gengrid_Item_Class *itc, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
*
* @since 1.11
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_search_by_text_item_get(Eo *obj, Elm_Widget_Item *item_to_search_from, const char *part_name, const char *pattern, Elm_Glob_Match_Flags flags);
*
* @since 1.10
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_reorder_mode_start(Eo *obj, Ecore_Pos_Map tween_mode);
*
* @since 1.10
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EOAPI void elm_obj_gengrid_reorder_mode_stop(Eo *obj);
/** Called when gengrid realized
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_REALIZED (&(_ELM_GENGRID_EVENT_REALIZED))
/** Called when gengrid unrealized
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_UNREALIZED (&(_ELM_GENGRID_EVENT_UNREALIZED))
/** Called on gengrid index update
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_INDEX_UPDATE (&(_ELM_GENGRID_EVENT_INDEX_UPDATE))
/** Called when scroll page changed
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_SCROLL_PAGE_CHANGED (&(_ELM_GENGRID_EVENT_SCROLL_PAGE_CHANGED))
/** Called when bottom edge is reached
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_EDGE_BOTTOM (&(_ELM_GENGRID_EVENT_EDGE_BOTTOM))
/** Called when top edge is reached
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_EDGE_TOP (&(_ELM_GENGRID_EVENT_EDGE_TOP))
/** Called when right edge is reached
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_EDGE_RIGHT (&(_ELM_GENGRID_EVENT_EDGE_RIGHT))
/** Called when left edge is reached
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_EDGE_LEFT (&(_ELM_GENGRID_EVENT_EDGE_LEFT))
/** Called when item got focus
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_ITEM_FOCUSED (&(_ELM_GENGRID_EVENT_ITEM_FOCUSED))
/** Called when item no longer has focus
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_ITEM_UNFOCUSED (&(_ELM_GENGRID_EVENT_ITEM_UNFOCUSED))
/** Called when item reorder animation started
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_ITEM_REORDER_ANIM_START (&(_ELM_GENGRID_EVENT_ITEM_REORDER_ANIM_START))
/** Called when item reorder animation stopped
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_ITEM_REORDER_ANIM_STOP (&(_ELM_GENGRID_EVENT_ITEM_REORDER_ANIM_STOP))
/** Called when gengrid got activated
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_ACTIVATED (&(_ELM_GENGRID_EVENT_ACTIVATED))
/** Called when gengrid is highlighted
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_HIGHLIGHTED (&(_ELM_GENGRID_EVENT_HIGHLIGHTED))
/** Called when gengrid is no longer highlighted
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_UNHIGHLIGHTED (&(_ELM_GENGRID_EVENT_UNHIGHLIGHTED))
/** Called when gengrid is released
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_RELEASED (&(_ELM_GENGRID_EVENT_RELEASED))
/** Called when gengrid item moved
* @return Efl_Object *
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
#define ELM_GENGRID_EVENT_MOVED (&(_ELM_GENGRID_EVENT_MOVED))
/** Gengrid reorder modes
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
typedef enum
{
#endif
-/** Elementary gengrid item class
+/**
+ * Elementary gengrid item class
+ *
+ * @defgroup Elm_Gengrid_Item_Group
+ * @ingroup Elm_Gengrid_Group
+ */
+
+/**
+ * @brief Get gengrid item class
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
#define ELM_GENGRID_ITEM_CLASS elm_gengrid_item_class_get()
*
* @return The item before @c item, or @c NULL if there's none (and on errors)
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_item_prev_get(const Eo *obj);
*
* @return The item after @c item, or @c NULL if there's none (and on errors)
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI Elm_Widget_Item *elm_obj_gengrid_item_next_get(const Eo *obj);
* @param[in] selected The selected state ($true selected, @c false not
* selected)
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_selected_set(Eo *obj, Eina_Bool selected);
*
* @return The selected state ($true selected, @c false not selected)
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI Eina_Bool elm_obj_gengrid_item_selected_get(const Eo *obj);
*
* @return Gengrid Item class for the given item
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI const Elm_Gengrid_Item_Class *elm_obj_gengrid_item_class_get(const Eo *obj);
*
* @return The position inside the list of item.
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI int elm_obj_gengrid_item_index_get(const Eo *obj);
* @param[out] x Pointer to variable to store the item's <b>row number</b>.
* @param[out] y Pointer to variable to store the item's <b>column number</b>.
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_pos_get(const Eo *obj, unsigned int *x, unsigned int *y);
* @param[in] obj The object.
* @param[in] mode The selected mode
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_select_mode_set(Eo *obj, Elm_Object_Select_Mode mode);
*
* @return The selected mode
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI Elm_Object_Select_Mode elm_obj_gengrid_item_select_mode_get(const Eo *obj);
*
* @since 1.19
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_custom_size_set(Eo *obj, int w, int h);
*
* @since 1.19
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_custom_size_get(const Eo *obj, int *w, int *h);
* @param[in] obj The object.
* @param[in] type Where to position the item in the viewport.
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_show(Eo *obj, Elm_Gengrid_Item_Scrollto_Type type);
* @param[in] obj The object.
* @param[in] type Where to position the item in the viewport.
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_bring_in(Eo *obj, Elm_Gengrid_Item_Scrollto_Type type);
* changed and you want the changes to be reflected.
* @param[in] obj The object.
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_update(Eo *obj);
*
* @since 1.15
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_fields_update(Eo *obj, const char *parts, Elm_Gengrid_Item_Field_Type itf);
* @param[in] itc The gengrid item class describing the function pointers and
* the item style.
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_class_update(Eo *obj, const Elm_Gengrid_Item_Class *itc);
*
* @since 1.18
*
- * @ingroup Elm_Gengrid_Item
+ * @ingroup Elm_Gengrid_Item_Group
*/
EOAPI void elm_obj_gengrid_item_all_contents_unset(Eo *obj, Eina_List **l);
#endif
/**
+ * @defgroup Elm_Gengrid_Item_Group
+ * @ingroup Elm_Gengrid_Group
+ */
+
+/**
* @brief Get the previous item in a gengrid widget's internal list of items,
* given a handle to one of those items.
*
* @see elm_object_item_del()
* @see elm_gengrid_clear()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent);
* @return The item stored in @p obj at position @p nth or @c NULL, if there's
* no item with that index (and on errors)
*
- * @ingroup Genilst
+ * @ingroup Elm_Gengrid_Group
* @since 1.8
*/
EAPI Elm_Object_Item *elm_gengrid_nth_item_get(const Evas_Object *obj, unsigned int nth);
*
* @see elm_gengrid_scroller_policy_get()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EINA_DEPRECATED EAPI void elm_gengrid_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v);
*
* @see elm_gengrid_scroller_policy_set()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EINA_DEPRECATED EAPI void elm_gengrid_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v);
*
* @see elm_scroller_bounce_set()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
*
* @see elm_scroller_bounce_get()
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
* @param[in] h_pagesize Page size horizontal
* @param[in] v_pagesize Page size vertical
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_page_size_set(Evas_Object *obj, int h_pagesize, int v_pagesize);
* @param[in] h_pagerel Page relation horizontal
* @param[in] v_pagerel Page relation vertical
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
* @param[out] h_pagerel Page relation horizontal
* @param[out] v_pagerel Page relation vertical
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
* @param[in] disabled Use @c true to disable mouse wheel or @c false to enable
* it.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI void elm_gengrid_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled);
*
* @return Use @c true to disable mouse wheel or @c false to enable it.
*
- * @ingroup Elm_Gengrid
+ * @ingroup Elm_Gengrid_Group
*/
EAPI Eina_Bool elm_gengrid_wheel_disabled_get(const Evas_Object *obj);
/**
- * @defgroup Elm_Genlist Genlist (Generic list)
+ * @defgroup Elm_Genlist_Group Genlist (Generic list)
* @ingroup Elementary
*
* @image html genlist_inheritance_tree.png
*/
/**
- * @addtogroup Elm_Genlist
+ * @addtogroup Elm_Genlist_Group
* @{
*/
* @see elm_genlist_item_class_free()
* @see elm_genlist_item_append()
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI Elm_Genlist_Item_Class *elm_genlist_item_class_new(void);
* @see elm_genlist_item_class_ref()
* @see elm_genlist_item_class_unref()
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_class_free(Elm_Genlist_Item_Class *itc);
*
* @see elm_genlist_item_class_unref()
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_class_ref(Elm_Genlist_Item_Class *itc);
* @see elm_genlist_item_class_ref()
* @see elm_genlist_item_class_free()
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_class_unref(Elm_Genlist_Item_Class *itc);
* In order to set a content or something else as a tooltip, look at
* elm_genlist_item_tooltip_content_cb_set().
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_tooltip_text_set(Elm_Object_Item *it, const char *text);
* In order to set just a text as a tooltip, look at
* elm_genlist_item_tooltip_text_set().
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_tooltip_content_cb_set(Elm_Object_Item *it, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
*
* @see elm_genlist_item_tooltip_content_cb_set()
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_tooltip_unset(Elm_Object_Item *it);
*
* @see elm_genlist_item_tooltip_style_get()
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_tooltip_style_set(Elm_Object_Item *it, const char *style);
*
* @see elm_genlist_item_tooltip_style_set() for more details
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Object_Item *it);
* @see elm_genlist_item_cursor_get()
* @see elm_genlist_item_cursor_unset()
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_cursor_set(Elm_Object_Item *it, const char *cursor);
* @see elm_genlist_item_cursor_set() for more details
* @see elm_genlist_item_cursor_unset()
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI const char *elm_genlist_item_cursor_get(const Elm_Object_Item *it);
* @see elm_object_cursor_unset()
* @see elm_genlist_item_cursor_set() for more details
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_cursor_unset(Elm_Object_Item *it);
* @see elm_genlist_item_cursor_engine_only_set()
* @see elm_genlist_item_cursor_style_get()
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_cursor_style_set(Elm_Object_Item *it, const char *style);
*
* @see elm_genlist_item_cursor_style_set() for more details
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Object_Item *it);
* @note By default, cursors will only be looked for between those
* provided by the rendering engine.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Object_Item *it, Eina_Bool engine_only);
*
* @see elm_genlist_item_cursor_engine_only_set(), for more details
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Object_Item *it);
#endif
/** Elementary genlist class
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_CLASS elm_genlist_class_get()
* @param[in] homogeneous Assume the items within the genlist are of the same
* height and width. Default is @c false.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_homogeneous_set(Eo *obj, Eina_Bool homogeneous);
* @return Assume the items within the genlist are of the same height and
* width. Default is @c false.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Eina_Bool elm_obj_genlist_homogeneous_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] mode The select mode.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_select_mode_set(Eo *obj, Elm_Object_Select_Mode mode);
*
* @return The select mode.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Object_Select_Mode elm_obj_genlist_select_mode_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] enabled The tree effect status.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_focus_on_selection_set(Eo *obj, Eina_Bool enabled);
*
* @return The tree effect status.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Eina_Bool elm_obj_genlist_focus_on_selection_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] timeout Timeout in seconds. Default is elm config value (1.0).
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_longpress_timeout_set(Eo *obj, double timeout);
*
* @return Timeout in seconds. Default is elm config value (1.0).
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI double elm_obj_genlist_longpress_timeout_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] multi Multi-select enable/disable. Default is disabled.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_multi_select_set(Eo *obj, Eina_Bool multi);
*
* @return Multi-select enable/disable. Default is disabled.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Eina_Bool elm_obj_genlist_multi_select_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] reorder_mode The reorder mode.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_reorder_mode_set(Eo *obj, Eina_Bool reorder_mode);
*
* @return The reorder mode.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Eina_Bool elm_obj_genlist_reorder_mode_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] decorated The decorate mode status.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_decorate_mode_set(Eo *obj, Eina_Bool decorated);
*
* @return The decorate mode status.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Eina_Bool elm_obj_genlist_decorate_mode_get(const Eo *obj);
*
* @since 1.8
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_multi_select_mode_set(Eo *obj, Elm_Object_Multi_Select_Mode mode);
*
* @since 1.8
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Object_Multi_Select_Mode elm_obj_genlist_multi_select_mode_get(const Eo *obj);
* @param[in] count Maximum number of items within an item block. Default is
* 32.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_block_count_set(Eo *obj, int count);
*
* @return Maximum number of items within an item block. Default is 32.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI int elm_obj_genlist_block_count_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] enabled The tree effect status.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_tree_effect_enabled_set(Eo *obj, Eina_Bool enabled);
*
* @return The tree effect status.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Eina_Bool elm_obj_genlist_tree_effect_enabled_get(const Eo *obj);
* @param[in] highlight @c true to enable highlighting or @c false to disable
* it.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_highlight_mode_set(Eo *obj, Eina_Bool highlight);
*
* @return @c true to enable highlighting or @c false to disable it.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Eina_Bool elm_obj_genlist_highlight_mode_get(const Eo *obj);
* @param[in] mode The mode to use (one of @ref ELM_LIST_SCROLL or
* @ref ELM_LIST_LIMIT).
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_mode_set(Eo *obj, Elm_List_Mode mode);
* @return The mode to use (one of @ref ELM_LIST_SCROLL or
* @ref ELM_LIST_LIMIT).
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_List_Mode elm_obj_genlist_mode_get(const Eo *obj);
* @return The active item for that current mode. Or @c null if no item is
* activated with any mode.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_decorated_item_get(const Eo *obj);
*
* @return The selected item, or @c null if none is selected.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_selected_item_get(const Eo *obj);
*
* @return The first item or @c null.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_first_item_get(const Eo *obj);
*
* @return List of realized items
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Eina_List *elm_obj_genlist_realized_items_get(const Eo *obj) EINA_WARN_UNUSED_RESULT;
*
* @return List of selected items
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI const Eina_List *elm_obj_genlist_selected_items_get(const Eo *obj);
*
* @return Last item in list
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_last_item_get(const Eo *obj);
*
* @return Handle to inserted item
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_item_insert_before(Eo *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Widget_Item *parent, Elm_Widget_Item *before_it, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
* To update just one item, use @ref elm_genlist_item_update.
* @param[in] obj The object.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_realized_items_update(Eo *obj);
*
* @return Handle to inserted item
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_item_insert_after(Eo *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Widget_Item *parent, Elm_Widget_Item *after_it, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
*
* @return Item at position
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_at_xy_item_get(const Eo *obj, int x, int y, int *posret);
* @param[in] obj The object.
* @param[in] key Filter key
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_filter_set(Eo *obj, void *key);
*
* @return Iterator on genlist
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Eina_Iterator *elm_obj_genlist_filter_iterator_new(Eo *obj);
*
* @since 1.18
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI unsigned int elm_obj_genlist_filtered_items_count(const Eo *obj);
*
* @return Item in list
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI unsigned int elm_obj_genlist_items_count(const Eo *obj);
*
* @return Handle to prepended item
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_item_prepend(Eo *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Widget_Item *parent, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
* This removes (and deletes) all items in @c obj, leaving it empty.
* @param[in] obj The object.
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI void elm_obj_genlist_clear(Eo *obj);
*
* @return Handle to appended item
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_item_append(Eo *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Widget_Item *parent, Elm_Genlist_Item_Type type, Evas_Smart_Cb func, const void *func_data);
*
* @return Handle to inserted item
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_item_sorted_insert(Eo *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Widget_Item *parent, Elm_Genlist_Item_Type type, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
*
* @since 1.11
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_search_by_text_item_get(Eo *obj, Elm_Widget_Item *item_to_search_from, const char *part_name, const char *pattern, Elm_Glob_Match_Flags flags);
/** Called when genlist item got focus
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_ITEM_FOCUSED (&(_ELM_GENLIST_EVENT_ITEM_FOCUSED))
/** Called when genlist item lost focus
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_ITEM_UNFOCUSED (&(_ELM_GENLIST_EVENT_ITEM_UNFOCUSED))
/** Called when vertical bar is dragged
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_VBAR_DRAG (&(_ELM_GENLIST_EVENT_VBAR_DRAG))
/** Called when vertical bar is pressed
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_VBAR_PRESS (&(_ELM_GENLIST_EVENT_VBAR_PRESS))
/** Called when vertical bar is no longer pressed
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_VBAR_UNPRESS (&(_ELM_GENLIST_EVENT_VBAR_UNPRESS))
/** Called when horizontal bar is dragged
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_HBAR_DRAG (&(_ELM_GENLIST_EVENT_HBAR_DRAG))
/** Called when horizontal bar is pressed
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_HBAR_PRESS (&(_ELM_GENLIST_EVENT_HBAR_PRESS))
/** Called when horizontal bar is no longer pressed
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_HBAR_UNPRESS (&(_ELM_GENLIST_EVENT_HBAR_UNPRESS))
/** Called when top edge is reached
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_EDGE_TOP (&(_ELM_GENLIST_EVENT_EDGE_TOP))
/** Called when bottom edge is reached
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_EDGE_BOTTOM (&(_ELM_GENLIST_EVENT_EDGE_BOTTOM))
/** Called when left edge is reached
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_EDGE_LEFT (&(_ELM_GENLIST_EVENT_EDGE_LEFT))
/** Called when right edge is reached
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_EDGE_RIGHT (&(_ELM_GENLIST_EVENT_EDGE_RIGHT))
/** Called when genlist item moved
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_MOVED (&(_ELM_GENLIST_EVENT_MOVED))
/** Called when genlist item moved before
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_MOVED_BEFORE (&(_ELM_GENLIST_EVENT_MOVED_BEFORE))
/** Called when genlist item moved after
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_MOVED_AFTER (&(_ELM_GENLIST_EVENT_MOVED_AFTER))
/** Called when swipe is detected
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_SWIPE (&(_ELM_GENLIST_EVENT_SWIPE))
/** Called when multitouch pinch in detected
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_MULTI_PINCH_IN (&(_ELM_GENLIST_EVENT_MULTI_PINCH_IN))
/** Called when multitouch pinch out detected
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_MULTI_PINCH_OUT (&(_ELM_GENLIST_EVENT_MULTI_PINCH_OUT))
/** Called when multitouch swipe down detected
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_MULTI_SWIPE_DOWN (&(_ELM_GENLIST_EVENT_MULTI_SWIPE_DOWN))
/** Called when multitouch swipe up detected
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_MULTI_SWIPE_UP (&(_ELM_GENLIST_EVENT_MULTI_SWIPE_UP))
/** Called when multitouch swipe right detected
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_MULTI_SWIPE_RIGHT (&(_ELM_GENLIST_EVENT_MULTI_SWIPE_RIGHT))
/** Called when multitouch swipe left detected
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_MULTI_SWIPE_LEFT (&(_ELM_GENLIST_EVENT_MULTI_SWIPE_LEFT))
/** Called when genlist is released
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_RELEASED (&(_ELM_GENLIST_EVENT_RELEASED))
/** called when genlist is activated
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_ACTIVATED (&(_ELM_GENLIST_EVENT_ACTIVATED))
/** Called when genlist is highlighted
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_HIGHLIGHTED (&(_ELM_GENLIST_EVENT_HIGHLIGHTED))
/** Called when genlist is no longer highlighted
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_UNHIGHLIGHTED (&(_ELM_GENLIST_EVENT_UNHIGHLIGHTED))
/** Called when genlist is realized
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_REALIZED (&(_ELM_GENLIST_EVENT_REALIZED))
/** Called when genlist is unrealized
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_UNREALIZED (&(_ELM_GENLIST_EVENT_UNREALIZED))
/** Called when contract is requested
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_CONTRACT_REQUEST (&(_ELM_GENLIST_EVENT_CONTRACT_REQUEST))
/** Called when expand is requested
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_EXPAND_REQUEST (&(_ELM_GENLIST_EVENT_EXPAND_REQUEST))
/** called when genlist is contracted
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_CONTRACTED (&(_ELM_GENLIST_EVENT_CONTRACTED))
/** Called when genlist is expanded
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_EXPANDED (&(_ELM_GENLIST_EVENT_EXPANDED))
/** Called when genlist index updated
* @return Efl_Object *
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_INDEX_UPDATE (&(_ELM_GENLIST_EVENT_INDEX_UPDATE))
/** Called when genlist tree effect finished
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_TREE_EFFECT_FINISHED (&(_ELM_GENLIST_EVENT_TREE_EFFECT_FINISHED))
/** Called when genlist filter is done
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
#define ELM_GENLIST_EVENT_FILTER_DONE (&(_ELM_GENLIST_EVENT_FILTER_DONE))
#endif
-/** Elementary genlist item class
+/**
+ * Elementary genlist item class
+ *
+ * @defgroup Elm_Genlist_Item_Group
+ * @ingroup Elm_Genlist_Group
+ */
+
+/**
+ * @brief Get genlist item class
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
#define ELM_GENLIST_ITEM_CLASS elm_genlist_item_class_get()
*
* @return The item before @c item, or @c null if there's none (and on errors).
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_item_prev_get(const Eo *obj);
*
* @return The item after @c item, or @c null if there's none (and on errors).
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_item_next_get(const Eo *obj);
*
* @return The parent of the item or @c null if it has no parent.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI Elm_Widget_Item *elm_obj_genlist_item_parent_item_get(const Eo *obj);
*
* @since 1.9
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI const Eina_List *elm_obj_genlist_item_subitems_get(const Eo *obj);
* @param[in] selected The selected state ($true selected, @c false not
* selected).
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_selected_set(Eo *obj, Eina_Bool selected);
*
* @return The selected state ($true selected, @c false not selected).
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI Eina_Bool elm_obj_genlist_item_selected_get(const Eo *obj);
* @param[in] expanded The expanded state ($true expanded, @c false not
* expanded).
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_expanded_set(Eo *obj, Eina_Bool expanded);
*
* @return The expanded state ($true expanded, @c false not expanded).
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI Eina_Bool elm_obj_genlist_item_expanded_get(const Eo *obj);
*
* @return The depth of expanded item.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI int elm_obj_genlist_item_expanded_depth_get(const Eo *obj);
*
* @return Genlist Item class for the given item.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI const Elm_Genlist_Item_Class *elm_obj_genlist_item_class_get(const Eo *obj);
*
* @return The position inside the list of item.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI int elm_obj_genlist_item_index_get(const Eo *obj);
*
* @return Name of the item's decorate mode.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI const char *elm_obj_genlist_item_decorate_mode_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] flip The flip mode.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_flip_set(Eo *obj, Eina_Bool flip);
*
* @return The flip mode.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI Eina_Bool elm_obj_genlist_item_flip_get(const Eo *obj);
* @param[in] obj The object.
* @param[in] mode The selected mode.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_select_mode_set(Eo *obj, Elm_Object_Select_Mode mode);
*
* @return The selected mode.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI Elm_Object_Select_Mode elm_obj_genlist_item_select_mode_get(const Eo *obj);
*
* @return Item type.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI Elm_Genlist_Item_Type elm_obj_genlist_item_type_get(const Eo *obj);
* @param[in] pin The item pin state state ($true pin item, @c false unpin
* item).
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_pin_set(Eo *obj, Eina_Bool pin);
*
* @return The item pin state state ($true pin item, @c false unpin item).
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI Eina_Bool elm_obj_genlist_item_pin_get(const Eo *obj);
*
* @since 1.9
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI unsigned int elm_obj_genlist_item_subitems_count(Eo *obj);
* given item @c it.
* @param[in] obj The object.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_subitems_clear(Eo *obj);
/** Promote an item to the top of the list.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_promote(Eo *obj);
/** Demote an item to the end of the list.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_demote(Eo *obj);
* @param[in] type The position to bring in, the given item to. @ref
* Elm_Genlist_Item_Scrollto_Type.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_show(Eo *obj, Elm_Genlist_Item_Scrollto_Type type);
* @param[in] type The position to bring in, the given item to. @ref
* Elm_Genlist_Item_Scrollto_Type.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_bring_in(Eo *obj, Elm_Genlist_Item_Scrollto_Type type);
* @param[in] obj The object.
* @param[out] l The contents list to return.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_all_contents_unset(Eo *obj, Eina_List **l);
* elm_genlist_item_fields_update.
* @param[in] obj The object.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_update(Eo *obj);
* @param[in] parts The name of item's part.
* @param[in] itf The type of item's part type.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_fields_update(Eo *obj, const char *parts, Elm_Genlist_Item_Field_Type itf);
* @param[in] obj The object.
* @param[in] itc The item class for the item.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_class_update(Eo *obj, const Elm_Genlist_Item_Class *itc);
* @param[in] decorate_it_type Mode name.
* @param[in] decorate_it_set Boolean to define set or unset mode.
*
- * @ingroup Elm_Genlist_Item
+ * @ingroup Elm_Genlist_Item_Group
*/
EOAPI void elm_obj_genlist_item_decorate_mode_set(Eo *obj, const char *decorate_it_type, Eina_Bool decorate_it_set);
#endif
/**
+ * @defgroup Elm_Genlist_Item_Group
+ * @ingroup Elm_Genlist_Group
+ */
+
+/**
* @brief Get the previous item in a genlist widget's internal list of items,
* given a handle to one of those items.
*
* @see elm_object_item_del()
* @see elm_genlist_clear()
*
- * @ingroup Elm_Genlist
+ * @ingroup Elm_Genlist_Group
*/
EAPI Evas_Object *elm_genlist_add(Evas_Object *parent);
* @return The item stored in @p obj at position @p nth or @c NULL, if there's
* no item with that index (and on errors)
*
- * @ingroup Genilst
+ * @ingroup Elm_Genlist_Group
* @since 1.8
*/
EAPI Elm_Object_Item *
/**
- * @defgroup Elm_Gesture_Layer Gesture Layer
+ * @defgroup Elm_Gesture_Layer_Group Gesture Layer
* @ingroup Elementary
*
* @image html gesture_layer_inheritance_tree.png
* This does not activate the gesture layer. You have to
* call elm_gesture_layer_attach() in order to 'activate' gesture-layer.
*
- * @ingroup Elm_Gesture_Layer
+ * @ingroup Elm_Gesture_Layer_Group
*/
EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent);
*
* @see elm_gesture_layer_tap_longpress_cb_del
* @since 1.8
- * @ingroup Elm_Gesture_Layer
+ * @ingroup Elm_Gesture_Layer_Group
*/
EAPI void elm_gesture_layer_tap_longpress_cb_add(Evas_Object *obj, Elm_Gesture_State state, Elm_Gesture_Event_Cb cb, void *data);
*
* @see elm_gesture_layer_tap_longpress_cb_add
* @since 1.8
- * @ingroup Elm_Gesture_Layer
+ * @ingroup Elm_Gesture_Layer_Group
*/
EAPI void elm_gesture_layer_tap_longpress_cb_del(Evas_Object *obj, Elm_Gesture_State state, Elm_Gesture_Event_Cb cb, void *data);
projects / platform / upstream / efl.git / commitdiff