summaryrefslogtreecommitdiff
path: root/legacy/ecore/ecore.c.in
diff options
context:
space:
mode:
authorCarsten Haitzler <raster@rasterman.com>2004-05-08 04:44:04 +0000
committerCarsten Haitzler <raster@rasterman.com>2004-05-08 04:44:04 +0000
commit093bd1d9c24d50cf440231e9ada30ead0e7cccc7 (patch)
treec9b6ae9fa953675d982ccb080f8fa7b288db1626 /legacy/ecore/ecore.c.in
parent20df2031055a920a433c4f0cd5287412c3443e35 (diff)
nathan's docs :)
SVN revision: 10113
Diffstat (limited to '')
-rw-r--r--legacy/ecore/ecore.c.in143
1 files changed, 87 insertions, 56 deletions
diff --git a/legacy/ecore/ecore.c.in b/legacy/ecore/ecore.c.in
index c61bc8522c..2105d4fc0b 100644
--- a/legacy/ecore/ecore.c.in
+++ b/legacy/ecore/ecore.c.in
@@ -7,8 +7,10 @@ These routines are used for Ecore Library interaction
7/** 7/**
8 8
9@mainpage Ecore 9@mainpage Ecore
10
10@image latex ecore_big.eps width=5cm 11@image latex ecore_big.eps width=5cm
11@image html ecore.png 12@image html ecore.png
13
12@version 1.0.0 14@version 1.0.0
13@author Carsten Haitzler <raster\@rasterman.com> 15@author Carsten Haitzler <raster\@rasterman.com>
14@author Tom Gilbert <tom\@linuxbrit.co.uk> 16@author Tom Gilbert <tom\@linuxbrit.co.uk>
@@ -20,16 +22,6 @@ These routines are used for Ecore Library interaction
20 22
21 23
22 24
23
24
25
26
27
28
29
30
31
32
33@section intro What is Ecore? 25@section intro What is Ecore?
34 26
35Ecore is a clean and tiny event loop library with many modules to do lots of 27Ecore is a clean and tiny event loop library with many modules to do lots of
@@ -64,19 +56,6 @@ Here is an exmaple of a simple program and its basic event loop flow:
64 56
65 57
66 58
67
68
69
70
71
72
73
74
75
76
77
78
79
80@section work How does Ecore work? 59@section work How does Ecore work?
81 60
82Ecore is very easy to learn and use. All the function calls are designed to 61Ecore is very easy to learn and use. All the function calls are designed to
@@ -141,15 +120,16 @@ int main(int argc, const char **argv)
141} 120}
142@endcode 121@endcode
143 122
144In the previous example, we initialize our application and get the time at which 123In the previous example, we initialize our application and get the time at
145our program has started so we can calculate an offset. We set up a timer to 124which our program has started so we can calculate an offset. We set
146tick off in 0.5 seconds, and since it returns 1, will keep ticking off every 125up a timer to tick off in 0.5 seconds, and since it returns 1, will
1470.5 seconds until it returns 0, or is deleted by hand. An event handler is set 126keep ticking off every 0.5 seconds until it returns 0, or is deleted
148up to call a function - exit_func(), whenever an event of type 127by hand. An event handler is set up to call a function - exit_func(),
149ECORE_EVENT_SIGNAL_EXIT is received (CTRL-C on the command line will cause 128whenever an event of type ECORE_EVENT_SIGNAL_EXIT is received (CTRL-C
150such an event to happen). If this event occurs it tells you what kind of 129on the command line will cause such an event to happen). If this event
151exit signal was received, and asks the main loop to quit when it is finished 130occurs it tells you what kind of exit signal was received, and asks
152by calling ecore_main_loop_quit(). 131the main loop to quit when it is finished by calling
132ecore_main_loop_quit().
153 133
154The handles returned by ecore_timer_add() and ecore_event_handler_add() are 134The handles returned by ecore_timer_add() and ecore_event_handler_add() are
155only stored here as an example. If you don't need to address the timer or 135only stored here as an example. If you don't need to address the timer or
@@ -163,11 +143,6 @@ follows the same principles as shown in this example.
163 143
164 144
165 145
166
167
168
169
170
171@section compiling How to compile using Ecore? 146@section compiling How to compile using Ecore?
172 147
173This section has to be documented. Below is just a quick line to handle all 148This section has to be documented. Below is just a quick line to handle all
@@ -183,17 +158,6 @@ gcc *.c \
183 158
184 159
185 160
186
187
188
189
190
191
192
193
194
195
196
197@section install How is it installed? 161@section install How is it installed?
198 162
199Suggested configure options for evas for a Linux desktop X display: 163Suggested configure options for evas for a Linux desktop X display:
@@ -213,30 +177,97 @@ make CFLAGS="-O9 -mpentiumpro -march=pentiumpro -mcpu=pentiumpro"
213 177
214 178
215 179
180@section tutorial Ecore Tutorial
216 181
182You will find a more comprehensive @ref tut here, going through many examples
183with tips and hints as to how best do some things.
217 184
218 185
219 186
220 187
221 188
189@todo (1.0) Document API
222 190
191*/
223 192
193/** @page tut Ecore Tutorial
224 194
225@section tutorial Ecore Tutorial 195Here is a tutotial for using Ecore...
226 196
227You will find a more comprehensive @ref tut here, going through many examples 197*/
228with tips and hints as to how best do some things.
229 198
199/**
200@page The Enlightened Property Library
230 201
202The Enlightened Property Library (Ecore_Config) is an adbstraction
203from the complexities of writing your own configuration. It provides
204many features using the Enlightenment 17 development libraries.
231 205
232 206
233 207
234@todo (1.0) Document API 208 */
235 209
236*/ 210// GROUP DEFINITIONS
237 211
238/** @page tut Ecore Tutorial 212/**
213 * @defgroup Ecore_Main_Loop_Group Main Loop Functions
214 *
215 * Functions used to control the main loop.
216 */
239 217
240Here is a tutotial for using Ecore... 218/**
219 * @defgroup Ecore_Timer_Group Ecore Timer
220 *
221 * The timer allows callbacks to be called at specific intervals.
222 */
241 223
242*/ 224/**
225 * @defgroup Idle_Group Idle Handlers
226 *
227 * Callbacks that are called when the program enters or exits an idle state.
228 *
229 * The ecore main loop enters an idle state when it is waiting for
230 * timers to time out, data to come in on a file descriptor or any
231 * other event to occur. You can set callbacks to be called when the
232 * main loop enters an idle state, during an idle state or just after
233 * the program wakes up.
234 *
235 * Enterer callbacks are good for updating your program's state, if it
236 * has a state engine. Once all of the enterer handlers are called,
237 * the program will enter a "sleeping" state.
238 *
239 * Idler callbacks are called when the main loop has called all
240 * enterer handlers. They are useful for interfaces that require
241 * polling and timers would be too slow to use.
242 *
243 * If no idler callbacks are specified, then the process literally
244 * goes to sleep. Otherwise, the idler callbacks are called
245 * continuously while the loop is "idle", using as much CPU as is
246 * available to the process.
247 *
248 * Exiter callbacks are called when the main loop wakes up from an idle
249 * state.
250 */
251
252// EXAMPLES
253
254/**
255 * @example args_example.c
256 * Shows how to set and retrieve the program arguments.
257 */
258
259/**
260 * @example event_handler_example.c
261 * Shows how to use event handlers.
262 */
263
264/**
265 * @example timer_example.c
266 * Demonstrates use of the ecore_timer.
267 */
268
269/**
270 * @example config_basic_example.c
271 * Provides an example of how to use the basic configuration functions.
272 * See the file Ecore_Config.h for the full list of available functions.
273 */