Edje.h | Edje.h | |||
---|---|---|---|---|
/** | /** | |||
@brief Edje Graphical Design Library | @brief Edje Graphical Design Library | |||
These routines are used for Edje. | These routines are used for Edje. | |||
@mainpage Edje Library Documentation | @mainpage Edje Library Documentation | |||
@version 1.1 | @version 1.7 | |||
@date 2003-2012 | @date 2003-2012 | |||
Please see the @ref authors page for contact details. | Please see the @ref authors page for contact details. | |||
@section intro What is Edje? | @section intro What is Edje? | |||
Edje is a complex graphical design & layout library. | Edje is a complex graphical design & layout library. | |||
It doesn't intend to do containing and regular layout like a widget | It doesn't intend to do containing and regular layout like a widget | |||
set, but it is the base for such components. Based on the requirements | set, but it is the base for such components. Based on the requirements | |||
skipping to change at line 186 | skipping to change at line 186 | |||
@author Mathieu Taillefumier <mathieu.taillefumier@@free.fr> | @author Mathieu Taillefumier <mathieu.taillefumier@@free.fr> | |||
@author Tristan <blunderer@@gmail.com> | @author Tristan <blunderer@@gmail.com> | |||
@author Gustavo Lima Chaves <glima@@profusion.mobi> | @author Gustavo Lima Chaves <glima@@profusion.mobi> | |||
@author Bruno Dilly <bdilly@@profusion.mobi> | @author Bruno Dilly <bdilly@@profusion.mobi> | |||
@author Fabiano Fidêncio <fidencio@@profusion.mobi> | @author Fabiano Fidêncio <fidencio@@profusion.mobi> | |||
@author Jihoon Kim <jihoon48.kim@@samsung.com> | @author Jihoon Kim <jihoon48.kim@@samsung.com> | |||
@author Tiago Falcão <tiago@@profusion.mobi> | @author Tiago Falcão <tiago@@profusion.mobi> | |||
@author Davide Andreoli <dave@@gurumeditation.it> | @author Davide Andreoli <dave@@gurumeditation.it> | |||
@author Sebastian Dransfeld <sd@@tango.flipp.net> | @author Sebastian Dransfeld <sd@@tango.flipp.net> | |||
@author Tom Hacohen <tom@@stosb.com> | @author Tom Hacohen <tom@@stosb.com> | |||
@author Aharon Hillel <a.hillel@@partner.samsung.com> | @author Aharon Hillel <a.hillel@@samsung.com> | |||
@author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com> | @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com> | |||
@author Mike Blumenkrantz <michael.blumenkrantz@gmail.com | @author Mike Blumenkrantz <michael.blumenkrantz@gmail.com | |||
@author Jaehwan Kim <jae.hwan.kim@samsung.com> | @author Jaehwan Kim <jae.hwan.kim@samsung.com> | |||
@author billiob (Boris Faure) <billiob@gmail.com> | @author billiob (Boris Faure) <billiob@gmail.com> | |||
@author Govindaraju SM <govi.sm@samsung.com> <govism@gmail.com> | @author Govindaraju SM <govi.sm@samsung.com> <govism@gmail.com> | |||
@author Prince Kumar Dubey <prince.dubey@samsung.com> <prince.dubey@gmail.c om> | @author Prince Kumar Dubey <prince.dubey@samsung.com> <prince.dubey@gmail.c om> | |||
@author David Seikel <onefang at gmail.com> | @author David Seikel <onefang at gmail.com> | |||
@author Guilherme Íscaro <iscaro@profusion.mobi> | @author Guilherme Íscaro <iscaro@profusion.mobi> | |||
Please contact <enlightenment-devel@lists.sourceforge.net> to get in | Please contact <enlightenment-devel@lists.sourceforge.net> to get in | |||
skipping to change at line 293 | skipping to change at line 293 | |||
# else | # else | |||
# define EAPI | # define EAPI | |||
# endif | # endif | |||
#endif | #endif | |||
#ifdef __cplusplus | #ifdef __cplusplus | |||
extern "C" { | extern "C" { | |||
#endif | #endif | |||
#define EDJE_VERSION_MAJOR 1 | #define EDJE_VERSION_MAJOR 1 | |||
#define EDJE_VERSION_MINOR 2 | #define EDJE_VERSION_MINOR 7 | |||
typedef struct _Edje_Version | typedef struct _Edje_Version | |||
{ | { | |||
int major; | int major; | |||
int minor; | int minor; | |||
int micro; | int micro; | |||
int revision; | int revision; | |||
} Edje_Version; | } Edje_Version; | |||
EAPI extern Edje_Version *edje_version; | EAPI extern Edje_Version *edje_version; | |||
skipping to change at line 370 | skipping to change at line 370 | |||
EDJE_PART_TYPE_TEXT = 2, | EDJE_PART_TYPE_TEXT = 2, | |||
EDJE_PART_TYPE_IMAGE = 3, | EDJE_PART_TYPE_IMAGE = 3, | |||
EDJE_PART_TYPE_SWALLOW = 4, | EDJE_PART_TYPE_SWALLOW = 4, | |||
EDJE_PART_TYPE_TEXTBLOCK = 5, | EDJE_PART_TYPE_TEXTBLOCK = 5, | |||
EDJE_PART_TYPE_GRADIENT = 6, | EDJE_PART_TYPE_GRADIENT = 6, | |||
EDJE_PART_TYPE_GROUP = 7, | EDJE_PART_TYPE_GROUP = 7, | |||
EDJE_PART_TYPE_BOX = 8, | EDJE_PART_TYPE_BOX = 8, | |||
EDJE_PART_TYPE_TABLE = 9, | EDJE_PART_TYPE_TABLE = 9, | |||
EDJE_PART_TYPE_EXTERNAL = 10, | EDJE_PART_TYPE_EXTERNAL = 10, | |||
EDJE_PART_TYPE_PROXY = 11, | EDJE_PART_TYPE_PROXY = 11, | |||
EDJE_PART_TYPE_LAST = 12 | EDJE_PART_TYPE_SPACER = 12, /**< @since 1.7 */ | |||
EDJE_PART_TYPE_LAST = 13 | ||||
} Edje_Part_Type; | } Edje_Part_Type; | |||
typedef enum _Edje_Text_Effect | typedef enum _Edje_Text_Effect | |||
{ | { | |||
#define EDJE_TEXT_EFFECT_MASK_BASIC 0xf | #define EDJE_TEXT_EFFECT_MASK_BASIC 0xf | |||
#define EDJE_TEXT_EFFECT_BASIC_SET(x, s) \ | #define EDJE_TEXT_EFFECT_BASIC_SET(x, s) \ | |||
do { x = ((x) & ~EDJE_TEXT_EFFECT_MASK_BASIC) | (s); } while (0) | do { x = ((x) & ~EDJE_TEXT_EFFECT_MASK_BASIC) | (s); } while (0) | |||
EDJE_TEXT_EFFECT_NONE = 0, | EDJE_TEXT_EFFECT_NONE = 0, | |||
EDJE_TEXT_EFFECT_PLAIN = 1, | EDJE_TEXT_EFFECT_PLAIN = 1, | |||
EDJE_TEXT_EFFECT_OUTLINE = 2, | EDJE_TEXT_EFFECT_OUTLINE = 2, | |||
skipping to change at line 1370 | skipping to change at line 1371 | |||
* @brief Set the Edje text class. | * @brief Set the Edje text class. | |||
* | * | |||
* @param text_class The text class name | * @param text_class The text class name | |||
* @param font The font name | * @param font The font name | |||
* @param size The font size | * @param size The font size | |||
* | * | |||
* @return @c EINA_TRUE, on success or @c EINA_FALSE, on error | * @return @c EINA_TRUE, on success or @c EINA_FALSE, on error | |||
* | * | |||
* This function updates all Edje members at the process level which | * This function updates all Edje members at the process level which | |||
* belong to this text class with the new font attributes. | * belong to this text class with the new font attributes. | |||
* If the @p size is 0 then the font size will be kept with the previous si | ||||
ze. | ||||
* If the @p size is less then 0 then the font size will be calculated in t | ||||
he | ||||
* percentage. For example, if the @p size is -50, then the font size will | ||||
be | ||||
* scaled to half of the original size and if the @p size is -10 then the f | ||||
ont | ||||
* size will be scaled as much as 0.1x. | ||||
* | * | |||
* @see edje_text_class_get(). | * @see edje_text_class_get(). | |||
* | * | |||
*/ | */ | |||
EAPI Eina_Bool edje_text_class_set (const char *text_class, const char *font, Evas_Font_Size size); | EAPI Eina_Bool edje_text_class_set (const char *text_class, const char *font, Evas_Font_Size size); | |||
/** | /** | |||
* @brief Delete the text class. | * @brief Delete the text class. | |||
* | * | |||
* @param text_class The text class name string | * @param text_class The text class name string | |||
skipping to change at line 2281 | skipping to change at line 2287 | |||
* This function sets the callback to be called when the text changes. | * This function sets the callback to be called when the text changes. | |||
*/ | */ | |||
EAPI void edje_object_text_change_cb_set (Evas_Object *obj, Ed je_Text_Change_Cb func, void *data); | EAPI void edje_object_text_change_cb_set (Evas_Object *obj, Ed je_Text_Change_Cb func, void *data); | |||
/** | /** | |||
* @brief Sets the text for an object part | * @brief Sets the text for an object part | |||
* | * | |||
* @param obj A valid Evas Object handle | * @param obj A valid Evas Object handle | |||
* @param part The part name | * @param part The part name | |||
* @param text The text string | * @param text The text string | |||
* | ||||
* @return @c EINA_BOOL on success, @c EINA_FALSE otherwise | ||||
*/ | */ | |||
EAPI Eina_Bool edje_object_part_text_set (Evas_Object *obj, co nst char *part, const char *text); | EAPI Eina_Bool edje_object_part_text_set (Evas_Object *obj, co nst char *part, const char *text); | |||
/** | /** | |||
* @brief Sets the text for an object part, but converts HTML escapes to UT F8 | * @brief Sets the text for an object part, but converts HTML escapes to UT F8 | |||
* | * | |||
* This converts the given string @p text to UTF8 assuming it contains HTML | * This converts the given string @p text to UTF8 assuming it contains HTML | |||
* style escapes like "&" and "©" etc. IF the part is of type TEXT , | * style escapes like "&" and "©" etc. IF the part is of type TEXT , | |||
* as opposed to TEXTBLOCK. | * as opposed to TEXTBLOCK. | |||
* | * | |||
* @param obj A valid Evas Object handle | * @param obj A valid Evas Object handle | |||
* @param part The part name | * @param part The part name | |||
* @param text The text string | * @param text The text string | |||
* | ||||
* @return @c EINA_BOOL on success, @c EINA_FALSE otherwise | ||||
* | ||||
* @since 1.2 | * @since 1.2 | |||
*/ | */ | |||
EAPI Eina_Bool edje_object_part_text_escaped_set (Evas_Object *obj, co nst char *part, const char *text); | EAPI Eina_Bool edje_object_part_text_escaped_set (Evas_Object *obj, co nst char *part, const char *text); | |||
/** | /** | |||
* @brief Return the text of the object part. | * @brief Return the text of the object part. | |||
* | * | |||
* @param obj A valid Evas_Object handle | * @param obj A valid Evas_Object handle | |||
* @param part The part name | * @param part The part name | |||
* | * | |||
skipping to change at line 3102 | skipping to change at line 3113 | |||
* @param part The part name | * @param part The part name | |||
* @param func The function callback to remove | * @param func The function callback to remove | |||
* @param data The data passed to the callback function | * @param data The data passed to the callback function | |||
* | * | |||
* @return The same data pointer if successful, or NULL otherwise | * @return The same data pointer if successful, or NULL otherwise | |||
* @since 1.2.0 | * @since 1.2.0 | |||
*/ | */ | |||
EAPI void *edje_object_text_markup_filter_callback_del_full(Evas_Object *ob j, const char *part, Edje_Markup_Filter_Cb func, void *data); | EAPI void *edje_object_text_markup_filter_callback_del_full(Evas_Object *ob j, const char *part, Edje_Markup_Filter_Cb func, void *data); | |||
/** | /** | |||
* @brief Swallows an object into the edje. | * @brief "Swallows" an object into one of the Edje object @c SWALLOW | |||
* parts. | ||||
* | * | |||
* @param obj A valid Evas_Object handle | * @param obj A valid Edje object handle | |||
* @param part The part name | * @param part The swallow part's name | |||
* @param obj_swallow The object to swallow | * @param obj_swallow The object to occupy that part | |||
* | * | |||
* Swallows the object into the edje part so that all geometry changes | * Swallowing an object into an Edje object is, for a given part of | |||
* for the part affect the swallowed object. (e.g. resize, move, show, | * type @c SWALLOW in the EDC group which gave life to @a obj, to set | |||
* raise/lower, etc.). | * an external object to be controlled by @a obj, being displayed | |||
* exactly over that part's region inside the whole Edje object's | ||||
* viewport. | ||||
* | ||||
* From this point on, @a obj will have total control over @a | ||||
* obj_swallow's geometry and visibility. For instance, if @a obj is | ||||
* visible, as in @c evas_object_show(), the swallowed object will be | ||||
* visible too -- if the given @c SWALLOW part it's in is also | ||||
* visible. Other actions on @a obj will also reflect on the swallowed | ||||
* object as well (e.g. resizing, moving, raising/lowering, etc.). | ||||
* | ||||
* Finally, all internal changes to @a part, specifically, will | ||||
* reflect on the displaying of @a obj_swallow, for example state | ||||
* changes leading to different visibility states, geometries, | ||||
* positions, etc. | ||||
* | * | |||
* If an object has already been swallowed into this part, then it | * If an object has already been swallowed into this part, then it | |||
* will first be unswallowed before the new object is swallowed. | * will first be unswallowed (as in edje_object_part_unswallow()) | |||
* before the new object is swallowed. | ||||
* | ||||
* @note @a obj @b won't delete the swallowed object once it is | ||||
* deleted -- @a obj_swallow will get to an unparented state again. | ||||
* | ||||
* For more details on EDC @c SWALLOW parts, see @ref edcref "syntax | ||||
* reference". | ||||
*/ | */ | |||
EAPI Eina_Bool edje_object_part_swallow (Evas_Object *obj, co nst char *part, Evas_Object *obj_swallow); | EAPI Eina_Bool edje_object_part_swallow (Evas_Object *obj, co nst char *part, Evas_Object *obj_swallow); | |||
/** | /** | |||
* @brief Unswallow an object. | * @brief Unswallow an object. | |||
* | * | |||
* @param obj A valid Evas_Object handle | * @param obj A valid Evas_Object handle | |||
* @param obj_swallow The swallowed object | * @param obj_swallow The swallowed object | |||
* | * | |||
* Causes the edje to regurgitate a previously swallowed object. :) | * Causes the edje to regurgitate a previously swallowed object. :) | |||
skipping to change at line 3578 | skipping to change at line 3611 | |||
* | * | |||
* Removes all the external objects from the box indicated by part. | * Removes all the external objects from the box indicated by part. | |||
* Elements created from the theme will not be removed. | * Elements created from the theme will not be removed. | |||
* | * | |||
* @see edje_object_part_box_remove() | * @see edje_object_part_box_remove() | |||
* @see edje_object_part_box_remove_at() | * @see edje_object_part_box_remove_at() | |||
*/ | */ | |||
EAPI Eina_Bool edje_object_part_box_remove_all (Evas_Object *obj , const char *part, Eina_Bool clear); | EAPI Eina_Bool edje_object_part_box_remove_all (Evas_Object *obj , const char *part, Eina_Bool clear); | |||
/** | /** | |||
* @brief Retrieve a list all accessibility part names | ||||
* | ||||
* @param obj A valid Evas_Object handle | ||||
* @return A list all accessibility part names on @p obj | ||||
* @since 1.7.0 | ||||
*/ | ||||
EAPI Eina_List * edje_object_access_part_list_get (const Evas_Objec | ||||
t *obj); | ||||
/** | ||||
* @brief Retrieve a child from a table | * @brief Retrieve a child from a table | |||
* | * | |||
* @param obj A valid Evas_Object handle | * @param obj A valid Evas_Object handle | |||
* @param part The part name | * @param part The part name | |||
* @param col The column of the child to get | * @param col The column of the child to get | |||
* @param row The row of the child to get | * @param row The row of the child to get | |||
* @return The child Evas_Object | * @return The child Evas_Object | |||
*/ | */ | |||
EAPI Evas_Object *edje_object_part_table_child_get (Evas_Object *obj , const char *part, unsigned int col, unsigned int row); | EAPI Evas_Object *edje_object_part_table_child_get (const Evas_Objec t *obj, const char *part, unsigned int col, unsigned int row); | |||
/** | /** | |||
* @brief Packs an object into the table. | * @brief Packs an object into the table. | |||
* | * | |||
* @param obj A valid Evas_Object handle | * @param obj A valid Evas_Object handle | |||
* @param part The part name | * @param part The part name | |||
* @param child_obj The object to pack in | * @param child_obj The object to pack in | |||
* @param col The column to place it in | * @param col The column to place it in | |||
* @param row The row to place it in | * @param row The row to place it in | |||
* @param colspan Columns the child will take | * @param colspan Columns the child will take | |||
End of changes. 12 change blocks. | ||||
14 lines changed or deleted | 61 lines changed or added | |||