summaryrefslogtreecommitdiff
path: root/legacy/ecore/src/lib/ecore/Ecore.h
diff options
context:
space:
mode:
authorDaniel Zaoui <daniel.zaoui@samsung.com>2012-10-28 08:46:23 +0000
committerDaniel Zaoui <daniel.zaoui@yahoo.com>2012-10-28 08:46:23 +0000
commit424491e6f7e008b0004bf2f8c3e77ae1c607d441 (patch)
tree1186908425e1e328c266d16a5397e264f6afb275 /legacy/ecore/src/lib/ecore/Ecore.h
parent98b52208ea5ff9e3e029b01554a2505d85051629 (diff)
Added descriptions for new Eo defines
Added authors Signed-off-by: Daniel Zaoui <daniel.zaoui@samsung.com> SVN revision: 78576
Diffstat (limited to '')
-rw-r--r--legacy/ecore/src/lib/ecore/Ecore.h185
1 files changed, 185 insertions, 0 deletions
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
1276 1276
1277#define ECORE_POLLER_ID(sub_id) (ECORE_POLLER_BASE_ID + sub_id) 1277#define ECORE_POLLER_ID(sub_id) (ECORE_POLLER_BASE_ID + sub_id)
1278 1278
1279/**
1280 * @def ecore_poller_constructor
1281 * @since 1.8
1282 *
1283 * Contructor with parameters for Ecore Poller.
1284 *
1285 * @param[in] type
1286 * @param[in] interval
1287 * @param[in] func
1288 * @param[in] data
1289 *
1290 */
1279#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) 1291#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)
1280 1292
1293/**
1294 * @def ecore_poller_interval_set
1295 * @since 1.8
1296 *
1297 * Changes the polling interval rate of poller.
1298 *
1299 * @param[in] interval
1300 * @param[out] ret
1301 *
1302 * @see ecore_poller_poller_interval_set
1303 */
1281#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) 1304#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)
1305
1306/**
1307 * @def ecore_poller_interval_get
1308 * @since 1.8
1309 *
1310 * Gets the polling interval rate of poller.
1311 *
1312 * @param[out] ret
1313 *
1314 * @see ecore_poller_poller_interval_get
1315 */
1282#define ecore_poller_interval_get(ret) ECORE_POLLER_ID(ECORE_POLLER_SUB_ID_INTERVAL_GET), EO_TYPECHECK(int *, ret) 1316#define ecore_poller_interval_get(ret) ECORE_POLLER_ID(ECORE_POLLER_SUB_ID_INTERVAL_GET), EO_TYPECHECK(int *, ret)
1283 1317
1284 1318
@@ -1413,8 +1447,29 @@ enum
1413 1447
1414#define ECORE_ANIMATOR_ID(sub_id) (ECORE_ANIMATOR_BASE_ID + sub_id) 1448#define ECORE_ANIMATOR_ID(sub_id) (ECORE_ANIMATOR_BASE_ID + sub_id)
1415 1449
1450/**
1451 * @def ecore_animator_constructor
1452 * @since 1.8
1453 *
1454 * Contructor.
1455 *
1456 * @param[in] func
1457 * @param[in] data
1458 *
1459 */
1416#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) 1460#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)
1417 1461
1462/**
1463 * @def ecore_animator_timeline_constructor
1464 * @since 1.8
1465 *
1466 * Contructor.
1467 *
1468 * @param[in] runtime
1469 * @param[in] func
1470 * @param[in] data
1471 *
1472 */
1418#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) 1473#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)
1419 1474
1420/** 1475/**
@@ -1781,13 +1836,88 @@ enum
1781 1836
1782#define ECORE_TIMER_ID(sub_id) (ECORE_TIMER_BASE_ID + sub_id) 1837#define ECORE_TIMER_ID(sub_id) (ECORE_TIMER_BASE_ID + sub_id)
1783 1838
1839/**
1840 * @def ecore_timer_constructor
1841 * @since 1.8
1842 *
1843 * Contructor.
1844 *
1845 * @param[in] in
1846 * @param[in] func
1847 * @param[in] data
1848 *
1849 */
1784#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) 1850#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)
1851
1852/**
1853 * @def ecore_timer_loop_constructor
1854 * @since 1.8
1855 *
1856 * Contructor.
1857 *
1858 * @param[in] in
1859 * @param[in] func
1860 * @param[in] data
1861 *
1862 */
1785#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) 1863#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)
1786 1864
1865/**
1866 * @def ecore_obj_timer_interval_set
1867 * @since 1.8
1868 *
1869 * Change the interval the timer ticks of.
1870 *
1871 * @param[in] in
1872 *
1873 * @see ecore_timer_interval_set
1874 */
1787#define ecore_obj_timer_interval_set(in) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_INTERVAL_SET), EO_TYPECHECK(double, in) 1875#define ecore_obj_timer_interval_set(in) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_INTERVAL_SET), EO_TYPECHECK(double, in)
1876
1877/**
1878 * @def ecore_obj_timer_interval_get
1879 * @since 1.8
1880 *
1881 * Get the interval the timer ticks on.
1882 *
1883 * @param[out] ret
1884 *
1885 * @see ecore_timer_interval_get
1886 */
1788#define ecore_obj_timer_interval_get(ret) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_INTERVAL_GET), EO_TYPECHECK(double *, ret) 1887#define ecore_obj_timer_interval_get(ret) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_INTERVAL_GET), EO_TYPECHECK(double *, ret)
1888
1889/**
1890 * @def ecore_obj_timer_delay
1891 * @since 1.8
1892 *
1893 * Add some delay for the next occurrence of a timer.
1894 *
1895 * @param[in] add
1896 *
1897 * @see ecore_timer_delay
1898 */
1789#define ecore_obj_timer_delay(add) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_DELAY), EO_TYPECHECK(double, add) 1899#define ecore_obj_timer_delay(add) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_DELAY), EO_TYPECHECK(double, add)
1900
1901/**
1902 * @def ecore_obj_timer_reset
1903 * @since 1.8
1904 *
1905 * Reset a timer to its full interval.
1906 *
1907 * @see ecore_timer_reset
1908 */
1790#define ecore_obj_timer_reset() ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_RESET) 1909#define ecore_obj_timer_reset() ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_RESET)
1910
1911/**
1912 * @def ecore_obj_timer_pending_get
1913 * @since 1.8
1914 *
1915 * Get the pending time regarding a timer.
1916 *
1917 * @param[out] ret
1918 *
1919 * @see ecore_timer_pending_get
1920 */
1791#define ecore_obj_timer_pending_get(ret) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_PENDING_GET), EO_TYPECHECK(double *, ret) 1921#define ecore_obj_timer_pending_get(ret) ECORE_TIMER_ID(ECORE_TIMER_SUB_ID_PENDING_GET), EO_TYPECHECK(double *, ret)
1792 1922
1793EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *data); 1923EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *data);
@@ -1869,6 +1999,17 @@ enum
1869}; 1999};
1870 2000
1871#define ECORE_IDLER_ID(sub_id) (ECORE_IDLER_BASE_ID + sub_id) 2001#define ECORE_IDLER_ID(sub_id) (ECORE_IDLER_BASE_ID + sub_id)
2002
2003/**
2004 * @def ecore_idler_constructor
2005 * @since 1.8
2006 *
2007 * Contructor.
2008 *
2009 * @param[in] func
2010 * @param[in] data
2011 *
2012 */
1872#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) 2013#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)
1873 2014
1874/** 2015/**
@@ -1889,7 +2030,29 @@ enum
1889}; 2030};
1890 2031
1891#define ECORE_IDLE_ENTERER_ID(sub_id) (ECORE_IDLE_ENTERER_BASE_ID + sub_id) 2032#define ECORE_IDLE_ENTERER_ID(sub_id) (ECORE_IDLE_ENTERER_BASE_ID + sub_id)
2033
2034/**
2035 * @def ecore_idle_enterer_after_constructor
2036 * @since 1.8
2037 *
2038 * Contructor. Will insert the handler at the end of the list.
2039 *
2040 * @param[in] func
2041 * @param[in] data
2042 *
2043 */
1892#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) 2044#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)
2045
2046/**
2047 * @def ecore_idle_enterer_before_constructor
2048 * @since 1.8
2049 *
2050 * Contructor. Will insert the handler at the beginning of the list.
2051 *
2052 * @param[in] func
2053 * @param[in] data
2054 *
2055 */
1893#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) 2056#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)
1894 2057
1895/** 2058/**
@@ -1912,6 +2075,17 @@ enum
1912}; 2075};
1913 2076
1914#define ECORE_IDLE_EXITER_ID(sub_id) (ECORE_IDLE_EXITER_BASE_ID + sub_id) 2077#define ECORE_IDLE_EXITER_ID(sub_id) (ECORE_IDLE_EXITER_BASE_ID + sub_id)
2078
2079/**
2080 * @def ecore_idle_exiter_constructor
2081 * @since 1.8
2082 *
2083 * Contructor.
2084 *
2085 * @param[in] func
2086 * @param[in] data
2087 *
2088 */
1915#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) 2089#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)
1916 2090
1917/** 2091/**
@@ -2725,6 +2899,17 @@ enum
2725}; 2899};
2726 2900
2727#define ECORE_JOB_ID(sub_id) (ECORE_JOB_BASE_ID + sub_id) 2901#define ECORE_JOB_ID(sub_id) (ECORE_JOB_BASE_ID + sub_id)
2902
2903/**
2904 * @def ecore_job_constructor
2905 * @since 1.8
2906 *
2907 * Contructor.
2908 *
2909 * @param[in] func
2910 * @param[in] data
2911 *
2912 */
2728#define ecore_job_constructor(func, data) ECORE_JOB_ID(ECORE_JOB_SUB_ID_CONSTRUCTOR), EO_TYPECHECK(Ecore_Cb, func), EO_TYPECHECK(const void *, data) 2913#define ecore_job_constructor(func, data) ECORE_JOB_ID(ECORE_JOB_SUB_ID_CONSTRUCTOR), EO_TYPECHECK(Ecore_Cb, func), EO_TYPECHECK(const void *, data)
2729 2914
2730EAPI Ecore_Job *ecore_job_add(Ecore_Cb func, const void *data); 2915EAPI Ecore_Job *ecore_job_add(Ecore_Cb func, const void *data);