Box example - basic usage

This example shows how to append, insert and remove elements from an Edje box part.

It will make use of the edje_object_part_box functions.

To play with this example, use mouse left click to delete an existing rectangle from the box and right mouse click to add a new rectangle just before the clicked one. Use the keyboard keys "a" to append a rectangle, "i" to prepend, and "c" to remove all rectangles from the box.

We will store our example global information in the data structure defined below, and also set some callbacks for resizing the canvas and exiting the window:

static const char commands[] = \
  "commands are:\n"
  "\ti - prepend rectangle\n"
  "\ta - append rectangle\n"
  "\tc - remove\n"
  "\tEsc - exit\n"
  "\th - print help\n";
 
static void
_on_destroy(Ecore_Evas *ee EINA_UNUSED)
{
   ecore_main_loop_quit();
}
 
/* here just to keep our example's window size and background image's
 * size in synchrony */
static void
_on_canvas_resize(Ecore_Evas *ee)
{
   Evas_Object *bg;
   Evas_Object *edje_obj;
   int          w;
   int          h;
 
   bg = ecore_evas_data_get(ee, "background");
   edje_obj = ecore_evas_data_get(ee, "edje_obj");
   ecore_evas_geometry_get(ee, NULL, NULL, &w, &h);
   evas_object_resize(bg, w, h);
   evas_object_resize(edje_obj, w, h);
}

In the main function, we create our Ecore_Evas, add a background to it, and finally load our Edje file that contains a Box part. This part is named "example/box" in this case, and we use this name to append elements to it.

The code until now is the one that follows:

Also notice that we set the callback _bg_key_down for "key down" events on the background object, and that object is the one with focus.

Now we add some small rectangles to the box part, using the edje_object_part_box_append() API, and set some callbacks for "mouse down" events on every object. These callbacks will be used to add or delete objects from the box part.

   bg = evas_object_rectangle_add(evas);
   evas_object_color_set(bg, 255, 255, 255, 255);
   evas_object_resize(bg, WIDTH, HEIGHT);
   evas_object_focus_set(bg, EINA_TRUE);
   evas_object_show(bg);
   ecore_evas_data_set(ee, "background", bg);
 
   evas_object_event_callback_add(bg, EVAS_CALLBACK_KEY_DOWN, _on_bg_key_down, ee);
 
   edje_obj = edje_object_add(evas);
 
   edje_object_file_set(edje_obj, edje_file, "example/group");
   evas_object_move(edje_obj, 0, 0);
   evas_object_resize(edje_obj, WIDTH, HEIGHT);
   evas_object_show(edje_obj);
   ecore_evas_data_set(ee, "edje_obj", edje_obj);
 
   for (i = 0; i < NRECTS; i++)
     {
        Evas_Object *rect;
        Eina_Bool r = EINA_FALSE;
        int red = (i * 10) % 256;
        rect = evas_object_rectangle_add(evas);
        evas_object_color_set(rect, red, 0, 0, 255);
        evas_object_resize(rect, RECTW, RECTH);
        r = edje_object_part_box_append(edje_obj, "example/box", rect);
        if (!r)
          printf("An error occurred when appending rect #%d to the box.\n", i);
        evas_object_show(rect);
 
        evas_object_event_callback_add(
           rect, EVAS_CALLBACK_MOUSE_DOWN, _on_rect_mouse_down, ee);
     }

Now let's take a look at the callbacks for key down and mouse down events:

static void
_on_rect_mouse_down(void *data, Evas *e, Evas_Object *o, void *event_info)
{
   Ecore_Evas            *ee;
   Evas_Event_Mouse_Down *ev;
   Evas_Object           *edje_obj;
 
   ee = (Ecore_Evas *)data;
   ev = (Evas_Event_Mouse_Down *)event_info;
   edje_obj = ecore_evas_data_get(ee, "edje_obj");
 
   if (ev->button == 1)
     {
        printf("Removing rect %p under the mouse pointer.\n", o);
        edje_object_part_box_remove(edje_obj, "example/box", o);
        evas_object_del(o);
     }
   else if (ev->button == 3)
     {
        Evas_Object *rect;
        Eina_Bool    r;
 
        rect = evas_object_rectangle_add(e);
        evas_object_color_set(rect, 0, 0, 255, 255);
        evas_object_resize(rect, RECTW + 10, RECTH);
        evas_object_show(rect);
 
        printf("Inserting rect %p before the rectangle under the mouse pointer.\n", rect);
        r = edje_object_part_box_insert_before(edje_obj, "example/box", rect, o);
        if (!r)
          printf("An error occurred when appending rect %p to the box.\n", rect);
 
        evas_object_event_callback_add(rect, EVAS_CALLBACK_MOUSE_DOWN, _on_rect_mouse_down, NULL);
     }
}

This callback for mouse down events will get left clicks and remove the object that received that left click from the box part, and then delete it. This is done with the edje_object_part_box_remove() function.

However, on right clicks it will create a new rectangle object, and add it just before the right clicked object, using edje_object_part_box_insert_before().

And this is the key down callback:

 
static void
_on_bg_key_down(void *data, Evas *e, Evas_Object *o EINA_UNUSED, void *event_info)
{
   Ecore_Evas          *ee;
   Evas_Event_Key_Down *ev;
   Evas_Object         *edje_obj;
   Evas_Object         *rect;
   Eina_Bool            r;
 
   ee = (Ecore_Evas *)data;
   ev = (Evas_Event_Key_Down *)event_info;
   edje_obj = ecore_evas_data_get(ee, "edje_obj");
 
   if (!strcmp(ev->key, "h"))
     {
        printf(commands);
        return;
     }
   if (!strcmp(ev->key, "i"))
     {
        rect = evas_object_rectangle_add(e);
        evas_object_color_set(rect, 0, 0, 128, 255);
        evas_object_resize(rect, RECTW + 30, RECTH);
        evas_object_show(rect);
 
        printf("Inserting rect %p before the rectangle under the mouse pointer.\n", rect);
        r = edje_object_part_box_insert_at(edje_obj, "example/box", rect, 0);
        if (!r)
          printf("An error occurred when appending rect %p to the box.\n", rect);
 
        evas_object_event_callback_add(rect, EVAS_CALLBACK_MOUSE_DOWN, _on_rect_mouse_down, NULL);
     }
   else if (!strcmp(ev->key, "a"))
     {
        rect = evas_object_rectangle_add(e);
        evas_object_color_set(rect, 0, 128, 0, 255);
        evas_object_resize(rect, RECTW, RECTH);
        evas_object_show(rect);
 
        printf("Inserting rect %p before the rectangle under the mouse pointer.\n", rect);
        r = edje_object_part_box_append(edje_obj, "example/box", rect);
        if (!r)
          printf("An error occurred when appending rect %p to the box.\n", rect);
 
        evas_object_event_callback_add(rect, EVAS_CALLBACK_MOUSE_DOWN, _on_rect_mouse_down, NULL);
     }
   else if (!strcmp(ev->key, "c"))
     edje_object_part_box_remove_all(edje_obj, "example/box", EINA_TRUE);
   else if (!strcmp(ev->key, "Escape"))
     ecore_main_loop_quit();
   else
     {
        printf("unhandled key: %s\n", ev->key);
        printf(commands);
     }

It will insert elements at the beginning of the box if "i" was pressed, using edje_object_part_box_insert_at(). It will also append objects to the box if "a" was pressed, just exactly like we did in the main function. And will remove all objects (deleting them) if "c" was pressed.

As you can see, this example uses the "horizontal_flow" layout for the box, where each item is put linearly in rows, in as many rows as necessary to store all of them.

The example's window should look like this picture:

The full source code follows:

 
#ifdef HAVE_CONFIG_H
# include "config.h"
#else
# define EINA_UNUSED
#endif
 
#ifndef PACKAGE_DATA_DIR
#define PACKAGE_DATA_DIR "."
#endif
 
#include <Ecore.h>
#include <Ecore_Evas.h>
#include <Edje.h>
 
#define WIDTH  300
#define HEIGHT 300
 
#define RECTW 30
#define RECTH 30
 
#define NRECTS 20
 
static const char commands[] = \
  "commands are:\n"
  "\ti - prepend rectangle\n"
  "\ta - append rectangle\n"
  "\tc - remove\n"
  "\tEsc - exit\n"
  "\th - print help\n";
 
static void
_on_destroy(Ecore_Evas *ee EINA_UNUSED)
{
   ecore_main_loop_quit();
}
 
/* here just to keep our example's window size and background image's
 * size in synchrony */
static void
_on_canvas_resize(Ecore_Evas *ee)
{
   Evas_Object *bg;
   Evas_Object *edje_obj;
   int          w;
   int          h;
 
   bg = ecore_evas_data_get(ee, "background");
   edje_obj = ecore_evas_data_get(ee, "edje_obj");
   ecore_evas_geometry_get(ee, NULL, NULL, &w, &h);
   evas_object_resize(bg, w, h);
   evas_object_resize(edje_obj, w, h);
}
 
static void
_on_rect_mouse_down(void *data, Evas *e, Evas_Object *o, void *event_info)
{
   Ecore_Evas            *ee;
   Evas_Event_Mouse_Down *ev;
   Evas_Object           *edje_obj;
 
   ee = (Ecore_Evas *)data;
   ev = (Evas_Event_Mouse_Down *)event_info;
   edje_obj = ecore_evas_data_get(ee, "edje_obj");
 
   if (ev->button == 1)
     {
        printf("Removing rect %p under the mouse pointer.\n", o);
        edje_object_part_box_remove(edje_obj, "example/box", o);
        evas_object_del(o);
     }
   else if (ev->button == 3)
     {
        Evas_Object *rect;
        Eina_Bool    r;
 
        rect = evas_object_rectangle_add(e);
        evas_object_color_set(rect, 0, 0, 255, 255);
        evas_object_resize(rect, RECTW + 10, RECTH);
        evas_object_show(rect);
 
        printf("Inserting rect %p before the rectangle under the mouse pointer.\n", rect);
        r = edje_object_part_box_insert_before(edje_obj, "example/box", rect, o);
        if (!r)
          printf("An error occurred when appending rect %p to the box.\n", rect);
 
        evas_object_event_callback_add(rect, EVAS_CALLBACK_MOUSE_DOWN, _on_rect_mouse_down, NULL);
     }
}
 
static void
_on_bg_key_down(void *data, Evas *e, Evas_Object *o EINA_UNUSED, void *event_info)
{
   Ecore_Evas          *ee;
   Evas_Event_Key_Down *ev;
   Evas_Object         *edje_obj;
   Evas_Object         *rect;
   Eina_Bool            r;
 
   ee = (Ecore_Evas *)data;
   ev = (Evas_Event_Key_Down *)event_info;
   edje_obj = ecore_evas_data_get(ee, "edje_obj");
 
   if (!strcmp(ev->key, "h"))
     {
        printf(commands);
        return;
     }
   if (!strcmp(ev->key, "i"))
     {
        rect = evas_object_rectangle_add(e);
        evas_object_color_set(rect, 0, 0, 128, 255);
        evas_object_resize(rect, RECTW + 30, RECTH);
        evas_object_show(rect);
 
        printf("Inserting rect %p before the rectangle under the mouse pointer.\n", rect);
        r = edje_object_part_box_insert_at(edje_obj, "example/box", rect, 0);
        if (!r)
          printf("An error occurred when appending rect %p to the box.\n", rect);
 
        evas_object_event_callback_add(rect, EVAS_CALLBACK_MOUSE_DOWN, _on_rect_mouse_down, NULL);
     }
   else if (!strcmp(ev->key, "a"))
     {
        rect = evas_object_rectangle_add(e);
        evas_object_color_set(rect, 0, 128, 0, 255);
        evas_object_resize(rect, RECTW, RECTH);
        evas_object_show(rect);
 
        printf("Inserting rect %p before the rectangle under the mouse pointer.\n", rect);
        r = edje_object_part_box_append(edje_obj, "example/box", rect);
        if (!r)
          printf("An error occurred when appending rect %p to the box.\n", rect);
 
        evas_object_event_callback_add(rect, EVAS_CALLBACK_MOUSE_DOWN, _on_rect_mouse_down, NULL);
     }
   else if (!strcmp(ev->key, "c"))
     edje_object_part_box_remove_all(edje_obj, "example/box", EINA_TRUE);
   else if (!strcmp(ev->key, "Escape"))
     ecore_main_loop_quit();
   else
     {
        printf("unhandled key: %s\n", ev->key);
        printf(commands);
     }
}
 
int
main(int argc EINA_UNUSED, char *argv[] EINA_UNUSED)
{
   const char  *edje_file = PACKAGE_DATA_DIR"/box.edj";
   Ecore_Evas  *ee;
   Evas        *evas;
   Evas_Object *bg;
   Evas_Object *edje_obj;
   int          i;
 
   if (!ecore_evas_init())
     return EXIT_FAILURE;
 
   if (!edje_init())
     goto shutdown_ecore_evas;
 
   /* this will give you a window with an Evas canvas under the first
    * engine available */
   ee = ecore_evas_new(NULL, 0, 0, WIDTH, HEIGHT, NULL);
   if (!ee) goto shutdown_edje;
 
   ecore_evas_callback_destroy_set(ee, _on_destroy);
   ecore_evas_callback_resize_set(ee, _on_canvas_resize);
   ecore_evas_title_set(ee, "Edje Box Example");
 
   evas = ecore_evas_get(ee);
 
   bg = evas_object_rectangle_add(evas);
   evas_object_color_set(bg, 255, 255, 255, 255);
   evas_object_resize(bg, WIDTH, HEIGHT);
   evas_object_focus_set(bg, EINA_TRUE);
   evas_object_show(bg);
   ecore_evas_data_set(ee, "background", bg);
 
   evas_object_event_callback_add(bg, EVAS_CALLBACK_KEY_DOWN, _on_bg_key_down, ee);
 
   edje_obj = edje_object_add(evas);
 
   edje_object_file_set(edje_obj, edje_file, "example/group");
   evas_object_move(edje_obj, 0, 0);
   evas_object_resize(edje_obj, WIDTH, HEIGHT);
   evas_object_show(edje_obj);
   ecore_evas_data_set(ee, "edje_obj", edje_obj);
 
   for (i = 0; i < NRECTS; i++)
     {
        Evas_Object *rect;
        Eina_Bool r = EINA_FALSE;
        int red = (i * 10) % 256;
        rect = evas_object_rectangle_add(evas);
        evas_object_color_set(rect, red, 0, 0, 255);
        evas_object_resize(rect, RECTW, RECTH);
        r = edje_object_part_box_append(edje_obj, "example/box", rect);
        if (!r)
          printf("An error occurred when appending rect #%d to the box.\n", i);
        evas_object_show(rect);
 
        evas_object_event_callback_add(
           rect, EVAS_CALLBACK_MOUSE_DOWN, _on_rect_mouse_down, ee);
     }
 
   printf(commands);
 
   ecore_evas_show(ee);
 
   ecore_main_loop_begin();
 
   ecore_evas_free(ee);
   ecore_evas_shutdown();
   edje_shutdown();
 
   return EXIT_SUCCESS;
 
 shutdown_edje:
   edje_shutdown();
 shutdown_ecore_evas:
   ecore_evas_shutdown();
 
   return EXIT_FAILURE;
}

To compile use this command:

* gcc -o edje-box edje-box.c -DPACKAGE_BIN_DIR=\"/Where/enlightenment/is/installed/bin\" -DPACKAGE_LIB_DIR=\"/Where/enlightenment/is/installed/lib\"
* -DPACKAGE_DATA_DIR=\"/Where/enlightenment/is/installed/share\"
* `pkg-config --cflags --libs evas ecore ecore-evas edje`
*
* edje_cc box.edc
*