enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 1 Projects Releases Wiki Activity

docs: Enhance Efl.Ui.Clickable_Util documentation

This commit is contained in:
Xavi Artigas 2019-07-16 12:20:31 +02:00
parent 34f88a5786
commit 1b2a5570c3
1 changed files with 21 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/lib/elementary/efl_ui_clickable_util.eo
View File

@ -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.
This means, widgets themselfs do not neccessarily need to listen to the theme signals. This function does this, and calls the correct clickable functions.
Using these methods widgets do not need to listen to the theme signals. This class
does it 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.
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.
Using these methods widgets do not need to listen to the object events. This class
does it 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.]]
}
}
}