From 38e36ad237745cd5e8a3f19c3ffe695ace560711 Mon Sep 17 00:00:00 2001 From: antognolli Date: Wed, 29 Jun 2011 18:15:36 +0000 Subject: [PATCH] ecore/timer - Document ecore_timer_freeze and ecore_timer_thaw. git-svn-id: http://svn.enlightenment.org/svn/e/trunk/ecore@60830 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- src/lib/ecore/ecore_timer.c | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/src/lib/ecore/ecore_timer.c b/src/lib/ecore/ecore_timer.c index 36f8c1d..a9758a0 100644 --- a/src/lib/ecore/ecore_timer.c +++ b/src/lib/ecore/ecore_timer.c @@ -318,8 +318,18 @@ ecore_timer_pending_get(Ecore_Timer *timer) } /** + * Pauses a running timer. * + * @param timer The timer to be paused. * + * The timer callback won't be called while the timer is paused. The remaining + * time until the timer expires will be saved, so the timer can be resumed with + * that same remaining time to expire, instead of expiring instantly. Use + * ecore_timer_thaw() to resume it. + * + * @note Nothing happens if the timer was already paused. + * + * @see ecore_timer_thaw() */ EAPI void ecore_timer_freeze(Ecore_Timer *timer) @@ -347,6 +357,19 @@ ecore_timer_freeze(Ecore_Timer *timer) timer->frozen = 1; } +/** + * Resumes a frozen (paused) timer. + * + * @param timer The timer to be resumed. + * + * The timer will be resumed from its previous relative position in time. That + * means, if it had X seconds remaining until expire when it was paused, it will + * be started now with those same X seconds remaining to expire again. But + * notice that the interval time won't be touched by this call or by + * ecore_timer_freeze(). + * + * @see ecore_timer_freeze() + */ EAPI void ecore_timer_thaw(Ecore_Timer *timer) { -- 2.7.4