Tizen Native API
Edje Swallow Part

Functions

EINA_DEPRECATED void edje_extern_object_min_size_set (Evas_Object *obj, Evas_Coord minw, Evas_Coord minh)
 Set the object minimum size.
void edje_extern_object_max_size_set (Evas_Object *obj, Evas_Coord maxw, Evas_Coord maxh)
 Set the object maximum size.
void edje_extern_object_aspect_set (Evas_Object *obj, Edje_Aspect_Control aspect, Evas_Coord aw, Evas_Coord ah)
 Set the object aspect size.
void edje_object_part_unswallow (Edje_Object *obj, Evas_Object *obj_swallow)
 Unswallow an object.
Evas_Objectedje_object_part_swallow_get (const Edje_Object *obj, const char *part)
 Get the object currently swallowed by a part.
Eina_Bool edje_object_part_swallow (Edje_Object *obj, const char *part, Evas_Object *obj_swallow)
 Swallows an object into one of the Edje object SWALLOW parts.

Typedefs

typedef enum _Edje_Aspect_Control Edje_Aspect_Control

Functions that deal with parts of type swallow and swallowed objects.

A important feature of Edje is to be able to create Evas_Objects in code and place them in a layout. And that is what swallowing is all about.

Swallow parts are place holders defined in the EDC file for objects that one may want to include in the layout later, or for objects that are not native of Edje. In this last case, Edje will only treat the Evas_Object properties of the swallowed objects.


Typedef Documentation

All Edje aspect control values


Function Documentation

Set the object aspect size.

Since :
2.3
Parameters:
objA valid Evas_Object handle
aspectThe aspect control axes
awThe aspect radio width
ahThe aspect ratio height

This sets the desired aspect ratio to keep an object that will be swallowed by Edje. The width and height define a preferred size ASPECT and the object may be scaled to be larger or smaller, but retaining the relative scale of both aspect width and height.

Deprecated:
use evas_object_size_hint_aspect_set() instead. Deprecated since Tizen 2.4

Set the object maximum size.

Since :
2.3
Parameters:
[in]objA valid Evas_Object handle
[in]maxwThe maximum width
[in]maxhThe maximum height
Remarks:
This sets the maximum size restriction for the object.
Deprecated:
use evas_object_size_hint_max_set() instead. Deprecated since Tizen 2.4

Set the object minimum size.

Since :
2.3
Parameters:
objA valid Evas_Object handle
minwThe minimum width
minhThe minimum height

This sets the minimum size restriction for the object.

Deprecated:
use evas_object_size_hint_min_set() instead. Deprecated sinze Tizen 2.4
Eina_Bool edje_object_part_swallow ( Edje_Object *  obj,
const char *  part,
Evas_Object obj_swallow 
)

Swallows an object into one of the Edje object SWALLOW parts.

Since :
2.3
Remarks:
Swallowing an object into an Edje object is, for a given part of type SWALLOW in the EDC group which gave life to obj, to set an external object to be controlled by obj, being displayed exactly over that part's region inside the whole Edje object's viewport.
From this point on, obj will have total control over obj_swallow's geometry and visibility. For instance, if obj is visible, as in evas_object_show(), the swallowed object will be visible too -- if the given SWALLOW part it's in is also visible. Other actions on obj will also reflect on the swallowed object as well (e.g. resizing, moving, raising/lowering, etc.).
Finally, all internal changes to part, specifically, will reflect on the displaying of 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 will first be unswallowed (as in edje_object_part_unswallow()) before the new object is swallowed.
obj won't delete the swallowed object once it is deleted -- obj_swallow will get to an unparented state again.

For more details on EDC SWALLOW parts, see edcref syntax reference.

Parameters:
[in]objThe edje object
[in]partThe swallow part's name
[in]obj_swallowThe object to occupy that part
Evas_Object* edje_object_part_swallow_get ( const Edje_Object *  obj,
const char *  part 
)

Get the object currently swallowed by a part.

Since :
2.3
Returns:
The swallowed object, or NULL if there is none.
Parameters:
[in]objThe edje object
[in]partThe part name
void edje_object_part_unswallow ( Edje_Object *  obj,
Evas_Object obj_swallow 
)

Unswallow an object.

Since :
2.3
Remarks:
Causes the edje to regurgitate a previously swallowed object. :)
obj_swallow will not be deleted or hidden.
obj_swallow may appear shown on the evas depending on its state when it got unswallowed. Make sure you delete it or hide it if you do not want it to.
Parameters:
[in]objThe edje object
[in]obj_swallowThe swallowed object