/******************************************************************************/
/************************** GENERAL API ***********************************/
/******************************************************************************/
-/** @name General API
- * General functions that don't fit in other cateories.
+/**
+ * @name General API
+ * General functions that don't fit in other categories.
*/ //@{
-/** Adds an editable Edje object to the canvas.
- *
+/**
+ * @brief Adds an editable Edje object to the canvas.
* An Edje_Edit object is, for the most part, a standard Edje object. Only
* difference is you can use the Edje_Edit API on them.
*
*/
EAPI Evas_Object * edje_edit_object_add(Evas *e);
-/** Free a generic Eina_List of (char *) allocated by an edje_edit_*_get() function.
- *
+/**
+ * @brief Frees a generic Eina_List of (char *) allocated by an edje_edit_*_get() function.
* @param lst List of strings to free.
*/
EAPI void edje_edit_string_list_free(Eina_List *lst);
-/** Free a generic string (char *) allocated by an edje_edit_*_get() function.
- *
+/**
+ * @brief Frees a generic string (char *) allocated by an edje_edit_*_get() function.
* @param str String to free.
*/
EAPI void edje_edit_string_free(const char *str);
-/** Get the name of the program that compiled the edje file.
+/**
+ * @brief Gets the name of the program that compiled the edje file.
* Can be 'edje_cc' or 'edje_edit'
*
* @param obj Object being edited.
*/
EAPI const char * edje_edit_compiler_get(Evas_Object *obj);
-/** Save the modified edje object back to his file.
- *
+/**
+ * @brief Saves the modified edje object back to his file.
* Use this function when you are done with your editing, all the change made
* to the current loaded group will be saved back to the original file.
*
*/
EAPI Eina_Bool edje_edit_save(Evas_Object *obj);
-/** Saves every group back into the file.
- *
+/**
+ * @brief Saves every group back into the file.
* @param obj Object to save.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_save_all(Evas_Object *obj);
-/** Save every group into new file.
- *
+/**
+ * @brief Saves every group into new file.
* Use this function when you need clean eet dictionary in .edj file from
* unnecessary text entries (e.g. names of deleted groups etc.).
*
*/
EAPI Eina_Bool edje_edit_clean_save_as(Evas_Object *obj, const char* new_file_name);
-/** Save the group(s) back to the file, without generation source code.
- *
+/**
+ * @brief Saves the group(s) back to the file, without generation source code.
* This function saves changes in group(s) back into the edj file. Process of
* saving takes a bit time in compare with @see edje_edit_save() and @see edje_edit_save_all(),
* because this function DOES NOT generate source code for groups.
*/
EAPI Eina_Bool edje_edit_without_source_save(Evas_Object *obj, Eina_Bool current_group);
-/** Print on standard output many information about the internal status
+/**
+ * @brief Prints on standard output many information about the internal status
* of the edje object.
*
* This is probably only useful to debug.
/******************************************************************************/
/************************** GROUPS API ************************************/
/******************************************************************************/
-/** @name Groups API
- * Functions to deal with groups property (see @ref edcref).
+/**
+ * @name Groups API
+ * Functions to deal with groups property (see @ref edcref).
*/ //@{
/**
- * @brief Add an edje (empty) group to an edje object's group set.
+ * @brief Adds an edje (empty) group to an edje object's group set.
*
* @param obj The pointer to edje object.
* @param name The name of the group.
EAPI Eina_Bool edje_edit_group_add(Evas_Object *obj, const char *name);
/**
- * @brief Copy whole group and all it's data into separate group.
+ * @brief Copies whole group and all it's data into separate group.
*
* @param obj The pointer to edje object.
* @param group_name The name of the group.
EAPI Eina_Bool edje_edit_group_copy(Evas_Object *obj, const char *group_name, const char *copy_name);
/**
- * @brief Delete the specified group from the edje file.
+ * @brief Deletes the specified group from the edje file.
*
* @param obj The pointer to the edje object.
* @param group_name Group to delete.
*/
EAPI Eina_Bool edje_edit_group_del(Evas_Object *obj, const char *group_name);
-/** Check if a group with the given name exist in the edje.
- *
+/**
+ * @brief Checks if a group with the given name exist in the edje.
* @param obj Object being edited.
* @param group Group name to check for.
*
*/
EAPI Eina_Bool edje_edit_group_exist(Evas_Object *obj, const char *group);
-/** Set a new name for the current open group.
+/**
+ * @brief Sets a new name for the current open group.
*
* You can only rename a group that is currently loaded
* Note that the relative getter function don't exist as it doesn't make sense ;)
*/
EAPI Eina_Bool edje_edit_group_name_set(Evas_Object *obj, const char *new_name);
-/** Get the group minimum width.
+/**
+ * @brief Gets the group minimum width.
*
* @param obj Object being edited.
*
*/
EAPI int edje_edit_group_min_w_get(Evas_Object *obj);
-/** Set the group minimum width.
+/**
+ * @brief Sets the group minimum width.
*
* @param obj Object being edited.
* @param w New minimum width for the group.
*/
EAPI Eina_Bool edje_edit_group_min_w_set(Evas_Object *obj, int w);
-/** Get the group minimum height.
+/**
+ * @brief Gets the group minimum height.
*
* @param obj Object being edited.
*
- * @return The minimum height set for the group. -1 if an error occurred.
+ * @return The minimum height set for the group. @c -1 if an error occurred.
*/
EAPI int edje_edit_group_min_h_get(Evas_Object *obj);
-/** Set the group minimum height.
+/**
+ * @brief Sets the group minimum height.
*
* @param obj Object being edited.
* @param h New minimum height for the group.
*/
EAPI Eina_Bool edje_edit_group_min_h_set(Evas_Object *obj, int h);
-/** Get the group maximum width.
+/**
+ * @brief Gets the group maximum width.
*
* @param obj Object being edited.
*
- * @return The maximum width set for the group. -1 if an error occurred.
+ * @return The maximum width set for the group. @c -1 if an error occurred.
*/
EAPI int edje_edit_group_max_w_get(Evas_Object *obj);
-/** Set the group maximum width.
+/**
+ * @brief Sets the group maximum width.
*
* @param obj Object being edited.
* @param w New maximum width for the group.
*/
EAPI Eina_Bool edje_edit_group_max_w_set(Evas_Object *obj, int w);
-/** Get the group maximum height.
+/**
+ * @brief Gets the group maximum height.
*
* @param obj Object being edited.
*
- * @return The maximum height set for the group. -1 if an error occurred.
+ * @return The maximum height set for the group. @c -1 if an error occurred.
*/
EAPI int edje_edit_group_max_h_get(Evas_Object *obj);
-/** Set the group maximum height.
+/**
+ * @brief Sets the group maximum height.
*
* @param obj Object being edited.
* @param h New maximum height for the group.
*/
EAPI Eina_Bool edje_edit_group_max_h_set(Evas_Object *obj, int h);
-/** Get the group broadcast_signal.
+/**
+ * @brief Gets the group broadcast_signal.
*
* @param obj Object being edited.
*
*/
EAPI Eina_Bool edje_edit_group_broadcast_signal_get(Evas_Object *obj);
-/** Set the group broadcast signal.
+/**
+ * @brief Sets the group broadcast signal.
*
* @param obj Object being edited.
* @param bs @c EINA_TRUE if group will accept broadcast signal, @c EINA_FALSE otherwise.
//@}
-/** Retrieves a list with the item names inside the vertical limits block at the group level.
+/**
+ * @brief Retrieves a list with the item names inside the vertical limits block at the group level.
*
* @param obj Object being edited.
*
*/
EAPI Eina_List * edje_edit_group_limits_vertical_list_get(Evas_Object *obj);
-/** Delete given pair name-value from the vertical limits block at the group level.
+/**
+ * @brief Deletes given pair name-value from the vertical limits block at the group level.
*
* @param obj Object being edited.
* @param name Limit name.
*/
EAPI Eina_Bool edje_edit_group_limits_vertical_del(Evas_Object *obj, const char *name, int value);
-/** Add given pair name-value to the vertical limits block at the group level.
+/**
+ * @brief Adds given pair name-value to the vertical limits block at the group level.
*
* @param obj Object being edited.
* @param name Limit name.
*/
EAPI Eina_Bool edje_edit_group_limits_vertical_add(Evas_Object *obj, const char *name, int value);
-/** Retrieves a list with the item names inside the horizontal limits block at the group level.
+/**
+ * @brief Retrieves a list with the item names inside the horizontal limits block at the group level.
*
* @param obj Object being edited.
*
*/
EAPI Eina_List * edje_edit_group_limits_horizontal_list_get(Evas_Object *obj);
-/** Delete given pair name-value from the horizontal limits block at the group level.
+/**
+ * @brief Deletes given pair name-value from the horizontal limits block at the group level.
*
* @param obj Object being edited.
* @param name Limit name.
*/
EAPI Eina_Bool edje_edit_group_limits_horizontal_del(Evas_Object *obj, const char *name, int value);
-/** Add given pair name-value to the horizontal limits block at the group level.
+/**
+ * @brief Adds given pair name-value to the horizontal limits block at the group level.
*
* @param obj Object being edited.
* @param name Limit name.
*/
EAPI Eina_Bool edje_edit_group_limits_horizontal_add(Evas_Object *obj, const char *name, int value);
-/** Free an Eina_List of (Edje_Edit_List *) allocated by an edje_edit_limits_vertical_list_get() or edje_edit_limits_horizontal_list_get() functions.
+/**
+ @brief Frees an Eina_List of (Edje_Edit_List *) allocated by an edje_edit_limits_vertical_list_get() or edje_edit_limits_horizontal_list_get() functions.
*
* @param lst List to free.
*/
/******************************************************************************/
/************************** ALIAS API **************************************/
/******************************************************************************/
-/** @name Alias API
- * Functions to deal with aliases that just another names of the group in the edje (see @ref edcref).
+/**
+ * @name Alias API
+ * Functions to deal with aliases that just another names of the group in the edje (see @ref edcref).
*/ //@{
/**
- * Retrieves a list of aliases for this group.
+ * @brief Retrieves a list of aliases for this group.
* If given group name is an alias name then this function will return NULL.
*
* @attention After you done using returned list, please use edje_edit_string_list_free to free this list.
EAPI Eina_List * edje_edit_group_aliases_get(Evas_Object *obj, const char *group_name);
/**
- * Check if this group is an alias name.
+ * @brief Checks if this group is an alias name.
*
* @param obj Object being edited.
* @param alias_name Group name that is alias.
EAPI Eina_Bool edje_edit_group_alias_is(Evas_Object *obj, const char *alias_name);
/**
- * Return the main group name that is aliased by given alias name.
+ * @brief Returns the main group name that is aliased by given alias name.
*
* @attention After you done using this string, please use edje_edit_string_free to free this string.
*
EAPI const char * edje_edit_group_aliased_get(Evas_Object *obj, const char *alias_name);
/**
- * Add new alias to the given group.
+ * @brief Adds new alias to the given group.
*
* @attention when aliasing a group, be sure that the given group_name is no an alias.
*
/******************************************************************************/
/************************** DATA API **************************************/
/******************************************************************************/
-/** @name Data API
- * Functions to deal with data embedded in the edje (see @ref edcref).
+/**
+ * @name Data API
+ * Functions to deal with data embedded in the edje (see @ref edcref).
*/ //@{
-/** Retrieves a list with the item names inside the data block.
+/**
+ * @brief Retrieves a list with the item names inside the data block.
*
* @param obj Object being edited.
*
*/
EAPI Eina_List * edje_edit_data_list_get(Evas_Object *obj);
-/** Create a new *global* data object in the given edje file.
+/**
+ * @brief Creates a new *global* data object in the given edje file.
*
* If another data entry with the same name exists, nothing is created and
* EINA_FALSE is returned.
*/
EAPI Eina_Bool edje_edit_data_add(Evas_Object *obj, const char *itemname, const char *value);
-/** Delete the given data object from edje.
+/**
+ * @brief Deletes the given data object from edje.
*
* @param obj Object being edited.
* @param itemname Data entry to remove from the global data block.
*/
EAPI Eina_Bool edje_edit_data_del(Evas_Object *obj, const char *itemname);
-/** Get the data associated with the given itemname.
+/**
+ * @brief Gets the data associated with the given itemname.
*
* @param obj Object being edited.
* @param itemname Name of the data entry to fetch the value for.
*/
EAPI const char * edje_edit_data_value_get(Evas_Object *obj, const char *itemname);
-/** Set the data associated with the given itemname.
+/**
+ * @brief Sets the data associated with the given itemname.
*
* @param obj Object being edited.
* @param itemname Name of data entry to change the value.
*/
EAPI Eina_Bool edje_edit_data_value_set(Evas_Object *obj, const char *itemname, const char *value);
-/** Change the name of the given data object.
+/**
+ * @brief Changes the name of the given data object.
*
* @param obj Object being edited.
* @param itemname Data entry to rename.
*/
EAPI Eina_Bool edje_edit_data_name_set(Evas_Object *obj, const char *itemname, const char *newname);
-/** Retrieves a list with the item names inside the data block at the group level.
+/**
+ * @brief Retrieves a list with the item names inside the data block at the group level.
*
* @param obj Object being edited.
*
*/
EAPI Eina_List * edje_edit_group_data_list_get(Evas_Object *obj);
-/** Create a new data object in the given edje file *belonging to the current group*.
+/**
+ * @brief Creates a new data object in the given edje file *belonging to the current group*.
*
* If another data entry with the same name exists,
* nothing is created and EINA_FALSE is returned.
*/
EAPI Eina_Bool edje_edit_group_data_add(Evas_Object *obj, const char *itemname, const char *value);
-/** Delete the given data object from the group.
+/**
+ * @brief Deletes the given data object from the group.
*
* @param obj Object being edited.
* @param itemname Name of the data entry to remove.
*/
EAPI Eina_Bool edje_edit_group_data_del(Evas_Object *obj, const char *itemname);
-/** Get the data associated with the given itemname.
+/**
+ * @brief Gets the data associated with the given itemname.
*
* @param obj Object being edited.
* @param itemname Name of the data entry.
*/
EAPI const char * edje_edit_group_data_value_get(Evas_Object *obj, const char *itemname);
-/** Set the data associated with the given itemname.
+/**
+ * @brief Sets the data associated with the given itemname.
*
* @param obj Object being edited.
* @param itemname Name of the data entry to set the value.
*/
EAPI Eina_Bool edje_edit_group_data_value_set(Evas_Object *obj, const char *itemname, const char *value);
-/** Change the name of the given data object.
+/**
+ * @brief Changes the name of the given data object.
*
* @param obj Object being edited.
* @param itemname Name of the data entry to rename.
/******************************************************************************/
/*********************** COLOR CLASSES API ********************************/
/******************************************************************************/
-/** @name Color Classes API
- * Functions to deal with Color Classes (see @ref edcref).
+/**
+ * @name Color Classes API
+ * Functions to deal with Color Classes (see @ref edcref).
*/ //@{
-/** Get the list of all the Color Classes in the given edje object.
+/**
+ * @brief Gets the list of all the Color Classes in the given edje object.
*
* @param obj Object being edited.
*
*/
EAPI Eina_List * edje_edit_color_classes_list_get(Evas_Object *obj);
-/** Create a new color class object in the given edje.
+/**
+ * @brief Creates a new color class object in the given edje.
*
* If another class with the same name exists nothing is created and EINA_FALSE is returned.
*
*/
EAPI Eina_Bool edje_edit_color_class_add(Evas_Object *obj, const char *name);
-/** Delete the given class object from edje.
+/**
+ * @brief Deletes the given class object from edje.
*
* @param obj Object being edited.
* @param name Color class to delete.
*/
EAPI Eina_Bool edje_edit_color_class_del(Evas_Object *obj, const char *name);
-/** Get all the colors that compose the class.
+/**
+ * @brief Gets all the colors that compose the class.
*
* You can pass NULL to colors you are not intrested in.
*
*/
EAPI Eina_Bool edje_edit_color_class_colors_get(Evas_Object *obj, const char *class_name, int *r, int *g, int *b, int *a, int *r2, int *g2, int *b2, int *a2, int *r3, int *g3, int *b3, int *a3);
-/** Set the colors for the given color class.
+/**
+ * @brief Sets the colors for the given color class.
*
* If you set a color to -1 it will not be touched.
*
*/
EAPI Eina_Bool edje_edit_color_class_colors_set(Evas_Object *obj, const char *class_name, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3);
-/** Change the name of a color class.
+/**
+ * @brief Changes the name of a color class.
*
* @param obj Object being edited.
* @param name Color class to rename.
*/
EAPI Eina_Bool edje_edit_color_class_name_set(Evas_Object *obj, const char *name, const char *newname);
-/** Get the description of a color class.
+/**
+ * @brief Gets the description of a color class.
*
* @param obj Object being edited.
* @param name Color class to get the description of.
*/
EAPI Eina_Stringshare *edje_edit_color_class_description_get(Evas_Object *obj, const char *class_name);
-/** Change the description of a color class.
+/**
+ * @brief Changes the description of a color class.
*
* @param obj Object being edited.
* @param name Color class to edit.
/******************************************************************************/
/************************** TEXT STYLES *************************************/
/******************************************************************************/
-/** @name Text styles API
- * Functions to deal with text styles (see @ref edcref).
+/**
+ * @name Text styles API
+ * Functions to deal with text styles (see @ref edcref).
*/ //@{
-/** Get the list of all the text styles in the given edje object.
+/**
+ * @brief Gets the list of all the text styles in the given edje object.
*
* @param obj Object being edited.
*
*/
EAPI Eina_List * edje_edit_styles_list_get(Evas_Object *obj);
-/** Create a new text style object in the given edje.
+/**
+ * @brief Creates a new text style object in the given edje.
*
* If another style with the same name exists nothing is created and EINA_FALSE is returned.
*
*/
EAPI Eina_Bool edje_edit_style_add(Evas_Object *obj, const char *style);
-/** Delete the given text style and all the child tags.
+/**
+ * @brief Deletes the given text style and all the child tags.
*
* @param obj Object being edited.
* @param style Style to delete.
*/
EAPI Eina_Bool edje_edit_style_del(Evas_Object *obj, const char *style);
-/** Get the list of all the tags name in the given text style.
+/**
+ * @brief Gets the list of all the tags name in the given text style.
*
* @param obj Object being edited.
* @param style Style to get the tags for.
*/
EAPI Eina_List * edje_edit_style_tags_list_get(Evas_Object *obj, const char *style);
-/** Get the value of the given tag.
+/**
+ * @brief Gets the value of the given tag.
*
* @param obj Object being edited.
* @param style Style containing the tag being.
*/
EAPI const char * edje_edit_style_tag_value_get(Evas_Object *obj, const char *style, const char *tag);
-/** Set the value of the given tag.
+/**
+ * @brief Sets the value of the given tag.
*
* @param obj Object being edited.
* @param style Style containing the tag to change.
*/
EAPI Eina_Bool edje_edit_style_tag_value_set(Evas_Object *obj, const char *style, const char *tag, const char *new_value);
-/** Set the name of the given tag.
+/**
+ * @brief Sets the name of the given tag.
*
* @param obj Object being edited.
* @param style Style containing the tag to rename.
*/
EAPI Eina_Bool edje_edit_style_tag_name_set(Evas_Object *obj, const char *style, const char *tag, const char *new_name);
-/** Add a new tag to the given text style.
+/**
+ @ @brief Adds a new tag to the given text style.
*
* If another tag with the same name exists nothing is created and EINA_FALSE is returned.
*
*/
EAPI Eina_Bool edje_edit_style_tag_add(Evas_Object *obj, const char *style, const char *tag_name);
-/** Delete the given tag.
+/**
+ * @brief Deletes the given tag.
*
* @param obj Object being edited.
* @param style Style from where to remove the tag.
/******************************************************************************/
/************************ EXTERNALS API ***********************************/
/******************************************************************************/
-/** @name Externals API
- * Functions to deal with list of external modules (see @ref edcref).
+/**
+ * @name Externals API
+ * Functions to deal with list of external modules (see @ref edcref).
*/ //@{
-/** Get the list of all the externals requested in the given edje object.
+/**
+ * @brief Gets the list of all the externals requested in the given edje object.
*
* @param obj Object being edited.
*
*/
EAPI Eina_List * edje_edit_externals_list_get(Evas_Object *obj);
-/** Add an external module to be requested on edje load.
+/**
+ * @brief Adds an external module to be requested on edje load.
*
* @param obj Object being edited.
* @param external Name of the external module to add to the list of autoload.
*/
EAPI Eina_Bool edje_edit_external_add(Evas_Object *obj, const char *external);
-/** Delete the given external from the list.
+/**
+ * @brief Deletes the given external from the list.
*
* @param obj Object being edited.
* @param external Name of the external module to remove from the autoload list.
/******************************************************************************/
/************************** PARTS API *************************************/
/******************************************************************************/
-/** @name Parts API
- * Functions to deal with part objects (see @ref edcref).
+/**
+ * @name Parts API
+ * Functions to deal with part objects (see @ref edcref).
*/ //@{
-/** Get the select mode for a textblock part
+/**
+ * @brief Gets the select mode for a textblock part.
* @param obj Object being edited.
* @param part Name of the part.
*/
EAPI Edje_Edit_Select_Mode edje_edit_part_select_mode_get(Evas_Object *obj, const char *part);
-/** Set the select mode for a textblock part
+/**
+ * @brief Sets the select mode for a textblock part.
*
* @param obj Object being edited.
* @param part Name of the part.
*/
EAPI Eina_Bool edje_edit_part_select_mode_set(Evas_Object *obj, const char *part, Edje_Edit_Select_Mode mode);
-/** Get the edit mode for a textblock part
+/**
+ * @brief Gets the edit mode for a textblock part.
*
* @param obj Object being edited.
* @param part Name of the part.
*/
EAPI Edje_Edit_Entry_Mode edje_edit_part_entry_mode_get(Evas_Object *obj, const char *part);
-/** Set the edit mode for a textblock part
+/**
+ * @brief Sets the edit mode for a textblock part.
*
* @param obj Object being edited.
* @param part Name of the part.
*/
EAPI Eina_Bool edje_edit_part_entry_mode_set(Evas_Object *obj, const char *part, Edje_Edit_Entry_Mode mode);
-/** Get the list of all the parts in the given edje object.
+/**
+ * @brief Gets the list of all the parts in the given edje object.
*
* @param obj Object being edited.
*
*/
EAPI Eina_List * edje_edit_parts_list_get(Evas_Object *obj);
-/** Create a new part in the given edje.
+/**
+ * @brief Creates a new part in the given edje.
*
* If another part with the same name just exists nothing is created and EINA_FALSE is returned.
* Note that this function also create a default description for the part.
*/
EAPI Eina_Bool edje_edit_part_add(Evas_Object *obj, const char *name, Edje_Part_Type type);
-/** Create a new part of type EXTERNAL in the given edje.
+/**
+ * @brief Creates a new part of type EXTERNAL in the given edje.
*
* If another part with the same name just exists nothing is created and EINA_FALSE is returned.
* Note that this function also create a default description for the part.
*/
EAPI Eina_Bool edje_edit_part_external_add(Evas_Object *obj, const char *name, const char *source);
-/** Delete the given part from the edje.
+/**
+ * @brief Deletes the given part from the edje.
*
* All the reference to this part will be zeroed.
*
*/
EAPI Eina_Bool edje_edit_part_del(Evas_Object *obj, const char *part);
-/** Copy the given part in edje.
+/**
+ * @brief Copies the given part in edje.
*
* If another part with the same name just exists nothing is created and EINA_FALSE is returned.
*
*/
EAPI Eina_Bool edje_edit_part_copy(Evas_Object *obj, const char *part, const char *new_copy);
-/** Check if a part with the given name exist in the edje object.
+/**
+ * @brief Checks if a part with the given name exist in the edje object.
*
* @param obj Object being edited.
* @param part Name of part to check for its existence.
*/
EAPI Eina_Bool edje_edit_part_exist(Evas_Object *obj, const char *part);
-/** Get the name of part stacked above the one passed.
+/**
+ * @brief Gets the name of part stacked above the one passed.
*
* @param obj Object being edited.
* @param part Name of part of which to check the one above.
*/
EAPI const char * edje_edit_part_above_get(Evas_Object *obj, const char *part);
-/** Get the name of part stacked below the one passed.
+/**
+ * @brief Gets the name of part stacked below the one passed.
*
* @param obj Object being edited.
* @param part Name of part of which to check the one below.
*/
EAPI const char * edje_edit_part_below_get(Evas_Object *obj, const char *part);
-/** Move the given part below the previous one.
+/**
+ * @brief Moves the given part below the previous one.
*
* @param obj Object being edited.
* @param part Name of part to move one step below.
*/
EAPI Eina_Bool edje_edit_part_restack_below(Evas_Object *obj, const char *part);
-/** Move the given part below the part named below.
+/**
+ * @brief Moves the given part below the part named below.
*
* @param obj Object being edited.
* @param part Name of part which will be moved.
*/
EAPI Eina_Bool edje_edit_part_restack_part_below(Evas_Object *obj, const char* part, const char *below);
-/** Move the given part above the next one.
+/**
+ * @brief Moves the given part above the next one.
*
* @param obj Object being edited.
* @param part Name of part to move one step above.
*/
EAPI Eina_Bool edje_edit_part_restack_above(Evas_Object *obj, const char *part);
-/** Move the given part above the part named above.
+/**
+ * @brief Moves the given part above the part named above.
*
* @param obj Object being edited.
* @param part Name of part which will be moved.
*/
EAPI Eina_Bool edje_edit_part_restack_part_above(Evas_Object *obj, const char* part, const char *above);
-/** Set a new name for part.
+/**
+ * @brief Sets a new name for part.
*
* Note that the relative getter function don't exist as it don't make sense ;)
*
*/
EAPI Eina_Bool edje_edit_part_name_set(Evas_Object *obj, const char *part, const char *new_name);
-/** Get api's name of a part.
+/**
+ * @brief Gets api's name of a part.
*
* @param obj Object being edited.
* @param part Name of the part.
*
- * @return name of the api if successful, NULL otherwise.
+ * @return Name of the API if successful, NULL otherwise.
*/
EAPI const char * edje_edit_part_api_name_get(Evas_Object *obj, const char *part);
-/** Get api's description of a part.
+/**
+ * @brief Gets api's description of a part.
*
* @param obj Object being edited.
* @param part Name of the part.
*
- * @return description of the api if successful, NULL otherwise.
+ * @return Description of the api if successful, NULL otherwise.
*/
EAPI const char * edje_edit_part_api_description_get(Evas_Object *obj, const char *part);
-/** Set api's name of a part.
+/**
+ * @brief Sets api's name of a part.
*
* @param obj Object being edited.
* @param part Name of the part.
*/
EAPI Eina_Bool edje_edit_part_api_name_set(Evas_Object *obj, const char *part, const char *name);
-/** Set api's description of a part.
+/**
+ * @brief Sets api's description of a part.
*
* @param obj Object being edited.
* @param part Name of part.
*/
EAPI Eina_Bool edje_edit_part_api_description_set(Evas_Object *obj, const char *part, const char *description);
-/** Get the type of a part.
+/**
+ * @brief Gets the type of a part.
*
* @param obj Object being edited.
* @param part Name of part to get the type of.
*/
EAPI Edje_Part_Type edje_edit_part_type_get(Evas_Object *obj, const char *part);
-/** Get the clip_to part.
+/**
+ * @brief Gets the clip_to part.
*
* @param obj Object being edited.
* @param part Name of the part whose clipper to get.
*/
EAPI const char * edje_edit_part_clip_to_get(Evas_Object *obj, const char *part);
-/** Set a part to clip part to.
+/**
+ * @brief Sets a part to clip part to.
*
* @param obj Object being edited.
* @param part Part to set the clipper to.
*/
EAPI Eina_Bool edje_edit_part_clip_to_set(Evas_Object *obj, const char *part, const char *clip_to);
-/** Get the source of part.
+/**
+ * @brief Gets the source of part.
*
* The meaning of this parameter varies depending on the type of the part.
* For GROUP parts, it's the name of another group in the Edje file which will
*/
EAPI const char * edje_edit_part_source_get(Evas_Object *obj, const char *part);
-/** Set the source of part.
+/**
+ * @brief Sets the source of part.
*
* If setting source of the part will lead to recursive reference
* (when A source to B, and B is going to be source to A because of this function),
*/
EAPI Eina_Bool edje_edit_part_source_set(Evas_Object *obj, const char *part, const char *source);
-/** Get the source2 of part.
+/**
+ * @brief Gets the source2 of part.
*
* Only available to TEXTBLOCK parts. It is used for the group to be loaded and
* used for selection display OVER the selected text. source is used for under
*/
EAPI const char * edje_edit_part_source2_get(Evas_Object *obj, const char *part);
-/** Set the source2 of part.
+/**
+ * @brief Sets the source2 of part.
*
* @param obj Object being edited.
* @param part Part to set the source of.
*/
EAPI Eina_Bool edje_edit_part_source2_set(Evas_Object *obj, const char *part, const char *source);
-/** Get the source3 of part.
+/**
+ * @brief Gets the source3 of part.
*
* Only available to TEXTBLOCK parts. It is used for the group to be loaded and
* used for cursor display UNDER the cursor position. source4 is used for over
*/
EAPI const char * edje_edit_part_source3_get(Evas_Object *obj, const char *part);
-/** Set the source3 of part.
+/**
+ * @brief Sets the source3 of part.
*
* @param obj Object being edited.
* @param part Part to set the source of.
*/
EAPI Eina_Bool edje_edit_part_source3_set(Evas_Object *obj, const char *part, const char *source);
-/** Get the source4 of part.
+/**
+ * @brief Gets the source4 of part.
*
* Only available to TEXTBLOCK parts. It is used for the group to be loaded and
* used for cursor display OVER the cursor position. source3 is used for under
*/
EAPI const char * edje_edit_part_source4_get(Evas_Object *obj, const char *part);
-/** Set the source4 of part.
+/**
+ * @brief Sets the source4 of part.
*
* @param obj Object being edited.
* @param part Part to set the source of.
*/
EAPI Eina_Bool edje_edit_part_source4_set(Evas_Object *obj, const char *part, const char *source);
-/** Get the source5 of part.
+/**
+ * @brief Gets the source5 of part.
*
* Only available to TEXTBLOCK parts. It is used for the group to be loaded and
* used for anchors display UNDER the anchor position. source6 is used for over
*/
EAPI const char * edje_edit_part_source5_get(Evas_Object *obj, const char *part);
-/** Set the source5 of part.
+/**
+ * @brief Sets the source5 of part.
*
* @param obj Object being edited.
* @param part Part to set the source of.
*/
EAPI Eina_Bool edje_edit_part_source5_set(Evas_Object *obj, const char *part, const char *source);
-/** Get the source6 of part.
+/**
+ * @brief Gets the source6 of part.
*
* Only available to TEXTBLOCK parts. It is used for the group to be loaded and
* used for anchor display OVER the anchor position. source5 is used for under
*/
EAPI const char * edje_edit_part_source6_get(Evas_Object *obj, const char *part);
-/** Set the source6 of part.
+/**
+ * @brief Sets the source6 of part.
*
* @param obj Object being edited.
* @param part Part to set the source of.
*/
EAPI Eina_Bool edje_edit_part_source6_set(Evas_Object *obj, const char *part, const char *source);
-/** Get the effect for a given part.
+/**
+ * @brief Gets the effect for a given part.
*
* Gets the effect used for parts of type TEXT. See @ref edcref for more details.
*
*/
EAPI Edje_Text_Effect edje_edit_part_effect_get(Evas_Object *obj, const char *part);
-/** Set the effect for a given part.
+/**
+ * @brief Sets the effect for a given part.
* Effects and shadow directions can be combined.
*
* For effect and shadow direction list please look at Edje Part Text ref page.
*/
EAPI Eina_Bool edje_edit_part_effect_set(Evas_Object *obj, const char *part, Edje_Text_Effect effect);
-/** Get the current selected state in part.
+/**
+ * @brief Gets the current selected state in part.
*
* @param obj Object being edited.
* @param part Part to get the selected state of.
*/
EAPI const char * edje_edit_part_selected_state_get(Evas_Object *obj, const char *part, double *value);
-/** Set the current state in part.
+/**
+ * @brief Sets the current state in part.
*
* @param obj Object being edited.
* @param part Part to set the state of.
*/
EAPI Eina_Bool edje_edit_part_selected_state_set(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get mouse_events for part.
+/**
+ * @brief Gets mouse_events for part.
*
* @param obj Object being edited.
* @param part Part to get if the mouse events is accepted.
*/
EAPI Eina_Bool edje_edit_part_mouse_events_get(Evas_Object *obj, const char *part);
-/** Set mouse_events for part.
+/**
+ * @brief Sets mouse_events for part.
*
* @param obj Object being edited.
* @param part The part to set if the mouse events is accepted.
- * @param mouse_events EINA_TRUE if part will accept mouse events, @c EINA_FALSE otherwise.
+ * @param mouse_events @c EINA_TRUE if part will accept mouse events, @c EINA_FALSE otherwise.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_mouse_events_set(Evas_Object *obj, const char *part, Eina_Bool mouse_events);
-/** Get anti-alising for part.
+/**
+ * @brief Gets anti-aliasing for part.
*
* @param obj Object being edited.
* @param part Part to get if the anti-aliasing is accepted.
*
- * @return @c EINA_TRUE if part will draw anti-alised, @c EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if part will draw anti-aliased, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_anti_alias_get(Evas_Object *obj, const char *part);
-/** Set anti-alising for part.
+/**
+ * @brief Sets anti-aliasing for part.
*
* @param obj Object being edited.
* @param part The part to set if the anti-aliasing is accepted.
- * @param mouse_events EINA_TRUE if part should to draw anti-aliased, @c EINA_FALSE otherwise.
+ * @param mouse_events @c EINA_TRUE if part should to draw anti-aliased, @c EINA_FALSE otherwise.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_anti_alias_set(Evas_Object *obj, const char *part, Eina_Bool anti_alias);
-/** Get repeat_events for part.
+/**
+ * @brief Gets repeat_events for part.
*
* @param obj Object being edited.
* @param part Part to get if it will pass all events to the other parts.
*/
EAPI Eina_Bool edje_edit_part_repeat_events_get(Evas_Object *obj, const char *part);
-/** Set repeat_events for part.
+/**
+ * @brief Sets repeat_events for part.
*
* @param obj Object being edited.
* @param part Part to set if will repeat all the received mouse events to other parts.
- * @param repeat_events EINA_TRUE if the events received will propagate to other parts, @c EINA_FALSE otherwise
+ * @param repeat_events @c EINA_TRUE if the events received will propagate to other parts, @c EINA_FALSE otherwise
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_repeat_events_set(Evas_Object *obj, const char *part, Eina_Bool repeat_events);
-/** Get use_alternate_font_metrics variable for part.
+/**
+ * @brief Gets use_alternate_font_metrics variable for part.
*
* @param obj Object being edited.
* @param part Part to get use_alternate_font_metrics for text or textblock part is enabled.
EAPI Eina_Bool
edje_edit_part_use_alternate_font_metrics_get(Evas_Object *obj, const char *part);
-/** Set use_alternate_font_metrics variable for part.
+/**
+ * @brief Sets use_alternate_font_metrics variable for part.
*
* @param obj Object being edited.
* @param part Part to set use_alternate_font_metrics for text or textblock part is enabled.
EAPI Eina_Bool
edje_edit_part_use_alternate_font_metrics_set(Evas_Object *obj, const char *part, Eina_Bool use);
-/** Get multiline for part.
+/**
+ * @brief Gets multiline for part.
*
* @param obj Object being edited.
* @param part Part to get if editing multiple lines for text or textblock part is enabled.
*/
EAPI Eina_Bool edje_edit_part_multiline_get(Evas_Object *obj, const char *part);
-/** Set multiline for part.
+/**
+ * @brief Sets multiline for part.
*
* @param obj Object being edited.
* @param part Part to set if editing multiple lines for text or textblock part is enabled.
- * @param multiline EINA_TRUE if multiple lines for editing is enabled, @c EINA_FALSE otherwise
+ * @param multiline @c EINA_TRUE if multiple lines for editing is enabled, @c EINA_FALSE otherwise
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_multiline_set(Evas_Object *obj, const char *part, Eina_Bool multiline);
-/** Get precise_is_inside for part.
+/**
+ * @brief Gets precise_is_inside for part.
*
* @param obj Object being edited.
* @param part Part to get if it will enable point collision detection for the part.
*/
EAPI Eina_Bool edje_edit_part_precise_is_inside_get(Evas_Object *obj, const char *part);
-/** Set precise_is_inside for part.
+/**
+ * @brief Sets precise_is_inside for part.
*
* @param obj Object being edited.
* @param part Part to set if it will enable point collision detection for the part.
*/
EAPI Eina_Bool edje_edit_part_precise_is_inside_set(Evas_Object *obj, const char *part, Eina_Bool precise_is_inside);
-/** Get accessibility for part.
+/**
+ * @brief Gets accessibility for part.
*
* @param obj Object being edited.
* @param part Part to get if it uses accessibility feature.
*/
EAPI Eina_Bool edje_edit_part_access_get(Evas_Object *obj, const char *part);
-/** Set accessibility for part.
+/**
+ * @brief Sets accessibility for part.
*
* @param obj Object being edited.
* @param part Part to set if it uses accessibility feature.
*/
EAPI Eina_Bool edje_edit_part_access_set(Evas_Object *obj, const char *part, Eina_Bool access);
-/** Get ignore_flags for part.
+/**
+ * @brief Gets ignore_flags for part.
*
* @param obj Object being edited.
* @param part Part to get which event_flags are being ignored.
*/
EAPI Evas_Event_Flags edje_edit_part_ignore_flags_get(Evas_Object *obj, const char *part);
-/** Set ignore_flags for part.
+/**
+ * @brief Sets ignore_flags for part.
*
* @param obj Object being edited.
* @param part Part to set which event flags will be ignored.
*/
EAPI Eina_Bool edje_edit_part_ignore_flags_set(Evas_Object *obj, const char *part, Evas_Event_Flags ignore_flags);
-/** Get mask_flags for part.
+/**
+ * @brief Gets mask_flags for part.
*
* @param obj Object being edited.
* @param part Part to get which event_flags are being masked.
*/
EAPI Evas_Event_Flags edje_edit_part_mask_flags_get(Evas_Object *obj, const char *part);
-/** Set mask_flags for part.
+/**
+ * @brief Sets mask_flags for part.
*
* @param obj Object being edited.
* @param part Part to set which event flags will be masked.
*/
EAPI Eina_Bool edje_edit_part_mask_flags_set(Evas_Object *obj, const char *part, Evas_Event_Flags mask_flags);
-/** Get pointer_mode of a part.
+/**
+ * @brief Gets pointer_mode of a part.
*
* @param obj Object being edited.
* @param part Part name to get it's pointer_mode.
*/
EAPI Evas_Object_Pointer_Mode edje_edit_part_pointer_mode_get(Evas_Object *obj, const char *part);
-/** Get pointer_mode of a part.
+/**
+ * @brief Gets pointer_mode of a part.
*
* Note that Ponter Mode can be:
* - EVAS_OBJECT_POINTER_MODE_AUTOGRAB - default, X11-like
*/
EAPI Eina_Bool edje_edit_part_pointer_mode_set(Evas_Object *obj, const char *part, Evas_Object_Pointer_Mode pointer_mode);
-/** Get cursor_mode of a part.
+/**
+ * @brief Gets cursor_mode of a part.
*
* Note that Cursor Mode can be:
* 0 - UNDER cursor mode means the cursor will draw below the character pointed
*/
EAPI unsigned char edje_edit_part_cursor_mode_get(Evas_Object *obj, const char *part);
-/** Get pointer_mode of a part.
+/**
+ * @brief Gets pointer_mode of a part.
*
* Note that Cursor Mode can be:
* 0 - UNDER cursor mode means the cursor will draw below the character pointed
*/
EAPI Eina_Bool edje_edit_part_cursor_mode_set(Evas_Object *obj, const char *part, unsigned char cursor_mode);
-/** Set scale property for the part.
+/**
+ * @brief Sets scale property for the part.
*
* This property tells Edje that the given part should be scaled by the
* Edje scale factor.
*/
EAPI Eina_Bool edje_edit_part_scale_set(Evas_Object *obj, const char *part, Eina_Bool scale);
-/** Get scale for the part.
+/**
+ * @brief Gets scale for the part.
*
* @param obj Object being edited.
* @param part Part to get the scale value of.
*/
EAPI Eina_Bool edje_edit_part_scale_get(Evas_Object *obj, const char *part);
-/** Get horizontal dragable state for part.
+/**
+ * @brief Gets horizontal dragable state for part.
*
* @param obj Object being edited.
- * @param part Part to get if can be dragged horizontally;
+ * @param part Part to get if can be dragged horizontally.
*
- * @return 1 (or -1) if the part can be dragged horizontally, 0 otherwise.
+ * @return @c 1 (or -1) if the part can be dragged horizontally, @c 0 otherwise.
*/
EAPI int edje_edit_part_drag_x_get(Evas_Object *obj, const char *part);
-/** Set horizontal dragable state for part.
+/**
+ * @brief Sets horizontal dragable state for part.
*
* @param obj Object being edited.
* @param part Part to set if should be dragged horizontally.
- * @param drag 1 (or -1) if the part should be dragged horizontally, 0 otherwise.
+ * @param drag @c 1 (or -1) if the part should be dragged horizontally, @c 0 otherwise.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_x_set(Evas_Object *obj, const char *part, int drag);
-/** Get vertical dragable state for part.
+/**
+ * @brief Gets vertical dragable state for part.
*
* @param obj Object being edited.
* @param part Part to get if can be dragged vertically.
*
- * @return 1 (or - 1) if the part can be dragged vertically, 0 otherwise.
+ * @return @c 1 (or - 1) if the part can be dragged vertically, @c 0 otherwise.
*/
EAPI int edje_edit_part_drag_y_get(Evas_Object *obj, const char *part);
-/** Set vertical dragable state for part.
+/**
+ * @brief Sets vertical dragable state for part.
*
* @param obj Object being edited.
* @param part Part to set if should be dragged vertically.
- * @param drag 1 (or -1) of the part shpuld be dragged vertically, 0 otherwise.
+ * @param drag @c 1 (or -1) of the part should be dragged vertically, @c 0 otherwise.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_y_set(Evas_Object *obj, const char *part, int drag);
-/** Get horizontal dragable step for part.
+/**
+ * @brief Gets horizontal dragable step for part.
*
* @param obj Object being edited.
* @param part Part to get the drag horizontal step value.
*/
EAPI int edje_edit_part_drag_step_x_get(Evas_Object *obj, const char *part);
-/** Set horizontal dragable state for part.
+/**
+ * @brief Sets horizontal dragable state for part.
*
* @param obj Object being edited.
* @param part Part to set the drag horizontal step value.
*/
EAPI Eina_Bool edje_edit_part_drag_step_x_set(Evas_Object *obj, const char *part, int step);
-/** Get vertical dragable step for part.
+/**
+ * @brief Gets vertical dragable step for part.
*
* @param obj Object being edited.
* @param part Part to get the drag vertical step value.
*/
EAPI int edje_edit_part_drag_step_y_get(Evas_Object *obj, const char *part);
-/** Set vertical dragable state for part.
+/**
+ * @brief Sets vertical dragable state for part.
*
* @param obj Object being edited.
* @param part Part to set the drag vertical step value.
*/
EAPI Eina_Bool edje_edit_part_drag_step_y_set(Evas_Object *obj, const char *part, int step);
-/** Get horizontal dragable count for part.
+/**
+ * @brief Gets horizontal dragable count for part.
*
* @param obj Object being edited.
* @param part Part to get the drag horizontal count value.
*
- * @return horizontal dragable count value
+ * @return Horizontal dragable count value
*/
EAPI int edje_edit_part_drag_count_x_get(Evas_Object *obj, const char *part);
-/** Set horizontal dragable count for part.
+/**
+ * @brief Sets horizontal dragable count for part.
*
* @param obj Object being edited.
* @param part Part to set the drag horizontal count value.
*/
EAPI Eina_Bool edje_edit_part_drag_count_x_set(Evas_Object *obj, const char *part, int count);
-/** Get vertical dragable count for part.
+/**
+ * @brief Gets vertical dragable count for part.
*
* @param obj Object being edited.
* @param part Part to get the drag vertical count value.
*
- * @return vertical dragable count value
+ * @return Vertical dragable count value
*/
EAPI int edje_edit_part_drag_count_y_get(Evas_Object *obj, const char *part);
-/** Set vertical dragable count for part.
+/**
+ * @brief Sets vertical dragable count for part.
*
* @param obj Object being edited.
* @param part Part to set the drag vertical count value.
*/
EAPI Eina_Bool edje_edit_part_drag_count_y_set(Evas_Object *obj, const char *part, int count);
-/** Get the name of the part that is used as 'confine' for the given draggies.
+/**
+ * @brief Gets the name of the part that is used as 'confine' for the given draggies.
*
* @param obj Object being edited.
* @param part Part to get the name that is used as 'confine' for the given draggies.
*
- * @return The name of the confine part or NULL (if unset).
+ * @return The name of the confine part, or NULL (if unset).
*/
EAPI const char * edje_edit_part_drag_confine_get(Evas_Object *obj, const char *part);
-/** Set the name of the part that is used as 'confine' for the given draggies.
+/**
+ * @brief Sets the name of the part that is used as 'confine' for the given draggies.
*
* @param obj Object being edited.
* @param part Part to set the name that is used as 'confine' for the given draggies.
- * @param confine The name of the confine part or NULL to unset confine.
+ * @param confine The name of the confine part, or NULL to unset confine.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_confine_set(Evas_Object *obj, const char *part, const char *confine);
-/** Get the name of the part that is used as the receiver of the drag event.
+/**
+ * @brief Gets the name of the part that is used as the receiver of the drag event.
*
* @param obj Object being edited.
* @param part Part to get the name that is used as the receiver of the drag event.
*/
EAPI const char * edje_edit_part_drag_event_get(Evas_Object *obj, const char *part);
-/** Set the name of the part that will receive events from the given draggies.
+/**
+ * @brief Sets the name of the part that will receive events from the given draggies.
*
* @param obj Object being edited.
* @param part Part to set the name that will receive events from the given draggies.
*/
EAPI Eina_Bool edje_edit_part_drag_event_set(Evas_Object *obj, const char *part, const char *event);
-/** Get the name of the part that is used as 'threshold' for the given draggies.
+/**
+ * @brief Gets the name of the part that is used as 'threshold' for the given draggies.
*
* @param obj Object being edited.
* @param part Part to get the name that is used as 'threshold' for the given draggies.
*
- * @return The name of the threshold part or NULL (if unset).
+ * @return The name of the threshold part, or NULL (if unset).
*/
EAPI const char * edje_edit_part_drag_threshold_get(Evas_Object *obj, const char *part);
-/** Set the name of the part that is used as 'threshold' for the given draggies.
+/**
+ * @brief Sets the name of the part that is used as 'threshold' for the given draggies.
*
* @param obj Object being edited.
* @param part Part to set the name that is used as 'threshold' for the given draggies.
- * @param threshold The name of the threshold part or NULL to unset confine.
+ * @param threshold The name of the threshold part, or NULL to unset confine.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
/******************************************************************************/
/******************************* BOX API ****************************/
/******************************************************************************/
-/** @name Box Description API
- * Functions to deal with box (see @ref edcref).
+/**
+ * @name Box Description API
+ * Functions to deal with box (see @ref edcref).
*/ //@{
-/** Get primary layout of the box.
+/**
+ * @brief Gets primary layout of the box.
*
* @note The returned string should be freed with @c eina_stringshare_del().
* @param obj Object being edited.
*/
EAPI Eina_Stringshare * edje_edit_state_box_layout_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set primary layout of the box.
+/**
+ * @brief Sets primary layout of the box.
*
* When trying to set primary layout to NULL, function will use
* alternative layout instead.
*/
EAPI Eina_Bool edje_edit_state_box_layout_set(Evas_Object *obj, const char *part, const char *state, double value, char *layout);
-/** Get fallback layout of the box.
+/**
+ * @brief Gets fallback layout of the box.
*
* @note The returned string should be freed with @c eina_stringshare_del().
* @param obj Object being edited.
*/
EAPI Eina_Stringshare * edje_edit_state_box_alt_layout_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set fallback layout of the box.
+/**
+ * @brief Sets fallback layout of the box.
*
* When trying to set fallback layout to NULL, function will use
* default layout ("horizontal") instead.
/******************************************************************************/
/************************** TABLE API *************************************/
/******************************************************************************/
-/** @name Table Description API
- * Functions to deal with table (see @ref edcref).
+/**
+ * @name Table Description API
+ * Functions to deal with table (see @ref edcref).
*/ //@{
-/** Set homogeneous mode for TABLE part.
+/**
+ * @brief Sets homogeneous mode for TABLE part.
*
* @param obj Object being edited.
* @param part Part that have TABLE type.
*/
EAPI Eina_Bool
edje_edit_state_table_homogeneous_set(Evas_Object *obj, const char *part, const char *state, double value, unsigned char homogeneous);
-/** Get homogeneous mode for TABLE part.
+/**
+ * @brief Gets homogeneous mode for TABLE part.
*
* @param obj Object being edited.
* @param part Part that have TABLE type.
* @li EDJE_OBJECT_TABLE_HOMOGENEOUS_TABLE,
* @li EDJE_OBJECT_TABLE_HOMOGENEOUS_ITEM
*
- * @return Table homogeneous mode on success or 0 on any error.
+ * @return Table homogeneous mode on success, or @c 0 on any error.
* @since 1.14
*/
EAPI unsigned char edje_edit_state_table_homogeneous_get(Evas_Object *obj, const char *part, const char *state, double value);
/******************************************************************************/
/*********************** TABLE & BOX API **********************************/
/******************************************************************************/
-/** @name "Container" Description API
+/**
+ * @name "Container" Description API
* Functions to deal both with box and table (see @ref edcref).
* Those functions called edje_edit_state_container_<something> because they
* are working both for TABLE and BOX at same time.
*/ //@{
-/** Get whether vertical or horizontal minimum size's of the box are equal
+/**
+ * @deprecated Use edje_edit_state_container_min_h_get() and
+ * edje_edit_state_container_min_v_get() instead.
+ *
+ * @brief Gets whether vertical or horizontal minimum size's of the box are equal
* to the minimum vertical or horizontal size of items
* (function for BOX or TABLE part.
* If EINA_TRUE - is equal, if EINA_FALSE - is not)
* @param h Variable to store horizontal min value.
* @param v Variable to store vertical min value.
*
- * @deprecated Use edje_edit_state_container_min_h_get() and
- * edje_edit_state_container_min_v_get() instead.
- *
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.14
*/
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_state_container_min_get(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool *h, Eina_Bool *v);
-/** Get whether horizontal min size of the container is equal to the min
+/**
+ * @brief Gets whether horizontal min size of the container is equal to the min
* horizontal size of items (BOX and TABLE part functions).
*
* @param obj Object being edited.
EAPI Eina_Bool
edje_edit_state_container_min_h_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get whether vertical min size of the container is equal to the min vertical
+/**
+ * @brief Gets whether vertical min size of the container is equal to the min vertical
* size of items (BOX and TABLE part functions).
*
* @param obj Object being edited.
EAPI Eina_Bool
edje_edit_state_container_min_v_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set whether vertical or horizontal minimum size's of the box are equal
+/**
+ * @deprecated Use edje_edit_state_container_min_h_set() and
+ * edje_edit_state_container_min_v_set() instead.
+ *
+ * @brief Sets whether vertical or horizontal minimum size's of the box are equal
* to the minimum vertical or horizontal size of items
* (function for BOX or TABLE part.
* If EINA_TRUE - is equal, if EINA_FALSE - is not)
* @param h horizontal min value.
* @param v vertical min value.
*
- * @deprecated Use edje_edit_state_container_min_h_set() and
- * edje_edit_state_container_min_v_set() instead.
- *
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.14
*/
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_state_container_min_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool h, Eina_Bool v);
-/** Set whether horizontal min size of the container should be equal to the min
+/**
+ * @brief Sets whether horizontal min size of the container should be equal to the min
* horizontal size of items (BOX and TABLE part functions).
*
* @param obj Object being edited.
EAPI Eina_Bool
edje_edit_state_container_min_h_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool h);
-/** Set whether vertical min size of the container should be equal to the min
+/**
+ * @brief Sets whether vertical min size of the container should be equal to the min
* vertical size of items (BOX and TABLE part functions).
*
* @param obj Object being edited.
EAPI Eina_Bool
edje_edit_state_container_min_v_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool v);
-/** Get x and y paddings for BOX or TABLE part.
+/**
+ * @deprecated Use edje_edit_state_container_padding_x_get() and
+ * edje_edit_state_container_padding_y_get() instead.
+ *
+ * @brief Gets x and y paddings for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that have BOX/TABLE type.
* @param x Variable to store x padding.
* @param y Variable to store y padding.
*
- * @deprecated Use edje_edit_state_container_padding_x_get() and
- * edje_edit_state_container_padding_y_get() instead.
- *
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.14
*/
EINA_DEPRECATED EAPI Eina_Bool
edje_edit_state_container_padding_get(Evas_Object *obj, const char *part, const char *state, double value, int *x, int *y);
-/** Get x padding for BOX or TABLE part.
+/**
+ * @brief Gets x padding for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that has BOX/TABLE type.
EAPI int
edje_edit_state_container_padding_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get y padding for BOX or TABLE part.
+/**
+ * @brief Gets y padding for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that has BOX/TABLE type.
EAPI int
edje_edit_state_container_padding_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set x and y paddings for BOX or TABLE part.
+/**
+ * @deprecated Use edje_edit_state_container_padding_x_set() and
+ * edje_edit_state_container_padding_y_set() instead.
+ *
+ * @brief Sets x and y paddings for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that have BOX/TABLE type.
* @param x Value for setting x padding.
* @param y Value for setting y padding.
*
- * @deprecated Use edje_edit_state_container_padding_x_set() and
- * edje_edit_state_container_padding_y_set() instead.
- *
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.14
*/
EINA_DEPRECATED EAPI Eina_Bool
edje_edit_state_container_padding_set(Evas_Object *obj, const char *part, const char *state, double value, int x, int y);
-/** Set x padding for BOX or TABLE part.
+/**
+ * @brief Sets x padding for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that has BOX/TABLE type.
EAPI Eina_Bool
edje_edit_state_container_padding_x_set(Evas_Object *obj, const char *part, const char *state, double value, int x);
-/** Set y padding for BOX or TABLE part.
+/**
+ * @brief Sets y padding for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that has BOX/TABLE type.
EAPI Eina_Bool
edje_edit_state_container_padding_y_set(Evas_Object *obj, const char *part, const char *state, double value, int y);
-/** Set x and y align for BOX or TABLE part.
+/**
+ * @deprecated Use edje_edit_state_container_align_x_set() and
+ * edje_edit_state_container_align_y_set() instead.
+ *
+ * @brief Sets x and y align for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that have BOX/TABLE type.
* @param x Variable to store x value.
* @param y Variable to store y value.
*
- * @deprecated Use edje_edit_state_container_align_x_set() and
- * edje_edit_state_container_align_y_set() instead.
- *
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.14
*/
EINA_DEPRECATED EAPI Eina_Bool
edje_edit_state_container_align_set(Evas_Object *obj, const char *part, const char *state, double value, double x, double y);
-/** Set x align for BOX or TABLE part.
+/**
+ * @brief Sets x align for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that has BOX/TABLE type.
EAPI Eina_Bool
edje_edit_state_container_align_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
-/** Set y align for BOX or TABLE part.
+/**
+ * @brief Sets y align for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that has BOX/TABLE type.
EAPI Eina_Bool
edje_edit_state_container_align_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
-/** Get x and y align for BOX or TABLE part.
+/**
+ * @deprecated Use edje_edit_state_container_align_x_set() and
+ * edje_edit_state_container_align_y_set() instead.
+ *
+ * @brief Gets x and y align for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that have BOX/TABLE type.
* @param x Value for setting x align.
* @param y Value for setting y align.
*
- * @deprecated Use edje_edit_state_container_align_x_set() and
- * edje_edit_state_container_align_y_set() instead.
- *
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.14
*/
EINA_DEPRECATED EAPI Eina_Bool
edje_edit_state_container_align_get(Evas_Object *obj, const char *part, const char *state, double value, double *x, double *y);
-/** Get x align for BOX or TABLE part.
+/**
+ * @brief Gets x align for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that has BOX/TABLE type.
*/
EAPI double
edje_edit_state_container_align_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get y align for BOX or TABLE part.
+/**
+ * @brief Gets y align for BOX or TABLE part.
*
* @param obj Object being edited.
* @param part Part that has BOX/TABLE type.
/******************************************************************************/
/************************** BOX & TABLE ITEMS API *************************/
/******************************************************************************/
-/** @name Items API
- * Functions to deal with table and box part's items (see @ref edcref).
+/**
+ * @name Items API
+ * Functions to deal with table and box part's items (see @ref edcref).
*/ //@{
-/** Append new item to box or table part.
+/**
+ * @brief Appends new item to box or table part.
*
* @param obj Object being edited.
* @param part Part to add a new item. This part should have BOX or TABLE type.
*/
EAPI Eina_Bool edje_edit_part_item_append(Evas_Object *obj, const char *part, const char *item_name, const char *source_group);
-/** Insert new item to box or table part before specified existing item.
+/**
+ * @brief Inserts new item to box or table part before specified existing item.
*
* @param obj Object being edited.
* @param part Part to add a new item. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_insert_before(Evas_Object *obj, const char *part, const char *item_name, const char *item_before, const char *source_group);
-/** Insert new item to box or table part before specified existing item.
+/**
+ * @brief Inserts new item to box or table part before specified existing item.
*
* @param obj Object being edited.
* @param part Part to add a new item. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_insert_before_index(Evas_Object *obj, const char *part, const char *item_name, unsigned int index, const char *source_group);
-/** Insert new item to box or table part after specified existing item.
+/**
+ * @brief Inserts new item to box or table part after specified existing item.
*
* @param obj Object being edited.
* @param part Part to add a new item. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_insert_after(Evas_Object *obj, const char *part, const char *item_name, const char *item_after, const char *source_group);
-/** Insert new item to box or table part after specified existing item.
+/**
+ * @brief Inserts new item to box or table part after specified existing item.
*
* @param obj Object being edited.
* @param part Part to add a new item. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_insert_after_index(Evas_Object *obj, const char *part, const char *item_name, unsigned int index, const char *source_group);
-/** Insert new item to box or table part directly into specified position.
+/**
+ * @brief Inserts new item to box or table part directly into specified position.
*
* @param obj Object being edited.
* @param part Part to add a new item. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_insert_at(Evas_Object *obj, const char *part, const char *item_name, const char *source_group, unsigned int place);
-/** Restack existing item above.
+/**
+ * @brief Restacks existing item above.
*
* @param obj Object being edited.
* @param part Part which contain items. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_move_above(Evas_Object *obj, const char *part, const char *item_name);
-/** Restack existing item above.
+/**
+ * @brief Restacks existing item above.
*
* @param obj Object being edited.
* @param part Part which contain items. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_move_above_index(Evas_Object *obj, const char *part, unsigned int index);
-/** Restack existing item below.
+/**
+ * @brief Restacks existing item below.
*
* @param obj Object being edited.
* @param part Part which contain items. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_move_below(Evas_Object *obj, const char *part, const char *item_name);
-/** Restack existing item below.
+/**
+ * @brief Restacks existing item below.
*
* @param obj Object being edited.
* @param part Part which contain items. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_move_below_index(Evas_Object *obj, const char *part, unsigned int index);
-/** Get the list of all part items in the given edje.
+/**
+ * @brief Gets the list of all part items in the given edje.
*
* @param obj Object being edited.
* @param part Name of part which is TABLE or BOX part and contain items.
EINA_DEPRECATED
EAPI Eina_List * edje_edit_part_items_list_get(Evas_Object *obj, const char *part);
-/** Get the conunt of part items in the given edje.
+/**
+ * @brief Gets the count of part items in the given edje.
*
* @param obj Object being edited.
* @param part Name of part which is TABLE or BOX part and contain items.
EAPI int
edje_edit_part_items_count_get(Evas_Object *obj, const char *part);
-/** Delete item from box or table part.
+/**
+ * @brief Deletes item from box or table part.
*
* @param obj Object being edited.
* @param part Part to delete exist item. This part should have BOX or TABLE type.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_del(Evas_Object *obj, const char *part, const char* name);
-/** Delete item from box or table part by index.
+/**
+ * @brief Deletes item from box or table part by index.
*
* @param obj Object being edited.
* @param part Part to delete exist item. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_index_del(Evas_Object *obj, const char *part, unsigned int index);
-/** Set name for item from table or box items.
+/**
+ * @brief Sets name for item from table or box items.
*
* @param obj Object being edited.
* @param part Part to change item's source. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_index_name_set(Evas_Object *obj, const char *part, unsigned int index, const char *name);
-/** Get name for item from table or box items.
+/**
+ * @brief Gets name for item from table or box items.
*
* @param obj Object being edited.
* @param part Part to return item's source. This part should have BOX or TABLE type.
EAPI const char *
edje_edit_part_item_index_name_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set source for item from table or box items.
+/**
+ * @brief Sets source for item from table or box items.
*
* @param obj Object being edited.
* @param part Part to change item's source. This part should have BOX or TABLE type.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_source_set(Evas_Object *obj, const char *part, const char *item_name, const char *source_group);
-/** Set source for item from table or box items.
+/**
+ * @brief Sets source for item from table or box items.
*
* @param obj Object being edited.
* @param part Part to change item's source. This part should have BOX or TABLE type.
EAPI Eina_Bool
edje_edit_part_item_index_source_set(Evas_Object *obj, const char *part, unsigned int index, const char *source_group);
-/** Get source for item from table or box items.
+/**
+ * @brief Gets source for item from table or box items.
*
* @param obj Object being edited.
* @param part Part to return item's source. This part should have BOX or TABLE type.
EINA_DEPRECATED
EAPI const char * edje_edit_part_item_source_get(Evas_Object *obj, const char *part, const char *item_name);
-/** Get source for item from table or box items.
+/**
+ * @brief Gets source for item from table or box items.
*
* @param obj Object being edited.
* @param part Part to return item's source. This part should have BOX or TABLE type.
EAPI const char *
edje_edit_part_item_index_source_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Get the minimum width value of a part's item.
+/**
+ * @brief Gets the minimum width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI int edje_edit_part_item_min_w_get(Evas_Object *obj, const char *part, const char *item);
-/** Set the minimum width value of a part's item.
+/**
+ * @brief Sets the minimum width value of a part's item.
* The minimum width should be greater than 0.
*
* @param obj Object being edited.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_min_w_set(Evas_Object *obj, const char *part, const char *item, int min_w);
-/** Get the minimum height value of a part's item.
+/**
+ * @brief Gets the minimum height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI int edje_edit_part_item_min_h_get(Evas_Object *obj, const char *part, const char *item);
-/** Set the minimum height value of a part's item.
+/**
+ * @brief Sets the minimum height value of a part's item.
* The minimum height should be greater than 0.
*
* @param obj Object being edited.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_min_h_set(Evas_Object *obj, const char *part, const char *item, int min_h);
-/** Get the maximum width value of a part's item.
+/**
+ * @brief Gets the maximum width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI int edje_edit_part_item_max_w_get(Evas_Object *obj, const char *part, const char *item);
-/** Set the maximum width value of a part's item.
+/**
+ * @brief Sets the maximum width value of a part's item.
* The maximum width should be greater than -1.
* The value -1 means that state doesn't have any boundaries on width direction.
* (it can be any size that is bigger than it's min)
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_max_w_set(Evas_Object *obj, const char *part, const char *item, int max_w);
-/** Get the maximum height value of a part's item.
+/**
+ * @brief Gets the maximum height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI int edje_edit_part_item_max_h_get(Evas_Object *obj, const char *part, const char *item);
-/** Set the maximum height value of a part's item.
+/**
+ * @brief Sets the maximum height value of a part's item.
* The maximum height should be greater than -1.
* The value -1 means that state doesn't have any boundaries on height direction.
* (it can be any size that is bigger than it's min)
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_max_h_set(Evas_Object *obj, const char *part, const char *item, int max_h);
-/** Get the aspect width value of a part's item.
+/**
+ * @brief Gets the aspect width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI int edje_edit_part_item_aspect_w_get(Evas_Object *obj, const char *part, const char *item);
-/** Set the aspect width value of a part's item.
+/**
+ * @brief Sets the aspect width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_aspect_w_set(Evas_Object *obj, const char *part, const char *item, int aspect_w);
-/** Get the aspect height value of a part's item.
+/**
+ * @brief Gets the aspect height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI int edje_edit_part_item_aspect_h_get(Evas_Object *obj, const char *part, const char *item);
-/** Set the aspect height value of a part's item.
+/**
+ * @brief Sets the aspect height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_aspect_h_set(Evas_Object *obj, const char *part, const char *item, int aspect_h);
-/** Get the prefer width value of a part's item.
+/**
+ * @brief Gets the prefer width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI int edje_edit_part_item_prefer_w_get(Evas_Object *obj, const char *part, const char *item);
-/** Get aspect mode for an item of TABLE or BOX.
+/**
+ * @brief Gets aspect mode for an item of TABLE or BOX.
*
* This may return next values:
* - EDJE_ASPECT_CONTROL_NONE
EAPI Edje_Aspect_Control
edje_edit_part_item_aspect_mode_get(Evas_Object *obj, const char *part, const char *item);
-/** Set aspect mode for an item of TABLE or BOX.
+/**
+ * @brief Sets aspect mode for an item of TABLE or BOX.
*
* Mode may be next:
* - EDJE_ASPECT_CONTROL_NONE
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_aspect_mode_set(Evas_Object *obj, const char *part, const char *item, Edje_Aspect_Control mode);
-/** Set the prefer width value of a part's item.
+/**
+ * @brief Sets the prefer width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_prefer_w_set(Evas_Object *obj, const char *part, const char *item, int prefer_w);
-/** Get the prefer height value of a part's item.
+/**
+ * @brief Gets the prefer height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI int edje_edit_part_item_prefer_h_get(Evas_Object *obj, const char *part, const char *item);
-/** Set the prefer height value of a part's item.
+/**
+ * @brief Sets the prefer height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_prefer_h_set(Evas_Object *obj, const char *part, const char *item, int prefer_h);
-/** Get the spread width value of a part's item.
+/**
+ * @brief Gets the spread width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI int edje_edit_part_item_spread_w_get(Evas_Object *obj, const char *part, const char *item);
-/** Set the spread width value of a part's item.
+/**
+ * @brief Sets the spread width value of a part's item.
*
* @attention be careful, if you set up huge number (like 10 or 100). width and height of
* spread is being multiplied and you will get huge number of objects that may "eat"
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_spread_w_set(Evas_Object *obj, const char *part, const char *item, int spread_w);
-/** Get the spread height value of a part's item.
+/**
+ * @brief Gets the spread height value of a part's item.
*
* @attention be careful, if you set up huge number (like 10 or 100). width and height of
* spread is being multiplied and you will get huge number of objects that may "eat"
EINA_DEPRECATED
EAPI int edje_edit_part_item_spread_h_get(Evas_Object *obj, const char *part, const char *item);
-/** Set the spread height value of a part's item.
+/**
+ * @brief Sets the spread height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_spread_h_set(Evas_Object *obj, const char *part, const char *item, int spread_h);
-/** Get the minimum width value of a part's item.
+/**
+ * @brief Gets the minimum width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI int
edje_edit_part_item_index_min_w_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the minimum width value of a part's item.
+/**
+ * @brief Sets the minimum width value of a part's item.
* The minimum width should be greater than 0.
*
* @param obj Object being edited.
EAPI Eina_Bool
edje_edit_part_item_index_min_w_set(Evas_Object *obj, const char *part, unsigned int index, int min_w);
-/** Get the minimum height value of a part's item.
+/**
+ * @brief Gets the minimum height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI int
edje_edit_part_item_index_min_h_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the minimum height value of a part's item.
+/**
+ * @brief Sets the minimum height value of a part's item.
* The minimum height should be greater than 0.
*
* @param obj Object being edited.
EAPI Eina_Bool
edje_edit_part_item_index_min_h_set(Evas_Object *obj, const char *part, unsigned int index, int min_h);
-/** Get the maximum width value of a part's item.
+/**
+ * @brief Gets the maximum width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI int
edje_edit_part_item_index_max_w_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the maximum width value of a part's item.
+/**
+ * @brief Sets the maximum width value of a part's item.
* The maximum width should be greater than -1.
* The value -1 means that state doesn't have any boundaries on width direction.
* (it can be any size that is bigger than it's min)
EAPI Eina_Bool
edje_edit_part_item_index_max_w_set(Evas_Object *obj, const char *part, unsigned int index, int max_w);
-/** Get the maximum height value of a part's item.
+/**
+ * @brief Gets the maximum height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI int
edje_edit_part_item_index_max_h_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the maximum height value of a part's item.
+/**
+ * @brief Sets the maximum height value of a part's item.
* The maximum height should be greater than -1.
* The value -1 means that state doesn't have any boundaries on height direction.
* (it can be any size that is bigger than it's min)
EAPI Eina_Bool
edje_edit_part_item_index_max_h_set(Evas_Object *obj, const char *part, unsigned int index, int max_h);
-/** Get the aspect width value of a part's item.
+/**
+ * @brief Gets the aspect width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI int
edje_edit_part_item_index_aspect_w_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the aspect width value of a part's item.
+/**
+ * @brief Sets the aspect width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI Eina_Bool
edje_edit_part_item_index_aspect_w_set(Evas_Object *obj, const char *part, unsigned int index, int aspect_w);
-/** Get the aspect height value of a part's item.
+/**
+ * @brief Gets the aspect height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI int
edje_edit_part_item_index_aspect_h_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the aspect height value of a part's item.
+/**
+ * @brief Sets the aspect height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI Eina_Bool
edje_edit_part_item_index_aspect_h_set(Evas_Object *obj, const char *part, unsigned int index, int aspect_h);
-/** Get the prefer width value of a part's item.
+/**
+ * @brief Gets the prefer width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI int
edje_edit_part_item_index_prefer_w_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Get aspect mode for an item of TABLE or BOX.
+/**
+ * @brief Gets aspect mode for an item of TABLE or BOX.
*
* This may return next values:
* - EDJE_ASPECT_CONTROL_NONE
EAPI Edje_Aspect_Control
edje_edit_part_item_index_aspect_mode_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set aspect mode for an item of TABLE or BOX.
+/**
+ * @brief Sets aspect mode for an item of TABLE or BOX.
*
* Mode may be next:
* - EDJE_ASPECT_CONTROL_NONE
EAPI Eina_Bool
edje_edit_part_item_index_aspect_mode_set(Evas_Object *obj, const char *part, unsigned int index, Edje_Aspect_Control mode);
-/** Set the prefer width value of a part's item.
+/**
+ * @brief Sets the prefer width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI Eina_Bool
edje_edit_part_item_index_prefer_w_set(Evas_Object *obj, const char *part, unsigned int index, int prefer_w);
-/** Get the prefer height value of a part's item.
+/**
+ * @brief Gets the prefer height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI int
edje_edit_part_item_index_prefer_h_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the prefer height value of a part's item.
+/**
+ * @brief Sets the prefer height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI Eina_Bool
edje_edit_part_item_index_prefer_h_set(Evas_Object *obj, const char *part, unsigned int index, int prefer_h);
-/** Get the spread width value of a part's item.
+/**
+ * @brief Gets the spread width value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI int
edje_edit_part_item_index_spread_w_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the spread width value of a part's item.
+/**
+ * @brief Sets the spread width value of a part's item.
*
* @attention be careful, if you set up huge number (like 10 or 100). width and height of
* spread is being multiplied and you will get huge number of objects that may "eat"
EAPI Eina_Bool
edje_edit_part_item_index_spread_w_set(Evas_Object *obj, const char *part, unsigned int index, int spread_w);
-/** Get the spread height value of a part's item.
+/**
+ * @brief Gets the spread height value of a part's item.
*
* @attention be careful, if you set up huge number (like 10 or 100). width and height of
* spread is being multiplied and you will get huge number of objects that may "eat"
EAPI int
edje_edit_part_item_index_spread_h_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the spread height value of a part's item.
+/**
+ * @brief Sets the spread height value of a part's item.
*
* @param obj Object being edited.
* @param part Part that contain state.
EAPI Eina_Bool
edje_edit_part_item_index_spread_h_set(Evas_Object *obj, const char *part, unsigned int index, int spread_h);
-/** Get paddings of the part's item.
+/**
+ * @brief Gets paddings of the part's item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_padding_get(Evas_Object *obj, const char *part, const char *item_name, int *l, int *r, int *t, int *b);
-/** Set paddings of the part's item.
+/**
+ * @brief Sets paddings of the part's item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_padding_set(Evas_Object *obj, const char *part, const char *item_name, int l, int r, int t, int b);
-/** Get paddings of the part's item.
+/**
+ * @brief Gets paddings of the part's item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_index_padding_get(Evas_Object *obj, const char *part, unsigned int index, int *l, int *r, int *t, int *b);
-/** Set paddings of the part's item.
+/**
+ * @brief Sets paddings of the part's item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_index_padding_set(Evas_Object *obj, const char *part, unsigned int index, int l, int r, int t, int b);
-/** Get the horizontal align value of a part state.
+/**
+ * @brief Gets the horizontal align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain item.
EINA_DEPRECATED
EAPI double edje_edit_part_item_align_x_get(Evas_Object *obj, const char *part, const char *item);
-/** Get the horizontal align value of a part state.
+/**
+ * @brief Gets the horizontal align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI double
edje_edit_part_item_index_align_x_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the horizontal align value of a part state.
+/**
+ * @brief Sets the horizontal align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain itemf
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_align_x_set(Evas_Object *obj, const char *part, const char *item, double align_x);
-/** Set the horizontal align value of a part state.
+/**
+ * @brief Sets the horizontal align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain itemf
EAPI Eina_Bool
edje_edit_part_item_index_align_x_set(Evas_Object *obj, const char *part, unsigned int index, double align_x);
-/** Get the vertical align value of a part state.
+/**
+ * @brief Gets the vertical align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain item.
EINA_DEPRECATED
EAPI double edje_edit_part_item_align_y_get(Evas_Object *obj, const char *part, const char *item);
-/** Get the vertical align value of a part state.
+/**
+ * @brief Gets the vertical align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI double
edje_edit_part_item_index_align_y_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the vertical align value of a part state.
+/**
+ * @brief Sets the vertical align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain item.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_align_y_set(Evas_Object *obj, const char *part, const char *item, double align_y);
-/** Set the vertical align value of a part state.
+/**
+ * @brief Sets the vertical align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_index_align_y_set(Evas_Object *obj, const char *part, unsigned int index, double align_y);
-/** Get the horizontal weight value of a part item.
+/**
+ * @brief Gets the horizontal weight value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EINA_DEPRECATED
EAPI double edje_edit_part_item_weight_x_get(Evas_Object *obj, const char *part, const char *item);
-/** Get the horizontal weight value of a part item.
+/**
+ * @brief Gets the horizontal weight value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI double
edje_edit_part_item_index_weight_x_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the horizontal we value of a part item.
+/**
+ * @brief Sets the horizontal we value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain itemf
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_weight_x_set(Evas_Object *obj, const char *part, const char *item, double weight_x);
-/** Set the horizontal we value of a part item.
+/**
+ * @brief Sets the horizontal we value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain itemf
EAPI Eina_Bool
edje_edit_part_item_index_weight_x_set(Evas_Object *obj, const char *part, unsigned int index, double weight_x);
-/** Get the vertical weight value of a part item.
+/**
+ * @brief Gets the vertical weight value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EINA_DEPRECATED
EAPI double edje_edit_part_item_weight_y_get(Evas_Object *obj, const char *part, const char *item);
-/** Get the vertical weight value of a part item.
+/**
+ * @brief Gets the vertical weight value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI double
edje_edit_part_item_index_weight_y_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the vertical weight value of a part item.
+/**
+ * @brief Sets the vertical weight value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_weight_y_set(Evas_Object *obj, const char *part, const char *item, double weight_y);
-/** Set the vertical weight value of a part item.
+/**
+ * @brief Sets the vertical weight value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_index_weight_y_set(Evas_Object *obj, const char *part, unsigned int index, double weight_y);
-/** Get column/row position of the part's item.
+/**
+ * @deprecated Use edje_edit_part_item_position_col_get() and
+ * edje_edit_part_item_position_row_get() instead.
+ *
+ * @brief Gets column/row position of the part's item.
*
* @param obj Object being edited.
* @param part Part that contain item.
* @param col Column item position.
* @param row Row item position.
*
- * @deprecated Use edje_edit_part_item_position_col_get() and
- * edje_edit_part_item_position_row_get() instead.
- *
* @return @c EINA_TRUE If successful, @c EINA_FALSE otherwise.
* @since 1.11
*/
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_position_get(Evas_Object *obj, const char *part, const char *item_name, unsigned short *col, unsigned short *row);
-/** Get the horizontal align value of a part state.
+/**
+ * @brief Gets the horizontal align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI double
edje_edit_part_item_item_align_x_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the horizontal align value of a part state.
+/**
+ * @brief Sets the horizontal align value of a part state.
*
* @param obj Object being edited.
- * @param part Part that contain itemf
+ * @param part Part that contain item
* @param index Index of the item to set horizontal align value.
* @param align_x New value of the horizontal align.
*
EAPI Eina_Bool
edje_edit_part_item_item_align_x_set(Evas_Object *obj, const char *part, unsigned int index, double align_x);
-/** Get the vertical align value of a part state.
+/**
+ * @brief Gets the vertical align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI double
edje_edit_part_item_item_align_y_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the vertical align value of a part state.
+/**
+ * @brief Sets the vertical align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_item_align_y_set(Evas_Object *obj, const char *part, unsigned int index, double align_y);
-/** Get the horizontal weight value of a part item.
+/**
+ * @brief Gets the horizontal weight value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI double
edje_edit_part_item_item_weight_x_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the horizontal we value of a part item.
+/**
+ * @brief Sets the horizontal we value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain itemf
EAPI Eina_Bool
edje_edit_part_item_item_weight_x_set(Evas_Object *obj, const char *part, unsigned int index, double weight_x);
-/** Get the vertical weight value of a part item.
+/**
+ * @brief Gets the vertical weight value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI double
edje_edit_part_item_item_weight_y_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set the vertical weight value of a part item.
+/**
+ * @brief Sets the vertical weight value of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_item_weight_y_set(Evas_Object *obj, const char *part, unsigned int index, double weight_y);
-/** Get column position of the part's item.
+/**
+ * @brief Gets column position of the part's item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI unsigned short
edje_edit_part_item_position_col_get(Evas_Object *obj, const char *part, const char *item_name);
-/** Get row position of the part's item.
+/**
+ * @brief Gets row position of the part's item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI unsigned short
edje_edit_part_item_position_row_get(Evas_Object *obj, const char *part, const char *item_name);
-/** Get column position of the part's item.
+/**
+ * @brief Gets column position of the part's item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI unsigned short
edje_edit_part_item_index_position_col_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Get row position of the part's item.
+/**
+ * @brief Gets row position of the part's item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI unsigned short
edje_edit_part_item_index_position_row_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Set column/row position of a new part's item.
+/**
+ * @deprecated Use edje_edit_part_item_position_col_set() and
+ * edje_edit_part_item_position_row_set() instead.
+ *
+ * @brief Sets column/row position of a new part's item.
*
* @param obj Object being edited.
* @param part Part that contain item.
* @param col Column item position.
* @param row Row item position.
*
- * @deprecation Use edje_edit_part_item_position_col_set() and
- * edje_edit_part_item_position_row_set() instead.
- *
* @return @c EINA_TRUE If successful, @c EINA_FALSE otherwise.
* @since 1.11
*/
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_position_set(Evas_Object *obj, const char *part, const char *item_name, unsigned short col, unsigned short row);
-/** Set column position of a part item.
+/**
+ * @brief Sets column position of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_position_col_set(Evas_Object *obj, const char *part, const char *item_name, unsigned short col);
-/** Set row position of a part item.
+/**
+ * @brief Sets row position of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_position_row_set(Evas_Object *obj, const char *part, const char *item_name, unsigned short row);
-/** Set column position of a part item.
+/**
+ * @brief Sets column position of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_index_position_col_set(Evas_Object *obj, const char *part, unsigned int index, unsigned short col);
-/** Set row position of a part item.
+/**
+ * @brief Sets row position of a part item.
*
* @param obj Object being edited.
* @param part Part that contain item.
edje_edit_part_item_index_position_row_set(Evas_Object *obj, const char *part, unsigned int index, unsigned short row);
-/** Retrieves the how many columns and rows will span for use by item.
+/**
+ * @brief Retrieves the how many columns and rows will span for use by item.
*
* @param obj object being edited.
* @param part part that contain item.
EINA_DEPRECATED
EAPI void edje_edit_part_item_span_get(Evas_Object *obj, const char *part, const char *item, unsigned char *col, unsigned char *row);
-/** Get the number of span columns.
+/**
+ * @brief Gets the number of span columns.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI unsigned short
edje_edit_part_item_span_col_get(Evas_Object *obj, const char *part, const char *item);
-/** Get the number of span rows.
+/**
+ * @brief Gets the number of span rows.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI unsigned short
edje_edit_part_item_span_row_get(Evas_Object *obj, const char *part, const char *item);
-/** Set the count of columns and rows, which this item will spans for use.
+/**
+ * @brief Sets the count of columns and rows, which this item will spans for use.
*
* @param obj object being edited.
* @param part part that contain item.
EINA_DEPRECATED
EAPI Eina_Bool edje_edit_part_item_span_set(Evas_Object *obj, const char *part, const char *item, unsigned char col, unsigned char row);
-/** Set the count of columns which this item will spans for use.
+/**
+ * @brief Sets the count of columns which this item will spans for use.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_span_col_set(Evas_Object *obj, const char *part, const char *item, unsigned short col);
-/** Set the count of rows which this item will spans for use.
+/**
+ * @brief Sets the count of rows which this item will spans for use.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_span_row_set(Evas_Object *obj, const char *part, const char *item, unsigned short row);
-/** Set the count of columns which this item will spans for use.
+/**
+ * @brief Sets the count of columns which this item will spans for use.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_index_span_col_set(Evas_Object *obj, const char *part, unsigned int index, unsigned short col);
-/** Set the count of rows which this item will spans for use.
+/**
+ * @brief Sets the count of rows which this item will spans for use.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI Eina_Bool
edje_edit_part_item_index_span_row_set(Evas_Object *obj, const char *part, unsigned int index, unsigned short row);
-/** Get the number of span columns.
+/**
+ * @brief Gets the number of span columns.
*
* @param obj Object being edited.
* @param part Part that contain item.
EAPI unsigned short
edje_edit_part_item_index_span_col_get(Evas_Object *obj, const char *part, unsigned int index);
-/** Get the number of span rows.
+/**
+ * @brief Gets the number of span rows.
*
* @param obj Object being edited.
* @param part Part that contain item.
/******************************************************************************/
/************************** STATES API ************************************/
/******************************************************************************/
-/** @name States API
- * Functions to deal with part states (see @ref edcref).
+/**
+ * @name States API
+ * Functions to deal with part states (see @ref edcref).
*/ //@{
-/** Get the list of all the states in the given part.
+/**
+ * @brief Gets the list of all the states in the given part.
*
* @param obj Object being edited.
* @param part Part to get the states names list.
*/
EAPI Eina_List * edje_edit_part_states_list_get(Evas_Object *obj, const char *part);
-/** Set a new name for the given state in the given part.
+/**
+ * @brief Sets a new name for the given state in the given part.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_name_set(Evas_Object *obj, const char *part, const char *state, double value, const char *new_name, double new_value);
-/** Create a new state to the give part.
+/**
+ * @brief Creates a new state to the give part.
*
* @param obj Object being edited.
* @param part Part to set the name of the new state.
*/
EAPI Eina_Bool edje_edit_state_add(Evas_Object *obj, const char *part, const char *name, double value);
-/** Delete the given part state from the edje.
+/**
+ * @brief Deletes the given part state from the edje.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_del(Evas_Object *obj, const char *part, const char *state, double value);
-/** Check if a part state with the given name exist.
+/**
+ * @brief Checks if a part state with the given name exist.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_exist(Evas_Object *obj, const char *part, const char *state, double value);
-/** Copies the state @p from into @p to. If @p to doesn't exist it will be created.
+/**
+ * @brief Copies the state @p from into @p to. If @p to doesn't exist it will be created.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_copy(Evas_Object *obj, const char *part, const char *from, double val_from, const char *to, double val_to);
-/** Get the 'rel1 relative X' value of state.
+/**
+ * @brief Gets the 'rel1 relative X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_rel1_relative_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the 'rel1 relative Y' value of state.
+/**
+ * @brief Gets the 'rel1 relative Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_rel1_relative_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the 'rel2 relative X' value of state.
+/**
+ * @brief Gets the 'rel2 relative X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_rel2_relative_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the 'rel2 relative Y' value of state.
+/**
+ * @brief Gets the 'rel2 relative Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_rel2_relative_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the 'rel1 relative X' value of state.
+/**
+ * @brief Sets the 'rel1 relative X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel1_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
-/** Set the 'rel1 relative Y' value of state.
+/**
+ * @brief Sets the 'rel1 relative Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel1_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
-/** Set the 'rel2 relative X' value of state.
+/**
+ * @brief Sets the 'rel2 relative X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel2_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
-/** Set the 'rel2 relative Y' value of state.
+/**
+ * @brief Sets the 'rel2 relative Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel2_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
-/** Get the 'rel1 offset X' value of state.
+/**
+ * @brief Gets the 'rel1 offset X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_rel1_offset_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the 'rel1 offset Y' value of state.
+/**
+ * @brief Gets the 'rel1 offset Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_rel1_offset_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the 'rel2 offset X' value of state.
+/**
+ * @brief Gets the 'rel2 offset X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_rel2_offset_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the 'rel2 offset Y' value of state.
+/**
+ * @brief Gets the 'rel2 offset Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_rel2_offset_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the 'rel1 offset X' value of state.
+/**
+ * @brief Sets the 'rel1 offset X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel1_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, int x);
-/** Set the 'rel1 offset Y' value of state.
+/**
+ * @brief Sets the 'rel1 offset Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel1_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, int y);
-/** Set the 'rel2 offset X' value of state.
+/**
+ * @brief Sets the 'rel2 offset X' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel2_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, int x);
-/** Set the 'rel2 offset Y' value of state.
+/**
+ * @brief Sets the 'rel2 offset Y' value of state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel2_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, int y);
-/** Get the part name rel1x is relative to.
+/**
+ * @brief Gets the part name rel1x is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The state that contain which the part name rel1x is relative to (not including the state value).
* @param value The state value.
*
- * @return The part name rel1x is relative to or NULL if the part is relative to the whole interface.
+ * @return The part name rel1x is relative to, or NULL if the part is relative to the whole interface.
*/
EAPI const char * edje_edit_state_rel1_to_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the part name rel1y is relative to.
+/**
+ * @brief Gets the part name rel1y is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The state that contain which the part name rel1y is relative to (not including the state value).
* @param value The state value.
*
- * @return The part name rel1y is relative to or NULL if the part is relative to the whole interface.
+ * @return The part name rel1y is relative to, or NULL if the part is relative to the whole interface.
*/
EAPI const char * edje_edit_state_rel1_to_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the part name rel2x is relative to.
+/**
+ * @brief Gets the part name rel2x is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The state that contain which the part name rel2x is relative to (not including the state value).
* @param value The state value.
*
- * @return The part name rel2x is relative to or NULL if the part is relative to the whole interface.
+ * @return The part name rel2x is relative to, or NULL if the part is relative to the whole interface.
*/
EAPI const char * edje_edit_state_rel2_to_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the part name rel2y is relative to.
+/**
+ * @brief Gets the part name rel2y is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The state that contain which the part name rel2y is relative to (not including the state value).
* @param value The state value.
*
- * @return The part name rel2y is relative to or NULL if the part is relative to the whole interface.
+ * @return The part name rel2y is relative to, or NULL if the part is relative to the whole interface.
*/
EAPI const char * edje_edit_state_rel2_to_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the part rel1x is relative to.
+/**
+ * @brief Sets the part rel1x is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel1_to_x_set(Evas_Object *obj, const char *part, const char *state, double value, const char *rel_to);
-/** Set the part rel1y is relative to.
+/**
+ * @brief Sets the part rel1y is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel1_to_y_set(Evas_Object *obj, const char *part, const char *state, double value, const char *rel_to);
-/** Set the part rel2x is relative to.
+/**
+ * @brief Sets the part rel2x is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel2_to_x_set(Evas_Object *obj, const char *part, const char *state, double value, const char *rel_to);
-/** Set the part rel2y is relative to.
+/**
+ * @brief Sets the part rel2y is relative to.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_rel2_to_y_set(Evas_Object *obj, const char *part, const char *state, double value, const char *rel_to);
-/** Get the color of a part state.
+/**
+ * @brief Gets the color of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI void edje_edit_state_color_get(Evas_Object *obj, const char *part, const char *state, double value, int *r, int *g, int *b, int *a);
-/** Get the color2 of a part state.
+/**
+ * @brief Gets the color2 of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI void edje_edit_state_color2_get(Evas_Object *obj, const char *part, const char *state, double value, int *r, int *g, int *b, int *a);
-/** Get the color3 of a part state.
+/**
+ * @brief Gets the color3 of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI void edje_edit_state_color3_get(Evas_Object *obj, const char *part, const char *state, double value, int *r, int *g, int *b, int *a);
-/** Set the color of a part state.
+/**
+ * @brief Sets the color of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_color_set(Evas_Object *obj, const char *part, const char *state, double value, int r, int g, int b, int a);
-/** Set the color2 of a part state.
+/**
+ * @brief Sets the color2 of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_color2_set(Evas_Object *obj, const char *part, const char *state, double value, int r, int g, int b, int a);
-/** Set the color3 of a part state.
+/**
+ * @brief Sets the color3 of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_color3_set(Evas_Object *obj, const char *part, const char *state, double value, int r, int g, int b, int a);
-/** Get the horizontal align value of a part state.
+/**
+ * @brief Gets the horizontal align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_align_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the vertical align value of a part state.
+/**
+ * @brief Gets the vertical align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_align_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the horizontal align value of a part state.
+/**
+ * @brief Sets the horizontal align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_align_x_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
-/** Set the vertical align value of a part state.
+/**
+ * @brief Sets the vertical align value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_align_y_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
-/** Get the minimum width value of a part state.
+/**
+ * @brief Gets the minimum width value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_min_w_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the minimum width value of a part state.
+/**
+ * @brief Sets the minimum width value of a part state.
* The minimum width should be greater than 0.
*
* @param obj Object being edited.
*/
EAPI Eina_Bool edje_edit_state_min_w_set(Evas_Object *obj, const char *part, const char *state, double value, int min_w);
-/** Get the minimum height value of a part state.
+/**
+ * @brief Gets the minimum height value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_min_h_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the minimum height value of a part state.
+/**
+ * @brief Sets the minimum height value of a part state.
* The minimum height should be greater than 0.
*
* @param obj Object being edited.
*/
EAPI Eina_Bool edje_edit_state_min_h_set(Evas_Object *obj, const char *part, const char *state, double value, int min_h);
-/** Get the maximum width value of a part state.
+/**
+ * @brief Gets the maximum width value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_max_w_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the maximum width value of a part state.
+/**
+ * @brief Sets the maximum width value of a part state.
* The maximum width should be greater than -1.
* The value -1 means that state doesn't have any boundaries on width direction.
* (it can be any size that is bigger than it's min)
*/
EAPI Eina_Bool edje_edit_state_max_w_set(Evas_Object *obj, const char *part, const char *state, double value, int max_w);
-/** Get the maximum height value of a part state.
+/**
+ * @brief Gets the maximum height value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_max_h_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the maximum height value of a part state.
+/**
+ * @brief Sets the maximum height value of a part state.
* The maximum height should be greater than -1.
* The value -1 means that state doesn't have any boundaries on height direction.
* (it can be any size that is bigger than it's min)
*/
EAPI Eina_Bool edje_edit_state_max_h_set(Evas_Object *obj, const char *part, const char *state, double value, int max_h);
-/** Get the multiplier (minmul) width value of a part state.
+/**
+ * @brief Gets the multiplier (minmul) width value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_minmul_w_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the multiplier (minmul) width value of a part state.
+/**
+ * @brief Sets the multiplier (minmul) width value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_minmul_w_set(Evas_Object *obj, const char *part, const char *state, double value, double minmul_w);
-/** Get the multiplier (minmul) height value of a part state.
+/**
+ * @brief Gets the multiplier (minmul) height value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_minmul_h_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the multiplier (minmul) height value of a part state.
+/**
+ * @brief Sets the multiplier (minmul) height value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_minmul_h_set(Evas_Object *obj, const char *part, const char *state, double value, double minmul_h);
-/** Get the fixed width value of a part state.
+/**
+ * @brief Gets the fixed width value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fixed_w_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the fixed width value of a part state.
+/**
+ * @brief Sets the fixed width value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fixed_w_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool fixed);
-/** Get the fixed height value of a part state.
+/**
+ * @brief Gets the fixed height value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fixed_h_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the fixed height value of a part state.
+/**
+ * @brief Sets the fixed height value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fixed_h_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool fixed);
-/** Get the minimum aspect value of a part state.
+/**
+ * @brief Gets the minimum aspect value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_aspect_min_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the maximum aspect value of a part state.
+/**
+ * @brief Gets the maximum aspect value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_aspect_max_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the minimum aspect value of a part state.
+/**
+ * @brief Sets the minimum aspect value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_aspect_min_set(Evas_Object *obj, const char *part, const char *state, double value, double aspect);
-/** Set the maximum aspect value of a part state.
+/**
+ * @brief Sets the maximum aspect value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_aspect_max_set(Evas_Object *obj, const char *part, const char *state, double value, double aspect);
-/** Get the aspect preference of a part state.
+/**
+ * @brief Gets the aspect preference of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI unsigned char edje_edit_state_aspect_pref_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the aspect preference of a part state.
+/**
+ * @brief Sets the aspect preference of a part state.
*
* The available values of aspect preference are:
* <ul style="list-style-type:none">
*/
EAPI Eina_Bool edje_edit_state_aspect_pref_set(Evas_Object *obj, const char *part, const char *state, double value, unsigned char pref);
-/** Get the smooth property for given part state.
+/**
+ * @brief Gets the smooth property for given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fill_smooth_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the smooth property for given part state.
+/**
+ * @brief Sets the smooth property for given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fill_smooth_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool smooth);
-/** Get the fill type property for given part state.
+/**
+ * @brief Gets the fill type property for given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI unsigned char edje_edit_state_fill_type_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the fill type property for given part state.
+/**
+ * @brief Sets the fill type property for given part state.
*
* Sets the image fill type. The available types are:
* <dl>
*/
EAPI Eina_Bool edje_edit_state_fill_type_set(Evas_Object *obj, const char *part, const char *state, double value, unsigned char fill_type);
-/** Get the fill horizontal origin relative value of a part state.
+/**
+ * @brief Gets the fill horizontal origin relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_fill_origin_relative_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the fill vertical origin relative value of a part state.
+/**
+ * @brief Gets the fill vertical origin relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_fill_origin_relative_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the fill horizontal origin offset value of a part state.
+/**
+ * @brief Gets the fill horizontal origin offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_fill_origin_offset_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the fill vertical origin offset value of a part state.
+/**
+ * @brief Gets the fill vertical origin offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_fill_origin_offset_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the fill horizontal origin relative value of a part state.
+/**
+ * @brief Sets the fill horizontal origin relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
-/** Set the fill horizontal origin relative value of a part state.
+/**
+ * @brief Sets the fill horizontal origin relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
-/** Set the fill horizontal origin offset value of a part state.
+/**
+ * @brief Sets the fill horizontal origin offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
-/** Set the fill vertical origin offset value of a part state.
+/**
+ * @brief Sets the fill vertical origin offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
-/** Get the fill horizontal size relative value of a part state.
+/**
+ * @brief Gets the fill horizontal size relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_fill_size_relative_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the fill vertical size relative value of a part state.
+/**
+ * @brief Gets the fill vertical size relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI double edje_edit_state_fill_size_relative_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the fill horizontal size offset value of a part state.
+/**
+ * @brief Gets the fill horizontal size offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_fill_size_offset_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the fill vertical size offset value of a part state.
+/**
+ * @brief Gets the fill vertical size offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI int edje_edit_state_fill_size_offset_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the fill horizontal size relative value of a part state.
+/**
+ * @brief Sets the fill horizontal size relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fill_size_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
-/** Set the fill vertical size relative value of a part state.
+/**
+ * @brief Sets the fill vertical size relative value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fill_size_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
-/** Set the fill horizontal size offset value of a part state.
+/**
+ * @brief Sets the fill horizontal size offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fill_size_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
-/** Set the fill vertical size offset value of a part state.
+/**
+ * @brief Sets the fill vertical size offset value of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_fill_size_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
-/** Get the visibility of a part state.
+/**
+ * @brief Gets the visibility of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_visible_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the visibility of a part state.
+/**
+ * @brief Sets the visibility of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_visible_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool visible);
-/** Get the color class of the given part state.
+/**
+ * @brief Gets the color class of the given part state.
*
* Remember to free the string with edje_edit_string_free()
*
*/
EAPI const char *edje_edit_state_color_class_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the color class of the given part state.
+/**
+ * @brief Sets the color class of the given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_color_class_set(Evas_Object *obj, const char *part, const char *state, double value, const char *color_class);
-/** Get the list of parameters for an external part.
+/**
+ * @brief Gets the list of parameters for an external part.
*
* DO NOT FREE THE LIST!
*
*/
EAPI const Eina_List * edje_edit_state_external_params_list_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the external parameter type and value.
+/**
+ * @brief Gets the external parameter type and value.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, Edje_External_Param_Type *type, void **val);
-/** Get external parameter of type INT.
+/**
+ * @brief Gets external parameter of type INT.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_int_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, int *val);
-/** Get external parameter of type BOOL.
+/**
+ * @brief Gets external parameter of type BOOL.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_bool_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, Eina_Bool *val);
-/** Get external parameter of type DOUBLE.
+/**
+ * @brief Gets external parameter of type DOUBLE.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_double_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, double *val);
-/** Get external parameter of type STRING.
+/**
+ * @brief Gets external parameter of type STRING.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_string_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, const char **val);
-/** Get external parameter of type CHOICE.
+/**
+ * @brief Gets external parameter of type CHOICE.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_choice_get(Evas_Object *obj, const char *part, const char *state, double value, const char *param, const char **val);
-/** Set the external parameter type and value, adding it if it didn't
+/**
+ * @brief Sets the external parameter type and value, adding it if it didn't
* exist before.
*
* @param obj Object being edited.
-
* @param part Part that contain state.
* @param state The name of the state to get external parameter (not
* including the state value).
*/
EAPI Eina_Bool edje_edit_state_external_param_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, Edje_External_Param_Type type, ...);
-/** Set external parameter of type INT.
+/**
+ * @brief Sets external parameter of type INT.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_int_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, int val);
-/** Set external parameter of type BOOL.
+/**
+ * @brief Sets external parameter of type BOOL.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_bool_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, Eina_Bool val);
-/** Set external parameter of type DOUBLE.
+/**
+ * @brief Sets external parameter of type DOUBLE.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_double_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, double val);
-/** Set external parameter of type STRING.
+/**
+ * @brief Sets external parameter of type STRING.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_string_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, const char *val);
-/** Set external parameter of type CHOICE.
+/**
+ * @brief Sets external parameter of type CHOICE.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_external_param_choice_set(Evas_Object *obj, const char *part, const char *state, double value, const char *param, const char *val);
-/** Set the states step parameter values.
+/**
+ * @brief Sets the states step parameter values.
*
* Step parameter restricts resizing of each dimension to values divisibles by
* its value. This causes the part to jump from value to value while resizing.
*/
EAPI Eina_Bool edje_edit_state_step_set(Evas_Object *obj, const char *part, const char *state, double value, int step_x, int step_y);
-/** Get the states step values.
+/**
+ * @brief Gets the states step values.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_step_get(Evas_Object *obj, const char *part, const char *state, double value, int *step_x, int *step_y);
-/** Set the states limit parameter value.
+/**
+ * @brief Sets the states limit parameter value.
*
* Set limit causes the emission of signals when the the size of part changes
* from zero or to a zero size in corresponding to the limit value.
*/
EAPI Eina_Bool edje_edit_state_limit_set(Evas_Object *obj, const char *part, const char *state, double value, unsigned char limit);
-/** Get the states limit value.
+/**
+ * @brief Gets the states limit value.
*
* Returns value that represents the states limit value:
* <ul>
/******************************************************************************/
/************************** MAP API ************************************/
/******************************************************************************/
-/** @name Map API
- * Functions to deal with objects with rotation properties (see @ref edcref).
+/**
+ * @name Map API
+ * Functions to deal with objects with rotation properties (see @ref edcref).
*/ //@{
-/** Get the flag which enables mapping for the part.
+/**
+ * @brief Gets the flag which enables mapping for the part.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_on_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** This enables mapping for the part. Default is 0.
+/**
+ * @brief Enables mapping for the part. Default is 0.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_on_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool on);
-/** Get the part's name that is used as the 'perspective point'.
+/**
+ * @brief Gets the part's name that is used as the 'perspective point'.
*
* @param obj Object being edited.
* @param part The name of the part.
*/
EAPI const char * edje_edit_state_map_perspective_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the part's name that is used as the 'perspective point'.
+/**
+ * @brief Sets the part's name that is used as the 'perspective point'.
*
* @param obj Object being edited.
* @param part The name of the part.
*/
EAPI Eina_Bool edje_edit_state_map_perspective_set(Evas_Object *obj, const char *part, const char *state, double value, const char *source_part);
-/** Get the part's name that is used as the 'light' for calculating the brightness.
+/**
+ * @brief Gets the part's name that is used as the 'light' for calculating the brightness.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI const char * edje_edit_state_map_light_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the part that is used as the 'light'.
+/**
+ * @brief Sets the part that is used as the 'light'.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_light_set(Evas_Object *obj, const char *part, const char *state, double value, const char *source_part);
-/** Get backface_cull value of given part state.
+/**
+ * @brief Gets backface_cull value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_backface_cull_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set backface_cull value of given part state.
+/**
+ * @brief Sets backface_cull value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_backface_cull_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool backface_cull);
-/** Get perspective_on value of given part state.
+/**
+ * @brief Gets perspective_on value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_perspective_on_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set perspective_on value of given part state.
+/**
+ * @brief Sets perspective_on value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_perspective_on_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool perspective_on);
-/** Get map.alpha value of given part state.
+/**
+ * @brief Gets map.alpha value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_alpha_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set map.alpha value of given part state.
+/**
+ * @brief Sets map.alpha value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_alpha_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool alpha);
-/** Get map.smooth value of given part state.
+/**
+ * @brief Gets map.smooth value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_smooth_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set map.smooth value of given part state.
+/**
+ * @brief Sets map.smooth value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_smooth_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool smooth);
-/** Get map.rotation of given part state.
+/**
+ * @brief Gets map.rotation of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_rotation_get(Evas_Object *obj, const char *part, const char *state, double value, double *x, double *y, double *z);
-/** Set map.rotation of given part state.
+/**
+ * @brief Sets map.rotation of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_rotation_set(Evas_Object *obj, const char *part, const char *state, double value, double x, double y, double z);
-/** Get map.perspective.focal value of given part state.
+/**
+ * @brief Gets map.perspective.focal value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI int edje_edit_state_map_perspective_focal_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set map.perspective.focal value of given part state.
+/**
+ * @brief Sets map.perspective.focal value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_perspective_focal_set(Evas_Object *obj, const char *part, const char *state, double value, int focal);
-/** Get map.perspective.zplane value of given part state.
+/**
+ * @brief Gets map.perspective.zplane value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI int edje_edit_state_map_perspective_zplane_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set map.perspective.zplane value of given part state.
+/**
+ * @brief Sets map.perspective.zplane value of given part state.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_perspective_zplane_set(Evas_Object *obj, const char *part, const char *state, double value, int zplane);
-/** Get the part's name that is used as the center rotation.
+/**
+ * @brief Gets the part's name that is used as the center rotation.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI const char * edje_edit_state_map_rotation_center_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** This sets the part that is used as the center of rotation when rotating the part with this description. If no center is given, the parts original center itself is used for the rotation center.
+/**
+ * @brief Sets the part that is used as the center of rotation when rotating the part with this description. If no center is given, the parts original center itself is used for the rotation center.
*
* @param obj Object being edited.
* @param part The name of the part.
**/
EAPI Eina_Bool edje_edit_state_map_rotation_center_set(Evas_Object *obj, const char *part, const char *state, double value, const char *source_part);
-/** This sets the color for vertex/point of the current part.
+/**
+ * @brief Sets the color for vertex/point of the current part.
* For more detailed information please @see evas_map_point_color_set().
*
* In edje there is (currently) only 4 main point:
**/
EAPI Eina_Bool edje_edit_state_map_point_color_set(Evas_Object *obj, const char *part, const char *state, double value, int idx, int r, int g, int b, int a);
-/** This gets the color of given vertex/point of the current part.
+/**
+ * @brief Gets the color of given vertex/point of the current part.
* For more detailed information please @see evas_map_point_color_set().
*
* In edje there is (currently) only 4 main point:
**/
EAPI Eina_Bool edje_edit_state_map_point_color_get(Evas_Object *obj, const char *part, const char *state, double value, int idx, int *r, int *g, int *b, int *a);
-/** Set the source part for given part state.
+/**
+ * @brief Sets the source part for given part state.
*
* Set another part content as the content of this part.
*
*/
EAPI Eina_Bool edje_edit_state_proxy_source_set(Evas_Object *obj, const char *part, const char *state, double value, const char *source_name);
-/** Get the source name for given state of part.
+/**
+ * @brief Gets the source name for given state of part.
*
* @note The returned string should be freed with @c eina_stringshare_del().
* @param obj Object being edited.
*/
EAPI Eina_Stringshare * edje_edit_state_proxy_source_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the source clip for given PROXY part state.
+/**
+ * @brief Sets the source clip for given PROXY part state.
*
* The source clipper is ignored or used when rendering the proxy part.
*
EAPI Eina_Bool
edje_edit_state_proxy_source_clip_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool clip);
-/** Get the source clip for given PROXY part state.
+/**
+ * @brief Gets the source clip for given PROXY part state.
*
* The source clipper is ignored or used when rendering the proxy part.
*
EAPI Eina_Bool
edje_edit_state_proxy_source_clip_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the source visibility for given PROXY part state.
+/**
+ * @brief Sets the source visibility for given PROXY part state.
*
* Defines if both the proxy and its source object will be visible or not.
* In case of false flag, the source object will not be visible at all while
EAPI Eina_Bool
edje_edit_state_proxy_source_visible_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool visibility);
-/** Get the source visibility for given PROXY part state.
+/**
+ * @brief Gets the source visibility for given PROXY part state.
*
* Defines if both the proxy and its source object will be visible or not.
* In case of false flag, the source object will not be visible at all while
/******************************************************************************/
/************************** TEXT API ************************************/
/******************************************************************************/
-/** @name Text API
- * Functions to deal with text objects (see @ref edcref).
+/**
+ * @name Text API
+ * Functions to deal with text objects (see @ref edcref).
*/ //@{
-/** Get the text of a part state.
+/**
+ * @brief Gets the text of a part state.
*
* Remember to free the returned string with edje_edit_string_free().
*
*/
EAPI const char * edje_edit_state_text_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the text of a part state.
+/**
+ * @brief Sets the text of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_set(Evas_Object *obj, const char *part, const char *state, double value,const char *text);
-/** Get font name for a given part state.
+/**
+ * @brief Gets font name for a given part state.
*
* Remember to free the returned string using edje_edit_string_free().
*
*/
EAPI const char * edje_edit_state_font_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set font name for a given part state.
+/**
+ * @brief Sets font name for a given part state.
*
* Font name can be any alias of an internal font in the Edje file and,
* if it doesn't match any, Edje will look for a font with the given name
*/
EAPI Eina_Bool edje_edit_state_font_set(Evas_Object *obj, const char *part, const char *state, double value, const char *font);
-/** Get the text size of a part state
+/**
+ * @brief Gets the text size of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to get text size (not including the state value).
* @param value The state value.
*
- * @return The text size or -1 on errors.
+ * @return The text size or @c -1 on errors.
*/
EAPI int edje_edit_state_text_size_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the text size of a part state.
+/**
+ * @brief Sets the text size of a part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_size_set(Evas_Object *obj, const char *part, const char *state, double value, int size);
-/** Get the text horizontal align of a part state.
+/**
+ * @brief Gets the text horizontal align of a part state.
*
* The value range is from 0.0(right) to 1.0(left)
* If the value is between -1.0 and 0.0 then it uses align automatically.
* @param state The name of the state to get the text horizontal align (not including the state value).
* @param value The state value.
*
- * @return The text horizont align value
+ * @return The text horizontal align value
*/
EAPI double edje_edit_state_text_align_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get the text vertical align of a part state.
+/**
+ * @brief Gets the text vertical align of a part state.
*
* The value range is from 0.0(top) to 1.0(bottom)
*
* @param state The name of the state to get the text vertical align (not including the state value).
* @param value The state value.
*
- * @return The text horizont align value
+ * @return The text horizontal align value
*/
EAPI double edje_edit_state_text_align_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the text horizontal align of a part state.
+/**
+ * @brief Sets the text horizontal align of a part state.
*
* The value range is from 0.0(right) to 1.0(left)
* If the value is between -1.0 and 0.0 then it uses align automatically.
*/
EAPI Eina_Bool edje_edit_state_text_align_x_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
-/** Set the text vertical align of a part state.
+/**
+ * @brief Sets the text vertical align of a part state.
*
* The value range is from 0.0(top) to 1.0(bottom)
*
*/
EAPI Eina_Bool edje_edit_state_text_align_y_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
-/** Get the text elipsis of a part state.
+/**
+ * @brief Gets the text elipsis of a part state.
*
* The value range is from 0.0(right) to 1.0(left), and -1.0 (if disabled)
*
* @param obj Object being edited.
* @param part Part that contain state.
- * @param state The name of the state to get the text elipses value (not including the state value).
+ * @param state The name of the state to get the text elipsis value (not including the state value).
* @param value The state value.
*
* @return The text elipsis value
*/
EAPI double edje_edit_state_text_elipsis_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the text vertical align of a part state.
+/**
+ * @brief Sets the text vertical align of a part state.
*
* The value range is from 0.0(right) to 1.0(left)
* If the value is in range from -1.0 to 0.0 then ellipsis is disabled.
*
* @param obj Object being edited.
* @param part Part that contain state.
- * @param state The name of the state to set the text elipses value (not including the state value).
+ * @param state The name of the state to set the text elipsis value (not including the state value).
* @param value The state value.
* @param balance The position where to cut the string
*
*/
EAPI Eina_Bool edje_edit_state_text_elipsis_set(Evas_Object *obj, const char *part, const char *state, double value, double balance);
-/** Get if the text part fit it's container horizontally
+/**
+ * @brief Gets if the text part fit it's container horizontally.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_fit_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set if the text part should fit it's container horizontally
+/**
+ * @brief Sets if the text part should fit it's container horizontally.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the if the text part fit it's container horizontally (not including the state value).
* @param value The state value.
- * @param fit EINA_TRUE to make the text fit it's container horizontally, @c EINA_FALSE otherwise.
+ * @param fit @c EINA_TRUE to make the text fit it's container horizontally, @c EINA_FALSE otherwise.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_fit_x_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool fit);
-/** Get if the text part fit it's container vertically
+/**
+ * @brief Gets if the text part fit it's container vertically.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_fit_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set if the text part should fit it's container vertically
+/**
+ * @brief Sets if the text part should fit it's container vertically.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the if the text part fit it's container vertically (not including the state value).
* @param value The state value.
- * @param fit EINA_TRUE to make the text fit it's container vertically, @c EINA_FALSE otherwise.
+ * @param fit @c EINA_TRUE to make the text fit it's container vertically, @c EINA_FALSE otherwise.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_fit_y_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool fit);
-/** Get if the text part forces the minimum horizontal size of the container to be equal to the minimum horizontal size of the text part
+/**
+ * @brief Gets if the text part forces the minimum horizontal size of the container to be equal to the minimum horizontal size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_min_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get if the text part forces the maximum horizontal size of the container to be equal to the maximum horizontal size of the text part
+/**
+ * @brief Gets if the text part forces the maximum horizontal size of the container to be equal to the maximum horizontal size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_max_x_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get if the text part forces the minimum vertical size of the container to be equal to the minimum vertical size of the text part
+/**
+ * @brief Gets if the text part forces the minimum vertical size of the container to be equal to the minimum vertical size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_min_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Get if the text part forces the maximum vertical size of the container to be equal to the maximum vertical size of the text part
+/**
+ * @brief Gets if the text part forces the maximum vertical size of the container to be equal to the maximum vertical size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_max_y_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set if the text part forces the minimum horizontal size of the container to be equal to the minimum horizontal size of the text part
+/**
+ * @brief Sets if the text part forces the minimum horizontal size of the container to be equal to the minimum horizontal size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the the minimum horizontal size of the container to be equal (not including the state value).
* @param value The state value.
- * @param v EINA_TRUE to make the text force it's forces container's minimum horizontal size, @c EINA_FALSE otherwise.
+ * @param v @c EINA_TRUE to make the text force it's forces container's minimum horizontal size, @c EINA_FALSE otherwise.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_min_x_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool v);
-/** Set if the text part forces the maximum horizontal size of the container to be equal to the maximum horizontal size of the text part
+/**
+ * @brief Sets if the text part forces the maximum horizontal size of the container to be equal to the maximum horizontal size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the the maximum horizontal size of the container to be equal (not including the state value).
* @param value The state value.
- * @param v EINA_TRUE to make the text force it's forces container's maximum horizontal size, @c EINA_FALSE otherwise.
+ * @param v @c EINA_TRUE to make the text force it's forces container's maximum horizontal size, @c EINA_FALSE otherwise.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_max_x_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool v);
-/** Set if the text part forces the minimum vertical size of the container to be equal to the minimum vertical size of the text part
+/**
+ * @brief Sets if the text part forces the minimum vertical size of the container to be equal to the minimum vertical size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the the minimum vertical size of the container to be equal (not including the state value).
* @param value The state value.
- * @param v EINA_TRUE to make the text force it's forces container's minimum vertical size, @c EINA_FALSE otherwise.
+ * @param v @c EINA_TRUE to make the text force it's forces container's minimum vertical size, @c EINA_FALSE otherwise.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_min_y_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool v);
-/** Set if the text part forces the maximum vertical size of the container to be equal to the maximum vertical size of the text part
+/**
+ * @brief Sets if the text part forces the maximum vertical size of the container to be equal to the maximum vertical size of the text part
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the the maximum vertical size of the container to be equal (not including the state value).
* @param value The state value.
- * @param v EINA_TRUE to make the text force it's forces container's maximum vertical size, @c EINA_FALSE otherwise.
+ * @param v @c EINA_TRUE to make the text force it's forces container's maximum vertical size, @c EINA_FALSE otherwise.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_max_y_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool v);
-/** Get style name for a given part state.
+/**
+ * @brief Gets style name for a given part state.
*
* @param obj Object being edited.
* @param part The name of the part to get the style of.
* @param state The state of the part to get the style of.
* @param value Value of the state.
*
- * @return Style used by the part or NULL if error or nothing is set.
+ * @return Style used by the part, or NULL if error or nothing is set.
*/
EAPI const char * edje_edit_state_text_style_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set style name for a given part state.
+/**
+ * @brief Sets style name for a given part state.
*
* Causes the part to use the default style and tags defined in the "style" block with the specified name.
*
*/
EAPI Eina_Bool edje_edit_state_text_style_set(Evas_Object *obj, const char *part, const char *state, double value, const char *style);
-/** Get part name, which used as text source.
+/**
+ * @brief Gets part name, which used as text source.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI const char * edje_edit_state_text_text_source_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the source text part for a given part.
+/**
+ * @brief Sets the source text part for a given part.
* Causes the part to display the content text of another part and update
* them as they change.
*
*/
EAPI Eina_Bool edje_edit_state_text_text_source_set(Evas_Object *obj, const char *part, const char *state, double value, const char *source);
-/** Get part name, which used as style text source.
+/**
+ * @brief Gets part name, which used as style text source.
*
* @param obj Object being edited.
* @param part Part that contain state.
* @param state The name of the state to set the the maximum vertical size of
* @param value Value of the state.
- * the container to be equal (not including the state value).
+ * The container to be equal (not including the state value).
*
* @return The name of part or NULL, if text_source param not a setted.
*/
EAPI const char * edje_edit_state_text_source_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the source part which would be used as style for text for a given part.
+/**
+ * @brief Sets the source part which would be used as style for text for a given part.
* Causes the part to use the text properties (like font and size) of another
* part and update them as they change.
*
*/
EAPI Eina_Bool edje_edit_state_text_source_set(Evas_Object *obj, const char *part, const char *state, double value, const char *source);
-/** Get the text class of the given part state.
+/**
+ * @brief Gets the text class of the given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI const char * edje_edit_state_text_class_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the text class of the given part state.
+/**
+ * @brief Sets the text class of the given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_class_set(Evas_Object *obj, const char *part, const char *state, double value, const char *text_class);
-/** Get the replacement character string of the given part state.
+/**
+ * @brief Gets the replacement character string of the given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI const char * edje_edit_state_text_repch_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the replacement character string of the given part state.
+/**
+ * @brief Sets the replacement character string of the given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_repch_set(Evas_Object *obj, const char *part, const char *state, double value, const char *repch);
-/** Get the min and max font size allowed for the text part.
+/**
+ * @brief Gets the min and max font size allowed for the text part.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_size_range_min_max_get(Evas_Object *obj, const char *part, const char *state, double value, int *min, int *max);
-/** Set the min and max font size allowed for the text part.
+/**
+ * @brief Sets the min and max font size allowed for the text part.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_text_size_range_min_max_set(Evas_Object *obj, const char *part, const char *state, double value, int min, int max);
-/** Get the list of all the fonts in the given edje.
+/**
+ * @brief Gets the list of all the fonts in the given edje.
*
* Use edje_edit_string_list_free() when you don't need the list anymore.
*
*/
EAPI Eina_List * edje_edit_fonts_list_get(Evas_Object *obj);
-/** Add a new font to the edje file.
+/**
+ * @brief Adds a new font to the edje file.
*
* The newly created font will be available to all the groups in the edje, not only the current one.
*
*/
EAPI Eina_Bool edje_edit_font_add(Evas_Object *obj, const char *path, const char* alias);
-/** Delete font from the edje file.
+/**
+ * @brief Deletes font from the edje file.
*
* The font will be removed from all the groups in the edje, not only the current one.
*
*/
EAPI Eina_Bool edje_edit_font_del(Evas_Object *obj, const char* alias);
-/** Get font path for a given font alias.
+/**
+ * @brief Gets font path for a given font alias.
*
* Remember to free the string with edje_edit_string_free()
*
/******************************************************************************/
/************************ IMAGE SET API ***********************************/
/******************************************************************************/
-/** @name Image Set API
- * Functions to deal with image objects (see @ref edcref).
+/**
+ * @name Image Set API
+ * Functions to deal with image objects (see @ref edcref).
*/ //@{
-/** Check if given image name is set of images or not.
+/**
+ * @brief Checks if given image name is set of images or not.
*
* @param obj Object being edited.
* @param image a name to check if it is set or not.
EAPI Eina_Bool
edje_edit_image_set_exists(Evas_Object *obj, const char *image);
-/** Get id of image set.
+/**
+ * @brief Gets id of image set.
*
* @param obj Object being edited.
* @param name image set's name.
EAPI int
edje_edit_image_set_id_get(Evas_Object *obj, const char *name);
-/** Rename image set.
+/**
+ * @brief Renames image set.
*
* @param obj Object being edited.
* @param set image set's name.
EAPI Eina_Bool
edje_edit_image_set_rename(Evas_Object *obj, const char *set, const char *new_set);
-/** Get the list of all the image sets in the given edje.
+/**
+ * @brief Gets the list of all the image sets in the given edje.
* Use edje_edit_string_list_free() when you don't need the list anymore.
*
* @param obj Object being edited.
EAPI Eina_List *
edje_edit_image_set_list_get(Evas_Object *obj);
-/** Get list of (Edje_Part_Image_Use *) - group-part-state triplets where given
+/**
+ * @brief Gets list of (Edje_Part_Image_Use *) - group-part-state triplets where given
* set is used
*
* Use edje_edit_image_usage_list_free() when you don't need it anymore.
*
* @param obj Object being edited.
* @param name The name of the image.
- * @param first_only If EINA_TRUE, return only one triplete.
+ * @param first_only If @c EINA_TRUE, return only one triplete.
*
* @return Eina_List containing Edje_Part_Image_Use if successful, NULL otherwise
*/
EAPI Eina_List*
edje_edit_set_usage_list_get(Evas_Object *obj, const char *name, Eina_Bool first_only);
-/** Add new image set.
+/**
+ * @brief Adds new image set.
*
* @param obj Object being edited.
* @param name image set's name.
EAPI Eina_Bool
edje_edit_image_set_add(Evas_Object *obj, const char *name);
-/** Delete image set.
+/**
+ * @brief Deletes image set.
*
* Can't delete set if it is used by any part.
*
EAPI Eina_Bool
edje_edit_image_set_del(Evas_Object *obj, const char *name);
-/** Get the list of all images inside of given set in the given edje.
+/**
+ * @brief Gets the list of all images inside of given set in the given edje.
* Use edje_edit_string_list_free() when you don't need the list anymore.
*
* @param obj Object being edited.
EAPI Eina_List *
edje_edit_image_set_images_list_get(Evas_Object *obj, const char *name);
-/** Add image to set.
+/**
+ * @brief Adds image to set.
*
* Add image to given set. If image is not exist inside of edje
* collection then function @see edje_edit_image_add should be
EAPI Eina_Bool
edje_edit_image_set_image_add(Evas_Object *obj, const char *set_name, const char *name);
-/** Delete image on current position from set.
+/**
+ * @brief Deletes image on current position from set.
*
* Remove image from given set. To be sure what kind of image will be
* deleted, firstly check it's position via
EAPI Eina_Bool
edje_edit_image_set_image_del(Evas_Object *obj, const char *set_name, unsigned int place);
-/** Get min size of set's image.
+/**
+ * @brief Gets min size of set's image.
*
* @param obj Object being edited.
* @param set_name name of image set.
EAPI Eina_Bool
edje_edit_image_set_image_min_get(Evas_Object *obj, const char *set_name, unsigned int place, int *w, int *h);
-/** Set min size of set's image.
+/**
+ * @brief Sets min size of set's image.
*
* @param obj Object being edited.
* @param set_name name of image set.
EAPI Eina_Bool
edje_edit_image_set_image_min_set(Evas_Object *obj, const char *set_name, unsigned int place, int w, int h);
-/** Get max size of set's image.
+/**
+ * @brief Gets max size of set's image.
*
* @param obj Object being edited.
* @param set_name name of image set.
EAPI Eina_Bool
edje_edit_image_set_image_max_get(Evas_Object *obj, const char *set_name, unsigned int place, int *w, int *h);
-/** Set max size of set's image.
+/**
+ * @brief Sets max size of set's image.
*
* @param obj Object being edited.
* @param set_name name of image set.
EAPI Eina_Bool
edje_edit_image_set_image_max_set(Evas_Object *obj, const char *set_name, unsigned int place, int w, int h);
-/** Get border of set's image.
+/**
+ * @brief Gets border of set's image.
*
* @param obj Object being edited.
* @param set_name name of image set.
EAPI Eina_Bool
edje_edit_image_set_image_border_get(Evas_Object *obj, const char *set_name, unsigned int place, int *l, int *r, int *b, int *t);
-/** Set border of set's image.
+/**
+ * @brief Sets border of set's image.
*
* @param obj Object being edited.
* @param set_name name of image set.
EAPI Eina_Bool
edje_edit_image_set_image_border_set(Evas_Object *obj, const char *set_name, unsigned int place, int l, int r, int b, int t);
-/** Get border scale of set's image.
+/**
+ * @brief Gets border scale of set's image.
*
* @param obj Object being edited.
* @param set_name name of image set.
EAPI double
edje_edit_image_set_image_border_scale_get(Evas_Object *obj, const char *set_name, unsigned int place);
-/** Set border scale of set's image.
+/**
+ * @brief Sets border scale of set's image.
*
* @param obj Object being edited.
* @param set_name name of image set.
/******************************************************************************/
/************************** IMAGES API ************************************/
/******************************************************************************/
-/** @name Images API
- * Functions to deal with image objects (see @ref edcref).
+/**
+ * @name Images API
+ * Functions to deal with image objects (see @ref edcref).
*/ //@{
-/** Get the list of all the images in the given edje.
+/**
+ * @brief Gets the list of all the images in the given edje.
* Use edje_edit_string_list_free() when you don't need the list anymore.
*
* @param obj Object being edited.
*/
EAPI Eina_List * edje_edit_images_list_get(Evas_Object *obj);
-/** Add an new image to the image collection
+/**
+ * @brief Adds an new image to the image collection
*
* This function add the given image inside the edje. Don't add a new image part
* but only put the image inside the edje file. It actually write directly to
*/
EAPI Eina_Bool edje_edit_image_add(Evas_Object *obj, const char *path);
-/** Delete an image from the image collection
+/**
+ * @brief Deletes an image from the image collection
*
* It actually write directly to the file so you don't have to save.
* Can't delete image if it is used by any part.
*/
EAPI Eina_Bool edje_edit_image_del(Evas_Object *obj, const char *name);
-/** Replace one image in all descriptions
+/**
+ * @brief Replaces one image in all descriptions.
*
* @param obj Object being edited.
* @param name The name of the image to replace.
*/
EAPI Eina_Bool edje_edit_image_replace(Evas_Object *obj, const char *name, const char *new_name);
-/** Rename image
+/**
+ * @brief Renames image.
*
* @param obj Object being edited.
* @param name The name of the image to be renamed.
*/
EAPI Eina_Bool edje_edit_image_rename(Evas_Object *obj, const char *name, const char *new_name);
-/** Get list of (Edje_Part_Image_Use *) - group-part-state triplets where given
+/**
+ * @brief Gets list of (Edje_Part_Image_Use *) - group-part-state triplets where given
* image is used.
*
* Important! Image can also be used inside of set and plenty of times, so for each use
*
* @param obj Object being edited.
* @param name The name of the image.
- * @param first_only If EINA_TRUE, return only one triplete.
+ * @param first_only If @c EINA_TRUE, return only one triplet.
*
* @return Eina_List containing Edje_Part_Image_Use if successful, NULL otherwise
*/
EAPI Eina_List* edje_edit_image_usage_list_get(Evas_Object *obj, const char *name, Eina_Bool first_only);
-/** Free an Eina_List of (Edje_Part_Image_Use *) allocated by an edje_edit_image_usage_list_get() function.
+/**
+ * @brief Frees an Eina_List of (Edje_Part_Image_Use *) allocated by an edje_edit_image_usage_list_get() function.
*
* @param lst List of strings to free.
*/
EAPI void edje_edit_image_usage_list_free(Eina_List *lst);
-/** Add an image entry to the image collection
+/**
+ * @brief Adds an image entry to the image collection.
*
* This function adds the given image entry to the edje image collection. The
* image needs to be inside the eet already, with key name "images/id". After
*/
EAPI Eina_Bool edje_edit_image_data_add(Evas_Object *obj, const char *name, int id);
-/** Get normal image name for a given part state.
+/**
+ * @brief Gets normal image name for a given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI const char * edje_edit_state_image_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set normal image for a given part state.
+/**
+ * @brief Sets normal image for a given part state.
*
* @param obj Object being edited.
* @param part Part that contain state.
*/
EAPI Eina_Bool edje_edit_state_image_set(Evas_Object *obj, const char *part, const char *state, double value, const char *image);
-/** Get image id for a given image name.
+/**
+ * @brief Gets image id for a given image name.
*
* @param obj Object being edited.
* @param image_name The image name.
*/
EAPI int edje_edit_image_id_get(Evas_Object *obj, const char *image_name);
-/** Get compression type for the given image.
+/**
+ * @brief Gets compression type for the given image.
*
* @param obj Object being edited.
* @param image The name of the image.
*/
EAPI Edje_Edit_Image_Comp edje_edit_image_compression_type_get(Evas_Object *obj, const char *image);
-/** Set compression type for the given image.
+/**
+ * @brief Sets compression type for the given image.
*
* @param obj Object being edited.
* @param image The name of the image.
*/
EAPI Eina_Bool edje_edit_image_compression_type_set(Evas_Object *obj, const char *image, Edje_Edit_Image_Comp ic);
-/** Get compression rate for the given image.
+/**
+ * @brief Gets compression rate for the given image.
*
* @param obj Object being edited.
* @param image The name of the image.
*/
EAPI int edje_edit_image_compression_rate_get(Evas_Object *obj, const char *image);
-/** Get the image border of a part state.
+/**
+ * @brief Gets the image border of a part state.
*
* Pass NULL to any of [r,g,b,a] to get only the others.
*
*/
EAPI void edje_edit_state_image_border_get(Evas_Object *obj, const char *part, const char *state, double value, int *l, int *r, int *t, int *b);
-/** Set the image border of a part state.
+/**
+ * @brief Sets the image border of a part state.
*
* Pass -1 to any of [l,r,t,b] to leave the value untouched.
*
*/
EAPI Eina_Bool edje_edit_state_image_border_set(Evas_Object *obj, const char *part, const char *state, double value, int l, int r, int t, int b);
-/** Get the border scale value of a part state.
+/**
+ * @brief Gets the border scale value of a part state.
*
* This value tells Edje if the border should be scaled by
* the object/global edje scale factors
EAPI Eina_Bool
edje_edit_state_image_border_scale_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the border scale value of a part state.
+/**
+ * @brief Sets the border scale value of a part state.
*
* This value tells Edje if the border should be scaled by
* the object/global edje scale factors
EAPI Eina_Bool
edje_edit_state_image_border_scale_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool scale);
-/** Get the border scale by value of a part state.
+/**
+ * @brief Gets the border scale by value of a part state.
*
* Valid values are: 0.0 or bigger (0.0 or 1.0 to turn it off)
*
EAPI double
edje_edit_state_image_border_scale_by_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set the border scale by value of a part state.
+/**
+ * @brief Sets the border scale by value of a part state.
*
* Valid values are: 0.0 or bigger (0.0 or 1.0 to turn it off)
*
EAPI Eina_Bool
edje_edit_state_image_border_scale_by_set(Evas_Object *obj, const char *part, const char *state, double value, double scale);
-/** Get if the image center should be draw.
+/**
+ * @brief Gets if the image center should be draw.
*
* 1 or 2 means to draw the center, 0 to don't draw it.
* If 1 - then the center will apply alpha channel.
* @param state The name of the state to get the image border fill (not including the state value).
* @param value The state value.
*
- * @return 2 if the center of the bordered image is draw without alpha, 1 dawing with alpha and 0 not drawing the center.
+ * @return @c 2 if the center of the bordered image is draw without alpha, @c 1 drawing with alpha and @c 0 not drawing the center.
*/
EAPI unsigned char edje_edit_state_image_border_fill_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Set if the image center should be draw.
+/**
+ * @brief Sets if the image center should be draw.
*
* 1 or 2 means to draw the center, 0 to don't draw it.
* If 1 - then the center will apply alpha channel.
*/
EAPI Eina_Bool edje_edit_state_image_border_fill_set(Evas_Object *obj, const char *part, const char *state, double value, unsigned char fill);
-/** Get the list of all the tweens images in the given part state.
+/**
+ * @brief Gets the list of all the tweens images in the given part state.
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*
*/
EAPI Eina_List * edje_edit_state_tweens_list_get(Evas_Object *obj, const char *part, const char *state, double value);
-/** Add a new tween frame to the given part state.
+/**
+ * @brief Adds a new tween frame to the given part state.
*
* The tween param must be the name of an existing image.
*
*/
EAPI Eina_Bool edje_edit_state_tween_add(Evas_Object *obj, const char *part, const char *state, double value, const char *tween);
-/** Insert a new tween frame to the given part state into a specific place.
+/**
+ * @brief Inserts a new tween frame to the given part state into a specific place.
*
* The tween param must be the name of an existing image.
*
EAPI Eina_Bool
edje_edit_state_tween_insert_at(Evas_Object *obj, const char *part, const char *state, double value, const char *tween, int place);
-/** Remove the first tween with the given name.
+/**
+ * @brief Removes the first tween with the given name.
*
* The image is not removed from the edje.
*
* @param obj Object being edited.
* @param part Part that contain state.
- * @param state The name of the state to del the tween (not including the state value).
+ * @param state The name of the state to delete the tween (not including the state value).
* @param value The state value.
- * @param tween The name of the image to del.
+ * @param tween The name of the image to delete.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
/******************************************************************************/
/************************** SOUNDS API ************************************/
/******************************************************************************/
-/** @name Sounds API
- * Functions to deal with sound objects (see @ref edcref).
+/**
+ * @name Sounds API
+ * Functions to deal with sound objects (see @ref edcref).
*/ //@{
-/** Get the list of all the sounds samples in the given edje.
+/**
+ * @brief Gets the list of all the sounds samples in the given edje.
* Use edje_edit_string_list_free() when you don't need the list anymore.
*
* @param obj Object being edited.
*/
EAPI Eina_List * edje_edit_sound_samples_list_get(Evas_Object *obj);
-/** Get the list of all the sounds tones in the given edje.
+/**
+ * @brief Gets the list of all the sounds tones in the given edje.
* Use edje_edit_string_list_free() when you don't need the list anymore.
*
* @param obj Object being edited.
*/
EAPI Eina_List * edje_edit_sound_tones_list_get(Evas_Object *obj);
-/** Add new sound sample to samples collection
+/**
+ * @brief Adds new sound sample to samples collection.
*
* This function adds the given sound file to the edje collection.
* The added sound sample could be used by PLAY_SAMPLE action in any program
*/
EAPI Eina_Bool edje_edit_sound_sample_add(Evas_Object *obj, const char* name, const char* snd_src);
-/** Delete sound sample from the collection
+/**
+ * @brief Deletes sound sample from the collection.
*
* Deletes sound sample from collection by its name. After successful deletion
* all PLAY_SAMPLE actions in all programs of all groups of current collection
*/
EAPI Eina_Bool edje_edit_sound_sample_del(Evas_Object *obj, const char *name);
-/** Add new tone to the collection
+/**
+ * @brief Adds new tone to the collection.
*
* This function adds new tone with given frequency to the edje collection.
* The added sound sample could be used by PLAY_TONE action in any program
*/
EAPI Eina_Bool edje_edit_sound_tone_add(Evas_Object *obj, const char* name, int frequency);
-/** Delete tone from the collection
+/**
+ * @brief Deletes tone from the collection.
*
* Deletes tone from collection by its name. After successful deletion
* all PLAY_TONE actions in all programs of all groups of current collection
*/
EAPI Eina_Bool edje_edit_sound_tone_del(Evas_Object *obj, const char* name);
-/** Get the sound quality compression.
+/**
+ * @brief Gets the sound quality compression.
*
* @param obj Object being edited.
* @param sound The name of the sample.
*/
EAPI double edje_edit_sound_compression_rate_get(Evas_Object *obj, const char* sound);
-/** Set the sound quality compression.
+/**
+ * @brief Sets the sound quality compression.
*
* @param obj Object being edited.
* @param sound The name of the sample.
*/
EAPI Eina_Bool edje_edit_sound_compression_rate_set(Evas_Object *obj, const char* sound, double rate);
-/** Set the frequency of tone.
+/**
+ * @brief Sets the frequency of tone.
*
* @param obj Object being edited.
* @param name The name of the tone.
*/
EAPI Eina_Bool edje_edit_sound_tone_frequency_set(Evas_Object *obj, const char *name, int frequency);
-/** Get the frequency of tone.
+/**
+ * @brief Gets the frequency of tone.
*
* @param obj Object being edited.
* @param name The name of the tone.
*/
EAPI int edje_edit_sound_tone_frequency_get(Evas_Object *obj, const char *name);
-/** Get the sound type compression.
+/**
+ * @brief Gets the sound type compression.
*
* @param obj Object being edited.
* @param name The name of the sample.
*/
EAPI Edje_Edit_Sound_Comp edje_edit_sound_compression_type_get(Evas_Object *obj, const char* name);
-/** Set the sound type compression.
+/**
+ * @brief Sets the sound type compression.
*
* @param obj Object being edited.
* @param name The name of the sample.
*/
EAPI Eina_Bool edje_edit_sound_compression_type_set(Evas_Object *obj, const char* name, Edje_Edit_Sound_Comp sc);
-/** Get the certain sound data from the edje object.
+/**
+ * @brief Gets the certain sound data from the edje object.
*
* @param obj Object being edited.
* @param sample_name The name of the sound.
*/
EAPI Eina_Binbuf *edje_edit_sound_samplebuffer_get(Evas_Object *obj, const char *sample_name);
-/** Get the name of sample source.
+/**
+ * @brief Gets the name of sample source.
*
* @param obj Object being edited.
* @param sample_name The name of the sample.
/******************************************************************************/
/************************* SPECTRUM API ***********************************/
/******************************************************************************/
-/** @name Spectrum API
- * Functions to manage spectrum (see @ref edcref).
+/**
+ * @name Spectrum API
+ * Functions to manage spectrum (see @ref edcref).
*/ //@{
-/** Get the list of all the spectrum in the given edje object.
+/**
+ * @brief Gets the list of all the spectrum in the given edje object.
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*
*/
EAPI Eina_List * edje_edit_spectrum_list_get(Evas_Object *obj);
-/** Add a new spectra in the given edje object.
+/**
+ * @brief Adds a new spectra in the given edje object.
*
* @param obj Object being edited.
* @param name The name of the spectra to include in the edje.
*/
EAPI Eina_Bool edje_edit_spectra_add(Evas_Object *obj, const char *name);
-/** Delete the given spectra from the edje object.
+/**
+ * @brief Deletes the given spectra from the edje object.
*
* @param obj Object being edited.
* @param spectra The name of the spectra to delete.
*/
EAPI Eina_Bool edje_edit_spectra_del(Evas_Object *obj, const char *spectra);
-/** Change the name of the given spectra.
+/**
+ * @brief Changes the name of the given spectra.
*
* @param obj Object being edited.
* @param spectra The name of the current spectra.
*/
EAPI Eina_Bool edje_edit_spectra_name_set(Evas_Object *obj, const char *spectra, const char *name);
-/** Get the number of stops in the given spectra.
+/**
+ * @brief Gets the number of stops in the given spectra.
*
* @param obj Object being edited.
* @param spectra The name of the spectra.
*/
EAPI int edje_edit_spectra_stop_num_get(Evas_Object *obj, const char *spectra);
-/** Set the number of stops in the given spectra.
+/**
+ * @brief Sets the number of stops in the given spectra.
*
* @param obj Object being edited.
* @param spectra The name of the spectra.
*/
EAPI Eina_Bool edje_edit_spectra_stop_num_set(Evas_Object *obj, const char *spectra, int num);
-/** Get the colors of the given stop.
+/**
+ * @brief Gets the colors of the given stop.
*
* @param obj Object being edited.
* @param spectra The name of the spectra.
*/
EAPI Eina_Bool edje_edit_spectra_stop_color_get(Evas_Object *obj, const char *spectra, int stop_number, int *r, int *g, int *b, int *a, int *d);
-/** Set the colors of the given stop.
+/**
+ * @brief Sets the colors of the given stop.
*
* @param obj Object being edited.
* @param spectra The name of the spectra.
/******************************************************************************/
/************************* PROGRAMS API ***********************************/
/******************************************************************************/
-/** @name Programs API
- * Functions to deal with programs (see @ref edcref).
+/**
+ * @name Programs API
+ * Functions to deal with programs (see @ref edcref).
*/ //@{
-/** Get the list of all the programs in the given edje object.
+/**
+ * @brief Gets the list of all the programs in the given edje object.
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*
*/
EAPI Eina_List * edje_edit_programs_list_get(Evas_Object *obj);
-/** Add a new program to the edje file
+/**
+ * @brief Adds a new program to the edje file
*
* If a program with the same name just exist the function will fail.
*
*/
EAPI Eina_Bool edje_edit_program_add(Evas_Object *obj, const char *name);
-/** Remove the given program from the edje file.
+/**
+ * @brief Removes the given program from the edje file.
*
* @param obj Object being edited.
* @param prog The name of the program to remove.
*/
EAPI Eina_Bool edje_edit_program_del(Evas_Object *obj, const char *prog);
-/** Check if a program with the given name exist in the edje object.
+/**
+ * @brief Checks if a program with the given name exist in the edje object.
*
* @param obj Object being edited.
* @param prog The prog of the program that will be searched.
*/
EAPI Eina_Bool edje_edit_program_exist(Evas_Object *obj, const char *prog);
-/** Run the given program.
+/**
+ * @brief Runs the given program.
*
* @param obj Object being edited.
* @param prog The name of the program to execute.
*/
EAPI Eina_Bool edje_edit_program_run(Evas_Object *obj, const char *prog);
-/** Stop all running programs.
+/**
+ * @brief Stops all running programs.
*
* @param obj Object being edited.
*
*/
EAPI Eina_Bool edje_edit_program_stop_all(Evas_Object *obj);
-/** Set parts into intermediate state of programs transition.
+/**
+ * @brief Sets parts into intermediate state of programs transition.
*
* @param obj Object being edited.
* @param prog The name of the program to use. Program should have action STATE_SET.
*/
EAPI Eina_Bool edje_edit_program_transition_state_set(Evas_Object *obj, const char *prog, double pos);
-/** Set a new name for the given program
+/**
+ * @brief Sets a new name for the given program.
*
* @param obj Object being edited.
* @param prog The current program name.
*/
EAPI Eina_Bool edje_edit_program_name_set(Evas_Object *obj, const char *prog, const char *new_name);
-/** Get source of a given program.
+/**
+ * @brief Gets source of a given program.
*
* Remember to free the returned string using edje_edit_string_free().
*
* @param obj Object being edited.
* @param prog The name of the program to get source.
*
- * @return The source value por program.
+ * @return The source value per program.
*/
EAPI const char * edje_edit_program_source_get(Evas_Object *obj, const char *prog);
-/** Set source of the given program.
+/**
+ * @brief Sets source of the given program.
*
* @param obj Object being edited.
* @param prog The name of the program to set source.
*/
EAPI Eina_Bool edje_edit_program_source_set(Evas_Object *obj, const char *prog, const char *source);
-/** Get signal of a given program.
+/**
+ * @brief Gets signal of a given program.
*
* Remember to free the returned string using edje_edit_string_free().
*
*/
EAPI const char * edje_edit_program_signal_get(Evas_Object *obj, const char *prog);
-/** Set signal of the given program.
+/**
+ * @brief Sets signal of the given program.
*
* @param obj Object being edited.
* @param prog The name of the program to set the signal.
*/
EAPI Eina_Bool edje_edit_program_signal_set(Evas_Object *obj, const char *prog, const char *signal);
-/** Get in.from of a given program.
+/**
+ * @brief Gets in.from of a given program.
*
* @param obj Object being edited.
* @param prog The name of the program to get the delay.
*/
EAPI double edje_edit_program_in_from_get(Evas_Object *obj, const char *prog);
-/** Set in.from of a given program.
+/**
+ * @brief Sets in.from of a given program.
*
* @param obj Object being edited.
* @param prog The name of the program to set the delay.
*/
EAPI Eina_Bool edje_edit_program_in_from_set(Evas_Object *obj, const char *prog, double seconds);
-/** Get in.range of a given program.
+/**
+ * @brief Gets in.range of a given program.
*
* @param obj Object being edited.
* @param prog The name of the program to get random delay.
*/
EAPI double edje_edit_program_in_range_get(Evas_Object *obj, const char *prog);
-/** Set in.range of a given program.
+/**
+ * @brief Sets in.range of a given program.
*
* @param obj Object being edited.
* @param prog The name of the program to set random delay.
*/
EAPI Eina_Bool edje_edit_program_in_range_set(Evas_Object *obj, const char *prog, double seconds);
-/** Get the action of a given program.
+/**
+ * @brief Gets the action of a given program.
*
* @param obj Object being edited.
* @param prog The name of the program to get the action.
*
- * @return The action type, or -1 on errors.
+ * @return The action type, or @c -1 on errors.
* Action can be one of EDJE_ACTION_TYPE_NONE, _STATE_SET, ACTION_STOP, SIGNAL_EMIT, DRAG_VAL_SET, _DRAG_VAL_STEP, _DRAG_VAL_PAGE, _SCRIPT
*/
EAPI Edje_Action_Type edje_edit_program_action_get(Evas_Object *obj, const char *prog);
-/** Set the action of a given program.
+/**
+ * @brief Sets the action of a given program.
*
* Action can be one of EDJE_ACTION_TYPE_NONE, _STATE_SET, ACTION_STOP, SIGNAL_EMIT, DRAG_VAL_SET, _DRAG_VAL_STEP, _DRAG_VAL_PAGE, _SCRIPT
*
*/
EAPI Eina_Bool edje_edit_program_action_set(Evas_Object *obj, const char *prog, Edje_Action_Type action);
-/** Get the list of the targets for the given program.
+/**
+ * @brief Gets the list of the targets for the given program.
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*
* @param obj Object being edited.
- * @param prog The name of the progrem to get the list of the targets.
+ * @param prog The name of the program to get the list of the targets.
*
* @return A list with all the targets names, or NULL on error.
*/
EAPI Eina_List * edje_edit_program_targets_get(Evas_Object *obj, const char *prog);
-/** Add a new target program to the list of 'targets' in the given program.
+/**
+ * @brief Adds a new target program to the list of 'targets' in the given program.
*
* If program action is @c EDJE_ACTION_TYPE_ACTION_STOP, then 'target'
* must be an existing program name. If it's @c
*/
EAPI Eina_Bool edje_edit_program_target_add(Evas_Object *obj, const char *prog, const char *target);
-/** Add a new target program to certain place in list of 'targets' in the given program.
+/**
+ * @brief Adds a new target program to certain place in list of 'targets' in the given program.
*
* If program action is @c EDJE_ACTION_TYPE_ACTION_STOP, then 'target'
* must be an existing program name. If it's @c
EAPI Eina_Bool
edje_edit_program_target_insert_at(Evas_Object *obj, const char *prog, const char *target, int place);
-/** Deletes a target from the list of 'targets' in the given program.
+/**
+ * @brief Deletes a target from the list of 'targets' in the given program.
*
* If program action is EDJE_ACTION_TYPE_ACTION_STOP then 'target' must be an existing program name.
* If action is EDJE_ACTION_TYPE_STATE_SET then 'target' must be an existing part name.
*/
EAPI Eina_Bool edje_edit_program_target_del(Evas_Object *obj, const char *prog, const char *target);
-/** Clear the 'targets' list of the given program
+/**
+ * @brief Clears the 'targets' list of the given program
*
* @param obj Object being edited.
- * @param prog The name of the program to cleaar the 'targets' list.
+ * @param prog The name of the program to clear the 'targets' list.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_targets_clear(Evas_Object *obj, const char *prog);
-/** Get the list of action that will be run after the give program
+/**
+ * @brief Gets the list of action that will be run after the give program.
*
* Use edje_edit_string_list_free() when you don't need it anymore.
*
* @param obj Object being edited.
* @param prog The name of the program to get the list of actions
*
- * @return A list with all program names. or NULL on error.
+ * @return A list with all program names, or NULL on error.
*/
EAPI Eina_List * edje_edit_program_afters_get(Evas_Object *obj, const char *prog);
-/** Add a new program name to the list of 'afters' in the given program.
+/**
+ * @brief Adds a new program name to the list of 'afters' in the given program.
*
* All the programs listed in 'afters' will be executed after program execution.
*
*/
EAPI Eina_Bool edje_edit_program_after_add(Evas_Object *obj, const char *prog, const char *after);
-/** Add a new program name into specific place in list of 'afters' in the given program.
+/**
+ * @brief Adds a new program name into specific place in list of 'afters' in the given program.
*
* All the programs listed in 'afters' will be executed after program execution.
*
EAPI Eina_Bool
edje_edit_program_after_insert_at(Evas_Object *obj, const char *prog, const char *after, int place);
-/** Delete the given program from the list of 'afters' of the program.
+/**
+ * @brief Deletes the given program from the list of 'afters' of the program.
*
* @param obj Object being edited.
* @param prog The name of the program from where to remove the after.
*/
EAPI Eina_Bool edje_edit_program_after_del(Evas_Object *obj, const char *prog, const char *after);
-/** Clear the 'afters' list of the given program.
+/**
+ * @brief Clears the 'afters' list of the given program.
*
* @param obj Object being edited.
* @param prog The name of the program to clear the 'afters' list.
*/
EAPI Eina_Bool edje_edit_program_afters_clear(Evas_Object *obj, const char *prog);
-/** Get the state for the given program
+/**
+ * @brief Get the state for the given program.
*
* In a STATE_SET action this is the name of state to set.
* In a SIGNAL_EMIT action is the name of the signal to emit.
*/
EAPI const char * edje_edit_program_state_get(Evas_Object *obj, const char *prog);
-/** Get api's name of a program.
+/**
+ * @brief Gets api's name of a program.
*
* @param obj Object being edited.
* @param prog Name of program.
*
- * @return name of the api if successful, NULL otherwise.
+ * @return Name of the api if successful, NULL otherwise.
*/
EAPI const char * edje_edit_program_api_name_get(Evas_Object *obj, const char *prog);
-/** Get api's description of a program.
+/**
+ * @brief Gets api's description of a program.
*
* @param obj Object being edited.
* @param prog Name of program.
*
- * @return description of the api if successful, NULL otherwise.
+ * @return Description of the api if successful, NULL otherwise.
*/
EAPI const char * edje_edit_program_api_description_get(Evas_Object *obj, const char *prog);
-/** Set api's name of a program.
+/**
+ * @brief Sets api's name of a program.
*
* @param obj Object being edited.
* @param prog Name of the part.
*/
EAPI Eina_Bool edje_edit_program_api_name_set(Evas_Object *obj, const char *prog, const char *name);
-/** Set api's description of a program.
+/**
+ * @brief Sets api's description of a program.
*
* @param obj Object being edited.
* @param prog Name of the program.
*/
EAPI Eina_Bool edje_edit_program_api_description_set(Evas_Object *obj, const char *prog, const char *description);
-/** Set the state for the given program
+/**
+ * @brief Sets the state for the given program.
*
* In a STATE_SET action this is the name of state to set.
* In a SIGNAL_EMIT action is the name of the signal to emit.
*
* @param obj Object being edited.
* @param prog The name of the program to set a state.
- * @param state The nameo of the state to set (not including the state value)
+ * @param state The name of the state to set (not including the state value)
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_state_set(Evas_Object *obj, const char *prog, const char *state);
-/** Get the value of state for the given program.
+/**
+ * @brief Gets the value of state for the given program.
*
* In a STATE_SET action this is the value of state to set.
* Not used on SIGNAL_EMIT action.
*/
EAPI double edje_edit_program_value_get(Evas_Object *obj, const char *prog);
-/** Set the value of state for the given program.
+/**
+ * @brief Sets the value of state for the given program.
*
* In a STATE_SET action this is the value of state to set.
* Not used on SIGNAL_EMIT action.
*/
EAPI Eina_Bool edje_edit_program_value_set(Evas_Object *obj, const char *prog, double value);
-/** Get the state2 for the given program
+/**
+ * @brief Gets the state2 for the given program
*
* In a STATE_SET action is not used
* In a SIGNAL_EMIT action is the source of the emitted signal.
*/
EAPI const char * edje_edit_program_state2_get(Evas_Object *obj, const char *prog);
-/** Set the state2 for the given program
+/**
+ * @brief Sets the state2 for the given program
*
* In a STATE_SET action is not used
* In a SIGNAL_EMIT action is the source of the emitted signal.
*/
EAPI Eina_Bool edje_edit_program_state2_set(Evas_Object *obj, const char *prog, const char *state2);
-/** Get the value of state2 for the given program.
+/**
+ * @brief Gets the value of state2 for the given program.
*
* @param obj Object being edited.
* @param prog The name of the program to get the state2 value.
*/
EAPI double edje_edit_program_value2_get(Evas_Object *obj, const char *prog);
-/** Set the value2 of state for the given program.
+/**
+ * @brief Sets the value2 of state for the given program.
*
* This is used in DRAG_ACTION
*
*/
EAPI Eina_Bool edje_edit_program_value2_set(Evas_Object *obj, const char *prog, double value);
-/** Get the type of transition to use when apply animations.
+/**
+ * @brief Gets the type of transition to use when apply animations.
*
* Can be one of: EDJE_TWEEN_MODE_NONE, EDJE_TWEEN_MODE_LINEAR, EDJE_TWEEN_MODE_SINUSOIDAL, EDJE_TWEEN_MODE_ACCELERATE or EDJE_TWEEN_MODE_DECELERATE.
*
*/
EAPI Edje_Tween_Mode edje_edit_program_transition_get(Evas_Object *obj, const char *prog);
-/** Set the type of transition to use when apply animations.
+/**
+ * @brief Sets the type of transition to use when apply animations.
*
* Can be one of: EDJE_TWEEN_MODE_NONE, EDJE_TWEEN_MODE_LINEAR, EDJE_TWEEN_MODE_SINUSOIDAL, EDJE_TWEEN_MODE_ACCELERATE or EDJE_TWEEN_MODE_DECELERATE.
*
*/
EAPI Eina_Bool edje_edit_program_transition_set(Evas_Object *obj, const char *prog, Edje_Tween_Mode transition);
-/** Get the interpolation value 1 of the transition.
+/**
+ * @brief Gets the interpolation value 1 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_ACCELERATE_FACTOR, EDJE_TWEEN_MODE_DECELERATE_FACTOR, EDJE_TWEEN_MODE_SINUSOIDAL_FACTOR, EDJE_TWEEN_MODE_DIVISOR_INTERP, EDJE_TWEEN_MODE_BOUNCE or EDJE_TWEEN_MODE_SPRING.
*
* @param obj Object being edited.
* @param prog The name of the program to get the interpolation value 1.
*
- * @return interpolation value 1.
+ * @return Interpolation value 1.
*/
EAPI double edje_edit_program_transition_value1_get(Evas_Object *obj, const char *prog);
-/** Set the interpolation value 1 of the transition.
+/**
+ * @brief Sets the interpolation value 1 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_ACCELERATE_FACTOR, EDJE_TWEEN_MODE_DECELERATE_FACTOR, EDJE_TWEEN_MODE_SINUSOIDAL_FACTOR, EDJE_TWEEN_MODE_DIVISOR_INTERP, EDJE_TWEEN_MODE_BOUNCE or EDJE_TWEEN_MODE_SPRING.
*
* @param obj Object being edited.
*/
EAPI Eina_Bool edje_edit_program_transition_value1_set(Evas_Object *obj, const char *prog, double value);
-/** Get the interpolation value 2 of the transition.
+/**
+ * @brief Gets the interpolation value 2 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_DIVISOR_INTERP, EDJE_TWEEN_MODE_BOUNCE or EDJE_TWEEN_MODE_SPRING.
* @param obj Object being edited.
* @param prog The name of the program to get the interpolation value 2.
*
- * @return interpolation value 2.
+ * @return Interpolation value 2.
*/
EAPI double edje_edit_program_transition_value2_get(Evas_Object *obj, const char *prog);
-/** Set the interpolation value 2 of the transition.
+/**
+ * @brief Sets the interpolation value 2 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_DIVISOR_INTERP, EDJE_TWEEN_MODE_BOUNCE or EDJE_TWEEN_MODE_SPRING.
*
* @param obj Object being edited.
*/
EAPI Eina_Bool edje_edit_program_transition_value2_set(Evas_Object *obj, const char *prog, double value);
-/** Get the interpolation value 3 of the transition.
+/**
+ * @brief Gets the interpolation value 3 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_CUBIC_BEZIER.
*
* @param obj Object being edited.
* @param prog The name of the program to get the interpolation value 3.
*
- * @return interpolation value 3.
+ * @return Interpolation value 3.
*/
EAPI double edje_edit_program_transition_value3_get(Evas_Object *obj, const char *prog);
-/** Set the interpolation value 3 of the transition.
+/**
+ * @brief Sets the interpolation value 3 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_CUBIC_BEZIER.
*
* @param obj Object being edited.
*/
EAPI Eina_Bool edje_edit_program_transition_value3_set(Evas_Object *obj, const char *prog, double value);
-/** Get the interpolation value 4 of the transition.
+/**
+ * @brief Gets the interpolation value 4 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_CUBIC_BEZIER.
*
* @param obj Object being edited.
* @param prog The name of the program to get the interpolation value 4.
*
- * @return interpolation value 4.
+ * @return Interpolation value 4.
*/
EAPI double edje_edit_program_transition_value4_get(Evas_Object *obj, const char *prog);
-/** Set the interpolation value 4 of the transition.
+/**
+ * @brief Sets the interpolation value 4 of the transition.
* Can be used with one of transition type: EDJE_TWEEN_MODE_CUBIC_BEZIER.
*
* @param obj Object being edited.
*/
EAPI Eina_Bool edje_edit_program_transition_value4_set(Evas_Object *obj, const char *prog, double value);
-/** Get the duration of the transition in seconds.
+/**
+ * @brief Gets the duration of the transition in seconds.
*
* @param obj Object being edited.
* @param prog The name of the program to get the transition time.
*/
EAPI double edje_edit_program_transition_time_get(Evas_Object *obj, const char *prog);
-/** Set the duration of the transition in seconds.
+/**
+ * @brief Sets the duration of the transition in seconds.
*
* @param obj Object being edited.
* @param prog The name of the program to set the transition time.
*/
EAPI Eina_Bool edje_edit_program_transition_time_set(Evas_Object *obj, const char *prog, double seconds);
-/** Get sample name of the program.
+/**
+ * @brief Gets sample name of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*/
EAPI const char * edje_edit_program_sample_name_get(Evas_Object *obj, const char *prog);
-/** Set sample name of the program.
+/**
+ * @brief Sets sample name of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*/
EAPI Eina_Bool edje_edit_program_sample_name_set(Evas_Object *obj, const char *prog, const char *name);
-/** Get tone name of the program.
+/**
+ * @brief Gets tone name of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*/
EAPI const char * edje_edit_program_tone_name_get(Evas_Object *obj, const char *prog);
-/** Set tone name of the program.
+/**
+ * @brief Sets tone name of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*/
EAPI Eina_Bool edje_edit_program_tone_name_set(Evas_Object *obj, const char *prog, const char *name);
-/** Get sample speed of the program.
+/**
+ * @brief Gets sample speed of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*
- * @return double speed on success, -1 otherwise.
+ * @return Double speed on success, @c -1 otherwise.
*/
EAPI double edje_edit_program_sample_speed_get(Evas_Object *obj, const char *prog);
-/** Set sample speed of the program.
+/**
+ * @brief Sets sample speed of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*/
EAPI Eina_Bool edje_edit_program_sample_speed_set(Evas_Object *obj, const char *prog, double speed);
-/** Get tone duration of the program.
+/**
+ * @brief Gets tone duration of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*
- * @return double duration on success, -1 otherwise.
+ * @return Double duration on success, @c -1 otherwise.
*/
EAPI double edje_edit_program_tone_duration_get(Evas_Object *obj, const char *prog);
-/** Set tone duration of the program.
+/**
+ * @brief Sets tone duration of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*/
EAPI Eina_Bool edje_edit_program_tone_duration_set(Evas_Object *obj, const char *prog, double duration);
-/** Get sample channel of the program.
+/**
+ * @brief Gets sample channel of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*
- * @return channel on success, 0 otherwise.
+ * @return Channel on success, @c 0 otherwise.
*/
EAPI unsigned char edje_edit_program_channel_get(Evas_Object *obj, const char *prog);
-/** Set sample channel of the program.
+/**
+ * @brief Sets sample channel of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*/
EAPI Eina_Bool edje_edit_program_channel_set(Evas_Object *obj, const char *prog, Edje_Channel channel);
-/** Get filter part name of the program.
+/**
+ * @brief Gets filter part name of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*/
EAPI const char * edje_edit_program_filter_part_get(Evas_Object *obj, const char *prog);
-/** Set filter part name of the program.
+/**
+ * @brief Sets filter part name of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*/
EAPI Eina_Bool edje_edit_program_filter_part_set(Evas_Object *obj, const char *prog, const char *filter_part);
-/** Get filter state of the program.
+/**
+ * @brief Gets filter state of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
*/
EAPI const char * edje_edit_program_filter_state_get(Evas_Object *obj, const char *prog);
-/** Set filter state of the program.
+/**
+ * @brief Sets filter state of the program.
*
* @param obj Object being edited.
* @param prog The name of the program.
/******************************************************************************/
/************************** SCRIPTS API ***********************************/
/******************************************************************************/
-/** @name Scripts API
- * Functions to deal with embryo scripts (see @ref edcref).
+/**
+ * @name Scripts API
+ * Functions to deal with embryo scripts (see @ref edcref).
*/ //@{
/**
- * Get the Embryo script for the group of the given object.
+ * @brief Gets the Embryo script for the group of the given object.
*
* Get the shared script for the group under edition. Shared script means
* the script {} block for the group, not counting what's in each program.
EAPI char *edje_edit_script_get(Evas_Object *obj);
/**
- * Set the code for the group script.
+ * @brief Sets the code for the group script.
*
* Set the Embryo source code for the shared script of the edited group.
* Note that changing the code itself will not update the running VM, you
EAPI Eina_Bool edje_edit_script_set(Evas_Object *obj, const char *code);
/**
- * Get the Embryo script for the given program.
+ * @brief Gets the Embryo script for the given program.
*
* Get the script code for the given program. Like the group script, this
* function returns a duplicate of the code that the user can modify at will
EAPI char *edje_edit_script_program_get(Evas_Object *obj, const char *prog);
/**
- * Set the Embryo script for the given program.
+ * @brief Sets the Embryo script for the given program.
*
* Set the Embryo source code for the program @p prog. It must be an
* existing program of type EDJE_ACTION_TYPE_SCRIPT, or the function
* need to call @see edje_edit_script_compile() for it to get updated.
*
* @param obj The object being edited
- * @param prog The program name.
+ * @param prog The program name
* @param code The Embryo source
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
EAPI Eina_Bool edje_edit_script_program_set(Evas_Object *obj, const char *prog, const char *code);
/**
- * Compile the Embryo script for the given object
+ * @brief Compiles the Embryo script for the given object.
*
* If required, this function will process all script code for the group and
* build the bytecode, updating the running Embryo VM Program if the build
EAPI Eina_Bool edje_edit_script_compile(Evas_Object *obj);
/**
- * Get the list of errors resulting from the last script build
+ * @brief Gets the list of errors resulting from the last script build.
*
* Get the list of errors that resulted from the last attempt to rebuild
* the Embryo script for the edited group. This will be a standard Eina_List
/******************************************************************************/
/************************ SOURCE CODE API *********************************/
/******************************************************************************/
-/** @name Scripts API
- * Functions to deal with embryo scripts (see @ref edcref).
+/**
+ * @name Scripts API
+ * Functions to deal with embryo scripts (see @ref edcref).
*/ //@{
/**
- * Return source code of the current edje edit object.
+ * @brief Returns source code of the current edje edit object.
*
- * Remember to free the string with edje_edit_string_free()
+ * Remember to free the string with edje_edit_string_free().
*
* This function will return source code of the whole group, loaded previously.
* This function also will collect all possible resources that is required and
EAPI const char *edje_edit_source_generate(Evas_Object *obj);
/**
- * Return source code of the current edje edit object.
+ * @brief Returns source code of the current edje edit object.
*
- * Remember to free the string with edje_edit_string_free()
+ * Remember to free the string with edje_edit_string_free().
*
* This function will return source code of the whole group, loaded previously.
* This function also will collect all possible resources that is required and
EAPI const char * edje_edit_object_source_generate(Evas_Object *obj);
/**
- * Return source code of all collections.
+ * @brief Returns source code of all collections.
*
- * Remember to free the string with free()
+ * Remember to free the string with free().
*
* This function will generate and return source code of all collections and
* other top level blocks.
EAPI char *edje_edit_full_source_generate(Evas_Object *obj);
/**
- * Return source code of global block data.
+ * @brief Returns source code of global block data.
*
- * Remember to free the string with edje_edit_string_free()
+ * Remember to free the string with edje_edit_string_free().
*
* @param obj The object being edited
*
EAPI const char * edje_edit_data_source_generate(Evas_Object *obj);
/**
- * Get a list of color clsses which given object use.
+ * @brief Gets a list of color classes which given object use.
*
- * @paramaram obj The object being edited
+ * @param obj The object being edited
*
* @return The color classes list
*/
edje_edit_object_color_class_list_get(Evas_Object *obj);
/**
- * Get the source code for given color classes
+ * @brief Gets the source code for given color classes.
*
* @param obj The object being edited
- * @param color_classes The list of color classes for generete code
+ * @param color_classes The list of color classes for generate code
*
* @return The color classes source code
*/
/******************************************************************************/
/************************** ERROR API ***********************************/
/******************************************************************************/
-/** @name Error API
- * to deal with error messages (see @ref edcref).
+/**
+ * @name Error API
+ * Functions to deal with error messages (see @ref edcref).
*/ //@{
EAPI extern Eina_Error EDJE_EDIT_ERROR_GROUP_CURRENTLY_USED;
/**
- @brief Eet Data Handling Library Public API Calls
+ @brief Eet Data Handling Library Public API Calls.
- These routines are used for Eet Library interaction
+ These routines are used for Eet Library interaction.
@page eet_main Eet
/**
* @def EET_VERSION_MAJOR
- * The major number of eet version
+ * The major number of eet version.
*/
#define EET_VERSION_MAJOR EFL_VERSION_MAJOR
/**
* @def EET_VERSION_MINOR
- * The minor number of eet version
+ * The minor number of eet version.
*/
#define EET_VERSION_MINOR EFL_VERSION_MINOR
/**
*/
/**
- * Initialize the EET library.
+ * @ingroup Eet_Group
+ * @brief Initializes the EET library.
*
* The first time this function is called, it will perform all the internal
* initialization required for the library to function properly and increment
* the initialization counter. Any subsequent call only increment this counter
* and return its new value, so it's safe to call this function more than once.
*
- * @return The new init count. Will be 0 if initialization failed.
+ * @return The new init count. Will be @c 0 if initialization failed.
*
* @since 1.0.0
- * @ingroup Eet_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_init(void);
/**
- * Shut down the EET library.
+ * @ingroup Eet_Group
+ * @brief Shuts down the EET library.
*
* If eet_init() was called more than once for the running application,
* eet_shutdown() will decrement the initialization counter and return its
* @return The new init count.
*
* @since 1.0.0
- * @ingroup Eet_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_shutdown(void);
/**
- * Clear eet cache
+ * @ingroup Eet_Group
+ * @Clears eet cache.
*
* For a faster access to previously accessed data, Eet keeps an internal
* cache of files. These files will be freed automatically only when
* will be written down to disk before flushing them from memory.
*
* @since 1.0.0
- * @ingroup Eet_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
* Functions to create, destroy and do basic manipulation of
* #Eet_File handles.
*
- * This sections explains how to use the most basic Eet functions, which
+ * This section explains how to use the most basic Eet functions, which
* are used to work with eet files, read data from them, store it back in or
* take a look at what entries it contains, without making use of the
* serialization capabilities explained in @ref Eet_Data_Group.
*/
/**
- * Open an eet file on disk, and returns a handle to it.
+ * @ingroup Eet_File_Group
+ * @brief Opens an eet file on disk, and returns a handle to it.
* @param file The file path to the eet file. eg: @c "/tmp/file.eet".
* @param mode The mode for opening. Either #EET_FILE_MODE_READ,
* #EET_FILE_MODE_WRITE or #EET_FILE_MODE_READ_WRITE.
* @return An opened eet file handle.
- * @ingroup Eet_File_Group
*
* This function will open an exiting eet file for reading, and build
* the directory table in memory and return a handle to the file, if it
Eet_File_Mode mode);
/**
- * Open an eet file on disk from an Eina_File handle, and returns a handle to it.
+ * @ingroup Eet_File_Group
+ * @brief Opens an eet file on disk from an Eina_File handle, and returns a handle to it.
* @param file The Eina_File handle to map to an eet file.
* @return An opened eet file handle.
- * @ingroup Eet_File_Group
*
* This function will open an exiting eet file for reading, and build
* the directory table in memory and return a handle to the file, if it
eet_mmap(const Eina_File *file);
/**
- * Open an eet file directly from a memory location. The data is not copied,
+ * @ingroup Eet_File_Group
+ * Opens an eet file directly from a memory location. The data is not copied,
* so you must keep it around as long as the eet file is open. There is
* currently no cache for this kind of Eet_File, so it's reopened every time
* you use eet_memopen_read.
* Files opened this way will always be in read-only mode.
*
* @since 1.1.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
size_t size);
/**
- * Get the mode an Eet_File was opened with.
+ * @ingroup Eet_File_Group
+ * @brief Gets the mode an Eet_File was opened with.
* @param ef A valid eet file handle.
* @return The mode ef was opened with.
*
* @since 1.0.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_mode_get(Eet_File *ef);
/**
- * Close an eet file handle and flush pending writes.
+ * @ingroup Eet_File_Group
+ * @brief Closes an eet file handle and flush pending writes.
* @param ef A valid eet file handle.
* @return An eet error identifier.
*
* If the eet file handle is not valid nothing will be done.
*
* @since 1.0.0
- * @ingroup Eet_File_Group
*
* @see eet_clearcache()
*
eet_close(Eet_File *ef);
/**
- * Sync content of an eet file handle, flushing pending writes.
+ * @ingroup Eet_File_Group
+ * @brief Syncs content of an eet file handle, flushing pending writes.
* @param ef A valid eet file handle.
* @return An eet error identifier.
*
* If the eet file handle is not valid nothing will be done.
*
* @since 1.2.4
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_sync(Eet_File *ef);
/**
- * Return a handle to the shared string dictionary of the Eet file
+ * @ingroup Eet_File_Group
+ * @brief Returns a handle to the shared string dictionary of the Eet file
* @param ef A valid eet file handle.
* @return A handle to the dictionary of the file
*
* the #Eet_Data_Descriptor_Class instructions.
*
* @since 1.0.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_dictionary_get(Eet_File *ef);
/**
- * Check if a given string comes from a given dictionary
+ * @ingroup Eet_File_Group
+ * @brief Checks if a given string comes from a given dictionary
* @param ed A valid dictionary handle
* @param string A valid 0 byte terminated C string
- * @return 1 if it is in the dictionary, 0 otherwise
+ * @return @c 1 if it is in the dictionary, @c 0 otherwise
*
* This checks the given dictionary to see if the given string is actually
- * inside that dictionary (i.e. comes from it) and returns 1 if it does.
+ * inside that dictionary (i.e. comes from it) and returns @c 1 if it does.
* If the dictionary handle is invalid, the string is NULL or the string is
- * not in the dictionary, 0 is returned.
+ * not in the dictionary, @c 0 is returned.
*
* @since 1.0.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *string);
/**
- * Return the number of strings inside a dictionary
+ * @ingroup Eet_File_Group
+ * @brief Returns the number of strings inside a dictionary.
* @param ed A valid dictionary handle
* @return the number of strings inside a dictionary
*
* @since 1.6.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_dictionary_count(const Eet_Dictionary *ed);
/**
- * Read a specified entry from an eet file and return data
+ * @ingroup Eet_File_Group
+ * @brief Reads a specified entry from an eet file and return data.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param size_ret Number of bytes read from entry and returned.
* placed in size_ret.
*
* If the eet file handle is not valid NULL is returned and size_ret is
- * filled with 0.
+ * filled with @c 0.
*
* @see eet_read_cipher()
*
* @since 1.0.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int *size_ret);
/**
- * Read a specified entry from an eet file and return data
+ * @ingroup Eet_File_Group
+ * @brief Reads a specified entry from an eet file and return data.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param size_ret Number of bytes read from entry and returned.
* data chunk are placed in size_ret.
*
* If the eet file handle is not valid NULL is returned and size_ret is
- * filled with 0.
+ * filled with @c 0.
*
* @since 1.0.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int *size_ret);
/**
- * Write a specified entry to an eet file handle
+ * @ingroup Eet_File_Group
+ * @brief Write a specified entry to an eet file handle.
* @param ef A valid eet file handle opened for writing.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param data Pointer to the data to be stored.
* @see eet_write_cipher()
*
* @since 1.0.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int compress);
/**
- * Delete a specified entry from an Eet file being written or re-written
+ * @ingroup Eet_File_Group
+ * @brief Deletes a specified entry from an Eet file being written or re-written.
* @param ef A valid eet file handle opened for writing.
* @param name Name of the entry. eg: "/base/file_i_want".
* @return Success or failure of the delete.
* Name, must not be NULL, otherwise 0 will be returned.
*
* @since 1.0.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *name);
/**
- * Alias a specific section to another one. Destination may exist or not,
+ * @ingroup Eet_File_Group
+ * @brief Alias a specific section to another one. Destination may exist or not,
* no checks are done.
* @param ef A valid eet file handle opened for writing.
* @param name Name of the new entry. eg: "/base/file_i_want".
* The equivalent of this would be calling 'ln -s destination name'
*
* @since 1.3.3
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int compress);
/**
- * Retrieve the filename of an Eet_File
+ * @ingroup Eet_File_Group
+ * @brief Retrieves the filename of an Eet_File.
* @param ef A valid eet file handle opened for writing.
* @return The stringshared file string opened with eet_open(), or NULL on error
*
* @note This function will return NULL for files opened with eet_memopen_read()
*
* @since 1.6
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_file_get(Eet_File *ef);
/**
- * Retrieve the destination name of an alias
+ * @ingroup Eet_File_Group
+ * @brief Retrieves the destination name of an alias.
* @param ef A valid eet file handle opened for writing
* @param name Name of the entry. eg: "/base/file_i_want"
* @return Destination of the alias. eg: "/base/the_real_stuff_i_want", NULL on failure
* Name must not be NULL, otherwise NULL will be returned.
*
* @since 1.5
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *name);
/**
- * List all entries in eet file matching shell glob.
+ * @ingroup Eet_File_Group
+ * @brief Lists all entries in eet file matching shell glob.
* @param ef A valid eet file handle.
* @param glob A shell glob to match against.
* @param count_ret Number of entries found to match.
* there are any, and if no memory errors occur.
*
* The eet file handle must be valid and glob must not be NULL, or NULL
- * will be returned and count_ret will be filled with 0.
+ * will be returned and count_ret will be filled with @c 0.
*
* The calling program must call free() on the array returned, but NOT
* on the string pointers in the array. They are taken as read-only
* the file handle is not closed. When it is closed those pointers in the
* array are now not valid and should not be used.
*
- * On success the array returned will have a list of string pointers
+ * On success, the array returned will have a list of string pointers
* that are the names of the entries that matched, and count_ret will have
* the number of entries in this array placed in it.
*
* value of "*".
*
* @since 1.0.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int *count_ret);
/**
- * Return an iterator that will describe each entry of an Eet_File.
+ * @ingroup Eet_File_Group
+ * @brief Returns an iterator that will describe each entry of an Eet_File.
* @param ef A valid eet file handle.
* @return An interator of Eet_Entry.
*
* @since 1.8.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI Eina_Iterator *eet_list_entries(Eet_File *ef);
/**
- * Return the number of entries in the specified eet file.
+ * @ingroup Eet_File_Group
+ * @brief Returns the number of entries in the specified eet file.
* @param ef A valid eet file handle.
- * @return Number of entries in ef or -1 if the number of entries
+ * @return Number of entries in ef or @c -1 if the number of entries
* cannot be read due to open mode restrictions.
*
* @since 1.0.0
- * @ingroup Eet_File_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
/**
* @defgroup Eet_File_Cipher_Group Eet File Ciphered Main Functions
+ * @ingroup Eet_File_Group
*
* Most of the @ref Eet_File_Group have alternative versions that
* accounts for ciphers to protect their content.
*
* @see @ref Eet_Cipher_Group
*
- * @ingroup Eet_File_Group
*/
/**
- * Read a specified entry from an eet file and return data using a cipher.
+ * @ingroup Eet_File_Cipher_Group
+ * @brif Reads a specified entry from an eet file and return data using a cipher.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param size_ret Number of bytes read from entry and returned.
* placed in size_ret.
*
* If the eet file handle is not valid NULL is returned and size_ret is
- * filled with 0.
+ * filled with @c 0.
*
* @see eet_read()
*
* @since 1.0.0
- * @ingroup Eet_File_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *cipher_key);
/**
- * Write a specified entry to an eet file handle using a cipher.
+ * @ingroup Eet_File_Cipher_Group
+ * @brief Writes a specified entry to an eet file handle using a cipher.
* @param ef A valid eet file handle opened for writing.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param data Pointer to the data to be stored.
* @param size Length in bytes in the data to be stored.
* @param compress Compression flags (1 == compress, 0 = don't compress).
* @param cipher_key The key to use as cipher.
- * @return bytes written on successful write, 0 on failure.
+ * @return Bytes written on successful write, @c 0 on failure.
*
* This function will write the specified chunk of data to the eet file
- * and return greater than 0 on success. 0 will be returned on failure.
+ * and return greater than @c 0 on success. 0 will be returned on failure.
*
* The eet file handle must be a valid file handle for an eet file opened
- * for writing. If it is not, 0 will be returned and no action will be
+ * for writing. If it is not, @c 0 will be returned and no action will be
* performed.
*
* Name, and data must not be NULL, and size must be > 0. If these
* @see eet_write()
*
* @since 1.0.0
- * @ingroup Eet_File_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
*/
/**
- * Read just the header data for an image and dont decode the pixels.
+ * @ingroup Eet_File_Image_Group
+ * @brief Reads just the header data for an image and dont decode the pixels.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param w A pointer to the unsigned int to hold the width in pixels.
* @param compress A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
- * @return 1 on successful decode, 0 otherwise
+ * @return @c 1 on successful decode, @c 0 otherwise
*
* Reads and decodes the image header data stored under the given key and
* Eet file.
* @see eet_data_image_header_read_cipher()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Read image data from the named key in the eet file.
+ * @ingroup Eet_File_Image_Group
+ * @brief Reads image data from the named key in the eet file.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param w A pointer to the unsigned int to hold the width in pixels.
* @see eet_data_image_read_to_surface()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Read image data from the named key in the eet file and store it in the given buffer.
+ * @ingroup Eet_File_Image_Group
+ * @brief Reads image data from the named key in the eet file and store it in the given buffer.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param src_x The starting x coordinate from where to dump the stream.
* @param compress A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
- * @return 1 on success, 0 otherwise.
+ * @return @c 1 on success, @c 0 otherwise.
*
* Reads and decodes the image stored in the given Eet file, placing the
* resulting pixel data in the buffer pointed by the user.
* @see eet_data_image_decode_to_cspace_surface_cipher()
*
* @since 1.0.2
- * @ingroup Eet_File_Image_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Write image data to the named key in an eet file.
+ * @ingroup Eet_File_Image_Group
+ * @brief Writes image data to the named key in an eet file.
* @param ef A valid eet file handle opened for writing.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param data A pointer to the image pixel data.
* @see eet_data_image_write_cipher()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding lossy);
/**
- * Decode Image data header only to get information.
+ * @ingroup Eet_File_Image_Group
+ * @brief Decodes Image data header only to get information.
* @param data The encoded pixel data.
* @param size The size, in bytes, of the encoded pixel data.
* @param w A pointer to the unsigned int to hold the width in pixels.
* @param compress A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
- * @return 1 on success, 0 on failure.
+ * @return @c 1 on success, @c 0 on failure.
*
* This function works exactly like eet_data_image_header_read(), but instead
* of reading from an Eet file, it takes the buffer of size @p size pointed
* by @p data, which must be a valid Eet encoded image.
*
- * On success the function returns 1 indicating the header was read and
- * decoded properly, or 0 on failure.
+ * On success the function returns @c 1 indicating the header was read and
+ * decoded properly, or @c 0 on failure.
*
* @see eet_data_image_header_read()
* @see eet_data_image_header_decode_cipher()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Decode Image data into pixel data.
+ * @ingroup Eet_File_Image_Group
+ * @brief Decodes Image data into pixel data.
* @param data The encoded pixel data.
* @param size The size, in bytes, of the encoded pixel data.
* @param w A pointer to the unsigned int to hold the width in pixels.
* @see eet_data_image_decode_cipher()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Decode Image data into pixel data and stores in the given buffer.
+ * @ingroup Eet_File_Image_Group
+ * @brief Decodes Image data into pixel data and stores in the given buffer.
* @param data The encoded pixel data.
* @param size The size, in bytes, of the encoded pixel data.
* @param src_x The starting x coordinate from where to dump the stream.
* @param compress A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
- * @return 1 on success, 0 otherwise.
+ * @return @c 1 on success, @c 0 otherwise.
*
* Like eet_data_image_read_to_surface(), but reading the given @p data buffer
* instead of a file.
* @see eet_data_image_decode_to_surface_cipher()
*
* @since 1.0.2
- * @ingroup Eet_File_Image_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Encode image data for storage or transmission.
+ * @ingroup Eet_File_Image_Group
+ * @brief Encodes image data for storage or transmission.
* @param data A pointer to the image pixel data.
* @param size_ret A pointer to an int to hold the size of the returned data.
* @param w The width of the image in pixels.
* @see eet_data_image_encode_cipher()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
/**
* @defgroup Eet_File_Image_Cipher_Group Image Store and Load using a Cipher
+ * @ingroup Eet_File_Image_Group
*
* Most of the @ref Eet_File_Image_Group have alternative versions
* that accounts for ciphers to protect their content.
*
* @see @ref Eet_Cipher_Group
*
- * @ingroup Eet_File_Image_Group
*/
/**
- * Read just the header data for an image and dont decode the pixels using a cipher.
+ * @ingroup Eet_File_Image_Cipher_Group
+ * @brief Reads just the header data for an image and dont decode the pixels using a cipher.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param cipher_key The key to use as cipher.
* @param compress A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
- * @return 1 on successful decode, 0 otherwise
+ * @return @c 1 on successful decode, @c 0 otherwise
*
* This function reads an image from an eet file stored under the named
* key in the eet file and return a pointer to the decompressed pixel data.
* the image file (0 - 100). The lossy flags is either 0 or 1 as to if
* the image was encoded lossily or not.
*
- * On success the function returns 1 indicating the header was read and
- * decoded properly, or 0 on failure.
+ * On success the function returns @c 1 indicating the header was read and
+ * decoded properly, or @c 0 on failure.
*
* @see eet_data_image_header_read()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Get the colorspace Eet can decode into of a given eet image ressource
+ * @ingroup Eet_File_Image_Group
+ * @brief Gets the colorspace Eet can decode into of a given eet image ressource.
*
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @return 1 on successful get, 0 otherwise.
*
* @since 1.10.0
- * @ingroup Eet_File_Image_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const Eet_Colorspace **cspaces);
/**
- * Read image data from the named key in the eet file using a cipher.
+ * @ingroup Eet_File_Image_Cipher_Group
+ * @brief Reads image data from the named key in the eet file using a cipher.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param cipher_key The key to use as cipher.
* @see eet_data_image_read()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Read image data from the named key in the eet file using a cipher.
+ * @ingroup Eet_File_Image_Cipher_Group
+ * @brief Reads image data from the named key in the eet file using a cipher.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param cipher_key The key to use as cipher.
* @param compress A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
- * @return 1 on success, 0 otherwise.
+ * @return @c 1 on success, @c 0 otherwise.
*
* This function reads an image from an eet file stored under the named
* key in the eet file and store the decompressed pixel data in the provided
* @see eet_data_image_decode_to_cspace_surface_cipher()
*
* @since 1.0.2
- * @ingroup Eet_File_Image_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
/**
- * Read image data from the named key in the eet file using a cipher.
+ * @ingroup Eet_File_Image_Cipher_Group
+ * @brief Reads image data from the named key in the eet file using a cipher.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param cipher_key The key to use as cipher.
* @param comp A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
- * @return 1 on success, 0 otherwise.
+ * @return @c 1 on success, @c 0 otherwise.
*
* This function reads an image from an eet file stored under the named
* key in the eet file and store the decompressed pixel data in the provided
* @see eet_data_image_read_to_surface_cipher()
*
* @since 1.10.0
- * @ingroup Eet_File_Image_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
/**
- * Read image data from the named key in the eet file using a cipher.
+ * @ingroup Eet_File_Image_Cipher_Group
+ * @brief Reads image data from the named key in the eet file using a cipher.
* @param ef A valid eet file handle opened for reading.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param cipher_key The key to use as cipher.
* @param comp A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
- * @return 1 on success, 0 otherwise.
+ * @return @c 1 on success, @c 0 otherwise.
*
* This function reads an image from an eet file stored under the named
* key in the eet file and store the decompressed pixels in the specified
* @see eet_data_image_read_to_surface_cipher()
*
* @since 1.10.0
- * @ingroup Eet_File_Image_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Write image data to the named key in an eet file using a cipher.
+ * @ingroup Eet_File_Image_Cipher_Group
+ * @brief Writes image data to the named key in an eet file using a cipher.
* @param ef A valid eet file handle opened for writing.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param cipher_key The key to use as cipher.
* @see eet_data_image_write()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding lossy);
/**
- * Decode Image data header only to get information using a cipher.
+ * @ingroup Eet_File_Image_Cipher_Group
+ * @brief Decodes Image data header only to get information using a cipher.
* @param data The encoded pixel data.
* @param cipher_key The key to use as cipher.
* @param size The size, in bytes, of the encoded pixel data.
* @param compress A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
- * @return 1 on success, 0 on failure.
+ * @return @c 1 on success, @c 0 on failure.
*
* This function takes encoded pixel data and decodes it into raw RGBA
* pixels on success.
* @see eet_data_image_header_decode()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Decode Image data into pixel data using a cipher.
+ * @ingroup Eet_File_Image_Cipher_Group
+ * @brief Decodes Image data into pixel data using a cipher.
* @param data The encoded pixel data.
* @param cipher_key The key to use as cipher.
* @param size The size, in bytes, of the encoded pixel data.
* @see eet_data_image_decode()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Decode Image data into pixel data using a cipher.
+ * @ingroup Eet_File_Image_Cipher_Group
+ * @brief Decodes Image data into pixel data using a cipher.
* @param data The encoded pixel data.
* @param cipher_key The key to use as cipher.
* @param size The size, in bytes, of the encoded pixel data.
* @param compress A pointer to the int to hold the compression amount.
* @param quality A pointer to the int to hold the quality amount.
* @param lossy A pointer to the int to hold the lossiness flag.
- * @return 1 on success, 0 otherwise.
+ * @return @c 1 on success, @c 0 otherwise.
*
* This function takes encoded pixel data and decodes it into raw RGBA
* pixels on success.
* @see eet_data_image_decode_to_surface()
*
* @since 1.0.2
- * @ingroup Eet_File_Image_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Image_Encoding *lossy);
/**
- * Encode image data for storage or transmission using a cipher.
+ * @ingroup Eet_File_Image_Cipher_Group
+ * @brief Encodes image data for storage or transmission using a cipher.
* @param data A pointer to the image pixel data.
* @param cipher_key The key to use as cipher.
* @param size_ret A pointer to an int to hold the size of the returned data.
* @see eet_data_image_encode()
*
* @since 1.0.0
- * @ingroup Eet_File_Image_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
*/
/**
- * Callback used to request if needed the password of a private key.
+ * @ingroup Eet_Cipher_Group
+ * @brief Callback used to request if needed the password of a private key.
*
* @param buffer the buffer where to store the password.
* @param size the maximum password size (size of buffer, including '@\0').
* @param rwflag if the buffer is also readable or just writable.
* @param data currently unused, may contain some context in future.
- * @return 1 on success and password was set to @p buffer, 0 on failure.
+ * @return @c 1 on success and password was set to @p buffer, @c 0 on failure.
*
* @since 1.2.0
- * @ingroup Eet_Cipher_Group
*/
typedef int (*Eet_Key_Password_Callback)(char *buffer, int size, int rwflag, void *data);
/**
- * Create an Eet_Key needed for signing an eet file.
+ * @ingroup Eet_Cipher_Group
+ * @brief Creates an Eet_Key needed for signing an eet file.
*
* The certificate should provide the public that match the private key.
* No verification is done to ensure that.
*
* @warning You need to compile signature support in EET.
* @since 1.2.0
- * @ingroup Eet_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Key_Password_Callback cb);
/**
- * Close and release all resource used by an Eet_Key. An
- * reference counter prevent it from being freed until all file
+ * @ingroup Eet_Cipher_Group
+ * @brief Close and release all resource used by an Eet_Key.
+ * A reference counter prevent it from being freed until all file
* using it are also closed.
*
* @param key the key handle to close and free resources.
*
* @since 1.2.0
- * @ingroup Eet_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_identity_close(Eet_Key *key);
/**
- * Set a key to sign a file
+ * @ingroup Eet_Cipher_Group
+ * @breif Sets a key to sign a file.
*
* @param ef the file to set the identity.
* @param key the key handle to set as identity.
* #EET_ERROR_NONE on success.
*
* @since 1.2.0
- * @ingroup Eet_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Key *key);
/**
- * Display both private and public key of an Eet_Key.
+ * @ingroup Eet_Cipher_Group
+ * @brief Displays both private and public key of an Eet_Key.
*
* @param key the handle to print.
* @param out where to print.
*
* @warning You need to compile signature support in EET.
* @since 1.2.0
- * @ingroup Eet_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
FILE *out);
/**
- * Compare the identify certificate of an eet file against a stored one
+ * @ingroup Eet_Cipher_Group
+ * @brief Compares the identify certificate of an eet file against a stored one
*
* @param ef The file handle to check the identify of
* @param certificate_file The path to the certificate file
- * @return EINA_TRUE if the certificates match, otherwise EINA_FALSE;
+ * @return @c EINA_TRUE if the certificates match, otherwise @c EINA_FALSE
*
* The @p ef file handle mus be valid, and a signed file, otherwise
* checking will fail. The path to the certificate file must be a valid
* security. This is just a convenience test function.
* @warning You need to compile signature support in EET.
* @since 1.13
- * @ingroup Eet_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *certificate_file);
/**
- * Get the x509 der certificate associated with an Eet_File. Will return NULL
+ * @ingroup Eet_Cipher_Group
+ * @brief Gets the x509 der certificate associated with an Eet_File. Will return NULL
* if the file is not signed.
*
* @param ef The file handle to query.
* @return the x509 certificate or @c NULL on error.
*
* @since 1.2.0
- * @ingroup Eet_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int *der_length);
/**
- * Get the raw signature associated with an Eet_File. Will return NULL
+ * @ingroup Eet_Cipher_Group
+ * @brief Gets the raw signature associated with an Eet_File. Will return NULL
* if the file is not signed.
*
* @param ef The file handle to query.
* @param signature_length The length of returned data, may be @c NULL.
- * @return the raw signature or @c NULL on error.
- *
- * @ingroup Eet_Cipher_Group
+ * @return The raw signature or @c NULL on error.
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int *signature_length);
/**
- * Get the SHA1 associated with a file. Could be the one used to
+ * @ingroup Eet_Cipher_Group
+ * @brief Gets the SHA1 associated with a file. Could be the one used to
* sign the data or if the data where not signed, it will be the
* SHA1 of the file.
*
* @return the associated SHA1 or @c NULL on error.
*
* @since 1.2.0
- * @ingroup Eet_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int *sha1_length);
/**
- * Display the x509 der certificate to out.
+ * @ingroup Eet_Cipher_Group
+ * @brief Displays the x509 der certificate to out.
*
* @param certificate the x509 certificate to print
* @param der_length The length the certificate.
*
* @warning You need to compile signature support in EET.
* @since 1.2.0
- * @ingroup Eet_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
* @typedef (*Eet_Descriptor_Hash_Foreach_Callback_Callback)
*
* Callback prototype for Eet_Descriptor_Hash_Foreach_Callback
- * @param h the hash
- * @param k the key
- * @param dt the data
- * @param fdt the data passed to the callback
- * @return an integer
+ * @param h The hash
+ * @param k The key
+ * @param dt The data
+ * @param fdt The data passed to the callback
+ * @return An integer
*/
typedef int (*Eet_Descriptor_Hash_Foreach_Callback_Callback)(void *h, const char *k, void *dt, void *fdt);
/**
* @typedef (*Eet_Descriptor_Mem_Alloc_Callback)
*
- * Callback prototype for Eet_Descriptor_Mem_Alloc
- * @param size is the size of memory to alloc on call of the callback
+ * Callback prototype for Eet_Descriptor_Mem_Alloc.
+ * @param size Is the size of memory to alloc on call of the callback
*/
typedef void * (*Eet_Descriptor_Mem_Alloc_Callback)(size_t size);
* @typedef (*Eet_Descriptor_Mem_Free_Callback)
*
* Callback prototype for Eet_Descriptor_Mem_Alloc
- * @param mem must be a pointer to free on call of the callback
+ * @param mem Must be a pointer to free on call of the callback
*/
typedef void (*Eet_Descriptor_Mem_Free_Callback)(void *mem);
* @typedef (*Eet_Descriptor_Str_Alloc_Callback)
*
* Callback prototype for Eet_Descriptor_Str_Alloc
- * @param str must be the string to alloc
- * @return have must be an allocated char * for the given string
+ * @param str Must be the string to alloc
+ * @return have Must be an allocated char * for the given string
*/
typedef char * (*Eet_Descriptor_Str_Alloc_Callback)(const char *str);
* @typedef (*Eet_Descriptor_Str_Free_Callback)
*
* Callback prototype for Eet_Descriptor_Str_Free
- * @param str must be an allocated string to free
+ * @param str Must be an allocated string to free
*/
typedef void (*Eet_Descriptor_Str_Free_Callback)(const char *str);
* @typedef (*Eet_Descriptor_List_Next_Callback)
*
* Callback prototype for Eet_Descriptor_List_Next
- * @param l must be a pointer to the list
- * @return must be a pointer to the list
+ * @param l Must be a pointer to the list
+ * @return Must be a pointer to the list
*/
typedef void * (*Eet_Descriptor_List_Next_Callback)(void *l);
* @typedef (*Eet_Descriptor_List_Append_Callback)
*
* Callback prototype for Eet_Descriptor_List_Append
- * @param l must be a pointer to the list
- * @param d the data to append to the list
- * @return must be a pointer to the list
+ * @param l Must be a pointer to the list
+ * @param d The data to append to the list
+ * @return Must be a pointer to the list
*/
typedef void * (*Eet_Descriptor_List_Append_Callback)(void *l, void *d);
* @typedef (*Eet_Descriptor_List_Data_Callback)
*
* Callback prototype for Eet_Descriptor_List_Data
- * @param l must be a pointer to the list
- * @return must be a pointer to the list
+ * @param l Must be a pointer to the list
+ * @return Must be a pointer to the list
*/
typedef void * (*Eet_Descriptor_List_Data_Callback)(void *l);
* @typedef (*Eet_Descriptor_List_Free_Callback)
*
* Callback prototype for Eet_Descriptor_List_Free
- * @param l must be a pointer to the list to free
+ * @param l Must be a pointer to the list to free
*/
typedef void * (*Eet_Descriptor_List_Free_Callback)(void *l);
* @typedef (*Eet_Descriptor_Hash_Foreach_Callback)
*
* Callback for Eet_Descriptor_Hash_Foreach
- * @param h the hash
- * @param func the function callback to call on each iteration
- * @param fdt the data to pass to the callbac setted in param func
+ * @param h The hash
+ * @param func The function callback to call on each iteration
+ * @param fdt The data to pass to the callbac setted in param func
*/
typedef void (*Eet_Descriptor_Hash_Foreach_Callback)(void *h, Eet_Descriptor_Hash_Foreach_Callback_Callback func, void *fdt);
* @typedef (*Eet_Descriptor_Hash_Add_Callback)
*
* Callback prototype for Eet_Descriptor_Hash_Add
- * @param h the hash
- * @param k the key
- * @param d the data to associate with the 'k' key
+ * @param h The hash
+ * @param k The key
+ * @param d The data to associate with the 'k' key
*/
typedef void * (*Eet_Descriptor_Hash_Add_Callback)(void *h, const char *k, void *d);
* @typedef (*Eet_Descriptor_Hash_Free_Callback)
*
* Callback prototype for Eet_Descriptor_Hash_Free
- * @param h the hash to free
+ * @param h The hash to free
*/
typedef void (*Eet_Descriptor_Hash_Free_Callback)(void *h);
* @typedef (*Eet_Descriptor_Str_Alloc_Callback)
*
* Callback prototype for Eet_Descriptor_Str_Alloc
- * @param str the string to allocate
- * @return an allocated pointer to the string
+ * @param str The string to allocate
+ * @return An allocated pointer to the string
*/
typedef char * (*Eet_Descriptor_Str_Direct_Alloc_Callback)(const char *str);
* @typedef (*Eet_Descriptor_Str_Free_Callback)
*
* Callback prototype for Eet_Descriptor_Str_Free
- * @param str the string to free
+ * @param str The string to free
*/
typedef void (*Eet_Descriptor_Str_Direct_Free_Callback)(const char *str);
* @typedef (*Eet_Descriptor_Type_Get_Callback)
*
* Callback prototype for Eet_Descriptor_Type_Get
- * @param data data to pass to the callback
+ * @param data Data to pass to the callback
* @param unknow Eina_Bool __FIXME__
*/
typedef const char * (*Eet_Descriptor_Type_Get_Callback)(const void *data, Eina_Bool *unknow);
* @typedef (*Eet_Descriptor_Type_Set_Callback)
*
* Callback prototype for Eet_Descriptor_Type_Set
- * @param type the type to set
- * @param data to pass to the callback
+ * @param type The type to set
+ * @param data To pass to the callback
* @param unknow Eina_Bool __FIXME__
*/
typedef Eina_Bool (*Eet_Descriptor_Type_Set_Callback)(const char *type, void *data, Eina_Bool unknow);
/**
* @internal
*
- * Create a new empty data structure descriptor.
+ * @ingroup Eet_Data_Group
+ * @deprecated use eet_data_descriptor_stream_new() or
+ * eet_data_descriptor_file_new()
+ * @brief Creates a new empty data structure descriptor.
* @param name The string name of this data structure (most be a
* global constant and never change).
* @param size The size of the struct (in bytes).
* needed if you use those data types, else you can pass NULL instead.
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
- * @deprecated use eet_data_descriptor_stream_new() or
- * eet_data_descriptor_file_new()
*/
EINA_DEPRECATED EAPI Eet_Data_Descriptor *
eet_data_descriptor_new(const char *name,
eet_data_descriptor3_new(const Eet_Data_Descriptor_Class *eddc);
/**
+ * @ingroup Eet_Data_Group
* This function creates a new data descriptor and returns a handle to the
* new data descriptor. On creation it will be empty, containing no contents
* describing anything other than the shell of the data structure.
* and duplicated in memory.
*
* @since 1.2.3
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_data_descriptor_stream_new(const Eet_Data_Descriptor_Class *eddc);
/**
+ * @ingroup Eet_Data_Group
* This function creates a new data descriptor and returns a handle to the
* new data descriptor. On creation it will be empty, containing no contents
* describing anything other than the shell of the data structure.
* @endcode
*
* @since 1.2.3
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_data_descriptor_file_new(const Eet_Data_Descriptor_Class *eddc);
/**
+ * @ingroup Eet_Data_Group
* This function is an helper that set all the parameters of an
* Eet_Data_Descriptor_Class correctly when you use Eina data type
* with a stream.
* @param eddc_size The size of the Eet_Data_Descriptor_Class at the compilation time.
* @param name The name of the structure described by this class.
* @param size The size of the structure described by this class.
- * @return EINA_TRUE if the structure was correctly set (The only
+ * @return @c EINA_TRUE if the structure was correctly set (The only
* reason that could make it fail is if you did give wrong
* parameter).
*
* the EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET macro is recommended.
*
* @since 1.2.3
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int size);
/**
+ * @ingroup Eet_Data_Group
* This macro is an helper that set all the parameter of an
* Eet_Data_Descriptor_Class correctly when you use Eina data type
* with stream.
*
* @see eet_data_descriptor_stream_new
* @since 1.2.3
- * @ingroup Eet_Data_Group
*/
#define EET_EINA_STREAM_DATA_DESCRIPTOR_CLASS_SET(clas, type) \
(eet_eina_stream_data_descriptor_class_set(clas, sizeof (*(clas)), # type, sizeof(type)))
/**
+ * @ingroup Eet_Data_Group
* This function is an helper that set all the parameter of an
* Eet_Data_Descriptor_Class correctly when you use Eina data type
* with a file.
* @param eddc_size The size of the Eet_Data_Descriptor_Class at the compilation time.
* @param name The name of the structure described by this class.
* @param size The size of the structure described by this class.
- * @return EINA_TRUE if the structure was correctly set (The only
+ * @return @c EINA_TRUE if the structure was correctly set (The only
* reason that could make it fail is if you did give wrong
* parameter).
*
* the EET_EINA_FILE_DATA_DESCRIPTOR_CLASS_SET macro is recommended.
*
* @since 1.2.3
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int size);
/**
+ * @ingroup Eet_Data_Group
* This macro is an helper that set all the parameter of an
* Eet_Data_Descriptor_Class correctly when you use Eina data type
* with file.
* @param clas The Eet_Data_Descriptor_Class you want to set.
* @param type The type of the structure described by this class.
- * @return EINA_TRUE if the structure was correctly set (The only
+ * @return @c EINA_TRUE if the structure was correctly set (The only
* reason that could make it fail is if you did give wrong
* parameter).
*
* @see eet_data_descriptor_file_new
* @since 1.2.3
- * @ingroup Eet_Data_Group
*/
#define EET_EINA_FILE_DATA_DESCRIPTOR_CLASS_SET(clas, type) \
(eet_eina_file_data_descriptor_class_set(clas, sizeof (*(clas)), # type, sizeof(type)))
/**
- * This function frees a data descriptor when it is not needed anymore.
+ * @ingroup Eet_Data_Group
+ * @brief This function frees a data descriptor when it is not needed anymore.
* @param edd The data descriptor to free.
*
* This function takes a data descriptor handle as a parameter and frees all
* call the descriptor is no longer valid.
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_data_descriptor_free(Eet_Data_Descriptor *edd);
/**
- * This function returns the name of a data descriptor.
+ * @ingroup Eet_Data_Group
+ * @brief This function returns the name of a data descriptor.
*
* @since 1.8.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI const char *eet_data_descriptor_name_get(const Eet_Data_Descriptor *edd);
/**
- * This function is an internal used by macros.
+ * @ingroup Eet_Data_Group
+ * @brief This function is an internal used by macros.
*
* This function is used by macros EET_DATA_DESCRIPTOR_ADD_BASIC(),
* EET_DATA_DESCRIPTOR_ADD_SUB() and EET_DATA_DESCRIPTOR_ADD_LIST(). It is
* @param subtype If contains a subtype, then its data descriptor.
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Data_Descriptor *subtype);
/**
- * Read a data structure from an eet file and decodes it.
+ * @ingroup Eet_Data_Group
+ * @brief Reads a data structure from an eet file and decodes it.
* @param ef The eet file handle to read from.
* @param edd The data descriptor handle to use when decoding.
* @param name The key the data is stored under in the eet file.
* @see eet_data_read_cipher()
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *name);
/**
- * Write a data structure from memory and store in an eet file.
+ * @ingroup Eet_Data_Group
+ * @brief Writes a data structure from memory and store in an eet file.
* @param ef The eet file handle to write to.
* @param edd The data descriptor to use when encoding.
* @param name The key to store the data under in the eet file.
* @param data A pointer to the data structure to save and encode.
* @param compress Compression flags for storage.
- * @return bytes written on successful write, 0 on failure.
+ * @return bytes Written on successful write, @c 0 on failure.
*
* This function is the reverse of eet_data_read(), saving a data structure
* to an eet file. The file must have been opening in write mode and the data
* @see eet_data_write_cipher()
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
*
* Callback protoype for Eet_Dump
*
- * @param data to passe to the callback
- * @param str the string to dump
+ * @param data To passe to the callback
+ * @param str The string to dump
*
*/
typedef void (*Eet_Dump_Callback)(void *data, const char *str);
/**
- * Dump an eet encoded data structure into ascii text
+ * @ingroup Eet_Data_Group
+ * @brief Dumps an eet encoded data structure into ascii text
* @param data_in The pointer to the data to decode into a struct.
* @param size_in The size of the data pointed to in bytes.
* @param dumpfunc The function to call passed a string when new
* data is converted to text
* @param dumpdata The data to pass to the @p dumpfunc callback.
- * @return 1 on success, 0 on failure
+ * @return @c 1 on success, @c 0 on failure
*
* This function will take a chunk of data encoded by
* eet_data_descriptor_encode() and convert it into human readable
* int len;
* void *data;
*
- * f = fopen(file, "r");
+ * f = fopen(file, "rb");
* fseek(f, 0, SEEK_END);
* len = ftell(f);
* rewind(f);
* @see eet_data_text_dump_cipher()
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
void *dumpdata) EINA_ARG_NONNULL(3);
/**
- * Take an ascii encoding from eet_data_text_dump() and re-encode in binary.
+ * @ingroup Eet_Data_Group
+ * @brief Takes an ascii encoding from eet_data_text_dump() and re-encode in binary.
* @param text The pointer to the string data to parse and encode.
* @param textlen The size of the string in bytes (not including 0
* byte terminator).
* @see eet_data_text_undump_cipher()
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int *size_ret);
/**
- * Dump an eet encoded data structure from an eet file into ascii text
+ * @ingroup Eet_Data_Group
+ * @brief Dumps an eet encoded data structure from an eet file into ascii text.
* @param ef A valid eet file handle.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param dumpfunc The function to call passed a string when new
* data is converted to text
* @param dumpdata The data to pass to the @p dumpfunc callback.
- * @return 1 on success, 0 on failure
+ * @return @c 1 on success, @c 0 on failure
*
* This function will take an open and valid eet file from
* eet_open() request the data encoded by
* @see eet_data_dump_cipher()
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
void *dumpdata) EINA_ARG_NONNULL(3);
/**
- * Take an ascii encoding from eet_data_dump() and re-encode in binary.
+ * @ingroup Eet_Data_Group
+ * @brief Takes an ascii encoding from eet_data_dump() and re-encode in binary.
* @param ef A valid eet file handle.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param text The pointer to the string data to parse and encode.
* @param textlen The size of the string in bytes (not including 0
* byte terminator).
* @param compress Compression flags (1 == compress, 0 = don't compress).
- * @return 1 on success, 0 on failure
+ * @return @c 1 on success, @c 0 on failure
*
* This function will parse the string pointed to by @p text,
* encode it the same way eet_data_descriptor_encode() takes an
* @see eet_data_undump_cipher()
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int compress);
/**
- * Decode a data structure from an arbitrary location in memory.
- * @param edd The data descriptor to use when decoding.
+ * @ingroup Eet_Data_Group
+ * @brief Decodes a data structure from an arbitrary location in memory.
+ * @param edd The data descriptor to use when decoding.
* @param data_in The pointer to the data to decode into a struct.
* @param size_in The size of the data pointed to in bytes.
* @return NULL on failure, or a valid decoded struct pointer on success.
* @see eet_data_descriptor_decode_cipher()
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int size_in);
/**
- * Encode a dsata struct to memory and return that encoded data.
- * @param edd The data descriptor to use when encoding.
+ * @ingroup Eet_Data_Group
+ * @brief Encodes a dsata struct to memory and return that encoded data.
+ * @param edd The data descriptor to use when encoding.
* @param data_in The pointer to the struct to encode into data.
* @param size_ret pointer to the an int to be filled with the decoded size.
* @return NULL on failure, or a valid encoded data chunk on success.
* @see eet_data_descriptor_encode_cipher()
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int *size_ret);
/**
- * Add a basic data element to a data descriptor.
+ * @ingroup Eet_Data_Group
+ * @brief Adds a basic data element to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* EET_T_USHORT, EET_T_UINT, EET_T_ULONG_LONG or EET_T_STRING.
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_BASIC(edd, struct_type, name, member, type) \
do { \
} while(0)
/**
- * Add a sub-element type to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds a sub-element type to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* this element.
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_SUB(edd, struct_type, name, member, subtype) \
do { \
} while (0)
/**
- * Add a nested sub-element type to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds a nested sub-element type to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* All the parameters are the same as for EET_DATA_DESCRIPTOR_ADD_SUB().
*
* @since 1.8.0
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_SUB_NESTED(edd, struct_type, name, member, subtype) \
do { \
} while (0)
/**
- * Add a linked list type to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds a linked list type to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* element that is in each member of the linked list to be stored.
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_LIST(edd, struct_type, name, member, subtype) \
do { \
} while (0)
/**
- * Add a linked list of string to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds a linked list of string to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* parameters are the same as for EET_DATA_DESCRIPTOR_ADD_BASIC().
*
* @since 1.5.0
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_LIST_STRING(edd, struct_type, name, member) \
do { \
} while (0)
/**
- * Add a hash type to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds a hash type to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* The hash keys must be strings.
*
* @since 1.0.0
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_HASH(edd, struct_type, name, member, subtype) \
do { \
} while (0)
/**
- * Add a hash of string to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds a hash of string to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* parameters are the same as for EET_DATA_DESCRIPTOR_ADD_HASH().
*
* @since 1.3.4
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_HASH_STRING(edd, struct_type, name, member) \
do { \
} while (0)
/**
- * Add an array of basic data elements to a data descriptor.
+ * @ingroup Eet_Data_Group
+ * @brief Adds an array of basic data elements to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* struct containing it.
*
* @since 1.5.0
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_BASIC_ARRAY(edd, struct_type, name, member, type) \
do { \
} while(0)
/**
- * Add a variable array of basic data elements to a data descriptor.
+ * @ingroup Eet_Data_Group
+ * @brief Adds a variable array of basic data elements to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* is in.
*
* @since 1.6.0
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_BASIC_VAR_ARRAY(edd, struct_type, name, member, type) \
do { \
} while(0)
/**
- * Add a fixed size array type to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds a fixed size array type to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* struct containing it.
*
* @since 1.0.2
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_ARRAY(edd, struct_type, name, member, subtype) \
do { \
} while (0)
/**
- * Add a variable size array type to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds a variable size array type to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* is in.
*
* @since 1.0.2
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_VAR_ARRAY(edd, struct_type, name, member, subtype) \
do { \
} while (0)
/**
- * Add a variable size array type to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds a variable size array type to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* the parameters are the same as for EET_DATA_DESCRIPTOR_ADD_BASIC().
*
* @since 1.4.0
- * @ingroup Eet_Data_Group
*/
#define EET_DATA_DESCRIPTOR_ADD_VAR_ARRAY_STRING(edd, struct_type, name, member) \
do { \
} while (0)
/**
- * Add an union type to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds an union type to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* callback of unified_type should be defined.
*
* @since 1.2.4
- * @ingroup Eet_Data_Group
* @see Eet_Data_Descriptor_Class
*/
#define EET_DATA_DESCRIPTOR_ADD_UNION(edd, struct_type, name, member, type_member, unified_type) \
} while (0)
/**
- * Add a automatically selectable type to a data descriptor
+ * @ingroup Eet_Data_Group
+ * @brief Adds a automatically selectable type to a data descriptor.
* @param edd The data descriptor to add the type to.
* @param struct_type The type of the struct.
* @param name The string name to use to encode/decode this member
* given previously and telling it by setting unknow to EINA_TRUE.
*
* @since 1.2.4
- * @ingroup Eet_Data_Group
* @see Eet_Data_Descriptor_Class
*/
#define EET_DATA_DESCRIPTOR_ADD_VARIANT(edd, struct_type, name, member, type_member, unified_type) \
} while (0)
/**
- * Add a mapping to a data descriptor that will be used by union, variant or inherited type
+ * @ingroup Eet_Data_Group
+ * @brief Adds a mapping to a data descriptor that will be used by union, variant or inherited type.
* @param unified_type The data descriptor to add the mapping to.
* @param name The string name to get/set type.
* @param subtype The matching data descriptor.
*
* @since 1.2.4
- * @ingroup Eet_Data_Group
* @see Eet_Data_Descriptor_Class
*/
#define EET_DATA_DESCRIPTOR_ADD_MAPPING(unified_type, name, subtype) \
subtype)
/**
- * Add a mapping of a basic type to a data descriptor that will be used by a union type.
+ * @ingroup Eet_Data_Group
+ * @brief Adds a mapping of a basic type to a data descriptor that will be used by a union type.
* @param unified_type The data descriptor to add the mapping to.
* @param name The string name to get/set type.
* @param basic_type The matching basic type.
*
* @since 1.8
- * @ingroup Eet_Data_Group
* @see Eet_Data_Descriptor_Class
*/
#define EET_DATA_DESCRIPTOR_ADD_MAPPING_BASIC(unified_type, name, basic_type) \
NULL)
/**
* @defgroup Eet_Data_Cipher_Group Eet Data Serialization using A Ciphers
+ * @ingroup Eet_Data_Group
*
* Most of the @ref Eet_Data_Group have alternative versions that
* accounts for ciphers to protect their content.
*
* @see @ref Eet_Cipher_Group
*
- * @ingroup Eet_Data_Group
*/
/**
- * Read a data structure from an eet file and decodes it using a cipher.
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Reads a data structure from an eet file and decodes it using a cipher.
* @param ef The eet file handle to read from.
* @param edd The data descriptor handle to use when decoding.
* @param name The key the data is stored under in the eet file.
* @see eet_data_read()
*
* @since 1.0.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *cipher_key);
/**
- * Read a data structure from an eet file and decodes it into a buffer using a cipher,
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Reads a data structure from an eet file and decodes it into a buffer using a cipher.
* @param ef The eet file handle to read from.
* @param edd The data descriptor handle to use when decoding.
* @param name The key the data is stored under in the eet file.
* @param cipher_key The key to use as cipher.
* @param buffer Buffer.
* @param buffer_size The buffer size.
- * @return A pointer to buffer if successful and NULL on error.
+ * @return A pointer to buffer if successful, and NULL on error.
*
* This function decodes a data structure stored in an eet file, returning
* a pointer to it if it decoded successfully, or NULL on failure. This
* @see eet_data_read_cipher()
*
* @since 1.10.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int buffer_size);
/**
- * Read a data structure from an eet extended attribute and decodes it using a cipher.
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Reads a data structure from an eet extended attribute and decodes it using a cipher.
* @param filename The file to extract the extended attribute from.
* @param attribute The attribute to get the data from.
* @param edd The data descriptor handle to use when decoding.
* is as simple as a single function call.
*
* @since 1.5.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *cipher_key);
/**
- * Write a data structure from memory and store in an eet file
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Writes a data structure from memory and store in an eet file
* using a cipher.
* @param ef The eet file handle to write to.
* @param edd The data descriptor to use when encoding.
* to an eet file.
*
* @since 1.0.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int compress);
/**
- * Write a data structure from memory and store in an eet extended attribute
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Writes a data structure from memory and store in an eet extended attribute
* using a cipher.
* @param filename The file to write the extended attribute to.
* @param attribute The attribute to store the data to.
* to an eet extended attribute.
*
* @since 1.5.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eina_Xattr_Flags flags);
/**
- * Dump an eet encoded data structure into ascii text using a cipher.
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Dumps an eet encoded data structure into ascii text using a cipher.
* @param data_in The pointer to the data to decode into a struct.
* @param cipher_key The key to use as cipher.
* @param size_in The size of the data pointed to in bytes.
* @param dumpfunc The function to call passed a string when new
* data is converted to text
* @param dumpdata The data to pass to the @p dumpfunc callback.
- * @return 1 on success, 0 on failure
+ * @return @c 1 on success, @c 0 on failure
*
* This function will take a chunk of data encoded by
* eet_data_descriptor_encode() and convert it into human readable
* int len;
* void *data;
*
- * f = fopen(file, "r");
+ * f = fopen(file, "rb");
* fseek(f, 0, SEEK_END);
* len = ftell(f);
* rewind(f);
* @see eet_data_text_dump()
*
* @since 1.0.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
void *dumpdata) EINA_ARG_NONNULL(4);
/**
- * Take an ascii encoding from eet_data_text_dump() and re-encode
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Takes an ascii encoding from eet_data_text_dump() and re-encode
* in binary using a cipher.
* @param text The pointer to the string data to parse and encode.
* @param cipher_key The key to use as cipher.
* @see eet_data_text_undump()
*
* @since 1.0.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int *size_ret);
/**
- * Dump an eet encoded data structure from an eet file into ascii
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Dumps an eet encoded data structure from an eet file into ascii
* text using a cipher.
* @param ef A valid eet file handle.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param dumpfunc The function to call passed a string when new
* data is converted to text
* @param dumpdata The data to pass to the @p dumpfunc callback.
- * @return 1 on success, 0 on failure
+ * @return @c 1 on success, @c 0 on failure
*
* This function will take an open and valid eet file from
* eet_open() request the data encoded by
* @see eet_data_dump()
*
* @since 1.0.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
void *dumpdata) EINA_ARG_NONNULL(4);
/**
- * Take an ascii encoding from eet_data_dump() and re-encode in
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Takes an ascii encoding from eet_data_dump() and re-encode in
* binary using a cipher.
* @param ef A valid eet file handle.
* @param name Name of the entry. eg: "/base/file_i_want".
* @param textlen The size of the string in bytes (not including 0
* byte terminator).
* @param compress Compression flags (1 == compress, 0 = don't compress).
- * @return 1 on success, 0 on failure
+ * @return @c 1 on success, @c 0 on failure
*
* This function will parse the string pointed to by @p text,
* encode it the same way eet_data_descriptor_encode() takes an
* @see eet_data_undump()
*
* @since 1.0.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int compress);
/**
- * Decode a data structure from an arbitrary location in memory
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Decodes a data structure from an arbitrary location in memory
* using a cipher.
* @param edd The data descriptor to use when decoding.
* @param data_in The pointer to the data to decode into a struct.
* @see eet_data_descriptor_decode()
*
* @since 1.0.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int size_in);
/**
- * Encode a data struct to memory and return that encoded data
+ * @ingroup Eet_Data_Cipher_Group
+ * @brief Encodes a data struct to memory and return that encoded data
* using a cipher.
- * @param edd The data descriptor to use when encoding.
+ * @param edd The data descriptor to use when encoding.
* @param data_in The pointer to the struct to encode into data.
* @param cipher_key The key to use as cipher.
* @param size_ret pointer to the an int to be filled with the decoded size.
* @see eet_data_descriptor_encode()
*
* @since 1.0.0
- * @ingroup Eet_Data_Cipher_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
*/
/**
- * Create a new character node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new character node.
* @param name Name of the node.
* @param c Character value.
* @return A new character node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
char c);
/**
- * Create a new short node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new short node.
* @param name Name of the node.
- * @param s short value.
+ * @param s Short value.
* @return A new short node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
short s);
/**
- * Create a new integer node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new integer node.
* @param name Name of the node.
- * @param i integer value.
+ * @param i Integer value.
* @return A new integer node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
int i);
/**
- * Create a new long long integer node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new long long integer node.
* @param name Name of the node.
- * @param l long long integer value.
+ * @param l Long long integer value.
* @return A new long long integer node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
long long l);
/**
- * Create a new float node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new float node.
* @param name Name of the node.
- * @param f float value.
+ * @param f Float value.
* @return A new float node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
float f);
/**
- * Create a new double node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new double node.
* @param name Name of the node.
- * @param d double value.
+ * @param d Double value.
* @return A new double node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
double d);
/**
- * Create a new unsigned character node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new unsigned character node.
* @param name Name of the node.
- * @param uc unsigned char value.
+ * @param uc Unsigned char value.
* @return A new unsigned char node.
- * @ingroup Eet_Node_Group
+
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
unsigned char uc);
/**
- * Create a new unsigned short node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new unsigned short node.
* @param name Name of the node.
- * @param us unsigned short value.
+ * @param us Unsigned short value.
* @return A new unsigned short node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
unsigned short us);
/**
- * Create a new unsigned integer node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new unsigned integer node.
* @param name Name of the node.
- * @param ui unsigned integer value.
+ * @param ui Unsigned integer value.
* @return A new unsigned integer node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
unsigned int ui);
/**
- * Create a new unsigned long long integer node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new unsigned long long integer node.
* @param name Name of the node.
- * @param l unsigned long long integer value.
+ * @param l Unsigned long long integer value.
* @return A new unsigned long long integer node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
unsigned long long l);
/**
- * Create a new string node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new string node.
* @param name Name of the node.
- * @param str string value.
+ * @param str String value.
* @return A new string node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *str);
/**
- * Create a new inlined string node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new inlined string node.
* @param name Name of the node.
- * @param str string value.
+ * @param str String value.
* @return A new inlined string node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *str);
/**
- * Create a new empty node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new empty node.
* @param name Name of the node.
* @return A new empty node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
eet_node_null_new(const char *name);
/**
- * Create a new list node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new list node.
* @param name Name of the node.
- * @param nodes list of nodes.
+ * @param nodes List of nodes.
* @return A new list node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eina_List *nodes);
/**
- * Create a new array node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new array node.
* @param name Name of the node.
- * @param count number of nodes
- * @param nodes list of nodes.
+ * @param count Number of nodes
+ * @param nodes List of nodes.
* @return A new array node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eina_List *nodes);
/**
- * Create a new variable array node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new variable array node.
* @param name Name of the node.
- * @param nodes list of nodes.
+ * @param nodes List of nodes.
* @return A new variable array node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
* @ingroup Eet_Node_Group
*/
/**
- * Create a new short node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new short node.
* @param name Name of the node.
- * @param s short value.
+ * @param s Short value.
* @return A new short node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Node *node);
/**
- * Create a new struct node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new struct node.
* @param name Name of the node.
- * @param nodes list of nodes.
+ * @param nodes List of nodes.
* @return A new struct node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
* @ingroup Eet_Node_Group
*/
/**
- * Create a new short node.
+ * @ingroup Eet_Node_Group
+ * @brief Creates a new short node.
* @param name Name of the node.
- * @param s short value.
+ * @param s Short value.
* @return A new short node.
- * @ingroup Eet_Node_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
Eet_Node *child);
/**
- * @brief Get a node's child nodes
+ * @brief Gets a node's child nodes.
* @param node The node
* @return The first child node which contains a pointer to the
* next child node and the parent.
eet_node_children_get(Eet_Node *node);
/**
- * @brief Get the next node in a list of nodes
+ * @brief Gets the next node in a list of nodes.
* @param node The node
* @return A node which contains a pointer to the
* next child node and the parent.
eet_node_next_get(Eet_Node *node);
/**
- * @brief Get the parent node of a node
+ * @brief Gets the parent node of a node.
* @param node The node
* @return The parent node of @p node
* @since 1.5
eet_node_parent_get(Eet_Node *node);
/**
- * @brief Append a "list" node TODO FIX ME
* @ingroup Eet_Node_Group
+ * @brief Appends a "list" node TODO FIX ME.
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
void *dumpdata);
/**
- * @brief Return the type of a node
+ * @brief Returns the type of a node.
* @param node The node
* @return The node's type (EET_T_$TYPE)
* @since 1.5
eet_node_type_get(Eet_Node *node);
/**
- * @brief Return the node's data
+ * @brief Returns the node's data.
* @param node The node
* @return The data contained in the node
* @since 1.5
*
* Callback prototype for Eet_Node_Walk_Struct_Alloc
* @param type The allocation type
- * @param user_data the data passed by the user to the callback
+ * @param user_data The data passed by the user to the callback
*/
typedef void * (*Eet_Node_Walk_Struct_Alloc_Callback)(const char *type, void *user_data);
*
* Callback prototype for Eet_Node_Walk_Struct_Add
* @param parent The parent node
- * @param name the name for the new node
- * @param child the child node
- * @param user_data the data passed by the user to the callback
+ * @param name The name for the new node
+ * @param child The child node
+ * @param user_data The data passed by the user to the callback
*/
typedef void (*Eet_Node_Walk_Struct_Add_Callback)(void *parent, const char *name, void *child, void *user_data);
* @typedef (*Eet_Node_Walk_Array_Callback)
*
* Callback prototype for Eet_Node_Walk_Array
- * @param variable EINA_TRUE or EINA_FALSE
- * @param name a name
- * @param count a counter
- * @param user_data the data passed by the user to the callback
+ * @param variable @c EINA_TRUE or @c EINA_FALSE
+ * @param name A name
+ * @param count A counter
+ * @param user_data The data passed by the user to the callback
*/
typedef void * (*Eet_Node_Walk_Array_Callback)(Eina_Bool variable, const char *name, int count, void *user_data);
*/
/**
+ * @ingroup Eet_Connection_Group
* @typedef Eet_Connection
* Opaque handle to track paquet for a specific connection.
*
- * @ingroup Eet_Connection_Group
*/
typedef struct _Eet_Connection Eet_Connection;
/**
+ * @ingroup Eet_Connection_Group
* @typedef Eet_Read_Cb
* Called back when an @ref Eet_Data_Group has been received completely and could be used.
*
- * @ingroup Eet_Connection_Group
*/
typedef Eina_Bool Eet_Read_Cb (const void *eet_data, size_t size, void *user_data);
/**
+ * @ingroup Eet_Connection_Group
* @typedef Eet_Write_Cb
* Called back when a packet containing @ref Eet_Data_Group data is ready to be send.
*
- * @ingroup Eet_Connection_Group
*/
typedef Eina_Bool Eet_Write_Cb (const void *data, size_t size, void *user_data);
/**
- * Instanciate a new connection to track.
+ * @ingroup Eet_Connection_Group
+ * @brief Instanciates a new connection to track.
* @param eet_read_cb Function to call when one Eet_Data packet has been fully assemble.
* @param eet_write_cb Function to call when one Eet_Data packet is ready to be send over the wire.
* @param user_data Pointer provided to both functions to be used as a context handler.
- * @return NULL on failure, or a valid Eet_Connection handler.
+ * @return @c NULL on failure, or a valid Eet_Connection handler.
*
* For every connection to track you will need a separate Eet_Connection provider.
*
* @since 1.2.4
- * @ingroup Eet_Connection_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const void *user_data);
/**
- * Process a raw packet received over the link
+ * @ingroup Eet_Connection_Group
+ * @brief Processes a raw packet received over the link.
* @param conn Connection handler to track.
* @param data Raw data packet.
* @param size The size of that packet.
- * @return 0 on complete success, any other value indicate where in the stream it got wrong (It could be before that packet).
+ * @return @c 0 on complete success, any other value indicate where in the stream it got wrong (It could be before that packet).
*
* Every time you receive a packet related to your connection, you should pass
* it to that function so that it could process and assemble packet has you
* receive it. It will automatically call Eet_Read_Cb when one is fully received.
*
* @since 1.2.4
- * @ingroup Eet_Connection_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
size_t size);
/**
- * Tell if the Eet_Connection as received some partial data.
+ * @ingroup Eet_Connection_Group
+ * @brief Tells if the Eet_Connection as received some partial data.
* @param conn Connection handler to request.
- * @return EINA_TRUE if there is some data pending inside, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if there is some data pending inside, @c EINA_FALSE otherwise.
*
* Eet_Connection buffer data until the received data can be unserialized correctly. This
* function let you know if there is some data inside that buffer waiting for more data to
* be received before being processed.
*
* @since 1.7
- * @ingroup Eet_Connection_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
EAPI Eina_Bool eet_connection_empty(Eet_Connection *conn);
/**
- * Convert a complex structure and prepare it to be send.
+ * @ingroup Eet_Connection_Group
+ * @brief Converts a complex structure and prepare it to be send.
* @param conn Connection handler to track.
* @param edd The data descriptor to use when encoding.
* @param data_in The pointer to the struct to encode into data.
* @param cipher_key The key to use as cipher.
- * @return EINA_TRUE if the data where correctly send, EINA_FALSE if they don't.
+ * @return @c EINA_TRUE if the data where correctly send, @c EINA_FALSE if they don't.
*
* This function serialize data_in with edd, assemble the packet and call
* Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary allocated
* @see eet_data_descriptor_encode_cipher
*
* @since 1.2.4
- * @ingroup Eet_Connection_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *cipher_key);
/**
- * Convert a Eet_Node tree and prepare it to be send.
+ * @ingroup Eet_Connection_Group
+ * @brief Converts a Eet_Node tree and prepare it to be send.
* @param conn Connection handler to track.
* @param node The data tree to use when encoding.
* @param cipher_key The key to use as cipher.
- * @return EINA_TRUE if the data where correctly send, EINA_FALSE if they don't.
+ * @return @c EINA_TRUE if the data where correctly send, @c EINA_FALSE if they don't.
*
* This function serialize node, assemble the packet and call
* Eet_Write_Cb when ready. The data passed Eet_Write_Cb are temporary allocated
* @see eet_data_node_encode_cipher
*
* @since 1.2.4
- * @ingroup Eet_Connection_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0
const char *cipher_key);
/**
- * Close a connection and lost its track.
+ * @ingroup Eet_Connection_Group
+ * @brief Closes a connection and lost its track.
* @param conn Connection handler to close.
* @param on_going Signal if a partial packet wasn't completed.
* @return the user_data passed to both callback.
*
* @since 1.2.4
- * @ingroup Eet_Connection_Group
*
* @if MOBILE @since_tizen 3.0
* @elseif WEARABLE @since_tizen 3.0