kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

efl_ui_autorepeat: fix documentations 

eo_prefix is not required here. And the class documentation is improved.

Reviewed-by: Marcel Hollerbach <mail@marcel-hollerbach.de>
Differential Revision: https://phab.enlightenment.org/D8806
This commit is contained in:
Marcel Hollerbach 2019-05-02 19:35:35 +00:00
parent 1baf3ba772
commit 55506f1428
1 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/lib/efl/interfaces/efl_ui_autorepeat.eo
View File

@ -1,46 +1,47 @@
interface @beta Efl.Ui.Autorepeat { interface @beta Efl.Ui.Autorepeat {
[[Efl UI autorepeat interface]] [[Interface for autorepeating clicks.
eo_prefix: efl_ui;
This interface abstracts functions for enabling / disabling this feature.
When enabled, keeping a button pressed will continuously emit the $repeated
event until the button is released. The time it takes until it starts
emitting the event is given by @.autorepeat_initial_timeout, and the
time between each new emission by @.autorepeat_gap_timeout.
]]
methods { methods {
@property autorepeat_initial_timeout { @property autorepeat_initial_timeout {
[[The initial timeout before the autorepeat event is generated [[The initial timeout before the autorepeat event is generated.
Sets the timeout, in seconds, since the button is pressed until the Sets the timeout, in seconds, since the button is pressed until the
first $repeated signal is emitted. If $t is 0.0 or less, there first $repeated signal is emitted. If $t is 0.0 or less, there
won't be any delay and the event will be fired the moment the button is won't be any delay and the event will be fired the moment the button is
pressed. pressed.
See also @.autorepeat_enabled.set, @.autorepeat_gap_timeout.set. See also @.autorepeat_enabled and @.autorepeat_gap_timeout.
]] ]]
values { values {
t: double; [[Timeout in seconds]] t: double; [[Timeout in seconds.]]
} }
} }
@property autorepeat_gap_timeout { @property autorepeat_gap_timeout {
[[The interval between each generated autorepeat event [[The interval between each generated autorepeat event.
After the first $repeated event is fired, all subsequent ones will After the first $repeated event is fired, all subsequent ones will
follow after a delay of $t seconds for each. follow after a delay of $t seconds for each.
See also @.autorepeat_initial_timeout.set. See also @.autorepeat_initial_timeout.
]] ]]
values { values {
t: double; [[Interval in seconds]] t: double; [[Time interval in seconds.]]
} }
} }
@property autorepeat_enabled { @property autorepeat_enabled {
[[Turn on/off the autorepeat event generated when the button is kept pressed [[Turn on/off the autorepeat event generated when a button is kept pressed.
When off, no autorepeat is performed and buttons emit a normal $clicked When off, no autorepeat is performed and buttons emit a normal $clicked
signal when they are clicked. event when they are clicked.
When on, keeping a button pressed will continuously emit a $repeated
signal until the button is released. The time it takes until it starts
emitting the signal is given by @.autorepeat_initial_timeout.set, and the
time between each new emission by @.autorepeat_gap_timeout.set.
]] ]]
values { values {
on: bool; [[A bool to turn on/off the event]] on: bool; [[A bool to turn on/off the repeat event generation.]]
} }
} }
} }