bu5hm4n pushed a commit to branch master.

http://git.enlightenment.org/core/efl.git/commit/?id=ee3ffd5a49d82bb136db09e3a8592d2a01a24eba

commit ee3ffd5a49d82bb136db09e3a8592d2a01a24eba
Author: Xavi Artigas <[email protected]>
Date:   Wed Apr 17 15:02:12 2019 +0000

    docs: Clarify Efl.Content behavior
    
    Now we need to make sure implementations actually follow this behavior.
    
    Reviewed-by: Marcel Hollerbach <[email protected]>
    Differential Revision: https://phab.enlightenment.org/D8635
---
 src/lib/efl/interfaces/efl_content.eo | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/src/lib/efl/interfaces/efl_content.eo 
b/src/lib/efl/interfaces/efl_content.eo
index ed3e96b18c..d23ac388a4 100644
--- a/src/lib/efl/interfaces/efl_content.eo
+++ b/src/lib/efl/interfaces/efl_content.eo
@@ -1,6 +1,6 @@
 interface Efl.Content
 {
-   [[Common interface for objects that have a (single) content.
+   [[Common interface for objects that have a single sub-object as content.
 
      This is used for the default content part of widgets, as well as for
      individual parts through @Efl.Part.
@@ -9,17 +9,24 @@ interface Efl.Content
    ]]
    methods {
       @property content {
-         [[Swallowed sub-object contained in this object.]]
+         [[Sub-object currently set as this object's single content.
+
+           If it is set multiple times, previous sub-objects are removed first.
+           Therefore, if an invalid $content is set the object will
+           become empty (it will have no sub-object).
+         ]]
          set {
-            return: bool; [[$true on success, $false otherwise]]
+            return: bool; [[$true if $content was successfully swallowed.]]
          }
          get {}
          values {
-            content: Efl.Gfx.Entity; [[The object to swallow.]]
+            content: Efl.Gfx.Entity; [[The sub-object.]]
          }
       }
       content_unset {
-         [[Unswallow the object in the current container and return it.]]
+         [[Remove the sub-object currently set as content of this object and 
return it.
+           This object becomes empty.
+         ]]
          return: Efl.Gfx.Entity; [[Unswallowed object]]
       }
    }

-- 


Reply via email to