Functions that deal with layout components. More...
Modules | |
Edje Text Part | |
Functions that deal with parts of type text. | |
Edje Swallow Part | |
Functions that deal with parts of type swallow and swallowed objects. | |
Edje Drag | |
Functions that deal with dragable parts. | |
Edje Box Part | |
Functions that deal with parts of type box. | |
Edje Table Part | |
Functions that deal with parts of type table. | |
Typedefs | |
typedef enum _Edje_Part_Type | Edje_Part_Type |
Enumerations | |
enum | _Edje_Part_Type { EDJE_PART_TYPE_NONE = 0, EDJE_PART_TYPE_RECTANGLE = 1, EDJE_PART_TYPE_TEXT = 2, EDJE_PART_TYPE_IMAGE = 3, EDJE_PART_TYPE_SWALLOW = 4, EDJE_PART_TYPE_TEXTBLOCK = 5, EDJE_PART_TYPE_GRADIENT = 6, EDJE_PART_TYPE_GROUP = 7, EDJE_PART_TYPE_BOX = 8, EDJE_PART_TYPE_TABLE = 9, EDJE_PART_TYPE_EXTERNAL = 10, EDJE_PART_TYPE_PROXY = 11, EDJE_PART_TYPE_SPACER = 12, EDJE_PART_TYPE_LAST = 13 } |
#define | edje_obj_part_exists(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_EXISTS), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool *, ret) |
Check if an Edje part exists in a given Edje object's group. More... | |
#define | edje_obj_part_object_get(part, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_OBJECT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const Evas_Object **, ret) |
Get a handle to the Evas object implementing a given Edje. More... | |
#define | edje_obj_part_geometry_get(part, x, y, w, h, ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_GEOMETRY_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Coord *, x), EO_TYPECHECK(Evas_Coord *, y), EO_TYPECHECK(Evas_Coord *, w), EO_TYPECHECK(Evas_Coord *, h), EO_TYPECHECK(Eina_Bool *, ret) |
Retrieve the geometry of a given Edje part, in a given Edje. More... | |
#define | edje_obj_access_part_list_get(ret) EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_ACCESS_PART_LIST_GET), EO_TYPECHECK(Eina_List **, ret) |
Retrieve a list all accessibility part names. More... | |
Eina_Bool | edje_object_part_exists (const Evas_Object *obj, const char *part) |
Check if an Edje part exists in a given Edje object's group definition. More... | |
const Evas_Object * | edje_object_part_object_get (const Evas_Object *obj, const char *part) |
Get a handle to the Evas object implementing a given Edje part, in an Edje object. More... | |
Eina_Bool | edje_object_part_geometry_get (const Evas_Object *obj, const char *part, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) |
Retrieve the geometry of a given Edje part, in a given Edje object's group definition, relative to the object's area More... | |
Eina_List * | edje_object_access_part_list_get (const Evas_Object *obj) |
Retrieve a list all accessibility part names. More... | |
Functions that deal with layout components.
Parts are layout components, but as a layout, they are objects too.
There are several types of parts, these types can be divided into two main categories, the first being containers. Containers are parts that are in effect a group of elements. The second group is that of the elements, these part types may not contain others.
This section has some functions specific for some types and others that could be applied to any type.
#define edje_obj_part_exists | ( | part, | |
ret | |||
) | EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_EXISTS), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Eina_Bool *, ret) |
Check if an Edje part exists in a given Edje object's group.
[in] | part | |
[out] | ret |
Referenced by edje_object_part_exists().
#define edje_obj_part_object_get | ( | part, | |
ret | |||
) | EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_OBJECT_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(const Evas_Object **, ret) |
Get a handle to the Evas object implementing a given Edje.
[in] | part | |
[out] | ret |
Referenced by edje_object_part_object_get().
#define edje_obj_part_geometry_get | ( | part, | |
x, | |||
y, | |||
w, | |||
h, | |||
ret | |||
) | EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_PART_GEOMETRY_GET), EO_TYPECHECK(const char *, part), EO_TYPECHECK(Evas_Coord *, x), EO_TYPECHECK(Evas_Coord *, y), EO_TYPECHECK(Evas_Coord *, w), EO_TYPECHECK(Evas_Coord *, h), EO_TYPECHECK(Eina_Bool *, ret) |
Retrieve the geometry of a given Edje part, in a given Edje.
[in] | part | |
[out] | x | |
[out] | y | |
[out] | w | |
[out] | h | |
[out] | ret |
Referenced by edje_object_part_geometry_get().
#define edje_obj_access_part_list_get | ( | ret | ) | EDJE_OBJ_ID(EDJE_OBJ_SUB_ID_ACCESS_PART_LIST_GET), EO_TYPECHECK(Eina_List **, ret) |
Retrieve a list all accessibility part names.
[out] | ret |
Referenced by edje_object_access_part_list_get().
enum _Edje_Part_Type |
Eina_Bool edje_object_part_exists | ( | const Evas_Object * | obj, |
const char * | part | ||
) |
Check if an Edje part exists in a given Edje object's group definition.
obj | A handle to an Edje object |
part | The part's name to check for existence in obj's group |
EINA_TRUE
, if the Edje part exists in obj's
group or EINA_FALSE
, otherwise (and on errors)This function returns if a given part exists in the Edje group bound to object obj
(with edje_object_file_set()).
This call is useful, for example, when one could expect or not a given GUI element, depending on the theme applied to obj
.
References EAPI, edje_obj_part_exists, EINA_FALSE, and EINA_TRUE.
const Evas_Object* edje_object_part_object_get | ( | const Evas_Object * | obj, |
const char * | part | ||
) |
Get a handle to the Evas object implementing a given Edje part, in an Edje object.
obj | A handle to an Edje object |
part | The Edje part's name |
NULL
on failure (e.g. the given part doesn't exist)This function gets a pointer of the Evas object corresponding to a given part in the obj
object's group.
You should never modify the state of the returned object (with evas_object_move()
or evas_object_hide()
for example), because it's meant to be managed by Edje, solely. You are safe to query information about its current state (with evas_object_visible_get()
or evas_object_color_get()
for example), though.
References EAPI, and edje_obj_part_object_get.
Eina_Bool edje_object_part_geometry_get | ( | const Evas_Object * | obj, |
const char * | part, | ||
Evas_Coord * | x, | ||
Evas_Coord * | y, | ||
Evas_Coord * | w, | ||
Evas_Coord * | h | ||
) |
Retrieve the geometry of a given Edje part, in a given Edje object's group definition, relative to the object's area
obj | A handle to an Edje object |
part | The Edje part's name |
x | A pointer to a variable where to store the part's x coordinate |
y | A pointer to a variable where to store the part's y coordinate |
w | A pointer to a variable where to store the part's width |
h | A pointer to a variable where to store the part's height |
This function gets the geometry of an Edje part within its group. The x
and y
coordinates are relative to the top left corner of the whole obj
object's area.
NULL
pointers on the geometry components you're not interested in: they'll be ignored by the function.NULL
geometry pointers' pointed variables be set to zero. References EAPI, edje_obj_part_geometry_get, EINA_FALSE, and EINA_TRUE.
Eina_List* edje_object_access_part_list_get | ( | const Evas_Object * | obj | ) |
Retrieve a list all accessibility part names.
obj | A valid Evas_Object handle |
obj
References _Eina_List::data, EAPI, edje_obj_access_part_list_get, EINA_FALSE, eina_list_append(), EINA_LIST_FOREACH, eina_list_nth(), eina_list_remove_list(), EINA_TRUE, EVAS_CALLBACK_DEL, evas_object_box_append(), evas_object_box_children_get(), evas_object_box_insert_at(), evas_object_box_insert_before(), evas_object_box_prepend(), evas_object_box_remove(), evas_object_box_remove_at(), evas_object_data_del(), evas_object_data_get(), evas_object_data_set(), evas_object_del(), evas_object_event_callback_add(), evas_object_event_callback_del_full(), and _Evas_Object_Box_Option::obj.