efl/src/lib/ecore/ecore_timer.eo

68 lines
2.3 KiB
Plaintext
Raw Normal View History

class Ecore.Timer (Eo.Base)
2014-03-23 22:47:52 -07:00
{
/*@ Timers are objects that will call a given callback at some point
* in the future. They may also optionall repeat themselves if the
* timer callback returns true. If it does not they will be
* automatically deleted and never called again. Timers require the
* ecore mainloop to be running and functioning properly. They do not
* guarantee exact timing, but try to work on a "best effort basis.
*/
2014-03-23 22:47:52 -07:00
eo_prefix: ecore_obj_timer;
constructors {
loop_constructor {
/*@ Create a timer to call in a given time from now */
2014-03-23 22:47:52 -07:00
params {
@in double in; /*@ The time, in seconds, from now when to go off */
@in Ecore_Task_Cb func; /*@ The callback function to call when the timer goes off */
@in const(void)* data; /*@ A pointer to pass to the callback function as its data pointer */
2014-03-23 22:47:52 -07:00
}
}
constructor {
/*@ Create a timer to call in a given time from when the mainloop woke up from sleep */
2014-03-23 22:47:52 -07:00
params {
@in double in; /*@ The time, in seconds, from when the main loop woke up, to go off */
@in Ecore_Task_Cb func; /*@ The callback function to call when the timer goes off */
@in const(void)* data; /*@ A pointer to pass to the callback function as its data pointer */
2014-03-23 22:47:52 -07:00
}
}
}
properties {
interval {
set {
/*@ Change the interval the timer ticks off. */
2014-03-23 22:47:52 -07:00
}
get {
/*@ Get the interval the timer ticks on. */
}
values {
double in; /*@ The new interval in seconds */
2014-03-23 22:47:52 -07:00
}
}
pending {
get {
/*@ Get the pending time regarding a timer. */
return double;
}
}
}
methods {
reset {
/*@ Reset a timer to its full interval. This effectively makes
* the timer start ticking off from zero now. */
2014-03-23 22:47:52 -07:00
}
delay {
/*@ Add some delay for the next occurrence of a timer. */
params {
@in double add; /*@ The amount of time to delay the timer by in seconds */
2014-03-23 22:47:52 -07:00
}
}
}
implements {
Eo.Base.constructor;
Eo.Base.destructor;
Eo.Base.event_freeze;
Eo.Base.event_freeze_count.get;
Eo.Base.event_thaw;
2014-03-23 22:47:52 -07:00
}
}