summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-04-15 15:45:15 +0200
committerStefan Schmidt <stefan@osg.samsung.com>2016-04-17 17:42:41 +0200
commitf012499f479a8f01d89d4fa712304f93407dbf99 (patch)
tree456799897563b96647ab60d5f2623e6dcade672b
parente728ea168fefb67b91f4743d23ee6a40ddae3ebe (diff)
docs: document ecore_mainloop class, functions and events.
-rw-r--r--src/lib/ecore/ecore_mainloop.eo25
1 files changed, 22 insertions, 3 deletions
diff --git a/src/lib/ecore/ecore_mainloop.eo b/src/lib/ecore/ecore_mainloop.eo
index 37eeaeebed..88e96d4eab 100644
--- a/src/lib/ecore/ecore_mainloop.eo
+++ b/src/lib/ecore/ecore_mainloop.eo
@@ -2,38 +2,57 @@ type @extern Ecore_Select_Function: __undefined_type;
2 2
3class Ecore_Mainloop (Eo.Base) 3class Ecore_Mainloop (Eo.Base)
4{ 4{
5 [[The Ecore Main Loop
6
7 Ecore is a clean and tiny event loop library with many modules to do lots of
8 convenient things for a programmer, to save time and effort. It's small and
9 lean, designed to work from embedded systems all the way up to large and
10 powerful multi-cpu workstations. The main loop has a number of primitives to
11 be used with its main loop. It serializes all the primitives and allows for
12 great responsiveness without the need for threads(or any other concurrency).
13 ]]
5 legacy_prefix: null; 14 legacy_prefix: null;
6 data: null; 15 data: null;
7 methods { 16 methods {
8 @property select_func { 17 @property select_func {
18 [[Function to use when monitoring multiple file descriptors.]]
9 set { 19 set {
10 } 20 }
11 get { 21 get {
12 } 22 }
13 values { 23 values {
14 select_func: Ecore_Select_Function; 24 select_func: Ecore_Select_Function;
25 [[This function will be used instead of the system call select.]]
15 } 26 }
16 } 27 }
17 iterate { 28 iterate {
29 [[Runs a single iteration of the main loop to process everything on the
30 queue.]]
18 } 31 }
19 iterate_may_block { 32 iterate_may_block {
33 [[Runs a single iteration of the main loop to process everything on the
34 queue with block/non-blocking status.]]
20 return: int; 35 return: int;
21 params { 36 params {
22 may_block: int; 37 may_block: int; [[A flag if the main loop has a possibility of blocking.]]
23 } 38 }
24 } 39 }
25 begin { 40 begin {
41 [[Runs the application main loop.]]
26 } 42 }
27 quit { 43 quit {
44 [[Quits the main loop once all the events currently on the queue have
45 been processed.]]
28 } 46 }
29 animator_ticked { 47 animator_ticked {
48 [[Returns if an animator has ticked off during this loop iteration.]]
30 /* FIXME: Should it be a prooperty? */ 49 /* FIXME: Should it be a prooperty? */
31 return: bool; 50 return: bool;
32 } 51 }
33 } 52 }
34 events { 53 events {
35 idle,enter; 54 idle,enter; [[Event occurs once the main loop enters the idle state.]]
36 idle,exit; 55 idle,exit; [[Event occurs once the main loop exits the idle state.]]
37 idle; /* FIXME: We need to make sure we can get it work. */ 56 idle; /* FIXME: We need to make sure we can get it work. */
38 /* TODO: All of the legacy ecore events. (Ecore.h header) */ 57 /* TODO: All of the legacy ecore events. (Ecore.h header) */
39 } 58 }