xartigas pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=1b2a5570c3d1b24f8335512e22f8b9103b9741f6
commit 1b2a5570c3d1b24f8335512e22f8b9103b9741f6
Author: Xavi Artigas <xavierarti...@yahoo.es>
Date: Tue Jul 16 12:20:31 2019 +0200
docs: Enhance Efl.Ui.Clickable_Util documentation
---
src/lib/elementary/efl_ui_clickable_util.eo | 29 +++++++++++++++++++++--------
1 file 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 @@
class @beta Efl.Ui.Clickable_Util {
+ [[Helper class that connects theme signals or object events to the
@Efl.Ui.Clickable interface.
+
+ This simplifies creating widgets that implement the @Efl.Ui.Clickable
interface.
+ ]]
methods {
bind_to_theme @class {
- [[This will listen to the standard events of a theme, and emit the
events on clickable
+ [[This will listen to the standard "click" events on a theme and emit
the appropriate
+ events through the @Efl.Ui.Clickable interface.
+
+ Using these methods widgets do not need to listen to the theme
signals. This class
+ does it and calls the correct clickable functions.
- This means, widgets themselfs do not neccessarily need to listen to
the theme signals. This function does this, and calls the correct clickable
functions.
+ This handles theme signals "efl,action,press", "efl,action,unpress"
and "efl,action,mouse_out",
+ and the @[Efl.Input.Interface.pointer,move] event.
]]
params {
- object : Efl.Canvas.Layout; [[The object to listen on]]
- clickable : Efl.Ui.Clickable; [[The object to call the clickable
events on]]
+ object : Efl.Canvas.Layout; [[The object to listen on.]]
+ clickable : Efl.Ui.Clickable; [[The object to call the clickable
methods on.]]
}
}
bind_to_object @class {
- [[This will listen to the standard events on a object, and call the
correct methods on clickable
+ [[This will listen to the standard "click" events on an object, and emit
the appropriate
+ events through the @Efl.Ui.Clickable interface.
+
+ Using these methods widgets do not need to listen to the object
events. This class
+ does it and calls the correct clickable functions.
- 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.
+ The handled events are @[Efl.Input.Interface.pointer,up] and
@[Efl.Input.Interface.pointer,down].
]]
params {
- object : Efl.Input.Interface; [[The object to listen on]]
- clickable : Efl.Ui.Clickable; [[The object to call the clickable
events on]]
+ object : Efl.Input.Interface; [[The object to listen on.]]
+ clickable : Efl.Ui.Clickable; [[The object to call the clickable
methods on.]]
}
}
}
--
