diff --git a/legacy/ecore/AUTHORS b/legacy/ecore/AUTHORS index 010d7a43e2..c38312214b 100644 --- a/legacy/ecore/AUTHORS +++ b/legacy/ecore/AUTHORS @@ -56,3 +56,5 @@ Patryk Kaczmarek Daniel Willmann Michal Pakula vel Rutka Vikram Narayanan +Daniel Zaoui +Yakov Goldberg diff --git a/legacy/ecore/src/lib/ecore/Ecore.h b/legacy/ecore/src/lib/ecore/Ecore.h index 3610af4c68..3363929ce4 100644 --- a/legacy/ecore/src/lib/ecore/Ecore.h +++ b/legacy/ecore/src/lib/ecore/Ecore.h @@ -1276,9 +1276,43 @@ enum #define ECORE_POLLER_ID(sub_id) (ECORE_POLLER_BASE_ID + sub_id) +/** + * @def ecore_poller_constructor + * @since 1.8 + * + * Contructor with parameters for Ecore Poller. + * + * @param[in] type + * @param[in] interval + * @param[in] func + * @param[in] data + * + */ #define ecore_poller_constructor(type, interval, func, data) ECORE_POLLER_ID(ECORE_POLLER_SUB_ID_CONSTRUCTOR), EO_TYPECHECK(Ecore_Poller_Type, type), EO_TYPECHECK(int, interval), EO_TYPECHECK(Ecore_Task_Cb, func), EO_TYPECHECK(const void *, data) +/** + * @def ecore_poller_interval_set + * @since 1.8 + * + * Changes the polling interval rate of poller. + * + * @param[in] interval + * @param[out] ret + * + * @see ecore_poller_poller_interval_set + */ #define ecore_poller_interval_set(interval, ret) ECORE_POLLER_ID(ECORE_POLLER_SUB_ID_INTERVAL_SET), EO_TYPECHECK(int, interval), EO_TYPECHECK(Eina_Bool *, ret) + +/** + * @def ecore_poller_interval_get + * @since 1.8 + * + * Gets the polling interval rate of poller. + * + * @param[out] ret + * + * @see ecore_poller_poller_interval_get + */ #define ecore_poller_interval_get(ret) ECORE_POLLER_ID(ECORE_POLLER_SUB_ID_INTERVAL_GET), EO_TYPECHECK(int *, ret) @@ -1413,8 +1447,29 @@ enum #define ECORE_ANIMATOR_ID(sub_id) (ECORE_ANIMATOR_BASE_ID + sub_id) +/** + * @def ecore_animator_constructor + * @since 1.8 + * + * Contructor. + * + * @param[in] func + * @param[in] data + * + */ #define ecore_animator_constructor(func, data) ECORE_ANIMATOR_ID(ECORE_ANIMATOR_SUB_ID_CONSTRUCTOR), EO_TYPECHECK(Ecore_Task_Cb, func), EO_TYPECHECK(const void *, data) +/** + * @def ecore_animator_timeline_constructor + * @since 1.8 + * + * Contructor. + * + * @param[in] runtime + * @param[in] func + * @param[in] data + * + */ #define ecore_animator_timeline_constructor(runtime, func, data) ECORE_ANIMATOR_ID(ECORE_ANIMATOR_SUB_ID_TIMELINE_CONSTRUCTOR), EO_TYPECHECK(double, runtime), EO_TYPECHECK(Ecore_Timeline_Cb, func), EO_TYPECHECK(const void *, data) /** @@ -1781,13 +1836,88 @@ enum #define ECORE_TIMER_ID(sub_id) (ECORE_TIMER_BASE_ID + sub_id) +/** + * @def ecore_timer_constructor + * @since 1.8 + * + * Contructor. + * + * @param[in] in + * @param[in] func + * @param[in] data + * + */ #define ecore_timer_constructor(in, func, data) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_CONSTRUCTOR), EO_TYPECHECK(double, in), EO_TYPECHECK(Ecore_Task_Cb, func), EO_TYPECHECK(const void *, data) + +/** + * @def ecore_timer_loop_constructor + * @since 1.8 + * + * Contructor. + * + * @param[in] in + * @param[in] func + * @param[in] data + * + */ #define ecore_timer_loop_constructor(in, func, data) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_LOOP_CONSTRUCTOR), EO_TYPECHECK(double, in), EO_TYPECHECK(Ecore_Task_Cb, func), EO_TYPECHECK(const void *, data) +/** + * @def ecore_obj_timer_interval_set + * @since 1.8 + * + * Change the interval the timer ticks of. + * + * @param[in] in + * + * @see ecore_timer_interval_set + */ #define ecore_obj_timer_interval_set(in) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_INTERVAL_SET), EO_TYPECHECK(double, in) + +/** + * @def ecore_obj_timer_interval_get + * @since 1.8 + * + * Get the interval the timer ticks on. + * + * @param[out] ret + * + * @see ecore_timer_interval_get + */ #define ecore_obj_timer_interval_get(ret) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_INTERVAL_GET), EO_TYPECHECK(double *, ret) + +/** + * @def ecore_obj_timer_delay + * @since 1.8 + * + * Add some delay for the next occurrence of a timer. + * + * @param[in] add + * + * @see ecore_timer_delay + */ #define ecore_obj_timer_delay(add) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_DELAY), EO_TYPECHECK(double, add) + +/** + * @def ecore_obj_timer_reset + * @since 1.8 + * + * Reset a timer to its full interval. + * + * @see ecore_timer_reset + */ #define ecore_obj_timer_reset() ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_RESET) + +/** + * @def ecore_obj_timer_pending_get + * @since 1.8 + * + * Get the pending time regarding a timer. + * + * @param[out] ret + * + * @see ecore_timer_pending_get + */ #define ecore_obj_timer_pending_get(ret) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_PENDING_GET), EO_TYPECHECK(double *, ret) EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *data); @@ -1869,6 +1999,17 @@ enum }; #define ECORE_IDLER_ID(sub_id) (ECORE_IDLER_BASE_ID + sub_id) + +/** + * @def ecore_idler_constructor + * @since 1.8 + * + * Contructor. + * + * @param[in] func + * @param[in] data + * + */ #define ecore_idler_constructor(func, data) ECORE_IDLER_ID(ECORE_IDLER_SUB_ID_CONSTRUCTOR), EO_TYPECHECK(Ecore_Task_Cb, func), EO_TYPECHECK(const void *, data) /** @@ -1889,7 +2030,29 @@ enum }; #define ECORE_IDLE_ENTERER_ID(sub_id) (ECORE_IDLE_ENTERER_BASE_ID + sub_id) + +/** + * @def ecore_idle_enterer_after_constructor + * @since 1.8 + * + * Contructor. Will insert the handler at the end of the list. + * + * @param[in] func + * @param[in] data + * + */ #define ecore_idle_enterer_after_constructor(func, data) ECORE_IDLE_ENTERER_ID(ECORE_IDLE_ENTERER_SUB_ID_AFTER_CONSTRUCTOR), EO_TYPECHECK(Ecore_Task_Cb, func), EO_TYPECHECK(const void *, data) + +/** + * @def ecore_idle_enterer_before_constructor + * @since 1.8 + * + * Contructor. Will insert the handler at the beginning of the list. + * + * @param[in] func + * @param[in] data + * + */ #define ecore_idle_enterer_before_constructor(func, data) ECORE_IDLE_ENTERER_ID(ECORE_IDLE_ENTERER_SUB_ID_BEFORE_CONSTRUCTOR), EO_TYPECHECK(Ecore_Task_Cb, func), EO_TYPECHECK(const void *, data) /** @@ -1912,6 +2075,17 @@ enum }; #define ECORE_IDLE_EXITER_ID(sub_id) (ECORE_IDLE_EXITER_BASE_ID + sub_id) + +/** + * @def ecore_idle_exiter_constructor + * @since 1.8 + * + * Contructor. + * + * @param[in] func + * @param[in] data + * + */ #define ecore_idle_exiter_constructor(func, data) ECORE_IDLE_EXITER_ID(ECORE_IDLE_EXITER_SUB_ID_CONSTRUCTOR), EO_TYPECHECK(Ecore_Task_Cb, func), EO_TYPECHECK(const void *, data) /** @@ -2725,6 +2899,17 @@ enum }; #define ECORE_JOB_ID(sub_id) (ECORE_JOB_BASE_ID + sub_id) + +/** + * @def ecore_job_constructor + * @since 1.8 + * + * Contructor. + * + * @param[in] func + * @param[in] data + * + */ #define ecore_job_constructor(func, data) ECORE_JOB_ID(ECORE_JOB_SUB_ID_CONSTRUCTOR), EO_TYPECHECK(Ecore_Cb, func), EO_TYPECHECK(const void *, data) EAPI Ecore_Job *ecore_job_add(Ecore_Cb func, const void *data);