summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-07-16 12:20:31 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-07-16 12:20:31 +0200
commit1b2a5570c3d1b24f8335512e22f8b9103b9741f6 (patch)
tree5a2aa29eca7b2a918f52ffae49c93efeadbe04bd
parent34f88a578690e0bae7da33277be21b1ccf7f4812 (diff)
docs: Enhance Efl.Ui.Clickable_Util documentation
-rw-r--r--src/lib/elementary/efl_ui_clickable_util.eo29
1 files changed, 21 insertions, 8 deletions
diff --git a/src/lib/elementary/efl_ui_clickable_util.eo b/src/lib/elementary/efl_ui_clickable_util.eo
index 5f009e2925..d086c24581 100644
--- a/src/lib/elementary/efl_ui_clickable_util.eo
+++ b/src/lib/elementary/efl_ui_clickable_util.eo
@@ -1,23 +1,36 @@
1class @beta Efl.Ui.Clickable_Util { 1class @beta Efl.Ui.Clickable_Util {
2 [[Helper class that connects theme signals or object events to the @Efl.Ui.Clickable interface.
3
4 This simplifies creating widgets that implement the @Efl.Ui.Clickable interface.
5 ]]
2 methods { 6 methods {
3 bind_to_theme @class { 7 bind_to_theme @class {
4 [[This will listen to the standard events of a theme, and emit the events on clickable 8 [[This will listen to the standard "click" events on a theme and emit the appropriate
9 events through the @Efl.Ui.Clickable interface.
10
11 Using these methods widgets do not need to listen to the theme signals. This class
12 does it and calls the correct clickable functions.
5 13
6 This means, widgets themselfs do not neccessarily need to listen to the theme signals. This function does this, and calls the correct clickable functions. 14 This handles theme signals "efl,action,press", "efl,action,unpress" and "efl,action,mouse_out",
15 and the @[Efl.Input.Interface.pointer,move] event.
7 ]] 16 ]]
8 params { 17 params {
9 object : Efl.Canvas.Layout; [[The object to listen on]] 18 object : Efl.Canvas.Layout; [[The object to listen on.]]
10 clickable : Efl.Ui.Clickable; [[The object to call the clickable events on]] 19 clickable : Efl.Ui.Clickable; [[The object to call the clickable methods on.]]
11 } 20 }
12 } 21 }
13 bind_to_object @class { 22 bind_to_object @class {
14 [[This will listen to the standard events on a object, and call the correct methods on clickable 23 [[This will listen to the standard "click" events on an object, and emit the appropriate
24 events through the @Efl.Ui.Clickable interface.
25
26 Using these methods widgets do not need to listen to the object events. This class
27 does it and calls the correct clickable functions.
15 28
16 This means, widgets themselfs do not neccessarily need to listen to the events on the object. This function does this, and calls the correct clickable functions. 29 The handled events are @[Efl.Input.Interface.pointer,up] and @[Efl.Input.Interface.pointer,down].
17 ]] 30 ]]
18 params { 31 params {
19 object : Efl.Input.Interface; [[The object to listen on]] 32 object : Efl.Input.Interface; [[The object to listen on.]]
20 clickable : Efl.Ui.Clickable; [[The object to call the clickable events on]] 33 clickable : Efl.Ui.Clickable; [[The object to call the clickable methods on.]]
21 } 34 }
22 } 35 }
23 } 36 }