summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMarcel Hollerbach <mail@marcel-hollerbach.de>2019-02-17 18:08:42 +0100
committerMarcel Hollerbach <mail@marcel-hollerbach.de>2019-02-22 14:00:30 +0100
commit46ce95f43f9a54de74e8ff4900a79705a4c41cb0 (patch)
tree08a3ffcbd783a5907817e665329520f43cfe7b59 /src
parent113cb3b97cb92e57416d9c088527e9bdab46f782 (diff)
efl_ui_focus_object: improve doc
ref T7571 Reviewed-by: Xavi Artigas <xavierartigas@yahoo.es> Differential Revision: https://phab.enlightenment.org/D7992
Diffstat (limited to 'src')
-rw-r--r--src/lib/elementary/efl_ui_focus_object.eo16
1 files changed, 4 insertions, 12 deletions
diff --git a/src/lib/elementary/efl_ui_focus_object.eo b/src/lib/elementary/efl_ui_focus_object.eo
index 451e0b314a..a0589228d6 100644
--- a/src/lib/elementary/efl_ui_focus_object.eo
+++ b/src/lib/elementary/efl_ui_focus_object.eo
@@ -24,23 +24,17 @@ mixin @beta Efl.Ui.Focus.Object
24 [[This is called by the manager and should never be called by 24 [[This is called by the manager and should never be called by
25 anyone else. 25 anyone else.
26 26
27 It can be used by configuring a focus object to adapt to
28 any changes that are required.
29
30 The function emits the focus state events, if focus is 27 The function emits the focus state events, if focus is
31 different to the previous state. 28 different to the previous state.
32 ]] 29 ]]
33
34 } 30 }
35 values { 31 values {
36 focus : bool; [[The focused state of the object]] 32 focus : bool; [[The focused state of the object]]
37 } 33 }
38 } 34 }
39 @property focus_manager { 35 @property focus_manager {
40 [[Describes which manager is used to register. 36 [[This is the focus manager where this focus object is registered in.
41 37 The element which is the $root of a Efl.Ui.Focus.Manager will not have this focus manager as this object, but rather the second focus manager where it is registered in.
42 If an instance of this interface is the root of a manager, this instance should not have a manager where as root of this property. The other manager in this instance will be set as focused in the corresponding manager.
43 This instance should be registered with its own manager as redirect.
44 ]] 38 ]]
45 get {} 39 get {}
46 values { 40 values {
@@ -55,20 +49,18 @@ mixin @beta Efl.Ui.Focus.Object
55 } 49 }
56 } 50 }
57 @property child_focus @protected { 51 @property child_focus @protected {
58 [[set if a child of this element has focus or not.]] 52 [[Indicates if a child of this object has focus setted to true.]]
59 values { 53 values {
60 child_focus : bool; 54 child_focus : bool;
61 } 55 }
62 } 56 }
63 prepare_logical { 57 prepare_logical {
64 [[Tells the object that its children will be queried soon by the given manager. 58 [[Tells the object that its children will be queried soon by the given manager.
65 The call will be a NOP if there is already a active preprare_logical call on this object
66
67 Deleting manager items in this call will result in undefined behaviour and may cause your system to crash. 59 Deleting manager items in this call will result in undefined behaviour and may cause your system to crash.
68 ]] 60 ]]
69 } 61 }
70 prepare_logical_none_recursive @protected { 62 prepare_logical_none_recursive @protected {
71 [[]] 63 [[This is called when prepare_logical is called, but only on the first call, additional recursive calls to $prepare_logical will not call this function agian.]]
72 } 64 }
73 on_focus_update @protected { 65 on_focus_update @protected {
74 [[Virtual function handling focus in/out events on the widget]] 66 [[Virtual function handling focus in/out events on the widget]]