ui.widget: enhance documentation of sub_object_add

Reviewers: segfaultxavi, bu5hm4n

Reviewed By: segfaultxavi, bu5hm4n

Subscribers: bu5hm4n, kimcinoo, cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D8281
This commit is contained in:
Yeongjong Lee 2019-03-11 12:17:17 +01:00 committed by Xavi Artigas
parent 6524589e86
commit c043b11f46
1 changed files with 17 additions and 3 deletions

View File

@ -253,7 +253,15 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
/* Internal hooks. */
widget_sub_object_add @protected {
[[Virtual function handling sub objects being added.
[[Virtual function customizing sub objects being added.
When a widget is added as a sub-object of another widget (like list
elements inside a list container, for example) some of its properties
are automatically adapted to the parent's current values (like focus,
access, theme, scale, mirror, scrollable child get, translate,
display mode set, tree dump).
Override this method if you want to customize differently sub-objects
being added to this object.
Sub objects can be any canvas object, not necessarily widgets.
@ -266,11 +274,17 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
return: bool; [[Indicates if the operation succeeded.]]
}
widget_sub_object_del @protected {
[[Virtual function handling sub objects being removed.
[[Virtual function customizing sub objects being removed.
When a widget is removed as a sub-object from another widget
(@Efl.Pack.unpack, @Efl.Content.content_unset, for example) some of
its properties are automatically adjusted.(like focus, access, tree dump)
Override this method if you want to customize differently sub-objects
being removed to this object.
Sub objects can be any canvas object, not necessarily widgets.
See also @.widget_parent.
See also @.widget_parent and @.widget_sub_object_add.
]]
params {
@in sub_obj: Efl.Canvas.Object;