From: Myoungwoon Roy, Kim Date: Mon, 29 Jun 2020 09:52:33 +0000 (+0900) Subject: docs: Correct the wrong API group name in Edje and Elm_Box X-Git-Tag: submit/tizen/20200630.100857^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F48%2F237348%2F3;p=platform%2Fupstream%2Fefl.git docs: Correct the wrong API group name in Edje and Elm_Box Change-Id: Iaa5c77f33425a172bf03d3553d81d29b2609892a --- diff --git a/src/lib/edje/Edje_Legacy.h b/src/lib/edje/Edje_Legacy.h index 0230dfb..1389dff 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); @@ -784,6 +806,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 + * * @if MOBILE @since_tizen 2.3 * @elseif WEARABLE @since_tizen 2.3.1 * @endif @@ -802,6 +826,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 + * * @if MOBILE @since_tizen 2.3 * @elseif WEARABLE @since_tizen 2.3.1 * @endif @@ -824,6 +850,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 + * * @if MOBILE @since_tizen 2.3 * @elseif WEARABLE @since_tizen 2.3.1 * @endif @@ -862,7 +890,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); @@ -884,7 +912,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); @@ -920,7 +948,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); @@ -956,7 +984,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); @@ -967,7 +995,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); @@ -982,7 +1010,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); @@ -993,7 +1021,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); @@ -1011,7 +1039,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); @@ -1029,7 +1057,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); @@ -1048,7 +1076,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); @@ -1087,7 +1115,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); @@ -1103,7 +1131,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); @@ -1119,7 +1147,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); @@ -1136,7 +1164,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); @@ -1153,7 +1181,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); @@ -1166,7 +1194,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); @@ -1180,7 +1208,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); @@ -1192,7 +1220,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); @@ -1206,7 +1234,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); @@ -1223,7 +1251,7 @@ EAPI Eina_Bool edje_object_part_table_clear(Evas_Object *obj, const char *part, * * @return The description of the target color class or $null if not found * - * @ingroup Edje_Object + * @ingroup Edje_Object_Color_Class */ EAPI const char *edje_object_color_class_description_get(const Evas_Object *obj, const char *color_class); @@ -1257,7 +1285,7 @@ EAPI const char *edje_object_color_class_description_get(const Evas_Object *obj, * @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); @@ -1289,7 +1317,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); @@ -1307,7 +1335,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); @@ -1322,7 +1350,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); @@ -1337,7 +1365,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); @@ -1354,7 +1382,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); @@ -1371,7 +1399,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); @@ -1392,7 +1420,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); @@ -1413,7 +1441,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); @@ -1430,7 +1458,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); @@ -1444,7 +1472,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); @@ -1462,7 +1490,7 @@ EAPI void edje_object_part_text_select_allow_set(const Evas_Object *obj, const c * @param[in] part The part name * @param[in] disable true to disble, false otherwise * - * @ingroup Edje_Object + * @ingroup Edje_Object_Part */ EAPI void edje_object_part_text_select_disable_set(const Edje_Object *obj, const char *part, Eina_Bool disable); @@ -1473,7 +1501,7 @@ EAPI void edje_object_part_text_select_disable_set(const Edje_Object *obj, const * * @since 1.1.0 * - * @ingroup Edje_Object + * @ingroup Edje_Object_Group */ EAPI void edje_object_mirrored_set(Evas_Object *obj, Eina_Bool rtl); @@ -1486,7 +1514,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); @@ -1497,7 +1525,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); @@ -1508,7 +1536,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); @@ -1532,7 +1560,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); @@ -1547,7 +1575,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); @@ -1561,7 +1589,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); @@ -1592,7 +1620,6 @@ typedef enum _Edje_Drag_Dir EDJE_DRAG_DIR_XY = 3 /**< Part can be dragged in every direction. */ } Edje_Drag_Dir; - /** * @brief Sets the dragable object location. * @@ -1823,7 +1850,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); @@ -1834,7 +1861,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); @@ -1845,7 +1872,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); @@ -1856,7 +1883,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); @@ -1869,7 +1896,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); @@ -1883,7 +1910,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); @@ -1899,7 +1926,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); @@ -1910,7 +1937,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); @@ -1921,7 +1948,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); @@ -1934,7 +1961,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); @@ -1947,7 +1974,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); @@ -1959,7 +1986,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); @@ -1971,7 +1998,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); @@ -1982,7 +2009,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); @@ -1998,7 +2025,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); @@ -2011,7 +2038,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); @@ -2025,7 +2052,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); @@ -2038,7 +2065,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); @@ -2052,7 +2079,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); @@ -2067,7 +2094,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); @@ -2080,7 +2107,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); @@ -2095,7 +2122,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); @@ -2109,7 +2136,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); @@ -2120,7 +2147,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); @@ -2138,7 +2165,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); @@ -2151,7 +2178,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); @@ -2186,7 +2213,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); @@ -2204,7 +2231,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); @@ -2223,7 +2250,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); @@ -2256,7 +2283,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); @@ -2276,7 +2303,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); @@ -2298,7 +2325,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); @@ -2313,7 +2340,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); @@ -2328,7 +2355,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); @@ -2346,7 +2373,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); @@ -2364,7 +2391,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); @@ -2381,7 +2408,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); @@ -2394,7 +2421,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); @@ -2406,7 +2433,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); @@ -2419,7 +2446,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); @@ -2431,7 +2458,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); @@ -2444,7 +2471,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); @@ -2460,7 +2487,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); @@ -2474,7 +2501,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); @@ -2487,7 +2514,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); @@ -2500,7 +2527,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); @@ -2516,7 +2543,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); @@ -2532,7 +2559,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); @@ -2549,7 +2576,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); @@ -2564,7 +2591,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); @@ -2581,7 +2608,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); @@ -2596,7 +2623,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); @@ -2610,7 +2637,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); @@ -2626,7 +2653,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); @@ -2643,7 +2670,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); @@ -2658,7 +2685,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); @@ -2671,7 +2698,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); @@ -2686,7 +2713,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); @@ -2698,7 +2725,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); @@ -2712,7 +2739,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); @@ -2727,7 +2754,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); @@ -2743,7 +2770,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); @@ -2758,7 +2785,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); @@ -2773,7 +2800,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); @@ -2786,7 +2813,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); @@ -2801,7 +2828,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); @@ -2815,7 +2842,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); @@ -2824,7 +2851,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); @@ -2833,7 +2860,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); @@ -2842,7 +2869,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); @@ -2853,7 +2880,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); @@ -2864,7 +2891,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); @@ -2880,7 +2907,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); @@ -2902,7 +2929,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); @@ -2924,7 +2951,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); @@ -2939,7 +2966,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); @@ -2954,7 +2981,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); @@ -2976,7 +3003,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); @@ -2998,7 +3025,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); @@ -3016,7 +3043,7 @@ 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); @@ -3032,7 +3059,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); @@ -3046,7 +3073,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); @@ -3188,6 +3215,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) * * This function sets the text class for All Edje Objects created from Edje file. @@ -3199,6 +3230,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); @@ -3209,6 +3243,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); @@ -3222,14 +3259,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/elm_box.h b/src/lib/elementary/elm_box.h index bc68eea..0c64ff1 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 f16b72c..7eeb53b 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_legacy.h b/src/lib/elementary/elm_box_legacy.h index 1afb296..ad8aaa9 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);