dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[edje] Better doc for edje_object_part_swallow. 

SVN revision: 71630
This commit is contained in:
Gustavo Lima Chaves 2012-06-01 20:51:17 +00:00
parent ebdbff021c
commit 04f00945fa
1 changed files with 30 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
legacy/edje/src/lib/Edje.h
View File

@ -3122,18 +3122,40 @@ EAPI void *edje_object_text_markup_filter_callback_del(Evas_Object *obj, const c
EAPI void *edje_object_text_markup_filter_callback_del_full(Evas_Object *obj, 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 part The part name
* @param obj_swallow The object to swallow
* @param obj A valid Edje object handle
* @param part The swallow part's name
* @param obj_swallow The object to occupy that part
*
* Swallows the object into the edje part so that all geometry changes
* for the part affect the swallowed object. (e.g. resize, move, show,
* raise/lower, etc.).
* Swallowing an object into an Edje object is, for a given part of
* type @c SWALLOW in the EDC group which gave life to @a obj, to set
* 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
* 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, const char *part, Evas_Object *obj_swallow);