# endif
#endif
+/**
+ * Compression type for the image.
+ *
+ * @ref edcref
+ */
typedef enum _Edje_Edit_Image_Comp
{
EDJE_EDIT_IMAGE_COMP_RAW,
EDJE_EDIT_IMAGE_COMP_LOSSY_ETC2
} Edje_Edit_Image_Comp;
+/**
+ * Mode for a textblock part.
+ *
+ * @ref edcref
+ */
typedef enum _Edje_Edit_Select_Mode
{
EDJE_EDIT_SELECT_MODE_DEFAULT,
EDJE_EDIT_SELECT_MODE_EXPLICIT
} Edje_Edit_Select_Mode;
+/**
+ * Sound type compression.
+ *
+ * @ref edcref
+ */
typedef enum _Edje_Edit_Sound_Comp
{
EDJE_EDIT_SOUND_COMP_NONE,
EDJE_EDIT_SOUND_COMP_AS_IS
} Edje_Edit_Sound_Comp;
+/**
+ * Mode for a textblock part.
+ *
+ * @ref edcref
+ */
typedef enum _Edje_Edit_Entry_Mode
{
EDJE_EDIT_ENTRY_MODE_NONE,
EDJE_EDIT_ENTRY_MODE_PASSWORD
} Edje_Edit_Entry_Mode;
+/**
+ * @typedef Edje_Edit_Script_Error
+ *
+ * This is structure used for the list of errors that resulted from the last
+ * attempt to rebuild the Embryo script for the edited group.
+ *
+ * @see edje_edit_script_error_list_get()
+ */
struct _Edje_Edit_Script_Error
{
- const char *program_name; /* null == group shared script */
- int line;
- const char *error_str;
+ const char *program_name; /**< name of the script, if null then it is group shared script */
+ int line; /**< Line of the error inside in scriptcode */
+ const char *error_str; /**< Error Message */
};
typedef struct _Edje_Edit_Script_Error Edje_Edit_Script_Error;
+/**
+ * @typedef Edje_Part_Image_Use
+ *
+ * This is structure used for the list of group-part-state triplets where certain
+ * image is being used and pointed.
+ *
+ * @see edje_edit_image_usage_list_get()
+ * @see edje_edit_image_usage_list_free()
+ */
struct _Edje_Part_Image_Use
{
- const char *group;
- const char *part;
+ const char *group; /**< name of group that use image */
+ const char *part; /**< name of part that use image */
struct {
- const char *name;
- double value;
- } state;
+ const char *name; /**< name of the state */
+ double value; /**< value of the state */
+ } state; /**< structure that contain state's information */
};
typedef struct _Edje_Part_Image_Use Edje_Part_Image_Use;
+/**
+ * @typedef Edje_Edit_Limit
+ *
+ * This is structure used for list with the item names inside the limits block.
+ *
+ * @see edje_edit_group_limits_vertical_list_get()
+ * @see edje_edit_group_limits_horizontal_list_get()
+ * @see edje_edit_group_limits_vertical_del()
+ * @see edje_edit_group_limits_horizontal_del()
+ * @see edje_edit_group_limits_vertical_add()
+ * @see edje_edit_group_limits_horizontal_add()
+ * @see edje_edit_limits_list_free()
+ */
struct _Edje_Edit_Limit
{
- Eina_Stringshare *name;
- int value;
+ Eina_Stringshare *name; /**< name of the limit */
+ int value; /**< value of the limit */
};
typedef struct _Edje_Edit_Limit Edje_Edit_Limit;
*
* @param obj Object to save back to the file it was loaded from.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*
* @todo Add a way to check what the error actually was, the way Edje Load does.
*/
*
* @param obj Object to save.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*
* @see edje_edit_save()
*/
* @param new_file_name Where to save object. File should not exist, otherwise
* EINA_FALSE will be returned.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*
* @see edje_edit_save()
*/
/** Save 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 @edje_edit_save and @edje_edit_save_all,
+ * 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.
*
* @note With using this function all source code will be erased. And DOES NOT
* generated new code. In attempt to decompile edj file, wich was saved with
* using this functions will unpacked only resources(like fonts, images, sounds).
- * If needed saving source code into file, please use @edje_edit_save or
- * @edje_edit_save_all.
+ * If needed saving source code into file, please use @see edje_edit_save() or
+ * @see edje_edit_save_all().
* @param obj Object to save back to the file it was loaded from.
* @param current_group EINA_TRUE if needed save only group which loaded with obj,
* or EINA_FALSE for save all groups, which exists in edj file.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool
* @param obj The pointer to edje object.
* @param name The name of the group.
*
- * @return EINA_TRUE If it could allocate memory to the part group added
+ * @return @c EINA_TRUE If it could allocate memory to the part group added
* or zero if not.
*
* This function adds, at run time, one more group, which will reside
* @param obj Object being edited.
* @param group Group name to check for.
*
- * @return EINA_TRUE if group exists, EINA_FALSE if not.
+ * @return @c EINA_TRUE if group exists, @c EINA_FALSE if not.
*/
EAPI Eina_Bool edje_edit_group_exist(Evas_Object *obj, const char *group);
* @param obj Object being edited.
* @param new_name New name for the group.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_name_set(Evas_Object *obj, const char *new_name);
* @param obj Object being edited.
* @param w New minimum width for the group.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_min_w_set(Evas_Object *obj, int w);
* @param obj Object being edited.
* @param h New minimum height for the group.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_min_h_set(Evas_Object *obj, int h);
* @param obj Object being edited.
* @param w New maximum width for the group.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_max_w_set(Evas_Object *obj, int w);
* @param obj Object being edited.
* @param h New maximum height for the group.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_max_h_set(Evas_Object *obj, int h);
*
* @param obj Object being edited.
*
- * @return EINA_FALSE if group not accept broadcast signal, EINA_TRUE otherwise (Default to true since 1.1.).
+ * @return @c EINA_FALSE if group not accept broadcast signal, @c EINA_TRUE otherwise (Default to true since 1.1.).
* @since 1.11
*/
EAPI Eina_Bool edje_edit_group_broadcast_signal_get(Evas_Object *obj);
/** Set the group broadcast signal.
*
* @param obj Object being edited.
- * @param bs EINA_TRUE if group will accept broadcast signal, EINA_FALSE otherwise.
+ * @param bs @c EINA_TRUE if group will accept broadcast signal, @c EINA_FALSE otherwise.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_group_broadcast_signal_set(Evas_Object *obj, Eina_Bool bs);
* @param obj Object being edited.
* @param alias_name Group name that is alias.
*
- * @return EINA_TRUE if alias, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if alias, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_alias_is(Evas_Object *obj, const char *alias_name);
* @param group_name Group name that is being aliased.
* @param alias_name Group name that is alias.
*
- * @return EINA_TRUE if success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_alias_add(Evas_Object *obj, const char *group_name, const char *alias_name);
* @param itemname Name for the new data entry.
* @param value Value for the new data entry.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_data_add(Evas_Object *obj, const char *itemname, const char *value);
* @param obj Object being edited.
* @param itemname Data entry to remove from the global data block.
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_data_del(Evas_Object *obj, const char *itemname);
* @param itemname Name of data entry to change the value.
* @param value New value for the entry.
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_data_value_set(Evas_Object *obj, const char *itemname, const char *value);
* @param itemname Data entry to rename.
* @param newname New name for the data entry.
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_data_name_set(Evas_Object *obj, const char *itemname, const char *newname);
* @param itemname Name for the new data entry.
* @param value Value for the new data entry.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_data_add(Evas_Object *obj, const char *itemname, const char *value);
* @param obj Object being edited.
* @param itemname Name of the data entry to remove.
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_data_del(Evas_Object *obj, const char *itemname);
* @param itemname Name of the data entry to set the value.
* @param value Value to set for the data entry.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_data_value_set(Evas_Object *obj, const char *itemname, const char *value);
* @param itemname Name of the data entry to rename.
* @param newname New name for the data entry.
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_group_data_name_set(Evas_Object *obj, const char *itemname, const char *newname);
* @param obj Object being edited.
* @param name Name for the new color class.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_color_class_add(Evas_Object *obj, const char *name);
* @param obj Object being edited.
* @param name Color class to delete.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_color_class_del(Evas_Object *obj, const char *name);
* @param b3 Blue component of tertiary color.
* @param a3 Alpha component of tertiary color.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param b3 Blue component of tertiary color.
* @param a3 Alpha component of tertiary color.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param name Color class to rename.
* @param newname New name for the color class.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_color_class_name_set(Evas_Object *obj, const char *name, const char *newname);
* @param obj Object being edited.
* @param style Name for the new style.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_add(Evas_Object *obj, const char *style);
* @param obj Object being edited.
* @param style Style to delete.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_del(Evas_Object *obj, const char *style);
* @param tag Name of the tag to set the value for.
* @param new_value Value for the tag.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_tag_value_set(Evas_Object *obj, const char *style, const char *tag, const char *new_value);
* @param tag Tag to rename.
* @param new_name New name for the tag.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_tag_name_set(Evas_Object *obj, const char *style, const char *tag, const char *new_name);
* @param style Style where to add the new tag.
* @param tag_name Name for the new tag.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_tag_add(Evas_Object *obj, const char *style, const char *tag_name);
* @param style Style from where to remove the tag.
* @param tag Tag to delete.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_style_tag_del(Evas_Object *obj, const char *style, const char *tag);
* @param obj Object being edited.
* @param external Name of the external module to add to the list of autoload.
*
- * @return EINA_TRUE on success (or it was already there), EINA_FALSE otherwise.
+ * @return @c EINA_TRUE on success (or it was already there), @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_external_add(Evas_Object *obj, const char *external);
* @param obj Object being edited.
* @param external Name of the external module to remove from the autoload list.
*
- * @return EINA_TRUE on success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_external_del(Evas_Object *obj, const char *external);
* @param mode One of possible enum Edje_Edit_Select_Mode:
* EDJE_EDIT_SELECT_MODE_DEFAULT, EDJE_EDIT_SELECT_MODE_EXPLICIT.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool
* @param mode One of possible enum Edje_Entry_Mode:
* EDJE_EDIT_ENTRY_MODE_NONE, EDJE_EDIT_ENTRY_MODE_PLAIN, EDJE_EDIT_ENTRY_MODE_EDITABLE, EDJE_EDIT_ENTRY_MODE_PASSWORD.
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool
* @param name Name for the new part.
* @param type Type of the new part. See @ref edcref for more info on this.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_add(Evas_Object *obj, const char *name, Edje_Part_Type type);
* @param name Name for the new part.
* @param source The registered external type to use for this part.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_external_add(Evas_Object *obj, const char *name, const char *source);
* @param obj Object being edited.
* @param part Name of part to delete.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_del(Evas_Object *obj, const char *part);
* @param part Name of the part.
* @param new_copy Name of the new copied part.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_copy(Evas_Object *obj, const char *part, const char *new_copy);
* @param obj Object being edited.
* @param part Name of part to check for its existence.
*
- * @return EINA_TRUE if the part exists, EINA_FALSE if not.
+ * @return @c EINA_TRUE if the part exists, @c EINA_FALSE if not.
*/
EAPI Eina_Bool edje_edit_part_exist(Evas_Object *obj, const char *part);
* @param obj Object being edited.
* @param part Name of part to move one step below.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_restack_below(Evas_Object *obj, const char *part);
* @param part Name of part which will be moved.
* @param below Name of part for which will be moved 'part'.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_part_restack_part_below(Evas_Object *obj, const char* part, const char *below);
* @param obj Object being edited.
* @param part Name of part to move one step above.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_restack_above(Evas_Object *obj, const char *part);
* @param part Name of part which will be moved.
* @param above Name of part for which will be moved 'part'.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_part_restack_part_above(Evas_Object *obj, const char* part, const char *above);
* @param part Name of part to rename.
* @param new_name New name for the given part.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_name_set(Evas_Object *obj, const char *part, const char *new_name);
* @param part Name of the part.
* @param name New name for the api property.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_api_name_set(Evas_Object *obj, const char *part, const char *name);
* @param part Name of part.
* @param description New description for the api property.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_api_description_set(Evas_Object *obj, const char *part, const char *description);
* @param part Part to set the clipper to.
* @param clip_to Part to use as clipper, if NULL then the clipping value will be cancelled (unset clipping).
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_clip_to_set(Evas_Object *obj, const char *part, const char *clip_to);
* @param part Part to set the source of.
* @param source Value for the source parameter.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*
* @see edje_edit_part_source_get()
*
* @param part Part to set the source of.
* @param source Value for the source parameter.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*
* @see edje_edit_part_source2_get()
* @since 1.11
* @param part Part to set the source of.
* @param source Value for the source parameter.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*
* @see edje_edit_part_source3_get()
* @since 1.11
* @param part Part to set the source of.
* @param source Value for the source parameter.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*
* @see edje_edit_part_source4_get()
* @since 1.11
* @param part Part to set the source of.
* @param source Value for the source parameter.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*
* @see edje_edit_part_source5_get()
* @since 1.11
* @param part Part to set the source of.
* @param source Value for the source parameter.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*
* @see edje_edit_part_source6_get()
* @since 1.11
* @param part Part to set the effect to. Only makes sense on type TEXT.
* @param effect Effect to set for the part.
*
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
+ *
* @see Edje_Part_Text
*/
EAPI Eina_Bool edje_edit_part_effect_set(Evas_Object *obj, const char *part, Edje_Text_Effect effect);
* @param state Name of the state to set.
* @param value Value of the state.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_selected_state_set(Evas_Object *obj, const char *part, const char *state, double value);
* @param obj Object being edited.
* @param part Part to get if the mouse events is accepted.
*
- * @return EINA_TRUE if part will accept mouse events, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if part will accept mouse events, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_mouse_events_get(Evas_Object *obj, const char *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, EINA_FALSE otherwise.
+ * @param mouse_events EINA_TRUE if part will accept mouse events, @c EINA_FALSE otherwise.
*
- * @return EINA_TRUE if successful, 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);
* @param obj Object being edited.
* @param part Part to get if it will pass all events to the other parts.
*
- * @return EINA_TRUE if the events received will propagate to other parts, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if the events received will propagate to other parts, @c EINA_FALSE otherwise
*/
EAPI Eina_Bool edje_edit_part_repeat_events_get(Evas_Object *obj, const char *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, EINA_FALSE otherwise
+ * @param repeat_events EINA_TRUE if the events received will propagate to other parts, @c EINA_FALSE otherwise
*
- * @return EINA_TRUE if successful, 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);
* @param obj Object being edited.
* @param part Part to get if editing multiple lines for text or textblock part is enabled.
*
- * @return EINA_TRUE if multiple lines for editing is enabled, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if multiple lines for editing is enabled, @c EINA_FALSE otherwise
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_multiline_get(Evas_Object *obj, const char *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, EINA_FALSE otherwise
+ * @param multiline EINA_TRUE if multiple lines for editing is enabled, @c EINA_FALSE otherwise
*
- * @return EINA_TRUE if successful, 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);
* @param obj Object being edited.
* @param part Part to get if it will enable point collision detection for the part.
*
- * @return EINA_TRUE if point collision detection for the part is enabled, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if point collision detection for the part is enabled, @c EINA_FALSE otherwise
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_precise_is_inside_get(Evas_Object *obj, const char *part);
*
* @param obj Object being edited.
* @param part Part to set if it will enable point collision detection for the part.
- * @param precise_is_inside EINA_TRUE if point collision detection for the part is enabled, EINA_FALSE otherwise
+ * @param precise_is_inside EINA_TRUE if point collision detection for the part is enabled, @c EINA_FALSE otherwise
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_precise_is_inside_set(Evas_Object *obj, const char *part, Eina_Bool precise_is_inside);
* @param obj Object being edited.
* @param part Part to get if it uses accessibility feature.
*
- * @return EINA_TRUE if part uses accessibility feature, EINA_FALSE otherwise
+ * @return @c EINA_TRUE if part uses accessibility feature, @c EINA_FALSE otherwise
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_access_get(Evas_Object *obj, const char *part);
*
* @param obj Object being edited.
* @param part Part to set if it uses accessibility feature.
- * @param access EINA_TRUE if part uses accessibility feature, EINA_FALSE otherwise
+ * @param access EINA_TRUE if part uses accessibility feature, @c EINA_FALSE otherwise
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_access_set(Evas_Object *obj, const char *part, Eina_Bool access);
* @param part Part to set which event flags will be ignored.
* @param ignore_flags The Event flags to be ignored by the part.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_ignore_flags_set(Evas_Object *obj, const char *part, Evas_Event_Flags ignore_flags);
* @param part Part name to get it's pointer_mode.
* @param pointer_mode Pointer Mode.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_pointer_mode_set(Evas_Object *obj, const char *part, Evas_Object_Pointer_Mode pointer_mode);
*
* @param obj Object being edited.
* @param part Part name to get it's pointer_mode.
- * @param pointer_mode Pointer Mode.
+ * @param cursor_mode Pointer Mode.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_cursor_mode_set(Evas_Object *obj, const char *part, unsigned char cursor_mode);
* @param part Part to set scale for.
* @param scale Scale value to set.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_scale_set(Evas_Object *obj, const char *part, Eina_Bool scale);
* @param part Part to set if should be dragged horizontally.
* @param drag 1 (or -1) if the part should be dragged horizontally, 0 otherwise.
*
- * @return EINA_TRUE if successful, EINA_FALSE 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);
* @param part Part to set if should be dragged vertically.
* @param drag 1 (or -1) of the part shpuld be dragged vertically, 0 otherwise.
*
- * @return EINA_TRUE if successful, EINA_FALSE 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);
* @param part Part to set the drag horizontal step value.
* @param step The step the will be dragged.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_step_x_set(Evas_Object *obj, const char *part, int step);
* @param part Part to set the drag vertical step value.
* @param step The step the will be dragged.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_step_y_set(Evas_Object *obj, const char *part, int step);
*
* @param obj Object being edited.
* @param part Part to get the drag horizontal count value.
+ *
+ * @return horizontal dragable count value
*/
EAPI int edje_edit_part_drag_count_x_get(Evas_Object *obj, const char *part);
* @param part Part to set the drag horizontal count value.
* @param count The count value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_count_x_set(Evas_Object *obj, const char *part, int count);
*
* @param obj Object being edited.
* @param part Part to get the drag vertical count value.
+ *
+ * @return vertical dragable count value
*/
EAPI int edje_edit_part_drag_count_y_get(Evas_Object *obj, const char *part);
* @param part Part to set the drag vertical count value.
* @param count The count value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_count_y_set(Evas_Object *obj, const char *part, int count);
* @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.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @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);
* @param part Part to set the name that will receive events from the given draggies.
* @param event The name of the part that will receive events, or NULL to unset.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_event_set(Evas_Object *obj, const char *part, const char *event);
*
* @param obj Object being edited.
* @param part Part to set the name that is used as 'threshold' for the given draggies.
- * @param confine 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 EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_part_drag_threshold_set(Evas_Object *obj, const char *part, const char *threshold);
+//@}
+/******************************************************************************/
+/************************** BOX & TABLE ITEMS API *************************/
+/******************************************************************************/
+/** @name Items API
+ * Functions to deal with table and box part's items (see @ref edcref).
+ */ //@{
+
/** Append new item to box or table part.
*
* @param obj Object being edited.
* @param item_name Name of new item that is not exist in BOX or TABLE yet.
* @param source_group Source (means group name) of the new item
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_append(Evas_Object *obj, const char *part, const char *item_name, const char *source_group);
/** Get 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.
*
* @return A List containing all part items names found in the edje file.
* @since 1.11
*
* @param obj Object being edited.
* @param part Part to delete exist item. This part should have BOX or TABLE type.
- * @param item_name Name of exist item to delete it from BOX or TABLE.
+ * @param name Name of exist item to delete it from BOX or TABLE.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_del(Evas_Object *obj, const char *part, const char* name);
* @param item_name Name of item.
* @param source_group New gorup name.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_source_set(Evas_Object *obj, const char *part, const char *item_name, const char *source_group);
* @param item The name of the item to set minimum width.
* @param min_w Minimum width value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_min_w_set(Evas_Object *obj, const char *part, const char *item, int min_w);
* @param item The name of the item to set minimum height.
* @param min_h Minimum height value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_min_h_set(Evas_Object *obj, const char *part, const char *item, int min_h);
* @param item The name of the item to set maximum width.
* @param max_w Maximum width value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_max_w_set(Evas_Object *obj, const char *part, const char *item, int max_w);
* @param item The name of the item to set maximum height.
* @param max_h Maximum height value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_max_h_set(Evas_Object *obj, const char *part, const char *item, int max_h);
* @param obj Object being edited.
* @param part Part that contain state.
* @param item The name of the item to set aspect width.
- * @param aspect_w Maximum width value.
+ * @param aspect_w Aspect width value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_aspect_w_set(Evas_Object *obj, const char *part, const char *item, int aspect_w);
* @param obj Object being edited.
* @param part Part that contain state.
* @param item The name of the item to set aspect height.
- * @param max_h Maximum height value.
+ * @param aspect_h Aspect height value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_aspect_h_set(Evas_Object *obj, const char *part, const char *item, int aspect_h);
* @param item The name of the item to set aspect mode.
* @param mode One of possible enum from Edje_Aspect_Control:
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool
* @param obj Object being edited.
* @param part Part that contain state.
* @param item The name of the item to set prefer width.
- * @param prefer_w Maximum width value.
+ * @param prefer_w Prefer width value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_prefer_w_set(Evas_Object *obj, const char *part, const char *item, int prefer_w);
* @param obj Object being edited.
* @param part Part that contain state.
* @param item The name of the item to set prefer height.
- * @param max_h Maximum height value.
+ * @param prefer_h Prefer height value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_prefer_h_set(Evas_Object *obj, const char *part, const char *item, int prefer_h);
* @param t A pointer to store the top padding value.
* @param b A pointer to store the bottom padding value.
*
- * @return EINA_TRUE If successfull, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
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);
* @param t Value of the top padding.
* @param b Value of the bottom padding.
*
- * @return EINA_TRUE If successfull, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
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);
* @param item The name of the item to set horizontal align value.
* @param align_x New value of the horizontal align.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_align_x_set(Evas_Object *obj, const char *part, const char *item, double align_x);
* @param item The name of the item to set vertical align value.
* @param align_y New value of the vertical align.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_part_item_align_y_set(Evas_Object *obj, const char *part, const char *item, double align_y);
* @param new_name The new name for the state.
* @param new_value The new value for the state.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param name Name for the new state (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE if successfully, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if successfully, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_add(Evas_Object *obj, const char *part, const char *name, double value);
* @param state The current name of the state (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE if successfully, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if successfully, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_del(Evas_Object *obj, const char *part, const char *state, double value);
* @param state The name of the state to check (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE if the part state exist, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the part state exist, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_exist(Evas_Object *obj, const char *part, const char *state, double value);
* @param to State to copy into (not including state value).
* @param val_to The value of the state to copy into.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param value The state value.
* @param x The new 'rel1 relative X' value to set'.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel1_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
* @param value The state value.
* @param y The new 'rel1 relative Y' value to set'.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel1_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
* @param value The state value.
* @param x The new 'rel2 relative X' value to set'.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel2_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
* @param value The state value.
* @param y The new 'rel2 relative Y' value to set'.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel2_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
* @param value The state value.
* @param x The new 'rel1 offset X' value to set'.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel1_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, int x);
* @param value The state value.
* @param y The new 'rel1 offset Y' value to set'.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel1_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, int y);
* @param value The state value.
* @param x The new 'rel2 offset X' value to set'.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel2_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, int x);
* @param value The state value.
* @param y The new 'rel2 offset Y' value to set'.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_rel2_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, int y);
* @param value The state value.
* @param rel_to The name of the part that is used as container/parent (NULL make the part relative to the whole interface).
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param value The state value.
* @param rel_to The name of the part that is used as container/parent (NULL make the part relative to the whole interface).
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param value The state value.
* @param rel_to The name of the part that is used as container/parent (NULL make the part relative to the whole interface).
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param value The state value.
* @param rel_to The name of the part that is used as container/parent (NULL make the part relative to the whole interface).
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param b The blue value of the color.
* @param a The alpha value of the color.
*
- * @return EINA_TRUE If successfull, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param b The blue value of the color.
* @param a The alpha value of the color.
*
- * @return EINA_TRUE If successfull, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param b The blue value of the color.
* @param a The alpha value of the color.
*
- * @return EINA_TRUE If successfull, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param value The state value.
* @param align The new vertical align value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_align_x_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
* @param value The state value.
* @param align The new vertical align value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_align_y_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
* @param value The state value.
* @param min_w Minimum width value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_min_w_set(Evas_Object *obj, const char *part, const char *state, double value, int min_w);
* @param value The state value.
* @param min_h Minimum height value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_min_h_set(Evas_Object *obj, const char *part, const char *state, double value, int min_h);
* @param value The state value.
* @param max_w Maximum width value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_max_w_set(Evas_Object *obj, const char *part, const char *state, double value, int max_w);
* @param value The state value.
* @param max_h Maximum height value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_max_h_set(Evas_Object *obj, const char *part, const char *state, double value, int max_h);
* @param value The state value.
* @param minmul_w Multiplier width value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_state_minmul_w_set(Evas_Object *obj, const char *part, const char *state, double value, double minmul_w);
* @param value The state value.
* @param minmul_h Multiplier height value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_state_minmul_h_set(Evas_Object *obj, const char *part, const char *state, double value, double minmul_h);
* @param value The state value.
* @param fixed Fixed width value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fixed_w_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool fixed);
* @param value The state value.
* @param fixed Fixed height value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fixed_h_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool fixed);
* @param value The state value.
* @param aspect Minimum aspect value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_aspect_min_set(Evas_Object *obj, const char *part, const char *state, double value, double aspect);
* @param value The state value.
* @param aspect Maximum aspect value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_aspect_max_set(Evas_Object *obj, const char *part, const char *state, double value, double aspect);
* @param pref The aspect preference to set (0 = None, 1 = Vertical, 2
* = Horizontal, 3 = Both)
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_aspect_pref_set(Evas_Object *obj, const char *part, const char *state, double value, unsigned char pref);
* @param value The state value.
* @param smooth The smooth value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_state_fill_smooth_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool smooth);
/** Set the fill type property for given part state.
*
- * Sets the image fill type. The available types are:
+ * Sets the image fill type. The available types are:
* <dl>
* <dt>SCALE</dt>
* <dd>image will be scaled accordingly to the 'relative' and 'offset' params values from 'origin' and 'size' blocks.</dd>
* <dd>image will be tiled accordingly to the 'relative' and 'offset' params values from 'origin' and 'size' blocks.</dd>
* </dl>
* <b>Important</b>: the part parameter 'min' must be set, it's size of tiled image.
- * If parameter 'max' is set tiled area will be resized accordingly to the 'max' values of part.
+ * If parameter 'max' is set tiled area will be resized accordingly to the 'max' values of part.
* The default value of fill type is SCALE.
*
* @param obj Object being edited.
* @param value The state value.
* @param fill_type The value that represents fill type: 0 for SCALE or 1 for TILE.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @see edje_edit_state_fill_type_get()
* @since 1.11
*/
* @param value The state value.
* @param x The fill horizontal origin value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
* @param value The state value.
* @param y The fill vertical origin value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
* @param value The state value.
* @param x The fill horizontal origin offset value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
* @param value The state value.
* @param y The fill vertical origin offset value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_origin_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
* @param value The state value.
* @param x The horizontal size relative value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_size_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
* @param value The state value.
* @param x The vertical size relative value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_size_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
* @param value The state value.
* @param x The horizontal size offset value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_size_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, double x);
* @param value The state value.
* @param y The vertical size offset value.
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_fill_size_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, double y);
* @param state The name of the state to get visibility (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE if the state is visible, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the state is visible, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_visible_get(Evas_Object *obj, const char *part, const char *state, double value);
* @param part Part that contain state.
* @param state The name of the state to set visibility (not including the state value).
* @param value The state value.
- * @param visible To set state visible (EINA_TRUE if the state is visible, EINA_FALSE otherwise)
+ * @param visible To set state visible (EINA_TRUE if the state is visible, @c EINA_FALSE otherwise)
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_visible_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool visible);
* @param value The state value.
* @param color_class The color class to assign.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_color_class_set(Evas_Object *obj, const char *part, const char *state, double value, const char *color_class);
* @param type The type of the parameter will be stored here.
* @param val Pointer to value will be stored here - DO NOT FREE IT!
*
- * @return EINA_TRUE if the parameter was found, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the parameter was found, @c EINA_FALSE otherwise.
*/
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);
* @param param The name of the paramter.
* @param val The value of the parameter.
*
- * @return EINA_TRUE if successful. EINA_FALSE if not found or is of different type.
+ * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of different type.
*/
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);
* @param param The name of the paramter.
* @param val The value of the parameter.
*
- * @return EINA_TRUE if successful. EINA_FALSE if not found or is of different type.
+ * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of different type.
*/
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);
* @param param The name of the paramter.
* @param val The value of the parameter.
*
- * @return EINA_TRUE if successful. EINA_FALSE if not found or is of different type.
+ * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of different type.
*/
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);
* @param param The name of the paramter.
* @param val The value of the parameter.
*
- * @return EINA_TRUE if successful. EINA_FALSE if not found or is of
+ * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of
* different type.
*/
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);
* @param param The name of the paramter.
* @param val The value of the parameter.
*
- * @return EINA_TRUE if successful. EINA_FALSE if not found or is of
+ * @return @c EINA_TRUE if successful. @c EINA_FALSE if not found or is of
* different type.
*/
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);
* @param param The name of the paramter set.
* @param type The type of the parameter.
*
- * @return EINA_TRUE if it was set, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
/**
* @param param The name of the paramter.
* @param val Value will be stored here.
*
- * @return EINA_TRUE if it was set, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param param The name of the paramter.
* @param val Value will be stored here.
*
- * @return EINA_TRUE if it was set, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param param The name of the paramter.
* @param val Value will be stored here.
*
- * @return EINA_TRUE if it was set, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param param The name of the paramter.
* @param val Value will be stored here.
*
- * @return EINA_TRUE if it was set, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param param The name of the paramter.
* @param val Value will be stored here.
*
- * @return EINA_TRUE if it was set, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param state The name of the state to set fill horizontal size
* relative value (not including the state value).
* @param value The state value.
- * @param x The horizontal step value.
- * @param y The vertical step value.
+ * @param step_x The horizontal step value.
+ * @param step_y The vertical step value.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @see edje_edit_state_step_get()
* @since 1.11
*/
* @param state The name of the state to set fill horizontal size
* relative value (not including the state value).
* @param value The state value.
- * @param x The pointer to the variable where horizontal step value should be written.
- * @param y The pointer to the variable where vertical step value should be written.
+ * @param step_x The pointer to the variable where horizontal step value should be written.
+ * @param step_y The pointer to the variable where vertical step value should be written.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @see edje_edit_state_step_set()
* @since 1.11
*/
* @param part Part that contain state.
* @param state The name of the state.
* @param value The state value.
- * @param x The horizontal step value.
- * @param y The vertical step value.
+ * @param limit The value that represents the states limit value in case of success.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @see edje_edit_state_limit_get()
* @since 1.11
*/
* @param state The name of the state (not including the state value).
* @param value The state value.
*
- * @return @cEINA_TRUE in case if mapping allowed or @cEINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case if mapping allowed or @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
* @param value The state value.
* @param on The flag which allow mapping for the part.
*
- * @return @cEINA_TRUE in case of success, @cEINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
* @param value The state value.
* @param source_part The source part's name.
*
- * @return @cEINA_TRUE in case of success, @cEINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool
* @param value The state value.
* @param source_part The source part's name.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
* @param part The name of the part.
* @param state The name of the state (not including the state value).
* @param value The state value.
- * @param bool New backface_cull value.
+ * @param backface_cull New backface_cull value.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
-edje_edit_state_map_backface_cull_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool 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.
*
* @param part The name of the part.
* @param state The name of the state (not including the state value).
* @param value The state value.
- * @param bool New perspective_on value.
+ * @param perspective_on New perspective_on value.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
-edje_edit_state_map_perspective_on_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool 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.
*
* @param part The name of the part.
* @param state The name of the state (not including the state value).
* @param value The state value.
- * @param bool New map.alpha value.
+ * @param alpha New map.alpha value.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
-edje_edit_state_map_alpha_get(Evas_Object *obj, const char *part, const char *state, double value);
+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.
*
* @param part The name of the part.
* @param state The name of the state (not including the state value).
* @param value The state value.
- * @param bool New map.smooth value.
+ * @param smooth New map.smooth value.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
-edje_edit_state_map_smooth_set(Evas_Object *obj, const char *part, const char *state, double value, Eina_Bool 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.
*
* @param y x-rotation.
* @param z z-rotation.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
* @param y x-rotation.
* @param z z-rotation.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
* @param part The name of the part.
* @param state The name of the state (not including the state value).
* @param value The state value.
- * @param bool New map.perspective.focal value.
+ * @param focal New map.perspective.focal value.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
* @param part The name of the part.
* @param state The name of the state (not including the state value).
* @param value The state value.
- * @param bool New map.perspective.zplane value.
+ * @param zplane New map.perspective.zplane value.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
* @param value The state value.
* @param source_part The source part's name.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
* @param b The blue color value to set.
* @param a The alpha color value to set.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
* @param b The blue color value to get.
* @param a The alpha color value to get.
*
- * @return EINA_TRUE in case of success, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
**/
EAPI Eina_Bool
* @param part Part that contain state.
* @param state The name of the state.
* @param value The state value.
- * @param source_part The name of part to be set as source. If NULL is passed, the source will be unset.
+ * @param source_name The name of part to be set as source. If NULL is passed, the source will be unset.
*
* @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @see edje_edit_state_proxy_source_get()
* @param value The state value.
* @param text The new text to assign.
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_set(Evas_Object *obj, const char *part, const char *state, double value,const char *text);
* @param value Value of the state.
* @param font The font name to use.
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_font_set(Evas_Object *obj, const char *part, const char *state, double value, const char *font);
* @param value The state value.
* @param size The new font size to set (in pixel)
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_size_set(Evas_Object *obj, const char *part, const char *state, double value, int size);
* @param value The state value.
* @param align The new text horizontal align value
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_align_x_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
* @param value The state value.
* @param align The new text vertical align value
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_align_y_set(Evas_Object *obj, const char *part, const char *state, double value, double align);
* @param value The state value.
* @param balance The position where to cut the string
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_elipsis_set(Evas_Object *obj, const char *part, const char *state, double value, double balance);
* @param state The name of the state to get the if the text part fit it's container horizontally (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE If the part fit it's container horizontally, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE If the part fit it's container horizontally, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_fit_x_get(Evas_Object *obj, const char *part, const char *state, double value);
* @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, EINA_FALSE otherwise.
+ * @param fit EINA_TRUE to make the text fit it's container horizontally, @c EINA_FALSE otherwise.
*
- * @return EINA_TRUE if successful, 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);
* @param state The name of the state to get the if the text part fit it's container vertically (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE If the part fit it's container vertically, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE If the part fit it's container vertically, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_fit_y_get(Evas_Object *obj, const char *part, const char *state, double value);
* @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, EINA_FALSE otherwise.
+ * @param fit EINA_TRUE to make the text fit it's container vertically, @c EINA_FALSE otherwise.
*
- * @return EINA_TRUE if successful, 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);
* @param state The name of the state to get the the minimum horizontal size of the container to be equal (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE If the part forces container's minimum horizontal size, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE If the part forces container's minimum horizontal size, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_min_x_get(Evas_Object *obj, const char *part, const char *state, double value);
* @param state The name of the state to get the the minimum horizontal size of the container to be equal (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE If the part forces container's maximum horizontal size, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE If the part forces container's maximum horizontal size, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_max_x_get(Evas_Object *obj, const char *part, const char *state, double value);
* @param state The name of the state to get the the minimum vertical size of the container to be equal (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE If the part forces container's minimum vertical size, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE If the part forces container's minimum vertical size, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_min_y_get(Evas_Object *obj, const char *part, const char *state, double value);
* @param state The name of the state to get the the maximum vertical size of the container to be equal (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE If the part forces container's maximum vertical size, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE If the part forces container's maximum vertical size, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_text_max_y_get(Evas_Object *obj, const char *part, const char *state, double value);
* @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, EINA_FALSE otherwise.
+ * @param v EINA_TRUE to make the text force it's forces container's minimum horizontal size, @c EINA_FALSE otherwise.
*
- * @return EINA_TRUE if successful, 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);
* @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, EINA_FALSE otherwise.
+ * @param v EINA_TRUE to make the text force it's forces container's maximum horizontal size, @c EINA_FALSE otherwise.
*
- * @return EINA_TRUE if successful, 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);
* @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, EINA_FALSE otherwise.
+ * @param v EINA_TRUE to make the text force it's forces container's minimum vertical size, @c EINA_FALSE otherwise.
*
- * @return EINA_TRUE if successful, 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);
* @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, EINA_FALSE otherwise.
+ * @param v EINA_TRUE to make the text force it's forces container's maximum vertical size, @c EINA_FALSE otherwise.
*
- * @return EINA_TRUE if successful, 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);
* @param value Value of the state.
* @param style The style name to use.
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_state_text_style_set(Evas_Object *obj, const char *part, const char *state, double value, const char *style);
* @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 Value of the state.
*
* @return The name of part or NULL, if text_source param not a setted.
*/
* @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 Value of the state.
* @param source The text source part name.
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_state_text_text_source_set(Evas_Object *obj, const char *part, const char *state, double value, const char *source);
* @param value Value of the state.
* @param source The text source part name.
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_state_text_source_set(Evas_Object *obj, const char *part, const char *state, double value, const char *source);
* @param value The state value.
* @param text_class The text class to assign.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_state_text_class_set(Evas_Object *obj, const char *part, const char *state, double value, const char *text_class);
* @param value The state value.
* @param repch The replacement character string to assign.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_state_text_repch_set(Evas_Object *obj, const char *part, const char *state, double value, const char *repch);
* @param min Minimal value of the font size in points (pt).
* @param max Maximum value of the font size in points (pt).
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param min Minimal value of the font size in points (pt).
* @param max Maximum value of the font size in points (pt).
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param path The file path to load the font from.
* @param alias The alias for file, or NULL to use filename
*
- * @return EINA_TRUE if font cat be loaded, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if font cat be loaded, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_font_add(Evas_Object *obj, const char *path, const char* alias);
* @param obj Object being edited.
* @param alias The font alias
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise (including the
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.(including the
* case when the alias is not valid).
*/
EAPI Eina_Bool edje_edit_font_del(Evas_Object *obj, const char* alias);
* @param obj Object being edited.
* @param path The name of the image file to include in the edje.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_image_add(Evas_Object *obj, const char *path);
* @param obj Object being edited.
* @param name The name of the image file to include in the edje.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise (including the
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.(including the
* case when the name is not valid or image is in use).
*/
EAPI Eina_Bool edje_edit_image_del(Evas_Object *obj, const char *name);
*
* @param obj Object being edited.
* @param name The name of the image to replace.
- * @param name The new_name of the image to replace with.
+ * @param new_name The new_name of the image to replace with.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise (including the
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.(including the
* case when one of the names is not valid)
*/
EAPI Eina_Bool edje_edit_image_replace(Evas_Object *obj, const char *name, const char *new_name);
* @param name The image entry name.
* @param id The image id.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_image_data_add(Evas_Object *obj, const char *name, int id);
* @param value The state value.
* @param image The name of the image (must be an image contained in the edje file).
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_image_set(Evas_Object *obj, const char *part, const char *state, double value, const char *image);
* @param ic Edje_Edit_Image_Comp.
* (EDJE_EDIT_IMAGE_COMP_RAW, EDJE_EDIT_IMAGE_COMP_USER, EDJE_EDIT_IMAGE_COMP_COMP, EDJE_EDIT_IMAGE_COMP_LOSSY[_ETC1]).
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_image_compression_type_set(Evas_Object *obj, const char *image, Edje_Edit_Image_Comp ic);
* @param t Top border value (or -1).
* @param b Bottom border value (or -1).
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param value The state value.
* @param fill Fill to be set. 1 or 2 if the center of the bordered image is draw, 0 otherwise.
*
- * @return EINA_TRUE if successful, EINA_FALSE - otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_image_border_fill_set(Evas_Object *obj, const char *part, const char *state, double value, unsigned char fill);
* @param value The state value.
* @param tween The name of the image to add.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_tween_add(Evas_Object *obj, const char *part, const char *state, double value, const char *tween);
* @param value The state value.
* @param tween The name of the image to del.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_tween_del(Evas_Object *obj, const char *part, const char *state, double value, const char *tween);
* @param name The name that will identify sample.
* @param snd_src The name of the sound file to add.
*
- * @return @c EINA_TRUE if successful, @c EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @see edje_edit_sound_sample_del()
* @since 1.11
*/
* @param obj Object being edited.
* @param name The name of the sound to be deleted from the edje.
*
- * @return @c EINA_TRUE if successful, @c EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @see edje_edit_sound_sample_add()
* @since 1.11
*/
*/
EAPI double edje_edit_sound_compression_rate_get(Evas_Object *obj, const char* sound);
-/* Set the sound quality compression.
+/** Set the sound quality compression.
*
* @param obj Object being edited.
* @param sound The name of the sample.
* @param rate Quality of the compression.
*
- * @return @c EINA_TRUE if successful, @cEINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_sound_compression_rate_set(Evas_Object *obj, const char* sound, double rate);
* @param name The name of the tone.
* @param frequency The value of frequency of tone. This value has to be in range of 20 to 20000 inclusive.
*
- * @return @c EINA_TRUE if successful, @c EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @see edje_edit_sound_tone_frequency_get()
* @since 1.11
*/
* @param sc Edje_Edit_Sound_Comp
* (@c EDJE_EDIT_SOUND_COMP_RAW, @c EDJE_EDIT_SOUND_COMP_COMP, @c EDJE_EDIT_SOUND_COMP_LOSSY, @c EDJE_EDIT_SOUND_COMP_AS_IS).
*
- * @return @c EINA_TRUE if successful, @c EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
* @since 1.11
*/
EAPI Eina_Bool edje_edit_sound_compression_type_set(Evas_Object *obj, const char* name, Edje_Edit_Sound_Comp sc);
* @param obj Object being edited.
* @param name The name of the spectra to include in the edje.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_spectra_add(Evas_Object *obj, const char *name);
* @param obj Object being edited.
* @param spectra The name of the spectra to delete.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_spectra_del(Evas_Object *obj, const char *spectra);
* @param spectra The name of the current spectra.
* @param name The new name to assign.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_spectra_name_set(Evas_Object *obj, const char *spectra, const char *name);
* @param spectra The name of the spectra.
* @param num The number of stops you want
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_spectra_stop_num_set(Evas_Object *obj, const char *spectra, int num);
* @param a Where to store the alpha color value,
* @param d Where to store the delta stop value,
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
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);
* @param b The blue color value to set,
* @param a The alpha color value to set,
* @param d The delta stop value to set,
+ *
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_spectra_stop_color_set(Evas_Object *obj, const char *spectra, int stop_number, int r, int g, int b, int a, int d);
* @param value The state value.
* @param type The type of gradient to use.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_type_set(Evas_Object *obj, const char *part, const char *state, double value, const char *type);
* @param state The name of the state to set the gradient type (not including the state value).
* @param value The state value.
*
- * @return EINA_TRUE if gradient use the fill properties, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if gradient use the fill properties, @c EINA_FALSE otherwise.
* */
EAPI Eina_Bool edje_edit_state_gradient_use_fill_get(Evas_Object *obj, const char *part, const char *state, double value);
* @param value The state value.
* @param spectra The spectra name to assign
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_spectra_set(Evas_Object *obj, const char *part, const char *state, double value, const char *spectra);
* @param value The state value.
* @param val The rel1 relative x to be set,
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise..
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise..
*/
EAPI Eina_Bool edje_edit_state_gradient_rel1_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double val);
* @param value The state value.
* @param val The rel1 relative y to be set,
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise..
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise..
*/
EAPI Eina_Bool edje_edit_state_gradient_rel1_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double val);
* @param value The state value.
* @param val The rel2 relative x to be set,
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise..
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise..
*/
EAPI Eina_Bool edje_edit_state_gradient_rel2_relative_x_set(Evas_Object *obj, const char *part, const char *state, double value, double val);
* @param value The state value.
* @param val The rel2 relative y to be set,
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise..
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise..
*/
EAPI Eina_Bool edje_edit_state_gradient_rel2_relative_y_set(Evas_Object *obj, const char *part, const char *state, double value, double val);
* @param value The state value.
* @param val The rel1 offset x value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_rel1_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, int val);
* @param value The state value.
* @param val The rel1 offset y value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_rel1_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, int val);
* @param value The state value.
* @param val The rel2 offset x value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_rel2_offset_x_set(Evas_Object *obj, const char *part, const char *state, double value, int val);
* @param value The state value.
* @param val The rel2 offset y value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_state_gradient_rel2_offset_y_set(Evas_Object *obj, const char *part, const char *state, double value, int val);
* @param obj Object being edited.
* @param name The name of the new program.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_add(Evas_Object *obj, const char *name);
* @param obj Object being edited.
* @param prog The name of the program to remove.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_del(Evas_Object *obj, const char *prog);
* @param obj Object being edited.
* @param prog The prog of the program that will be searched.
*
- * @return EINA_TRUE if the program exist, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE if the program exist, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_exist(Evas_Object *obj, const char *prog);
* @param obj Object being edited.
* @param prog The name of the program to execute.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_run(Evas_Object *obj, const char *prog);
* @param prog The current program name.
* @param new_name The new name to assign.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_name_set(Evas_Object *obj, const char *prog, const char *new_name);
* @param prog The name of the program to set source.
* @param source The new source value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_source_set(Evas_Object *obj, const char *prog, const char *source);
* @param prog The name of the program to set the signal.
* @param signal The new signal value.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_signal_set(Evas_Object *obj, const char *prog, const char *signal);
* @param prog The name of the program to set the delay.
* @param seconds Number of seconds to delay the program execution
*
- * */
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
+ */
EAPI Eina_Bool edje_edit_program_in_from_set(Evas_Object *obj, const char *prog, double seconds);
/** Get in.range of a given program.
* @param prog The name of the program to set random delay.
* @param seconds Max random number of seconds to delay.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_in_range_set(Evas_Object *obj, const char *prog, double seconds);
* @param prog The name of the program to set the action.
* @param action The new action type.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_action_set(Evas_Object *obj, const char *prog, Edje_Action_Type action);
* @param prog The name of the program to add a new target.
* @param target The name of the new target itself.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_target_add(Evas_Object *obj, const char *prog, const char *target);
* @param prog The name of the program to del a target from the list of targets.
* @param target The name of another program or another part.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_target_del(Evas_Object *obj, const char *prog, const char *target);
* @param obj Object being edited.
* @param prog The name of the program to cleaar the 'targets' list.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @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);
* @param prog The name of the program that contains the list of afters
* @param after The name of another program to add to the afters list
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_after_add(Evas_Object *obj, const char *prog, const char *after);
* @param prog The name of the program from where to remove the after.
* @param after The name of the program to remove from the list of afters.
*
- * @return EINA_TRUE is successful or not in the list, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE is successful or not in the list, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_after_del(Evas_Object *obj, const char *prog, const char *after);
* @param obj Object being edited.
* @param prog The name of the program to clear the 'afters' list.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_afters_clear(Evas_Object *obj, const char *prog);
* @param prog Name of the part.
* @param name New name for the api property.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_api_name_set(Evas_Object *obj, const char *prog, const char *name);
* @param prog Name of the program.
* @param description New description for the api property.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_api_description_set(Evas_Object *obj, const char *prog, const char *description);
* @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)
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @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);
* @param prog The name of the program to set the value of state.
* @param value The vale to set.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_value_set(Evas_Object *obj, const char *prog, double value);
* @param prog The name of the program to set the state2.
* @param state2 The name of the state to set.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_state2_set(Evas_Object *obj, const char *prog, const char *state2);
* @param obj Object being edited.
* @param prog The name of the program to set the state2 value.
* @param value The value of the state2 to set.
+ *
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_value2_set(Evas_Object *obj, const char *prog, double value);
* @param prog The name of the program to set the transition.
* @param transition The transition type to set
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_transition_set(Evas_Object *obj, const char *prog, Edje_Tween_Mode transition);
* @param prog The name of the program to get the interpolation value 1.
* @param value The interpolation value 1 for the transition.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_program_transition_value1_set(Evas_Object *obj, const char *prog, double value);
* @param prog The name of the program to get the interpolation value 2.
* @param value The interpolation value 2 for the transition.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_program_transition_value2_set(Evas_Object *obj, const char *prog, double value);
* @param prog The name of the program to get the interpolation value 3.
* @param value The interpolation value 3 for the transition.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_program_transition_value3_set(Evas_Object *obj, const char *prog, double value);
* @param prog The name of the program to get the interpolation value 4.
* @param value The interpolation value 4 for the transition.
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool
edje_edit_program_transition_value4_set(Evas_Object *obj, const char *prog, double value);
* @param prog The name of the program to set the transition time.
* @param seconds The duration of the transition (in seconds).
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_program_transition_time_set(Evas_Object *obj, const char *prog, double seconds);
*
* 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
- * need to call edje_edit_script_compile for it to get updated.
+ * need to call @see edje_edit_script_compile() for it to get updated.
*
* @param obj The object being edited
* @param code The Embryo source
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_script_set(Evas_Object *obj, const char *code);
* existing program of type EDJE_ACTION_TYPE_SCRIPT, or the function
* will fail and do nothing.
* Note that changing the code itself will not update the running VM, you
- * need to call edje_edit_script_compile for it to get updated.
+ * 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 code The Embryo source
*
- * @return EINA_TRUE if successful, EINA_FALSE otherwise.
+ * @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);
*
* @param obj The object being edited
*
+ * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
*/
EAPI Eina_Bool edje_edit_script_compile(Evas_Object *obj);
projects / platform / upstream / efl.git / commitdiff