From e561bb6980e0a5e6c2674b0e380dbbd6a7b62e4d Mon Sep 17 00:00:00 2001 From: "Myoungwoon Roy, Kim" Date: Wed, 1 Jul 2020 01:14:53 +0000 Subject: [PATCH] docs: Correct the wrong group name in Edje and Elementary I had found wrong group name in edje and box, ctxpopup, entry, gengrid, genlist, gesture and fixed them. Reviewed-by: Stefan Schmidt Differential Revision: https://phab.enlightenment.org/D12036 --- src/lib/edje/Edje_Legacy.h | 318 ++++++++++-------- src/lib/elementary/elc_ctxpopup.h | 8 +- src/lib/elementary/elc_ctxpopup_legacy.h | 2 +- src/lib/elementary/elm_box.h | 2 +- src/lib/elementary/elm_box_common.h | 2 +- src/lib/elementary/elm_box_eo.h | 40 +-- src/lib/elementary/elm_box_legacy.h | 4 +- src/lib/elementary/elm_config.h | 12 +- src/lib/elementary/elm_ctxpopup_eo.h | 46 +-- src/lib/elementary/elm_ctxpopup_eo.legacy.h | 2 +- src/lib/elementary/elm_ctxpopup_item_eo.h | 22 +- src/lib/elementary/elm_deprecated.h | 10 +- src/lib/elementary/elm_entry.h | 2 +- src/lib/elementary/elm_entry_common.h | 2 +- src/lib/elementary/elm_entry_eo.h | 240 ++++++------- src/lib/elementary/elm_entry_legacy.h | 12 +- src/lib/elementary/elm_general.h | 10 +- src/lib/elementary/elm_gengrid.h | 4 +- src/lib/elementary/elm_gengrid_common.h | 32 +- src/lib/elementary/elm_gengrid_eo.h | 114 +++---- src/lib/elementary/elm_gengrid_eo.legacy.h | 2 +- src/lib/elementary/elm_gengrid_item_eo.h | 46 +-- .../elementary/elm_gengrid_item_eo.legacy.h | 5 + src/lib/elementary/elm_gengrid_legacy.h | 22 +- src/lib/elementary/elm_genlist.h | 4 +- src/lib/elementary/elm_genlist_common.h | 32 +- src/lib/elementary/elm_genlist_eo.h | 158 ++++----- src/lib/elementary/elm_genlist_item_eo.h | 72 ++-- .../elementary/elm_genlist_item_eo.legacy.h | 5 + src/lib/elementary/elm_genlist_legacy.h | 4 +- src/lib/elementary/elm_gesture_layer.h | 2 +- src/lib/elementary/elm_gesture_layer_legacy.h | 6 +- 32 files changed, 659 insertions(+), 583 deletions(-) diff --git a/src/lib/edje/Edje_Legacy.h b/src/lib/edje/Edje_Legacy.h index f8c49fd044..a571ea297e 100644 --- a/src/lib/edje/Edje_Legacy.h +++ b/src/lib/edje/Edje_Legacy.h @@ -48,6 +48,9 @@ * @note Before creating the first Edje object in your code, remember * to initialize the library, with edje_init(), or unexpected behavior * might occur. + * + * @ingroup Edje_Object_Group + * */ EAPI Evas_Object *edje_object_add (Evas *evas); @@ -67,6 +70,9 @@ EAPI Evas_Object *edje_object_add (Evas *evas); * will remove it (if it was issued before). * * @return @c false if obj was not a valid Edje object otherwise @c true + * + * @ingroup Edje_Object_Group + * */ EAPI Eina_Bool edje_object_preload(Evas_Object *obj, Eina_Bool cancel); @@ -110,6 +116,9 @@ EAPI Eina_Bool edje_object_preload(Evas_Object *obj, Eina_Bool cancel); * @param[in] func The callback function to be executed when the signal is * emitted. * @param[in] data A pointer to data to pass in to func. + * + * @ingroup Edje_Object_Group + * */ EAPI void edje_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data); @@ -125,6 +134,9 @@ EAPI void edje_object_signal_callback_add(Evas_Object *obj, const char *emission * * @param[in] emission The signal's "emission" string * @param[in] source The signal's "source" string + * + * @ingroup Edje_Object_Group + * */ EAPI void edje_object_signal_emit(Evas_Object *obj, const char *emission, const char *source); @@ -146,6 +158,8 @@ EAPI void edje_object_signal_emit(Evas_Object *obj, const char *emission, const * @see edje_object_signal_callback_add(). * @see edje_object_signal_callback_del_full(). * + * @ingroup Edje_Object_Group + * */ EAPI void *edje_object_signal_callback_del (Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func); @@ -171,6 +185,8 @@ EAPI void *edje_object_signal_callback_del (Evas_Object *obj, const char * @see edje_object_signal_callback_add(). * @see edje_object_signal_callback_del(). * + * @ingroup Edje_Object_Group + * */ EAPI void *edje_object_signal_callback_del_full(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data); @@ -207,6 +223,9 @@ typedef enum * #EDJE_LOAD_ERROR_RESOURCE_ALLOCATION_FAILED - #EDJE_LOAD_ERROR_CORRUPT_FILE * - #EDJE_LOAD_ERROR_UNKNOWN_FORMAT - #EDJE_LOAD_ERROR_INCOMPATIBLE_FILE - * #EDJE_LOAD_ERROR_UNKNOWN_COLLECTION - #EDJE_LOAD_ERROR_RECURSIVE_REFERENCE + * + * @ingroup Edje_Object_Group + * */ EAPI Edje_Load_Error edje_object_load_error_get(const Evas_Object *obj); @@ -223,6 +242,9 @@ EAPI Edje_Load_Error edje_object_load_error_get(const Evas_Object *obj); * edje_object_load_error_get(). The function in question is meant * to be used in conjunction with the latter, for pretty-printing any * possible error cause. + * + * @ingroup Edje_Object_Group + * */ EAPI const char *edje_load_error_str (Edje_Load_Error error); @@ -248,7 +270,7 @@ EAPI const char *edje_load_error_str (Edje_Load_Error error); * * @return @c true on success, @c false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI Eina_Bool edje_object_part_geometry_get(const Evas_Object *obj, const char * part, int *x, int *y, int *w, int *h); @@ -260,7 +282,7 @@ EAPI Eina_Bool edje_object_part_geometry_get(const Evas_Object *obj, const char * * @return The part state: "default" for the default state "" for other states * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI const char *edje_object_part_state_get(const Evas_Object *obj, const char * part, double *val_ret); @@ -286,7 +308,7 @@ EAPI const char *edje_object_part_state_get(const Evas_Object *obj, const char * * @return A pointer to the Evas object implementing the given part, @c null on * failure (e.g. the given part doesn't exist) * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI const Efl_Canvas_Object *edje_object_part_object_get(const Evas_Object *obj, const char * part); @@ -307,7 +329,7 @@ EAPI const Efl_Canvas_Object *edje_object_part_object_get(const Evas_Object *obj * * @param[in] update Whether or not update the size hints. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_update_hints_set(Evas_Object *obj, Eina_Bool update); @@ -328,7 +350,7 @@ EAPI void edje_object_update_hints_set(Evas_Object *obj, Eina_Bool update); * * @return Whether or not update the size hints. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI Eina_Bool edje_object_update_hints_get(const Evas_Object *obj); @@ -341,7 +363,7 @@ EAPI Eina_Bool edje_object_update_hints_get(const Evas_Object *obj); * @param[out] minw The minimum required width (return value) * @param[out] minh The minimum required height (return value) * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_size_min_calc(Evas_Object *obj, int *minw, int *minh); @@ -368,7 +390,7 @@ EAPI void edje_object_size_min_calc(Evas_Object *obj, int *minw, int *minh); * @param[in] restrictedh The minimum height constraint as input, @c minh can * not be lower than this * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_size_min_restricted_calc(Evas_Object *obj, int *minw, int *minh, int restrictedw, int restrictedh); @@ -392,7 +414,7 @@ EAPI void edje_object_size_min_restricted_calc(Evas_Object *obj, int *minw, int * * @return @c true on success, @c false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI Eina_Bool edje_object_parts_extends_calc(Evas_Object *obj, int *x, int *y, int *w, int *h); @@ -403,7 +425,7 @@ EAPI Eina_Bool edje_object_parts_extends_calc(Evas_Object *obj, int *x, int *y, * * See also @ref edje_object_freeze and @ref edje_object_thaw. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_calc_force(Evas_Object *obj); @@ -417,7 +439,7 @@ EAPI void edje_object_calc_force(Evas_Object *obj); * * @return The frozen state or 0 on error * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI int edje_object_freeze(Evas_Object *obj); @@ -433,7 +455,7 @@ EAPI int edje_object_freeze(Evas_Object *obj); * * @return The frozen state or 0 if the object is not frozen or on error. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI int edje_object_thaw(Evas_Object *obj); @@ -657,7 +679,7 @@ EAPI void edje_object_message_signal_recursive_process(Evas_Object *obj); */ /** - * @addgroup Edje_Object + * @addgroup Edje_Object_Group * * @{ */ @@ -671,7 +693,7 @@ EAPI void edje_object_message_signal_recursive_process(Evas_Object *obj); * @return @ref EDJE_EXTERNAL_PARAM_TYPE_MAX on errors, or another value from * @ref Edje_External_Param_Type on success. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Edje_External_Param_Type edje_object_part_external_param_type_get(const Evas_Object *obj, const char *part, const char * param); @@ -700,7 +722,7 @@ EAPI Edje_External_Param_Type edje_object_part_external_param_type_get(const Eva * * @return @c true if everything went fine, @c false on errors. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_external_param_set(Evas_Object *obj, const char *part, const Edje_External_Param *param); @@ -726,7 +748,7 @@ EAPI Eina_Bool edje_object_part_external_param_set(Evas_Object *obj, const char * information, @c false on errors and param member values are not set or * valid. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_external_param_get(const Evas_Object *obj, const char *part, Edje_External_Param *param); @@ -749,7 +771,7 @@ EAPI Eina_Bool edje_object_part_external_param_get(const Evas_Object *obj, const * @return The externally created object, or @c null if there is none or part * is not an external. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Evas_Object *edje_object_part_external_object_get(const Evas_Object *obj, const char * part); @@ -765,7 +787,7 @@ EAPI Evas_Object *edje_object_part_external_object_get(const Evas_Object *obj, c * * @return Canvas object * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Evas_Object *edje_object_part_external_content_get(const Evas_Object *obj, const char *part, const char *content); @@ -783,6 +805,8 @@ EAPI Evas_Object *edje_object_part_external_content_get(const Evas_Object *obj, * * This sets the minimum size restriction for the object. * + * @ingroup Edje_Object_Group + * */ EINA_DEPRECATED EAPI void edje_extern_object_min_size_set (Evas_Object *obj, Evas_Coord minw, Evas_Coord minh); @@ -796,6 +820,8 @@ EINA_DEPRECATED EAPI void edje_extern_object_min_size_set (Evas_Object * * * This sets the maximum size restriction for the object. * + * @ingroup Edje_Object_Group + * */ EINA_DEPRECATED EAPI void edje_extern_object_max_size_set (Evas_Object *obj, Evas_Coord maxw, Evas_Coord maxh); @@ -813,6 +839,8 @@ EINA_DEPRECATED EAPI void edje_extern_object_max_size_set (Evas_Object * * ASPECT and the object may be scaled to be larger or smaller, but * retaining the relative scale of both aspect width and height. * + * @ingroup Edje_Object_Group + * */ EINA_DEPRECATED EAPI void edje_extern_object_aspect_set (Evas_Object *obj, Edje_Aspect_Control aspect, Evas_Coord aw, Evas_Coord ah); @@ -847,7 +875,7 @@ EINA_DEPRECATED EAPI void edje_extern_object_aspect_set (Evas_Object * * @param[in] group The name of the group, in @p file, which implements an Edje object * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI Eina_Bool edje_object_file_set(Evas_Object *obj, const char *file, const char *group); @@ -869,7 +897,7 @@ EAPI Eina_Bool edje_object_file_set(Evas_Object *obj, const char *file, const ch * @param[out] group The name of the group, in @p file, which implements an Edje object * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_file_get(const Evas_Object *obj, const char **file, const char **group); @@ -905,7 +933,7 @@ EAPI void edje_object_file_get(const Evas_Object *obj, const char **file, const * @param[in] group The name of the group, in @p file, which implements an Edje object * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group * */ EAPI Eina_Bool edje_object_mmap_set(Evas_Object *obj, const Eina_File *file, const char *group); @@ -941,7 +969,7 @@ EAPI Eina_Bool edje_object_mmap_set(Evas_Object *obj, const Eina_File *file, con * * @param[in] obj_swallow The object to occupy that part * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_swallow(Evas_Object *obj, const char *part, Evas_Object *obj_swallow); @@ -952,7 +980,7 @@ EAPI Eina_Bool edje_object_part_swallow(Evas_Object *obj, const char *part, Evas * * @return The swallowed object, or @c null if there is none. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Evas_Object *edje_object_part_swallow_get(const Evas_Object *obj, const char *part); @@ -967,7 +995,7 @@ EAPI Evas_Object *edje_object_part_swallow_get(const Evas_Object *obj, const cha * * @param[in] obj_swallow The swallowed object * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_unswallow(Evas_Object *obj, Evas_Object *obj_swallow); @@ -978,7 +1006,7 @@ EAPI void edje_object_part_unswallow(Evas_Object *obj, Evas_Object *obj_swallow) * * @since 1.7.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_List *edje_object_access_part_list_get(const Evas_Object *obj); @@ -996,7 +1024,7 @@ EAPI Eina_List *edje_object_access_part_list_get(const Evas_Object *obj); * * @return @c true: Successfully added. @c false: An error occurred. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_box_append(Evas_Object *obj, const char *part, Evas_Object *child); @@ -1014,7 +1042,7 @@ EAPI Eina_Bool edje_object_part_box_append(Evas_Object *obj, const char *part, E * * @return @c true: Successfully added. @c false: An error occurred. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child); @@ -1033,7 +1061,7 @@ EAPI Eina_Bool edje_object_part_box_prepend(Evas_Object *obj, const char *part, * * @return @c true: Successfully added. @c false: An error occurred. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference); @@ -1072,7 +1100,7 @@ EAPI Eina_Bool edje_object_part_box_insert_after(Evas_Object *obj, const char *p * * @return @c true: Successfully added. @c false: An error occurred. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos); @@ -1088,7 +1116,7 @@ EAPI Eina_Bool edje_object_part_box_insert_at(Evas_Object *obj, const char *part * * @return Pointer to the object removed, or @c null. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Evas_Object *edje_object_part_box_remove_at(Evas_Object *obj, const char *part, unsigned int pos); @@ -1104,7 +1132,7 @@ EAPI Evas_Object *edje_object_part_box_remove_at(Evas_Object *obj, const char *p * * @return Pointer to the object removed, or @c null. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Evas_Object *edje_object_part_box_remove(Evas_Object *obj, const char *part, Evas_Object *child); @@ -1121,7 +1149,7 @@ EAPI Evas_Object *edje_object_part_box_remove(Evas_Object *obj, const char *part * * @return 1: Successfully cleared. 0: An error occurred. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear); @@ -1138,7 +1166,7 @@ EAPI Eina_Bool edje_object_part_box_remove_all(Evas_Object *obj, const char *par * * @return @c true object was added, @c false on failure * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_table_pack(Evas_Object *obj, const char *part, Evas_Object *child_obj, unsigned short col, unsigned short row, unsigned short colspan, unsigned short rowspan); @@ -1151,7 +1179,7 @@ EAPI Eina_Bool edje_object_part_table_pack(Evas_Object *obj, const char *part, E * * @return @c true object removed, @c false on failure * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj); @@ -1165,7 +1193,7 @@ EAPI Eina_Bool edje_object_part_table_unpack(Evas_Object *obj, const char *part, * * @return @c true get some data, @c false on failure * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_table_col_row_size_get(const Evas_Object *obj, const char *part, int *cols, int *rows); @@ -1177,7 +1205,7 @@ EAPI Eina_Bool edje_object_part_table_col_row_size_get(const Evas_Object *obj, c * * @return The child Efl.Canvas.Object * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Evas_Object *edje_object_part_table_child_get(const Evas_Object *obj, const char *part, unsigned int col, unsigned int row); @@ -1191,7 +1219,7 @@ EAPI Evas_Object *edje_object_part_table_child_get(const Evas_Object *obj, const * * @return @c true clear the table, @c false on failure * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear); @@ -1225,7 +1253,7 @@ EAPI Eina_Bool edje_object_part_table_clear(Evas_Object *obj, const char *part, * @param[in] b3 Shadow Blue value * @param[in] a3 Shadow Alpha value * - * @ingroup Edje_Object + * @ingroup Edje_Object_Color_Class */ EAPI Eina_Bool edje_object_color_class_set(Evas_Object *obj, const char * color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3); @@ -1257,7 +1285,7 @@ EAPI Eina_Bool edje_object_color_class_set(Evas_Object *obj, const char * color_ * * @return true if found or false if not found and all values are zeroed. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Color_Class */ EAPI Eina_Bool edje_object_color_class_get(const Evas_Object *obj, const char * color_class, int *r, int *g, int *b, int *a, int *r2, int *g2, int *b2, int *a2, int *r3, int *g3, int *b3, int *a3); @@ -1275,7 +1303,7 @@ EAPI Eina_Bool edje_object_color_class_get(const Evas_Object *obj, const char * * * @param[in] color_class The color class to be deleted. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Color_Class */ EAPI void edje_object_color_class_del(Evas_Object *obj, const char *color_class); @@ -1290,7 +1318,7 @@ EAPI void edje_object_color_class_del(Evas_Object *obj, const char *color_class) * * @since 1.17.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Color_Class */ EAPI Eina_Bool edje_object_color_class_clear(const Evas_Object *obj); @@ -1305,7 +1333,7 @@ EAPI Eina_Bool edje_object_color_class_clear(const Evas_Object *obj); * * @return @c true, on success or @c false, on error * - * @ingroup Edje_Object + * @ingroup Edje_Object_Text_Class */ EAPI Eina_Bool edje_object_text_class_set(Evas_Object *obj, const char * text_class, const char *font, Evas_Font_Size size); @@ -1322,7 +1350,7 @@ EAPI Eina_Bool edje_object_text_class_set(Evas_Object *obj, const char * text_cl * * @return @c true, on success or @c false, on error * - * @ingroup Edje_Object + * @ingroup Edje_Object_Text_Class */ EAPI Eina_Bool edje_object_text_class_get(const Evas_Object *obj, const char * text_class, const char **font, Evas_Font_Size *size); @@ -1339,7 +1367,7 @@ EAPI Eina_Bool edje_object_text_class_get(const Evas_Object *obj, const char * t * * @since 1.17 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Text_Class */ EAPI void edje_object_text_class_del(Evas_Object *obj, const char *text_class); @@ -1360,7 +1388,7 @@ EAPI void edje_object_text_class_del(Evas_Object *obj, const char *text_class); * * @since 1.17 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Size_Class */ EAPI Eina_Bool edje_object_size_class_set(Evas_Object *obj, const char * size_class, int minw, int minh, int maxw, int maxh); @@ -1381,7 +1409,7 @@ EAPI Eina_Bool edje_object_size_class_set(Evas_Object *obj, const char * size_cl * * @since 1.17 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Size_Class */ EAPI Eina_Bool edje_object_size_class_get(const Evas_Object *obj, const char * size_class, int *minw, int *minh, int *maxw, int *maxh); @@ -1398,7 +1426,7 @@ EAPI Eina_Bool edje_object_size_class_get(const Evas_Object *obj, const char * s * * @since 1.17 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Size_Class */ EAPI void edje_object_size_class_del(Evas_Object *obj, const char *size_class); @@ -1412,7 +1440,7 @@ EAPI void edje_object_size_class_del(Evas_Object *obj, const char *size_class); * @param[in] part The part name * @param[in] allow true to enable, false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_select_allow_set(const Evas_Object *obj, const char *part, Eina_Bool allow); @@ -1423,7 +1451,7 @@ EAPI void edje_object_part_text_select_allow_set(const Evas_Object *obj, const c * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_mirrored_set(Evas_Object *obj, Eina_Bool rtl); @@ -1436,7 +1464,7 @@ EAPI void edje_object_mirrored_set(Evas_Object *obj, Eina_Bool rtl); * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI Eina_Bool edje_object_mirrored_get(const Evas_Object *obj); @@ -1447,7 +1475,7 @@ EAPI Eina_Bool edje_object_mirrored_get(const Evas_Object *obj); * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_language_set(Evas_Object *obj, const char *language); @@ -1458,7 +1486,7 @@ EAPI void edje_object_language_set(Evas_Object *obj, const char *language); * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI const char *edje_object_language_get(const Evas_Object *obj); @@ -1482,7 +1510,7 @@ EAPI const char *edje_object_language_get(const Evas_Object *obj); * * @return @c true on success, @c false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Scale */ EAPI Eina_Bool edje_object_scale_set(Evas_Object *obj, double scale); @@ -1497,7 +1525,7 @@ EAPI Eina_Bool edje_object_scale_set(Evas_Object *obj, double scale); * @return The scaling factor (the default value is @0.0, meaning individual * scaling not set) * - * @ingroup Edje_Object + * @ingroup Edje_Object_Scale */ EAPI double edje_object_scale_get(const Evas_Object *obj); @@ -1511,7 +1539,7 @@ EAPI double edje_object_scale_get(const Evas_Object *obj); * @return The base_scale factor (the default value is @ 1.0, that means the * edc file is made based on scale 1.0. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Scale */ EAPI double edje_object_base_scale_get(const Evas_Object *obj); @@ -1772,7 +1800,7 @@ EAPI Eina_Bool edje_object_part_drag_page(Evas_Object *obj, const char *part, do * @param[in] part The part name * @param[in] text The text to set on that part * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_set(const Evas_Object *obj, const char *part, const char *text); @@ -1783,7 +1811,7 @@ EAPI Eina_Bool edje_object_part_text_set(const Evas_Object *obj, const char *par * * @return The text set on the part, @c null otherwise. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI const char * edje_object_part_text_get(const Evas_Object *obj, const char *part); @@ -1794,7 +1822,7 @@ EAPI const char * edje_object_part_text_get(const Evas_Object *obj, const char * * @param[in] part The part name * @param[in] cur The edje cursor to work on * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_cursor_begin_set(Evas_Object *obj, const char *part, Edje_Cursor cur); @@ -1805,7 +1833,7 @@ EAPI void edje_object_part_text_cursor_begin_set(Evas_Object *obj, const char *p * @param[in] part The part name * @param[in] cur The edje cursor to work on * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_cursor_end_set(Evas_Object *obj, const char *part, Edje_Cursor cur); @@ -1818,7 +1846,7 @@ EAPI void edje_object_part_text_cursor_end_set(Evas_Object *obj, const char *par * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_cursor_pos_set(Evas_Object *obj, const char * part, Edje_Cursor cur, int pos); @@ -1832,7 +1860,7 @@ EAPI void edje_object_part_text_cursor_pos_set(Evas_Object *obj, const char * pa * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI int edje_object_part_text_cursor_pos_get(const Evas_Object *obj, const char * part, Edje_Cursor cur); @@ -1848,7 +1876,7 @@ EAPI int edje_object_part_text_cursor_pos_get(const Evas_Object *obj, const char * * @return @c true on success, @c false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_cursor_coord_set(Evas_Object *obj, const char *part, Edje_Cursor cur, int x, int y); @@ -1859,7 +1887,7 @@ EAPI Eina_Bool edje_object_part_text_cursor_coord_set(Evas_Object *obj, const ch * @param[in] part The part name * @param[in] cur The edje cursor to work on * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_cursor_line_begin_set(Evas_Object *obj, const char *part, Edje_Cursor cur); @@ -1870,7 +1898,7 @@ EAPI void edje_object_part_text_cursor_line_begin_set(Evas_Object *obj, const ch * @param[in] part The part name * @param[in] cur The edje cursor to work on * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_cursor_line_end_set(Evas_Object *obj, const char *part, Edje_Cursor cur); @@ -1883,7 +1911,7 @@ EAPI void edje_object_part_text_cursor_line_end_set(Evas_Object *obj, const char * * @return @c true on success, @c false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_cursor_prev(Evas_Object *obj, const char *part, Edje_Cursor cur); @@ -1896,7 +1924,7 @@ EAPI Eina_Bool edje_object_part_text_cursor_prev(Evas_Object *obj, const char *p * * @return @c true on success, @c false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_cursor_next(Evas_Object *obj, const char *part, Edje_Cursor cur); @@ -1908,7 +1936,7 @@ EAPI Eina_Bool edje_object_part_text_cursor_next(Evas_Object *obj, const char *p * * @return @c true on success, @c false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_cursor_up(Evas_Object *obj, const char *part, Edje_Cursor cur); @@ -1920,7 +1948,7 @@ EAPI Eina_Bool edje_object_part_text_cursor_up(Evas_Object *obj, const char *par * * @return @c true on success, @c false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_cursor_down(Evas_Object *obj, const char *part, Edje_Cursor cur); @@ -1931,7 +1959,7 @@ EAPI Eina_Bool edje_object_part_text_cursor_down(Evas_Object *obj, const char *p * @param[in] src The cursor to copy from * @param[in] dst The cursor to copy to * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_cursor_copy(Evas_Object *obj, const char *part, Edje_Cursor src, Edje_Cursor dst); @@ -1947,7 +1975,7 @@ EAPI void edje_object_part_text_cursor_copy(Evas_Object *obj, const char *part, * @return The character string pointed to (may be a multi-byte utf8 sequence) * terminated by a null byte. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI char *edje_object_part_text_cursor_content_get(const Evas_Object *obj, const char * part, Edje_Cursor cur); @@ -1960,7 +1988,7 @@ EAPI char *edje_object_part_text_cursor_content_get(const Evas_Object *obj, cons * @param[out] w Cursor width * @param[out] h Cursor height * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_cursor_geometry_get(const Evas_Object *obj, const char * part, int *x, int *y, int *w, int *h); @@ -1974,7 +2002,7 @@ EAPI void edje_object_part_text_cursor_geometry_get(const Evas_Object *obj, cons * * @since 1.18.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_hide_visible_password(Evas_Object *obj, const char *part); @@ -1987,7 +2015,7 @@ EAPI Eina_Bool edje_object_part_text_hide_visible_password(Evas_Object *obj, con * * @return @c true if the cursor points to a format, @c false otherwise. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_cursor_is_format_get(const Evas_Object *obj, const char * part, Edje_Cursor cur); @@ -2001,7 +2029,7 @@ EAPI Eina_Bool edje_object_part_text_cursor_is_format_get(const Evas_Object *obj * @return @c true if the cursor points to a visible format, @c false * otherwise. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_cursor_is_visible_format_get(const Evas_Object *obj, const char * part, Edje_Cursor cur); @@ -2016,7 +2044,7 @@ EAPI Eina_Bool edje_object_part_text_cursor_is_visible_format_get(const Evas_Obj * @return The list of anchor rects (const Evas_Textblock_Rectangle *), do not * modify! Geometry is relative to entry part. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI const Eina_List *edje_object_part_text_anchor_geometry_get(const Evas_Object *obj, const char * part, const char * anchor); @@ -2029,7 +2057,7 @@ EAPI const Eina_List *edje_object_part_text_anchor_geometry_get(const Evas_Objec * * @return The list of anchors (const char *), do not modify! * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI const Eina_List *edje_object_part_text_anchor_list_get(const Evas_Object *obj, const char * part); @@ -2044,7 +2072,7 @@ EAPI const Eina_List *edje_object_part_text_anchor_list_get(const Evas_Object *o * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI const char *edje_object_part_text_style_user_peek(const Evas_Object *obj, const char *part); @@ -2058,7 +2086,7 @@ EAPI const char *edje_object_part_text_style_user_peek(const Evas_Object *obj, c * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_style_user_push(Evas_Object *obj, const char *part, const char *style); @@ -2069,7 +2097,7 @@ EAPI void edje_object_part_text_style_user_push(Evas_Object *obj, const char *pa * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_style_user_pop(Evas_Object *obj, const char *part); @@ -2087,7 +2115,7 @@ EAPI void edje_object_part_text_style_user_pop(Evas_Object *obj, const char *par * * @return $1 if item exists, $0 if not * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_item_geometry_get(const Evas_Object *obj, const char * part, const char * item, int *cx, int *cy, int *cw, int *ch); @@ -2100,7 +2128,7 @@ EAPI Eina_Bool edje_object_part_text_item_geometry_get(const Evas_Object *obj, c * * @return The list of items (const char *), do not modify! * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI const Eina_List *edje_object_part_text_item_list_get(const Evas_Object *obj, const char * part); @@ -2135,7 +2163,7 @@ EAPI const Eina_List *edje_object_part_text_item_list_get(const Evas_Object *obj * @param[in] func The callback function that will act as filter * @param[in] data User provided data to pass to the filter function * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_text_insert_filter_callback_add(Evas_Object *obj, const char *part, Edje_Text_Filter_Cb func, void *data); @@ -2153,7 +2181,7 @@ EAPI void edje_object_text_insert_filter_callback_add(Evas_Object *obj, const ch * * @return The user data pointer if successful, or @c null otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void *edje_object_text_insert_filter_callback_del(Evas_Object *obj, const char *part, Edje_Text_Filter_Cb func); @@ -2172,7 +2200,7 @@ EAPI void *edje_object_text_insert_filter_callback_del(Evas_Object *obj, const c * * @return The same data pointer if successful, or @c null otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void *edje_object_text_insert_filter_callback_del_full(Evas_Object *obj, const char *part, Edje_Text_Filter_Cb func, void *data); @@ -2205,7 +2233,7 @@ EAPI void *edje_object_text_insert_filter_callback_del_full(Evas_Object *obj, co * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_text_markup_filter_callback_add(Evas_Object *obj, const char *part, Edje_Markup_Filter_Cb func, void *data); @@ -2225,7 +2253,7 @@ EAPI void edje_object_text_markup_filter_callback_add(Evas_Object *obj, const ch * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void *edje_object_text_markup_filter_callback_del(Evas_Object *obj, const char *part, Edje_Markup_Filter_Cb func); @@ -2247,7 +2275,7 @@ EAPI void *edje_object_text_markup_filter_callback_del(Evas_Object *obj, const c * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void *edje_object_text_markup_filter_callback_del_full(Evas_Object *obj, const char *part, Edje_Markup_Filter_Cb func, void *data); @@ -2262,7 +2290,7 @@ EAPI void *edje_object_text_markup_filter_callback_del_full(Evas_Object *obj, co * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_user_insert(const Evas_Object *obj, const char *part, const char *text); @@ -2277,7 +2305,7 @@ EAPI void edje_object_part_text_user_insert(const Evas_Object *obj, const char * * * @since 1.1 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_append(Evas_Object *obj, const char *part, const char *text); @@ -2295,7 +2323,7 @@ EAPI void edje_object_part_text_append(Evas_Object *obj, const char *part, const * * @since 1.2 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_escaped_set(Evas_Object *obj, const char *part, const char *text); @@ -2313,7 +2341,7 @@ EAPI Eina_Bool edje_object_part_text_escaped_set(Evas_Object *obj, const char *p * * @return @c true on success, @c false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_unescaped_set(Evas_Object *obj, const char * part, const char *text_to_escape); @@ -2330,7 +2358,7 @@ EAPI Eina_Bool edje_object_part_text_unescaped_set(Evas_Object *obj, const char * * @return The text string * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI char *edje_object_part_text_unescaped_get(const Evas_Object *obj, const char * part); @@ -2343,7 +2371,7 @@ EAPI char *edje_object_part_text_unescaped_get(const Evas_Object *obj, const cha * @param[in] part The part name * @param[in] text The text string * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_insert(Evas_Object *obj, const char *part, const char *text); @@ -2355,7 +2383,7 @@ EAPI void edje_object_part_text_insert(Evas_Object *obj, const char *part, const * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_autocapital_type_set(Evas_Object *obj, const char *part, Edje_Text_Autocapital_Type autocapital_type); @@ -2368,7 +2396,7 @@ EAPI void edje_object_part_text_autocapital_type_set(Evas_Object *obj, const cha * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Edje_Text_Autocapital_Type edje_object_part_text_autocapital_type_get(const Evas_Object *obj, const char *part); @@ -2380,7 +2408,7 @@ EAPI Edje_Text_Autocapital_Type edje_object_part_text_autocapital_type_get(const * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_prediction_allow_set(Evas_Object *obj, const char *part, Eina_Bool prediction); @@ -2393,7 +2421,7 @@ EAPI void edje_object_part_text_prediction_allow_set(Evas_Object *obj, const cha * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_prediction_allow_get(const Evas_Object *obj, const char *part); @@ -2409,7 +2437,7 @@ EAPI Eina_Bool edje_object_part_text_prediction_allow_get(const Evas_Object *obj * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void *edje_object_part_text_imf_context_get(const Evas_Object *obj, const char *part); @@ -2423,7 +2451,7 @@ EAPI void *edje_object_part_text_imf_context_get(const Evas_Object *obj, const c * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_imf_context_reset(const Evas_Object *obj, const char *part); @@ -2436,7 +2464,7 @@ EAPI void edje_object_part_text_imf_context_reset(const Evas_Object *obj, const * * @since 1.12.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_hint_set(Evas_Object *obj, const char *part, Edje_Input_Hints input_hints); @@ -2449,7 +2477,7 @@ EAPI void edje_object_part_text_input_hint_set(Evas_Object *obj, const char *par * * @since 1.12.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Edje_Input_Hints edje_object_part_text_input_hint_get(const Evas_Object *obj, const char *part); @@ -2465,7 +2493,7 @@ EAPI Edje_Input_Hints edje_object_part_text_input_hint_get(const Evas_Object *ob * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_show(const Evas_Object *obj, const char *part); @@ -2481,7 +2509,7 @@ EAPI void edje_object_part_text_input_panel_show(const Evas_Object *obj, const c * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_hide(const Evas_Object *obj, const char *part); @@ -2498,7 +2526,7 @@ EAPI void edje_object_part_text_input_panel_hide(const Evas_Object *obj, const c * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_imdata_set(Evas_Object *obj, const char *part, const void *data, int len); @@ -2513,7 +2541,7 @@ EAPI void edje_object_part_text_input_panel_imdata_set(Evas_Object *obj, const c * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_imdata_get(const Evas_Object *obj, const char *part, void *data, int *len); @@ -2530,7 +2558,7 @@ EAPI void edje_object_part_text_input_panel_imdata_get(const Evas_Object *obj, c * * @since 1.1 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_layout_set(Evas_Object *obj, const char *part, Edje_Input_Panel_Layout layout); @@ -2545,7 +2573,7 @@ EAPI void edje_object_part_text_input_panel_layout_set(Evas_Object *obj, const c * * @since 1.1 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Edje_Input_Panel_Layout edje_object_part_text_input_panel_layout_get(const Evas_Object *obj, const char *part); @@ -2559,7 +2587,7 @@ EAPI Edje_Input_Panel_Layout edje_object_part_text_input_panel_layout_get(const * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_language_set(Evas_Object *obj, const char *part, Edje_Input_Panel_Lang lang); @@ -2575,7 +2603,7 @@ EAPI void edje_object_part_text_input_panel_language_set(Evas_Object *obj, const * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Edje_Input_Panel_Lang edje_object_part_text_input_panel_language_get(const Evas_Object *obj, const char *part); @@ -2592,7 +2620,7 @@ EAPI Edje_Input_Panel_Lang edje_object_part_text_input_panel_language_get(const * * @since 1.8 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_layout_variation_set(Evas_Object *obj, const char *part, int variation); @@ -2607,7 +2635,7 @@ EAPI void edje_object_part_text_input_panel_layout_variation_set(Evas_Object *ob * * @since 1.8 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI int edje_object_part_text_input_panel_layout_variation_get(const Evas_Object *obj, const char *part); @@ -2620,7 +2648,7 @@ EAPI int edje_object_part_text_input_panel_layout_variation_get(const Evas_Objec * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_enabled_set(Evas_Object *obj, const char *part, Eina_Bool enabled); @@ -2635,7 +2663,7 @@ EAPI void edje_object_part_text_input_panel_enabled_set(Evas_Object *obj, const * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_input_panel_enabled_get(const Evas_Object *obj, const char *part); @@ -2647,7 +2675,7 @@ EAPI Eina_Bool edje_object_part_text_input_panel_enabled_get(const Evas_Object * * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_return_key_disabled_set(Evas_Object *obj, const char *part, Eina_Bool disabled); @@ -2661,7 +2689,7 @@ EAPI void edje_object_part_text_input_panel_return_key_disabled_set(Evas_Object * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_input_panel_return_key_disabled_get(const Evas_Object *obj, const char *part); @@ -2676,7 +2704,7 @@ EAPI Eina_Bool edje_object_part_text_input_panel_return_key_disabled_get(const E * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_return_key_type_set(Evas_Object *obj, const char *part, Edje_Input_Panel_Return_Key_Type return_key_type); @@ -2692,7 +2720,7 @@ EAPI void edje_object_part_text_input_panel_return_key_type_set(Evas_Object *obj * * @since 1.2.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Edje_Input_Panel_Return_Key_Type edje_object_part_text_input_panel_return_key_type_get(const Evas_Object *obj, const char *part); @@ -2707,7 +2735,7 @@ EAPI Edje_Input_Panel_Return_Key_Type edje_object_part_text_input_panel_return_k * * @since 1.9.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_input_panel_show_on_demand_set(Evas_Object *obj, const char *part, Eina_Bool ondemand); @@ -2722,7 +2750,7 @@ EAPI void edje_object_part_text_input_panel_show_on_demand_set(Evas_Object *obj, * * @since 1.9.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_input_panel_show_on_demand_get(const Evas_Object *obj, const char *part); @@ -2735,7 +2763,7 @@ EAPI Eina_Bool edje_object_part_text_input_panel_show_on_demand_get(const Evas_O * * @since 1.20.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_prediction_hint_set(Evas_Object *obj, const char *part, const char *prediction_hint); @@ -2750,7 +2778,7 @@ EAPI void edje_object_part_text_prediction_hint_set(Evas_Object *obj, const char * * @since 1.21.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_prediction_hint_hash_set(Evas_Object *obj, const char *part, const char *key, const char *value); @@ -2764,7 +2792,7 @@ EAPI Eina_Bool edje_object_part_text_prediction_hint_hash_set(Evas_Object *obj, * * @since 1.21.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_text_prediction_hint_hash_del(Evas_Object *obj, const char *part, const char *key); @@ -2773,7 +2801,7 @@ EAPI Eina_Bool edje_object_part_text_prediction_hint_hash_del(Evas_Object *obj, * * @param[in] part The part name * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_select_begin(const Evas_Object *obj, const char *part); @@ -2782,7 +2810,7 @@ EAPI void edje_object_part_text_select_begin(const Evas_Object *obj, const char * * @param[in] part The part name * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_select_abort(const Evas_Object *obj, const char *part); @@ -2791,7 +2819,7 @@ EAPI void edje_object_part_text_select_abort(const Evas_Object *obj, const char * * @param[in] part The part name * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_select_extend(const Evas_Object *obj, const char *part); @@ -2802,7 +2830,7 @@ EAPI void edje_object_part_text_select_extend(const Evas_Object *obj, const char * * @param[in] part The part name * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_select_all(const Evas_Object *obj, const char *part); @@ -2813,7 +2841,7 @@ EAPI void edje_object_part_text_select_all(const Evas_Object *obj, const char *p * * @param[in] part The part name * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_select_none(const Evas_Object *obj, const char *part); @@ -2829,7 +2857,7 @@ EAPI void edje_object_part_text_select_none(const Evas_Object *obj, const char * * * @return The text string * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI const char *edje_object_part_text_selection_get(const Evas_Object *obj, const char *part); @@ -2851,7 +2879,7 @@ EAPI const char *edje_object_part_text_selection_get(const Evas_Object *obj, con * * @param[in] play The play state, @c true by default. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_play_set(Evas_Object *obj, Eina_Bool play); @@ -2873,7 +2901,7 @@ EAPI void edje_object_play_set(Evas_Object *obj, Eina_Bool play); * * @return The play state, @c true by default. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI Eina_Bool edje_object_play_get(const Evas_Object *obj); @@ -2888,7 +2916,7 @@ EAPI Eina_Bool edje_object_play_get(const Evas_Object *obj); * * @param[in] scale The transition duration factor. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_transition_duration_factor_set(Evas_Object *obj, double scale); @@ -2903,7 +2931,7 @@ EAPI void edje_object_transition_duration_factor_set(Evas_Object *obj, double sc * * @return The transition duration factor. * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI double edje_object_transition_duration_factor_get(const Evas_Object *obj); @@ -2925,7 +2953,7 @@ EAPI double edje_object_transition_duration_factor_get(const Evas_Object *obj); * @param[out] minw Pointer to a variable where to store the minimum width * @param[out] minh Pointer to a variable where to store the minimum height * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_size_min_get(const Evas_Object *obj, int *minw, int *minh); @@ -2947,7 +2975,7 @@ EAPI void edje_object_size_min_get(const Evas_Object *obj, int *minw, int *minh) * @param[out] maxw The maximum width * @param[out] maxh The maximum height * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_size_max_get(const Evas_Object *obj, int *maxw, int *maxh); @@ -2965,12 +2993,10 @@ EAPI void edje_object_size_max_get(const Evas_Object *obj, int *maxw, int *maxh) * @return @c true if the Edje part exists in obj's group, or @c false * otherwise (and on errors) * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI Eina_Bool edje_object_part_exists(const Evas_Object *obj, const char *part); - - /** * @brief Sets the function that provides item objects for named items in an * edje entry text @@ -2983,7 +3009,7 @@ EAPI Eina_Bool edje_object_part_exists(const Evas_Object *obj, const char *part) * objects * @param[in] data The data pointer to pass to the func callback * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_item_provider_set(Edje_Object *obj, Edje_Item_Provider_Cb func, void *data); @@ -2997,7 +3023,7 @@ EAPI void edje_object_item_provider_set(Edje_Object *obj, Edje_Item_Provider_Cb * * @return The description of the target color class or @c null if not found * - * @ingroup Edje_Object + * @ingroup Edje_Object_Color_Class */ EAPI const char *edje_object_color_class_description_get(const Edje_Object *obj, const char * color_class); @@ -3138,6 +3164,10 @@ EAPI void edje_object_perspective_set(Evas_Object *obj, Edje_Perspective *ps); */ EAPI const Edje_Perspective *edje_object_perspective_get(const Evas_Object *obj); +/** + * @} + */ + /** * @brief Sets Edje text class for edje file (if loaded) * @@ -3150,6 +3180,9 @@ EAPI const Edje_Perspective *edje_object_perspective_get(const Evas_Object *obj) * @param[in] size Font Size * * @return @c true, on success or @c false, on error + * + * @ingroup Edje_Object_Text_Class + * */ EAPI Eina_Bool edje_file_text_class_set(const char *file, const char *text_class, const char *font, Evas_Font_Size size); @@ -3160,6 +3193,9 @@ EAPI Eina_Bool edje_file_text_class_set(const char *file, const char *text_class * file and text class. * * @param[in] text_class The text class to be deleted. + * + * @ingroup Edje_Object_Text_Class + * */ EAPI Eina_Bool edje_file_text_class_del(const char *file, const char *text_class); @@ -3173,12 +3209,12 @@ EAPI Eina_Bool edje_file_text_class_del(const char *file, const char *text_class * @param[out] size Font Size * * @return @c true, on success or @c false, on error + * + * @ingroup Edje_Object_Text_Class + * */ EAPI Eina_Bool edje_file_text_class_get(const char *file, const char * text_class, const char **font, Evas_Font_Size *size); -/** - * @} - */ /** * @defgroup Edje_Object_Part Edje Part diff --git a/src/lib/elementary/elc_ctxpopup.h b/src/lib/elementary/elc_ctxpopup.h index a55319cdcc..7008d58f6c 100644 --- a/src/lib/elementary/elc_ctxpopup.h +++ b/src/lib/elementary/elc_ctxpopup.h @@ -1,5 +1,5 @@ /** - * @defgroup Elm_Ctxpopup Ctxpopup + * @defgroup Elm_Ctxpopup_Group Ctxpopup * @ingroup Elementary * * @image html ctxpopup_inheritance_tree.png @@ -60,9 +60,13 @@ * @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 diff --git a/src/lib/elementary/elc_ctxpopup_legacy.h b/src/lib/elementary/elc_ctxpopup_legacy.h index d3181ed2cf..6c475515c9 100644 --- a/src/lib/elementary/elc_ctxpopup_legacy.h +++ b/src/lib/elementary/elc_ctxpopup_legacy.h @@ -4,7 +4,7 @@ * @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); diff --git a/src/lib/elementary/elm_box.h b/src/lib/elementary/elm_box.h index c15eb01d21..24ab2e8017 100644 --- a/src/lib/elementary/elm_box.h +++ b/src/lib/elementary/elm_box.h @@ -1,5 +1,5 @@ /** - * @defgroup Elm_Box Box + * @defgroup Elm_Box_Group Box * @ingroup Elementary * * @image html box_inheritance_tree.png diff --git a/src/lib/elementary/elm_box_common.h b/src/lib/elementary/elm_box_common.h index f16b72ce98..7eeb53b144 100644 --- a/src/lib/elementary/elm_box_common.h +++ b/src/lib/elementary/elm_box_common.h @@ -1,5 +1,5 @@ /** - * @addtogroup Elm_Box + * @addtogroup Elm_Box_Group * * @{ */ diff --git a/src/lib/elementary/elm_box_eo.h b/src/lib/elementary/elm_box_eo.h index fb82524082..431226d52e 100644 --- a/src/lib/elementary/elm_box_eo.h +++ b/src/lib/elementary/elm_box_eo.h @@ -15,7 +15,7 @@ typedef Eo Elm_Box; #endif /** Elementary box class * - * @ingroup Elm_Box + * @ingroup Elm_Box_Group */ #define ELM_BOX_CLASS elm_box_class_get() @@ -32,7 +32,7 @@ EWAPI const Efl_Class *elm_box_class_get(void); * @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); @@ -44,7 +44,7 @@ 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); @@ -59,7 +59,7 @@ 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); @@ -72,7 +72,7 @@ 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); @@ -88,7 +88,7 @@ EOAPI void elm_obj_box_align_get(const Eo *obj, double *horizontal, double *vert * @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); @@ -100,7 +100,7 @@ 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); @@ -116,7 +116,7 @@ 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); @@ -129,7 +129,7 @@ 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); @@ -145,7 +145,7 @@ 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; @@ -164,7 +164,7 @@ 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); @@ -180,7 +180,7 @@ 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); @@ -195,7 +195,7 @@ 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); @@ -215,7 +215,7 @@ 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); @@ -234,7 +234,7 @@ EOAPI void elm_obj_box_pack_after(Eo *obj, Efl_Canvas_Object *subobj, Efl_Canvas * @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); @@ -247,7 +247,7 @@ 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); @@ -267,7 +267,7 @@ 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); @@ -280,7 +280,7 @@ EOAPI void elm_obj_box_pack_before(Eo *obj, Efl_Canvas_Object *subobj, Efl_Canva * 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); @@ -289,7 +289,7 @@ EWAPI extern const Efl_Event_Description _ELM_BOX_EVENT_CHILD_ADDED; /** 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)) @@ -298,7 +298,7 @@ EWAPI extern const Efl_Event_Description _ELM_BOX_EVENT_CHILD_REMOVED; /** 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)) diff --git a/src/lib/elementary/elm_box_legacy.h b/src/lib/elementary/elm_box_legacy.h index 1afb296efd..ad8aaa91d0 100644 --- a/src/lib/elementary/elm_box_legacy.h +++ b/src/lib/elementary/elm_box_legacy.h @@ -6,7 +6,7 @@ * @param parent The parent object * @return The new object or NULL if it cannot be created * - * @ingroup Elm_Box + * @ingroup Elm_Box_Group */ EAPI Evas_Object *elm_box_add(Evas_Object *parent); @@ -43,5 +43,7 @@ EAPI Evas_Object *elm_box_add(Evas_Object *parent); * @param[in] cb The callback function used for layout * @param[in] data Data that will be passed to layout function * @param[in] free_data Function called to free @c data + * + * @ingroup Elm_Box_Group */ EAPI void elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_Layout cb, const void *data, Ecore_Cb free_data); diff --git a/src/lib/elementary/elm_config.h b/src/lib/elementary/elm_config.h index 33d4bfad13..429e6aa01f 100644 --- a/src/lib/elementary/elm_config.h +++ b/src/lib/elementary/elm_config.h @@ -304,7 +304,7 @@ EAPI void elm_config_scroll_page_scroll_friction_set(double friction); * * @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); @@ -315,7 +315,7 @@ 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); @@ -1927,7 +1927,7 @@ EAPI const char *elm_config_indicator_service_get(int rotation); * 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); @@ -1936,7 +1936,7 @@ 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); @@ -1945,7 +1945,7 @@ 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); @@ -1954,7 +1954,7 @@ 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); diff --git a/src/lib/elementary/elm_ctxpopup_eo.h b/src/lib/elementary/elm_ctxpopup_eo.h index 78e8ad0a11..505eddfa58 100644 --- a/src/lib/elementary/elm_ctxpopup_eo.h +++ b/src/lib/elementary/elm_ctxpopup_eo.h @@ -13,7 +13,7 @@ typedef Eo Elm_Ctxpopup; /** Direction in which to show the popup. * - * @ingroup Elm_Ctxpopup + * @ingroup Elm_Ctxpopup_Group */ typedef enum { @@ -33,7 +33,7 @@ typedef enum #endif /** Elementary context popup class * - * @ingroup Elm_Ctxpopup + * @ingroup Elm_Ctxpopup_Group */ #define ELM_CTXPOPUP_CLASS elm_ctxpopup_class_get() @@ -46,7 +46,7 @@ EWAPI const Efl_Class *elm_ctxpopup_class_get(void); * * @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); @@ -57,7 +57,7 @@ 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); @@ -68,7 +68,7 @@ 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); @@ -79,7 +79,7 @@ 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); @@ -89,7 +89,7 @@ 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); @@ -102,7 +102,7 @@ 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); @@ -124,7 +124,7 @@ 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); @@ -139,7 +139,7 @@ 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); @@ -156,7 +156,7 @@ 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); @@ -169,7 +169,7 @@ 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); @@ -188,7 +188,7 @@ 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); @@ -203,7 +203,7 @@ EOAPI void elm_obj_ctxpopup_direction_priority_set(Eo *obj, Elm_Ctxpopup_Directi * @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); @@ -216,7 +216,7 @@ EOAPI void elm_obj_ctxpopup_direction_priority_get(const Eo *obj, Elm_Ctxpopup_D * * @return Direction * - * @ingroup Elm_Ctxpopup + * @ingroup Elm_Ctxpopup_Group */ EOAPI Elm_Ctxpopup_Direction elm_obj_ctxpopup_direction_get(const Eo *obj); @@ -228,13 +228,13 @@ 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); @@ -254,7 +254,7 @@ 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); @@ -274,7 +274,7 @@ EOAPI Elm_Widget_Item *elm_obj_ctxpopup_item_insert_before(Eo *obj, Elm_Widget_I * * @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); @@ -294,7 +294,7 @@ EOAPI Elm_Widget_Item *elm_obj_ctxpopup_item_insert_after(Eo *obj, Elm_Widget_It * * @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); @@ -316,7 +316,7 @@ EOAPI Elm_Widget_Item *elm_obj_ctxpopup_item_append(Eo *obj, const char *label, * * @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); @@ -324,7 +324,7 @@ EWAPI extern const Efl_Event_Description _ELM_CTXPOPUP_EVENT_DISMISSED; /** Called when context popup was dismissed * - * @ingroup Elm_Ctxpopup + * @ingroup Elm_Ctxpopup_Group */ #define ELM_CTXPOPUP_EVENT_DISMISSED (&(_ELM_CTXPOPUP_EVENT_DISMISSED)) @@ -333,7 +333,7 @@ EWAPI extern const Efl_Event_Description _ELM_CTXPOPUP_EVENT_GEOMETRY_UPDATE; /** 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)) diff --git a/src/lib/elementary/elm_ctxpopup_eo.legacy.h b/src/lib/elementary/elm_ctxpopup_eo.legacy.h index 74422ac22e..1754b76dd2 100644 --- a/src/lib/elementary/elm_ctxpopup_eo.legacy.h +++ b/src/lib/elementary/elm_ctxpopup_eo.legacy.h @@ -13,7 +13,7 @@ typedef Eo Elm_Ctxpopup; /** Direction in which to show the popup. * - * @ingroup Elm_Ctxpopup + * @ingroup Elm_Ctxpopup_Group */ typedef enum { diff --git a/src/lib/elementary/elm_ctxpopup_item_eo.h b/src/lib/elementary/elm_ctxpopup_item_eo.h index 1e8d30d650..f33426dc7a 100644 --- a/src/lib/elementary/elm_ctxpopup_item_eo.h +++ b/src/lib/elementary/elm_ctxpopup_item_eo.h @@ -13,9 +13,17 @@ typedef Eo Elm_Ctxpopup_Item; #endif -/** Elementary context popup item class +/** + * Elementary context popup item class * - * @ingroup Elm_Ctxpopup_Item + * @defgroup Elm_Ctxpopup_Item_Group + * @ingroup Elm_Ctxpopup_Group + */ + +/** + * @brief Get the context popup item class + * + * @ingroup Elm_Ctxpopup_Item_Group */ #define ELM_CTXPOPUP_ITEM_CLASS elm_ctxpopup_item_class_get() @@ -31,7 +39,7 @@ EWAPI const Efl_Class *elm_ctxpopup_item_class_get(void); * @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); @@ -45,7 +53,7 @@ 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); @@ -66,7 +74,7 @@ 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); @@ -79,7 +87,7 @@ 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); @@ -90,7 +98,7 @@ 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); diff --git a/src/lib/elementary/elm_deprecated.h b/src/lib/elementary/elm_deprecated.h index ebed20dcb6..f9955f2ec4 100644 --- a/src/lib/elementary/elm_deprecated.h +++ b/src/lib/elementary/elm_deprecated.h @@ -68,7 +68,7 @@ EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Obj * * @deprecated * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly); @@ -81,7 +81,7 @@ EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Objec * * @deprecated * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj); @@ -680,7 +680,7 @@ EINA_DEPRECATED EAPI void elm_genlist_scroller_policy_get(const Evas_Ob * * @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); @@ -696,7 +696,7 @@ EINA_DEPRECATED EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_S * * @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); @@ -709,7 +709,7 @@ EINA_DEPRECATED EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bou * * @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); diff --git a/src/lib/elementary/elm_entry.h b/src/lib/elementary/elm_entry.h index 3e187b93cd..e4ce22b3d8 100644 --- a/src/lib/elementary/elm_entry.h +++ b/src/lib/elementary/elm_entry.h @@ -1,5 +1,5 @@ /** - * @defgroup Elm_Entry Entry + * @defgroup Elm_Entry_Group Entry * @ingroup Elementary * * @image html entry_inheritance_tree.png diff --git a/src/lib/elementary/elm_entry_common.h b/src/lib/elementary/elm_entry_common.h index 4e807a3b32..6178cecb85 100644 --- a/src/lib/elementary/elm_entry_common.h +++ b/src/lib/elementary/elm_entry_common.h @@ -2,7 +2,7 @@ #define ELM_ENTRY_COMMON_H_ /** - * @addtogroup Elm_Entry + * @addtogroup Elm_Entry_Group * * @{ */ diff --git a/src/lib/elementary/elm_entry_eo.h b/src/lib/elementary/elm_entry_eo.h index 90ec95a423..7ea896e931 100644 --- a/src/lib/elementary/elm_entry_eo.h +++ b/src/lib/elementary/elm_entry_eo.h @@ -15,7 +15,7 @@ typedef Eo Elm_Entry; #endif /** Elementary entry class * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_CLASS elm_entry_class_get() @@ -29,7 +29,7 @@ EWAPI const Efl_Class *elm_entry_class_get(void); * @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); @@ -43,7 +43,7 @@ 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); @@ -58,7 +58,7 @@ 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); @@ -73,7 +73,7 @@ EOAPI void elm_obj_entry_input_panel_show_on_demand_set(Eo *obj, Eina_Bool ondem * * @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); @@ -83,7 +83,7 @@ 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); @@ -95,7 +95,7 @@ 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); @@ -113,7 +113,7 @@ 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); @@ -128,7 +128,7 @@ 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); @@ -148,7 +148,7 @@ 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); @@ -160,7 +160,7 @@ 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); @@ -171,7 +171,7 @@ EOAPI void elm_obj_entry_input_panel_language_set(Eo *obj, Elm_Input_Panel_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); @@ -181,7 +181,7 @@ 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); @@ -192,7 +192,7 @@ EOAPI void elm_obj_entry_selection_handler_disabled_set(Eo *obj, Eina_Bool disab * * @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); @@ -204,7 +204,7 @@ 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); @@ -217,7 +217,7 @@ 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); @@ -227,7 +227,7 @@ 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); @@ -238,7 +238,7 @@ EOAPI void elm_obj_entry_autocapital_type_set(Eo *obj, Elm_Autocapital_Type auto * * @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); @@ -258,7 +258,7 @@ 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); @@ -270,7 +270,7 @@ 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); @@ -285,7 +285,7 @@ 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); @@ -296,7 +296,7 @@ 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); @@ -315,7 +315,7 @@ 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); @@ -326,7 +326,7 @@ 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); @@ -339,7 +339,7 @@ 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); @@ -350,7 +350,7 @@ 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); @@ -361,7 +361,7 @@ 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); @@ -373,7 +373,7 @@ EOAPI void elm_obj_entry_input_panel_return_key_disabled_set(Eo *obj, Eina_Bool * * @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); @@ -383,7 +383,7 @@ 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); @@ -394,7 +394,7 @@ 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); @@ -407,7 +407,7 @@ 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); @@ -421,7 +421,7 @@ EOAPI void elm_obj_entry_anchor_hover_parent_set(Eo *obj, Efl_Canvas_Object *par * * @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); @@ -432,7 +432,7 @@ 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); @@ -443,7 +443,7 @@ 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); @@ -454,7 +454,7 @@ 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); @@ -465,7 +465,7 @@ 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); @@ -475,7 +475,7 @@ 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); @@ -486,7 +486,7 @@ EOAPI void elm_obj_entry_input_panel_layout_set(Eo *obj, Elm_Input_Panel_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); @@ -502,7 +502,7 @@ 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); @@ -513,7 +513,7 @@ EOAPI void elm_obj_entry_input_panel_return_key_type_set(Eo *obj, Elm_Input_Pane * * @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); @@ -524,7 +524,7 @@ EOAPI Elm_Input_Panel_Return_Key_Type elm_obj_entry_input_panel_return_key_type_ * @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); @@ -536,7 +536,7 @@ 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); @@ -554,7 +554,7 @@ 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); @@ -565,7 +565,7 @@ 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); @@ -578,7 +578,7 @@ 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); @@ -589,7 +589,7 @@ 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); @@ -601,13 +601,13 @@ 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); @@ -620,7 +620,7 @@ 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); @@ -633,7 +633,7 @@ 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); @@ -649,7 +649,7 @@ 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); @@ -660,25 +660,25 @@ EOAPI void elm_obj_entry_input_panel_return_key_autoenabled_set(Eo *obj, Eina_Bo * @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); @@ -709,7 +709,7 @@ 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); @@ -727,7 +727,7 @@ 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); @@ -743,7 +743,7 @@ EOAPI Eina_Bool elm_obj_entry_textblock_cursor_geometry_get(const Eo *obj, int * * * @return Input method context * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ EOAPI void *elm_obj_entry_imf_context_get(const Eo *obj); @@ -759,7 +759,7 @@ 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); @@ -775,7 +775,7 @@ 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; @@ -794,7 +794,7 @@ EOAPI char *elm_obj_entry_textblock_cursor_content_get(const Eo *obj) EINA_WARN_ * * @return Selected string * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ EOAPI const char *elm_obj_entry_selection_get(const Eo *obj); @@ -805,7 +805,7 @@ 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); @@ -817,7 +817,7 @@ 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); @@ -830,7 +830,7 @@ 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); @@ -841,7 +841,7 @@ 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); @@ -849,7 +849,7 @@ 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); @@ -862,7 +862,7 @@ 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); @@ -876,7 +876,7 @@ EOAPI void elm_obj_entry_item_provider_prepend(Eo *obj, Elm_Entry_Item_Provider_ * @c false). * @param[in] obj The object. * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ EOAPI void elm_obj_entry_input_panel_show(Eo *obj); @@ -888,7 +888,7 @@ 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); @@ -900,14 +900,14 @@ 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); @@ -918,20 +918,20 @@ 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); @@ -947,7 +947,7 @@ 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); @@ -961,7 +961,7 @@ 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); @@ -976,7 +976,7 @@ EOAPI void elm_obj_entry_item_provider_remove(Eo *obj, Elm_Entry_Item_Provider_C * * @since 1.7 * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ EOAPI const char *elm_obj_entry_text_style_user_peek(const Eo *obj); @@ -987,7 +987,7 @@ 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); @@ -998,7 +998,7 @@ 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); @@ -1020,7 +1020,7 @@ 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); @@ -1035,7 +1035,7 @@ 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); @@ -1046,13 +1046,13 @@ EOAPI void elm_obj_entry_input_panel_imdata_set(Eo *obj, const void *data, int l * @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); @@ -1063,13 +1063,13 @@ 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); @@ -1082,26 +1082,26 @@ 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); @@ -1116,7 +1116,7 @@ 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); @@ -1130,7 +1130,7 @@ 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); @@ -1150,7 +1150,7 @@ EOAPI void elm_obj_entry_markup_filter_remove(Eo *obj, Elm_Entry_Filter_Cb func, * @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); @@ -1169,7 +1169,7 @@ EOAPI void elm_obj_entry_item_provider_append(Eo *obj, Elm_Entry_Item_Provider_C * @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); @@ -1186,7 +1186,7 @@ EOAPI void elm_obj_entry_markup_filter_append(Eo *obj, Elm_Entry_Filter_Cb func, * @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); @@ -1209,7 +1209,7 @@ 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); @@ -1222,7 +1222,7 @@ EOAPI void elm_obj_entry_context_menu_item_add(Eo *obj, const char *label, const * @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); @@ -1235,7 +1235,7 @@ EOAPI void elm_obj_entry_markup_filter_prepend(Eo *obj, Elm_Entry_Filter_Cb func * * @since 1.20 * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ EOAPI void elm_obj_entry_prediction_hint_set(Eo *obj, const char *prediction_hint); @@ -1250,7 +1250,7 @@ EOAPI void elm_obj_entry_prediction_hint_set(Eo *obj, const char *prediction_hin * * @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); @@ -1264,7 +1264,7 @@ EOAPI Eina_Bool elm_obj_entry_prediction_hint_hash_set(Eo *obj, const char *key, * * @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); @@ -1272,7 +1272,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_ACTIVATED; /** Called when entry got activated * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_ACTIVATED (&(_ELM_ENTRY_EVENT_ACTIVATED)) @@ -1280,7 +1280,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_CHANGED; /** Called when entry changed * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_CHANGED (&(_ELM_ENTRY_EVENT_CHANGED)) @@ -1289,7 +1289,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_CHANGED_USER; /** 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)) @@ -1298,7 +1298,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_VALIDATE; /** Called when validating * @return Elm_Validate_Content * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_VALIDATE (&(_ELM_ENTRY_EVENT_VALIDATE)) @@ -1306,7 +1306,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_CONTEXT_OPEN; /** Called when context menu was opened * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_CONTEXT_OPEN (&(_ELM_ENTRY_EVENT_CONTEXT_OPEN)) @@ -1315,7 +1315,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_ANCHOR_CLICKED; /** 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)) @@ -1323,7 +1323,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_REJECTED; /** Called when entry was rejected * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_REJECTED (&(_ELM_ENTRY_EVENT_REJECTED)) @@ -1331,7 +1331,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_MAXLENGTH_REACHED; /** 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)) @@ -1339,7 +1339,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_PREEDIT_CHANGED; /** Called when entry preedit changed * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_PREEDIT_CHANGED (&(_ELM_ENTRY_EVENT_PREEDIT_CHANGED)) @@ -1347,7 +1347,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_PRESS; /** Called when entry pressed * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_PRESS (&(_ELM_ENTRY_EVENT_PRESS)) @@ -1355,7 +1355,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_REDO_REQUEST; /** Called when redo was requested * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_REDO_REQUEST (&(_ELM_ENTRY_EVENT_REDO_REQUEST)) @@ -1363,7 +1363,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_UNDO_REQUEST; /** Called when undo was requested * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_UNDO_REQUEST (&(_ELM_ENTRY_EVENT_UNDO_REQUEST)) @@ -1371,7 +1371,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_TEXT_SET_DONE; /** 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)) @@ -1379,7 +1379,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_ABORTED; /** Called when entry was aborted * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_ABORTED (&(_ELM_ENTRY_EVENT_ABORTED)) @@ -1388,7 +1388,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_ANCHOR_DOWN; /** 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)) @@ -1397,7 +1397,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_ANCHOR_HOVER_OPENED; /** 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)) @@ -1406,7 +1406,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_ANCHOR_IN; /** 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)) @@ -1415,7 +1415,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_ANCHOR_OUT; /** 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)) @@ -1424,7 +1424,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_ANCHOR_UP; /** 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)) @@ -1432,7 +1432,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_CURSOR_CHANGED; /** Called on cursor changed * - * @ingroup Elm_Entry + * @ingroup Elm_Entry_Group */ #define ELM_ENTRY_EVENT_CURSOR_CHANGED (&(_ELM_ENTRY_EVENT_CURSOR_CHANGED)) @@ -1440,7 +1440,7 @@ EWAPI extern const Efl_Event_Description _ELM_ENTRY_EVENT_CURSOR_CHANGED_MANUAL; /** 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)) diff --git a/src/lib/elementary/elm_entry_legacy.h b/src/lib/elementary/elm_entry_legacy.h index 06b3f76eb7..9d87e54e54 100644 --- a/src/lib/elementary/elm_entry_legacy.h +++ b/src/lib/elementary/elm_entry_legacy.h @@ -12,7 +12,7 @@ * @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); @@ -24,7 +24,7 @@ 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); @@ -35,7 +35,7 @@ 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); @@ -51,7 +51,7 @@ 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 @@ -66,7 +66,7 @@ EAPI Eina_Bool elm_entry_file_set(Evas_Object *obj, const char *file, E * 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 @@ -82,6 +82,6 @@ EAPI void elm_entry_file_get(const Evas_Object *obj, const char ** * @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); diff --git a/src/lib/elementary/elm_general.h b/src/lib/elementary/elm_general.h index 6624d9ecd1..b0708e11c3 100644 --- a/src/lib/elementary/elm_general.h +++ b/src/lib/elementary/elm_general.h @@ -342,7 +342,7 @@ typedef enum /** 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 { @@ -359,7 +359,7 @@ 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 { @@ -371,7 +371,7 @@ typedef enum /** Defines where to position the item in the genlist. * - * @ingroup Elm_Genlist_Item + * @ingroup Elm_Genlist_Item_Group */ typedef enum { @@ -389,7 +389,7 @@ typedef enum /** Defines where to position the item in the genlist. * - * @ingroup Elm_Gengrid_Item + * @ingroup Elm_Gengrid_Item_Group */ typedef enum { @@ -407,7 +407,7 @@ 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 { diff --git a/src/lib/elementary/elm_gengrid.h b/src/lib/elementary/elm_gengrid.h index 6d328033de..c45854e7ab 100644 --- a/src/lib/elementary/elm_gengrid.h +++ b/src/lib/elementary/elm_gengrid.h @@ -1,5 +1,5 @@ /** - * @defgroup Elm_Gengrid Gengrid (Generic grid) + * @defgroup Elm_Gengrid_Group Gengrid (Generic grid) * @ingroup Elementary * * @image html gengrid_inheritance_tree.png @@ -271,7 +271,7 @@ */ /** - * @addtogroup Elm_Gengrid + * @addtogroup Elm_Gengrid_Group * @{ */ diff --git a/src/lib/elementary/elm_gengrid_common.h b/src/lib/elementary/elm_gengrid_common.h index cd08c037c6..1ce05dcae3 100644 --- a/src/lib/elementary/elm_gengrid_common.h +++ b/src/lib/elementary/elm_gengrid_common.h @@ -35,7 +35,7 @@ typedef Elm_Gen_Item_Del_Cb Elm_Gengrid_Item_Del_Cb; * @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); @@ -52,7 +52,7 @@ 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); @@ -65,7 +65,7 @@ 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); @@ -80,7 +80,7 @@ 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); @@ -99,7 +99,7 @@ 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); @@ -167,7 +167,7 @@ EAPI void elm_gengrid_item_tooltip_unset(Elm_Object_Ite * * @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); @@ -181,7 +181,7 @@ EAPI void elm_gengrid_item_tooltip_style_set(Elm_Object * * @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); @@ -243,7 +243,7 @@ EAPI void elm_gengrid_item_cursor_set(Elm_Object_Item * * @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); @@ -260,7 +260,7 @@ EAPI const char *elm_gengrid_item_cursor_get(const Elm_Object_ * @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); @@ -285,7 +285,7 @@ EAPI void elm_gengrid_item_cursor_unset(Elm_Object_Item * @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); @@ -299,7 +299,7 @@ EAPI void elm_gengrid_item_cursor_style_set(Elm_Object_ * * @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); @@ -319,7 +319,7 @@ EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_O * @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); @@ -335,7 +335,7 @@ EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_O * * @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); @@ -351,7 +351,7 @@ EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const * 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); @@ -379,7 +379,7 @@ EAPI void elm_gengrid_item_pos_get(const Elm_Object_Ite * * @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); @@ -392,7 +392,7 @@ EAPI void elm_gengrid_item_select_mode_set(Elm_Object_I * * @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); diff --git a/src/lib/elementary/elm_gengrid_eo.h b/src/lib/elementary/elm_gengrid_eo.h index 340a273cd8..2e891e655b 100644 --- a/src/lib/elementary/elm_gengrid_eo.h +++ b/src/lib/elementary/elm_gengrid_eo.h @@ -13,7 +13,7 @@ typedef Eo Elm_Gengrid; /** Gengrid reorder modes * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ typedef enum { @@ -25,7 +25,7 @@ typedef enum #endif /** Elementary gengrid class * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_CLASS elm_gengrid_class_get() @@ -46,7 +46,7 @@ EWAPI const Efl_Class *elm_gengrid_class_get(void); * @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); @@ -60,7 +60,7 @@ 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); @@ -75,7 +75,7 @@ EOAPI void elm_obj_gengrid_align_get(const Eo *obj, double *align_x, double *ali * @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); @@ -89,7 +89,7 @@ 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); @@ -107,7 +107,7 @@ 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); @@ -119,7 +119,7 @@ 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); @@ -135,7 +135,7 @@ 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); @@ -149,7 +149,7 @@ 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); @@ -168,7 +168,7 @@ EOAPI void elm_obj_gengrid_group_item_size_get(const Eo *obj, int *w, int *h); * @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); @@ -179,7 +179,7 @@ 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); @@ -199,7 +199,7 @@ 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); @@ -211,7 +211,7 @@ 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); @@ -222,7 +222,7 @@ 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); @@ -234,7 +234,7 @@ 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); @@ -246,7 +246,7 @@ 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); @@ -262,7 +262,7 @@ EOAPI void elm_obj_gengrid_reorder_type_set(Eo *obj, Elm_Gengrid_Reorder_Type ty * @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); @@ -276,7 +276,7 @@ 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); @@ -294,7 +294,7 @@ 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); @@ -309,7 +309,7 @@ EOAPI void elm_obj_gengrid_multi_select_mode_set(Eo *obj, Elm_Object_Multi_Selec * * @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); @@ -330,7 +330,7 @@ EOAPI Elm_Object_Multi_Select_Mode elm_obj_gengrid_multi_select_mode_get(const E * @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); @@ -343,7 +343,7 @@ 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); @@ -360,7 +360,7 @@ 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); @@ -376,7 +376,7 @@ 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; @@ -390,7 +390,7 @@ EOAPI Eina_List *elm_obj_gengrid_realized_items_get(const Eo *obj) EINA_WARN_UNU * @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); @@ -407,7 +407,7 @@ 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); @@ -421,7 +421,7 @@ 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); @@ -439,7 +439,7 @@ 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); @@ -453,7 +453,7 @@ EOAPI Elm_Widget_Item *elm_obj_gengrid_item_insert_before(Eo *obj, const Elm_Gen * 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); @@ -471,7 +471,7 @@ 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); @@ -484,7 +484,7 @@ EOAPI Elm_Widget_Item *elm_obj_gengrid_item_insert_after(Eo *obj, const Elm_Geng * * @return Items in list * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ EOAPI unsigned int elm_obj_gengrid_items_count(const Eo *obj); @@ -512,7 +512,7 @@ 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); @@ -529,7 +529,7 @@ EOAPI Elm_Widget_Item *elm_obj_gengrid_at_xy_item_get(const Eo *obj, int x, int * * @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); @@ -546,7 +546,7 @@ EOAPI Elm_Widget_Item *elm_obj_gengrid_item_append(Eo *obj, const Elm_Gengrid_It * * @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); @@ -558,7 +558,7 @@ EOAPI Elm_Widget_Item *elm_obj_gengrid_item_prepend(Eo *obj, const Elm_Gengrid_I * 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); @@ -580,7 +580,7 @@ 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); @@ -607,7 +607,7 @@ EOAPI Elm_Widget_Item *elm_obj_gengrid_item_sorted_insert(Eo *obj, const Elm_Gen * * @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); @@ -619,7 +619,7 @@ EOAPI Elm_Widget_Item *elm_obj_gengrid_search_by_text_item_get(Eo *obj, Elm_Widg * * @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); @@ -627,7 +627,7 @@ 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); @@ -636,7 +636,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_REALIZED; /** Called when gengrid realized * @return Efl_Object * * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_EVENT_REALIZED (&(_ELM_GENGRID_EVENT_REALIZED)) @@ -645,7 +645,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_UNREALIZED; /** Called when gengrid unrealized * @return Efl_Object * * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_EVENT_UNREALIZED (&(_ELM_GENGRID_EVENT_UNREALIZED)) @@ -654,7 +654,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_INDEX_UPDATE; /** 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)) @@ -662,7 +662,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_SCROLL_PAGE_CHANGED; /** 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)) @@ -670,7 +670,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_EDGE_BOTTOM; /** Called when bottom edge is reached * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_EVENT_EDGE_BOTTOM (&(_ELM_GENGRID_EVENT_EDGE_BOTTOM)) @@ -678,7 +678,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_EDGE_TOP; /** Called when top edge is reached * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_EVENT_EDGE_TOP (&(_ELM_GENGRID_EVENT_EDGE_TOP)) @@ -686,7 +686,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_EDGE_RIGHT; /** Called when right edge is reached * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_EVENT_EDGE_RIGHT (&(_ELM_GENGRID_EVENT_EDGE_RIGHT)) @@ -694,7 +694,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_EDGE_LEFT; /** Called when left edge is reached * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_EVENT_EDGE_LEFT (&(_ELM_GENGRID_EVENT_EDGE_LEFT)) @@ -703,7 +703,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_ITEM_FOCUSED; /** 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)) @@ -712,7 +712,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_ITEM_UNFOCUSED; /** 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)) @@ -721,7 +721,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_ITEM_REORDER_ANIM_ST /** 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)) @@ -730,7 +730,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_ITEM_REORDER_ANIM_ST /** 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)) @@ -739,7 +739,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_ACTIVATED; /** Called when gengrid got activated * @return Efl_Object * * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_EVENT_ACTIVATED (&(_ELM_GENGRID_EVENT_ACTIVATED)) @@ -748,7 +748,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_HIGHLIGHTED; /** Called when gengrid is highlighted * @return Efl_Object * * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_EVENT_HIGHLIGHTED (&(_ELM_GENGRID_EVENT_HIGHLIGHTED)) @@ -757,7 +757,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_UNHIGHLIGHTED; /** 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)) @@ -766,7 +766,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_RELEASED; /** Called when gengrid is released * @return Efl_Object * * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_EVENT_RELEASED (&(_ELM_GENGRID_EVENT_RELEASED)) @@ -775,7 +775,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENGRID_EVENT_MOVED; /** Called when gengrid item moved * @return Efl_Object * * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ #define ELM_GENGRID_EVENT_MOVED (&(_ELM_GENGRID_EVENT_MOVED)) diff --git a/src/lib/elementary/elm_gengrid_eo.legacy.h b/src/lib/elementary/elm_gengrid_eo.legacy.h index b454ac0653..e069502d68 100644 --- a/src/lib/elementary/elm_gengrid_eo.legacy.h +++ b/src/lib/elementary/elm_gengrid_eo.legacy.h @@ -13,7 +13,7 @@ typedef Eo Elm_Gengrid; /** Gengrid reorder modes * - * @ingroup Elm_Gengrid + * @ingroup Elm_Gengrid_Group */ typedef enum { diff --git a/src/lib/elementary/elm_gengrid_item_eo.h b/src/lib/elementary/elm_gengrid_item_eo.h index b11d264b81..f03b78fe7f 100644 --- a/src/lib/elementary/elm_gengrid_item_eo.h +++ b/src/lib/elementary/elm_gengrid_item_eo.h @@ -13,9 +13,17 @@ typedef Eo Elm_Gengrid_Item; #endif -/** Elementary gengrid item class +/** + * Elementary gengrid item class * - * @ingroup Elm_Gengrid_Item + * @defgroup Elm_Gengrid_Item_Group + * @ingroup Elm_Gengrid_Group + */ + +/** + * @brief Get gengrid item class + * + * @ingroup Elm_Gengrid_Item_Group */ #define ELM_GENGRID_ITEM_CLASS elm_gengrid_item_class_get() @@ -31,7 +39,7 @@ EWAPI const Efl_Class *elm_gengrid_item_class_get(void); * * @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); @@ -45,7 +53,7 @@ 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); @@ -63,7 +71,7 @@ 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); @@ -81,7 +89,7 @@ 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); @@ -95,7 +103,7 @@ 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); @@ -106,7 +114,7 @@ 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); @@ -121,7 +129,7 @@ EOAPI int elm_obj_gengrid_item_index_get(const Eo *obj); * @param[out] x Pointer to variable to store the item's row number. * @param[out] y Pointer to variable to store the item's column number. * - * @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); @@ -147,7 +155,7 @@ EOAPI void elm_obj_gengrid_item_pos_get(const Eo *obj, unsigned int *x, unsigned * @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); @@ -174,7 +182,7 @@ EOAPI void elm_obj_gengrid_item_select_mode_set(Eo *obj, Elm_Object_Select_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); @@ -196,7 +204,7 @@ 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); @@ -215,7 +223,7 @@ 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); @@ -229,7 +237,7 @@ 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); @@ -244,7 +252,7 @@ EOAPI void elm_obj_gengrid_item_show(Eo *obj, Elm_Gengrid_Item_Scrollto_Type typ * @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); @@ -256,7 +264,7 @@ EOAPI void elm_obj_gengrid_item_bring_in(Eo *obj, Elm_Gengrid_Item_Scrollto_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); @@ -277,7 +285,7 @@ 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); @@ -292,7 +300,7 @@ EOAPI void elm_obj_gengrid_item_fields_update(Eo *obj, const char *parts, Elm_Ge * @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); @@ -308,7 +316,7 @@ EOAPI void elm_obj_gengrid_item_class_update(Eo *obj, const Elm_Gengrid_Item_Cla * * @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); diff --git a/src/lib/elementary/elm_gengrid_item_eo.legacy.h b/src/lib/elementary/elm_gengrid_item_eo.legacy.h index 01f1a634db..6bbb187131 100644 --- a/src/lib/elementary/elm_gengrid_item_eo.legacy.h +++ b/src/lib/elementary/elm_gengrid_item_eo.legacy.h @@ -14,6 +14,11 @@ typedef Eo Elm_Gengrid_Item; #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. diff --git a/src/lib/elementary/elm_gengrid_legacy.h b/src/lib/elementary/elm_gengrid_legacy.h index 720563b896..492537e8e3 100644 --- a/src/lib/elementary/elm_gengrid_legacy.h +++ b/src/lib/elementary/elm_gengrid_legacy.h @@ -14,7 +14,7 @@ * @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); @@ -28,7 +28,7 @@ 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); @@ -80,7 +80,7 @@ EINA_DEPRECATED EAPI void elm_gengrid_page_show(const E * * @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); @@ -97,7 +97,7 @@ EINA_DEPRECATED EAPI void elm_gengrid_scroller_policy_set(Evas_Object * * * @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); @@ -121,7 +121,7 @@ EINA_DEPRECATED EAPI void elm_gengrid_scroller_policy_get(const Evas_Ob * * @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); @@ -139,7 +139,7 @@ EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina * * @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); @@ -218,7 +218,7 @@ EINA_DEPRECATED EAPI void elm_gengrid_page_bring_in(const Evas_Object * * @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); @@ -230,7 +230,7 @@ EAPI void elm_gengrid_page_size_set(Evas_Object *obj, int h_pagesize, int v_page * @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); @@ -242,7 +242,7 @@ EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, doub * @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); @@ -258,7 +258,7 @@ EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagere * @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); @@ -271,7 +271,7 @@ 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); diff --git a/src/lib/elementary/elm_genlist.h b/src/lib/elementary/elm_genlist.h index 918b9585a5..0a42f84e67 100644 --- a/src/lib/elementary/elm_genlist.h +++ b/src/lib/elementary/elm_genlist.h @@ -1,5 +1,5 @@ /** - * @defgroup Elm_Genlist Genlist (Generic list) + * @defgroup Elm_Genlist_Group Genlist (Generic list) * @ingroup Elementary * * @image html genlist_inheritance_tree.png @@ -393,7 +393,7 @@ */ /** - * @addtogroup Elm_Genlist + * @addtogroup Elm_Genlist_Group * @{ */ diff --git a/src/lib/elementary/elm_genlist_common.h b/src/lib/elementary/elm_genlist_common.h index 0b56d0e60c..3ab889fdca 100644 --- a/src/lib/elementary/elm_genlist_common.h +++ b/src/lib/elementary/elm_genlist_common.h @@ -44,7 +44,7 @@ typedef Elm_Gen_Item_Reusable_Content_Get_Cb Elm_Genlist_Reusable_Content_Get_Cb * @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); @@ -61,7 +61,7 @@ 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); @@ -74,7 +74,7 @@ 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); @@ -89,7 +89,7 @@ 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); @@ -108,7 +108,7 @@ 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); @@ -136,7 +136,7 @@ EAPI void elm_genlist_item_tooltip_text_set(Elm_Object_ * 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); @@ -153,7 +153,7 @@ EAPI void elm_genlist_item_tooltip_content_cb_set(Elm_O * * @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); @@ -176,7 +176,7 @@ EAPI void elm_genlist_item_tooltip_unset(Elm_Object_Ite * * @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); @@ -190,7 +190,7 @@ EAPI void elm_genlist_item_tooltip_style_set(Elm_Object * * @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); @@ -236,7 +236,7 @@ EAPI Eina_Bool elm_genlist_item_tooltip_window_mode_get(cons * @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); @@ -252,7 +252,7 @@ EAPI void elm_genlist_item_cursor_set(Elm_Object_Item * * @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); @@ -269,7 +269,7 @@ EAPI const char *elm_genlist_item_cursor_get(const Elm_Object_ * @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); @@ -294,7 +294,7 @@ EAPI void elm_genlist_item_cursor_unset(Elm_Object_Item * @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); @@ -308,7 +308,7 @@ EAPI void elm_genlist_item_cursor_style_set(Elm_Object_ * * @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); @@ -328,7 +328,7 @@ EAPI const char *elm_genlist_item_cursor_style_get(const Elm_O * @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); @@ -344,7 +344,7 @@ EAPI void elm_genlist_item_cursor_engine_only_set(Elm_O * * @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); diff --git a/src/lib/elementary/elm_genlist_eo.h b/src/lib/elementary/elm_genlist_eo.h index f132027980..77b43f49d0 100644 --- a/src/lib/elementary/elm_genlist_eo.h +++ b/src/lib/elementary/elm_genlist_eo.h @@ -15,7 +15,7 @@ typedef Eo Elm_Genlist; #endif /** Elementary genlist class * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_CLASS elm_genlist_class_get() @@ -38,7 +38,7 @@ EWAPI const Efl_Class *elm_genlist_class_get(void); * @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); @@ -50,7 +50,7 @@ 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); @@ -68,7 +68,7 @@ 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); @@ -79,7 +79,7 @@ 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); @@ -95,7 +95,7 @@ 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); @@ -106,7 +106,7 @@ 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); @@ -124,7 +124,7 @@ 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); @@ -135,7 +135,7 @@ 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); @@ -149,7 +149,7 @@ 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); @@ -160,7 +160,7 @@ 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); @@ -174,7 +174,7 @@ 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); @@ -185,7 +185,7 @@ 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); @@ -197,7 +197,7 @@ 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); @@ -208,7 +208,7 @@ 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); @@ -226,7 +226,7 @@ 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); @@ -239,7 +239,7 @@ EOAPI void elm_obj_genlist_multi_select_mode_set(Eo *obj, Elm_Object_Multi_Selec * * @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); @@ -262,7 +262,7 @@ EOAPI Elm_Object_Multi_Select_Mode elm_obj_genlist_multi_select_mode_get(const E * @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); @@ -273,7 +273,7 @@ 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); @@ -283,7 +283,7 @@ 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); @@ -294,7 +294,7 @@ 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); @@ -311,7 +311,7 @@ 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); @@ -323,7 +323,7 @@ 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); @@ -355,7 +355,7 @@ 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); @@ -367,7 +367,7 @@ 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); @@ -382,7 +382,7 @@ 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); @@ -400,7 +400,7 @@ 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); @@ -415,7 +415,7 @@ 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); @@ -431,7 +431,7 @@ 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; @@ -452,7 +452,7 @@ EOAPI Eina_List *elm_obj_genlist_realized_items_get(const Eo *obj) EINA_WARN_UNU * * @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); @@ -467,7 +467,7 @@ 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); @@ -488,7 +488,7 @@ 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); @@ -502,7 +502,7 @@ EOAPI Elm_Widget_Item *elm_obj_genlist_item_insert_before(Eo *obj, const Elm_Gen * 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); @@ -523,7 +523,7 @@ 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); @@ -546,7 +546,7 @@ EOAPI Elm_Widget_Item *elm_obj_genlist_item_insert_after(Eo *obj, const Elm_Genl * * @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); @@ -562,7 +562,7 @@ EOAPI Elm_Widget_Item *elm_obj_genlist_at_xy_item_get(const Eo *obj, int x, int * @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); @@ -576,7 +576,7 @@ 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); @@ -593,7 +593,7 @@ 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); @@ -606,7 +606,7 @@ 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); @@ -626,7 +626,7 @@ 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); @@ -636,7 +636,7 @@ EOAPI Elm_Widget_Item *elm_obj_genlist_item_prepend(Eo *obj, const Elm_Genlist_I * 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); @@ -656,7 +656,7 @@ 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); @@ -678,7 +678,7 @@ EOAPI Elm_Widget_Item *elm_obj_genlist_item_append(Eo *obj, const Elm_Genlist_It * * @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); @@ -704,7 +704,7 @@ EOAPI Elm_Widget_Item *elm_obj_genlist_item_sorted_insert(Eo *obj, const Elm_Gen * * @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); @@ -713,7 +713,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_ITEM_FOCUSED; /** 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)) @@ -722,7 +722,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_ITEM_UNFOCUSED; /** 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)) @@ -730,7 +730,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_VBAR_DRAG; /** Called when vertical bar is dragged * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_VBAR_DRAG (&(_ELM_GENLIST_EVENT_VBAR_DRAG)) @@ -738,7 +738,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_VBAR_PRESS; /** Called when vertical bar is pressed * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_VBAR_PRESS (&(_ELM_GENLIST_EVENT_VBAR_PRESS)) @@ -746,7 +746,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_VBAR_UNPRESS; /** 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)) @@ -754,7 +754,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_HBAR_DRAG; /** Called when horizontal bar is dragged * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_HBAR_DRAG (&(_ELM_GENLIST_EVENT_HBAR_DRAG)) @@ -762,7 +762,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_HBAR_PRESS; /** Called when horizontal bar is pressed * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_HBAR_PRESS (&(_ELM_GENLIST_EVENT_HBAR_PRESS)) @@ -770,7 +770,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_HBAR_UNPRESS; /** 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)) @@ -778,7 +778,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_EDGE_TOP; /** Called when top edge is reached * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_EDGE_TOP (&(_ELM_GENLIST_EVENT_EDGE_TOP)) @@ -786,7 +786,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_EDGE_BOTTOM; /** Called when bottom edge is reached * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_EDGE_BOTTOM (&(_ELM_GENLIST_EVENT_EDGE_BOTTOM)) @@ -794,7 +794,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_EDGE_LEFT; /** Called when left edge is reached * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_EDGE_LEFT (&(_ELM_GENLIST_EVENT_EDGE_LEFT)) @@ -802,7 +802,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_EDGE_RIGHT; /** Called when right edge is reached * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_EDGE_RIGHT (&(_ELM_GENLIST_EVENT_EDGE_RIGHT)) @@ -811,7 +811,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_MOVED; /** Called when genlist item moved * @return Efl_Object * * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_MOVED (&(_ELM_GENLIST_EVENT_MOVED)) @@ -820,7 +820,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_MOVED_BEFORE; /** 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)) @@ -829,7 +829,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_MOVED_AFTER; /** 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)) @@ -838,7 +838,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_SWIPE; /** Called when swipe is detected * @return Efl_Object * * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_SWIPE (&(_ELM_GENLIST_EVENT_SWIPE)) @@ -847,7 +847,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_MULTI_PINCH_IN; /** 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)) @@ -856,7 +856,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_MULTI_PINCH_OUT; /** 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)) @@ -865,7 +865,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_MULTI_SWIPE_DOWN; /** 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)) @@ -874,7 +874,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_MULTI_SWIPE_UP; /** 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)) @@ -883,7 +883,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_MULTI_SWIPE_RIGHT; /** 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)) @@ -892,7 +892,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_MULTI_SWIPE_LEFT; /** 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)) @@ -901,7 +901,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_RELEASED; /** Called when genlist is released * @return Efl_Object * * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_RELEASED (&(_ELM_GENLIST_EVENT_RELEASED)) @@ -910,7 +910,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_ACTIVATED; /** called when genlist is activated * @return Efl_Object * * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_ACTIVATED (&(_ELM_GENLIST_EVENT_ACTIVATED)) @@ -919,7 +919,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_HIGHLIGHTED; /** Called when genlist is highlighted * @return Efl_Object * * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_HIGHLIGHTED (&(_ELM_GENLIST_EVENT_HIGHLIGHTED)) @@ -928,7 +928,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_UNHIGHLIGHTED; /** 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)) @@ -937,7 +937,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_REALIZED; /** Called when genlist is realized * @return Efl_Object * * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_REALIZED (&(_ELM_GENLIST_EVENT_REALIZED)) @@ -946,7 +946,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_UNREALIZED; /** Called when genlist is unrealized * @return Efl_Object * * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_UNREALIZED (&(_ELM_GENLIST_EVENT_UNREALIZED)) @@ -955,7 +955,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_CONTRACT_REQUEST; /** 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)) @@ -964,7 +964,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_EXPAND_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)) @@ -973,7 +973,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_CONTRACTED; /** called when genlist is contracted * @return Efl_Object * * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_CONTRACTED (&(_ELM_GENLIST_EVENT_CONTRACTED)) @@ -982,7 +982,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_EXPANDED; /** Called when genlist is expanded * @return Efl_Object * * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_EXPANDED (&(_ELM_GENLIST_EVENT_EXPANDED)) @@ -991,7 +991,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_INDEX_UPDATE; /** 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)) @@ -999,7 +999,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_TREE_EFFECT_FINISHED /** 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)) @@ -1007,7 +1007,7 @@ EWAPI extern const Efl_Event_Description _ELM_GENLIST_EVENT_FILTER_DONE; /** Called when genlist filter is done * - * @ingroup Elm_Genlist + * @ingroup Elm_Genlist_Group */ #define ELM_GENLIST_EVENT_FILTER_DONE (&(_ELM_GENLIST_EVENT_FILTER_DONE)) diff --git a/src/lib/elementary/elm_genlist_item_eo.h b/src/lib/elementary/elm_genlist_item_eo.h index ef73deb4d2..2f98625f07 100644 --- a/src/lib/elementary/elm_genlist_item_eo.h +++ b/src/lib/elementary/elm_genlist_item_eo.h @@ -13,9 +13,17 @@ typedef Eo Elm_Genlist_Item; #endif -/** Elementary genlist item class +/** + * Elementary genlist item class * - * @ingroup Elm_Genlist_Item + * @defgroup Elm_Genlist_Item_Group + * @ingroup Elm_Genlist_Group + */ + +/** + * @brief Get genlist item class + * + * @ingroup Elm_Genlist_Item_Group */ #define ELM_GENLIST_ITEM_CLASS elm_genlist_item_class_get() @@ -40,7 +48,7 @@ EWAPI const Efl_Class *elm_genlist_item_class_get(void); * * @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); @@ -63,7 +71,7 @@ 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); @@ -77,7 +85,7 @@ 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); @@ -93,7 +101,7 @@ 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); @@ -108,7 +116,7 @@ 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); @@ -119,7 +127,7 @@ 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); @@ -141,7 +149,7 @@ 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); @@ -154,7 +162,7 @@ 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); @@ -165,7 +173,7 @@ 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); @@ -179,7 +187,7 @@ 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); @@ -192,7 +200,7 @@ 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); @@ -205,7 +213,7 @@ 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); @@ -219,7 +227,7 @@ 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); @@ -233,7 +241,7 @@ 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); @@ -261,7 +269,7 @@ 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); @@ -274,7 +282,7 @@ EOAPI void elm_obj_genlist_item_select_mode_set(Eo *obj, Elm_Object_Select_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); @@ -288,7 +296,7 @@ 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); @@ -304,7 +312,7 @@ 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); @@ -315,7 +323,7 @@ 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); @@ -330,7 +338,7 @@ 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); @@ -341,19 +349,19 @@ 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); @@ -368,7 +376,7 @@ 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); @@ -384,7 +392,7 @@ EOAPI void elm_obj_genlist_item_show(Eo *obj, Elm_Genlist_Item_Scrollto_Type typ * @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); @@ -398,7 +406,7 @@ EOAPI void elm_obj_genlist_item_bring_in(Eo *obj, Elm_Genlist_Item_Scrollto_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); @@ -419,7 +427,7 @@ 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); @@ -438,7 +446,7 @@ 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); @@ -452,7 +460,7 @@ EOAPI void elm_obj_genlist_item_fields_update(Eo *obj, const char *parts, Elm_Ge * @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); @@ -489,7 +497,7 @@ EOAPI void elm_obj_genlist_item_class_update(Eo *obj, const Elm_Genlist_Item_Cla * @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); diff --git a/src/lib/elementary/elm_genlist_item_eo.legacy.h b/src/lib/elementary/elm_genlist_item_eo.legacy.h index 7ef94fcb32..17fc09388c 100644 --- a/src/lib/elementary/elm_genlist_item_eo.legacy.h +++ b/src/lib/elementary/elm_genlist_item_eo.legacy.h @@ -14,6 +14,11 @@ typedef Eo Elm_Genlist_Item; #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. diff --git a/src/lib/elementary/elm_genlist_legacy.h b/src/lib/elementary/elm_genlist_legacy.h index 938c6b8f29..1109c88c4a 100644 --- a/src/lib/elementary/elm_genlist_legacy.h +++ b/src/lib/elementary/elm_genlist_legacy.h @@ -11,7 +11,7 @@ * @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); @@ -25,7 +25,7 @@ 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 * diff --git a/src/lib/elementary/elm_gesture_layer.h b/src/lib/elementary/elm_gesture_layer.h index 5987f89765..919d19af04 100644 --- a/src/lib/elementary/elm_gesture_layer.h +++ b/src/lib/elementary/elm_gesture_layer.h @@ -1,5 +1,5 @@ /** - * @defgroup Elm_Gesture_Layer Gesture Layer + * @defgroup Elm_Gesture_Layer_Group Gesture Layer * @ingroup Elementary * * @image html gesture_layer_inheritance_tree.png diff --git a/src/lib/elementary/elm_gesture_layer_legacy.h b/src/lib/elementary/elm_gesture_layer_legacy.h index 7c67737e93..a77ae588ec 100644 --- a/src/lib/elementary/elm_gesture_layer_legacy.h +++ b/src/lib/elementary/elm_gesture_layer_legacy.h @@ -10,7 +10,7 @@ * 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); @@ -32,7 +32,7 @@ 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); @@ -49,6 +49,6 @@ EAPI void elm_gesture_layer_tap_longpress_cb_add(Evas_Object *obj, Elm_Gesture_S * * @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);