diff --git a/src/lib/ecore/Ecore_Legacy.h b/src/lib/ecore/Ecore_Legacy.h index fb5b2a746a..80c0493034 100644 --- a/src/lib/ecore/Ecore_Legacy.h +++ b/src/lib/ecore/Ecore_Legacy.h @@ -255,10 +255,52 @@ EAPI Ecore_Timer *ecore_timer_loop_add(double in, Ecore_Task_Cb func, const void */ EAPI void *ecore_timer_del(Ecore_Timer *timer); +/** + * Pauses a running timer. + * + * @param timer The timer to be paused. + * + * @remarks 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); +/** + * @brief Return whether the timer is freezing. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + * + * @return True if the timer object is freezed, false otherwise. + * + * @see ecore_timer_freeze(), ecore_timer_thaw() + */ EAPI Eina_Bool ecore_timer_freeze_get(Ecore_Timer *timer); +/** + * @brief Resumes a frozen (paused) timer. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif + * + * @remarks 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(). + * + * @param[in] timer The timer to be resumed. + * + * @see ecore_timer_freeze() + */ EAPI void ecore_timer_thaw(Ecore_Timer *timer); #include "efl_loop_timer.eo.legacy.h"