From 49abb98ae921121273dfc2b8cc7103896572b412 Mon Sep 17 00:00:00 2001 From: Daniel Zaoui Date: Mon, 29 Oct 2012 07:26:16 +0000 Subject: [PATCH] Added descriptions to Eo defines Signed-off-by: Daniel Zaoui SVN revision: 78599 --- legacy/edje/src/lib/Edje.h | 1596 ++++++++++++++++++++++++++++++++++++ 1 file changed, 1596 insertions(+) diff --git a/legacy/edje/src/lib/Edje.h b/legacy/edje/src/lib/Edje.h index a9a2085317..5c52c21f36 100644 --- a/legacy/edje/src/lib/Edje.h +++ b/legacy/edje/src/lib/Edje.h @@ -971,129 +971,1578 @@ enum #define EDJE_OBJ_ID(sub_id) (EDJE_OBJ_BASE_ID + sub_id) + +/** + * @def edje_obj_scale_set + * + * @brief Set the scaling factor for a given Edje object. + * + * @param[in] scale + * @param[out] ret + * + * @see edje_object_scale_set + */ #define edje_obj_scale_set(scale, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_SCALE_SET), EO_TYPECHECK(double, scale), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_scale_get + * + * @brief Get a given Edje object's scaling factor. + * + * @param[out] ret + * + * @see edje_object_scale_get + */ #define edje_obj_scale_get(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_SCALE_GET), EO_TYPECHECK(double *, ret) + +/** + * @def edje_obj_mirrored_get + * + * @brief Get the RTL orientation for this object. + * + * @param[out] ret + * + * @see edje_object_mirrored_get + */ #define edje_obj_mirrored_get(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_MIRRORED_GET), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_mirrored_set + * + * @brief Set the RTL orientation for this object. + * + * @param[in] rtl + * + * @see edje_object_mirrored_set + */ #define edje_obj_mirrored_set(rtl) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_MIRRORED_SET), EO_TYPECHECK(Eina_Bool, rtl) + +/** + * @def edje_obj_data_get + * + * @brief Retrieve an EDC data field's value from a given Edje. + * + * @param[in] key + * @param[out] ret + * + * @see edje_object_data_get + */ #define edje_obj_data_get(key, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_DATA_GET), EO_TYPECHECK(const char *, key), EO_TYPECHECK(const char **, ret) + +/** + * @def edje_obj_freeze + * + * @brief Freezes the Edje object. + * + * @param[out] ret + * + * @see edje_object_freeze + */ #define edje_obj_freeze(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_FREEZE), EO_TYPECHECK(int *, ret) + +/** + * @def edje_obj_thaw + * + * @brief Thaws the Edje object. + * + * @param[out] ret + * + * @see edje_object_thaw + */ #define edje_obj_thaw(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_THAW), EO_TYPECHECK(int *, ret) + +/** + * @def edje_obj_color_class_set + * + * @brief Sets the object color class. + * + * @param[in] color_class + * @param[in] r + * @param[in] g + * @param[in] b + * @param[in] a + * @param[in] r2 + * @param[in] g2 + * @param[in] b2 + * @param[in] a2 + * @param[in] r3 + * @param[in] g3 + * @param[in] b3 + * @param[in] a3 + * @param[out] ret + * + * @see edje_object_color_class_set + */ #define edje_obj_color_class_set(color_class, r, g, b, a, r2, g2, b2, a2, r3, g3, b3, a3, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_COLOR_CLASS_SET), EO_TYPECHECK(const char *, color_class), EO_TYPECHECK(int, r), EO_TYPECHECK(int, g), EO_TYPECHECK(int, b), EO_TYPECHECK(int, a), EO_TYPECHECK(int, r2), EO_TYPECHECK(int, g2), EO_TYPECHECK(int, b2), EO_TYPECHECK(int, a2), EO_TYPECHECK(int, r3), EO_TYPECHECK(int, g3), EO_TYPECHECK(int, b3), EO_TYPECHECK(int, a3), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_color_class_get + * + * @brief Gets the object color class. + * + * @param[in] color_class + * @param[out] r + * @param[out] g + * @param[out] b + * @param[out] a + * @param[out] r2 + * @param[out] g2 + * @param[out] b2 + * @param[out] a2 + * @param[out] r3 + * @param[out] g3 + * @param[out] b3 + * @param[out] a3 + * @param[out] ret + * + * @see edje_object_color_class_get + */ #define edje_obj_color_class_get(color_class, r, g, b, a, r2, g2, b2, a2, r3, g3, b3, a3, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_COLOR_CLASS_GET), EO_TYPECHECK(const char *, color_class), EO_TYPECHECK(int *, r), EO_TYPECHECK(int *, g), EO_TYPECHECK(int *, b), EO_TYPECHECK(int *, a), EO_TYPECHECK(int *, r2), EO_TYPECHECK(int *, g2), EO_TYPECHECK(int *, b2), EO_TYPECHECK(int *, a2), EO_TYPECHECK(int *, r3), EO_TYPECHECK(int *, g3), EO_TYPECHECK(int *, b3), EO_TYPECHECK(int *, a3), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_text_class_set + * + * @brief Sets Edje text class. + * + * @param[in] text_class + * @param[in] font + * @param[in] size + * @param[out] ret + * + * @see edje_object_text_class_set + */ #define edje_obj_text_class_set(text_class, font, size, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_TEXT_CLASS_SET), EO_TYPECHECK(const char *, text_class), EO_TYPECHECK(const char *, font), EO_TYPECHECK(Evas_Font_Size, size), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_exists + * + * @brief Check if an Edje part exists in a given Edje object's group + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_exists + */ #define edje_obj_part_exists(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_EXISTS), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_object_get + * + * @brief Get a handle to the Evas object implementing a given Edje + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_object_get + */ #define edje_obj_part_object_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_OBJECT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const Evas_Object **, ret) + +/** + * @def edje_obj_part_geometry_get + * + * @brief Retrieve the geometry of a given Edje part, in a given Edje + * + * @param[in] part + * @param[out] x + * @param[out] y + * @param[out] w + * @param[out] h + * @param[out] ret + * + * @see edje_object_part_geometry_get + */ #define edje_obj_part_geometry_get(part, x, y, w, h, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_GEOMETRY_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Coord *, x), EO_TYPECHECK(Evas_Coord *, y), EO_TYPECHECK(Evas_Coord *, w), EO_TYPECHECK(Evas_Coord *, h), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_item_provider_set + * + * @brief Set the function that provides item objects for named items in an edje entry text + * + * @param[in] func + * @param[in] data + * + * @see edje_object_item_provider_set + */ #define edje_obj_item_provider_set(func, data) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_ITEM_PROVIDER_SET), EO_TYPECHECK(Edje_Item_Provider_Cb, func), EO_TYPECHECK(void *, data) + +/** + * @def edje_obj_text_change_cb_set + * + * @brief Set the object text callback. + * + * @param[in] func + * @param[in] data + * + * @see edje_object_text_change_cb_set + */ #define edje_obj_text_change_cb_set(func, data) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_TEXT_CHANGE_CB_SET), EO_TYPECHECK(Edje_Text_Change_Cb, func), EO_TYPECHECK(void *, data) + +/** + * @def edje_obj_part_text_style_user_push + * + * @brief Set the style of the part. + * + * @param[in] part + * @param[in] style + * + * @see edje_object_part_text_style_user_push + */ #define edje_obj_part_text_style_user_push(part, style) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_STYLE_USER_PUSH), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, style) + +/** + * @def edje_obj_part_text_style_user_pop + * + * @brief Delete the top style form the user style stack. + * + * @param[in] part + * + * @see edje_object_part_text_style_user_pop + */ #define edje_obj_part_text_style_user_pop(part) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_STYLE_USER_POP), EO_TYPECHECK(const char *, part) + +/** + * @def edje_obj_part_text_style_user_peek + * + * @brief Return the text of the object part. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_style_user_peek + */ #define edje_obj_part_text_style_user_peek(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_STYLE_USER_PEEK), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char **, ret) + +/** + * @def edje_obj_part_text_set + * + * @brief Sets the text for an object part + * + * @param[in] part + * @param[in] text + * @param[out] ret + * + * @see edje_object_part_text_set + */ #define edje_obj_part_text_set(part, text, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, text), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_get + * + * @brief Return the text of the object part. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_get + */ #define edje_obj_part_text_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char **, ret) + +/** + * @def edje_obj_part_text_escaped_set + * + * @brief Sets the text for an object part, but converts HTML escapes to UTF8 + * + * @param[in] part + * @param[in] text + * @param[out] ret + * + * @see edje_object_part_text_escaped_set + */ #define edje_obj_part_text_escaped_set(part, text, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_ESCAPED_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, text), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_unescaped_set + * + * @brief Sets the raw (non escaped) text for an object part. + * + * @param[in] part + * @param[in] text_to_escape + * @param[out] ret + * + * @see edje_object_part_text_unescaped_set + */ #define edje_obj_part_text_unescaped_set(part, text_to_escape, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_UNESCAPED_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, text_to_escape), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_unescaped_get + * + * @brief Returns the text of the object part, without escaping. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_unescaped_get + */ #define edje_obj_part_text_unescaped_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_UNESCAPED_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(char **, ret) + +/** + * @def edje_obj_part_text_selection_get + * + * @brief Return the selection text of the object part. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_selection_get + */ #define edje_obj_part_text_selection_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_SELECTION_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char **, ret) + +/** + * @def edje_obj_part_text_select_none + * + * @brief Set the selection to be none. + * + * @param[in] part + * + * @see edje_object_part_text_select_none + */ #define edje_obj_part_text_select_none(part) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_SELECT_NONE), EO_TYPECHECK(const char *, part) + +/** + * @def edje_obj_part_text_select_all + * + * @brief Set the selection to be everything. + * + * @param[in] part + * + * @see edje_object_part_text_select_all + */ #define edje_obj_part_text_select_all(part) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_SELECT_ALL), EO_TYPECHECK(const char *, part) + +/** + * @def edje_obj_part_text_insert + * + * @brief Insert text for an object part. + * + * @param[in] part + * @param[in] text + * + * @see edje_object_part_text_insert + */ #define edje_obj_part_text_insert(part, text) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INSERT), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, text) + +/** + * @def edje_obj_part_text_append + * + * @brief Insert text for an object part. + * + * @param[in] part + * @param[in] text + * + * @see edje_object_part_text_append + */ #define edje_obj_part_text_append(part, text) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_APPEND), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, text) + +/** + * @def edje_obj_part_text_anchor_list_get + * + * @brief Return a list of char anchor names. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_anchor_list_get + */ #define edje_obj_part_text_anchor_list_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_ANCHOR_LIST_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const Eina_List **, ret) + +/** + * @def edje_obj_part_text_anchor_geometry_get + * + * @brief Return a list of Evas_Textblock_Rectangle anchor rectangles. + * + * @param[in] part + * @param[in] anchor + * @param[out] ret + * + * @see edje_object_part_text_anchor_geometry_get + */ #define edje_obj_part_text_anchor_geometry_get(part, anchor, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_ANCHOR_GEOMETRY_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, anchor), EO_TYPECHECK(const Eina_List **, ret) + +/** + * @def edje_obj_part_text_item_list_get + * + * @brief Return a list of char item names. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_item_list_get + */ #define edje_obj_part_text_item_list_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_ITEM_LIST_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const Eina_List **, ret) + +/** + * @def edje_obj_part_text_item_geometry_get + * + * @brief Return item geometry. + * + * @param[in] part + * @param[in] item + * @param[out] cx + * @param[out] cy + * @param[out] cw + * @param[out] ch + * @param[out] ret + * + * @see edje_object_part_text_item_geometry_get + */ #define edje_obj_part_text_item_geometry_get(part, item, cx, cy, cw, ch, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_ITEM_GEOMETRY_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, item), EO_TYPECHECK(Evas_Coord *, cx), EO_TYPECHECK(Evas_Coord *, cy), EO_TYPECHECK(Evas_Coord *, cw), EO_TYPECHECK(Evas_Coord *, ch), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_cursor_geometry_get + * + * @brief Returns the cursor geometry of the part relative to the edje + * + * @param[in] part + * @param[out] x + * @param[out] y + * @param[out] w + * @param[out] h + * + * @see edje_object_part_text_cursor_geometry_get + */ #define edje_obj_part_text_cursor_geometry_get(part, x, y, w, h) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_GEOMETRY_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Coord *, x), EO_TYPECHECK(Evas_Coord *, y), EO_TYPECHECK(Evas_Coord *, w), EO_TYPECHECK(Evas_Coord *, h) + +/** + * @def edje_obj_part_text_user_insert + * + * @brief This function inserts text as if the user has inserted it. + * + * @param[in] part + * @param[in] text + * + * @see edje_object_part_text_user_insert + */ #define edje_obj_part_text_user_insert(part, text) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_USER_INSERT), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, text) + +/** + * @def edje_obj_part_text_select_allow_set + * + * @brief Enables selection if the entry is an EXPLICIT selection mode + * + * @param[in] part + * @param[in] allow + * + * @see edje_object_part_text_select_allow_set + */ #define edje_obj_part_text_select_allow_set(part, allow) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_SELECT_ALLOW_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool, allow) + +/** + * @def edje_obj_part_text_select_abort + * + * @brief Aborts any selection action on a part. + * + * @param[in] part + * + * @see edje_object_part_text_select_abort + */ #define edje_obj_part_text_select_abort(part) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_SELECT_ABORT), EO_TYPECHECK(const char *, part) + +/** + * @def edje_obj_part_text_select_begin + * + * @brief Starts selecting at current cursor position + * + * @param[in] part + * + * @see edje_object_part_text_select_begin + */ #define edje_obj_part_text_select_begin(part) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_SELECT_BEGIN), EO_TYPECHECK(const char *, part) + +/** + * @def edje_obj_part_text_select_extend + * + * @brief Extends the current selection to the current cursor position + * + * @param[in] part + * + * @see edje_object_part_text_select_extend + */ #define edje_obj_part_text_select_extend(part) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_SELECT_EXTEND), EO_TYPECHECK(const char *, part) + +/** + * @def edje_obj_part_text_imf_context_get + * + * @brief Get the input method context in entry. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_imf_context_get + */ #define edje_obj_part_text_imf_context_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_IMF_CONTEXT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(void **, ret) + +/** + * @def edje_obj_part_text_cursor_next + * + * @brief Advances the cursor to the next cursor position. + * + * @param[in] part + * @param[in] cur + * @param[out] ret + * + * @see edje_object_part_text_cursor_next + */ #define edje_obj_part_text_cursor_next(part, cur, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_NEXT), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_cursor_prev + * + * @brief Moves the cursor to the previous char + * + * @param[in] part + * @param[in] cur + * @param[out] ret + * + * @see edje_object_part_text_cursor_prev + */ #define edje_obj_part_text_cursor_prev(part, cur, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_PREV), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_cursor_up + * + * @brief Move the cursor to the char above the current cursor position. + * + * @param[in] part + * @param[in] cur + * @param[out] ret + * + * @see edje_object_part_text_cursor_up + */ #define edje_obj_part_text_cursor_up(part, cur, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_UP), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_cursor_down + * + * @brief Moves the cursor to the char below the current cursor position. + * + * @param[in] part + * @param[in] cur + * @param[out] ret + * + * @see edje_object_part_text_cursor_down + */ #define edje_obj_part_text_cursor_down(part, cur, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_DOWN), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_cursor_begin_set + * + * @brief Moves the cursor to the beginning of the text part + * + * @param[in] part + * @param[in] cur + * + * @see edje_object_part_text_cursor_begin_set + */ #define edje_obj_part_text_cursor_begin_set(part, cur) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_BEGIN_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur) + +/** + * @def edje_obj_part_text_cursor_end_set + * + * @brief Moves the cursor to the end of the text part. + * + * @param[in] part + * @param[in] cur + * + * @see edje_object_part_text_cursor_end_set + */ #define edje_obj_part_text_cursor_end_set(part, cur) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_END_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur) + +/** + * @def edje_obj_part_text_cursor_copy + * + * @brief Copy the cursor to another cursor. + * + * @param[in] part + * @param[in] src + * @param[in] dst + * + * @see edje_object_part_text_cursor_copy + */ #define edje_obj_part_text_cursor_copy(part, src, dst) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_COPY), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, src), EO_TYPECHECK(Edje_Cursor, dst) + +/** + * @def edje_obj_part_text_cursor_line_begin_set + * + * @brief Move the cursor to the beginning of the line. + * + * @param[in] part + * @param[in] cur + * + * @see edje_object_part_text_cursor_line_begin_set + */ #define edje_obj_part_text_cursor_line_begin_set(part, cur) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_LINE_BEGIN_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur) + +/** + * @def edje_obj_part_text_cursor_line_end_set + * + * @brief Move the cursor to the end of the line. + * + * @param[in] part + * @param[in] cur + * + * @see edje_object_part_text_cursor_line_end_set + */ #define edje_obj_part_text_cursor_line_end_set(part, cur) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_LINE_END_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur) + +/** + * @def edje_obj_part_text_cursor_coord_set + * + * Position the given cursor to a X,Y position. + * + * @param[in] part + * @param[in] cur + * @param[in] x + * @param[in] y + * @param[out] ret + * + * @see edje_object_part_text_cursor_coord_set + */ #define edje_obj_part_text_cursor_coord_set(part, cur, x, y, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_COORD_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur), EO_TYPECHECK(Evas_Coord, x), EO_TYPECHECK(Evas_Coord, y), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_cursor_is_format_get + * + * @brief Returns whether the cursor points to a format. + * + * @param[in] part + * @param[in] cur + * @param[out] ret + * + * @see edje_object_part_text_cursor_is_format_get + */ #define edje_obj_part_text_cursor_is_format_get(part, cur, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_IS_FORMAT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_cursor_is_visible_format_get + * + * @brief Return true if the cursor points to a visible format + * + * @param[in] part + * @param[in] cur + * @param[out] ret + * + * @see edje_object_part_text_cursor_is_visible_format_get + */ #define edje_obj_part_text_cursor_is_visible_format_get(part, cur, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_IS_VISIBLE_FORMAT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_cursor_content_get + * + * @brief Returns the content (char) at the cursor position. + * + * @param[in] part + * @param[in] cur + * @param[out] ret + * + * @see edje_object_part_text_cursor_content_get + */ #define edje_obj_part_text_cursor_content_get(part, cur, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_CONTENT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur), EO_TYPECHECK(char **, ret) + +/** + * @def edje_obj_part_text_cursor_pos_set + * + * @brief Sets the cursor position to the given value + * + * @param[in] part + * @param[in] cur + * @param[in] pos + * + * @see edje_object_part_text_cursor_pos_set + */ #define edje_obj_part_text_cursor_pos_set(part, cur, pos) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_POS_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur), EO_TYPECHECK(int, pos) + +/** + * @def edje_obj_part_text_cursor_pos_get + * + * @brief Retrieves the current position of the cursor + * + * @param[in] part + * @param[in] cur + * @param[out] ret + * + * @see edje_object_part_text_cursor_pos_get + */ #define edje_obj_part_text_cursor_pos_get(part, cur, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_CURSOR_POS_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Cursor, cur), EO_TYPECHECK(int *, ret) + +/** + * @def edje_obj_part_text_imf_context_reset + * + * @brief Reset the input method context if needed. + * + * @param[in] part + * + * @see edje_object_part_text_imf_context_reset + */ #define edje_obj_part_text_imf_context_reset(part) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_IMF_CONTEXT_RESET), EO_TYPECHECK(const char *, part) + +/** + * @def edje_obj_part_text_input_panel_layout_set + * + * @brief Set the layout of the input panel. + * + * @param[in] part + * @param[in] layout + * + * @see edje_object_part_text_input_panel_layout_set + */ #define edje_obj_part_text_input_panel_layout_set(part, layout) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_LAYOUT_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Input_Panel_Layout, layout) + +/** + * @def edje_obj_part_text_input_panel_layout_get + * + * @brief Get the layout of the input panel. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_input_panel_layout_get + */ #define edje_obj_part_text_input_panel_layout_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_LAYOUT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Input_Panel_Layout *, ret) + +/** + * @def edje_obj_part_text_autocapital_type_set + * + * @brief Set the autocapitalization type on the immodule. + * + * @param[in] part + * @param[in] autocapital_type + * + * @see edje_object_part_text_autocapital_type_set + */ #define edje_obj_part_text_autocapital_type_set(part, autocapital_type) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_AUTOCAPITAL_TYPE_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Text_Autocapital_Type, autocapital_type) + +/** + * @def edje_obj_part_text_autocapital_type_get + * + * @brief Retrieves the autocapitalization type + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_autocapital_type_get + */ #define edje_obj_part_text_autocapital_type_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_AUTOCAPITAL_TYPE_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Text_Autocapital_Type *, ret) + +/** + * @def edje_obj_part_text_prediction_allow_set + * + * @brief Set whether the prediction is allowed or not. + * + * @param[in] part + * @param[in] prediction + * + * @see edje_object_part_text_prediction_allow_set + */ #define edje_obj_part_text_prediction_allow_set(part, prediction) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_PREDICTION_ALLOW_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool, prediction) + +/** + * @def edje_obj_part_text_prediction_allow_get + * + * @brief Get whether the prediction is allowed or not. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_prediction_allow_get + */ #define edje_obj_part_text_prediction_allow_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_PREDICTION_ALLOW_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_input_panel_enabled_set + * + * @brief Sets the attribute to show the input panel automatically. + * + * @param[in] part + * @param[in] enabled + * + * @see edje_object_part_text_input_panel_enabled_set + */ #define edje_obj_part_text_input_panel_enabled_set(part, enabled) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_ENABLED_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool, enabled) + +/** + * @def edje_obj_part_text_input_panel_enabled_get + * + * @brief Retrieve the attribute to show the input panel automatically. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_input_panel_enabled_get + */ #define edje_obj_part_text_input_panel_enabled_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_ENABLED_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_text_input_panel_show + * + * @brief Show the input panel (virtual keyboard) based on the input panel property such as layout, autocapital types, and so on. + * + * @param[in] part + * + * @see edje_object_part_text_input_panel_show + */ #define edje_obj_part_text_input_panel_show(part) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_SHOW), EO_TYPECHECK(const char *, part) + +/** + * @def edje_obj_part_text_input_panel_hide + * + * @brief Hide the input panel (virtual keyboard). + * + * @param[in] part + * + * @see edje_object_part_text_input_panel_hide + */ #define edje_obj_part_text_input_panel_hide(part) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_HIDE), EO_TYPECHECK(const char *, part) + +/** + * @def edje_obj_part_text_input_panel_language_set + * + * Set the language mode of the input panel. + * + * @param[in] part + * @param[in] lang + * + * @see edje_object_part_text_input_panel_language_set + */ #define edje_obj_part_text_input_panel_language_set(part, lang) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_LANGUAGE_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Input_Panel_Lang, lang) + +/** + * @def edje_obj_part_text_input_panel_language_get + * + * Get the language mode of the input panel. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_input_panel_language_get + */ #define edje_obj_part_text_input_panel_language_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_LANGUAGE_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Input_Panel_Lang *, ret) + +/** + * @def edje_obj_part_text_input_panel_imdata_set + * + * Set the input panel-specific data to deliver to the input panel. + * + * @param[in] part + * @param[in] data + * @param[in] len + * + * @see edje_object_part_text_input_panel_imdata_set + */ #define edje_obj_part_text_input_panel_imdata_set(part, data, len) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_IMDATA_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const void *, data), EO_TYPECHECK(int, len) + +/** + * @def edje_obj_part_text_input_panel_imdata_get + * + * Get the specific data of the current active input panel. + * + * @param[in] part + * @param[in] data + * @param[in] len + * + * @see edje_object_part_text_input_panel_imdata_get + */ #define edje_obj_part_text_input_panel_imdata_get(part, data, len) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_IMDATA_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(void *, data), EO_TYPECHECK(int *, len) + +/** + * @def edje_obj_part_text_input_panel_return_key_type_set + * + * Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel. + * + * @param[in] part + * @param[out] return_key_type + * + * @see edje_object_part_text_input_panel_return_key_type_set + */ #define edje_obj_part_text_input_panel_return_key_type_set(part, return_key_type) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_RETURN_KEY_TYPE_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Input_Panel_Return_Key_Type, return_key_type) + +/** + * @def edje_obj_part_text_input_panel_return_key_type_get + * + * Get the "return" key type. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_input_panel_return_key_type_get + */ #define edje_obj_part_text_input_panel_return_key_type_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_RETURN_KEY_TYPE_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Input_Panel_Return_Key_Type *, ret) + +/** + * @def edje_obj_part_text_input_panel_return_key_disabled_set + * + * Set the return key on the input panel to be disabled. + * + * @param[in] part + * @param[in] disabled + * + * @see edje_object_part_text_input_panel_return_key_disabled_set + */ #define edje_obj_part_text_input_panel_return_key_disabled_set(part, disabled) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_RETURN_KEY_DISABLED_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool, disabled) + +/** + * @def edje_obj_part_text_input_panel_return_key_disabled_get + * + * Get whether the return key on the input panel should be disabled or not. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_text_input_panel_return_key_disabled_get + */ #define edje_obj_part_text_input_panel_return_key_disabled_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TEXT_INPUT_PANEL_RETURN_KEY_DISABLED_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_text_insert_filter_callback_add + * + * Add a filter function for newly inserted text. + * + * @param[in] part + * @param[in] func + * @param[in] data + * + * @see edje_object_text_insert_filter_callback_add + */ #define edje_obj_text_insert_filter_callback_add(part, func, data) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_TEXT_INSERT_FILTER_CALLBACK_ADD), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Text_Filter_Cb, func), EO_TYPECHECK(void *, data) + +/** + * @def edje_obj_text_insert_filter_callback_del + * + * Delete a function from the filter list. + * + * @param[in] part + * @param[in] func + * @param[out] ret + * + * @see edje_object_text_insert_filter_callback_del + */ #define edje_obj_text_insert_filter_callback_del(part, func, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_TEXT_INSERT_FILTER_CALLBACK_DEL), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Text_Filter_Cb, func), EO_TYPECHECK(void **, ret) + +/** + * @def edje_obj_text_insert_filter_callback_del_full + * + * Delete a function and matching user data from the filter list. + * + * @param[in] part + * @param[in] func + * @param[in] data + * @param[out] ret + * + * @see edje_object_text_insert_filter_callback_del_full + */ #define edje_obj_text_insert_filter_callback_del_full(part, func, data, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_TEXT_INSERT_FILTER_CALLBACK_DEL_FULL), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Text_Filter_Cb, func), EO_TYPECHECK(void *, data), EO_TYPECHECK(void **, ret) + +/** + * @def edje_obj_text_markup_filter_callback_add + * + * Add a markup filter function for newly inserted text. + * + * @param[in] part + * @param[in] func + * @param[in] data + * + * @see edje_object_text_markup_filter_callback_add + */ #define edje_obj_text_markup_filter_callback_add(part, func, data) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_TEXT_MARKUP_FILTER_CALLBACK_ADD), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Markup_Filter_Cb, func), EO_TYPECHECK(void *, data) + +/** + * @def edje_obj_text_markup_filter_callback_del + * + * Delete a function from the markup filter list. + * + * @param[in] part + * @param[in] func + * @param[out] ret + * + * @see edje_object_text_markup_filter_callback_del + */ #define edje_obj_text_markup_filter_callback_del(part, func, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_TEXT_MARKUP_FILTER_CALLBACK_DEL), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Markup_Filter_Cb, func), EO_TYPECHECK(void **, ret) + +/** + * @def edje_obj_text_markup_filter_callback_del_full + * + * Delete a function and matching user data from the markup filter list. + * + * @param[in] part + * @param[in] func + * @param[in] data + * @param[out] ret + * + * @see edje_object_text_markup_filter_callback_del_full + */ #define edje_obj_text_markup_filter_callback_del_full(part, func, data, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_TEXT_MARKUP_FILTER_CALLBACK_DEL_FULL), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Markup_Filter_Cb, func), EO_TYPECHECK(void *, data), EO_TYPECHECK(void **, ret) + +/** + * @def edje_obj_part_swallow + * + * @brief "Swallows" an object into one of the Edje object SWALLOW + * + * @param[in] part + * @param[in] obj_swallow + * @param[out] ret + * + * @see edje_object_part_swallow + */ #define edje_obj_part_swallow(part, obj_swallow, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_SWALLOW), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Object *, obj_swallow), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_unswallow + * + * @brief Unswallow an object. + * + * @param[in] obj_swallow + * + * @see edje_object_part_unswallow + */ #define edje_obj_part_unswallow(obj_swallow) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_UNSWALLOW), EO_TYPECHECK(Evas_Object *, obj_swallow) + +/** + * @def edje_obj_part_swallow_get + * + * @brief Get the object currently swallowed by a part. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_swallow_get + */ #define edje_obj_part_swallow_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_SWALLOW_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Object **, ret) + +/** + * @def edje_obj_size_min_get + * + * @brief Get the minimum size specified -- as an EDC property -- for a + * given Edje object + * + * @param[out] minw + * @param[out] minh + * + * @see edje_object_size_min_get + */ #define edje_obj_size_min_get(minw, minh) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_SIZE_MIN_GET), EO_TYPECHECK(Evas_Coord *, minw), EO_TYPECHECK(Evas_Coord *, minh) + +/** + * @def edje_obj_size_max_get + * + * @brief Get the maximum size specified -- as an EDC property -- for a + * given Edje object + * + * @param[out] maxw + * @param[out] maxh + * + * @see edje_object_size_max_get + */ #define edje_obj_size_max_get(maxw, maxh) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_SIZE_MAX_GET), EO_TYPECHECK(Evas_Coord *, maxw), EO_TYPECHECK(Evas_Coord *, maxh) + +/** + * @def edje_obj_calc_force + * + * @brief Force a Size/Geometry calculation. + * + * + * @see edje_object_calc_force + */ #define edje_obj_calc_force() EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_CALC_FORCE) + +/** + * @def edje_obj_size_min_calc + * + * @brief Calculate the minimum required size for a given Edje object. + * + * @param[out] minw + * @param[out] minh + * + * @see edje_object_size_min_calc + */ #define edje_obj_size_min_calc(minw, minh) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_SIZE_MIN_CALC), EO_TYPECHECK(Evas_Coord *, minw), EO_TYPECHECK(Evas_Coord *, minh) + +/** + * @def edje_obj_parts_extends_calc + * + * Calculate the geometry of the region, relative to a given Edje + * + * @param[out] x + * @param[out] y + * @param[out] w + * @param[out] h + * @param[out] ret + * + * @see edje_object_parts_extends_calc + */ #define edje_obj_parts_extends_calc(x, y, w, h, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PARTS_EXTENDS_CALC), EO_TYPECHECK(Evas_Coord *, x), EO_TYPECHECK(Evas_Coord *, y), EO_TYPECHECK(Evas_Coord *, w), EO_TYPECHECK(Evas_Coord *, h), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_size_min_restricted_calc + * + * @brief Calculate the minimum required size for a given Edje object. + * + * @param[out] minw + * @param[out] minh + * @param[in] restrictedw + * @param[in] restrictedh + * + * @see edje_object_size_min_restricted_calc + */ #define edje_obj_size_min_restricted_calc(minw, minh, restrictedw, restrictedh) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_SIZE_MIN_RESTRICTED_CALC), EO_TYPECHECK(Evas_Coord *, minw), EO_TYPECHECK(Evas_Coord *, minh), EO_TYPECHECK(Evas_Coord, restrictedw), EO_TYPECHECK(Evas_Coord, restrictedh) + +/** + * @def edje_obj_part_state_get + * + * @brief Returns the state of the Edje part. + * + * @param[in] part + * @param[out] val_ret + * @param[out] ret + * + * @see edje_object_part_state_get + */ #define edje_obj_part_state_get(part, val_ret, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_STATE_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double *, val_ret), EO_TYPECHECK(const char **, ret) + +/** + * @def edje_obj_part_drag_dir_get + * + * @brief Determine dragable directions. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_drag_dir_get + */ #define edje_obj_part_drag_dir_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_DIR_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_Drag_Dir *, ret) + +/** + * @def edje_obj_part_drag_value_set + * + * @brief Set the dragable object location. + * + * @param[in] part + * @param[in] dx + * @param[in] dy + * @param[out] ret + * + * @see edje_object_part_drag_value_set + */ #define edje_obj_part_drag_value_set(part, dx, dy, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_VALUE_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double, dx), EO_TYPECHECK(double, dy), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_drag_value_get + * + * @brief Get the dragable object location. + * + * @param[in] part + * @param[out] dx + * @param[out] dy + * @param[out] ret + * + * @see edje_object_part_drag_value_get + */ #define edje_obj_part_drag_value_get(part, dx, dy, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_VALUE_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double *, dx), EO_TYPECHECK(double *, dy), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_drag_size_set + * + * @brief Set the dragable object size. + * + * @param[in] part + * @param[in] dw + * @param[in] dh + * @param[out] ret + * + * @see edje_object_part_drag_size_set + */ #define edje_obj_part_drag_size_set(part, dw, dh, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_SIZE_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double, dw), EO_TYPECHECK(double, dh), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_drag_size_get + * + * @brief Get the dragable object size. + * + * @param[in] part + * @param[out] dw + * @param[out] dh + * @param[out] ret + * + * @see edje_object_part_drag_size_get + */ #define edje_obj_part_drag_size_get(part, dw, dh, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_SIZE_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double *, dw), EO_TYPECHECK(double *, dh), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_drag_step_set + * + * @brief Sets the drag step increment. + * + * @param[in] part + * @param[in] dx + * @param[in] dy + * @param[out] ret + * + * @see edje_object_part_drag_step_set + */ #define edje_obj_part_drag_step_set(part, dx, dy, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_STEP_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double, dx), EO_TYPECHECK(double, dy), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_drag_step_get + * + * @brief Gets the drag step increment values. + * + * @param[in] part + * @param[out] dx + * @param[out] dy + * @param[out] ret + * + * @see edje_object_part_drag_step_get + */ #define edje_obj_part_drag_step_get(part, dx, dy, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_STEP_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double *, dx), EO_TYPECHECK(double *, dy), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_drag_page_set + * + * @brief Sets the page step increments. + * + * @param[in] part + * @param[in] dx + * @param[in] dy + * @param[out] ret + * + * @see edje_object_part_drag_page_set + */ #define edje_obj_part_drag_page_set(part, dx, dy, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_PAGE_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double, dx), EO_TYPECHECK(double, dy), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_drag_page_get + * + * @brief Gets the page step increments. + * + * @param[in] part + * @param[out] dx + * @param[out] dy + * @param[out] ret + * + * @see edje_object_part_drag_page_get + */ #define edje_obj_part_drag_page_get(part, dx, dy, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_PAGE_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double *, dx), EO_TYPECHECK(double *, dy), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_drag_step + * + * @brief Steps the dragable x,y steps. + * + * @param[in] part + * @param[in] dx + * @param[in] dy + * @param[out] ret + * + * @see edje_object_part_drag_step + */ #define edje_obj_part_drag_step(part, dx, dy, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_STEP), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double, dx), EO_TYPECHECK(double, dy), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_drag_page + * + * @brief Pages x,y steps. + * + * @param[in] part + * @param[in] dx + * @param[in] dy + * @param[out] ret + * + * @see edje_object_part_drag_page + */ #define edje_obj_part_drag_page(part, dx, dy, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_DRAG_PAGE), EO_TYPECHECK(const char *, part), EO_TYPECHECK(double, dx), EO_TYPECHECK(double, dy), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_box_append + * + * @brief Appends an object to the box. + * + * @param[in] part + * @param[in] child + * @param[out] ret + * + * @see edje_object_part_box_append + */ #define edje_obj_part_box_append(part, child, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_BOX_APPEND), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_box_prepend + * + * @brief Prepends an object to the box. + * + * @param[in] part + * @param[in] child + * @param[out] ret + * + * @see edje_object_part_box_prepend + */ #define edje_obj_part_box_prepend(part, child, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_BOX_PREPEND), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_box_insert_before + * + * @brief Adds an object to the box. + * + * @param[in] part + * @param[in] child + * @param[in] reference + * @param[out] ret + * + * @see edje_object_part_box_insert_before + */ #define edje_obj_part_box_insert_before(part, child, reference, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_BOX_INSERT_BEFORE), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(const Evas_Object *, reference), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_box_insert_at + * + * @brief Inserts an object to the box. + * + * @param[in] part + * @param[in] child + * @param[in] pos + * @param[out] ret + * + * @see edje_object_part_box_insert_at + */ #define edje_obj_part_box_insert_at(part, child, pos, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_BOX_INSERT_AT), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(unsigned int, pos), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_box_remove + * + * @brief Removes an object from the box. + * + * @param[in] part + * @param[in] child + * @param[out] ret + * + * @see edje_object_part_box_remove + */ #define edje_obj_part_box_remove(part, child, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_BOX_REMOVE), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Object *, child), EO_TYPECHECK(Evas_Object **, ret) + +/** + * @def edje_obj_part_box_remove_at + * + * @brief Removes an object from the box. + * + * @param[in] part + * @param[in] pos + * @param[out] ret + * + * @see edje_object_part_box_remove_at + */ #define edje_obj_part_box_remove_at(part, pos, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_BOX_REMOVE_AT), EO_TYPECHECK(const char *, part), EO_TYPECHECK(unsigned int, pos), EO_TYPECHECK(Evas_Object **, ret) + +/** + * @def edje_obj_part_box_remove_all + * + * @brief Removes all elements from the box. + * + * @param[in] part + * @param[in] clear + * @param[out] ret + * + * @see edje_object_part_box_remove_all + */ #define edje_obj_part_box_remove_all(part, clear, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_BOX_REMOVE_ALL), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool, clear), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_access_part_list_get + * + * @brief Retrieve a list all accessibility part names + * + * @param[out] ret + * + * @see edje_object_access_part_list_get + */ #define edje_obj_access_part_list_get(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_ACCESS_PART_LIST_GET), EO_TYPECHECK(Eina_List **, ret) + +/** + * @def edje_obj_part_table_child_get + * + * @brief Retrieve a child from a table + * + * @param[in] part + * @param[in] col + * @param[in] row + * @param[out] ret + * + * @see edje_object_part_table_child_get + */ #define edje_obj_part_table_child_get(part, col, row, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TABLE_CHILD_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(unsigned int, col), EO_TYPECHECK(unsigned int, row), EO_TYPECHECK(Evas_Object **, ret) + +/** + * @def edje_obj_part_table_pack + * + * @brief Packs an object into the table. + * + * @param[in] part + * @param[in] child_obj + * @param[in] col + * @param[in] row + * @param[in] colspan + * @param[in] rowspan + * @param[out] ret + * + * @see edje_object_part_table_pack + */ #define edje_obj_part_table_pack(part, child_obj, col, row, colspan, rowspan, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TABLE_PACK), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Object *, child_obj), EO_TYPECHECK(unsigned short, col), EO_TYPECHECK(unsigned short, row), EO_TYPECHECK(unsigned short, colspan), EO_TYPECHECK(unsigned short, rowspan), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_table_unpack + * + * @brief Removes an object from the table. + * + * @param[in] part + * @param[in] child_obj + * @param[out] ret + * + * @see edje_object_part_table_unpack + */ #define edje_obj_part_table_unpack(part, child_obj, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TABLE_UNPACK), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Object *, child_obj), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_table_col_row_size_get + * + * @brief Gets the number of columns and rows the table has. + * + * @param[in] part + * @param[out] cols + * @param[out] rows + * @param[out] ret + * + * @see edje_object_part_table_col_row_size_get + */ #define edje_obj_part_table_col_row_size_get(part, cols, rows, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TABLE_COL_ROW_SIZE_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(int *, cols), EO_TYPECHECK(int *, rows), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_table_clear + * + * @brief Removes all object from the table. + * + * @param[in] part + * @param[in] clear + * @param[out] ret + * + * @see edje_object_part_table_clear + */ #define edje_obj_part_table_clear(part, clear, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_TABLE_CLEAR), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool, clear), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_perspective_set + * + * Set the given perspective object on this Edje object. + * + * @param[in] ps + * + * @see edje_object_perspective_set + */ #define edje_obj_perspective_set(ps) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PERSPECTIVE_SET), EO_TYPECHECK(Edje_Perspective *, ps) + +/** + * @def edje_obj_perspective_get + * + * Get the current perspective used on this Edje object. + * + * @param[out] ret + * + * @see edje_object_perspective_get + */ #define edje_obj_perspective_get(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PERSPECTIVE_GET), EO_TYPECHECK(const Edje_Perspective **, ret) + +/** + * @def edje_obj_preload + * + * @brief Preload the images on the Edje Object in the background. + * + * @param[in] cancel + * @param[out] ret + * + * @see edje_object_preload + */ #define edje_obj_preload(cancel, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PRELOAD), EO_TYPECHECK(Eina_Bool, cancel), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_update_hints_set + * + * @brief Edje will automatically update the size hints on itself. + * + * @param[in] update + * + * @see edje_object_update_hints_set + */ #define edje_obj_update_hints_set(update) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_UPDATE_HINTS_SET), EO_TYPECHECK(Eina_Bool, update) + +/** + * @def edje_obj_update_hints_get + * + * @brief Wether or not Edje will update size hints on itself. + * + * @param[out] ret + * + * @see edje_object_update_hints_get + */ #define edje_obj_update_hints_get(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_UPDATE_HINTS_GET), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_external_object_get + * + * @brief Get the object created by this external part. + * + * @param[in] part + * @param[out] ret + * + * @see edje_object_part_external_object_get + */ #define edje_obj_part_external_object_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_EXTERNAL_OBJECT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Object **, ret) + +/** + * @def edje_obj_part_external_param_set + * + * @brief Set the parameter for the external part. + * + * @param[in] part + * @param[in] param + * @param[out] ret + * + * @see edje_object_part_external_param_set + */ #define edje_obj_part_external_param_set(part, param, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_EXTERNAL_PARAM_SET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const Edje_External_Param *, param), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_external_param_get + * + * @brief Get the parameter for the external part. + * + * @param[in] part + * @param[out] param + * @param[out] ret + * + * @see edje_object_part_external_param_get + */ #define edje_obj_part_external_param_get(part, param, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_EXTERNAL_PARAM_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Edje_External_Param *, param), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_part_external_content_get + * + * @brief Get an object contained in an part of type EXTERNAL + * + * @param[in] part + * @param[out] content + * @param[out] ret + * + * @see edje_object_part_external_content_get + */ #define edje_obj_part_external_content_get(part, content, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_EXTERNAL_CONTENT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, content), EO_TYPECHECK(Evas_Object **, ret) + +/** + * @def edje_obj_part_external_param_type_get + * + * Facility to query the type of the given parameter of the given part. + * + * @param[in] part + * @param[out] param + * @param[out] ret + * + * @see edje_object_part_external_param_type_get + */ #define edje_obj_part_external_param_type_get(part, param, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_EXTERNAL_PARAM_TYPE_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const char *, param), EO_TYPECHECK(Edje_External_Param_Type *, ret) /** @@ -1101,24 +2550,171 @@ enum * * @param[in] file in * @param[in] group in + * @param[in] nested in * @param[out] ret out * + * @see edje_object_file_set */ #define edje_obj_file_set(file, group, nested, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_FILE_SET), EO_TYPECHECK(const char*, file), EO_TYPECHECK(const char *, group), EO_TYPECHECK(Eina_Array *, nested), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_file_get + * + * @brief Get the file and group name that a given Edje object is bound to + * + * @param[out] file + * @param[out] group + * + * @see edje_object_file_get + */ #define edje_obj_file_get(file, group) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_FILE_GET), EO_TYPECHECK(const char **, file), EO_TYPECHECK(const char **, group) + +/** + * @def edje_obj_load_error_get + * + * @brief Gets the (last) file loading error for a given Edje object + * + * @param[out] ret + * + * @see edje_object_load_error_get + */ #define edje_obj_load_error_get(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_LOAD_ERROR_GET), EO_TYPECHECK(Edje_Load_Error *, ret) + +/** + * @def edje_obj_message_send + * + * @brief Send an (Edje) message to a given Edje object + * + * @param[in] type + * @param[in] id + * @param[in] msg + * + * @see edje_object_message_send + */ #define edje_obj_message_send(type, id, msg) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_MESSAGE_SEND), EO_TYPECHECK(Edje_Message_Type, type), EO_TYPECHECK(int, id), EO_TYPECHECK(void *, msg) + +/** + * @def edje_obj_message_handler_set + * + * @brief Set an Edje message handler function for a given Edje object. + * + * @param[in] func + * @param[in] data + * + * @see edje_object_message_handler_set + */ #define edje_obj_message_handler_set(func, data) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_MESSAGE_HANDLER_SET), EO_TYPECHECK(Edje_Message_Handler_Cb, func), EO_TYPECHECK(void *, data) + +/** + * @def edje_obj_message_signal_process + * + * @brief Process an object's message queue. + * + * + * @see edje_object_message_signal_process + */ #define edje_obj_message_signal_process() EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_MESSAGE_SIGNAL_PROCESS) + +/** + * @def edje_obj_signal_callback_add + * + * @brief Add a callback for an arriving Edje signal, emitted by + * a given Ejde object. + * + * @param[in] emission + * @param[in] source + * @param[in] func + * @param[in] data + * + * @see edje_object_signal_callback_add + */ #define edje_obj_signal_callback_add(emission, source, func, data) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_SIGNAL_CALLBACK_ADD), EO_TYPECHECK(const char *, emission), EO_TYPECHECK(const char *, source), EO_TYPECHECK(Edje_Signal_Cb, func), EO_TYPECHECK(void *, data) + +/** + * @def edje_obj_signal_callback_del + * + * @brief Remove a signal-triggered callback from an object. + * + * @param[in] emission + * @param[in] source + * @param[in] func + * @param[out] ret + * + * @see edje_object_signal_callback_del + */ #define edje_obj_signal_callback_del(emission, source, func, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_SIGNAL_CALLBACK_DEL), EO_TYPECHECK(const char *, emission), EO_TYPECHECK(const char *, source), EO_TYPECHECK(Edje_Signal_Cb, func), EO_TYPECHECK(void **, ret) + +/** + * @def edje_obj_signal_callback_del_full + * + * @brief Unregister/delete a callback set for an arriving Edje + * + * @param[in] emission + * @param[in] source + * @param[in] func + * @param[in] data + * @param[out] ret + * + * @see edje_object_signal_callback_del_full + */ #define edje_obj_signal_callback_del_full(emission, source, func, data, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_SIGNAL_CALLBACK_DEL_FULL), EO_TYPECHECK(const char *, emission), EO_TYPECHECK(const char *, source), EO_TYPECHECK(Edje_Signal_Cb, func), EO_TYPECHECK(void *, data), EO_TYPECHECK(void **, ret) + +/** + * @def edje_obj_signal_emit + * + * @brief Send/emit an Edje signal to a given Edje object + * + * @param[in] emission + * @param[in] source + * + * @see edje_object_signal_emit + */ #define edje_obj_signal_emit(emission, source) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_SIGNAL_EMIT), EO_TYPECHECK(const char *, emission), EO_TYPECHECK(const char *, source) + +/** + * @def edje_obj_play_set + * + * @brief Set the Edje object to playing or paused states. + * + * @param[in] play + * + * @see edje_object_play_set + */ #define edje_obj_play_set(play) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PLAY_SET), EO_TYPECHECK(Eina_Bool, play) + +/** + * @def edje_obj_play_get + * + * @brief Get the Edje object's state. + * + * @param[out] ret + * + * @see edje_object_play_get + */ #define edje_obj_play_get(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PLAY_GET), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def edje_obj_animation_set + * + * @brief Set the object's animation state. + * + * @param[in] on + * + * @see edje_object_animation_set + */ #define edje_obj_animation_set(on) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_ANIMATION_SET), EO_TYPECHECK(Eina_Bool, on) + +/** + * @def edje_obj_animation_get + * + * @brief Get the Edje object's animation state. + * + * @param[out] ret + * + * @see edje_object_animation_get + */ #define edje_obj_animation_get(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_ANIMATION_GET), EO_TYPECHECK(Eina_Bool *, ret) #define EDJE_EDIT_CLASS edje_edit_class_get()