summaryrefslogtreecommitdiff
path: root/src/lib/edje
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-16 10:16:49 -0800
committerCedric BAIL <cedric@osg.samsung.com>2017-02-16 10:16:52 -0800
commit7760613107f164f14e706deb96c0ae9ac6614417 (patch)
tree1709c85f7aae2a84ad3ff4933776b210af1b0ab6 /src/lib/edje
parentcbe7859d1c79fbb991186605b5ea2defdfe9ef52 (diff)
doxygen: fix typos and some wrong expressions in Edje and Eet API reference documentation.
Summary: I had fixed some typos and some wrong expressions, such as capital letters, singular, and orders of groups in Edje and Eet API reference doxygen. Test Plan: Doxygen Revision Reviewers: stefan, cedric, raster, Jaehyun_Cho, jpeg Subscribers: conr2d Differential Revision: https://phab.enlightenment.org/D4666 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib/edje')
-rw-r--r--src/lib/edje/Edje.h2
-rw-r--r--src/lib/edje/Edje_Common.h296
-rw-r--r--src/lib/edje/Edje_Edit.h2193
-rw-r--r--src/lib/edje/Edje_Legacy.h40
4 files changed, 1571 insertions, 960 deletions
diff --git a/src/lib/edje/Edje.h b/src/lib/edje/Edje.h
index c13292f3d9..82f3cbac2d 100644
--- a/src/lib/edje/Edje.h
+++ b/src/lib/edje/Edje.h
@@ -197,7 +197,7 @@ param in edje programs
197 197
198/** 198/**
199 * @file Edje.h 199 * @file Edje.h
200 * @brief Edje Graphical Design Library 200 * @brief Edje Graphical Design Library.
201 * 201 *
202 * These routines are used for Edje. 202 * These routines are used for Edje.
203 */ 203 */
diff --git a/src/lib/edje/Edje_Common.h b/src/lib/edje/Edje_Common.h
index 243a28ca00..c39e0ceb06 100644
--- a/src/lib/edje/Edje_Common.h
+++ b/src/lib/edje/Edje_Common.h
@@ -2,11 +2,11 @@
2 2
3/** 3/**
4 * @internal 4 * @internal
5 * @ingroup Edje_General_Group
5 * 6 *
6 * @typedef Edje_Version 7 * @typedef Edje_Version
7 * Type for edje version 8 * Type for edje version
8 * 9 *
9 * @ingroup Edje_General_Group
10 */ 10 */
11typedef struct _Edje_Version 11typedef struct _Edje_Version
12{ 12{
@@ -75,6 +75,7 @@ struct _Edje_Size_Class
75 75
76/** 76/**
77 * @defgroup Edje_Object_Communication_Interface_Signal Edje Communication Interface: Signal 77 * @defgroup Edje_Object_Communication_Interface_Signal Edje Communication Interface: Signal
78 * @ingroup Edje_Object_Group
78 * 79 *
79 * @brief Functions that deal with signals. 80 * @brief Functions that deal with signals.
80 * 81 *
@@ -85,17 +86,15 @@ struct _Edje_Size_Class
85 * emit a signal from @b code to a @b theme or create handles for 86 * emit a signal from @b code to a @b theme or create handles for
86 * the ones emitted from @b themes. Signals are identified by strings. 87 * the ones emitted from @b themes. Signals are identified by strings.
87 * 88 *
88 * @ingroup Edje_Object_Group
89 *
90 * @{ 89 * @{
91 */ 90 */
92 91
93typedef void (*Edje_Signal_Cb) (void *data, Evas_Object *obj, const char *emission, const char *source); /**< Edje signal callback functions's prototype definition. @c data will have the auxiliary data pointer set at the time the callback registration. @c obj will be a pointer the Edje object where the signal comes from. @c emission will identify the exact signal's emission string and @c source the exact signal's source one. */ 92typedef void (*Edje_Signal_Cb) (void *data, Evas_Object *obj, const char *emission, const char *source); /**< Edje signal callback functions's prototype definition. @c data will have the auxiliary data pointer set at the time the callback registration. @c obj will be a pointer the Edje object where the signal comes from. @c emission will identify the exact signal's emission string and @c source the exact signal's source one. */
94 93
95/** 94/**
96 * @brief Get extra data passed to callbacks. 95 * @brief Gets extra data passed to callbacks.
97 * 96 *
98 * @return the extra data for that callback. 97 * @return The extra data for that callback.
99 * 98 *
100 * Some callbacks pass extra information. This function gives access to that 99 * Some callbacks pass extra information. This function gives access to that
101 * extra information. It's somehow like event_info in smart callbacks. 100 * extra information. It's somehow like event_info in smart callbacks.
@@ -123,7 +122,7 @@ EAPI void * edje_object_signal_callback_extra_data_get(void);
123 */ 122 */
124 123
125/** 124/**
126 * @brief Initialize the Edje library. 125 * @brief Initializes the Edje library.
127 * 126 *
128 * @return The new init count. The initial value is zero. 127 * @return The new init count. The initial value is zero.
129 * 128 *
@@ -144,7 +143,7 @@ EAPI void * edje_object_signal_callback_extra_data_get(void);
144EAPI int edje_init (void); 143EAPI int edje_init (void);
145 144
146/** 145/**
147 * @brief Shutdown the Edje library. 146 * @brief Shuts down the Edje library.
148 * 147 *
149 * @return The number of times the library has been initialized 148 * @return The number of times the library has been initialized
150 * without being shutdown. 149 * without being shutdown.
@@ -165,7 +164,7 @@ EAPI int edje_init (void);
165EAPI int edje_shutdown (void); 164EAPI int edje_shutdown (void);
166 165
167/** 166/**
168 * @brief Set the edje append fontset. 167 * @brief Sets the edje append fontset.
169 * 168 *
170 * @param fonts The fontset to append. 169 * @param fonts The fontset to append.
171 * 170 *
@@ -175,10 +174,10 @@ EAPI int edje_shutdown (void);
175EAPI void edje_fontset_append_set (const char *fonts); 174EAPI void edje_fontset_append_set (const char *fonts);
176 175
177/** 176/**
178 * Get data from the file level data block of an edje mapped file 177 * @brief Gets data from the file level data block of an edje mapped file.
179 * @param f The mapped edje file 178 * @param f The mapped edje file
180 * @param key The data key 179 * @param key The data key
181 * @return The string value of the data or NULL if no key is found. 180 * @return The string value of the data, or @c NULL if no key is found.
182 * Must be freed by the user when no longer needed. 181 * Must be freed by the user when no longer needed.
183 * 182 *
184 * If an edje file test.edj is built from the following edc: 183 * If an edje file test.edj is built from the following edc:
@@ -194,10 +193,10 @@ EAPI void edje_fontset_append_set (const char *fonts);
194EAPI char *edje_mmap_data_get(const Eina_File *f, const char *key); 193EAPI char *edje_mmap_data_get(const Eina_File *f, const char *key);
195 194
196/** 195/**
197 * Get data from the file level data block of an edje file 196 * @brief Gets data from the file level data block of an edje file.
198 * @param file The path to the .edj file 197 * @param file The path to the .edj file
199 * @param key The data key 198 * @param key The data key
200 * @return The string value of the data or NULL if no key is found. 199 * @return The string value of the data, or @c NULL if no key is found.
201 * Must be freed by the user when no longer needed. 200 * Must be freed by the user when no longer needed.
202 * 201 *
203 * If an edje file test.edj is built from the following edc: 202 * If an edje file test.edj is built from the following edc:
@@ -215,9 +214,9 @@ EAPI char *edje_mmap_data_get(const Eina_File *f, const char *key);
215EAPI char *edje_file_data_get (const char *file, const char *key); 214EAPI char *edje_file_data_get (const char *file, const char *key);
216 215
217/** 216/**
218 * @brief Load a new module in Edje. 217 * @brief Loads a new module in Edje.
219 * @param module The name of the module that will be added to Edje. 218 * @param module The name of the module that will be added to Edje.
220 * @return EINA_TRUE if the module was successfully loaded. Otherwise, EINA_FALSE. 219 * @return @c EINA_TRUE if the module was successfully loaded. Otherwise, @c EINA_FALSE.
221 * 220 *
222 * Modules are used to add functionality to Edje. 221 * Modules are used to add functionality to Edje.
223 * So, when a module is loaded, its functionality should be available for use. 222 * So, when a module is loaded, its functionality should be available for use.
@@ -237,7 +236,7 @@ EAPI Eina_Bool edje_module_load (const char *module
237EAPI const Eina_List *edje_available_modules_get (void); 236EAPI const Eina_List *edje_available_modules_get (void);
238 237
239/** 238/**
240 * @brief Get the edje append fontset. 239 * @brief Gets the edje append fontset.
241 * 240 *
242 * @return The edje append fontset. 241 * @return The edje append fontset.
243 * 242 *
@@ -250,7 +249,7 @@ EAPI const Eina_List *edje_available_modules_get (void);
250EAPI const char *edje_fontset_append_get (void); 249EAPI const char *edje_fontset_append_get (void);
251 250
252/** 251/**
253 * @brief Set the file cache size. 252 * @brief Sets the file cache size.
254 * 253 *
255 * @param count The file cache size in edje file units. Default is 16. 254 * @param count The file cache size in edje file units. Default is 16.
256 * 255 *
@@ -265,7 +264,7 @@ EAPI const char *edje_fontset_append_get (void);
265EAPI void edje_file_cache_set (int count); 264EAPI void edje_file_cache_set (int count);
266 265
267/** 266/**
268 * @brief Return the file cache size. 267 * @brief Returns the file cache size.
269 * 268 *
270 * @return The file cache size in edje file units. Default is 16. 269 * @return The file cache size in edje file units. Default is 16.
271 * 270 *
@@ -279,7 +278,7 @@ EAPI void edje_file_cache_set (int count);
279EAPI int edje_file_cache_get (void); 278EAPI int edje_file_cache_get (void);
280 279
281/** 280/**
282 * @brief Clean the file cache. 281 * @brief Cleans the file cache.
283 * 282 *
284 * This function cleans the file cache entries, but keeps this cache's 283 * This function cleans the file cache entries, but keeps this cache's
285 * size to the last value set. 284 * size to the last value set.
@@ -291,7 +290,7 @@ EAPI int edje_file_cache_get (void);
291EAPI void edje_file_cache_flush (void); 290EAPI void edje_file_cache_flush (void);
292 291
293/** 292/**
294 * @brief Set the collection cache size. 293 * @brief Sets the collection cache size.
295 * 294 *
296 * @param count The collection cache size, in edje object units. Default is 16. 295 * @param count The collection cache size, in edje object units. Default is 16.
297 * 296 *
@@ -307,7 +306,7 @@ EAPI void edje_file_cache_flush (void);
307EAPI void edje_collection_cache_set (int count); 306EAPI void edje_collection_cache_set (int count);
308 307
309/** 308/**
310 * @brief Return the collection cache size. 309 * @brief Returns the collection cache size.
311 * 310 *
312 * @return The collection cache size, in edje object units. Default is 16. 311 * @return The collection cache size, in edje object units. Default is 16.
313 * 312 *
@@ -321,7 +320,7 @@ EAPI void edje_collection_cache_set (int count);
321EAPI int edje_collection_cache_get (void); 320EAPI int edje_collection_cache_get (void);
322 321
323/** 322/**
324 * @brief Clean the collection cache. 323 * @brief Cleans the collection cache.
325 * 324 *
326 * This function cleans the collection cache, but keeps this cache's 325 * This function cleans the collection cache, but keeps this cache's
327 * size to the last value set. 326 * size to the last value set.
@@ -592,28 +591,28 @@ typedef struct _Edje_External_Type_Info Edje_External_Type_Info;
592 591
593/** 592/**
594 * @defgroup Edje_External_Plugin_Development_Group Edje Development of External Plugins 593 * @defgroup Edje_External_Plugin_Development_Group Edje Development of External Plugins
594 * @ingroup Edje_External_Group
595 * 595 *
596 * @brief Functions to register, unregister EXTERNAL types and develop the plugins. 596 * @brief Functions to register, unregister EXTERNAL types and develop the plugins.
597 * 597 *
598 * This group dicusses functions useful for the development of new plugins. 598 * This group discusses functions useful for the development of new plugins.
599 * These functions deal with the newly EXTERNAL types by registering, unregistering and manipulating them. 599 * These functions deal with the newly EXTERNAL types by registering, unregistering and manipulating them.
600 * 600 *
601 * @ingroup Edje_External_Group
602 * 601 *
603 * @{ 602 * @{
604 */ 603 */
605 604
606/** 605/**
607 * Register a type to be used by EXTERNAL parts. 606 * @brief Registers a type to be used by EXTERNAL parts.
608 * 607 *
609 * Parts of type EXTERNAL will call user defined functions 608 * Parts of type EXTERNAL will call user defined functions
610 * to create and manipulate the object that's allocated in that part. This is 609 * to create and manipulate the object that's allocated in that part. This is
611 * done by expecifying in the @c source property of the part the name of the 610 * done by expecifying in the @c source property of the part the name of the
612 * external to use, which must be one registered with this function. 611 * external to use, which must be one registered with this function.
613 * 612 *
614 * @param type_name name to register and be known by edje's "source:" 613 * @param type_name Name to register and be known by edje's "source:"
615 * parameter of "type: EXTERNAL" parts. 614 * parameter of "type: EXTERNAL" parts.
616 * @param type_info meta-information describing how to interact with it. 615 * @param type_info Meta-information describing how to interact with it.
617 * 616 *
618 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure (like 617 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure (like
619 * type already registered). 618 * type already registered).
@@ -623,7 +622,7 @@ typedef struct _Edje_External_Type_Info Edje_External_Type_Info;
623EAPI Eina_Bool edje_external_type_register (const char *type_name, const Edje_External_Type *type_info); 622EAPI Eina_Bool edje_external_type_register (const char *type_name, const Edje_External_Type *type_info);
624 623
625/** 624/**
626 * Unregister a previously registered EXTERNAL type. 625 * @brief Unregisters a previously registered EXTERNAL type.
627 * 626 *
628 * @param type_name name to unregister. It should have been registered with 627 * @param type_name name to unregister. It should have been registered with
629 * edje_external_type_register() before. 628 * edje_external_type_register() before.
@@ -636,7 +635,7 @@ EAPI Eina_Bool edje_external_type_register (const char *type_name
636EAPI Eina_Bool edje_external_type_unregister (const char *type_name); 635EAPI Eina_Bool edje_external_type_unregister (const char *type_name);
637 636
638/** 637/**
639 * Register a batch of types and their information. 638 * @brief Registers a batch of types and their information.
640 * 639 *
641 * When several types will be registered it is recommended to use this 640 * When several types will be registered it is recommended to use this
642 * function instead of several calls to edje_external_type_register(), as it 641 * function instead of several calls to edje_external_type_register(), as it
@@ -661,7 +660,7 @@ EAPI Eina_Bool edje_external_type_unregister (const char *type_name
661EAPI void edje_external_type_array_register (const Edje_External_Type_Info *array); 660EAPI void edje_external_type_array_register (const Edje_External_Type_Info *array);
662 661
663/** 662/**
664 * Unregister a batch of given external type previously registered. 663 * @brief Unregisters a batch of given external type previously registered.
665 * 664 *
666 * @param array @c NULL terminated array, should be the same as the 665 * @param array @c NULL terminated array, should be the same as the
667 * one used to register with edje_external_type_array_register() 666 * one used to register with edje_external_type_array_register()
@@ -671,7 +670,7 @@ EAPI void edje_external_type_array_register (const Edje_External_T
671EAPI void edje_external_type_array_unregister (const Edje_External_Type_Info *array); 670EAPI void edje_external_type_array_unregister (const Edje_External_Type_Info *array);
672 671
673/** 672/**
674 * Return the current ABI version for Edje_External_Type structure. 673 * @brief Returns the current ABI version for Edje_External_Type structure.
675 * 674 *
676 * Always check this number before accessing Edje_External_Type in 675 * Always check this number before accessing Edje_External_Type in
677 * your own software. If the number is not the same, your software may 676 * your own software. If the number is not the same, your software may
@@ -693,7 +692,7 @@ EAPI unsigned int edje_external_type_abi_version_get (void) EINA_CONST;
693 692
694/** 693/**
695 * 694 *
696 * @return an iterator of all the registered EXTERNAL types. 695 * @return An iterator of all the registered EXTERNAL types.
697 * 696 *
698 * Each item in the iterator is an @c Eina_Hash_Tuple which has the type 697 * Each item in the iterator is an @c Eina_Hash_Tuple which has the type
699 * of the external in the @c key and #Edje_External_Type as @c data. 698 * of the external in the @c key and #Edje_External_Type as @c data.
@@ -737,7 +736,7 @@ EAPI unsigned int edje_external_type_abi_version_get (void) EINA_CONST;
737EAPI Eina_Iterator *edje_external_iterator_get (void); 736EAPI Eina_Iterator *edje_external_iterator_get (void);
738 737
739/** 738/**
740 * Conevenience function to find a specific parameter in a list of them. 739 * @brief Convenience function to find a specific parameter in a list of them.
741 * 740 *
742 * @param params The list of parameters for the external 741 * @param params The list of parameters for the external
743 * @param key The parameter to look for 742 * @param key The parameter to look for
@@ -747,7 +746,7 @@ EAPI Eina_Iterator *edje_external_iterator_get (void);
747EAPI Edje_External_Param *edje_external_param_find (const Eina_List *params, const char *key); 746EAPI Edje_External_Param *edje_external_param_find (const Eina_List *params, const char *key);
748 747
749/** 748/**
750 * Get the value of the given parameter of integer type. 749 * @brief Gets the value of the given parameter of integer type.
751 * 750 *
752 * Look for the @p key parameter in the @p params list and return its value in 751 * Look for the @p key parameter in the @p params list and return its value in
753 * @p ret. If the parameter is found and is of type 752 * @p ret. If the parameter is found and is of type
@@ -759,13 +758,13 @@ EAPI Edje_External_Param *edje_external_param_find (const Eina_
759 * @param key Name of the parameter to fetch 758 * @param key Name of the parameter to fetch
760 * @param ret Int pointer where to store the value, must not be NULL. 759 * @param ret Int pointer where to store the value, must not be NULL.
761 * 760 *
762 * @return EINA_TRUE if the parameter was found and is of integer type, 761 * @return @c EINA_TRUE if the parameter was found and is of integer type,
763 * EINA_FALSE otherwise. 762 * @c EINA_FALSE otherwise.
764 */ 763 */
765EAPI Eina_Bool edje_external_param_int_get (const Eina_List *params, const char *key, int *ret); 764EAPI Eina_Bool edje_external_param_int_get (const Eina_List *params, const char *key, int *ret);
766 765
767/** 766/**
768 * Get the value of the given parameter of double type. 767 * @brief Gets the value of the given parameter of double type.
769 * 768 *
770 * Look for the @p key parameter in the @p params list and return its value in 769 * Look for the @p key parameter in the @p params list and return its value in
771 * @p ret. If the parameter is found and is of type 770 * @p ret. If the parameter is found and is of type
@@ -777,13 +776,13 @@ EAPI Eina_Bool edje_external_param_int_get (const Eina_
777 * @param key Name of the parameter to fetch 776 * @param key Name of the parameter to fetch
778 * @param ret Double pointer where to store the value, must not be NULL. 777 * @param ret Double pointer where to store the value, must not be NULL.
779 * 778 *
780 * @return EINA_TRUE if the parameter was found and is of double type, 779 * @return @c EINA_TRUE if the parameter was found and is of double type,
781 * EINA_FALSE otherwise. 780 * @c EINA_FALSE otherwise.
782 */ 781 */
783EAPI Eina_Bool edje_external_param_double_get (const Eina_List *params, const char *key, double *ret); 782EAPI Eina_Bool edje_external_param_double_get (const Eina_List *params, const char *key, double *ret);
784 783
785/** 784/**
786 * Get the value of the given parameter of string type. 785 * @brief Gets the value of the given parameter of string type.
787 * 786 *
788 * Look for the @p key parameter in the @p params list and return its value in 787 * Look for the @p key parameter in the @p params list and return its value in
789 * @p ret. If the parameter is found and is of type 788 * @p ret. If the parameter is found and is of type
@@ -797,13 +796,13 @@ EAPI Eina_Bool edje_external_param_double_get (const Eina_
797 * @param key Name of the parameter to fetch 796 * @param key Name of the parameter to fetch
798 * @param ret String pointer where to store the value, must not be NULL. 797 * @param ret String pointer where to store the value, must not be NULL.
799 * 798 *
800 * @return EINA_TRUE if the parameter was found and is of string type, 799 * @return @c EINA_TRUE if the parameter was found and is of string type,
801 * EINA_FALSE otherwise. 800 * @c EINA_FALSE otherwise.
802 */ 801 */
803EAPI Eina_Bool edje_external_param_string_get (const Eina_List *params, const char *key, const char **ret); 802EAPI Eina_Bool edje_external_param_string_get (const Eina_List *params, const char *key, const char **ret);
804 803
805/** 804/**
806 * Get the value of the given parameter of boolean type. 805 * @brief Gets the value of the given parameter of boolean type.
807 * 806 *
808 * Look for the @p key parameter in the @p params list and return its value in 807 * Look for the @p key parameter in the @p params list and return its value in
809 * @p ret. If the parameter is found and is of type 808 * @p ret. If the parameter is found and is of type
@@ -815,13 +814,13 @@ EAPI Eina_Bool edje_external_param_string_get (const Eina_
815 * @param key Name of the parameter to fetch 814 * @param key Name of the parameter to fetch
816 * @param ret Eina_Bool pointer where to store the value, must not be NULL. 815 * @param ret Eina_Bool pointer where to store the value, must not be NULL.
817 * 816 *
818 * @return EINA_TRUE if the parameter was found and is of boolean type, 817 * @return @c EINA_TRUE if the parameter was found and is of boolean type,
819 * EINA_FALSE otherwise. 818 * @c EINA_FALSE otherwise.
820 */ 819 */
821EAPI Eina_Bool edje_external_param_bool_get (const Eina_List *params, const char *key, Eina_Bool *ret); 820EAPI Eina_Bool edje_external_param_bool_get (const Eina_List *params, const char *key, Eina_Bool *ret);
822 821
823/** 822/**
824 * Get the value of the given parameter of choice type. 823 * @brief Gets the value of the given parameter of choice type.
825 * 824 *
826 * Look for the @p key parameter in the @p params list and return its value in 825 * Look for the @p key parameter in the @p params list and return its value in
827 * @p ret. If the parameter is found and is of type 826 * @p ret. If the parameter is found and is of type
@@ -841,7 +840,7 @@ EAPI Eina_Bool edje_external_param_bool_get (const Eina_
841EAPI Eina_Bool edje_external_param_choice_get (const Eina_List *params, const char *key, const char **ret); 840EAPI Eina_Bool edje_external_param_choice_get (const Eina_List *params, const char *key, const char **ret);
842 841
843/** 842/**
844 * Get the array of parameters information about a type given its name. 843 * @brief Gets the array of parameters information about a type given its name.
845 * 844 *
846 * @note the type names and other strings are static, that means they are 845 * @note the type names and other strings are static, that means they are
847 * @b NOT translated. One must use 846 * @b NOT translated. One must use
@@ -857,7 +856,7 @@ EAPI Eina_Bool edje_external_param_choice_get (const Eina_
857EAPI const Edje_External_Param_Info *edje_external_param_info_get (const char *type_name); 856EAPI const Edje_External_Param_Info *edje_external_param_info_get (const char *type_name);
858 857
859/** 858/**
860 * Get the #Edje_External_Type that defines an EXTERNAL type registered with 859 * @brief Gets the #Edje_External_Type that defines an EXTERNAL type registered with
861 * the name @p type_name. 860 * the name @p type_name.
862 */ 861 */
863EAPI const Edje_External_Type *edje_external_type_get (const char *type_name); 862EAPI const Edje_External_Type *edje_external_type_get (const char *type_name);
@@ -889,6 +888,7 @@ EAPI const Edje_External_Type *edje_external_type_get (const char
889 888
890/** 889/**
891 * @defgroup Edje_Object_Scale Edje Scale 890 * @defgroup Edje_Object_Scale Edje Scale
891 * @ingroup Edje_Object_Group
892 * 892 *
893 * @brief Functions that deal with scaling objects 893 * @brief Functions that deal with scaling objects
894 * 894 *
@@ -899,13 +899,12 @@ EAPI const Edje_External_Type *edje_external_type_get (const char
899 * Scaling affects the values of minimum/maximum @b part sizes, which 899 * Scaling affects the values of minimum/maximum @b part sizes, which
900 * are @b multiplied by it. Font sizes are scaled, too. 900 * are @b multiplied by it. Font sizes are scaled, too.
901 * 901 *
902 * @ingroup Edje_Object_Group
903 * 902 *
904 * @{ 903 * @{
905 */ 904 */
906 905
907/** 906/**
908 * @brief Set Edje's global scaling factor. 907 * @brief Sets Edje's global scaling factor.
909 * 908 *
910 * @param scale The global scaling factor (the default value is @c 1.0) 909 * @param scale The global scaling factor (the default value is @c 1.0)
911 * 910 *
@@ -924,9 +923,9 @@ EAPI const Edje_External_Type *edje_external_type_get (const char
924EAPI void edje_scale_set (double scale); 923EAPI void edje_scale_set (double scale);
925 924
926/** 925/**
927 * @brief Retrieve Edje's global scaling factor. 926 * @brief Retrieves Edje's global scaling factor.
928 * 927 *
929 * @return The global scaling factor 928 * @return The global scaling factor.
930 * 929 *
931 * This function returns Edje's global scaling factor. 930 * This function returns Edje's global scaling factor.
932 * 931 *
@@ -941,6 +940,7 @@ EAPI double edje_scale_get (void);
941 940
942/** 941/**
943 * @defgroup Edje_Text_Entry Edje Text Entry 942 * @defgroup Edje_Text_Entry Edje Text Entry
943 * @ingroup Edje_Part_Text
944 * 944 *
945 * @brief Functions that deal with text entries 945 * @brief Functions that deal with text entries
946 * 946 *
@@ -953,7 +953,6 @@ EAPI double edje_scale_get (void);
953 * 953 *
954 * Use the functions of this section to handle the user input of text. 954 * Use the functions of this section to handle the user input of text.
955 * 955 *
956 * @ingroup Edje_Part_Text
957 * 956 *
958 * @{ 957 * @{
959 */ 958 */
@@ -1039,12 +1038,12 @@ typedef void (*Edje_Markup_Filter_Cb) (void *data, Evas_Object *obj, c
1039 * @param obj The Evas_Object to filter. 1038 * @param obj The Evas_Object to filter.
1040 * @param part Edje part name 1039 * @param part Edje part name
1041 * @param item Item of container 1040 * @param item Item of container
1042 * @return must be an Evas_Object. 1041 * @return Must be an Evas_Object.
1043 */ 1042 */
1044typedef Evas_Object *(*Edje_Item_Provider_Cb) (void *data, Evas_Object *obj, const char *part, const char *item); 1043typedef Evas_Object *(*Edje_Item_Provider_Cb) (void *data, Evas_Object *obj, const char *part, const char *item);
1045 1044
1046/** 1045/**
1047 * @brief Show last character in password mode. 1046 * @brief Shows last character in password mode.
1048 * 1047 *
1049 * @param password_show_last If TRUE enable last character show in password mode. 1048 * @param password_show_last If TRUE enable last character show in password mode.
1050 * 1049 *
@@ -1058,7 +1057,7 @@ typedef Evas_Object *(*Edje_Item_Provider_Cb) (void *data, Evas_Object *obj, c
1058EAPI void edje_password_show_last_set(Eina_Bool password_show_last); 1057EAPI void edje_password_show_last_set(Eina_Bool password_show_last);
1059 1058
1060/** 1059/**
1061 * @brief Set the timeout value in last show password mode. 1060 * @brief Sets the timeout value in last show password mode.
1062 * 1061 *
1063 * @param password_show_last_timeout The timeout value. 1062 * @param password_show_last_timeout The timeout value.
1064 * 1063 *
@@ -1078,6 +1077,7 @@ EAPI void edje_password_show_last_timeout_set(double password_show_last_timeout)
1078 1077
1079/** 1078/**
1080 * @defgroup Edje_Object_Color_Class Edje Class: Color 1079 * @defgroup Edje_Object_Color_Class Edje Class: Color
1080 * @ingroup Edje_Object_Group
1081 * 1081 *
1082 * @brief Functions that deal with Color Classes 1082 * @brief Functions that deal with Color Classes
1083 * 1083 *
@@ -1090,13 +1090,11 @@ EAPI void edje_password_show_last_timeout_set(double password_show_last_timeout)
1090 * will affect all parts with that color class, while at a object level will 1090 * will affect all parts with that color class, while at a object level will
1091 * affect only the parts inside an specified object. 1091 * affect only the parts inside an specified object.
1092 * 1092 *
1093 * @ingroup Edje_Object_Group
1094 *
1095 * @{ 1093 * @{
1096 */ 1094 */
1097 1095
1098/** 1096/**
1099 * @brief Set Edje color class. 1097 * @brief Sets Edje color class.
1100 * 1098 *
1101 * @param color_class 1099 * @param color_class
1102 * @param r Object Red value 1100 * @param r Object Red value
@@ -1128,15 +1126,15 @@ EAPI void edje_password_show_last_timeout_set(double password_show_last_timeout)
1128 * 1126 *
1129 * @see edje_color_class_set(). 1127 * @see edje_color_class_set().
1130 * 1128 *
1131 * @note unlike Evas, Edje colors are @b not pre-multiplied. That is, 1129 * @note Unlike Evas, Edje colors are @b not pre-multiplied. That is,
1132 * half-transparent white is 255 255 255 128. 1130 * half-transparent white is 255 255 255 128.
1133 * 1131 *
1134 * @return Eina_Bool, EINA_TRUE on success and EINA_FALSE on failure. 1132 * @return Eina_Bool, @c EINA_TRUE on success and @c EINA_FALSE on failure.
1135 */ 1133 */
1136EAPI Eina_Bool edje_color_class_set (const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3); 1134EAPI Eina_Bool edje_color_class_set (const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3);
1137 1135
1138/** 1136/**
1139 * @brief Get Edje color class. 1137 * @brief Gets Edje color class.
1140 * 1138 *
1141 * @param color_class 1139 * @param color_class
1142 * @param r Object Red value 1140 * @param r Object Red value
@@ -1152,7 +1150,7 @@ EAPI Eina_Bool edje_color_class_set (const char *color_class, int
1152 * @param b3 Shadow Blue value 1150 * @param b3 Shadow Blue value
1153 * @param a3 Shadow Alpha value 1151 * @param a3 Shadow Alpha value
1154 * 1152 *
1155 * @return EINA_TRUE if found or EINA_FALSE if not found and all 1153 * @return @c EINA_TRUE if found or @c EINA_FALSE if not found and all
1156 * values are zeroed. 1154 * values are zeroed.
1157 * 1155 *
1158 * This function gets the color values for a process level color 1156 * This function gets the color values for a process level color
@@ -1166,13 +1164,13 @@ EAPI Eina_Bool edje_color_class_set (const char *color_class, int
1166 * 1164 *
1167 * @see edje_color_class_set(). 1165 * @see edje_color_class_set().
1168 * 1166 *
1169 * @note unlike Evas, Edje colors are @b not pre-multiplied. That is, 1167 * @note Unlike Evas, Edje colors are @b not pre-multiplied. That is,
1170 * half-transparent white is 255 255 255 128. 1168 * half-transparent white is 255 255 255 128.
1171 */ 1169 */
1172EAPI Eina_Bool edje_color_class_get (const char *color_class, int *r, int *g, int *b, int *a, int *r2, int *g2, int *b2, int *a2, int *r3, int *g3, int *b3, int *a3); 1170EAPI Eina_Bool edje_color_class_get (const char *color_class, int *r, int *g, int *b, int *a, int *r2, int *g2, int *b2, int *a2, int *r3, int *g3, int *b3, int *a3);
1173 1171
1174/** 1172/**
1175 * @brief Delete edje color class. 1173 * @brief Deletes edje color class.
1176 * 1174 *
1177 * @param color_class 1175 * @param color_class
1178 * 1176 *
@@ -1199,7 +1197,7 @@ EAPI void edje_color_class_del (const char *color_class);
1199EAPI Eina_List *edje_color_class_list (void); 1197EAPI Eina_List *edje_color_class_list (void);
1200 1198
1201/** 1199/**
1202 * @brief Iterate over all the active class of an application. 1200 * @brief Iterates over all the active class of an application.
1203 * 1201 *
1204 * @return an iterator of Edje_Color_Class of the currently active color class 1202 * @return an iterator of Edje_Color_Class of the currently active color class
1205 * 1203 *
@@ -1211,7 +1209,7 @@ EAPI Eina_List *edje_color_class_list (void);
1211EAPI Eina_Iterator *edje_color_class_active_iterator_new(void); 1209EAPI Eina_Iterator *edje_color_class_active_iterator_new(void);
1212 1210
1213/** 1211/**
1214 * @brief Iterate over all the color class provided by an Edje file. 1212 * @brief Iterates over all the color class provided by an Edje file.
1215 * 1213 *
1216 * @return an iterator of Edje_Color_Class provided by the Edje file. 1214 * @return an iterator of Edje_Color_Class provided by the Edje file.
1217 * 1215 *
@@ -1226,6 +1224,7 @@ EAPI Eina_Iterator *edje_mmap_color_class_iterator_new(Eina_File *f);
1226 1224
1227/** 1225/**
1228 * @defgroup Edje_Object_Part Edje Part 1226 * @defgroup Edje_Object_Part Edje Part
1227 * @ingroup Edje_Object_Group
1229 * 1228 *
1230 * @brief Functions that deal with layout components 1229 * @brief Functions that deal with layout components
1231 * 1230 *
@@ -1239,15 +1238,13 @@ EAPI Eina_Iterator *edje_mmap_color_class_iterator_new(Eina_File *f);
1239 * This section has some functions specific for some types and others that 1238 * This section has some functions specific for some types and others that
1240 * could be applied to any type. 1239 * could be applied to any type.
1241 * 1240 *
1242 * @ingroup Edje_Object_Group
1243 *
1244 * @{ 1241 * @{
1245 */ 1242 */
1246 1243
1247/** 1244/**
1248 * @typedef Edje_Part_Type 1245 * @typedef Edje_Part_Type
1249 * 1246 *
1250 * All possible "part" types in Edje 1247 * All possible "part" types in Edje.
1251 */ 1248 */
1252typedef enum _Edje_Part_Type 1249typedef enum _Edje_Part_Type
1253{ 1250{
@@ -1277,6 +1274,7 @@ typedef enum _Edje_Part_Type
1277 1274
1278/** 1275/**
1279 * @defgroup Edje_Part_Text Edje Text Part 1276 * @defgroup Edje_Part_Text Edje Text Part
1277 * @ingroup Edje_Object_Part
1280 * 1278 *
1281 * @brief Functions that deal with parts of type text 1279 * @brief Functions that deal with parts of type text
1282 * 1280 *
@@ -1286,8 +1284,6 @@ typedef enum _Edje_Part_Type
1286 * a input panel, where one can set a virtual keyboard to handle 1284 * a input panel, where one can set a virtual keyboard to handle
1287 * keyboard entry easily. 1285 * keyboard entry easily.
1288 * 1286 *
1289 * @ingroup Edje_Object_Part
1290 *
1291 * @{ 1287 * @{
1292 */ 1288 */
1293 1289
@@ -1302,7 +1298,7 @@ typedef enum _Edje_Part_Type
1302/** 1298/**
1303 * @typedef Edje_Text_Effect 1299 * @typedef Edje_Text_Effect
1304 * 1300 *
1305 * All possible text effects in Edje 1301 * All possible text effects in Edje.
1306 */ 1302 */
1307typedef enum _Edje_Text_Effect 1303typedef enum _Edje_Text_Effect
1308{ 1304{
@@ -1333,10 +1329,10 @@ typedef enum _Edje_Text_Effect
1333/** 1329/**
1334 * @typedef (*Edje_Text_Change_Cb) 1330 * @typedef (*Edje_Text_Change_Cb)
1335 * 1331 *
1336 * Callback prototype for Edje_Text_Change 1332 * Callback prototype for Edje_Text_Change.
1337 * @param data user provided data to pass to the callback 1333 * @param data User provided data to pass to the callback
1338 * @param obj the Evas_Object 1334 * @param obj The Evas_Object
1339 * @param The edje part 1335 * @param part The edje part
1340 */ 1336 */
1341typedef void (*Edje_Text_Change_Cb) (void *data, Evas_Object *obj, const char *part); 1337typedef void (*Edje_Text_Change_Cb) (void *data, Evas_Object *obj, const char *part);
1342/** 1338/**
@@ -1345,8 +1341,9 @@ typedef void (*Edje_Text_Change_Cb) (void *data, Evas_Object *obj, c
1345 1341
1346/** 1342/**
1347 * @defgroup Edje_Text_Selection Edje Text Selection 1343 * @defgroup Edje_Text_Selection Edje Text Selection
1344 * @ingroup Edje_Part_Text
1348 * 1345 *
1349 * @brief Functions that deal with selection in text parts 1346 * @brief Functions that deal with selection in text parts.
1350 * 1347 *
1351 * Selection is a known functionality for texts in the whole computational 1348 * Selection is a known functionality for texts in the whole computational
1352 * world. It is a block of text marked for further manipulation. 1349 * world. It is a block of text marked for further manipulation.
@@ -1354,8 +1351,6 @@ typedef void (*Edje_Text_Change_Cb) (void *data, Evas_Object *obj, c
1354 * Edje is responsible for handling this functionality through the 1351 * Edje is responsible for handling this functionality through the
1355 * following functions. 1352 * following functions.
1356 * 1353 *
1357 * @ingroup Edje_Part_Text
1358 *
1359 * @{ 1354 * @{
1360 */ 1355 */
1361/** 1356/**
@@ -1364,8 +1359,9 @@ typedef void (*Edje_Text_Change_Cb) (void *data, Evas_Object *obj, c
1364 1359
1365/** 1360/**
1366 * @defgroup Edje_Text_Cursor Edje Text Cursor 1361 * @defgroup Edje_Text_Cursor Edje Text Cursor
1362 * @ingroup Edje_Part_Text
1367 * 1363 *
1368 * @brief Functions that deal with cursor in text parts 1364 * @brief Functions that deal with cursor in text parts.
1369 * 1365 *
1370 * Cursor is a known functionality for texts in the whole computational 1366 * Cursor is a known functionality for texts in the whole computational
1371 * world. It marks a position in the text from where one may want 1367 * world. It marks a position in the text from where one may want
@@ -1374,8 +1370,6 @@ typedef void (*Edje_Text_Change_Cb) (void *data, Evas_Object *obj, c
1374 * Edje is responsible for handling this functionality through the 1370 * Edje is responsible for handling this functionality through the
1375 * following functions. 1371 * following functions.
1376 * 1372 *
1377 * @ingroup Edje_Part_Text
1378 *
1379 * @{ 1373 * @{
1380 */ 1374 */
1381 1375
@@ -1385,6 +1379,7 @@ typedef void (*Edje_Text_Change_Cb) (void *data, Evas_Object *obj, c
1385 1379
1386/** 1380/**
1387 * @defgroup Edje_Part_Swallow Edje Swallow Part 1381 * @defgroup Edje_Part_Swallow Edje Swallow Part
1382 * @ingroup Edje_Object_Part
1388 * 1383 *
1389 * @brief Functions that deal with parts of type swallow and swallowed objects. 1384 * @brief Functions that deal with parts of type swallow and swallowed objects.
1390 * 1385 *
@@ -1397,7 +1392,6 @@ typedef void (*Edje_Text_Change_Cb) (void *data, Evas_Object *obj, c
1397 * objects that are not native of Edje. In this last case, Edje will 1392 * objects that are not native of Edje. In this last case, Edje will
1398 * only treat the Evas_Object properties of the swallowed objects. 1393 * only treat the Evas_Object properties of the swallowed objects.
1399 * 1394 *
1400 * @ingroup Edje_Object_Part
1401 * 1395 *
1402 * @{ 1396 * @{
1403 */ 1397 */
@@ -1405,7 +1399,7 @@ typedef void (*Edje_Text_Change_Cb) (void *data, Evas_Object *obj, c
1405/** 1399/**
1406 * @typedef Edje_Aspect_Control 1400 * @typedef Edje_Aspect_Control
1407 * 1401 *
1408 * All Edje aspect control values 1402 * All Edje aspect control values.
1409 * 1403 *
1410 */ 1404 */
1411typedef enum _Edje_Aspect_Control 1405typedef enum _Edje_Aspect_Control
@@ -1423,6 +1417,7 @@ typedef enum _Edje_Aspect_Control
1423 1417
1424/** 1418/**
1425 * @defgroup Edje_Object_Geometry_Group Edje Object Geometry 1419 * @defgroup Edje_Object_Geometry_Group Edje Object Geometry
1420 * @ingroup Edje_Object_Group
1426 * 1421 *
1427 * @brief Functions that deal with object's geometry. 1422 * @brief Functions that deal with object's geometry.
1428 * 1423 *
@@ -1434,8 +1429,6 @@ typedef enum _Edje_Aspect_Control
1434 * the appearance in the screen of the parts inside. Most times 1429 * the appearance in the screen of the parts inside. Most times
1435 * that is what you want. 1430 * that is what you want.
1436 * 1431 *
1437 * @ingroup Edje_Object_Group
1438 *
1439 * @{ 1432 * @{
1440 */ 1433 */
1441/** 1434/**
@@ -1444,6 +1437,7 @@ typedef enum _Edje_Aspect_Control
1444 1437
1445/** 1438/**
1446 * @defgroup Edje_Part_Drag Edje Drag 1439 * @defgroup Edje_Part_Drag Edje Drag
1440 * @ingroup Edje_Object_Part
1447 * 1441 *
1448 * @brief Functions that deal with dragable parts. 1442 * @brief Functions that deal with dragable parts.
1449 * 1443 *
@@ -1456,7 +1450,6 @@ typedef enum _Edje_Aspect_Control
1456 * 1450 *
1457 * @see @ref tutorial_edje_drag 1451 * @see @ref tutorial_edje_drag
1458 * 1452 *
1459 * @ingroup Edje_Object_Part
1460 * 1453 *
1461 * @{ 1454 * @{
1462 */ 1455 */
@@ -1467,14 +1460,13 @@ typedef enum _Edje_Aspect_Control
1467 1460
1468/** 1461/**
1469 * @defgroup Edje_Part_Box Edje Box Part 1462 * @defgroup Edje_Part_Box Edje Box Part
1463 * @ingroup Edje_Object_Part
1470 * 1464 *
1471 * @brief Functions that deal with parts of type box. 1465 * @brief Functions that deal with parts of type box.
1472 * 1466 *
1473 * Box is a container type for parts, that means it can contain 1467 * Box is a container type for parts, that means it can contain
1474 * other parts. 1468 * other parts.
1475 * 1469 *
1476 * @ingroup Edje_Object_Part
1477 *
1478 * @{ 1470 * @{
1479 */ 1471 */
1480 1472
@@ -1508,21 +1500,20 @@ EAPI void edje_box_layout_register (const char *name, Evas_Object
1508 1500
1509/** 1501/**
1510 * @defgroup Edje_Part_Table Edje Table Part 1502 * @defgroup Edje_Part_Table Edje Table Part
1503 * @ingroup Edje_Object_Part
1511 * 1504 *
1512 * @brief Functions that deal with parts of type table. 1505 * @brief Functions that deal with parts of type table.
1513 * 1506 *
1514 * Table is a container type for parts, that means it can contain 1507 * Table is a container type for parts, that means it can contain
1515 * other parts. 1508 * other parts.
1516 * 1509 *
1517 * @ingroup Edje_Object_Part
1518 *
1519 * @{ 1510 * @{
1520 */ 1511 */
1521 1512
1522/** 1513/**
1523 * @typedef Edje_Object_Table_Homogeneous_Mode 1514 * @typedef Edje_Object_Table_Homogeneous_Mode
1524 * 1515 *
1525 * Table homogeneous modes 1516 * Table homogeneous modes.
1526 * 1517 *
1527 */ 1518 */
1528typedef enum _Edje_Object_Table_Homogeneous_Mode 1519typedef enum _Edje_Object_Table_Homogeneous_Mode
@@ -1538,8 +1529,8 @@ typedef enum _Edje_Object_Table_Homogeneous_Mode
1538 1529
1539/** 1530/**
1540 * @defgroup Edje_Object_Text_Class Edje Class: Text 1531 * @defgroup Edje_Object_Text_Class Edje Class: Text
1541 * 1532 * @ingroup Edje_Object_Group
1542 * @brief Functions that deal with Text Classes 1533 * @brief Functions that deal with Text Classes.
1543 * 1534 *
1544 * Sometimes we want to change the text of two or more parts equally and 1535 * Sometimes we want to change the text of two or more parts equally and
1545 * that's when we use text classes. 1536 * that's when we use text classes.
@@ -1550,19 +1541,17 @@ typedef enum _Edje_Object_Table_Homogeneous_Mode
1550 * all parts with that text class, while at object level will affect only 1541 * all parts with that text class, while at object level will affect only
1551 * the parts inside an specified object. 1542 * the parts inside an specified object.
1552 * 1543 *
1553 * @ingroup Edje_Object_Group
1554 *
1555 * @{ 1544 * @{
1556 */ 1545 */
1557 1546
1558/** 1547/**
1559 * @brief Set the Edje text class. 1548 * @brief Sets the Edje text class.
1560 * 1549 *
1561 * @param text_class The text class name 1550 * @param text_class The text class name
1562 * @param font The font name 1551 * @param font The font name
1563 * @param size The font size 1552 * @param size The font size
1564 * 1553 *
1565 * @return @c EINA_TRUE, on success or @c EINA_FALSE, on error 1554 * @return @c EINA_TRUE on success, or @c EINA_FALSE on error
1566 * 1555 *
1567 * This function updates all Edje members at the process level which 1556 * This function updates all Edje members at the process level which
1568 * belong to this text class with the new font attributes. 1557 * belong to this text class with the new font attributes.
@@ -1578,13 +1567,13 @@ typedef enum _Edje_Object_Table_Homogeneous_Mode
1578EAPI Eina_Bool edje_text_class_set (const char *text_class, const char *font, Evas_Font_Size size); 1567EAPI Eina_Bool edje_text_class_set (const char *text_class, const char *font, Evas_Font_Size size);
1579 1568
1580/** 1569/**
1581 * @brief Get the font and the font size from Edje text class. 1570 * @brief Gets the font and the font size from Edje text class.
1582 * 1571 *
1583 * @param text_class The text class name 1572 * @param text_class The text class name
1584 * @param font The font name 1573 * @param font The font name
1585 * @param size The font size 1574 * @param size The font size
1586 * 1575 *
1587 * @return @c EINA_TRUE, on success or @c EINA_FALSE, on error 1576 * @return @c EINA_TRUE on success, or @c EINA_FALSE on error
1588 * 1577 *
1589 * This function gets the font and the font name from the specified Edje 1578 * This function gets the font and the font name from the specified Edje
1590 * text class. The font string will only be valid until the text class is 1579 * text class. The font string will only be valid until the text class is
@@ -1596,7 +1585,7 @@ EAPI Eina_Bool edje_text_class_set (const char *text_class, const
1596EAPI Eina_Bool edje_text_class_get (const char *text_class, const char **font, Evas_Font_Size *size); 1585EAPI Eina_Bool edje_text_class_get (const char *text_class, const char **font, Evas_Font_Size *size);
1597 1586
1598/** 1587/**
1599 * @brief Delete the text class. 1588 * @brief Deletes the text class.
1600 * 1589 *
1601 * @param text_class The text class name string 1590 * @param text_class The text class name string
1602 * 1591 *
@@ -1607,7 +1596,7 @@ EAPI Eina_Bool edje_text_class_get (const char *text_class, const
1607EAPI void edje_text_class_del (const char *text_class); 1596EAPI void edje_text_class_del (const char *text_class);
1608 1597
1609/** 1598/**
1610 * @brief List text classes. 1599 * @brief Lists text classes.
1611 * 1600 *
1612 * @return A list of text class names (strings). These strings are 1601 * @return A list of text class names (strings). These strings are
1613 * stringshares and the list must be free()'d by the caller. 1602 * stringshares and the list must be free()'d by the caller.
@@ -1647,6 +1636,7 @@ EAPI Eina_Iterator *edje_mmap_text_class_iterator_new(Eina_File *f);
1647 1636
1648/** 1637/**
1649 * @defgroup Edje_Object_Size_Class Edje Class: Size 1638 * @defgroup Edje_Object_Size_Class Edje Class: Size
1639 * @ingroup Edje_Object_Group
1650 * 1640 *
1651 * @brief Functions that deal with Size Classes 1641 * @brief Functions that deal with Size Classes
1652 * 1642 *
@@ -1659,13 +1649,11 @@ EAPI Eina_Iterator *edje_mmap_text_class_iterator_new(Eina_File *f);
1659 * all parts with that size class, while at object level will affect only 1649 * all parts with that size class, while at object level will affect only
1660 * the parts inside an specified object. 1650 * the parts inside an specified object.
1661 * 1651 *
1662 * @ingroup Edje_Object_Group
1663 *
1664 * @{ 1652 * @{
1665 */ 1653 */
1666 1654
1667/** 1655/**
1668 * @brief Set the Edje size class. 1656 * @brief Sets the Edje size class.
1669 * 1657 *
1670 * @param size_class The size class name 1658 * @param size_class The size class name
1671 * @param minw The min width 1659 * @param minw The min width
@@ -1673,7 +1661,7 @@ EAPI Eina_Iterator *edje_mmap_text_class_iterator_new(Eina_File *f);
1673 * @param maxw The max width 1661 * @param maxw The max width
1674 * @param maxh The max height 1662 * @param maxh The max height
1675 * 1663 *
1676 * @return @c EINA_TRUE, on success or @c EINA_FALSE, on error 1664 * @return @c EINA_TRUE on success, or @c EINA_FALSE on error
1677 * 1665 *
1678 * This function updates all Edje members at the process level which 1666 * This function updates all Edje members at the process level which
1679 * belong to this size class with the new min and max attributes. 1667 * belong to this size class with the new min and max attributes.
@@ -1685,7 +1673,7 @@ EAPI Eina_Iterator *edje_mmap_text_class_iterator_new(Eina_File *f);
1685EAPI Eina_Bool edje_size_class_set (const char *size_class, Evas_Coord minw, Evas_Coord minh, Evas_Coord maxw, Evas_Coord maxh); 1673EAPI Eina_Bool edje_size_class_set (const char *size_class, Evas_Coord minw, Evas_Coord minh, Evas_Coord maxw, Evas_Coord maxh);
1686 1674
1687/** 1675/**
1688 * @brief Get the Edje size class. 1676 * @brief Gets the Edje size class.
1689 * 1677 *
1690 * @param size_class The size class name 1678 * @param size_class The size class name
1691 * @param minw The min width 1679 * @param minw The min width
@@ -1693,7 +1681,7 @@ EAPI Eina_Bool edje_size_class_set (const char *size_class, Evas_
1693 * @param maxw The max width 1681 * @param maxw The max width
1694 * @param maxh The max height 1682 * @param maxh The max height
1695 * 1683 *
1696 * @return @c EINA_TRUE, on success or @c EINA_FALSE, on error 1684 * @return @c EINA_TRUE on success, or @c EINA_FALSE on error
1697 * 1685 *
1698 * This function gets the min and max size from the specified Edje 1686 * This function gets the min and max size from the specified Edje
1699 * size class. 1687 * size class.
@@ -1703,7 +1691,7 @@ EAPI Eina_Bool edje_size_class_set (const char *size_class, Evas_
1703EAPI Eina_Bool edje_size_class_get (const char *size_class, Evas_Coord *minw, Evas_Coord *minh, Evas_Coord *maxw, Evas_Coord *maxh); 1691EAPI Eina_Bool edje_size_class_get (const char *size_class, Evas_Coord *minw, Evas_Coord *minh, Evas_Coord *maxw, Evas_Coord *maxh);
1704 1692
1705/** 1693/**
1706 * @brief Delete the size class. 1694 * @brief Deletes the size class.
1707 * 1695 *
1708 * @param size_class The size class name 1696 * @param size_class The size class name
1709 * 1697 *
@@ -1715,7 +1703,7 @@ EAPI Eina_Bool edje_size_class_get (const char *size_class, Evas_
1715EAPI void edje_size_class_del (const char *size_class); 1703EAPI void edje_size_class_del (const char *size_class);
1716 1704
1717/** 1705/**
1718 * @brief List size classes. 1706 * @brief Lists size classes.
1719 * 1707 *
1720 * @return A list of size class names (strings). These strings are 1708 * @return A list of size class names (strings). These strings are
1721 * stringshares and the list must be eina_stringshare_del()'ed by the caller. 1709 * stringshares and the list must be eina_stringshare_del()'ed by the caller.
@@ -1728,9 +1716,9 @@ EAPI void edje_size_class_del (const char *size_class);
1728EAPI Eina_List *edje_size_class_list (void); 1716EAPI Eina_List *edje_size_class_list (void);
1729 1717
1730/** 1718/**
1731 * @brief Iterate over all active classes of an application. 1719 * @brief Iterates over all active classes of an application.
1732 * 1720 *
1733 * @return an iterator of Edje_Size_Class of the currently active size class 1721 * @return An iterator of Edje_Size_Class of the currently active size class
1734 * 1722 *
1735 * This function only iterates over the Edje_Size_Class in use by 1723 * This function only iterates over the Edje_Size_Class in use by
1736 * an application. 1724 * an application.
@@ -1740,7 +1728,7 @@ EAPI Eina_List *edje_size_class_list (void);
1740EAPI Eina_Iterator *edje_size_class_active_iterator_new(void); 1728EAPI Eina_Iterator *edje_size_class_active_iterator_new(void);
1741 1729
1742/** 1730/**
1743 * @brief Iterate over all size classes provided by an Edje file. 1731 * @brief Iterates over all size classes provided by an Edje file.
1744 * 1732 *
1745 * @return an iterator of Edje_Size_Class provided by the Edje file. 1733 * @return an iterator of Edje_Size_Class provided by the Edje file.
1746 * 1734 *
@@ -1754,6 +1742,7 @@ EAPI Eina_Iterator *edje_mmap_size_class_iterator_new(Eina_File *f);
1754 1742
1755/** 1743/**
1756 * @defgroup Edje_Object_File Edje Object File 1744 * @defgroup Edje_Object_File Edje Object File
1745 * @ingroup Edje_Object_Group
1757 * 1746 *
1758 * @brief Functions to deals with EDJ files. 1747 * @brief Functions to deals with EDJ files.
1759 * 1748 *
@@ -1767,13 +1756,11 @@ EAPI Eina_Iterator *edje_mmap_size_class_iterator_new(Eina_File *f);
1767 * either by loading them or retrieving information of the EDC 1756 * either by loading them or retrieving information of the EDC
1768 * file about objects. 1757 * file about objects.
1769 * 1758 *
1770 * @ingroup Edje_Object_Group
1771 *
1772 * @{ 1759 * @{
1773 */ 1760 */
1774 1761
1775/** 1762/**
1776 * Get a list of groups in an edje mapped file 1763 * @brief Gets a list of groups in an edje mapped file.
1777 * @param f The mapped file 1764 * @param f The mapped file
1778 * 1765 *
1779 * @return The Eina_List of group names (char *) 1766 * @return The Eina_List of group names (char *)
@@ -1784,7 +1771,7 @@ EAPI Eina_Iterator *edje_mmap_size_class_iterator_new(Eina_File *f);
1784EAPI Eina_List *edje_mmap_collection_list(Eina_File *f); 1771EAPI Eina_List *edje_mmap_collection_list(Eina_File *f);
1785 1772
1786/** 1773/**
1787 * Free file collection list 1774 * @brief Frees file collection list.
1788 * @param lst The Eina_List of groups 1775 * @param lst The Eina_List of groups
1789 * 1776 *
1790 * Frees the list returned by edje_mmap_collection_list(). 1777 * Frees the list returned by edje_mmap_collection_list().
@@ -1792,27 +1779,27 @@ EAPI Eina_List *edje_mmap_collection_list(Eina_File *f);
1792EAPI void edje_mmap_collection_list_free(Eina_List *lst); 1779EAPI void edje_mmap_collection_list_free(Eina_List *lst);
1793 1780
1794/** 1781/**
1795 * Determine whether a group matching glob exists in an edje mapped file. 1782 * @brief Determines whether a group matching glob exists in an edje mapped file.
1796 * @param f The mapped file 1783 * @param f The mapped file
1797 * @param glob A glob to match on 1784 * @param glob A glob to match on
1798 * 1785 *
1799 * @return 1 if a match is found, 0 otherwise 1786 * @return @c 1 if a match is found, @c 0 otherwise
1800 */ 1787 */
1801EAPI Eina_Bool edje_mmap_group_exists(Eina_File *f, const char *glob); 1788EAPI Eina_Bool edje_mmap_group_exists(Eina_File *f, const char *glob);
1802 1789
1803/** 1790/**
1804 * Determine whether a group have 3D Scene. 1791 * @brief Determines whether a group have 3D Scene.
1805 * @param f The mapped file 1792 * @param f The mapped file
1806 * @param glob The group name 1793 * @param glob The group name
1807 * 1794 *
1808 * @return 1 if a Scene is found is found, 0 otherwise 1795 * @return @c 1 if a Scene is found is found, @c 0 otherwise
1809 * 1796 *
1810 * @since 1.18 1797 * @since 1.18
1811 */ 1798 */
1812EAPI Eina_Bool edje_mmap_3d_has(Eina_File *f, const char *group); 1799EAPI Eina_Bool edje_mmap_3d_has(Eina_File *f, const char *group);
1813 1800
1814/** 1801/**
1815 * @brief Iterate over all the opened Edje file. 1802 * @brief Iterates over all the opened Edje file.
1816 * 1803 *
1817 * @return an iterator of Eina_File currently opened Edje file. 1804 * @return an iterator of Eina_File currently opened Edje file.
1818 * 1805 *
@@ -1821,7 +1808,7 @@ EAPI Eina_Bool edje_mmap_3d_has(Eina_File *f, const char *group);
1821EAPI Eina_Iterator *edje_file_iterator_new(void); 1808EAPI Eina_Iterator *edje_file_iterator_new(void);
1822 1809
1823/** 1810/**
1824 * Get a list of groups in an edje file 1811 * @brief Gets a list of groups in an edje file.
1825 * @param file The path to the edje file 1812 * @param file The path to the edje file
1826 * 1813 *
1827 * @return The Eina_List of group names (char *) 1814 * @return The Eina_List of group names (char *)
@@ -1835,7 +1822,7 @@ EAPI Eina_Iterator *edje_file_iterator_new(void);
1835EAPI Eina_List *edje_file_collection_list (const char *file); 1822EAPI Eina_List *edje_file_collection_list (const char *file);
1836 1823
1837/** 1824/**
1838 * Free file collection list 1825 * @brief Frees file collection list.
1839 * @param lst The Eina_List of groups 1826 * @param lst The Eina_List of groups
1840 * 1827 *
1841 * Frees the list returned by edje_file_collection_list(). 1828 * Frees the list returned by edje_file_collection_list().
@@ -1843,16 +1830,16 @@ EAPI Eina_List *edje_file_collection_list (const char *file);
1843EAPI void edje_file_collection_list_free (Eina_List *lst); 1830EAPI void edje_file_collection_list_free (Eina_List *lst);
1844 1831
1845/** 1832/**
1846 * Determine whether a group matching glob exists in an edje file. 1833 * @brief Determines whether a group matching glob exists in an edje file.
1847 * @param file The file path 1834 * @param file The file path
1848 * @param glob A glob to match on 1835 * @param glob A glob to match on
1849 * 1836 *
1850 * @return 1 if a match is found, 0 otherwise 1837 * @return @c 1 if a match is found, @c 0 otherwise
1851 */ 1838 */
1852EAPI Eina_Bool edje_file_group_exists (const char *file, const char *glob); 1839EAPI Eina_Bool edje_file_group_exists (const char *file, const char *glob);
1853 1840
1854/** 1841/**
1855 * Converts the given Edje file load error code into a string 1842 * @brief Converts the given Edje file load error code into a string
1856 * describing it in English. 1843 * describing it in English.
1857 * 1844 *
1858 * @param error the error code, a value in ::Edje_Load_Error. 1845 * @param error the error code, a value in ::Edje_Load_Error.
@@ -1873,13 +1860,11 @@ EAPI const char *edje_load_error_str (Edje_Load_Error error);
1873 1860
1874/** 1861/**
1875 * @defgroup Edje_Object_Animation Edje Object Animation 1862 * @defgroup Edje_Object_Animation Edje Object Animation
1876 * 1863 * @ingroup Edje_Object_Group
1877 * @brief Functions that deal with animations. 1864 * @brief Functions that deal with animations.
1878 * 1865 *
1879 * Edje has the ability to animate objects. One can start, stop, play, 1866 * Edje has the ability to animate objects. One can start, stop, play,
1880 * pause, freeze and thaw edje animations using the functions of this section. 1867 * pause, freeze, and thaw edje animations using the functions of this section.
1881 *
1882 * @ingroup Edje_Object_Group
1883 * 1868 *
1884 * @{ 1869 * @{
1885 */ 1870 */
@@ -1887,7 +1872,7 @@ EAPI const char *edje_load_error_str (Edje_Load_Error error);
1887/** 1872/**
1888 * @typedef Edje_Tween_Mode 1873 * @typedef Edje_Tween_Mode
1889 * 1874 *
1890 * Available tween mode for edje animations 1875 * Available tween mode for edje animations.
1891 */ 1876 */
1892typedef enum _Edje_Tween_Mode 1877typedef enum _Edje_Tween_Mode
1893{ 1878{
@@ -1946,7 +1931,7 @@ typedef enum _Edje_Action_Type
1946} Edje_Action_Type; 1931} Edje_Action_Type;
1947 1932
1948/** 1933/**
1949 * @brief Set edje trasitions' frame time. 1934 * @brief Sets edje transitions' frame time.
1950 * 1935 *
1951 * @param t The frame time, in seconds. Default value is 1/30. 1936 * @param t The frame time, in seconds. Default value is 1/30.
1952 * 1937 *
@@ -1961,7 +1946,7 @@ typedef enum _Edje_Action_Type
1961EAPI void edje_frametime_set (double t); 1946EAPI void edje_frametime_set (double t);
1962 1947
1963/** 1948/**
1964 * @brief Get edje trasitions' frame time. 1949 * @brief Gets edje transitions' frame time.
1965 * 1950 *
1966 * @return The frame time, in seconds. 1951 * @return The frame time, in seconds.
1967 * 1952 *
@@ -1974,7 +1959,7 @@ EAPI void edje_frametime_set (double t);
1974EAPI double edje_frametime_get (void); 1959EAPI double edje_frametime_get (void);
1975 1960
1976/** 1961/**
1977 * @brief Freeze Edje objects. 1962 * @brief Freezes Edje objects.
1978 * 1963 *
1979 * This function freezes all Edje animations in the current process. 1964 * This function freezes all Edje animations in the current process.
1980 * 1965 *
@@ -1986,7 +1971,7 @@ EAPI double edje_frametime_get (void);
1986EAPI void edje_freeze (void); 1971EAPI void edje_freeze (void);
1987 1972
1988/** 1973/**
1989 * @brief Thaw Edje objects. 1974 * @brief Thaws Edje objects.
1990 * 1975 *
1991 * This function thaws all Edje animations in the current process. 1976 * This function thaws all Edje animations in the current process.
1992 * 1977 *
@@ -1998,7 +1983,7 @@ EAPI void edje_freeze (void);
1998EAPI void edje_thaw (void); 1983EAPI void edje_thaw (void);
1999 1984
2000/** 1985/**
2001 * @brief Set's Edje language. 1986 * @brief Sets Edje language.
2002 * 1987 *
2003 * This function sets the given language. 1988 * This function sets the given language.
2004 * 1989 *
@@ -2009,9 +1994,9 @@ EAPI void edje_thaw (void);
2009EAPI void edje_language_set (const char *locale); 1994EAPI void edje_language_set (const char *locale);
2010 1995
2011/** 1996/**
2012 * @brief Set edje transition duration factor. 1997 * @brief Sets edje transition duration factor.
2013 * 1998 *
2014 * @param scale The edje trasition's duration factor (the default value is @c 1.0) 1999 * @param scale The edje transition's duration factor (the default value is @c 1.0)
2015 * 2000 *
2016 * This function sets the edje transition duration factor 2001 * This function sets the edje transition duration factor
2017 * It will affect the speed of transitions 2002 * It will affect the speed of transitions
@@ -2032,7 +2017,7 @@ EAPI void edje_language_set (const char *locale);
2032EAPI void edje_transition_duration_factor_set (double scale); 2017EAPI void edje_transition_duration_factor_set (double scale);
2033 2018
2034/** 2019/**
2035 * @brief Retrieve transitions duration factor. 2020 * @brief Retrieves transitions duration factor.
2036 * 2021 *
2037 * @return The edje transition duration factor 2022 * @return The edje transition duration factor
2038 * 2023 *
@@ -2051,6 +2036,7 @@ EAPI double edje_transition_duration_factor_get (void);
2051 2036
2052/** 2037/**
2053 * @defgroup Edje_Object_Communication_Interface_Message Edje Communication Interface: Message 2038 * @defgroup Edje_Object_Communication_Interface_Message Edje Communication Interface: Message
2039 * @ingroup Edje_Object_Group
2054 * 2040 *
2055 * @brief Functions that deal with messages. 2041 * @brief Functions that deal with messages.
2056 * 2042 *
@@ -2065,8 +2051,6 @@ EAPI double edje_transition_duration_factor_get (void);
2065 * 2051 *
2066 * @note Messages must be handled by scripts. 2052 * @note Messages must be handled by scripts.
2067 * 2053 *
2068 * @ingroup Edje_Object_Group
2069 *
2070 * @{ 2054 * @{
2071 */ 2055 */
2072 2056
@@ -2143,7 +2127,7 @@ struct _Edje_Message_String_Float_Set
2143typedef void (*Edje_Message_Handler_Cb) (void *data, Evas_Object *obj, Edje_Message_Type type, int id, void *msg); /**< Edje message handler callback functions's prototype definition. @c data will have the auxiliary data pointer set at the time the callback registration. @c obj will be a pointer the Edje object where the message comes from. @c type will identify the type of the given message and @c msg will be a pointer the message's contents, de facto, which depend on @c type. */ 2127typedef void (*Edje_Message_Handler_Cb) (void *data, Evas_Object *obj, Edje_Message_Type type, int id, void *msg); /**< Edje message handler callback functions's prototype definition. @c data will have the auxiliary data pointer set at the time the callback registration. @c obj will be a pointer the Edje object where the message comes from. @c type will identify the type of the given message and @c msg will be a pointer the message's contents, de facto, which depend on @c type. */
2144 2128
2145/** 2129/**
2146 * @brief Process all queued up edje messages. 2130 * @brief Processes all queued up edje messages.
2147 * 2131 *
2148 * This function triggers the processing of messages addressed to any 2132 * This function triggers the processing of messages addressed to any
2149 * (alive) edje objects. 2133 * (alive) edje objects.
@@ -2157,6 +2141,7 @@ EAPI void edje_message_signal_process (void);
2157 2141
2158/** 2142/**
2159 * @defgroup Edje_Perspective Edje Perspective 2143 * @defgroup Edje_Perspective Edje Perspective
2144 * @ingroup Edje_Object_Group
2160 * 2145 *
2161 * @brief Functions that deal with 3D projection of an 2D object. 2146 * @brief Functions that deal with 3D projection of an 2D object.
2162 * 2147 *
@@ -2169,13 +2154,11 @@ EAPI void edje_message_signal_process (void);
2169 * affecting all the objects inside that have no particular perspective 2154 * affecting all the objects inside that have no particular perspective
2170 * set already. 2155 * set already.
2171 * 2156 *
2172 * @ingroup Edje_Object_Group
2173 *
2174 * @{ 2157 * @{
2175 */ 2158 */
2176 2159
2177/** 2160/**
2178 * Creates a new perspective in the given canvas. 2161 * @brief Creates a new perspective in the given canvas.
2179 * 2162 *
2180 * @param e The given canvas (Evas). 2163 * @param e The given canvas (Evas).
2181 * @return An @ref Edje_Perspective object for this canvas, or @c NULL on errors. 2164 * @return An @ref Edje_Perspective object for this canvas, or @c NULL on errors.
@@ -2188,7 +2171,7 @@ EAPI void edje_message_signal_process (void);
2188 */ 2171 */
2189EAPI Edje_Perspective *edje_perspective_new (Evas *e); 2172EAPI Edje_Perspective *edje_perspective_new (Evas *e);
2190/** 2173/**
2191 * Delete the given perspective object. 2174 * @brief Deletes the given perspective object.
2192 * 2175 *
2193 * @param ps A valid perspective object, or @c NULL. 2176 * @param ps A valid perspective object, or @c NULL.
2194 * 2177 *
@@ -2200,7 +2183,7 @@ EAPI Edje_Perspective *edje_perspective_new (Evas *e);
2200 */ 2183 */
2201EAPI void edje_perspective_free (Edje_Perspective *ps); 2184EAPI void edje_perspective_free (Edje_Perspective *ps);
2202/** 2185/**
2203 * Setup the transform for this perspective object. 2186 * @brief Sets up the transform for this perspective object.
2204 * 2187 *
2205 * This sets the parameters of the perspective transformation. X, Y and Z 2188 * This sets the parameters of the perspective transformation. X, Y and Z
2206 * values are used. The px and py points specify the "infinite distance" point 2189 * values are used. The px and py points specify the "infinite distance" point
@@ -2223,7 +2206,7 @@ EAPI void edje_perspective_free (Edje_Perspective *
2223 */ 2206 */
2224EAPI void edje_perspective_set (Edje_Perspective *ps, Evas_Coord px, Evas_Coord py, Evas_Coord z0, Evas_Coord foc); 2207EAPI void edje_perspective_set (Edje_Perspective *ps, Evas_Coord px, Evas_Coord py, Evas_Coord z0, Evas_Coord foc);
2225/** 2208/**
2226 * Make this perspective object be global for its canvas. 2209 * @brief Makes this perspective object be global for its canvas.
2227 * 2210 *
2228 * @param ps The given perspective object 2211 * @param ps The given perspective object
2229 * @param global @c EINA_TRUE if the perspective should be global, @c 2212 * @param global @c EINA_TRUE if the perspective should be global, @c
@@ -2247,7 +2230,7 @@ EAPI void edje_perspective_set (Edje_Perspective *
2247 */ 2230 */
2248EAPI void edje_perspective_global_set (Edje_Perspective *ps, Eina_Bool global); 2231EAPI void edje_perspective_global_set (Edje_Perspective *ps, Eina_Bool global);
2249/** 2232/**
2250 * Get whether the given perspective object is global or not. 2233 * @brief Gets whether the given perspective object is global or not.
2251 * 2234 *
2252 * @param ps The given perspective object. 2235 * @param ps The given perspective object.
2253 * @return @c EINA_TRUE if this perspective object is global, @c EINA_FALSE 2236 * @return @c EINA_TRUE if this perspective object is global, @c EINA_FALSE
@@ -2257,7 +2240,7 @@ EAPI void edje_perspective_global_set (Edje_Perspective *
2257 */ 2240 */
2258EAPI Eina_Bool edje_perspective_global_get (const Edje_Perspective *ps); 2241EAPI Eina_Bool edje_perspective_global_get (const Edje_Perspective *ps);
2259/** 2242/**
2260 * Get the global perspective object set for this canvas. 2243 * @brief Gets the global perspective object set for this canvas.
2261 * 2244 *
2262 * @param e The given canvas (Evas). 2245 * @param e The given canvas (Evas).
2263 * @return The perspective object set as global for this canvas. Or @c NULL 2246 * @return The perspective object set as global for this canvas. Or @c NULL
@@ -2276,6 +2259,7 @@ EAPI const Edje_Perspective *edje_evas_global_perspective_get(const Evas *e);
2276 2259
2277/** 2260/**
2278 * @defgroup Edje_Audio Edje Audio 2261 * @defgroup Edje_Audio Edje Audio
2262 * @ingroup Edje_Audio
2279 * 2263 *
2280 * @brief Functions to manipulate audio abilities in edje. 2264 * @brief Functions to manipulate audio abilities in edje.
2281 * 2265 *
@@ -2288,8 +2272,6 @@ EAPI const Edje_Perspective *edje_evas_global_perspective_get(const Evas *e);
2288 * affecting all the objects inside that have no particular perspective 2272 * affecting all the objects inside that have no particular perspective
2289 * set already. 2273 * set already.
2290 * 2274 *
2291 * @ingroup Edje_Audio
2292 *
2293 * @{ 2275 * @{
2294 */ 2276 */
2295 2277
@@ -2315,7 +2297,7 @@ typedef enum _Edje_Channel
2315} Edje_Channel; 2297} Edje_Channel;
2316 2298
2317/** 2299/**
2318 * Set the mute state of audio for the process as a whole 2300 * @brief Sets the mute state of audio for the process as a whole.
2319 * 2301 *
2320 * @param channel The channel to set the mute state of 2302 * @param channel The channel to set the mute state of
2321 * @param mute The mute state 2303 * @param mute The mute state
@@ -2329,7 +2311,7 @@ typedef enum _Edje_Channel
2329EAPI void edje_audio_channel_mute_set(Edje_Channel channel, Eina_Bool mute); 2311EAPI void edje_audio_channel_mute_set(Edje_Channel channel, Eina_Bool mute);
2330 2312
2331/** 2313/**
2332 * Get the mute state of the given channel 2314 * @brief Gets the mute state of the given channel.
2333 * 2315 *
2334 * @param channel The channel to get the mute state of 2316 * @param channel The channel to get the mute state of
2335 * @return The mute state of the channel 2317 * @return The mute state of the channel
@@ -2341,7 +2323,7 @@ EAPI void edje_audio_channel_mute_set(Edje_Channel channel, Eina_Bool mute);
2341EAPI Eina_Bool edje_audio_channel_mute_get(Edje_Channel channel); 2323EAPI Eina_Bool edje_audio_channel_mute_get(Edje_Channel channel);
2342 2324
2343/** 2325/**
2344 * Get the part name of an edje part object 2326 * @brief Gets the part name of an edje part object.
2345 * @param obj An edje part object 2327 * @param obj An edje part object
2346 * @return The name of the part, if the object is an edje part, or @c NULL 2328 * @return The name of the part, if the object is an edje part, or @c NULL
2347 * @note If this function returns @c NULL, @p obj was not an Edje part object 2329 * @note If this function returns @c NULL, @p obj was not an Edje part object
@@ -2353,7 +2335,7 @@ EAPI const char *edje_object_part_object_name_get(const Evas_Object *obj);
2353#ifdef EFL_BETA_API_SUPPORT 2335#ifdef EFL_BETA_API_SUPPORT
2354 2336
2355/** 2337/**
2356 * Create scene and root node which contains all 3D parts of edje object 2338 * @brief Creates scene and root node which contains all 3D parts of edje object.
2357 * @param obj An edje part object 2339 * @param obj An edje part object
2358 * @param root node to collect all 3D parts 2340 * @param root node to collect all 3D parts
2359 * @param scene 2341 * @param scene
diff --git a/src/lib/edje/Edje_Edit.h b/src/lib/edje/Edje_Edit.h
index 2b6c1c610c..7bb5a07c1f 100644
--- a/src/lib/edje/Edje_Edit.h
+++ b/src/lib/edje/Edje_Edit.h
@@ -194,12 +194,13 @@ extern "C" {
194/******************************************************************************/ 194/******************************************************************************/
195/************************** GENERAL API ***********************************/ 195/************************** GENERAL API ***********************************/
196/******************************************************************************/ 196/******************************************************************************/
197/** @name General API 197/**
198 * General functions that don't fit in other cateories. 198 * @name General API
199 * General functions that don't fit in other categories.
199 */ //@{ 200 */ //@{
200 201
201/** Adds an editable Edje object to the canvas. 202/**
202 * 203 * @brief Adds an editable Edje object to the canvas.
203 * An Edje_Edit object is, for the most part, a standard Edje object. Only 204 * An Edje_Edit object is, for the most part, a standard Edje object. Only
204 * difference is you can use the Edje_Edit API on them. 205 * difference is you can use the Edje_Edit API on them.
205 * 206 *
@@ -209,19 +210,20 @@ extern "C" {
209 */ 210 */
210EAPI Evas_Object * edje_edit_object_add(Evas *e); 211EAPI Evas_Object * edje_edit_object_add(Evas *e);
211 212
212/** Free a generic Eina_List of (char *) allocated by an edje_edit_*_get() function. 213/**
213 * 214 * @brief Frees a generic Eina_List of (char *) allocated by an edje_edit_*_get() function.
214 * @param lst List of strings to free. 215 * @param lst List of strings to free.
215 */ 216 */
216EAPI void edje_edit_string_list_free(Eina_List *lst); 217EAPI void edje_edit_string_list_free(Eina_List *lst);
217 218
218/** Free a generic string (char *) allocated by an edje_edit_*_get() function. 219/**
219 * 220 * @brief Frees a generic string (char *) allocated by an edje_edit_*_get() function.
220 * @param str String to free. 221 * @param str String to free.
221 */ 222 */
222EAPI void edje_edit_string_free(const char *str); 223EAPI void edje_edit_string_free(const char *str);
223 224
224/** Get the name of the program that compiled the edje file. 225/**
226 * @brief Gets the name of the program that compiled the edje file.
225 * Can be 'edje_cc' or 'edje_edit' 227 * Can be 'edje_cc' or 'edje_edit'
226 * 228 *
227 * @param obj Object being edited. 229 * @param obj Object being edited.
@@ -230,8 +232,8 @@ EAPI void edje_edit_string_free(const char *str);
230 */ 232 */
231EAPI const char * edje_edit_compiler_get(Evas_Object *obj); 233EAPI const char * edje_edit_compiler_get(Evas_Object *obj);
232 234
233/** Save the modified edje object back to his file. 235/**
234 * 236 * @brief Saves the modified edje object back to his file.
235 * Use this function when you are done with your editing, all the change made 237 * Use this function when you are done with your editing, all the change made
236 * to the current loaded group will be saved back to the original file. 238 * to the current loaded group will be saved back to the original file.
237 * 239 *
@@ -246,8 +248,8 @@ EAPI const char * edje_edit_compiler_get(Evas_Object *obj);
246 */ 248 */
247EAPI Eina_Bool edje_edit_save(Evas_Object *obj); 249EAPI Eina_Bool edje_edit_save(Evas_Object *obj);
248 250
249/** Saves every group back into the file. 251/**
250 * 252 * @brief Saves every group back into the file.
251 * @param obj Object to save. 253 * @param obj Object to save.
252 * 254 *
253 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 255 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
@@ -256,8 +258,8 @@ EAPI Eina_Bool edje_edit_save(Evas_Object *obj);
256 */ 258 */
257EAPI Eina_Bool edje_edit_save_all(Evas_Object *obj); 259EAPI Eina_Bool edje_edit_save_all(Evas_Object *obj);
258 260
259/** Save every group into new file. 261/**
260 * 262 * @brief Saves every group into new file.
261 * Use this function when you need clean eet dictionary in .edj file from 263 * Use this function when you need clean eet dictionary in .edj file from
262 * unnecessary text entries (e.g. names of deleted groups etc.). 264 * unnecessary text entries (e.g. names of deleted groups etc.).
263 * 265 *
@@ -271,8 +273,8 @@ EAPI Eina_Bool edje_edit_save_all(Evas_Object *obj);
271 */ 273 */
272EAPI Eina_Bool edje_edit_clean_save_as(Evas_Object *obj, const char* new_file_name); 274EAPI Eina_Bool edje_edit_clean_save_as(Evas_Object *obj, const char* new_file_name);
273 275
274/** Save the group(s) back to the file, without generation source code. 276/**
275 * 277 * @brief Saves the group(s) back to the file, without generation source code.
276 * This function saves changes in group(s) back into the edj file. Process of 278 * This function saves changes in group(s) back into the edj file. Process of
277 * saving takes a bit time in compare with @see edje_edit_save() and @see edje_edit_save_all(), 279 * saving takes a bit time in compare with @see edje_edit_save() and @see edje_edit_save_all(),
278 * because this function DOES NOT generate source code for groups. 280 * because this function DOES NOT generate source code for groups.
@@ -292,7 +294,8 @@ EAPI Eina_Bool edje_edit_clean_save_as(Evas_Object *obj, const char* new_file_na
292 */ 294 */
293EAPI Eina_Bool edje_edit_without_source_save(Evas_Object *obj, Eina_Bool current_group); 295EAPI Eina_Bool edje_edit_without_source_save(Evas_Object *obj, Eina_Bool current_group);
294 296
295/** Print on standard output many information about the internal status 297/**
298 * @brief Prints on standard output many information about the internal status
296 * of the edje object. 299 * of the edje object.
297 * 300 *
298 * This is probably only useful to debug. 301 * This is probably only useful to debug.
@@ -306,12 +309,13 @@ EAPI void edje_edit_print_internal_status(Evas_Object *obj);
306/******************************************************************************/ 309/******************************************************************************/
307/************************** GROUPS API ************************************/ 310/************************** GROUPS API ************************************/
308/******************************************************************************/ 311/******************************************************************************/
309/** @name Groups API 312/**
310 * Functions to deal with groups property (see @ref edcref). 313 * @name Groups API
314 * Functions to deal with groups property (see @ref edcref).
311 */ //@{ 315 */ //@{
312 316
313/** 317/**
314 * @brief Add an edje (empty) group to an edje object's group set. 318 * @brief Adds an edje (empty) group to an edje object's group set.
315 * 319 *
316 * @param obj The pointer to edje object. 320 * @param obj The pointer to edje object.
317 * @param name The name of the group. 321 * @param name The name of the group.
@@ -330,7 +334,7 @@ EAPI void edje_edit_print_internal_status(Evas_Object *obj);
330EAPI Eina_Bool edje_edit_group_add(Evas_Object *obj, const char *name); 334EAPI Eina_Bool edje_edit_group_add(Evas_Object *obj, const char *name);
331 335
332/** 336/**
333 * @brief Copy whole group and all it's data into separate group. 337 * @brief Copies whole group and all it's data into separate group.
334 * 338 *
335 * @param obj The pointer to edje object. 339 * @param obj The pointer to edje object.
336 * @param group_name The name of the group. 340 * @param group_name The name of the group.
@@ -354,7 +358,7 @@ EAPI Eina_Bool edje_edit_group_add(Evas_Object *obj, const char *name);
354EAPI Eina_Bool edje_edit_group_copy(Evas_Object *obj, const char *group_name, const char *copy_name); 358EAPI Eina_Bool edje_edit_group_copy(Evas_Object *obj, const char *group_name, const char *copy_name);
355 359
356/** 360/**
357 * @brief Delete the specified group from the edje file. 361 * @brief Deletes the specified group from the edje file.
358 * 362 *
359 * @param obj The pointer to the edje object. 363 * @param obj The pointer to the edje object.
360 * @param group_name Group to delete. 364 * @param group_name Group to delete.
@@ -375,8 +379,8 @@ EAPI Eina_Bool edje_edit_group_copy(Evas_Object *obj, const char *group_name, co
375 */ 379 */
376EAPI Eina_Bool edje_edit_group_del(Evas_Object *obj, const char *group_name); 380EAPI Eina_Bool edje_edit_group_del(Evas_Object *obj, const char *group_name);
377 381
378/** Check if a group with the given name exist in the edje. 382/**
379 * 383 * @brief Checks if a group with the given name exist in the edje.
380 * @param obj Object being edited. 384 * @param obj Object being edited.
381 * @param group Group name to check for. 385 * @param group Group name to check for.
382 * 386 *
@@ -384,7 +388,8 @@ EAPI Eina_Bool edje_edit_group_del(Evas_Object *obj, const char *group_name);
384 */ 388 */
385EAPI Eina_Bool edje_edit_group_exist(Evas_Object *obj, const char *group); 389EAPI Eina_Bool edje_edit_group_exist(Evas_Object *obj, const char *group);
386 390
387/** Set a new name for the current open group. 391/**
392 * @brief Sets a new name for the current open group.
388 * 393 *
389 * You can only rename a group that is currently loaded 394 * You can only rename a group that is currently loaded
390 * Note that the relative getter function don't exist as it doesn't make sense ;) 395 * Note that the relative getter function don't exist as it doesn't make sense ;)
@@ -395,7 +400,8 @@ EAPI Eina_Bool edje_edit_group_exist(Evas_Object *obj, const char *group);
395 */ 400 */
396EAPI Eina_Bool edje_edit_group_name_set(Evas_Object *obj, const char *new_name); 401EAPI Eina_Bool edje_edit_group_name_set(Evas_Object *obj, const char *new_name);
397 402
398/** Get the group minimum width. 403/**
404 * @brief Gets the group minimum width.
399 * 405 *
400 * @param obj Object being edited. 406 * @param obj Object being edited.
401 * 407 *
@@ -403,7 +409,8 @@ EAPI Eina_Bool edje_edit_group_name_set(Evas_Object *obj, const char *new_name);
403 */ 409 */
404EAPI int edje_edit_group_min_w_get(Evas_Object *obj); 410EAPI int edje_edit_group_min_w_get(Evas_Object *obj);
405 411
406/** Set the group minimum width. 412/**
413 * @brief Sets the group minimum width.
407 * 414 *
408 * @param obj Object being edited. 415 * @param obj Object being edited.
409 * @param w New minimum width for the group. 416 * @param w New minimum width for the group.
@@ -412,15 +419,17 @@ EAPI int edje_edit_group_min_w_get(Evas_Object *obj);
412 */ 419 */
413EAPI Eina_Bool edje_edit_group_min_w_set(Evas_Object *obj, int w); 420EAPI Eina_Bool edje_edit_group_min_w_set(Evas_Object *obj, int w);
414 421
415/** Get the group minimum height. 422/**
423 * @brief Gets the group minimum height.
416 * 424 *
417 * @param obj Object being edited. 425 * @param obj Object being edited.
418 * 426 *
419 * @return The minimum height set for the group. -1 if an error occurred. 427 * @return The minimum height set for the group. @c -1 if an error occurred.
420 */ 428 */
421EAPI int edje_edit_group_min_h_get(Evas_Object *obj); 429EAPI int edje_edit_group_min_h_get(Evas_Object *obj);
422 430
423/** Set the group minimum height. 431/**
432 * @brief Sets the group minimum height.
424 * 433 *
425 * @param obj Object being edited. 434 * @param obj Object being edited.
426 * @param h New minimum height for the group. 435 * @param h New minimum height for the group.
@@ -429,15 +438,17 @@ EAPI int edje_edit_group_min_h_get(Evas_Object *obj);
429 */ 438 */
430EAPI Eina_Bool edje_edit_group_min_h_set(Evas_Object *obj, int h); 439EAPI Eina_Bool edje_edit_group_min_h_set(Evas_Object *obj, int h);
431 440
432/** Get the group maximum width. 441/**
442 * @brief Gets the group maximum width.
433 * 443 *
434 * @param obj Object being edited. 444 * @param obj Object being edited.
435 * 445 *
436 * @return The maximum width set for the group. -1 if an error occurred. 446 * @return The maximum width set for the group. @c -1 if an error occurred.
437 */ 447 */
438EAPI int edje_edit_group_max_w_get(Evas_Object *obj); 448EAPI int edje_edit_group_max_w_get(Evas_Object *obj);
439 449
440/** Set the group maximum width. 450/**
451 * @brief Sets the group maximum width.
441 * 452 *
442 * @param obj Object being edited. 453 * @param obj Object being edited.
443 * @param w New maximum width for the group. 454 * @param w New maximum width for the group.
@@ -446,15 +457,17 @@ EAPI int edje_edit_group_max_w_get(Evas_Object *obj);
446 */ 457 */
447EAPI Eina_Bool edje_edit_group_max_w_set(Evas_Object *obj, int w); 458EAPI Eina_Bool edje_edit_group_max_w_set(Evas_Object *obj, int w);
448 459
449/** Get the group maximum height. 460/**
461 * @brief Gets the group maximum height.
450 * 462 *
451 * @param obj Object being edited. 463 * @param obj Object being edited.
452 * 464 *
453 * @return The maximum height set for the group. -1 if an error occurred. 465 * @return The maximum height set for the group. @c -1 if an error occurred.
454 */ 466 */
455EAPI int edje_edit_group_max_h_get(Evas_Object *obj); 467EAPI int edje_edit_group_max_h_get(Evas_Object *obj);
456 468
457/** Set the group maximum height. 469/**
470 * @brief Sets the group maximum height.
458 * 471 *
459 * @param obj Object being edited. 472 * @param obj Object being edited.
460 * @param h New maximum height for the group. 473 * @param h New maximum height for the group.
@@ -463,7 +476,8 @@ EAPI int edje_edit_group_max_h_get(Evas_Object *obj);
463 */ 476 */
464EAPI Eina_Bool edje_edit_group_max_h_set(Evas_Object *obj, int h); 477EAPI Eina_Bool edje_edit_group_max_h_set(Evas_Object *obj, int h);
465 478
466/** Get the group broadcast_signal. 479/**
480 * @brief Gets the group broadcast_signal.
467 * 481 *
468 * @param obj Object being edited. 482 * @param obj Object being edited.
469 * 483 *
@@ -472,7 +486,8 @@ EAPI Eina_Bool edje_edit_group_max_h_set(Evas_Object *obj, int h);
472 */ 486 */
473EAPI Eina_Bool edje_edit_group_broadcast_signal_get(Evas_Object *obj); 487EAPI Eina_Bool edje_edit_group_broadcast_signal_get(Evas_Object *obj);
474 488
475/** Set the group broadcast signal. 489/**
490 * @brief Sets the group broadcast signal.
476 * 491 *
477 * @param obj Object being edited. 492 * @param obj Object being edited.
478 * @param bs @c EINA_TRUE if group will accept broadcast signal, @c EINA_FALSE otherwise. 493 * @param bs @c EINA_TRUE if group will accept broadcast signal, @c EINA_FALSE otherwise.
@@ -485,7 +500,8 @@ EAPI Eina_Bool edje_edit_group_broadcast_signal_set(Evas_Object *obj, Eina_Bool
485//@} 500//@}
486 501
487 502
488/** Retrieves a list with the item names inside the vertical limits block at the group level. 503/**
504 * @brief Retrieves a list with the item names inside the vertical limits block at the group level.
489 * 505 *
490 * @param obj Object being edited. 506 * @param obj Object being edited.
491 * 507 *
@@ -493,7 +509,8 @@ EAPI Eina_Bool edje_edit_group_broadcast_signal_set(Evas_Object *obj, Eina_Bool
493 */ 509 */
494EAPI Eina_List * edje_edit_group_limits_vertical_list_get(Evas_Object *obj); 510EAPI Eina_List * edje_edit_group_limits_vertical_list_get(Evas_Object *obj);
495 511
496/** Delete given pair name-value from the vertical limits block at the group level. 512/**
513 * @brief Deletes given pair name-value from the vertical limits block at the group level.
497 * 514 *
498 * @param obj Object being edited. 515 * @param obj Object being edited.
499 * @param name Limit name. 516 * @param name Limit name.
@@ -503,7 +520,8 @@ EAPI Eina_List * edje_edit_group_limits_vertical_list_get(Evas_Object *obj);
503 */ 520 */
504EAPI Eina_Bool edje_edit_group_limits_vertical_del(Evas_Object *obj, const char *name, int value); 521EAPI Eina_Bool edje_edit_group_limits_vertical_del(Evas_Object *obj, const char *name, int value);
505 522
506/** Add given pair name-value to the vertical limits block at the group level. 523/**
524 * @brief Adds given pair name-value to the vertical limits block at the group level.
507 * 525 *
508 * @param obj Object being edited. 526 * @param obj Object being edited.
509 * @param name Limit name. 527 * @param name Limit name.
@@ -513,7 +531,8 @@ EAPI Eina_Bool edje_edit_group_limits_vertical_del(Evas_Object *obj, const char
513 */ 531 */
514EAPI Eina_Bool edje_edit_group_limits_vertical_add(Evas_Object *obj, const char *name, int value); 532EAPI Eina_Bool edje_edit_group_limits_vertical_add(Evas_Object *obj, const char *name, int value);
515 533
516/** Retrieves a list with the item names inside the horizontal limits block at the group level. 534/**
535 * @brief Retrieves a list with the item names inside the horizontal limits block at the group level.
517 * 536 *
518 * @param obj Object being edited. 537 * @param obj Object being edited.
519 * 538 *
@@ -521,7 +540,8 @@ EAPI Eina_Bool edje_edit_group_limits_vertical_add(Evas_Object *obj, const char
521 */ 540 */
522EAPI Eina_List * edje_edit_group_limits_horizontal_list_get(Evas_Object *obj); 541EAPI Eina_List * edje_edit_group_limits_horizontal_list_get(Evas_Object *obj);
523 542
524/** Delete given pair name-value from the horizontal limits block at the group level. 543/**
544 * @brief Deletes given pair name-value from the horizontal limits block at the group level.
525 * 545 *
526 * @param obj Object being edited. 546 * @param obj Object being edited.
527 * @param name Limit name. 547 * @param name Limit name.
@@ -531,7 +551,8 @@ EAPI Eina_List * edje_edit_group_limits_horizontal_list_get(Evas_Object *obj);
531 */ 551 */
532EAPI Eina_Bool edje_edit_group_limits_horizontal_del(Evas_Object *obj, const char *name, int value); 552EAPI Eina_Bool edje_edit_group_limits_horizontal_del(Evas_Object *obj, const char *name, int value);
533 553
534/** Add given pair name-value to the horizontal limits block at the group level. 554/**
555 * @brief Adds given pair name-value to the horizontal limits block at the group level.
535 * 556 *
536 * @param obj Object being edited. 557 * @param obj Object being edited.
537 * @param name Limit name. 558 * @param name Limit name.
@@ -541,7 +562,8 @@ EAPI Eina_Bool edje_edit_group_limits_horizontal_del(Evas_Object *obj, const cha
541 */ 562 */
542EAPI Eina_Bool edje_edit_group_limits_horizontal_add(Evas_Object *obj, const char *name, int value); 563EAPI Eina_Bool edje_edit_group_limits_horizontal_add(Evas_Object *obj, const char *name, int value);
543 564
544/** Free an Eina_List of (Edje_Edit_List *) allocated by an edje_edit_limits_vertical_list_get() or edje_edit_limits_horizontal_list_get() functions. 565/**
566 @brief Frees an Eina_List of (Edje_Edit_List *) allocated by an edje_edit_limits_vertical_list_get() or edje_edit_limits_horizontal_list_get() functions.
545 * 567 *
546 * @param lst List to free. 568 * @param lst List to free.
547 */ 569 */
@@ -550,12 +572,13 @@ EAPI void edje_edit_limits_list_free(Eina_List *lst);
550/******************************************************************************/ 572/******************************************************************************/
551/************************** ALIAS API **************************************/ 573/************************** ALIAS API **************************************/
552/******************************************************************************/ 574/******************************************************************************/
553/** @name Alias API 575/**
554 * Functions to deal with aliases that just another names of the group in the edje (see @ref edcref). 576 * @name Alias API
577 * Functions to deal with aliases that just another names of the group in the edje (see @ref edcref).
555 */ //@{ 578 */ //@{
556 579
557/** 580/**
558 * Retrieves a list of aliases for this group. 581 * @brief Retrieves a list of aliases for this group.
559 * If given group name is an alias name then this function will return NULL. 582 * If given group name is an alias name then this function will return NULL.
560 * 583 *
561 * @attention After you done using returned list, please use edje_edit_string_list_free to free this list. 584 * @attention After you done using returned list, please use edje_edit_string_list_free to free this list.
@@ -568,7 +591,7 @@ EAPI void edje_edit_limits_list_free(Eina_List *lst);
568EAPI Eina_List * edje_edit_group_aliases_get(Evas_Object *obj, const char *group_name); 591EAPI Eina_List * edje_edit_group_aliases_get(Evas_Object *obj, const char *group_name);
569 592
570/** 593/**
571 * Check if this group is an alias name. 594 * @brief Checks if this group is an alias name.
572 * 595 *
573 * @param obj Object being edited. 596 * @param obj Object being edited.
574 * @param alias_name Group name that is alias. 597 * @param alias_name Group name that is alias.
@@ -578,7 +601,7 @@ EAPI Eina_List * edje_edit_group_aliases_get(Evas_Object *obj, const char *group
578EAPI Eina_Bool edje_edit_group_alias_is(Evas_Object *obj, const char *alias_name); 601EAPI Eina_Bool edje_edit_group_alias_is(Evas_Object *obj, const char *alias_name);
579 602
580/** 603/**
581 * Return the main group name that is aliased by given alias name. 604 * @brief Returns the main group name that is aliased by given alias name.
582 * 605 *
583 * @attention After you done using this string, please use edje_edit_string_free to free this string. 606 * @attention After you done using this string, please use edje_edit_string_free to free this string.
584 * 607 *
@@ -590,7 +613,7 @@ EAPI Eina_Bool edje_edit_group_alias_is(Evas_Object *obj, const char *alias_name
590EAPI const char * edje_edit_group_aliased_get(Evas_Object *obj, const char *alias_name); 613EAPI const char * edje_edit_group_aliased_get(Evas_Object *obj, const char *alias_name);
591 614
592/** 615/**
593 * Add new alias to the given group. 616 * @brief Adds new alias to the given group.
594 * 617 *
595 * @attention when aliasing a group, be sure that the given group_name is no an alias. 618 * @attention when aliasing a group, be sure that the given group_name is no an alias.
596 * 619 *
@@ -606,11 +629,13 @@ EAPI Eina_Bool edje_edit_group_alias_add(Evas_Object *obj, const char *group_nam
606/******************************************************************************/ 629/******************************************************************************/
607/************************** DATA API **************************************/ 630/************************** DATA API **************************************/
608/******************************************************************************/ 631/******************************************************************************/
609/** @name Data API 632/**
610 * Functions to deal with data embedded in the edje (see @ref edcref). 633 * @name Data API
634 * Functions to deal with data embedded in the edje (see @ref edcref).
611 */ //@{ 635 */ //@{
612 636
613/** Retrieves a list with the item names inside the data block. 637/**
638 * @brief Retrieves a list with the item names inside the data block.
614 * 639 *
615 * @param obj Object being edited. 640 * @param obj Object being edited.
616 * 641 *
@@ -618,7 +643,8 @@ EAPI Eina_Bool edje_edit_group_alias_add(Evas_Object *obj, const char *group_nam
618 */ 643 */
619EAPI Eina_List * edje_edit_data_list_get(Evas_Object *obj); 644EAPI Eina_List * edje_edit_data_list_get(Evas_Object *obj);
620 645
621/** Create a new *global* data object in the given edje file. 646/**
647 * @brief Creates a new *global* data object in the given edje file.
622 * 648 *
623 * If another data entry with the same name exists, nothing is created and 649 * If another data entry with the same name exists, nothing is created and
624 * EINA_FALSE is returned. 650 * EINA_FALSE is returned.
@@ -631,7 +657,8 @@ EAPI Eina_List * edje_edit_data_list_get(Evas_Object *obj);
631 */ 657 */
632EAPI Eina_Bool edje_edit_data_add(Evas_Object *obj, const char *itemname, const char *value); 658EAPI Eina_Bool edje_edit_data_add(Evas_Object *obj, const char *itemname, const char *value);
633 659
634/** Delete the given data object from edje. 660/**
661 * @brief Deletes the given data object from edje.
635 * 662 *
636 * @param obj Object being edited. 663 * @param obj Object being edited.
637 * @param itemname Data entry to remove from the global data block. 664 * @param itemname Data entry to remove from the global data block.
@@ -640,7 +667,8 @@ EAPI Eina_Bool edje_edit_data_add(Evas_Object *obj, const char *itemname, const
640 */ 667 */
641EAPI Eina_Bool edje_edit_data_del(Evas_Object *obj, const char *itemname); 668EAPI Eina_Bool edje_edit_data_del(Evas_Object *obj, const char *itemname);
642 669
643/** Get the data associated with the given itemname. 670/**
671 * @brief Gets the data associated with the given itemname.
644 * 672 *
645 * @param obj Object being edited. 673 * @param obj Object being edited.
646 * @param itemname Name of the data entry to fetch the value for. 674 * @param itemname Name of the data entry to fetch the value for.
@@ -649,7 +677,8 @@ EAPI Eina_Bool edje_edit_data_del(Evas_Object *obj, const char *itemname);
649 */ 677 */
650EAPI const char * edje_edit_data_value_get(Evas_Object *obj, const char *itemname); 678EAPI const char * edje_edit_data_value_get(Evas_Object *obj, const char *itemname);
651 679
652/** Set the data associated with the given itemname. 680/**
681 * @brief Sets the data associated with the given itemname.
653 * 682 *
654 * @param obj Object being edited. 683 * @param obj Object being edited.
655 * @param itemname Name of data entry to change the value. 684 * @param itemname Name of data entry to change the value.
@@ -659,7 +688,8 @@ EAPI const char * edje_edit_data_value_get(Evas_Object *obj, const char *itemnam
659 */ 688 */
660EAPI Eina_Bool edje_edit_data_value_set(Evas_Object *obj, const char *itemname, const char *value); 689EAPI Eina_Bool edje_edit_data_value_set(Evas_Object *obj, const char *itemname, const char *value);
661 690
662/** Change the name of the given data object. 691/**
692 * @brief Changes the name of the given data object.
663 * 693 *
664 * @param obj Object being edited. 694 * @param obj Object being edited.
665 * @param itemname Data entry to rename. 695 * @param itemname Data entry to rename.
@@ -669,7 +699,8 @@ EAPI Eina_Bool edje_edit_data_value_set(Evas_Object *obj, const char *itemname,
669 */ 699 */
670EAPI Eina_Bool edje_edit_data_name_set(Evas_Object *obj, const char *itemname, const char *newname); 700EAPI Eina_Bool edje_edit_data_name_set(Evas_Object *obj, const char *itemname, const char *newname);
671 701
672/** Retrieves a list with the item names inside the data block at the group level. 702/**
703 * @brief Retrieves a list with the item names inside the data block at the group level.
673 * 704 *
674 * @param obj Object being edited. 705 * @param obj Object being edited.
675 * 706 *
@@ -677,7 +708,8 @@ EAPI Eina_Bool edje_edit_data_name_set(Evas_Object *obj, const char *itemname, c
677 */ 708 */
678EAPI Eina_List * edje_edit_group_data_list_get(Evas_Object *obj); 709EAPI Eina_List * edje_edit_group_data_list_get(Evas_Object *obj);
679 710
680/** Create a new data object in the given edje file *belonging to the current group*. 711/**
712 * @brief Creates a new data object in the given edje file *belonging to the current group*.
681 * 713 *
682 * If another data entry with the same name exists, 714 * If another data entry with the same name exists,
683 * nothing is created and EINA_FALSE is returned. 715 * nothing is created and EINA_FALSE is returned.
@@ -690,7 +722,8 @@ EAPI Eina_List * edje_edit_group_data_list_get(Evas_Object *obj);
690 */ 722 */
691EAPI Eina_Bool edje_edit_group_data_add(Evas_Object *obj, const char *itemname, const char *value); 723EAPI Eina_Bool edje_edit_group_data_add(Evas_Object *obj, const char *itemname, const char *value);
692 724
693/** Delete the given data object from the group. 725/**
726 * @brief Deletes the given data object from the group.
694 * 727 *
695 * @param obj Object being edited. 728 * @param obj Object being edited.
696 * @param itemname Name of the data entry to remove. 729 * @param itemname Name of the data entry to remove.
@@ -699,7 +732,8 @@ EAPI Eina_Bool edje_edit_group_data_add(Evas_Object *obj, const char *itemname,
699 */ 732 */
700EAPI Eina_Bool edje_edit_group_data_del(Evas_Object *obj, const char *itemname); 733EAPI Eina_Bool edje_edit_group_data_del(Evas_Object *obj, const char *itemname);
701 734
702/** Get the data associated with the given itemname. 735/**
736 * @brief Gets the data associated with the given itemname.
703 * 737 *
704 * @param obj Object being edited. 738 * @param obj Object being edited.
705 * @param itemname Name of the data entry. 739 * @param itemname Name of the data entry.
@@ -708,7 +742,8 @@ EAPI Eina_Bool edje_edit_group_data_del(Evas_Object *obj, const char *itemname);
708 */ 742 */
709EAPI const char * edje_edit_group_data_value_get(Evas_Object *obj, const char *itemname); 743EAPI const char * edje_edit_group_data_value_get(Evas_Object *obj, const char *itemname);
710 744
711/** Set the data associated with the given itemname. 745/**
746 * @brief Sets the data associated with the given itemname.
712 * 747 *
713 * @param obj Object being edited. 748 * @param obj Object being edited.
714 * @param itemname Name of the data entry to set the value. 749 * @param itemname Name of the data entry to set the value.
@@ -718,7 +753,8 @@ EAPI const char * edje_edit_group_data_value_get(Evas_Object *obj, const char *i
718 */ 753 */
719EAPI Eina_Bool edje_edit_group_data_value_set(Evas_Object *obj, const char *itemname, const char *value); 754EAPI Eina_Bool edje_edit_group_data_value_set(Evas_Object *obj, const char *itemname, const char *value);
720 755
721/** Change the name of the given data object. 756/**
757 * @brief Changes the name of the given data object.
722 * 758 *
723 * @param obj Object being edited. 759 * @param obj Object being edited.
724 * @param itemname Name of the data entry to rename. 760 * @param itemname Name of the data entry to rename.
@@ -733,11 +769,13 @@ EAPI Eina_Bool edje_edit_group_data_name_set(Evas_Object *obj, const char *itemn
733/*****************************************************************************/ 769/*****************************************************************************/
734/*********************** SIZE CLASSES API ********************************/ 770/*********************** SIZE CLASSES API ********************************/
735/*****************************************************************************/ 771/*****************************************************************************/
736/** @name Size Classes API 772/**
737 * Functions to deal with Size Classes (see @ref edcref). 773 * @name Size Classes API
774 * Functions to deal with Size Classes (see @ref edcref).
738 */ //@{ 775 */ //@{
739 776
740/** Get the list of all the Size Classes in the given edje object. 777/**
778 * @brief Gets the list of all the Size Classes in the given edje object.
741 * 779 *
742 * @param obj Object being edited. 780 * @param obj Object being edited.
743 * 781 *
@@ -751,7 +789,8 @@ EAPI Eina_Bool edje_edit_group_data_name_set(Evas_Object *obj, const char *itemn
751EAPI Eina_List * 789EAPI Eina_List *
752edje_edit_size_classes_list_get(Evas_Object *obj); 790edje_edit_size_classes_list_get(Evas_Object *obj);
753 791
754/** Create a new size class object in the given edje. 792/**
793 * @brief Creates a new size class object in the given edje.
755 * 794 *
756 * If class is already exist then nothing is created and EINA_FALSE returned. 795 * If class is already exist then nothing is created and EINA_FALSE returned.
757 * 796 *
@@ -765,7 +804,8 @@ edje_edit_size_classes_list_get(Evas_Object *obj);
765EAPI Eina_Bool 804EAPI Eina_Bool
766edje_edit_size_class_add(Evas_Object *obj, const char *name); 805edje_edit_size_class_add(Evas_Object *obj, const char *name);
767 806
768/** Delete size class object from edje. 807/**
808 * @brief Deletes size class object from edje.
769 * 809 *
770 * @param obj Object being edited. 810 * @param obj Object being edited.
771 * @param name Size class to delete. 811 * @param name Size class to delete.
@@ -777,7 +817,8 @@ edje_edit_size_class_add(Evas_Object *obj, const char *name);
777EAPI Eina_Bool 817EAPI Eina_Bool
778edje_edit_size_class_del(Evas_Object *obj, const char *name); 818edje_edit_size_class_del(Evas_Object *obj, const char *name);
779 819
780/** Change name of a size class. 820/**
821 * @brief Changes name of a size class.
781 * 822 *
782 * @param obj Object being edited. 823 * @param obj Object being edited.
783 * @param name Size class to rename. 824 * @param name Size class to rename.
@@ -790,7 +831,8 @@ edje_edit_size_class_del(Evas_Object *obj, const char *name);
790EAPI Eina_Bool 831EAPI Eina_Bool
791edje_edit_size_class_name_set(Evas_Object *obj, const char *name, const char *newname); 832edje_edit_size_class_name_set(Evas_Object *obj, const char *name, const char *newname);
792 833
793/** Return width min size of specified size class. 834/**
835 * @brief Returns width min size of specified size class.
794 * 836 *
795 * @param obj Object being edited. 837 * @param obj Object being edited.
796 * @param class_name Size class to fetch values. 838 * @param class_name Size class to fetch values.
@@ -802,7 +844,8 @@ edje_edit_size_class_name_set(Evas_Object *obj, const char *name, const char *ne
802EAPI Evas_Coord 844EAPI Evas_Coord
803edje_edit_size_class_min_w_get(Evas_Object *obj, const char *class_name); 845edje_edit_size_class_min_w_get(Evas_Object *obj, const char *class_name);
804 846
805/** Set width min size of specified size class. 847/**
848 * @brief Sets width min size of specified size class.
806 * 849 *
807 * @param obj Object being edited. 850 * @param obj Object being edited.
808 * @param class_name Size class to set values. 851 * @param class_name Size class to set values.
@@ -815,7 +858,8 @@ edje_edit_size_class_min_w_get(Evas_Object *obj, const char *class_name);
815EAPI Eina_Bool 858EAPI Eina_Bool
816edje_edit_size_class_min_w_set(Evas_Object *obj, const char *class_name, Evas_Coord size); 859edje_edit_size_class_min_w_set(Evas_Object *obj, const char *class_name, Evas_Coord size);
817 860
818/** Return width max size of specified size class. 861/**
862 * @brief Returns width max size of specified size class.
819 * 863 *
820 * @param obj Object being edited. 864 * @param obj Object being edited.
821 * @param class_name Size class to fetch values. 865 * @param class_name Size class to fetch values.
@@ -827,7 +871,8 @@ edje_edit_size_class_min_w_set(Evas_Object *obj, const char *class_name, Evas_Co
827EAPI Evas_Coord 871EAPI Evas_Coord
828edje_edit_size_class_max_w_get(Evas_Object *obj, const char *class_name); 872edje_edit_size_class_max_w_get(Evas_Object *obj, const char *class_name);
829 873
830/** Set width max size of specified size class. 874/**
875 * @brief Sets width max size of specified size class.
831 * 876 *
832 * @param obj Object being edited. 877 * @param obj Object being edited.
833 * @param class_name Size class to set values. 878 * @param class_name Size class to set values.
@@ -840,7 +885,8 @@ edje_edit_size_class_max_w_get(Evas_Object *obj, const char *class_name);
840EAPI Eina_Bool 885EAPI Eina_Bool
841edje_edit_size_class_max_w_set(Evas_Object *obj, const char *class_name, Evas_Coord size); 886edje_edit_size_class_max_w_set(Evas_Object *obj, const char *class_name, Evas_Coord size);
842 887
843/** Return height min size of specified size class. 888/**
889 * @brief Returns height min size of specified size class.
844 * 890 *
845 * @param obj Object being edited. 891 * @param obj Object being edited.
846 * @param class_name Size class to fetch values. 892 * @param class_name Size class to fetch values.
@@ -852,7 +898,8 @@ edje_edit_size_class_max_w_set(Evas_Object *obj, const char *class_name, Evas_Co
852EAPI Evas_Coord 898EAPI Evas_Coord
853edje_edit_size_class_min_h_get(Evas_Object *obj, const char *class_name); 899edje_edit_size_class_min_h_get(Evas_Object *obj, const char *class_name);
854 900
855/** Set height min size of specified size class. 901/**
902 * @brief Sets height min size of specified size class.
856 * 903 *
857 * @param obj Object being edited. 904 * @param obj Object being edited.
858 * @param class_name Size class to set values. 905 * @param class_name Size class to set values.
@@ -865,7 +912,8 @@ edje_edit_size_class_min_h_get(Evas_Object *obj, const char *class_name);
865EAPI Eina_Bool 912EAPI Eina_Bool
866edje_edit_size_class_min_h_set(Evas_Object *obj, const char *class_name, Evas_Coord size); 913edje_edit_size_class_min_h_set(Evas_Object *obj, const char *class_name, Evas_Coord size);
867 914
868/** Return height max size of specified size class. 915/**
916 * @brief Returns height max size of specified size class.
869 * 917 *
870 * @param obj Object being edited. 918 * @param obj Object being edited.
871 * @param class_name Size class to fetch values. 919 * @param class_name Size class to fetch values.
@@ -877,7 +925,8 @@ edje_edit_size_class_min_h_set(Evas_Object *obj, const char *class_name, Evas_Co
877EAPI Evas_Coord 925EAPI Evas_Coord
878edje_edit_size_class_max_h_get(Evas_Object *obj, const char *class_name); 926edje_edit_size_class_max_h_get(Evas_Object *obj, const char *class_name);
879 927
880/** Set height max size of specified size class. 928/**
929 * @brief Sets height max size of specified size class.
881 * 930 *
882 * @param obj Object being edited. 931 * @param obj Object being edited.
883 * @param class_name Size class to set values. 932 * @param class_name Size class to set values.
@@ -894,11 +943,13 @@ edje_edit_size_class_max_h_set(Evas_Object *obj, const char *class_name, Evas_Co
894/*****************************************************************************/ 943/*****************************************************************************/
895/*********************** TEXT CLASSES API ********************************/ 944/*********************** TEXT CLASSES API ********************************/
896/*****************************************************************************/ 945/*****************************************************************************/
897/** @name Text Classes API 946/**
898 * Functions to deal with Text Classes (see @ref edcref). 947 * @name Text Classes API
948 * Functions to deal with Text Classes (see @ref edcref).
899 */ //@{ 949 */ //@{
900 950
901/** Get the list of all the Text Classes in the given edje object. 951/**
952 * @brief Gets the list of all the Text Classes in the given edje object.
902 * 953 *
903 * @param obj Object being edited. 954 * @param obj Object being edited.
904 * 955 *
@@ -912,7 +963,8 @@ edje_edit_size_class_max_h_set(Evas_Object *obj, const char *class_name, Evas_Co
912EAPI Eina_List * 963EAPI Eina_List *
913edje_edit_text_classes_list_get(Evas_Object *obj); 964edje_edit_text_classes_list_get(Evas_Object *obj);
914 965
915/** Create a new text class object in the given edje. 966/**
967 * @brief Creates a new text class object in the given edje.
916 * 968 *
917 * If class is already exist then nothing is created and EINA_FALSE returned. 969 * If class is already exist then nothing is created and EINA_FALSE returned.
918 * 970 *
@@ -926,7 +978,8 @@ edje_edit_text_classes_list_get(Evas_Object *obj);
926EAPI Eina_Bool 978EAPI Eina_Bool
927edje_edit_text_class_add(Evas_Object *obj, const char *name); 979edje_edit_text_class_add(Evas_Object *obj, const char *name);
928 980
929/** Delete text class object from edje. 981/**
982 * @brief Deletes text class object from edje.
930 * 983 *
931 * @param obj Object being edited. 984 * @param obj Object being edited.
932 * @param name Text class to delete. 985 * @param name Text class to delete.
@@ -938,7 +991,8 @@ edje_edit_text_class_add(Evas_Object *obj, const char *name);
938EAPI Eina_Bool 991EAPI Eina_Bool
939edje_edit_text_class_del(Evas_Object *obj, const char *name); 992edje_edit_text_class_del(Evas_Object *obj, const char *name);
940 993
941/** Change name of a text class. 994/**
995 * @brief Changes name of a text class.
942 * 996 *
943 * @param obj Object being edited. 997 * @param obj Object being edited.
944 * @param name Text class to rename. 998 * @param name Text class to rename.
@@ -951,7 +1005,8 @@ edje_edit_text_class_del(Evas_Object *obj, const char *name);
951EAPI Eina_Bool 1005EAPI Eina_Bool
952edje_edit_text_class_name_set(Evas_Object *obj, const char *name, const char *newname); 1006edje_edit_text_class_name_set(Evas_Object *obj, const char *name, const char *newname);
953 1007
954/** Return font name of specified text class. 1008/**
1009 * @brief Returns font name of specified text class.
955 * 1010 *
956 * @param obj Object being edited. 1011 * @param obj Object being edited.
957 * @param class_name Text class to fetch values. 1012 * @param class_name Text class to fetch values.
@@ -963,7 +1018,8 @@ edje_edit_text_class_name_set(Evas_Object *obj, const char *name, const char *ne
963EAPI Eina_Stringshare * 1018EAPI Eina_Stringshare *
964edje_edit_text_class_font_get(Evas_Object *obj, const char *class_name); 1019edje_edit_text_class_font_get(Evas_Object *obj, const char *class_name);
965 1020
966/** Set font for the given text class. 1021/**
1022 * @brief Sets font for the given text class.
967 * 1023 *
968 * NULL is possible value. 1024 * NULL is possible value.
969 * 1025 *
@@ -978,7 +1034,8 @@ edje_edit_text_class_font_get(Evas_Object *obj, const char *class_name);
978EAPI Eina_Bool 1034EAPI Eina_Bool
979edje_edit_text_class_font_set(Evas_Object *obj, const char *class_name, const char *font); 1035edje_edit_text_class_font_set(Evas_Object *obj, const char *class_name, const char *font);
980 1036
981/** Return font size of specified text class. 1037/**
1038 * @brief Returns font size of specified text class.
982 * 1039 *
983 * @param obj Object being edited. 1040 * @param obj Object being edited.
984 * @param class_name Text class to fetch values. 1041 * @param class_name Text class to fetch values.
@@ -990,7 +1047,8 @@ edje_edit_text_class_font_set(Evas_Object *obj, const char *class_name, const ch
990EAPI Evas_Font_Size 1047EAPI Evas_Font_Size
991edje_edit_text_class_size_get(Evas_Object *obj, const char *class_name); 1048edje_edit_text_class_size_get(Evas_Object *obj, const char *class_name);
992 1049
993/** Set font size for specified text class 1050/**
1051 * @brief Sets font size for specified text class
994 * 1052 *
995 * @param obj Object being edited. 1053 * @param obj Object being edited.
996 * @param class_name Text class to set values. 1054 * @param class_name Text class to set values.
@@ -1008,11 +1066,13 @@ edje_edit_text_class_size_set(Evas_Object *obj, const char *class_name, Evas_Fon
1008/******************************************************************************/ 1066/******************************************************************************/
1009/*********************** COLOR CLASSES API ********************************/ 1067/*********************** COLOR CLASSES API ********************************/
1010/******************************************************************************/ 1068/******************************************************************************/
1011/** @name Color Classes API 1069/**
1012 * Functions to deal with Color Classes (see @ref edcref). 1070 * @name Color Classes API
1071 * Functions to deal with Color Classes (see @ref edcref).
1013 */ //@{ 1072 */ //@{
1014 1073
1015/** Get the list of all the Color Classes in the given edje object. 1074/**
1075 * @brief Gets the list of all the Color Classes in the given edje object.
1016 * 1076 *
1017 * @param obj Object being edited. 1077 * @param obj Object being edited.
1018 * 1078 *
@@ -1020,7 +1080,8 @@ edje_edit_text_class_size_set(Evas_Object *obj, const char *class_name, Evas_Fon
1020 */ 1080 */
1021EAPI Eina_List * edje_edit_color_classes_list_get(Evas_Object *obj); 1081EAPI Eina_List * edje_edit_color_classes_list_get(Evas_Object *obj);
1022 1082
1023/** Create a new color class object in the given edje. 1083/**
1084 * @brief Creates a new color class object in the given edje.
1024 * 1085 *
1025 * If another class with the same name exists nothing is created and EINA_FALSE is returned. 1086 * If another class with the same name exists nothing is created and EINA_FALSE is returned.
1026 * 1087 *
@@ -1031,7 +1092,8 @@ EAPI Eina_List * edje_edit_color_classes_list_get(Evas_Object *obj);
1031 */ 1092 */
1032EAPI Eina_Bool edje_edit_color_class_add(Evas_Object *obj, const char *name); 1093EAPI Eina_Bool edje_edit_color_class_add(Evas_Object *obj, const char *name);
1033 1094
1034/** Delete the given class object from edje. 1095/**
1096 * @brief Deletes the given class object from edje.
1035 * 1097 *
1036 * @param obj Object being edited. 1098 * @param obj Object being edited.
1037 * @param name Color class to delete. 1099 * @param name Color class to delete.
@@ -1040,7 +1102,8 @@ EAPI Eina_Bool edje_edit_color_class_add(Evas_Object *obj, const char *name);
1040 */ 1102 */
1041EAPI Eina_Bool edje_edit_color_class_del(Evas_Object *obj, const char *name); 1103EAPI Eina_Bool edje_edit_color_class_del(Evas_Object *obj, const char *name);
1042 1104
1043/** Get all the colors that compose the class. 1105/**
1106 * @brief Gets all the colors that compose the class.
1044 * 1107 *
1045 * You can pass NULL to colors you are not intrested in. 1108 * You can pass NULL to colors you are not intrested in.
1046 * 1109 *
@@ -1063,7 +1126,8 @@ EAPI Eina_Bool edje_edit_color_class_del(Evas_Object *obj, const char *name);
1063 */ 1126 */
1064EAPI 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); 1127EAPI 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);
1065 1128
1066/** Set the colors for the given color class. 1129/**
1130 * @brief Sets the colors for the given color class.
1067 * 1131 *
1068 * If you set a color to -1 it will not be touched. 1132 * If you set a color to -1 it will not be touched.
1069 * 1133 *
@@ -1086,7 +1150,8 @@ EAPI Eina_Bool edje_edit_color_class_colors_get(Evas_Object *obj, const char *cl
1086 */ 1150 */
1087EAPI 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); 1151EAPI 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);
1088 1152
1089/** Change the name of a color class. 1153/**
1154 * @brief Changes the name of a color class.
1090 * 1155 *
1091 * @param obj Object being edited. 1156 * @param obj Object being edited.
1092 * @param name Color class to rename. 1157 * @param name Color class to rename.
@@ -1096,7 +1161,8 @@ EAPI Eina_Bool edje_edit_color_class_colors_set(Evas_Object *obj, const char *cl
1096 */ 1161 */
1097EAPI Eina_Bool edje_edit_color_class_name_set(Evas_Object *obj, const char *name, const char *newname); 1162EAPI Eina_Bool edje_edit_color_class_name_set(Evas_Object *obj, const char *name, const char *newname);
1098 1163
1099/** Get the description of a color class. 1164/**
1165 * @brief Gets the description of a color class.
1100 * 1166 *
1101 * @param obj Object being edited. 1167 * @param obj Object being edited.
1102 * @param name Color class to get the description of. 1168 * @param name Color class to get the description of.
@@ -1106,7 +1172,8 @@ EAPI Eina_Bool edje_edit_color_class_name_set(Evas_Object *obj, const char *name
1106 */ 1172 */
1107EAPI Eina_Stringshare *edje_edit_color_class_description_get(Evas_Object *obj, const char *class_name); 1173EAPI Eina_Stringshare *edje_edit_color_class_description_get(Evas_Object *obj, const char *class_name);
1108 1174
1109/** Change the description of a color class. 1175/**
1176 * @brief Changes the description of a color class.
1110 * 1177 *
1111 * @param obj Object being edited. 1178 * @param obj Object being edited.
1112 * @param name Color class to edit. 1179 * @param name Color class to edit.
@@ -1122,11 +1189,13 @@ EAPI Eina_Bool edje_edit_color_class_description_set(Evas_Object *obj, const cha
1122/******************************************************************************/ 1189/******************************************************************************/
1123/************************** TEXT STYLES *************************************/ 1190/************************** TEXT STYLES *************************************/
1124/******************************************************************************/ 1191/******************************************************************************/
1125/** @name Text styles API 1192/**
1126 * Functions to deal with text styles (see @ref edcref). 1193 * @name Text styles API
1194 * Functions to deal with text styles (see @ref edcref).
1127 */ //@{ 1195 */ //@{
1128 1196
1129/** Get the list of all the text styles in the given edje object. 1197/**
1198 * @brief Gets the list of all the text styles in the given edje object.
1130 * 1199 *
1131 * @param obj Object being edited. 1200 * @param obj Object being edited.
1132 * 1201 *
@@ -1134,7 +1203,8 @@ EAPI Eina_Bool edje_edit_color_class_description_set(Evas_Object *obj, const cha
1134 */ 1203 */
1135EAPI Eina_List * edje_edit_styles_list_get(Evas_Object *obj); 1204EAPI Eina_List * edje_edit_styles_list_get(Evas_Object *obj);
1136 1205
1137/** Create a new text style object in the given edje. 1206/**
1207 * @brief Creates a new text style object in the given edje.
1138 * 1208 *
1139 * If another style with the same name exists nothing is created and EINA_FALSE is returned. 1209 * If another style with the same name exists nothing is created and EINA_FALSE is returned.
1140 * 1210 *
@@ -1145,7 +1215,8 @@ EAPI Eina_List * edje_edit_styles_list_get(Evas_Object *obj);
1145 */ 1215 */
1146EAPI Eina_Bool edje_edit_style_add(Evas_Object *obj, const char *style); 1216EAPI Eina_Bool edje_edit_style_add(Evas_Object *obj, const char *style);
1147 1217
1148/** Delete the given text style and all the child tags. 1218/**
1219 * @brief Deletes the given text style and all the child tags.
1149 * 1220 *
1150 * @param obj Object being edited. 1221 * @param obj Object being edited.
1151 * @param style Style to delete. 1222 * @param style Style to delete.
@@ -1154,7 +1225,8 @@ EAPI Eina_Bool edje_edit_style_add(Evas_Object *obj, const char *style);
1154 */ 1225 */
1155EAPI Eina_Bool edje_edit_style_del(Evas_Object *obj, const char *style); 1226EAPI Eina_Bool edje_edit_style_del(Evas_Object *obj, const char *style);
1156 1227
1157/** Get the list of all the tags name in the given text style. 1228/**
1229 * @brief Gets the list of all the tags name in the given text style.
1158 * 1230 *
1159 * @param obj Object being edited. 1231 * @param obj Object being edited.
1160 * @param style Style to get the tags for. 1232 * @param style Style to get the tags for.
@@ -1163,7 +1235,8 @@ EAPI Eina_Bool edje_edit_style_del(Evas_Object *obj, const char *style);
1163 */ 1235 */
1164EAPI Eina_List * edje_edit_style_tags_list_get(Evas_Object *obj, const char *style); 1236EAPI Eina_List * edje_edit_style_tags_list_get(Evas_Object *obj, const char *style);
1165 1237
1166/** Get the value of the given tag. 1238/**
1239 * @brief Gets the value of the given tag.
1167 * 1240 *
1168 * @param obj Object being edited. 1241 * @param obj Object being edited.
1169 * @param style Style containing the tag being. 1242 * @param style Style containing the tag being.
@@ -1173,7 +1246,8 @@ EAPI Eina_List * edje_edit_style_tags_list_get(Evas_Object *obj, const char *sty
1173 */ 1246 */
1174EAPI const char * edje_edit_style_tag_value_get(Evas_Object *obj, const char *style, const char *tag); 1247EAPI const char * edje_edit_style_tag_value_get(Evas_Object *obj, const char *style, const char *tag);
1175 1248
1176/** Set the value of the given tag. 1249/**
1250 * @brief Sets the value of the given tag.
1177 * 1251 *
1178 * @param obj Object being edited. 1252 * @param obj Object being edited.
1179 * @param style Style containing the tag to change. 1253 * @param style Style containing the tag to change.
@@ -1184,7 +1258,8 @@ EAPI const char * edje_edit_style_tag_value_get(Evas_Object *obj, const char *st
1184 */ 1258 */
1185EAPI Eina_Bool edje_edit_style_tag_value_set(Evas_Object *obj, const char *style, const char *tag, const char *new_value); 1259EAPI Eina_Bool edje_edit_style_tag_value_set(Evas_Object *obj, const char *style, const char *tag, const char *new_value);
1186 1260
1187/** Set the name of the given tag. 1261/**
1262 * @brief Sets the name of the given tag.
1188 * 1263 *
1189 * @param obj Object being edited. 1264 * @param obj Object being edited.
1190 * @param style Style containing the tag to rename. 1265 * @param style Style containing the tag to rename.
@@ -1195,7 +1270,8 @@ EAPI Eina_Bool edje_edit_style_tag_value_set(Evas_Object *obj, const char *style
1195 */ 1270 */
1196EAPI Eina_Bool edje_edit_style_tag_name_set(Evas_Object *obj, const char *style, const char *tag, const char *new_name); 1271EAPI Eina_Bool edje_edit_style_tag_name_set(Evas_Object *obj, const char *style, const char *tag, const char *new_name);
1197 1272
1198/** Add a new tag to the given text style. 1273/**
1274 @ @brief Adds a new tag to the given text style.
1199 * 1275 *
1200 * If another tag with the same name exists nothing is created and EINA_FALSE is returned. 1276 * If another tag with the same name exists nothing is created and EINA_FALSE is returned.
1201 * 1277 *
@@ -1207,7 +1283,8 @@ EAPI Eina_Bool edje_edit_style_tag_name_set(Evas_Object *obj, const char *style,
1207 */ 1283 */
1208EAPI Eina_Bool edje_edit_style_tag_add(Evas_Object *obj, const char *style, const char *tag_name); 1284EAPI Eina_Bool edje_edit_style_tag_add(Evas_Object *obj, const char *style, const char *tag_name);
1209 1285
1210/** Delete the given tag. 1286/**
1287 * @brief Deletes the given tag.
1211 * 1288 *
1212 * @param obj Object being edited. 1289 * @param obj Object being edited.
1213 * @param style Style from where to remove the tag. 1290 * @param style Style from where to remove the tag.
@@ -1222,11 +1299,13 @@ EAPI Eina_Bool edje_edit_style_tag_del(Evas_Object *obj, const char *style, cons
1222/******************************************************************************/ 1299/******************************************************************************/
1223/************************ EXTERNALS API ***********************************/ 1300/************************ EXTERNALS API ***********************************/
1224/******************************************************************************/ 1301/******************************************************************************/
1225/** @name Externals API 1302/**
1226 * Functions to deal with list of external modules (see @ref edcref). 1303 * @name Externals API
1304 * Functions to deal with list of external modules (see @ref edcref).
1227 */ //@{ 1305 */ //@{
1228 1306
1229/** Get the list of all the externals requested in the given edje object. 1307/**
1308 * @brief Gets the list of all the externals requested in the given edje object.
1230 * 1309 *
1231 * @param obj Object being edited. 1310 * @param obj Object being edited.
1232 * 1311 *
@@ -1234,7 +1313,8 @@ EAPI Eina_Bool edje_edit_style_tag_del(Evas_Object *obj, const char *style, cons
1234 */ 1313 */
1235EAPI Eina_List * edje_edit_externals_list_get(Evas_Object *obj); 1314EAPI Eina_List * edje_edit_externals_list_get(Evas_Object *obj);
1236 1315
1237/** Add an external module to be requested on edje load. 1316/**
1317 * @brief Adds an external module to be requested on edje load.
1238 * 1318 *
1239 * @param obj Object being edited. 1319 * @param obj Object being edited.
1240 * @param external Name of the external module to add to the list of autoload. 1320 * @param external Name of the external module to add to the list of autoload.
@@ -1243,7 +1323,8 @@ EAPI Eina_List * edje_edit_externals_list_get(Evas_Object *obj);
1243 */ 1323 */
1244EAPI Eina_Bool edje_edit_external_add(Evas_Object *obj, const char *external); 1324EAPI Eina_Bool edje_edit_external_add(Evas_Object *obj, const char *external);
1245 1325
1246/** Delete the given external from the list. 1326/**
1327 * @brief Deletes the given external from the list.
1247 * 1328 *
1248 * @param obj Object being edited. 1329 * @param obj Object being edited.
1249 * @param external Name of the external module to remove from the autoload list. 1330 * @param external Name of the external module to remove from the autoload list.
@@ -1257,11 +1338,13 @@ EAPI Eina_Bool edje_edit_external_del(Evas_Object *obj, const char *external);
1257/******************************************************************************/ 1338/******************************************************************************/
1258/************************** PARTS API *************************************/ 1339/************************** PARTS API *************************************/
1259/******************************************************************************/ 1340/******************************************************************************/
1260/** @name Parts API 1341/**
1261 * Functions to deal with part objects (see @ref edcref). 1342 * @name Parts API
1343 * Functions to deal with part objects (see @ref edcref).
1262 */ //@{ 1344 */ //@{
1263 1345
1264/** Get the select mode for a textblock part 1346/**
1347 * @brief Gets the select mode for a textblock part.
1265 1348
1266 * @param obj Object being edited. 1349 * @param obj Object being edited.
1267 * @param part Name of the part. 1350 * @param part Name of the part.
@@ -1271,7 +1354,8 @@ EAPI Eina_Bool edje_edit_external_del(Evas_Object *obj, const char *external);
1271 */ 1354 */
1272EAPI Edje_Edit_Select_Mode edje_edit_part_select_mode_get(Evas_Object *obj, const char *part); 1355EAPI Edje_Edit_Select_Mode edje_edit_part_select_mode_get(Evas_Object *obj, const char *part);
1273 1356
1274/** Set the select mode for a textblock part 1357/**
1358 * @brief Sets the select mode for a textblock part.
1275 * 1359 *
1276 * @param obj Object being edited. 1360 * @param obj Object being edited.
1277 * @param part Name of the part. 1361 * @param part Name of the part.
@@ -1283,7 +1367,8 @@ EAPI Edje_Edit_Select_Mode edje_edit_part_select_mode_get(Evas_Object *obj, cons
1283 */ 1367 */
1284EAPI Eina_Bool edje_edit_part_select_mode_set(Evas_Object *obj, const char *part, Edje_Edit_Select_Mode mode); 1368EAPI Eina_Bool edje_edit_part_select_mode_set(Evas_Object *obj, const char *part, Edje_Edit_Select_Mode mode);
1285 1369
1286/** Get the edit mode for a textblock part 1370/**
1371 * @brief Gets the edit mode for a textblock part.
1287 * 1372 *
1288 * @param obj Object being edited. 1373 * @param obj Object being edited.
1289 * @param part Name of the part. 1374 * @param part Name of the part.
@@ -1293,7 +1378,8 @@ EAPI Eina_Bool edje_edit_part_select_mode_set(Evas_Object *obj, const char *part
1293 */ 1378 */
1294EAPI Edje_Edit_Entry_Mode edje_edit_part_entry_mode_get(Evas_Object *obj, const char *part); 1379EAPI Edje_Edit_Entry_Mode edje_edit_part_entry_mode_get(Evas_Object *obj, const char *part);
1295 1380
1296/** Set the edit mode for a textblock part 1381/**
1382 * @brief Sets the edit mode for a textblock part.
1297 * 1383 *
1298 * @param obj Object being edited. 1384 * @param obj Object being edited.
1299 * @param part Name of the part. 1385 * @param part Name of the part.
@@ -1305,7 +1391,8 @@ EAPI Edje_Edit_Entry_Mode edje_edit_part_entry_mode_get(Evas_Object *obj, const
1305 */ 1391 */
1306EAPI Eina_Bool edje_edit_part_entry_mode_set(Evas_Object *obj, const char *part, Edje_Edit_Entry_Mode mode); 1392EAPI Eina_Bool edje_edit_part_entry_mode_set(Evas_Object *obj, const char *part, Edje_Edit_Entry_Mode mode);
1307 1393
1308/** Get the list of all the parts in the given edje object. 1394/**
1395 * @brief Gets the list of all the parts in the given edje object.
1309 * 1396 *
1310 * @param obj Object being edited. 1397 * @param obj Object being edited.
1311 * 1398 *
@@ -1316,7 +1403,8 @@ EAPI Eina_Bool edje_edit_part_entry_mode_set(Evas_Object *obj, const char *part,
1316 */ 1403 */
1317EAPI Eina_List * edje_edit_parts_list_get(Evas_Object *obj); 1404EAPI Eina_List * edje_edit_parts_list_get(Evas_Object *obj);
1318 1405
1319/** Create a new part in the given edje. 1406/**
1407 * @brief Creates a new part in the given edje.
1320 * 1408 *
1321 * If another part with the same name just exists nothing is created and EINA_FALSE is returned. 1409 * If another part with the same name just exists nothing is created and EINA_FALSE is returned.
1322 * Note that this function also create a default description for the part. 1410 * Note that this function also create a default description for the part.
@@ -1329,7 +1417,8 @@ EAPI Eina_List * edje_edit_parts_list_get(Evas_Object *obj);
1329 */ 1417 */
1330EAPI Eina_Bool edje_edit_part_add(Evas_Object *obj, const char *name, Edje_Part_Type type); 1418EAPI Eina_Bool edje_edit_part_add(Evas_Object *obj, const char *name, Edje_Part_Type type);
1331 1419
1332/** Create a new part of type EXTERNAL in the given edje. 1420/**
1421 * @brief Creates a new part of type EXTERNAL in the given edje.
1333 * 1422 *
1334 * If another part with the same name just exists nothing is created and EINA_FALSE is returned. 1423 * If another part with the same name just exists nothing is created and EINA_FALSE is returned.
1335 * Note that this function also create a default description for the part. 1424 * Note that this function also create a default description for the part.
@@ -1342,7 +1431,8 @@ EAPI Eina_Bool edje_edit_part_add(Evas_Object *obj, const char *name, Edje_Part_
1342 */ 1431 */
1343EAPI Eina_Bool edje_edit_part_external_add(Evas_Object *obj, const char *name, const char *source); 1432EAPI Eina_Bool edje_edit_part_external_add(Evas_Object *obj, const char *name, const char *source);
1344 1433
1345/** Delete the given part from the edje. 1434/**
1435 * @brief Deletes the given part from the edje.
1346 * 1436 *
1347 * All the reference to this part will be zeroed. 1437 * All the reference to this part will be zeroed.
1348 * 1438 *
@@ -1353,7 +1443,8 @@ EAPI Eina_Bool edje_edit_part_external_add(Evas_Object *obj, const char *name, c
1353 */ 1443 */
1354EAPI Eina_Bool edje_edit_part_del(Evas_Object *obj, const char *part); 1444EAPI Eina_Bool edje_edit_part_del(Evas_Object *obj, const char *part);
1355 1445
1356/** Copy the given part in edje. 1446/**
1447 * @brief Copies the given part in edje.
1357 * 1448 *
1358 * If another part with the same name just exists nothing is created and EINA_FALSE is returned. 1449 * If another part with the same name just exists nothing is created and EINA_FALSE is returned.
1359 * 1450 *
@@ -1366,7 +1457,8 @@ EAPI Eina_Bool edje_edit_part_del(Evas_Object *obj, const char *part);
1366 */ 1457 */
1367EAPI Eina_Bool edje_edit_part_copy(Evas_Object *obj, const char *part, const char *new_copy); 1458EAPI Eina_Bool edje_edit_part_copy(Evas_Object *obj, const char *part, const char *new_copy);
1368 1459
1369/** Check if a part with the given name exist in the edje object. 1460/**
1461 * @brief Checks if a part with the given name exist in the edje object.
1370 * 1462 *
1371 * @param obj Object being edited. 1463 * @param obj Object being edited.
1372 * @param part Name of part to check for its existence. 1464 * @param part Name of part to check for its existence.
@@ -1375,7 +1467,8 @@ EAPI Eina_Bool edje_edit_part_copy(Evas_Object *obj, const char *part, const cha
1375 */ 1467 */
1376EAPI Eina_Bool edje_edit_part_exist(Evas_Object *obj, const char *part); 1468EAPI Eina_Bool edje_edit_part_exist(Evas_Object *obj, const char *part);
1377 1469
1378/** Get the name of part stacked above the one passed. 1470/**
1471 * @brief Gets the name of part stacked above the one passed.
1379 * 1472 *
1380 * @param obj Object being edited. 1473 * @param obj Object being edited.
1381 * @param part Name of part of which to check the one above. 1474 * @param part Name of part of which to check the one above.
@@ -1385,7 +1478,8 @@ EAPI Eina_Bool edje_edit_part_exist(Evas_Object *obj, const char *part);
1385 */ 1478 */
1386EAPI const char * edje_edit_part_above_get(Evas_Object *obj, const char *part); 1479EAPI const char * edje_edit_part_above_get(Evas_Object *obj, const char *part);
1387 1480
1388/** Get the name of part stacked below the one passed. 1481/**
1482 * @brief Gets the name of part stacked below the one passed.
1389 * 1483 *
1390 * @param obj Object being edited. 1484 * @param obj Object being edited.
1391 * @param part Name of part of which to check the one below. 1485 * @param part Name of part of which to check the one below.
@@ -1395,7 +1489,8 @@ EAPI const char * edje_edit_part_above_get(Evas_Object *obj, const char *part);
1395 */ 1489 */
1396EAPI const char * edje_edit_part_below_get(Evas_Object *obj, const char *part); 1490EAPI const char * edje_edit_part_below_get(Evas_Object *obj, const char *part);
1397 1491
1398/** Move the given part below the previous one. 1492/**
1493 * @brief Moves the given part below the previous one.
1399 * 1494 *
1400 * @param obj Object being edited. 1495 * @param obj Object being edited.
1401 * @param part Name of part to move one step below. 1496 * @param part Name of part to move one step below.
@@ -1404,7 +1499,8 @@ EAPI const char * edje_edit_part_below_get(Evas_Object *obj, const char *part);
1404 */ 1499 */
1405EAPI Eina_Bool edje_edit_part_restack_below(Evas_Object *obj, const char *part); 1500EAPI Eina_Bool edje_edit_part_restack_below(Evas_Object *obj, const char *part);
1406 1501
1407/** Move the given part below the part named below. 1502/**
1503 * @brief Moves the given part below the part named below.
1408 * 1504 *
1409 * @param obj Object being edited. 1505 * @param obj Object being edited.
1410 * @param part Name of part which will be moved. 1506 * @param part Name of part which will be moved.
@@ -1414,7 +1510,8 @@ EAPI Eina_Bool edje_edit_part_restack_below(Evas_Object *obj, const char *part);
1414 */ 1510 */
1415EAPI Eina_Bool edje_edit_part_restack_part_below(Evas_Object *obj, const char* part, const char *below); 1511EAPI Eina_Bool edje_edit_part_restack_part_below(Evas_Object *obj, const char* part, const char *below);
1416 1512
1417/** Move the given part above the next one. 1513/**
1514 * @brief Moves the given part above the next one.
1418 * 1515 *
1419 * @param obj Object being edited. 1516 * @param obj Object being edited.
1420 * @param part Name of part to move one step above. 1517 * @param part Name of part to move one step above.
@@ -1423,7 +1520,8 @@ EAPI Eina_Bool edje_edit_part_restack_part_below(Evas_Object *obj, const char* p
1423 */ 1520 */
1424EAPI Eina_Bool edje_edit_part_restack_above(Evas_Object *obj, const char *part); 1521EAPI Eina_Bool edje_edit_part_restack_above(Evas_Object *obj, const char *part);
1425 1522
1426/** Move the given part above the part named above. 1523/**
1524 * @brief Moves the given part above the part named above.
1427 * 1525 *
1428 * @param obj Object being edited. 1526 * @param obj Object being edited.
1429 * @param part Name of part which will be moved. 1527 * @param part Name of part which will be moved.
@@ -1433,7 +1531,8 @@ EAPI Eina_Bool edje_edit_part_restack_above(Evas_Object *obj, const char *part);
1433 */ 1531 */
1434EAPI Eina_Bool edje_edit_part_restack_part_above(Evas_Object *obj, const char* part, const char *above); 1532EAPI Eina_Bool edje_edit_part_restack_part_above(Evas_Object *obj, const char* part, const char *above);
1435 1533
1436/** Set a new name for part. 1534/**
1535 * @brief Sets a new name for part.
1437 * 1536 *
1438 * Note that the relative getter function don't exist as it don't make sense ;) 1537 * Note that the relative getter function don't exist as it don't make sense ;)
1439 * 1538 *
@@ -1445,25 +1544,28 @@ EAPI Eina_Bool edje_edit_part_restack_part_above(Evas_Object *obj, const char* p
1445 */ 1544 */
1446EAPI Eina_Bool edje_edit_part_name_set(Evas_Object *obj, const char *part, const char *new_name); 1545EAPI Eina_Bool edje_edit_part_name_set(Evas_Object *obj, const char *part, const char *new_name);
1447 1546
1448/** Get api's name of a part. 1547/**
1548 * @brief Gets api's name of a part.
1449 * 1549 *
1450 * @param obj Object being edited. 1550 * @param obj Object being edited.
1451 * @param part Name of the part. 1551 * @param part Name of the part.
1452 * 1552 *
1453 * @return name of the api if successful, NULL otherwise. 1553 * @return Name of the API if successful, NULL otherwise.
1454 */ 1554 */
1455EAPI const char * edje_edit_part_api_name_get(Evas_Object *obj, const char *part); 1555EAPI const char * edje_edit_part_api_name_get(Evas_Object *obj, const char *part);
1456 1556
1457/** Get api's description of a part. 1557/**
1558 * @brief Gets api's description of a part.
1458 * 1559 *
1459 * @param obj Object being edited. 1560 * @param obj Object being edited.
1460 * @param part Name of the part. 1561 * @param part Name of the part.
1461 * 1562 *
1462 * @return description of the api if successful, NULL otherwise. 1563 * @return Description of the api if successful, NULL otherwise.
1463 */ 1564 */
1464EAPI const char * edje_edit_part_api_description_get(Evas_Object *obj, const char *part); 1565EAPI const char * edje_edit_part_api_description_get(Evas_Object *obj, const char *part);
1465 1566
1466/** Set api's name of a part. 1567/**
1568 * @brief Sets api's name of a part.
1467 * 1569 *
1468 * @param obj Object being edited. 1570 * @param obj Object being edited.
1469 * @param part Name of the part. 1571 * @param part Name of the part.
@@ -1473,7 +1575,8 @@ EAPI const char * edje_edit_part_api_description_get(Evas_Object *obj, const cha
1473 */ 1575 */
1474EAPI Eina_Bool edje_edit_part_api_name_set(Evas_Object *obj, const char *part, const char *name); 1576EAPI Eina_Bool edje_edit_part_api_name_set(Evas_Object *obj, const char *part, const char *name);
1475 1577
1476/** Set api's description of a part. 1578/**
1579 * @brief Sets api's description of a part.
1477 * 1580 *
1478 * @param obj Object being edited. 1581 * @param obj Object being edited.
1479 * @param part Name of part. 1582 * @param part Name of part.
@@ -1483,7 +1586,8 @@ EAPI Eina_Bool edje_edit_part_api_name_set(Evas_Object *obj, const char *part, c
1483 */ 1586 */
1484EAPI Eina_Bool edje_edit_part_api_description_set(Evas_Object *obj, const char *part, const char *description); 1587EAPI Eina_Bool edje_edit_part_api_description_set(Evas_Object *obj, const char *part, const char *description);
1485 1588
1486/** Get the type of a part. 1589/**
1590 * @brief Gets the type of a part.
1487 * 1591 *
1488 * @param obj Object being edited. 1592 * @param obj Object being edited.
1489 * @param part Name of part to get the type of. 1593 * @param part Name of part to get the type of.
@@ -1492,7 +1596,8 @@ EAPI Eina_Bool edje_edit_part_api_description_set(Evas_Object *obj, const char *
1492 */ 1596 */
1493EAPI Edje_Part_Type edje_edit_part_type_get(Evas_Object *obj, const char *part); 1597EAPI Edje_Part_Type edje_edit_part_type_get(Evas_Object *obj, const char *part);
1494 1598
1495/** Get the clip_to part. 1599/**
1600 * @brief Gets the clip_to part.
1496 * 1601 *
1497 * @param obj Object being edited. 1602 * @param obj Object being edited.
1498 * @param part Name of the part whose clipper to get. 1603 * @param part Name of the part whose clipper to get.
@@ -1501,7 +1606,8 @@ EAPI Edje_Part_Type edje_edit_part_type_get(Evas_Object *obj, const char *part);
1501 */ 1606 */
1502EAPI const char * edje_edit_part_clip_to_get(Evas_Object *obj, const char *part); 1607EAPI const char * edje_edit_part_clip_to_get(Evas_Object *obj, const char *part);
1503 1608
1504/** Set a part to clip part to. 1609/**
1610 * @brief Sets a part to clip part to.
1505 * 1611 *
1506 * @param obj Object being edited. 1612 * @param obj Object being edited.
1507 * @param part Part to set the clipper to. 1613 * @param part Part to set the clipper to.
@@ -1511,7 +1617,8 @@ EAPI const char * edje_edit_part_clip_to_get(Evas_Object *obj, const char *part)
1511 */ 1617 */
1512EAPI Eina_Bool edje_edit_part_clip_to_set(Evas_Object *obj, const char *part, const char *clip_to); 1618EAPI Eina_Bool edje_edit_part_clip_to_set(Evas_Object *obj, const char *part, const char *clip_to);
1513 1619
1514/** Get the source of part. 1620/**
1621 * @brief Gets the source of part.
1515 * 1622 *
1516 * The meaning of this parameter varies depending on the type of the part. 1623 * The meaning of this parameter varies depending on the type of the part.
1517 * For GROUP parts, it's the name of another group in the Edje file which will 1624 * For GROUP parts, it's the name of another group in the Edje file which will
@@ -1528,7 +1635,8 @@ EAPI Eina_Bool edje_edit_part_clip_to_set(Evas_Object *obj, const char *part, co
1528 */ 1635 */
1529EAPI const char * edje_edit_part_source_get(Evas_Object *obj, const char *part); 1636EAPI const char * edje_edit_part_source_get(Evas_Object *obj, const char *part);
1530 1637
1531/** Set the source of part. 1638/**
1639 * @brief Sets the source of part.
1532 * 1640 *
1533 * If setting source of the part will lead to recursive reference 1641 * If setting source of the part will lead to recursive reference
1534 * (when A source to B, and B is going to be source to A because of this function), 1642 * (when A source to B, and B is going to be source to A because of this function),
@@ -1549,7 +1657,8 @@ EAPI const char * edje_edit_part_source_get(Evas_Object *obj, const char *part);
1549 */ 1657 */
1550EAPI Eina_Bool edje_edit_part_source_set(Evas_Object *obj, const char *part, const char *source); 1658EAPI Eina_Bool edje_edit_part_source_set(Evas_Object *obj, const char *part, const char *source);
1551 1659
1552/** Get the source2 of part. 1660/**
1661 * @brief Gets the source2 of part.
1553 * 1662 *
1554 * Only available to TEXTBLOCK parts. It is used for the group to be loaded and 1663 * Only available to TEXTBLOCK parts. It is used for the group to be loaded and
1555 * used for selection display OVER the selected text. source is used for under 1664 * used for selection display OVER the selected text. source is used for under
@@ -1563,7 +1672,8 @@ EAPI Eina_Bool edje_edit_part_source_set(Evas_Object *obj, const char *part, con
1563 */ 1672 */
1564EAPI const char * edje_edit_part_source2_get(Evas_Object *obj, const char *part); 1673EAPI const char * edje_edit_part_source2_get(Evas_Object *obj, const char *part);
1565 1674
1566/** Set the source2 of part. 1675/**
1676 * @brief Sets the source2 of part.
1567 * 1677 *
1568 * @param obj Object being edited. 1678 * @param obj Object being edited.
1569 * @param part Part to set the source of. 1679 * @param part Part to set the source of.
@@ -1576,7 +1686,8 @@ EAPI const char * edje_edit_part_source2_get(Evas_Object *obj, const char *part)
1576 */ 1686 */
1577EAPI Eina_Bool edje_edit_part_source2_set(Evas_Object *obj, const char *part, const char *source); 1687EAPI Eina_Bool edje_edit_part_source2_set(Evas_Object *obj, const char *part, const char *source);
1578 1688
1579/** Get the source3 of part. 1689/**
1690 * @brief Gets the source3 of part.
1580 * 1691 *
1581 * Only available to TEXTBLOCK parts. It is used for the group to be loaded and 1692 * Only available to TEXTBLOCK parts. It is used for the group to be loaded and
1582 * used for cursor display UNDER the cursor position. source4 is used for over 1693 * used for cursor display UNDER the cursor position. source4 is used for over
@@ -1590,7 +1701,8 @@ EAPI Eina_Bool edje_edit_part_source2_set(Evas_Object *obj, const char *part, co
1590 */ 1701 */
1591EAPI const char * edje_edit_part_source3_get(Evas_Object *obj, const char *part); 1702EAPI const char * edje_edit_part_source3_get(Evas_Object *obj, const char *part);
1592 1703
1593/** Set the source3 of part. 1704/**
1705 * @brief Sets the source3 of part.
1594 * 1706 *
1595 * @param obj Object being edited. 1707 * @param obj Object being edited.
1596 * @param part Part to set the source of. 1708 * @param part Part to set the source of.
@@ -1605,7 +1717,8 @@ EAPI const char * edje_edit_part_source3_get(Evas_Object *obj, const char *part)
1605 */ 1717 */
1606EAPI Eina_Bool edje_edit_part_source3_set(Evas_Object *obj, const char *part, const char *source); 1718EAPI Eina_Bool edje_edit_part_source3_set(Evas_Object *obj, const char *part, const char *source);
1607 1719
1608/** Get the source4 of part. 1720/**
1721 * @brief Gets the source4 of part.
1609 * 1722 *
1610 * Only available to TEXTBLOCK parts. It is used for the group to be loaded and 1723 * Only available to TEXTBLOCK parts. It is used for the group to be loaded and
1611 * used for cursor display OVER the cursor position. source3 is used for under 1724 * used for cursor display OVER the cursor position. source3 is used for under
@@ -1619,7 +1732,8 @@ EAPI Eina_Bool edje_edit_part_source3_set(Evas_Object *obj, const char *part, co
1619 */ 1732 */
1620EAPI const char * edje_edit_part_source4_get(Evas_Object *obj, const char *part); 1733EAPI const char * edje_edit_part_source4_get(Evas_Object *obj, const char *part);
1621 1734
1622/** Set the source4 of part. 1735/**
1736 * @brief Sets the source4 of part.
1623 * 1737 *
1624 * @param obj Object being edited. 1738 * @param obj Object being edited.
1625 * @param part Part to set the source of. 1739 * @param part Part to set the source of.
@@ -1634,7 +1748,8 @@ EAPI const char * edje_edit_part_source4_get(Evas_Object *obj, const char *part)
1634 */ 1748 */
1635EAPI Eina_Bool edje_edit_part_source4_set(Evas_Object *obj, const char *part, const char *source); 1749EAPI Eina_Bool edje_edit_part_source4_set(Evas_Object *obj, const char *part, const char *source);
1636 1750
1637/** Get the source5 of part. 1751/**
1752 * @brief Gets the source5 of part.
1638 * 1753 *
1639 * Only available to TEXTBLOCK parts. It is used for the group to be loaded and 1754 * Only available to TEXTBLOCK parts. It is used for the group to be loaded and
1640 * used for anchors display UNDER the anchor position. source6 is used for over 1755 * used for anchors display UNDER the anchor position. source6 is used for over
@@ -1648,7 +1763,8 @@ EAPI Eina_Bool edje_edit_part_source4_set(Evas_Object *obj, const char *part, co
1648 */ 1763 */
1649EAPI const char * edje_edit_part_source5_get(Evas_Object *obj, const char *part); 1764EAPI const char * edje_edit_part_source5_get(Evas_Object *obj, const char *part);
1650 1765
1651/** Set the source5 of part. 1766/**
1767 * @brief Sets the source5 of part.
1652 * 1768 *
1653 * @param obj Object being edited. 1769 * @param obj Object being edited.
1654 * @param part Part to set the source of. 1770 * @param part Part to set the source of.
@@ -1661,7 +1777,8 @@ EAPI const char * edje_edit_part_source5_get(Evas_Object *obj, const char *part)
1661 */ 1777 */
1662EAPI Eina_Bool edje_edit_part_source5_set(Evas_Object *obj, const char *part, const char *source); 1778EAPI Eina_Bool edje_edit_part_source5_set(Evas_Object *obj, const char *part, const char *source);
1663 1779
1664/** Get the source6 of part. 1780/**
1781 * @brief Gets the source6 of part.
1665 * 1782 *
1666 * Only available to TEXTBLOCK parts. It is used for the group to be loaded and 1783 * Only available to TEXTBLOCK parts. It is used for the group to be loaded and
1667 * used for anchor display OVER the anchor position. source5 is used for under 1784 * used for anchor display OVER the anchor position. source5 is used for under
@@ -1675,7 +1792,8 @@ EAPI Eina_Bool edje_edit_part_source5_set(Evas_Object *obj, const char *part, co
1675 */ 1792 */
1676EAPI const char * edje_edit_part_source6_get(Evas_Object *obj, const char *part); 1793EAPI const char * edje_edit_part_source6_get(Evas_Object *obj, const char *part);
1677 1794
1678/** Set the source6 of part. 1795/**
1796 * @brief Sets the source6 of part.
1679 * 1797 *
1680 * @param obj Object being edited. 1798 * @param obj Object being edited.
1681 * @param part Part to set the source of. 1799 * @param part Part to set the source of.
@@ -1688,7 +1806,8 @@ EAPI const char * edje_edit_part_source6_get(Evas_Object *obj, const char *part)
1688 */ 1806 */
1689EAPI Eina_Bool edje_edit_part_source6_set(Evas_Object *obj, const char *part, const char *source); 1807EAPI Eina_Bool edje_edit_part_source6_set(Evas_Object *obj, const char *part, const char *source);
1690 1808
1691/** Get the effect for a given part. 1809/**
1810 * @brief Gets the effect for a given part.
1692 * 1811 *
1693 * Gets the effect used for parts of type TEXT. See @ref edcref for more details. 1812 * Gets the effect used for parts of type TEXT. See @ref edcref for more details.
1694 * 1813 *
@@ -1699,7 +1818,8 @@ EAPI Eina_Bool edje_edit_part_source6_set(Evas_Object *obj, const char *part, co
1699 */ 1818 */
1700EAPI Edje_Text_Effect edje_edit_part_effect_get(Evas_Object *obj, const char *part); 1819EAPI Edje_Text_Effect edje_edit_part_effect_get(Evas_Object *obj, const char *part);
1701 1820
1702/** Set the effect for a given part. 1821/**
1822 * @brief Sets the effect for a given part.
1703 * Effects and shadow directions can be combined. 1823 * Effects and shadow directions can be combined.
1704 * 1824 *
1705 * For effect and shadow direction list please look at Edje Part Text ref page. 1825 * For effect and shadow direction list please look at Edje Part Text ref page.
@@ -1714,7 +1834,8 @@ EAPI Edje_Text_Effect edje_edit_part_effect_get(Evas_Object *obj, const char *pa
1714 */ 1834 */
1715EAPI Eina_Bool edje_edit_part_effect_set(Evas_Object *obj, const char *part, Edje_Text_Effect effect); 1835EAPI Eina_Bool edje_edit_part_effect_set(Evas_Object *obj, const char *part, Edje_Text_Effect effect);
1716 1836
1717/** Get the current selected state in part. 1837/**
1838 * @brief Gets the current selected state in part.
1718 * 1839 *
1719 * @param obj Object being edited. 1840 * @param obj Object being edited.
1720 * @param part Part to get the selected state of. 1841 * @param part Part to get the selected state of.
@@ -1724,7 +1845,8 @@ EAPI Eina_Bool edje_edit_part_effect_set(Evas_Object *obj, const char *part, Edj
1724 */ 1845 */
1725EAPI const char * edje_edit_part_selected_state_get(Evas_Object *obj, const char *part, double *value); 1846EAPI const char * edje_edit_part_selected_state_get(Evas_Object *obj, const char *part, double *value);
1726 1847
1727/** Set the current state in part. 1848/**
1849 * @brief Sets the current state in part.
1728 * 1850 *
1729 * @param obj Object being edited. 1851 * @param obj Object being edited.
1730 * @param part Part to set the state of. 1852 * @param part Part to set the state of.
@@ -1735,7 +1857,8 @@ EAPI const char * edje_edit_part_selected_state_get(Evas_Object *obj, const char
1735 */ 1857 */
1736EAPI Eina_Bool edje_edit_part_selected_state_set(Evas_Object *obj, const char *part, const char *state, double value); 1858EAPI Eina_Bool edje_edit_part_selected_state_set(Evas_Object *obj, const char *part, const char *state, double value);
1737 1859
1738/** Get mouse_events for part. 1860/**
1861 * @brief Gets mouse_events for part.
1739 * 1862 *
1740 * @param obj Object being edited. 1863 * @param obj Object being edited.
1741 * @param part Part to get if the mouse events is accepted. 1864 * @param part Part to get if the mouse events is accepted.
@@ -1744,37 +1867,41 @@ EAPI Eina_Bool edje_edit_part_selected_state_set(Evas_Object *obj, const char *p
1744 */ 1867 */
1745EAPI Eina_Bool edje_edit_part_mouse_events_get(Evas_Object *obj, const char *part); 1868EAPI Eina_Bool edje_edit_part_mouse_events_get(Evas_Object *obj, const char *part);
1746 1869
1747/** Set mouse_events for part. 1870/**
1871 * @brief Sets mouse_events for part.
1748 * 1872 *
1749 * @param obj Object being edited. 1873 * @param obj Object being edited.
1750 * @param part The part to set if the mouse events is accepted. 1874 * @param part The part to set if the mouse events is accepted.
1751 * @param mouse_events EINA_TRUE if part will accept mouse events, @c EINA_FALSE otherwise. 1875 * @param mouse_events @c EINA_TRUE if part will accept mouse events, @c EINA_FALSE otherwise.
1752 * 1876 *
1753 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 1877 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
1754 */ 1878 */
1755EAPI Eina_Bool edje_edit_part_mouse_events_set(Evas_Object *obj, const char *part, Eina_Bool mouse_events); 1879EAPI Eina_Bool edje_edit_part_mouse_events_set(Evas_Object *obj, const char *part, Eina_Bool mouse_events);
1756 1880
1757/** Get anti-alising for part. 1881/**
1882 * @brief Gets anti-aliasing for part.
1758 * 1883 *
1759 * @param obj Object being edited. 1884 * @param obj Object being edited.
1760 * @param part Part to get if the anti-aliasing is accepted. 1885 * @param part Part to get if the anti-aliasing is accepted.
1761 * 1886 *
1762 * @return @c EINA_TRUE if part will draw anti-alised, @c EINA_FALSE otherwise. 1887 * @return @c EINA_TRUE if part will draw anti-aliased, @c EINA_FALSE otherwise.
1763 */ 1888 */
1764EAPI Eina_Bool edje_edit_part_anti_alias_get(Evas_Object *obj, const char *part); 1889EAPI Eina_Bool edje_edit_part_anti_alias_get(Evas_Object *obj, const char *part);
1765 1890
1766/** Set anti-alising for part. 1891/**
1892 * @brief Sets anti-aliasing for part.
1767 * 1893 *
1768 * @param obj Object being edited. 1894 * @param obj Object being edited.
1769 * @param part The part to set if the anti-aliasing is accepted. 1895 * @param part The part to set if the anti-aliasing is accepted.
1770 * @param mouse_events EINA_TRUE if part should to draw anti-aliased, @c EINA_FALSE otherwise. 1896 * @param mouse_events @c EINA_TRUE if part should to draw anti-aliased, @c EINA_FALSE otherwise.
1771 * 1897 *
1772 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 1898 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
1773 */ 1899 */
1774EAPI Eina_Bool edje_edit_part_anti_alias_set(Evas_Object *obj, const char *part, Eina_Bool anti_alias); 1900EAPI Eina_Bool edje_edit_part_anti_alias_set(Evas_Object *obj, const char *part, Eina_Bool anti_alias);
1775 1901
1776 1902
1777/** Get repeat_events for part. 1903/**
1904 * @brief Gets repeat_events for part.
1778 * 1905 *
1779 * @param obj Object being edited. 1906 * @param obj Object being edited.
1780 * @param part Part to get if it will pass all events to the other parts. 1907 * @param part Part to get if it will pass all events to the other parts.
@@ -1783,17 +1910,19 @@ EAPI Eina_Bool edje_edit_part_anti_alias_set(Evas_Object *obj, const char *part,
1783 */ 1910 */
1784EAPI Eina_Bool edje_edit_part_repeat_events_get(Evas_Object *obj, const char *part); 1911EAPI Eina_Bool edje_edit_part_repeat_events_get(Evas_Object *obj, const char *part);
1785 1912
1786/** Set repeat_events for part. 1913/**
1914 * @brief Sets repeat_events for part.
1787 * 1915 *
1788 * @param obj Object being edited. 1916 * @param obj Object being edited.
1789 * @param part Part to set if will repeat all the received mouse events to other parts. 1917 * @param part Part to set if will repeat all the received mouse events to other parts.
1790 * @param repeat_events EINA_TRUE if the events received will propagate to other parts, @c EINA_FALSE otherwise 1918 * @param repeat_events @c EINA_TRUE if the events received will propagate to other parts, @c EINA_FALSE otherwise
1791 * 1919 *
1792 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 1920 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
1793 */ 1921 */
1794EAPI Eina_Bool edje_edit_part_repeat_events_set(Evas_Object *obj, const char *part, Eina_Bool repeat_events); 1922EAPI Eina_Bool edje_edit_part_repeat_events_set(Evas_Object *obj, const char *part, Eina_Bool repeat_events);
1795 1923
1796/** Get use_alternate_font_metrics variable for part. 1924/**
1925 * @brief Gets use_alternate_font_metrics variable for part.
1797 * 1926 *
1798 * @param obj Object being edited. 1927 * @param obj Object being edited.
1799 * @param part Part to get use_alternate_font_metrics for text or textblock part is enabled. 1928 * @param part Part to get use_alternate_font_metrics for text or textblock part is enabled.
@@ -1804,7 +1933,8 @@ EAPI Eina_Bool edje_edit_part_repeat_events_set(Evas_Object *obj, const char *pa
1804EAPI Eina_Bool 1933EAPI Eina_Bool
1805edje_edit_part_use_alternate_font_metrics_get(Evas_Object *obj, const char *part); 1934edje_edit_part_use_alternate_font_metrics_get(Evas_Object *obj, const char *part);
1806 1935
1807/** Set use_alternate_font_metrics variable for part. 1936/**
1937 * @brief Sets use_alternate_font_metrics variable for part.
1808 * 1938 *
1809 * @param obj Object being edited. 1939 * @param obj Object being edited.
1810 * @param part Part to set use_alternate_font_metrics for text or textblock part is enabled. 1940 * @param part Part to set use_alternate_font_metrics for text or textblock part is enabled.
@@ -1816,7 +1946,8 @@ edje_edit_part_use_alternate_font_metrics_get(Evas_Object *obj, const char *part
1816EAPI Eina_Bool 1946EAPI Eina_Bool
1817edje_edit_part_use_alternate_font_metrics_set(Evas_Object *obj, const char *part, Eina_Bool use); 1947edje_edit_part_use_alternate_font_metrics_set(Evas_Object *obj, const char *part, Eina_Bool use);
1818 1948
1819/** Get multiline for part. 1949/**
1950 * @brief Gets multiline for part.
1820 * 1951 *
1821 * @param obj Object being edited. 1952 * @param obj Object being edited.
1822 * @param part Part to get if editing multiple lines for text or textblock part is enabled. 1953 * @param part Part to get if editing multiple lines for text or textblock part is enabled.
@@ -1826,18 +1957,20 @@ edje_edit_part_use_alternate_font_metrics_set(Evas_Object *obj, const char *part
1826 */ 1957 */
1827EAPI Eina_Bool edje_edit_part_multiline_get(Evas_Object *obj, const char *part); 1958EAPI Eina_Bool edje_edit_part_multiline_get(Evas_Object *obj, const char *part);
1828 1959
1829/** Set multiline for part. 1960/**
1961 * @brief Sets multiline for part.
1830 * 1962 *
1831 * @param obj Object being edited. 1963 * @param obj Object being edited.
1832 * @param part Part to set if editing multiple lines for text or textblock part is enabled. 1964 * @param part Part to set if editing multiple lines for text or textblock part is enabled.
1833 * @param multiline EINA_TRUE if multiple lines for editing is enabled, @c EINA_FALSE otherwise 1965 * @param multiline @c EINA_TRUE if multiple lines for editing is enabled, @c EINA_FALSE otherwise
1834 * 1966 *
1835 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 1967 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
1836 * @since 1.11 1968 * @since 1.11
1837 */ 1969 */
1838EAPI Eina_Bool edje_edit_part_multiline_set(Evas_Object *obj, const char *part, Eina_Bool multiline); 1970EAPI Eina_Bool edje_edit_part_multiline_set(Evas_Object *obj, const char *part, Eina_Bool multiline);
1839 1971
1840/** Get precise_is_inside for part. 1972/**
1973 * @brief Gets precise_is_inside for part.
1841 * 1974 *
1842 * @param obj Object being edited. 1975 * @param obj Object being edited.
1843 * @param part Part to get if it will enable point collision detection for the part. 1976 * @param part Part to get if it will enable point collision detection for the part.
@@ -1847,7 +1980,8 @@ EAPI Eina_Bool edje_edit_part_multiline_set(Evas_Object *obj, const char *part,
1847 */ 1980 */
1848EAPI Eina_Bool edje_edit_part_precise_is_inside_get(Evas_Object *obj, const char *part); 1981EAPI Eina_Bool edje_edit_part_precise_is_inside_get(Evas_Object *obj, const char *part);
1849 1982
1850/** Set precise_is_inside for part. 1983/**
1984 * @brief Sets precise_is_inside for part.
1851 * 1985 *
1852 * @param obj Object being edited. 1986 * @param obj Object being edited.
1853 * @param part Part to set if it will enable point collision detection for the part. 1987 * @param part Part to set if it will enable point collision detection for the part.
@@ -1858,7 +1992,8 @@ EAPI Eina_Bool edje_edit_part_precise_is_inside_get(Evas_Object *obj, const char
1858 */ 1992 */
1859EAPI Eina_Bool edje_edit_part_precise_is_inside_set(Evas_Object *obj, const char *part, Eina_Bool precise_is_inside); 1993EAPI Eina_Bool edje_edit_part_precise_is_inside_set(Evas_Object *obj, const char *part, Eina_Bool precise_is_inside);
1860 1994
1861/** Get accessibility for part. 1995/**
1996 * @brief Gets accessibility for part.
1862 * 1997 *
1863 * @param obj Object being edited. 1998 * @param obj Object being edited.
1864 * @param part Part to get if it uses accessibility feature. 1999 * @param part Part to get if it uses accessibility feature.
@@ -1868,7 +2003,8 @@ EAPI Eina_Bool edje_edit_part_precise_is_inside_set(Evas_Object *obj, const char
1868 */ 2003 */
1869EAPI Eina_Bool edje_edit_part_access_get(Evas_Object *obj, const char *part); 2004EAPI Eina_Bool edje_edit_part_access_get(Evas_Object *obj, const char *part);
1870 2005
1871/** Set accessibility for part. 2006/**
2007 * @brief Sets accessibility for part.
1872 * 2008 *
1873 * @param obj Object being edited. 2009 * @param obj Object being edited.
1874 * @param part Part to set if it uses accessibility feature. 2010 * @param part Part to set if it uses accessibility feature.
@@ -1879,7 +2015,8 @@ EAPI Eina_Bool edje_edit_part_access_get(Evas_Object *obj, const char *part);
1879 */ 2015 */
1880EAPI Eina_Bool edje_edit_part_access_set(Evas_Object *obj, const char *part, Eina_Bool access); 2016EAPI Eina_Bool edje_edit_part_access_set(Evas_Object *obj, const char *part, Eina_Bool access);
1881 2017
1882/** Get ignore_flags for part. 2018/**
2019 * @brief Gets ignore_flags for part.
1883 * 2020 *
1884 * @param obj Object being edited. 2021 * @param obj Object being edited.
1885 * @param part Part to get which event_flags are being ignored. 2022 * @param part Part to get which event_flags are being ignored.
@@ -1888,7 +2025,8 @@ EAPI Eina_Bool edje_edit_part_access_set(Evas_Object *obj, const char *part, Ein
1888 */ 2025 */
1889EAPI Evas_Event_Flags edje_edit_part_ignore_flags_get(Evas_Object *obj, const char *part); 2026EAPI Evas_Event_Flags edje_edit_part_ignore_flags_get(Evas_Object *obj, const char *part);
1890 2027
1891/** Set ignore_flags for part. 2028/**
2029 * @brief Sets ignore_flags for part.
1892 * 2030 *
1893 * @param obj Object being edited. 2031 * @param obj Object being edited.
1894 * @param part Part to set which event flags will be ignored. 2032 * @param part Part to set which event flags will be ignored.
@@ -1898,7 +2036,8 @@ EAPI Evas_Event_Flags edje_edit_part_ignore_flags_get(Evas_Object *obj, const ch
1898 */ 2036 */
1899EAPI Eina_Bool edje_edit_part_ignore_flags_set(Evas_Object *obj, const char *part, Evas_Event_Flags ignore_flags); 2037EAPI Eina_Bool edje_edit_part_ignore_flags_set(Evas_Object *obj, const char *part, Evas_Event_Flags ignore_flags);
1900 2038
1901/** Get mask_flags for part. 2039/**
2040 * @brief Gets mask_flags for part.
1902 * 2041 *
1903 * @param obj Object being edited. 2042 * @param obj Object being edited.
1904 * @param part Part to get which event_flags are being masked. 2043 * @param part Part to get which event_flags are being masked.
@@ -1907,7 +2046,8 @@ EAPI Eina_Bool edje_edit_part_ignore_flags_set(Evas_Object *obj, const char *par
1907 */ 2046 */
1908EAPI Evas_Event_Flags edje_edit_part_mask_flags_get(Evas_Object *obj, const char *part); 2047EAPI Evas_Event_Flags edje_edit_part_mask_flags_get(Evas_Object *obj, const char *part);
1909 2048
1910/** Set mask_flags for part. 2049/**
2050 * @brief Sets mask_flags for part.
1911 * 2051 *
1912 * @param obj Object being edited. 2052 * @param obj Object being edited.
1913 * @param part Part to set which event flags will be masked. 2053 * @param part Part to set which event flags will be masked.
@@ -1917,7 +2057,8 @@ EAPI Evas_Event_Flags edje_edit_part_mask_flags_get(Evas_Object *obj, const char
1917 */ 2057 */
1918EAPI Eina_Bool edje_edit_part_mask_flags_set(Evas_Object *obj, const char *part, Evas_Event_Flags mask_flags); 2058EAPI Eina_Bool edje_edit_part_mask_flags_set(Evas_Object *obj, const char *part, Evas_Event_Flags mask_flags);
1919 2059
1920/** Get pointer_mode of a part. 2060/**
2061 * @brief Gets pointer_mode of a part.
1921 * 2062 *
1922 * @param obj Object being edited. 2063 * @param obj Object being edited.
1923 * @param part Part name to get it's pointer_mode. 2064 * @param part Part name to get it's pointer_mode.
@@ -1927,7 +2068,8 @@ EAPI Eina_Bool edje_edit_part_mask_flags_set(Evas_Object *obj, const char *part,
1927 */ 2068 */
1928EAPI Evas_Object_Pointer_Mode edje_edit_part_pointer_mode_get(Evas_Object *obj, const char *part); 2069EAPI Evas_Object_Pointer_Mode edje_edit_part_pointer_mode_get(Evas_Object *obj, const char *part);
1929 2070
1930/** Get pointer_mode of a part. 2071/**
2072 * @brief Gets pointer_mode of a part.
1931 * 2073 *
1932 * Note that Ponter Mode can be: 2074 * Note that Ponter Mode can be:
1933 * - EVAS_OBJECT_POINTER_MODE_AUTOGRAB - default, X11-like 2075 * - EVAS_OBJECT_POINTER_MODE_AUTOGRAB - default, X11-like
@@ -1943,7 +2085,8 @@ EAPI Evas_Object_Pointer_Mode edje_edit_part_pointer_mode_get(Evas_Object *obj,
1943 */ 2085 */
1944EAPI Eina_Bool edje_edit_part_pointer_mode_set(Evas_Object *obj, const char *part, Evas_Object_Pointer_Mode pointer_mode); 2086EAPI Eina_Bool edje_edit_part_pointer_mode_set(Evas_Object *obj, const char *part, Evas_Object_Pointer_Mode pointer_mode);
1945 2087
1946/** Get cursor_mode of a part. 2088/**
2089 * @brief Gets cursor_mode of a part.
1947 * 2090 *
1948 * Note that Cursor Mode can be: 2091 * Note that Cursor Mode can be:
1949 * 0 - UNDER cursor mode means the cursor will draw below the character pointed 2092 * 0 - UNDER cursor mode means the cursor will draw below the character pointed
@@ -1959,7 +2102,8 @@ EAPI Eina_Bool edje_edit_part_pointer_mode_set(Evas_Object *obj, const char *par
1959 */ 2102 */
1960EAPI unsigned char edje_edit_part_cursor_mode_get(Evas_Object *obj, const char *part); 2103EAPI unsigned char edje_edit_part_cursor_mode_get(Evas_Object *obj, const char *part);
1961 2104
1962/** Get pointer_mode of a part. 2105/**
2106 * @brief Gets pointer_mode of a part.
1963 * 2107 *
1964 * Note that Cursor Mode can be: 2108 * Note that Cursor Mode can be:
1965 * 0 - UNDER cursor mode means the cursor will draw below the character pointed 2109 * 0 - UNDER cursor mode means the cursor will draw below the character pointed
@@ -1976,7 +2120,8 @@ EAPI unsigned char edje_edit_part_cursor_mode_get(Evas_Object *obj, const char *
1976 */ 2120 */
1977EAPI Eina_Bool edje_edit_part_cursor_mode_set(Evas_Object *obj, const char *part, unsigned char cursor_mode); 2121EAPI Eina_Bool edje_edit_part_cursor_mode_set(Evas_Object *obj, const char *part, unsigned char cursor_mode);
1978 2122
1979/** Set scale property for the part. 2123/**
2124 * @brief Sets scale property for the part.
1980 * 2125 *
1981 * This property tells Edje that the given part should be scaled by the 2126 * This property tells Edje that the given part should be scaled by the
1982 * Edje scale factor. 2127 * Edje scale factor.
@@ -1989,7 +2134,8 @@ EAPI Eina_Bool edje_edit_part_cursor_mode_set(Evas_Object *obj, const char *part
1989 */ 2134 */
1990EAPI Eina_Bool edje_edit_part_scale_set(Evas_Object *obj, const char *part, Eina_Bool scale); 2135EAPI Eina_Bool edje_edit_part_scale_set(Evas_Object *obj, const char *part, Eina_Bool scale);
1991 2136
1992/** Get scale for the part. 2137/**
2138 * @brief Gets scale for the part.
1993 * 2139 *
1994 * @param obj Object being edited. 2140 * @param obj Object being edited.
1995 * @param part Part to get the scale value of. 2141 * @param part Part to get the scale value of.
@@ -1998,45 +2144,50 @@ EAPI Eina_Bool edje_edit_part_scale_set(Evas_Object *obj, const char *part, Eina
1998 */ 2144 */
1999EAPI Eina_Bool edje_edit_part_scale_get(Evas_Object *obj, const char *part); 2145EAPI Eina_Bool edje_edit_part_scale_get(Evas_Object *obj, const char *part);
2000 2146
2001/** Get horizontal dragable state for part. 2147/**
2148 * @brief Gets horizontal dragable state for part.
2002 * 2149 *
2003 * @param obj Object being edited. 2150 * @param obj Object being edited.
2004 * @param part Part to get if can be dragged horizontally; 2151 * @param part Part to get if can be dragged horizontally.
2005 * 2152 *
2006 * @return 1 (or -1) if the part can be dragged horizontally, 0 otherwise. 2153 * @return @c 1 (or -1) if the part can be dragged horizontally, @c 0 otherwise.
2007 */ 2154 */
2008EAPI int edje_edit_part_drag_x_get(Evas_Object *obj, const char *part); 2155EAPI int edje_edit_part_drag_x_get(Evas_Object *obj, const char *part);
2009 2156
2010/** Set horizontal dragable state for part. 2157/**
2158 * @brief Sets horizontal dragable state for part.
2011 * 2159 *
2012 * @param obj Object being edited. 2160 * @param obj Object being edited.
2013 * @param part Part to set if should be dragged horizontally. 2161 * @param part Part to set if should be dragged horizontally.
2014 * @param drag 1 (or -1) if the part should be dragged horizontally, 0 otherwise. 2162 * @param drag @c 1 (or -1) if the part should be dragged horizontally, @c 0 otherwise.
2015 * 2163 *
2016 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 2164 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
2017 */ 2165 */
2018EAPI Eina_Bool edje_edit_part_drag_x_set(Evas_Object *obj, const char *part, int drag); 2166EAPI Eina_Bool edje_edit_part_drag_x_set(Evas_Object *obj, const char *part, int drag);
2019 2167
2020/** Get vertical dragable state for part. 2168/**
2169 * @brief Gets vertical dragable state for part.
2021 * 2170 *
2022 * @param obj Object being edited. 2171 * @param obj Object being edited.
2023 * @param part Part to get if can be dragged vertically. 2172 * @param part Part to get if can be dragged vertically.
2024 * 2173 *
2025 * @return 1 (or - 1) if the part can be dragged vertically, 0 otherwise. 2174 * @return @c 1 (or - 1) if the part can be dragged vertically, @c 0 otherwise.
2026 */ 2175 */
2027EAPI int edje_edit_part_drag_y_get(Evas_Object *obj, const char *part); 2176EAPI int edje_edit_part_drag_y_get(Evas_Object *obj, const char *part);
2028 2177
2029/** Set vertical dragable state for part. 2178/**
2179 * @brief Sets vertical dragable state for part.
2030 * 2180 *
2031 * @param obj Object being edited. 2181 * @param obj Object being edited.
2032 * @param part Part to set if should be dragged vertically. 2182 * @param part Part to set if should be dragged vertically.
2033 * @param drag 1 (or -1) of the part shpuld be dragged vertically, 0 otherwise. 2183 * @param drag @c 1 (or -1) of the part should be dragged vertically, @c 0 otherwise.
2034 * 2184 *
2035 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 2185 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
2036 */ 2186 */
2037EAPI Eina_Bool edje_edit_part_drag_y_set(Evas_Object *obj, const char *part, int drag); 2187EAPI Eina_Bool edje_edit_part_drag_y_set(Evas_Object *obj, const char *part, int drag);
2038 2188
2039/** Get horizontal dragable step for part. 2189/**
2190 * @brief Gets horizontal dragable step for part.
2040 * 2191 *
2041 * @param obj Object being edited. 2192 * @param obj Object being edited.
2042 * @param part Part to get the drag horizontal step value. 2193 * @param part Part to get the drag horizontal step value.
@@ -2045,7 +2196,8 @@ EAPI Eina_Bool edje_edit_part_drag_y_set(Evas_Object *obj, const char *part, int
2045 */ 2196 */
2046EAPI int edje_edit_part_drag_step_x_get(Evas_Object *obj, const char *part); 2197EAPI int edje_edit_part_drag_step_x_get(Evas_Object *obj, const char *part);
2047 2198
2048/** Set horizontal dragable state for part. 2199/**
2200 * @brief Sets horizontal dragable state for part.
2049 * 2201 *
2050 * @param obj Object being edited. 2202 * @param obj Object being edited.
2051 * @param part Part to set the drag horizontal step value. 2203 * @param part Part to set the drag horizontal step value.
@@ -2055,7 +2207,8 @@ EAPI int edje_edit_part_drag_step_x_get(Evas_Object *obj, const char *part);
2055 */ 2207 */
2056EAPI Eina_Bool edje_edit_part_drag_step_x_set(Evas_Object *obj, const char *part, int step); 2208EAPI Eina_Bool edje_edit_part_drag_step_x_set(Evas_Object *obj, const char *part, int step);
2057 2209
2058/** Get vertical dragable step for part. 2210/**
2211 * @brief Gets vertical dragable step for part.
2059 * 2212 *
2060 * @param obj Object being edited. 2213 * @param obj Object being edited.
2061 * @param part Part to get the drag vertical step value. 2214 * @param part Part to get the drag vertical step value.
@@ -2064,7 +2217,8 @@ EAPI Eina_Bool edje_edit_part_drag_step_x_set(Evas_Object *obj, const char *part
2064 */ 2217 */
2065EAPI int edje_edit_part_drag_step_y_get(Evas_Object *obj, const char *part); 2218EAPI int edje_edit_part_drag_step_y_get(Evas_Object *obj, const char *part);
2066 2219
2067/** Set vertical dragable state for part. 2220/**
2221 * @brief Sets vertical dragable state for part.
2068 * 2222 *
2069 * @param obj Object being edited. 2223 * @param obj Object being edited.
2070 * @param part Part to set the drag vertical step value. 2224 * @param part Part to set the drag vertical step value.
@@ -2074,16 +2228,18 @@ EAPI int edje_edit_part_drag_step_y_get(Evas_Object *obj, const char *part);
2074 */ 2228 */
2075EAPI Eina_Bool edje_edit_part_drag_step_y_set(Evas_Object *obj, const char *part, int step); 2229EAPI Eina_Bool edje_edit_part_drag_step_y_set(Evas_Object *obj, const char *part, int step);
2076 2230
2077/** Get horizontal dragable count for part. 2231/**
2232 * @brief Gets horizontal dragable count for part.
2078 * 2233 *
2079 * @param obj Object being edited. 2234 * @param obj Object being edited.
2080 * @param part Part to get the drag horizontal count value. 2235 * @param part Part to get the drag horizontal count value.
2081 * 2236 *
2082 * @return horizontal dragable count value 2237 * @return Horizontal dragable count value
2083 */ 2238 */
2084EAPI int edje_edit_part_drag_count_x_get(Evas_Object *obj, const char *part); 2239EAPI int edje_edit_part_drag_count_x_get(Evas_Object *obj, const char *part);
2085 2240
2086/** Set horizontal dragable count for part. 2241/**
2242 * @brief Sets horizontal dragable count for part.
2087 * 2243 *
2088 * @param obj Object being edited. 2244 * @param obj Object being edited.
2089 * @param part Part to set the drag horizontal count value. 2245 * @param part Part to set the drag horizontal count value.
@@ -2093,16 +2249,18 @@ EAPI int edje_edit_part_drag_count_x_get(Evas_Object *obj, const char *part);
2093 */ 2249 */
2094EAPI Eina_Bool edje_edit_part_drag_count_x_set(Evas_Object *obj, const char *part, int count); 2250EAPI Eina_Bool edje_edit_part_drag_count_x_set(Evas_Object *obj, const char *part, int count);
2095 2251
2096/** Get vertical dragable count for part. 2252/**
2253 * @brief Gets vertical dragable count for part.
2097 * 2254 *
2098 * @param obj Object being edited. 2255 * @param obj Object being edited.
2099 * @param part Part to get the drag vertical count value. 2256 * @param part Part to get the drag vertical count value.
2100 * 2257 *
2101 * @return vertical dragable count value 2258 * @return Vertical dragable count value
2102 */ 2259 */
2103EAPI int edje_edit_part_drag_count_y_get(Evas_Object *obj, const char *part); 2260EAPI int edje_edit_part_drag_count_y_get(Evas_Object *obj, const char *part);
2104 2261
2105/** Set vertical dragable count for part. 2262/**
2263 * @brief Sets vertical dragable count for part.
2106 * 2264 *
2107 * @param obj Object being edited. 2265 * @param obj Object being edited.
2108 * @param part Part to set the drag vertical count value. 2266 * @param part Part to set the drag vertical count value.
@@ -2112,26 +2270,29 @@ EAPI int edje_edit_part_drag_count_y_get(Evas_Object *obj, const char *part);
2112 */ 2270 */
2113EAPI Eina_Bool edje_edit_part_drag_count_y_set(Evas_Object *obj, const char *part, int count); 2271EAPI Eina_Bool edje_edit_part_drag_count_y_set(Evas_Object *obj, const char *part, int count);
2114 2272
2115/** Get the name of the part that is used as 'confine' for the given draggies. 2273/**
2274 * @brief Gets the name of the part that is used as 'confine' for the given draggies.
2116 * 2275 *
2117 * @param obj Object being edited. 2276 * @param obj Object being edited.
2118 * @param part Part to get the name that is used as 'confine' for the given draggies. 2277 * @param part Part to get the name that is used as 'confine' for the given draggies.
2119 * 2278 *
2120 * @return The name of the confine part or NULL (if unset). 2279 * @return The name of the confine part, or NULL (if unset).
2121 */ 2280 */
2122EAPI const char * edje_edit_part_drag_confine_get(Evas_Object *obj, const char *part); 2281EAPI const char * edje_edit_part_drag_confine_get(Evas_Object *obj, const char *part);
2123 2282
2124/** Set the name of the part that is used as 'confine' for the given draggies. 2283/**
2284 * @brief Sets the name of the part that is used as 'confine' for the given draggies.
2125 * 2285 *
2126 * @param obj Object being edited. 2286 * @param obj Object being edited.
2127 * @param part Part to set the name that is used as 'confine' for the given draggies. 2287 * @param part Part to set the name that is used as 'confine' for the given draggies.
2128 * @param confine The name of the confine part or NULL to unset confine. 2288 * @param confine The name of the confine part, or NULL to unset confine.
2129 * 2289 *
2130 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise. 2290 * @return @c EINA_TRUE in case of success, @c EINA_FALSE otherwise.
2131 */ 2291 */
2132EAPI Eina_Bool edje_edit_part_drag_confine_set(Evas_Object *obj, const char *part, const char *confine); 2292EAPI Eina_Bool edje_edit_part_drag_confine_set(Evas_Object *obj, const char *part, const char *confine);
2133 2293
2134/** Get the name of the part that is used as the receiver of the drag event. 2294/**
2295 * @brief Gets the name of the part that is used as the receiver of the drag event.
2135 * 2296 *
2136 * @param obj Object being edited. 2297 * @param obj Object being edited.
2137 * @param part Part to get the name that is used as the receiver of the drag event. 2298 * @param part Part to get the name that is used as the receiver of the drag event.
@@ -2140,7 +2301,8 @@ EAPI Eina_Bool edje_edit_part_drag_confine_set(Evas_Object *obj, const char *par
2140 */ 2301 */
2141EAPI const char * edje_edit_part_drag_event_get(Evas_Object *obj, const char *part); 2302EAPI const char * edje_edit_part_drag_event_get(Evas_Object *obj, const char *part);
2142 2303
2143/** Set the name of the part that will receive events from the given draggies. 2304/**
2305 * @brief Sets the name of the part that will receive events from the given draggies.
2144 * 2306 *
2145 * @param obj Object being edited. 2307 * @param obj Object being edited.
2146 * @param part Part to set the name that will receive events from the given draggies. 2308 * @param part Part to set the name that will receive events from the given draggies.
@@ -2150,20 +2312,22 @@ EAPI const char * edje_edit_part_drag_event_get(Evas_Object *obj, const char *pa
2150 */ 2312 */
2151EAPI Eina_Bool edje_edit_part_drag_event_set(Evas_Object *obj, const char *part, const char *event); 2313EAPI Eina_Bool edje_edit_part_drag_event_set(Evas_Object *obj, const char *part, const char *event);
2152 2314
2153/** Get the name of the part that is used as 'threshold' for the given draggies. 2315/**
2316 * @brief Gets the name of the part that is used as 'threshold' for the given draggies.
2154 * 2317 *
2155 * @param obj Object being edited. 2318 * @param obj Object being edited.
2156 * @param part Part to get the name that is used as 'threshold' for the given draggies. 2319 * @param part Part to get the name that is used as 'threshold' for the given draggies.
2157 * 2320 *
2158 * @return The name of the threshold part or NULL (if unset). 2321 * @return The name of the threshold part, or NULL (if unset).
2159 */ 2322 */
2160EAPI const char * edje_edit_part_drag_threshold_get(Evas_Object *obj, const char *part); 2323EAPI const char * edje_edit_part_drag_threshold_get(Evas_Object *obj, const char *part);
2161 2324
2162/** Set the name of the part that is used as 'threshold' for the given draggies. 2325/**
2326 * @brief Sets the name of the part that is used as 'threshold' for the given draggies.
2163 * 2327 *
2164 * @param obj Object being edited. 2328 * @param obj Object being edited.
2165 * @param part Part to set the name that is used as 'threshold' for the given draggies. 2329 * @param part Part to set the name that is used as 'threshold' for the given draggies.
2166 * @param threshold The name of the threshold part or NULL to unset confine.