Tizen Native API
Edje Box Part

Functions

void edje_box_layout_register (const char *name, Evas_Object_Box_Layout func, void *(*layout_data_get)(void *), void(*layout_data_free)(void *), void(*free_data)(void *), void *data)
 Registers a custom layout to be used in edje boxes.
Evas_Objectedje_object_part_box_remove_at (Edje_Object *obj, const char *part, unsigned int pos)
 Removes an object from the box.
Eina_Bool edje_object_part_box_insert_at (Edje_Object *obj, const char *part, Evas_Object *child, unsigned int pos)
 Inserts an object to the box.
Eina_Bool edje_object_part_box_prepend (Edje_Object *obj, const char *part, Evas_Object *child)
 Prepends an object to the box.
Evas_Objectedje_object_part_box_remove (Edje_Object *obj, const char *part, Evas_Object *child)
 Removes an object from the box.
Eina_Bool edje_object_part_box_insert_before (Edje_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference)
 Adds an object to the box.
Eina_Bool edje_object_part_box_append (Edje_Object *obj, const char *part, Evas_Object *child)
 Appends an object to the box.
Eina_Bool edje_object_part_box_remove_all (Edje_Object *obj, const char *part, Eina_Bool clear)
 Removes all elements from the box.

Functions that deal with parts of type box.

Box is a container type for parts, that means it can contain other parts.


Function Documentation

void edje_box_layout_register ( const char *  name,
Evas_Object_Box_Layout  func,
void *(*)(void *)  layout_data_get,
void(*)(void *)  layout_data_free,
void(*)(void *)  free_data,
void *  data 
)

Registers a custom layout to be used in edje boxes.

Since :
2.3
Parameters:
[in]nameThe name of the layout
[in]funcThe function defining the layout
[in]layout_data_getThis function gets the custom data pointer for func
[in]layout_data_freePassed to func to free its private data when needed
[in]free_dataFrees data
[in]dataPrivate pointer passed to layout_data_get
Remarks:
This function registers custom layouts that can be referred from themes by the registered name. The Evas_Object_Box_Layout functions receive two pointers for internal use, one being private data, and the other the function to free that data when it's not longer needed. From Edje, this private data will be retrieved by calling layout_data_get, and layout_data_free will be the free function passed to func. layout_data_get will be called with data as its parameter, and this one will be freed by free_data whenever the layout is unregistered from Edje.
Eina_Bool edje_object_part_box_append ( Edje_Object *  obj,
const char *  part,
Evas_Object child 
)

Appends an object to the box.

Since :
2.3
Returns:
EINA_TRUE: Successfully added. EINA_FALSE: An error occurred.
Remarks:
Appends child to the box indicated by part.
See also:
edje_object_part_box_prepend()
edje_object_part_box_insert_before()
edje_object_part_box_insert_at()
Parameters:
[in]objThe edje object
[in]partThe part name
[in]childThe object to append
Eina_Bool edje_object_part_box_insert_at ( Edje_Object *  obj,
const char *  part,
Evas_Object child,
unsigned int  pos 
)

Inserts an object to the box.

Since :
2.3
Returns:
EINA_TRUE: Successfully added. EINA_FALSE: An error occurred.
Remarks:
Adds child to the box indicated by part, in the position given by pos.
See also:
edje_object_part_box_append()
edje_object_part_box_prepend()
edje_object_part_box_insert_before()
Parameters:
[in]objThe edje object
[in]partThe part name
[in]childThe object to insert
[in]posThe position where to insert child
Eina_Bool edje_object_part_box_insert_before ( Edje_Object *  obj,
const char *  part,
Evas_Object child,
const Evas_Object reference 
)

Adds an object to the box.

Since :
2.3
Returns:
EINA_TRUE: Successfully added. EINA_FALSE: An error occurred.
Remarks:
Inserts child in the box given by part, in the position marked by reference.
See also:
edje_object_part_box_append()
edje_object_part_box_prepend()
edje_object_part_box_insert_at()
Parameters:
[in]objThe edje object
[in]partThe part name
[in]childThe object to insert
[in]referenceThe object to be used as reference
Eina_Bool edje_object_part_box_prepend ( Edje_Object *  obj,
const char *  part,
Evas_Object child 
)

Prepends an object to the box.

Since :
2.3
Returns:
EINA_TRUE: Successfully added. EINA_FALSE: An error occurred.
Remarks:
Prepends child to the box indicated by part.
See also:
edje_object_part_box_append()
edje_object_part_box_insert_before()
edje_object_part_box_insert_at()
Parameters:
[in]objThe edje object
[in]partThe part name
[in]childThe object to prepend
Evas_Object* edje_object_part_box_remove ( Edje_Object *  obj,
const char *  part,
Evas_Object child 
)

Removes an object from the box.

Since :
2.3
Returns:
Pointer to the object removed, or NULL.
Remarks:
Removes child from the box indicated by part.
See also:
edje_object_part_box_remove_at()
edje_object_part_box_remove_all()
Parameters:
[in]objThe edje object
[in]partThe part name
[in]childThe object to remove
Eina_Bool edje_object_part_box_remove_all ( Edje_Object *  obj,
const char *  part,
Eina_Bool  clear 
)

Removes all elements from the box.

Since :
2.3
Returns:
1: Successfully cleared. 0: An error occurred.
Remarks:
Removes all the external objects from the box indicated by part. Elements created from the theme will not be removed.
See also:
edje_object_part_box_remove()
edje_object_part_box_remove_at()
Parameters:
[in]objThe edje object
[in]partThe part name
[in]clearDelete objects on removal
Evas_Object* edje_object_part_box_remove_at ( Edje_Object *  obj,
const char *  part,
unsigned int  pos 
)

Removes an object from the box.

Since :
2.3
Returns:
Pointer to the object removed, or NULL.
Remarks:
Removes from the box indicated by part, the object in the position pos.
See also:
edje_object_part_box_remove()
edje_object_part_box_remove_all()
Parameters:
[in]objThe edje object
[in]partThe part name
[in]posThe position index of the object (starts counting from 0)