Tizen Native API
Functions | Typedefs
Edje Part
Edje Object

This group discusses functions that deal with layout components.

Remarks:
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.

Remarks:
This section has some functions specific for some types and others that could be applied to any type.

Functions

Eina_Bool edje_object_part_exists (const Evas_Object *obj, const char *part)
 Checks whether an edje part exists in a given edje object's group definition.
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.
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)
 Gets the geometry of a given edje part, in a given edje object's group definition, relative to the object's area.
Eina_List * edje_object_access_part_list_get (const Evas_Object *obj)
 Gets a list of all accessibility part names.

Typedefs

typedef enum _Edje_Part_Type Edje_Part_Type
 Edje Part Type.

Enumeration Type Documentation

enum _Edje_Part_Type

Edje Part Type.

Enumerator:
EDJE_PART_TYPE_SPACER 
Since (EFL) :
1.7

Function Documentation

Eina_List* edje_object_access_part_list_get ( const Evas_Object *  obj)

Gets a list of all accessibility part names.

Since (EFL) :
1.7.0
Since :
2.3.1
Parameters:
[in]objA valid Evas_Object handle
Returns:
A list of all accessibility part names on obj
Eina_Bool edje_object_part_exists ( const Evas_Object *  obj,
const char *  part 
)

Checks whether an edje part exists in a given edje object's group definition.

This function returns if a given part exists in the edje group bound to object obj (with edje_object_file_set()).

Since :
2.3.1
Remarks:
This call is useful, for example, when one could expect a given GUI element, depending on the theme applied to obj.
Parameters:
[in]objA handle to an edje object
[in]partThe part's name to check for existence in obj's group
Returns:
EINA_TRUE, if the edje part exists in obj's group, otherwise EINA_FALSE (and on errors)
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 
)

Gets the geometry of a given edje part, in a given edje object's group definition, relative to the object's area.

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.

Since :
2.3.1
Remarks:
Use NULL pointers on the geometry components you're not interested in, they are ignored by the function.
On failure, this function makes all non-NULL geometry pointers' pointed variables as zero.
Parameters:
[in]objA handle to an edje object
[in]partThe edje part's name
[out]xA pointer to a variable to store the part's x coordinate
[out]yA pointer to a variable to store the part's y coordinate
[out]wA pointer to a variable to store the part's width
[out]hA pointer to a variable to store the part's height
Returns:
EINA_TRUE if success, otherwise EINA_FALSE
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.

This function gets a pointer of the Evas object corresponding to a given part in the obj object's group.

Since :
2.3.1
Remarks:
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.
Parameters:
[in]objA handle to an edje object
[in]partThe edje part's name
Returns:
A pointer to the Evas object implementing the given part, otherwise NULL on failure (e.g. the given part doesn't exist)