Adding a new swallow example

Patch by: Guilherme Iscaro <iscaro@profusion.mobi>

SVN revision: 69913

legacy/edje/doc/examples.dox

@@ -5,6 +5,7 @@
  *
  * @li @ref Example_Edje_Basics
  * @li @ref tutorial_edje_swallow
+ * @li @ref tutorial_edje_swallow2
  * @li @ref tutorial_edje_text
  * @li @ref tutorial_edje_table
  * @li @ref tutorial_edje_color_class
@@ -1025,7 +1026,7 @@
  * @skip if(strcmp
  * @until evas_object_move
  *
- *The example's window should look like this picture:
+ * The example's window should look like this picture:
  *
  * @image html basic2final.png
  * @image rtf basic2final.png
@@ -1048,3 +1049,59 @@
  * @endverbatim
  *
  */
+
+/**
+ * @page tutorial_edje_swallow2 Swallow example 2
+ *
+ * This example will show you how to load an image using evas and fill a swallow with it.
+ * It's basically almost like the last example, but with a minor change.
+ *
+ * This variables are used to store the name of the image that is going to be used,
+ * the path to it and a variable that will store the error cause if something goes wrong.
+ *
+ * Here it is:
+ * @dontinclude edje-swallow2.c
+ * @skipline char         edje_file
+ * @skipline const char  *img
+ * @skipline Evas_Load
+ *
+ *
+ * Then we load the image with this command:
+ *
+ * @skip img =
+ * @until evas_object_image_file_set(img,
+ *
+ * To check if we had some problem we use:
+ *
+ * @skip err = evas
+ * @until }
+ *
+ * Now we are going to swallow it and check if worked. If you notice we are
+ * using "part_one" as argument. We do this because we must explicit what part of our
+ * .edc file we want to swallow:
+ *
+ * @skip edje_object_part
+ * @until printf
+ *
+ * The example's window should look like this picture:
+ *
+ * @image html swallow2final.png
+ * @image rtf swallow2final.png
+ * @image latex swallow2final.eps width=\textwidth
+ *
+ * The complete .edc file:
+ * @include swallow.edc
+ *
+ * And the source code:
+ * @include edje-swallow2.c
+ *
+ * To compile use this command:
+ * @verbatim
+ * gcc -o edje-swallow2 edje-swallow2.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 swallow.edc
+ * @endverbatim
+ */

legacy/edje/src/examples/edje-swallow2.c

@@ -0,0 +1,135 @@
+/**
+ * Simple Edje example illustrating swallow functions.
+ *
+ * You'll need at least one Evas engine built for it (excluding the
+ * buffer one). See stdout/stderr for output.
+ *
+ * @verbatim
+ * edje_cc swallow.edc && gcc -o edje-swallow2 edje-swallow2.c `pkg-config --libs --cflags evas ecore ecore-evas edje`
+ * @endverbatim
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#else
+# define __UNUSED__
+#endif
+
+#include <Ecore.h>
+#include <Ecore_Evas.h>
+#include <Edje.h>
+
+#define WIDTH  (300)
+#define HEIGHT (300)
+
+static void
+_on_delete(Ecore_Evas *ee __UNUSED__)
+{
+   ecore_main_loop_quit();
+}
+
+int
+main(int argc __UNUSED__, char *argv[])
+{
+   char         edje_file_path[PATH_MAX];
+   char         img_file_path[PATH_MAX];
+   const char  *edje_file = "swallow.edj";
+   const char  *img_file = "bubble.png";
+   Ecore_Evas  *ee;
+   Evas        *evas;
+   Evas_Object *bg;
+   Evas_Object *img;
+   Evas_Object *obj;
+   Evas_Object *edje_obj;
+   Eina_Prefix *pfx;
+   Evas_Load_Error err;
+
+   if (!ecore_evas_init())
+     return EXIT_FAILURE;
+
+   if (!edje_init())
+     goto shutdown_ecore_evas;
+
+   pfx = eina_prefix_new(argv[0], main,
+                         "EDJE_EXAMPLES",
+                         "edje/examples",
+                         edje_file,
+                         PACKAGE_BIN_DIR,
+                         PACKAGE_LIB_DIR,
+                         PACKAGE_DATA_DIR,
+                         PACKAGE_DATA_DIR);
+   if (!pfx)
+     goto shutdown_edje;
+
+   /* 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 free_prefix;
+
+   ecore_evas_callback_delete_request_set(ee, _on_delete);
+
+   ecore_evas_title_set(ee, "Edje Swallow Example");
+
+   evas = ecore_evas_get(ee);
+
+   bg = evas_object_rectangle_add(evas);
+   evas_object_color_set(bg, 255, 255, 255, 255); /* white bg */
+   evas_object_move(bg, 0, 0); /* at canvas' origin */
+   evas_object_resize(bg, WIDTH, HEIGHT); /* covers full canvas */
+   evas_object_show(bg);
+   ecore_evas_data_set(ee, "background", bg);
+
+   ecore_evas_object_associate(ee,bg, ECORE_EVAS_OBJECT_ASSOCIATE_BASE);
+
+   edje_obj = edje_object_add(evas);
+
+   snprintf(edje_file_path, sizeof(edje_file_path),
+            "%s/examples/%s", eina_prefix_data_get(pfx), edje_file);
+   edje_object_file_set(edje_obj, edje_file_path, "example_group");
+   evas_object_move(edje_obj, 20, 20);
+   evas_object_resize(edje_obj, WIDTH - 40, HEIGHT - 40);
+   evas_object_show(edje_obj);
+
+   snprintf(img_file_path, sizeof(edje_file_path),
+            "%s/examples/%s", eina_prefix_data_get(pfx), img_file);
+
+   img = evas_object_image_filled_add(evas);
+   evas_object_image_file_set(img, img_file_path, NULL);
+
+   err = evas_object_image_load_error_get(img);
+
+   if (err != EVAS_LOAD_ERROR_NONE)
+   {
+      fprintf(stderr, "could not load image '%s'. error string is \"%s\"\n",
+              img_file_path, evas_load_error_str(err));
+     goto free_prefix;
+   }
+
+   edje_object_part_swallow(edje_obj, "part_one", img);
+
+   obj = edje_object_part_swallow_get(edje_obj, "part_one");
+
+   if(obj == img)
+      printf("Swallowing worked!\n");
+
+   ecore_evas_show(ee);
+
+   ecore_main_loop_begin();
+
+   eina_prefix_free(pfx);
+   ecore_evas_free(ee);
+   ecore_evas_shutdown();
+   edje_shutdown();
+
+   return EXIT_SUCCESS;
+
+ free_prefix:
+   eina_prefix_free(pfx);
+ shutdown_edje:
+   edje_shutdown();
+ shutdown_ecore_evas:
+   ecore_evas_shutdown();
+
+   return EXIT_FAILURE;
+}

legacy/edje/src/lib/Edje.h

@@ -166,6 +166,7 @@ part of Edje's API:
 - @ref Example_Edje_Basics
 - @ref tutorial_edje_basic2
 - @ref tutorial_edje_swallow
+- @ref tutorial_edje_swallow2
 - @ref tutorial_edje_table
 - @ref tutorial_edje_box
 - @ref tutorial_edje_box2