edje: add note to the reference of .part_object_get()

Summary:
For EDJE_RP_TYPE_SWALLOW objects (like GROUP, SWALLOW, EXTERNAL),
edje_object_part_object_get() will return NULL or transparent rectangle.
The note is added to have developers use edje_object_part_swallow_get()
in that case.

Reviewers: jpeg, Hermet, cedric

Reviewed By: cedric

Subscribers: Hermet

Differential Revision: https://phab.enlightenment.org/D3859

Signed-off-by: Cedric Bail <cedric@osg.samsung.com>
This commit is contained in:
Jee-Yong Um 2016-04-22 15:17:01 -07:00 committed by Cedric Bail
parent 1aaeaf2b3b
commit 076037bd55
1 changed files with 5 additions and 1 deletions

View File

@ -1202,7 +1202,11 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File)
because it's meant to be managed by Edje, solely. You are safe to because it's meant to be managed by Edje, solely. You are safe to
query information about its current state (with query information about its current state (with
evas_object_visible_get() or \@ref evas_object_color_get() for evas_object_visible_get() or \@ref evas_object_color_get() for
example), though.]] example), though.
Note: If the type of Edje part is GROUP, SWALLOW or EXTERNAL,
returned handle by this function will indicate nothing or transparent
rectangle for events. Use @.part_swallow_get() in that case.]]
return: const(Evas.Object)*; [[A pointer to the Evas object implementing the given part, return: const(Evas.Object)*; [[A pointer to the Evas object implementing the given part,
or $null on failure (e.g. the given part doesn't exist)]] or $null on failure (e.g. the given part doesn't exist)]]
params { params {