In this example we illustrate how to interact with canvas' (and its objects') events, including the key input ones. We also demonstrate precise point collision on objects and canvas "obscured regions", here.
The example application consists of a window with a white background and an image – the Enlightenment logo. The application begins with this image switching back and forth into two sizes: the exact canvas' size and one quarter of it (when it's placed on the top left quadrant). Thus, we'll have an animation going on, with image states set to change each 2 elapsed seconds.
There's a global variable to aid accessing our desired context variables from anywhere in the code:
struct test_data
{
Ecore_Evas *ee;
};
static struct test_data d = {0};
Eo Ecore_Timer
A handle for timers.
Definition: Ecore_Common.h:3079
unsigned char Eina_Bool
Type to mimic a boolean.
Definition: eina_types.h:527
Eo Evas
An opaque handle to an Evas canvas.
Definition: Evas_Common.h:163
Efl_Canvas_Object Evas_Object
An Evas Object handle.
Definition: Evas_Common.h:185
What interests us there are the canvas
pointer, our image handle – img
– and the background one, bg
.
The first interesting thing on the example is the registration of a callback on each canvas resizing event, where we put our canvas' size and the background rectangle's one in synchrony, so that we don't get bogus content on rendering with canvas resizes:
EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func)
Sets a callback for Ecore_Evas resize events.
Definition: ecore_evas.c:1140
Than, after grabbing our canvas pointer from the Ecore Evas helper infrastructure, we registrate an event callbacks on it:
static void
{
printf("Canvas is about to flush its rendering pipeline!\n");
}
#define EINA_UNUSED
Used to indicate that a function parameter is purposely unused.
Definition: eina_types.h:339
It will be called whenever our canvas has to flush its rendering pipeline. In this example, two ways of observing that message which is printed in the cited callback are:
- to resize the example's window (thus resizing the canvas' viewport)
- let the animation run
When one resizes the canvas, there's at least one operation it has to do which will require new calculation for rendering: the resizing of the background rectangle, in a callback we already shown you.
The creation of our background rectangle is so that we give it a name, via evas_object_name_set() and we give it the canvas focus:
#define EINA_TRUE
boolean value TRUE (numerical value 1)
Definition: eina_types.h:539
EVAS_API void evas_object_show(Evas_Object *eo_obj)
Makes the given Evas object visible.
Definition: evas_object_main.c:1814
EVAS_API void evas_object_name_set(Evas_Object *eo_obj, const char *name)
Sets the name of the given Evas object to the given name.
Definition: evas_name.c:5
EVAS_API void evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a)
Sets the general/main color of the given Evas object to the given one.
Definition: evas_object_main.c:2024
EVAS_API void evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y)
Move the given Evas object to the given location inside its canvas' viewport.
Definition: evas_object_main.c:1171
EVAS_API void evas_object_focus_set(Efl_Canvas_Object *obj, Eina_Bool focus)
Indicates that this object is the keyboard event receiver on its canvas.
Definition: efl_canvas_object_eo.legacy.c:39
EVAS_API void evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h)
Changes the size of the given Evas object.
Definition: evas_object_main.c:1236
EVAS_API Evas_Object * evas_object_rectangle_add(Evas *e)
Adds a rectangle to the given evas.
Definition: evas_object_rectangle.c:78
Still exemplifying events and callbacks, we register a callback on the canvas event of an object being focused:
_object_focus_in_cb, NULL);
{
fprintf(stderr, "ERROR: Callback registering failed! Aborting.\n");
goto panic;
}
@ EVAS_ALLOC_ERROR_NONE
No allocation error.
Definition: Evas_Common.h:270
@ EVAS_CALLBACK_CANVAS_OBJECT_FOCUS_IN
Canvas object got focus.
Definition: Evas_Common.h:450
EVAS_API void evas_event_callback_add(Evas *eo_e, Evas_Callback_Type type, Evas_Event_Cb func, const void *data)
Add (register) a callback function to a given canvas event.
Definition: evas_callbacks.c:573
EVAS_API Evas_Alloc_Error evas_alloc_error(void)
Get the error status of the most recent memory allocation call.
Definition: main.c:17
static void
void *event_info)
{
printf("An object got focused: %s\n",
printf("Let's recheck it: %s\n",
"OK!" : "Oops, something is bad.");
}
EVAS_API Efl_Canvas_Object * evas_focus_get(const Evas_Canvas *obj)
Retrieve the object focused by the default seat.
Definition: evas_canvas_eo.legacy.c:51
EVAS_API const char * evas_object_name_get(const Evas_Object *eo_obj)
Retrieves the name of the given Evas object.
Definition: evas_name.c:26
EVAS_API Eina_Bool evas_object_focus_get(const Efl_Canvas_Object *obj)
Indicates that this object is the keyboard event receiver on its canvas.
Definition: efl_canvas_object_eo.legacy.c:45
In that call, event_info
is going to be the focused object's handle, in this case our background rectangle. We print its name, so you can check it's the same. We check that pointer is the same reported by Evas' API with regard to the newest focused object. Finally, we check whether that object is really flagged as focused, now using an Evas object API function.
The animation we talked about comes from a timer we register just before we start the example's main loop. As we said, the resizing of the image will also force the canvas to repaint itself, thus flushing the rendering pipeline whenever the timer ticks:
Ecore_Timer * ecore_timer_add(double in, Ecore_Task_Cb func, const void *data)
Creates a timer to call the given function in the given period of time.
Definition: ecore_timer.c:189
{
int w, h, cw, ch;
if (w < cw)
else
}
EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h)
Gets the geometry of an Ecore_Evas.
Definition: ecore_evas.c:1362
EVAS_API void evas_object_geometry_get(const Evas_Object *eo_obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
Retrieves the position and (rectangular) size of the given Evas object.
Definition: evas_object_main.c:1335
When you start this example, this animation will be running, by default. To interact with the program, there's a command line interface. A help string can be asked for with the 'h' key:
static const char *commands = \
"commands are:\n"
"\ta - toggle animation timer\n"
"\tc - cycle between focus and key grabs for key input\n"
"\td - delete canvas callbacks\n"
"\tf - freeze input for 3 seconds\n"
"\tp - toggle precise point collision detection on image\n"
"\tControl + o - add an obscured rectangle\n"
"\th - print help\n";
These are the commands the example will accept at any time, except when one triggers the 'f' one. This command will exemplify evas_event_freeze(), which interrupts all input events processing for the canvas (in the example, just for 3 seconds). Try to issue events for it during that freeze time:
if (strcmp(ev->key, "f") == 0)
{
printf("Freezing input for 3 seconds\n");
return;
}
EVAS_API void evas_event_freeze(Evas *eo_e)
Freeze all input events processing.
Definition: evas_events.c:1540
The 'd' command will unregister those two canvas callbacks for you, so you won't see the messages about the focused object and the rendering process anymore:
if (strcmp(ev->key, "d") == 0)
{
printf("Deleting canvas event callbacks\n");
_render_flush_cb, NULL);
_object_focus_in_cb, NULL);
return;
}
@ EVAS_CALLBACK_RENDER_FLUSH_PRE
Called after render update regions have been calculated, but only if update regions exist.
Definition: Evas_Common.h:445
EVAS_API void * evas_event_callback_del_full(Evas *eo_e, Evas_Callback_Type type, Evas_Event_Cb func, const void *data)
Delete (unregister) a callback function registered to a given canvas event.
Definition: evas_callbacks.c:678
In this example, we start using a focused object to handle the input events – the background rectangle. We register a callback on an key input event occurring on it, so that we can act on each key stroke:
{
fprintf(stderr, "ERROR: Callback registering failed! Aborting.\n");
goto panic;
}
@ EVAS_CALLBACK_KEY_DOWN
Key Press Event.
Definition: Evas_Common.h:430
EVAS_API void evas_object_event_callback_add(Evas_Object *eo_obj, Evas_Callback_Type type, Evas_Object_Event_Cb func, const void *data)
Add (register) a callback function to a given Evas object event.
Definition: evas_callbacks.c:478
static void
void *einfo)
{
const Evas_Modifier *mods;
printf(
"We've got key input: %s\n", ev->
key);
printf("It actually came from %s\n",
d.focus ? "focus" : "key grab");
Key press event.
Definition: Evas_Legacy.h:314
const char * key
The logical key : (eg shift+1 == exclamation)
Definition: Evas_Legacy.h:320
We do so by examining the ev->key
string (remember the event information struct for key down events is the Evas_Event_Key_Down one). There's one more trick for grabbing input events on this example – evas_object_key_grab(). The 'c' command will, when firstly used, unfocus the background rectangle. Unfocused objects on an Evas canvas will never receive key events. We grab, then, the keys we're interested at to the object forcefully:
if (d.focus)
{
printf("Focused object is now %s\n",
"still valid! Something went wrong." : "none.");
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
}
else
#define EINA_FALSE
boolean value FALSE (numerical value 0)
Definition: eina_types.h:533
EVAS_API Eina_Bool evas_object_key_grab(Evas_Object *obj, const char *keyname, Evas_Modifier_Mask modifiers, Evas_Modifier_Mask not_modifiers, Eina_Bool exclusive)
Requests keyname key events be directed to obj.
Definition: evas_key_grab.c:247
This shows how one can handle input not depending on focus issues – you can grab them globally. Switch back and forth focus and forced key grabbing with the 'c' key, and observe the messages printed about the focused object. Observe, also, that we register two more object callbacks, this time on the image object (Enlightenment logo), where we just print messages telling the mouse pointer has entered or exited it area:
@ EVAS_CALLBACK_MOUSE_IN
Mouse In Event.
Definition: Evas_Common.h:420
@ EVAS_CALLBACK_MOUSE_OUT
Mouse Out Event.
Definition: Evas_Common.h:421
static void
{
printf("Enlightenment logo has had the mouse in.\n");
}
static void
{
printf("Enlightenment logo has had the mouse out.\n");
}
Experiment with moving the mouse pointer over the image, letting it enter and exit its area (stop the animation with 'a', for a better experience). When you start the example, Evas will consider this area by being the whole boundary rectangle around the picture. If you issue the 'p' command, though, you get a demonstration of Evas' precise point collision detection on objects. With evas_object_precise_is_inside_get(), one can make Evas consider the transparent areas of an object (the middle of the logo's E letter, in the case) as not belonging to it when calculating mouse in/out/up/down events:
if (strcmp(ev->
key,
"p") == 0)
{
printf("Toggling precise point collision detection %s on Enlightenment logo\n",
precise ? "off" : "on");
return;
}
EVAS_API Eina_Bool evas_object_precise_is_inside_get(const Efl_Canvas_Object *obj)
Determine whether an object is set to use precise point collision detection.
Definition: efl_canvas_object_eo.legacy.c:57
EVAS_API void evas_object_precise_is_inside_set(Efl_Canvas_Object *obj, Eina_Bool precise)
Set whether to use precise (usually expensive) point collision detection for a given Evas object.
Definition: efl_canvas_object_eo.legacy.c:51
To finish the example, try the command bound to Control + 'o', which exemplifies Evas' obscured regions. When firstly pressed, you'll get the same contents, in a region in the middle of the canvas, at the time the key was pressed, until you toggle the effect off again (make sure the animation is running on to get the idea better). When you toggle this effect off, we also demonstrate the use of evas_render_updates(), which will force immediate updates on the canvas rendering, bringing back the obscured region's contents to normal.
(strcmp(ev->
key,
"o") == 0))
{
printf("Toggling obscured rectangle on canvas\n");
if (!d.obscured)
{
int w, h;
}
else
{
int w, h;
{
printf("Rectangle (%d, %d, %d, %d) on canvas got a"
" rendering update.\n", rect->
x, rect->
y,
}
}
d.obscured = !d.obscured;
}
#define EINA_LIST_FOREACH(list, l, _data)
Definition for the macro to iterate over a list.
Definition: eina_list.h:1415
EVAS_API void evas_output_viewport_get(const Evas *eo_e, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h)
Get the render engine's output viewport coordinates in canvas units.
Definition: evas_main.c:1441
EVAS_API const Evas_Modifier * evas_key_modifier_get(const Evas *eo_e)
Returns a handle to the list of modifier keys registered in the canvas e.
Definition: evas_key.c:35
EVAS_API Eina_List * evas_render_updates(Evas_Canvas *obj)
Force immediate renderization of the given Evas canvas.
Definition: evas_canvas_eo.legacy.c:297
EVAS_API void evas_render_updates_free(Eina_List *updates)
Free the rectangles returned by evas_render_updates().
Definition: evas_render.c:4078
EVAS_API void evas_obscured_clear(Evas_Canvas *obj)
Remove all "obscured regions" from an Evas canvas.
Definition: evas_canvas_eo.legacy.c:351
EVAS_API void evas_obscured_rectangle_add(Evas_Canvas *obj, int x, int y, int w, int h)
Add an "obscured region" to an Evas canvas.
Definition: evas_canvas_eo.legacy.c:327
EVAS_API void evas_damage_rectangle_add(Evas_Canvas *obj, int x, int y, int w, int h)
Add a damage rectangle.
Definition: evas_canvas_eo.legacy.c:267
EVAS_API Eina_Bool evas_key_modifier_is_set(const Evas_Modifier *m, const char *keyname)
Checks the state of a given modifier of the default seat, at the time of the call.
Definition: evas_key.c:76
Type for a generic double linked list.
Definition: eina_list.h:318
Definition: eina_rectangle.h:109
int h
height of rectangle
Definition: eina_rectangle.h:113
int x
top-left x coordinate of rectangle
Definition: eina_rectangle.h:110
int y
top-left y coordinate of rectangle
Definition: eina_rectangle.h:111
int w
width of rectangle
Definition: eina_rectangle.h:112
What follows is the complete code for this example.
#ifdef HAVE_CONFIG_H
#include "config.h"
#else
#define PACKAGE_EXAMPLES_DIR "."
#endif
#include <Ecore.h>
#include <stdio.h>
#include <errno.h>
#include "evas-common.h"
#define WIDTH (320)
#define HEIGHT (240)
static const char *img_path = PACKAGE_EXAMPLES_DIR EVAS_IMAGE_FOLDER "/enlightenment.png";
static const char *commands = \
"commands are:\n"
"\ta - toggle animation timer\n"
"\tc - cycle between focus and key grabs for key input\n"
"\td - delete canvas callbacks\n"
"\tf - freeze input for 3 seconds\n"
"\tp - toggle precise point collision detection on image\n"
"\tControl + o - add an obscured rectangle\n"
"\th - print help\n";
struct test_data
{
Ecore_Evas *ee;
};
static struct test_data d = {0};
static void
_canvas_resize_cb(Ecore_Evas *ee)
{
int w, h;
}
static void
void *event_info)
{
printf("An object got focused: %s\n",
printf("Let's recheck it: %s\n",
"OK!" : "Oops, something is bad.");
}
static void
{
printf("Canvas is about to flush its rendering pipeline!\n");
}
{
int w, h, cw, ch;
if (w < cw)
else
}
{
printf("Canvas was frozen %d times, now thawing.\n",
}
static void
{
printf("Enlightenment logo has had the mouse in.\n");
}
static void
{
printf("Enlightenment logo has had the mouse out.\n");
}
static void
void *einfo)
{
const Evas_Modifier *mods;
printf(
"We've got key input: %s\n", ev->
key);
printf("It actually came from %s\n",
d.focus ? "focus" : "key grab");
if (strcmp(ev->
key,
"h") == 0)
{
puts(commands);
return;
}
if (strcmp(ev->
key,
"a") == 0)
{
if (d.resize_timer != NULL)
{
printf("Stopping animation timer\n");
d.resize_timer = NULL;
}
else
{
printf("Re-issuing animation timer\n");
}
return;
}
if (strcmp(ev->
key,
"c") == 0)
{
printf("Switching to %s for key input\n",
d.focus ? "key grabs" : "focus");
if (d.focus)
{
printf("Focused object is now %s\n",
"still valid! Something went wrong." : "none.");
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
if (!ret)
{
printf("Something went wrong with key grabs.\n");
goto c_end;
}
}
else
{
}
c_end:
d.focus = !d.focus;
return;
}
if (strcmp(ev->
key,
"d") == 0)
{
printf("Deleting canvas event callbacks\n");
_render_flush_cb, NULL);
_object_focus_in_cb, NULL);
return;
}
if (strcmp(ev->
key,
"f") == 0)
{
printf("Freezing input for 3 seconds\n");
return;
}
if (strcmp(ev->
key,
"p") == 0)
{
printf("Toggling precise point collision detection %s on Enlightenment logo\n",
precise ? "off" : "on");
return;
}
(strcmp(ev->
key,
"o") == 0))
{
printf("Toggling obscured rectangle on canvas\n");
if (!d.obscured)
{
int w, h;
}
else
{
int w, h;
{
printf("Rectangle (%d, %d, %d, %d) on canvas got a"
" rendering update.\n", rect->
x, rect->
y,
}
}
d.obscured = !d.obscured;
}
}
int
main(void)
{
int err;
return EXIT_FAILURE;
if (!d.ee)
goto error;
_render_flush_cb, NULL);
{
fprintf(stderr, "ERROR: Callback registering failed! Aborting.\n");
goto panic;
}
_object_focus_in_cb, NULL);
{
fprintf(stderr, "ERROR: Callback registering failed! Aborting.\n");
goto panic;
}
{
fprintf(stderr, "ERROR: Callback registering failed! Aborting.\n");
goto panic;
}
{
fprintf(stderr, "ERROR: Image loading failed! Aborting.\n");
goto panic;
}
else
{
}
puts(commands);
return 0;
error:
fprintf(stderr, "error: Requires at least one Evas engine built and linked"
" to ecore-evas for this example to run properly.\n");
panic:
return -1;
}
EAPI int ecore_evas_init(void)
Inits the Ecore_Evas system.
Definition: ecore_evas.c:602
EAPI void ecore_evas_show(Ecore_Evas *ee)
Shows an Ecore_Evas' window.
Definition: ecore_evas.c:1480
EAPI Evas * ecore_evas_get(const Ecore_Evas *ee)
Gets an Ecore_Evas's Evas.
Definition: ecore_evas.c:1300
EAPI Ecore_Evas * ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options)
Creates a new Ecore_Evas based on engine name and common parameters.
Definition: ecore_evas.c:1039
EAPI int ecore_evas_shutdown(void)
Shuts down the Ecore_Evas system.
Definition: ecore_evas.c:666
EAPI void ecore_evas_free(Ecore_Evas *ee)
Frees an Ecore_Evas.
Definition: ecore_evas.c:1083
void ecore_main_loop_begin(void)
Runs the application main loop.
Definition: ecore_main.c:1311
void * ecore_timer_del(Ecore_Timer *timer)
Deletes the specified timer from the timer list.
Definition: ecore_timer.c:238
EVAS_API Evas_Modifier_Mask evas_key_modifier_mask_get(const Evas *eo_e, const char *keyname)
Creates a bit mask from the keyname modifier key.
Definition: evas_key.c:271
EVAS_API int evas_event_freeze_get(const Evas *e)
Return the freeze count on input events of a given canvas.
Definition: evas_events.c:1585
EVAS_API void evas_event_thaw(Evas *e)
Thaw a canvas out after freezing (for input events).
Definition: evas_events.c:1546
@ EVAS_LOAD_ERROR_NONE
No error on load.
Definition: Evas_Loader.h:141
unsigned long long Evas_Modifier_Mask
A bitmask of modifier keys.
Definition: Evas_Legacy.h:132
EVAS_API void evas_object_key_ungrab(Evas_Object *obj, const char *keyname, Evas_Modifier_Mask modifiers, Evas_Modifier_Mask not_modifiers)
Removes the grab on keyname key events by obj.
Definition: evas_key_grab.c:260
EVAS_API Evas_Load_Error evas_object_image_load_error_get(const Evas_Object *obj)
Retrieves a number representing any error that occurred during the last loading of the given image ob...
Definition: evas_image_legacy.c:400
EVAS_API void evas_object_image_file_set(Evas_Object *obj, const char *file, const char *key)
Set the source file from where an image object must fetch the real image data (it may be an Eet file,...
Definition: evas_image_legacy.c:194
EVAS_API Evas_Object * evas_object_image_filled_add(Evas *eo_e)
Creates a new image object that automatically scales its bound image to the object's area,...
Definition: evas_image_legacy.c:35