From 27b6eea8f899893c25e17aabdeb2fdbf1b919c98 Mon Sep 17 00:00:00 2001 From: glima Date: Wed, 29 Jun 2011 21:06:36 +0000 Subject: [PATCH] [evas] Documenting the following image functions: - evas_object_image_alpha_get - evas_object_image_alpha_set - evas_object_image_border_center_fill_get - evas_object_image_border_center_fill_set - evas_object_image_border_get - evas_object_image_border_scale_get - evas_object_image_border_scale_set - evas_object_image_border_set git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/evas@60844 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- doc/examples.dox | 37 +++-- src/examples/Makefile.am | 10 +- src/examples/evas-images.c | 313 +++++++++++++++++++++++++++++++++++++ src/examples/evas-load-error-str.c | 225 -------------------------- src/examples/red.png | Bin 185 -> 225 bytes src/lib/Evas.h | 155 +++++++++++------- 6 files changed, 442 insertions(+), 298 deletions(-) create mode 100644 src/examples/evas-images.c delete mode 100644 src/examples/evas-load-error-str.c diff --git a/doc/examples.dox b/doc/examples.dox index f37db4c..22cef0a 100644 --- a/doc/examples.dox +++ b/doc/examples.dox @@ -7,7 +7,7 @@ * * @ref Example_Evas_Init_Shutdown * - * @ref Example_Evas_Load_Error_Str + * @ref Example_Evas_Images * * @ref Example_Evas_Events * @@ -37,31 +37,31 @@ */ /** - * @page Example_Evas_Load_Error_Str Some image object functions and evas_load_error_str() example - * @dontinclude evas-load-error-str.c + * @page Example_Evas_Images Some image object functions examples + * @dontinclude evas-images.c * * In this example, we add two images to a canvas, each one having a * quarter of the canvas' size, positioned on the top left and bottom * right corners, respectively: - * @skip img1 = evas_object_image_add(evas); + * @skip img1 = evas_object_image_add(d.evas); * @until ecore_main_loop_begin * See there is a border image around the top left one, which is * the one that should be displayed. The other one will (on * purpose) fail to load, because we set a wrong file path as image * source on it: - * @dontinclude evas-load-error-str.c + * @dontinclude evas-images.c * @skip valid_path * @until bogus_path * This is how one is supposed to test for success when binding source * images to image objects: evas_object_image_load_error_get(), * followed by evas_load_error_str(), if one wants to pretty print/log - * the error. + * the error. We'll talk about the border image further. * * To interact with the program, there's a command line interface, * whose help string can be asked for with the 'h' key: - * @dontinclude evas-events.c - * @skip if (strcmp(ev->keyname, "h") == 0) - * @until } + * @dontinclude evas-images.c + * @skip commands + * @until ; * The first four commands will change the top left images's @b fill property * values, which dictate how the source image (Enlightenment's logo) * is to be displayed through the image object's area. Experiment with @@ -74,10 +74,25 @@ * one or other ways of setting an image object's viewport with regard * to its image source. * + * There are three commands which deal with the border image. This red + * frame is there to illustrate image borders. The image source + * for the border is a solid red rectangle, with a transparent area in + * its middle. See how we use it to get a 3 pixel wide frame with + * evas_object_image_border_set(d.border, 3, 3, 3, 3). To + * finish the effect of showing it as a border, we issue + * evas_object_image_border_center_fill_set(d.border, + * EVAS_BORDER_FILL_NONE). + * + * Use 't' to change the border's thickness. 'b' will change the + * border image's center region rendering schema: either a hole (no + * rendering), blending (see the original transparent area, in this + * case) or solid (the transparent area gets filled). Finally, 'c' + * will change the border's scaling factor. + * * The full example follows. * - * @include evas-load-error-str.c - * @example evas-load-error-str.c + * @include evas-images.c + * @example evas-images.c */ /** diff --git a/src/examples/Makefile.am b/src/examples/Makefile.am index ba1efd6..b6da36b 100644 --- a/src/examples/Makefile.am +++ b/src/examples/Makefile.am @@ -45,9 +45,9 @@ evas_init_shutdown_LDADD = $(top_builddir)/src/lib/libevas.la #the ones using ecore_evas follow AM_CPPFLAGS += @ECORE_EVAS_CFLAGS@ -pkglib_PROGRAMS += evas_load_error_str -evas_load_error_str_SOURCES = evas-load-error-str.c -evas_load_error_str_LDADD = $(top_builddir)/src/lib/libevas.la @ECORE_EVAS_LIBS@ +pkglib_PROGRAMS += evas_images +evas_images_SOURCES = evas-images.c +evas_images_LDADD = $(top_builddir)/src/lib/libevas.la @ECORE_EVAS_LIBS@ pkglib_PROGRAMS += evas_events evas_events_SOURCES = evas-events.c @@ -94,7 +94,7 @@ files_DATA += \ $(EDCS) \ $(srcdir)/evas-buffer-simple.c \ $(srcdir)/evas-init-shutdown.c \ - $(srcdir)/evas-load-error-str.c \ + $(srcdir)/evas-images.c \ $(srcdir)/evas-object-manipulation.c \ $(srcdir)/evas-events.c \ $(srcdir)/evas-aspect-hints.c \ @@ -105,7 +105,7 @@ endif EXTRA_DIST = $(EDCS) \ $(srcdir)/evas-buffer-simple.c \ $(srcdir)/evas-init-shutdown.c \ - $(srcdir)/evas-load-error-str.c \ + $(srcdir)/evas-images.c \ $(srcdir)/evas-object-manipulation.c \ $(srcdir)/evas-events.c \ $(srcdir)/evas-aspect-hints.c \ diff --git a/src/examples/evas-images.c b/src/examples/evas-images.c new file mode 100644 index 0000000..12f1fff --- /dev/null +++ b/src/examples/evas-images.c @@ -0,0 +1,313 @@ +/** + * Simple Evas example illustrating some image objects functions and evas_load_error_str()'s usage. + * + * You'll need at least one engine built for it (excluding the buffer + * one) and the png image loader also built. See stdout/stderr for + * output. + * + * @verbatim + * gcc -o evas-load-error-str evas-load-error-str.c `pkg-config --libs \ + * --cflags ecore-evas` + * @endverbatim + * + */ + +#ifdef HAVE_CONFIG_H + +#include "config.h" +#endif + +#include +#include +#include +#include + +#define WIDTH (320) +#define HEIGHT (240) + +static const char *border_img_path = PACKAGE_EXAMPLES_DIR "/red.png"; +static const char *valid_path = PACKAGE_EXAMPLES_DIR "/enlightenment.png"; +static const char *bogus_path = "/tmp/non-existent-220986.png"; +static const char *commands = \ + "commands are:\n" + "\tx - change image's x fill coordinate\n" + "\ty - change image's y fill coordinate\n" + "\tw - change image's w fill size\n" + "\te - change image's h fill size\n" + "\tf - toggle image filled property (overrides fill)\n" + "\ta - toggle image's alpha channel usage\n" + "\tt - change border's thickness\n" + "\tb - change border's center region aspect\n" + "\tc - change border's scaling factor\n" + "\ts - print image's fill property status\n" + "\th - print help\n"; + +struct test_data +{ + Evas *evas; + Ecore_Evas *ee; + Evas_Object *img1, *img2, *bg, *border; +}; + +static struct test_data d = {0}; + +static const char* +_border_fill_mode_to_str(Evas_Border_Fill_Mode mode) +{ + switch (mode) + { + case EVAS_BORDER_FILL_NONE: + return "none"; + case EVAS_BORDER_FILL_DEFAULT: + return "default"; + case EVAS_BORDER_FILL_SOLID: + return "solid"; + default: + return "invalid"; + } +} + +static void +_on_keydown(void *data __UNUSED__, + Evas *evas __UNUSED__, + Evas_Object *o __UNUSED__, + void *einfo) +{ + Evas_Event_Key_Down *ev = einfo; + + if (strcmp(ev->keyname, "h") == 0) /* print help */ + { + fprintf(stdout, commands); + return; + } + + if (strcmp(ev->keyname, "t") == 0) /* change border's thickness */ + { + int l, r, t, b; + + evas_object_image_border_get(d.border, &l, &r, &t, &b); + + l = (l + 3) % 9; + r = (r + 3) % 9; + t = (t + 3) % 9; + b = (b + 3) % 9; + + evas_object_image_border_set(d.border, l, r, t, b); + + fprintf(stdout, "Image's border thickness is now %d\n", l); + + return; + } + + if (strcmp(ev->keyname, "c") == 0) /* change border's scaling factor */ + { + double scale = evas_object_image_border_scale_get(d.border); + + scale *= 2; + if (scale > 4.0) scale = 1.0; + + evas_object_image_border_scale_set(d.border, scale); + + fprintf(stdout, "Image's border scaling factor is now %f\n", scale); + + return; + } + + if (strcmp(ev->keyname, "b") == 0) /* change border's center + * region's aspect */ + { + Eina_Bool fill = \ + evas_object_image_border_center_fill_get(d.border); + + fill = (fill + 1) % 3; + + evas_object_image_border_center_fill_set(d.border, fill); + + fprintf(stdout, "Image's border center region aspect is now \"%s\"\n", + _border_fill_mode_to_str(fill)); + + return; + } + + if (strcmp(ev->keyname, "a") == 0) /* toggle alpha channel usage */ + { + Eina_Bool alpha = evas_object_image_alpha_get(d.img1); + + evas_object_image_alpha_set(d.img1, !alpha); + + fprintf(stdout, "Image's alpha channel is now %s\n", + alpha ? "off" : "on"); + + return; + } + + if (strcmp(ev->keyname, "f") == 0) /* toggle filled property */ + { + Eina_Bool filled = evas_object_image_filled_get(d.img1); + + evas_object_image_filled_set(d.img1, !filled); + + fprintf(stdout, "Image's x filled property is now %s\n", + filled ? "off" : "on"); + + return; + } + + if (strcmp(ev->keyname, "x") == 0) /* change x fill coordinate */ + { + Evas_Coord x, y, w, h; + + evas_object_image_fill_get(d.img1, &x, &y, &w, &h); + x = (x + 20) % (WIDTH / 2); + evas_object_image_fill_set(d.img1, x, y, w, h); + + fprintf(stdout, "Image's x fill coordinate changed to %d\n", x); + + return; + } + + if (strcmp(ev->keyname, "y") == 0) /* change y fill coordinate */ + { + Evas_Coord x, y, w, h; + + evas_object_image_fill_get(d.img1, &x, &y, &w, &h); + y = (y + 20) % (HEIGHT / 2); + evas_object_image_fill_set(d.img1, x, y, w, h); + + fprintf(stdout, "Image's y fill coordinate changed to %d\n", y); + + return; + } + + if (strcmp(ev->keyname, "w") == 0) /* change w fill size */ + { + Evas_Coord x, y, w, h; + + evas_object_image_fill_get(d.img1, &x, &y, &w, &h); + if (w > (WIDTH / 2)) w = (WIDTH / 2); + else w = WIDTH; + evas_object_image_fill_set(d.img1, x, y, w, h); + + fprintf(stdout, "Image's w fill size changed to %d\n", w); + + return; + } + + if (strcmp(ev->keyname, "e") == 0) /* change h fill size */ + { + Evas_Coord x, y, w, h; + + evas_object_image_fill_get(d.img1, &x, &y, &w, &h); + if (h > (HEIGHT / 2)) h = (HEIGHT / 2); + else h = HEIGHT; + evas_object_image_fill_set(d.img1, x, y, w, h); + + fprintf(stdout, "Image's h fill size changed to %d\n", h); + + return; + } + + if (strcmp(ev->keyname, "s") == 0) /* status */ + { + Evas_Coord x, y, w, h; + + evas_object_image_fill_get(d.img1, &x, &y, &w, &h); + + fprintf(stdout, "Image has fill properties set to: %d, %d, %d, %d\n", + x, y, w, h); + + return; + } +} + +int +main(void) +{ + int err; + + if (!ecore_evas_init()) + return EXIT_FAILURE; + + /* this will give you a window with an Evas canvas under the first + * engine available */ + d.ee = ecore_evas_new(NULL, 10, 10, WIDTH, HEIGHT, NULL); + if (!d.ee) + goto error; + + ecore_evas_show(d.ee); + + /* the canvas pointer, de facto */ + d.evas = ecore_evas_get(d.ee); + + d.bg = evas_object_rectangle_add(d.evas); + evas_object_color_set(d.bg, 255, 255, 255, 255); /* white bg */ + evas_object_move(d.bg, 0, 0); /* at canvas' origin */ + evas_object_resize(d.bg, WIDTH, HEIGHT); /* covers full canvas */ + evas_object_show(d.bg); + + d.img1 = evas_object_image_add(d.evas); + evas_object_image_file_set(d.img1, valid_path, NULL); + err = evas_object_image_load_error_get(d.img1); + if (err != EVAS_LOAD_ERROR_NONE) + { + fprintf(stderr, "could not load image '%s'. error string is \"%s\"\n", + valid_path, evas_load_error_str(err)); + } + else + { + fprintf(stdout, + "loaded image '%s' with succes! error string is \"%s\"\n", + valid_path, evas_load_error_str(err)); + + evas_object_move(d.img1, 3, 3); + evas_object_image_fill_set(d.img1, 0, 0, WIDTH / 2, HEIGHT / 2); + evas_object_resize(d.img1, WIDTH / 2, HEIGHT / 2); + evas_object_show(d.img1); + + evas_object_focus_set(d.bg, EINA_TRUE); + evas_object_event_callback_add( + d.bg, EVAS_CALLBACK_KEY_DOWN, _on_keydown, NULL); + } + + /* this is a border around the image above, here just to emphasize + * its geometry */ + d.border = evas_object_image_filled_add(d.evas); + evas_object_image_file_set(d.border, border_img_path, NULL); + evas_object_image_border_set(d.border, 3, 3, 3, 3); + evas_object_image_border_center_fill_set(d.border, EVAS_BORDER_FILL_NONE); + + evas_object_move(d.border, 0, 0); + evas_object_resize(d.border, (WIDTH / 2) + 6, (HEIGHT / 2) + 6); + evas_object_show(d.border); + + /* image loading will fail for this one -- unless one cheats and + * puts a valid image on that path */ + d.img2 = evas_object_image_add(d.evas); + evas_object_image_file_set(d.img2, bogus_path, NULL); + err = evas_object_image_load_error_get(d.img2); + if (err != EVAS_LOAD_ERROR_NONE) + { + fprintf(stderr, "could not load image '%s': error string is \"%s\"\n", + bogus_path, evas_load_error_str(err)); + } + else + { + evas_object_move(d.img2, WIDTH / 2, HEIGHT / 2); + evas_object_image_fill_set(d.img2, 0, 0, WIDTH / 2, HEIGHT / 2); + evas_object_resize(d.img2, WIDTH / 2, HEIGHT / 2); + evas_object_show(d.img2); + } + + fprintf(stdout, commands); + ecore_main_loop_begin(); + + ecore_evas_free(d.ee); + ecore_evas_shutdown(); + return 0; + +error: + fprintf(stderr, "you got to have at least one evas engine built and linked" + " up to ecore-evas for this example to run properly.\n"); + ecore_evas_shutdown(); + return -1; +} diff --git a/src/examples/evas-load-error-str.c b/src/examples/evas-load-error-str.c deleted file mode 100644 index 5b8ea9d..0000000 --- a/src/examples/evas-load-error-str.c +++ /dev/null @@ -1,225 +0,0 @@ -/** - * Simple Evas example illustrating some image objects functions and evas_load_error_str()'s usage. - * - * You'll need at least one engine built for it (excluding the buffer - * one) and the png image loader also built. See stdout/stderr for - * output. - * - * @verbatim - * gcc -o evas-load-error-str evas-load-error-str.c `pkg-config --libs \ - * --cflags ecore-evas` - * @endverbatim - * - */ - -#ifdef HAVE_CONFIG_H - -#include "config.h" -#endif - -#include -#include -#include -#include - -#define WIDTH (320) -#define HEIGHT (240) - -static const char *border_img_path = PACKAGE_EXAMPLES_DIR "/red.png"; -static const char *valid_path = PACKAGE_EXAMPLES_DIR "/enlightenment.png"; -static const char *bogus_path = "/tmp/non-existent-220986.png"; - -static void -_on_keydown(void *data, - Evas *evas __UNUSED__, - Evas_Object *o __UNUSED__, - void *einfo) -{ - Evas_Object *img = data; - Evas_Event_Key_Down *ev = einfo; - - if (strcmp(ev->keyname, "h") == 0) /* print help */ - { - fprintf(stdout, "commands are:\n" - "\tx - change image's x fill coordinate\n" - "\ty - change image's y fill coordinate\n" - "\tw - change image's w fill size\n" - "\te - change image's h fill size\n" - "\tf - toggle image filled property (overrides fill)\n" - "\ts - print image's fill property status\n" - "\th - print help\n"); - return; - } - - if (strcmp(ev->keyname, "f") == 0) /* toggle filled property */ - { - Eina_Bool filled = evas_object_image_filled_get(img); - - evas_object_image_filled_set(img, !filled); - - fprintf(stdout, "Image's x filled property is now %s\n", - filled ? "off" : "on"); - - return; - } - - if (strcmp(ev->keyname, "x") == 0) /* change x fill coordinate */ - { - Evas_Coord x, y, w, h; - - evas_object_image_fill_get(img, &x, &y, &w, &h); - x = (x + 20) % (WIDTH / 2); - evas_object_image_fill_set(img, x, y, w, h); - - fprintf(stdout, "Image's x fill coordinate changed to %d\n", x); - - return; - } - - if (strcmp(ev->keyname, "y") == 0) /* change y fill coordinate */ - { - Evas_Coord x, y, w, h; - - evas_object_image_fill_get(img, &x, &y, &w, &h); - y = (y + 20) % (HEIGHT / 2); - evas_object_image_fill_set(img, x, y, w, h); - - fprintf(stdout, "Image's y fill coordinate changed to %d\n", y); - - return; - } - - if (strcmp(ev->keyname, "w") == 0) /* change w fill size */ - { - Evas_Coord x, y, w, h; - - evas_object_image_fill_get(img, &x, &y, &w, &h); - if (w > (WIDTH / 2)) w = (WIDTH / 2); - else w = WIDTH; - evas_object_image_fill_set(img, x, y, w, h); - - fprintf(stdout, "Image's w fill size changed to %d\n", w); - - return; - } - - if (strcmp(ev->keyname, "e") == 0) /* change h fill size */ - { - Evas_Coord x, y, w, h; - - evas_object_image_fill_get(img, &x, &y, &w, &h); - if (h > (HEIGHT / 2)) h = (HEIGHT / 2); - else h = HEIGHT; - evas_object_image_fill_set(img, x, y, w, h); - - fprintf(stdout, "Image's h fill size changed to %d\n", h); - - return; - } - - if (strcmp(ev->keyname, "s") == 0) /* status */ - { - Evas_Coord x, y, w, h; - - evas_object_image_fill_get(img, &x, &y, &w, &h); - - fprintf(stdout, "Image has fill properties set to: %d, %d, %d, %d\n", - x, y, w, h); - - return; - } -} - -int -main(void) -{ - Evas *evas; - Ecore_Evas *ee; - Evas_Object *img1, *img2, *bg, *border; - int err; - - if (!ecore_evas_init()) - return EXIT_FAILURE; - - /* this will give you a window with an Evas canvas under the first - * engine available */ - ee = ecore_evas_new(NULL, 10, 10, WIDTH, HEIGHT, NULL); - if (!ee) - goto error; - - ecore_evas_show(ee); - - /* the canvas pointer, de facto */ - 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); - - img1 = evas_object_image_add(evas); - evas_object_image_file_set(img1, valid_path, NULL); - err = evas_object_image_load_error_get(img1); - if (err != EVAS_LOAD_ERROR_NONE) - { - fprintf(stderr, "could not load image '%s'. error string is \"%s\"\n", - valid_path, evas_load_error_str(err)); - } - else - { - fprintf(stdout, - "loaded image '%s' with succes! error string is \"%s\"\n", - valid_path, evas_load_error_str(err)); - - evas_object_move(img1, 0, 0); - evas_object_image_fill_set(img1, 0, 0, WIDTH / 2, HEIGHT / 2); - evas_object_resize(img1, WIDTH / 2, HEIGHT / 2); - evas_object_show(img1); - - evas_object_focus_set(bg, EINA_TRUE); - evas_object_event_callback_add( - bg, EVAS_CALLBACK_KEY_DOWN, _on_keydown, img1); - } - - /* this is a border around the image above, here just to emphasize - * its geometry */ - border = evas_object_image_filled_add(evas); - evas_object_image_file_set(border, border_img_path, NULL); - evas_object_image_border_set(border, 3, 3, 3, 3); - evas_object_image_border_center_fill_set(border, EVAS_BORDER_FILL_NONE); - - evas_object_move(border, 0, 0); - evas_object_resize(border, (WIDTH / 2) + 3, (HEIGHT / 2) + 3); - evas_object_show(border); - - /* image loading will fail for this one -- unless one cheats and - * puts a valid image on that path */ - img2 = evas_object_image_add(evas); - evas_object_image_file_set(img2, bogus_path, NULL); - err = evas_object_image_load_error_get(img2); - if (err != EVAS_LOAD_ERROR_NONE) - { - fprintf(stderr, "could not load image '%s': error string is \"%s\"\n", - bogus_path, evas_load_error_str(err)); - } - else - { - evas_object_move(img2, WIDTH / 2, HEIGHT / 2); - evas_object_image_fill_set(img2, 0, 0, WIDTH / 2, HEIGHT / 2); - evas_object_resize(img2, WIDTH / 2, HEIGHT / 2); - evas_object_show(img2); - } - - ecore_main_loop_begin(); - - ecore_evas_free(ee); - ecore_evas_shutdown(); - return 0; - -error: - fprintf(stderr, "you got to have at least one evas engine built and linked" - " up to ecore-evas for this example to run properly.\n"); - ecore_evas_shutdown(); - return -1; -} diff --git a/src/examples/red.png b/src/examples/red.png index 18f08558c560361817f6206a85982c8a63aa1639..dd03528d706824eb72bddf34b9057e40484ea7a0 100644 GIT binary patch delta 143 zcmdnV_>ggeq&gb|1B11}xWu{g-xiDBJ2nU_EgTavfC3&Vd9T(Ecf"No error on load" and "File (or file path) does * not exist", respectively. See the full @ref - * Example_Evas_Load_Error_Str "example". + * Example_Evas_Images "example". * * @ingroup Evas_Utils */ -- 2.7.4