summaryrefslogtreecommitdiff
path: root/src/lib/ecore
diff options
context:
space:
mode:
authorJunsuChoi <jsuya.choi@samsung.com>2018-09-27 11:12:46 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2018-09-27 11:14:04 +0200
commit6f339cdc2a0e614fb41b898f54d6221f1bf4709b (patch)
treebf47f3bd59112ba94773281a469782968c8abfb8 /src/lib/ecore
parent5e0877ca2c0605df7a27dcdaaaba78885460dc0f (diff)
ecore_timer: Add docs for ecore_timer legacy functions
Summary: Find docs of missing legacy functions from 47cdbe3 and add them. Test Plan: make doc Reviewers: cedric, Hermet, segfaultxavi Reviewed By: segfaultxavi Subscribers: #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D7118
Diffstat (limited to 'src/lib/ecore')
-rw-r--r--src/lib/ecore/Ecore_Legacy.h42
1 files changed, 42 insertions, 0 deletions
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
255 */ 255 */
256EAPI void *ecore_timer_del(Ecore_Timer *timer); 256EAPI void *ecore_timer_del(Ecore_Timer *timer);
257 257
258/**
259 * Pauses a running timer.
260 *
261 * @param timer The timer to be paused.
262 *
263 * @remarks The timer callback won't be called while the timer is paused. The remaining
264 * time until the timer expires will be saved, so the timer can be resumed with
265 * that same remaining time to expire, instead of expiring instantly. Use
266 * ecore_timer_thaw() to resume it.
267 *
268 * @note Nothing happens if the timer was already paused.
269 *
270 * @see ecore_timer_thaw()
271 */
258EAPI void ecore_timer_freeze(Ecore_Timer *timer); 272EAPI void ecore_timer_freeze(Ecore_Timer *timer);
259 273
274/**
275 * @brief Return whether the timer is freezing.
276 *
277 * @if MOBILE @since_tizen 3.0
278 * @elseif WEARABLE @since_tizen 3.0
279 * @endif
280 *
281 * @return True if the timer object is freezed, false otherwise.
282 *
283 * @see ecore_timer_freeze(), ecore_timer_thaw()
284 */
260EAPI Eina_Bool ecore_timer_freeze_get(Ecore_Timer *timer); 285EAPI Eina_Bool ecore_timer_freeze_get(Ecore_Timer *timer);
261 286
287/**
288 * @brief Resumes a frozen (paused) timer.
289 *
290 * @if MOBILE @since_tizen 2.3
291 * @elseif WEARABLE @since_tizen 2.3.1
292 * @endif
293 *
294 * @remarks The timer will be resumed from its previous relative position in time. That
295 * means, if it had X seconds remaining until expire when it was paused, it will
296 * be started now with those same X seconds remaining to expire again. But
297 * notice that the interval time won't be touched by this call or by
298 * ecore_timer_freeze().
299 *
300 * @param[in] timer The timer to be resumed.
301 *
302 * @see ecore_timer_freeze()
303 */
262EAPI void ecore_timer_thaw(Ecore_Timer *timer); 304EAPI void ecore_timer_thaw(Ecore_Timer *timer);
263 305
264#include "efl_loop_timer.eo.legacy.h" 306#include "efl_loop_timer.eo.legacy.h"