add ECORE_CALLBACK_RENEW and ECORE_CALLBACK_CANCEL

SVN revision: 33612

legacy/ecore/src/lib/ecore/Ecore.h

@@ -61,6 +61,9 @@
 extern "C" {
 #endif
 
+#define ECORE_CALLBACK_CANCEL 0; /**< Return value to remove a callback */
+#define ECORE_CALLBACK_RENEW 1; /**< Return value to keep a callback */ 
+
 #define ECORE_EVENT_NONE            0
 #define ECORE_EVENT_SIGNAL_USER     1 /**< User signal event */
 #define ECORE_EVENT_SIGNAL_HUP      2 /**< Hup signal event */

legacy/ecore/src/lib/ecore/ecore_anim.c

@@ -21,9 +21,9 @@ static double          animators_frametime = 1.0 / 30.0;
  * be passed the @p data pointer as its parameter.
  * 
  * When the animator @p func is called, it must return a value of either 1 or 0. 
- * If it returns 1, it will be called again at the next tick, or if it returns
- * 0 it will be deleted automatically making any references/handles for it
- * invalid.
+ * If it returns 1 (or ECORE_CALLBACK_RENEW), it will be called again at the 
+ * next tick, or if it returns 0 (or ECORE_CALLBACK_CANCEL) it will be deleted 
+ * automatically making any references/handles for it invalid.
  */
 EAPI Ecore_Animator *
 ecore_animator_add(int (*func) (void *data), const void *data)

legacy/ecore/src/lib/ecore/ecore_events.c

@@ -35,10 +35,11 @@ static void                *ecore_raw_event_event =  NULL;
  * provided in this call as the @p data parameter.
  * 
  * When the callback @p func is called, it must return 1 or 0. If it returns 
- * 1, It will keep being called as per normal, for each handler set up for that
- * event type. If it returns 0, it will cease processing handlers for that
- * particular event, so all handler set to handle that event type that have not
- * already been called, will not be.
+ * 1 (or ECORE_CALLBACK_RENEW), It will keep being called as per normal, for 
+ * each handler set up for that event type. If it returns 0 (or 
+ * ECORE_CALLBACK_CANCEL), it will cease processing handlers for that particular
+ * event, so all handler set to handle that event type that have not already 
+ * been called, will not be.
  */
 EAPI Ecore_Event_Handler *
 ecore_event_handler_add(int type, int (*func) (void *data, int type, void *event), const void *data)

legacy/ecore/src/lib/ecore/ecore_idler.c

@@ -13,8 +13,9 @@ static int          idlers_delete_me = 0;
  *
  * Add an idler handle to the event loop, returning a handle on success and
  * NULL otherwise.  The function @p func will be called repeatedly while
- * no other events are ready to be processed, as long as it returns 1. A return
- * of 0 deletes the idler.
+ * no other events are ready to be processed, as long as it returns 1 
+ * (or ECORE_CALLBACK_RENEW). A return of 0 (or ECORE_CALLBACK_CANCEL) deletes 
+ * the idler.
  *
  * Idlers are useful for progressively prossessing data without blocking.
  */

legacy/ecore/src/lib/ecore/ecore_poll.c

@@ -255,8 +255,9 @@ ecore_poller_poll_interval_get(Ecore_Poller_Type type)
  * failure. The function @p func will be called at tick intervals described
  * above. The function will be passed the @p data pointer as its parameter.
  * 
- * When the poller @p func is called, it must return a value of either 1 or 0. 
- * If it returns 1, it will be called again at the next tick, or if it returns
+ * When the poller @p func is called, it must return a value of either 
+ * 1 (or ECORE_CALLBACK_RENEW) or 0 (or ECORE_CALLBACK_CANCEL). If it 
+ * returns 1, it will be called again at the next tick, or if it returns
  * 0 it will be deleted automatically making any references/handles for it
  * invalid.
  */

legacy/ecore/src/lib/ecore/ecore_timer.c

@@ -28,7 +28,8 @@ static double       last_check = 0.0;
  * failure. The function @p func will be called every @in@ seconds. The
  * function will be passed the @p data pointer as its parameter.
  * 
- * When the timer @p func is called, it must return a value of either 1 or 0. 
+ * When the timer @p func is called, it must return a value of either 1 
+ * (or ECORE_CALLBACK_RENEW) or 0 (or ECORE_CALLBACK_CANCEL). 
  * If it returns 1, it will be called again at the next tick, or if it returns
  * 0 it will be deleted automatically making any references/handles for it
  * invalid.