Adding a new signal example

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

SVN revision: 69973

legacy/edje/doc/examples.dox

@@ -17,6 +17,7 @@
  * @li @ref tutorial_edje_animations
  * @li @ref tutorial_edje_multisense
  * @li @ref tutorial_edje_basic2
+ * @li @ref tutorial_edje_signals_2
  */
 
 /**
@@ -1105,3 +1106,78 @@
  * edje_cc swallow.edc
  * @endverbatim
  */
+
+/**
+ * @page tutorial_edje_signals_2 Edje Signals example 2
+ *
+ * In this example we will make use of signals to help to move an image away from the mouse pointer.
+ *
+ * Signals are software interruption, this means that when it happens and if the program is sensitive to it
+ * the program will stop whatever it is doing and handle the signal.
+ *
+ * In this example we are only sensitive to the "mouve,move" signal so we need to register a callback to it.
+ * To do this we will add a signal callback to our edje object that will detect "mouse,move" signal
+ * comming from the part "part_image" and when this happens we will call the fuction _on_mouse_over passing
+ * the evas pointer as a parameter. The evas pointer is passed as a parameter because we need to know
+ * where is the mouse pointer in the screen.
+ *
+ * We can see bellow how we can listen to the signal:
+ *
+ * @dontinclude signals2.c
+ * @skip edje_object_signal
+ * @until );
+ *
+ *
+ * Now, let's pass to the callback function. If we want to keep the ball away from the mouse pointer
+ * we need to now where is the ball and where is the mouse and we can easily discovery these things using
+ * this:
+ *
+ * For the the object position in the canvas:
+ * @dontinclude signals2.c
+ * @skipline evas_object_geometry
+ *
+ * For the mouse position relative to the screen:
+ * @skipline evas_pointer_output
+ *
+ * Now that we have the position of the mouse and the object we just need
+ * to set the new location and move the object. To set the new location we do this:
+ * @skip if
+ * @until y -= (
+ *
+ * You can change the formula above if you like. Because we are changing the object's position
+ * we need to do something if the new position is beyound the canvas size. So here it is:
+ *
+ * @skip if
+ * @until y = 0
+ *
+ * Then now what we need to do is move the object:
+ * @skipline  evas_object
+ *
+ * Here is the complete callback function:
+ *
+ * @dontinclude signals2.c
+ * @skip _on_mouse_over
+ * @until }
+ *
+ *
+ * When you compile and run it you should see this:
+ * @image html signal2final.png
+ * @image rtf signal2final.png
+ * @image latex signal2final.eps width=\textwidth
+ *
+ * The .edc file:
+ * @include signalsBubble.edc
+ *
+ * The source code:
+ * @include signals2.c
+ *
+ * To compile use this command:
+ * @verbatim
+ * gcc -o signals2 signals2.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 -id /path/to/the/image signalsBubble.edc
+ * @endverbatim
+ */

legacy/edje/src/examples/signals2.c

@@ -0,0 +1,134 @@
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#else
+#define PACKAGE_EXAMPLES_DIR "."
+#define __UNUSED__
+#endif
+
+#include <Ecore.h>
+#include <Ecore_Evas.h>
+#include <Edje.h>
+#include <stdio.h>
+
+#define WIDTH     (700)
+#define HEIGHT    (700)
+
+static void
+_on_delete(Ecore_Evas *ee __UNUSED__)
+{
+   ecore_main_loop_quit();
+}
+
+/* mouse over signals */
+static void
+_on_mouse_over(void *data, Evas_Object *edje_obj,
+               const char *emission __UNUSED__, const char *source __UNUSED__)
+{
+   Evas *evas;
+   int x, y, mouseX, mouseY;
+
+   evas = (Evas *) data;
+   evas_object_geometry_get(edje_obj, &x, &y, NULL, NULL);
+
+   evas_pointer_output_xy_get(evas, &mouseX, &mouseY);
+
+   if ((rand() % 2) == 0)
+     x += ((mouseX - x) + (x / 4 + mouseY / 2));
+   else
+     x -= ((mouseX - x) + (x / 4 + mouseY / 2));
+
+   if ((rand() % 2) == 0)
+     y += ((mouseY - y) + (y / 4 + mouseX / 2));
+   else
+     y -= ((mouseY - y) + (y / 4 + mouseX / 2));
+
+   if (x > WIDTH)
+     x = WIDTH;
+   else if (x < 0) x = 0;
+
+   if (y > HEIGHT)
+     y = HEIGHT;
+   else if (y < 0) y = 0;
+
+   fprintf(stdout, "Moving object to - (%d,%d)\n", x, y);
+
+   evas_object_move(edje_obj, x, y);
+}
+
+int
+main(int argc __UNUSED__, char **argv)
+{
+   const char *edje_file = "signalsBubble.edj";
+   char edje_file_path[PATH_MAX];
+   Eina_Prefix *pfx;
+   Ecore_Evas *ee;
+   Evas *evas;
+   Evas_Object *bg;
+   Evas_Object *edje_obj;
+
+   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;
+
+   ee = ecore_evas_new(NULL, 0, 0, WIDTH, HEIGHT, NULL);
+
+   if (!ee) goto eina_prefix_free;
+
+   ecore_evas_callback_delete_request_set(ee, _on_delete);
+   ecore_evas_title_set(ee, "Edje animations and signals");
+
+   evas = ecore_evas_get(ee);
+
+   bg = evas_object_rectangle_add(evas);
+   evas_object_color_set(bg, 255, 255, 255, 255); //White
+   evas_object_move(bg, 0, 0); //orign
+   evas_object_resize(bg, WIDTH, HEIGHT); //cover the window
+   evas_object_show(bg);
+
+   ecore_evas_object_associate(ee, bg, ECORE_EVAS_OBJECT_ASSOCIATE_BASE);
+   evas_object_focus_set(bg, EINA_TRUE);
+
+   edje_obj = edje_object_add(evas);
+
+   snprintf(edje_file_path, sizeof(edje_file_path), "%s/examples/%s",
+            eina_prefix_data_get(pfx), edje_file);
+
+   if (!edje_object_file_set(edje_obj, edje_file_path, "image_group"))
+     {
+        int err = edje_object_load_error_get(edje_obj);
+        const char *errmsg = edje_load_error_str(err);
+        fprintf(stderr, "Could not load the edje file - reason:%s\n", errmsg);
+        goto eina_prefix_free;
+     }
+
+   edje_object_signal_callback_add(edje_obj, "mouse,move", "part_image",
+                                   _on_mouse_over, evas);
+   evas_object_resize(edje_obj, 63, 63);
+   evas_object_move(edje_obj, 50, 50);
+   evas_object_show(edje_obj);
+
+   ecore_evas_show(ee);
+
+   ecore_main_loop_begin();
+
+   eina_prefix_free(pfx);
+   ecore_evas_free(ee);
+   edje_shutdown();
+   ecore_evas_shutdown();
+
+   return EXIT_SUCCESS;
+
+   eina_prefix_free: eina_prefix_free(pfx);
+
+   shutdown_edje: edje_shutdown();
+
+   shutdown_ecore_evas: ecore_evas_shutdown();
+
+   return EXIT_FAILURE;
+}

legacy/edje/src/examples/signalsBubble.edc

@@ -0,0 +1,22 @@
+collections{
+   group{
+      name: "image_group";
+      max: 500 500;
+      min: 50 50;
+      images{
+           image: "bubble.png" COMP;
+     }
+    parts{
+            part{
+                   name: "part_image";
+                   type: IMAGE;
+                   description{
+                       min:63 63;
+                       image{
+                            normal: "bubble.png";
+                       }
+                   }
+                 }
+          }
+   }
+}

legacy/edje/src/lib/Edje.h

@@ -173,6 +173,7 @@ part of Edje's API:
 - @ref tutorial_edje_color_class
 - @ref tutorial_edje_animations
 - @ref Example_Edje_Signals_Messages
+- @ref tutorial_edje_signals_2
 - @ref tutorial_edje_text
 - @ref tutorial_edje_drag
 - @ref tutorial_edje_perspective