Evas event callback function signature.

Since :

2.3

Evas event callback Post function signature.

Since :

2.3

Add (register) a callback function to a given canvas event.

Since :

2.3

Parameters:

[in]	e	Canvas to attach a callback to
[in]	type	The type of event that will trigger the callback
[in]	func	The (callback) function to be called when the event is triggered
[in]	data	The data pointer to be passed to func

Remarks:

This function adds a function callback to the canvas e when the event of type type occurs on it. The function pointer is func.

In the event of a memory allocation error during the addition of the callback to the canvas, Evas Alloc Error function should be used to determine the nature of the error, if any, and the program should sensibly try and recover.

A callback function must have the Evas_Event_Cb prototype definition. The first parameter (data) in this definition will have the same value passed to evas_event_callback_add() as the data parameter, at runtime. The second parameter e is the canvas pointer on which the event occurred. The third parameter event_info is a pointer to a data structure that may or may not be passed to the callback, depending on the event type that triggered the callback. This is so because some events don't carry extra context with them, but others do.

The event type type to trigger the function may be one of EVAS_CALLBACK_RENDER_FLUSH_PRE, EVAS_CALLBACK_RENDER_FLUSH_POST, EVAS_CALLBACK_CANVAS_FOCUS_IN, EVAS_CALLBACK_CANVAS_FOCUS_OUT, EVAS_CALLBACK_CANVAS_OBJECT_FOCUS_IN and EVAS_CALLBACK_CANVAS_OBJECT_FOCUS_OUT. This determines the kind of event that will trigger the callback to be called. Only the last two of the event types listed here provide useful event information data -- a pointer to the recently focused Evas object. For the others the event_info pointer is going to be NULL.

Example:

Looking to the callbacks registered above,

we see that the canvas flushes its rendering pipeline (EVAS_CALLBACK_RENDER_FLUSH_PRE) whenever the _resize_cb routine takes place: it has to redraw that image at a different size. Also, the callback on an object being focused comes just after we focus it explicitly, on code.

See the full example.

Be careful not to add the same callback multiple times, if that's not what you want, because Evas won't check if a callback existed before exactly as the one being registered (and thus, call it more than once on the event, in this case). This would make sense if you passed different functions and/or callback data, only.

Delete a callback function from the canvas.

Since :

2.3

Parameters:

[in]	e	Canvas to remove a callback from
[in]	type	The type of event that was triggering the callback
[in]	func	The function that was to be called when the event was triggered

Returns:

The data pointer that was to be passed to the callback

Remarks:

This function removes the most recently added callback from the canvas e which was triggered by the event type type and was calling the function func when triggered. If the removal is successful it will also return the data pointer that was passed to evas_event_callback_add() when the callback was added to the canvas. If not successful NULL will be returned.

Example:

 extern Evas *e;
 void *my_data;
 void focus_in_callback(void *data, Evas *e, void *event_info);

 my_data = evas_event_callback_del(ebject, EVAS_CALLBACK_CANVAS_FOCUS_IN, focus_in_callback);

Delete (unregister) a callback function registered to a given canvas event.

Since :

2.3

Parameters:

[in]	e	Canvas to remove an event callback from
[in]	type	The type of event that was triggering the callback
[in]	func	The function that was to be called when the event was triggered
[in]	data	The data pointer that was to be passed to the callback

Returns:

The data pointer that was to be passed to the callback

Remarks:

This function removes the first added callback from the canvas e matching the event type type, the registered function pointer func and the callback data pointer data. If the removal is successful it will also return the data pointer that was passed to evas_event_callback_add() (that will be the same as the parameter) when the callback(s) was(were) added to the canvas. If not successful NULL will be returned. A common use would be to remove an exact match of a callback.

Example:

See the full example.

For deletion of canvas events callbacks filtering by just type and function pointer, user evas_event_callback_del().

Add (register) a callback function to a given canvas event with a non-default priority set. Except for the priority field, it's exactly the same as evas_event_callback_add.

Since :

2.3

Parameters:

[in]	e	Canvas to attach a callback to
[in]	type	The type of event that will trigger the callback
[in]	priority	The priority of the callback, lower values called first.
[in]	func	The (callback) function to be called when the event is triggered
[in]	data	The data pointer to be passed to func

See also:

evas_event_callback_add

Since (EFL) :

1.1

Push a callback on the post-event callback stack.

Since :

2.3

Parameters:

[in]	e	Canvas to push the callback on
[in]	func	The function that to be called when the stack is unwound
[in]	data	The data pointer to be passed to the callback

Remarks:

Evas has a stack of callbacks that get called after all the callbacks for an event have triggered (all the objects it triggers on and all the callbacks in each object triggered). When all these have been called, the stack is unwond from most recently to least recently pushed item and removed from the stack calling the callback set for it.

This is intended for doing reverse logic-like processing, example - when a child object that happens to get the event later is meant to be able to "steal" functions from a parent and thus on unwind of this stack have its function called first, thus being able to set flags, or return 0 from the post-callback that stops all other post-callbacks in the current stack from being called (thus basically allowing a child to take control, if the event callback prepares information ready for taking action, but the post callback actually does the action).

Remove a callback from the post-event callback stack.

Since :

2.3

Parameters:

[in]	e	Canvas to push the callback on
[in]	func	The function that to be called when the stack is unwound

Remarks:

This removes a callback from the stack added with evas_post_event_callback_push(). The first instance of the function in the callback stack is removed from being executed when the stack is unwound. Further instances may still be run on unwind.

Remove a callback from the post-event callback stack.

Since :

2.3

Parameters:

[in]	e	Canvas to push the callback on
[in]	func	The function that to be called when the stack is unwound
[in]	data	The data pointer to be passed to the callback

Remarks:

This removes a callback from the stack added with evas_post_event_callback_push(). The first instance of the function and data in the callback stack is removed from being executed when the stack is unwound. Further instances may still be run on unwind.