From: Yeongjong Lee <yj34.lee@samsung.com>
Date: Mon, 11 Mar 2019 11:17:17 +0000 (+0100)
Subject: ui.widget: enhance documentation of sub_object_add
X-Git-Tag: submit/tizen/20190318.043110~23
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6e51ea66b10eee31bb404f5d1737e6f297fa6d8e;p=platform%2Fupstream%2Fefl.git

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
---

diff --git a/src/lib/elementary/efl_ui_widget.eo b/src/lib/elementary/efl_ui_widget.eo
index a93b2cf..2bdfc15 100644
--- a/src/lib/elementary/efl_ui_widget.eo
+++ b/src/lib/elementary/efl_ui_widget.eo
@@ -282,7 +282,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.
 
@@ -295,11 +303,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;