Image example

This example is as simple as possible. An image object will be added to the window over a white background, and set to be resizable together with the window. All the options set through the example will affect the behavior of this image.

We start with the code for creating a window and its background, and also add the code to write the path to the image that will be loaded:

int
elm_main(int argc EINA_UNUSED, char **argv EINA_UNUSED)
{
Evas_Object *win, *image;
char buf[PATH_MAX];
elm_app_info_set(elm_main, "elementary", "images/plant_01.jpg");
elm_policy_set(ELM_POLICY_QUIT, ELM_POLICY_QUIT_LAST_WINDOW_CLOSED);
win = elm_win_util_standard_add("image", "Image");
elm_win_autodel_set(win, EINA_TRUE);
snprintf(buf, sizeof(buf), "%s/images/plant_01.jpg", elm_app_data_dir_get());
EINA_TRUE
#define EINA_TRUE
boolean value TRUE (numerical value 1)
Definition eina_types.h:539
EINA_UNUSED
#define EINA_UNUSED
Used to indicate that a function parameter is purposely unused.
Definition eina_types.h:339
elm_app_info_set
void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile)
Re-locate the application somewhere else after compilation, if the developer wishes for easier distri...
Definition elm_main.c:496
elm_app_data_dir_get
const char * elm_app_data_dir_get(void)
Get the application's run time data prefix directory, as set by elm_app_info_set() and the way (envir...
Definition elm_main.c:586
elm_policy_set
Eina_Bool elm_policy_set(unsigned int policy, int value)
Set a new policy's value (for a given policy group/identifier).
Definition elm_main.c:1380
ELM_POLICY_QUIT_LAST_WINDOW_CLOSED
@ ELM_POLICY_QUIT_LAST_WINDOW_CLOSED
quit when the application's last window is closed
Definition elm_general.h:248
ELM_POLICY_QUIT
@ ELM_POLICY_QUIT
under which circumstances the application should quit automatically.
Definition elm_general.h:227
elm_win_util_standard_add
Evas_Object * elm_win_util_standard_add(const char *name, const char *title)
Adds a window object with standard setup.
Definition efl_ui_win.c:9587
elm_win_autodel_set
void elm_win_autodel_set(Eo *obj, Eina_Bool autodel)
Set the window's autodel state.
Definition efl_ui_win.c:6199
Evas_Object
Efl_Canvas_Object Evas_Object
An Evas Object handle.
Definition Evas_Common.h:185

Now we create the image object, and set that file to be loaded:

image = elm_image_add(win);
if (!elm_image_file_set(image, buf, NULL))
{
printf("error: could not load image \"%s\"\n", buf);
return -1;
}
elm_image_add
Evas_Object * elm_image_add(Evas_Object *parent)
Add a new image to the parent.
Definition efl_ui_image.c:2716
elm_image_file_set
Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group)
Set the file that will be used as the image's source.
Definition efl_ui_image.c:2416

We can now go setting our options.

elm_image_no_scale_set() is used just to set this value to true (we don't want to scale our image anyway, just resize it).

elm_image_resizable_set() is used to allow the image to be resized to a size smaller than the original one, but not to a size bigger than it.

elm_image_smooth_set() will disable the smooth scaling, so the scale algorithm used to scale the image to the new object size is going to be faster, but with a lower quality.

elm_image_orient_set() is used to flip the image around the (1, 0) (0, 1) diagonal.

elm_image_aspect_fixed_set() is used to keep the original aspect ratio of the image, even when the window is resized to another aspect ratio.

elm_image_fill_outside_set() is used to ensure that the image will fill the entire area available to it, even if keeping the aspect ratio. The image will overflow its width or height (any of them that is necessary) to the object area, instead of resizing the image down until it can fit entirely in this area.

elm_image_editable_set() is used just to cover the API, but won't affect this example since we are not using any copy & paste property.

This is the code for setting these options:

elm_image_no_scale_set(image, EINA_TRUE);
elm_image_resizable_set(image, EINA_FALSE, EINA_TRUE);
elm_image_smooth_set(image, EINA_FALSE);
elm_image_orient_set(image, ELM_IMAGE_FLIP_HORIZONTAL);
elm_image_aspect_fixed_set(image, EINA_TRUE);
elm_image_fill_outside_set(image, EINA_TRUE);
elm_image_editable_set(image, EINA_TRUE);
EINA_FALSE
#define EINA_FALSE
boolean value FALSE (numerical value 0)
Definition eina_types.h:533
elm_image_no_scale_set
void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale)
Control scaling behaviour of this object.
Definition efl_ui_image.c:2619
elm_image_fill_outside_set
void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside)
Control if the image fills the entire object area, when keeping the aspect ratio.
Definition efl_ui_image.c:2502
elm_image_resizable_set
void elm_image_resizable_set(Evas_Object *obj, Eina_Bool up, Eina_Bool down)
Control if the object is (up/down) resizable.
Definition efl_ui_image.c:2637
elm_image_smooth_set
void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth)
Control the smooth effect for an image.
Definition efl_ui_image.c:2386
elm_image_orient_set
void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient elm_orient)
Contrtol the image orientation.
Definition efl_ui_image.c:2565
elm_image_editable_set
void elm_image_editable_set(Evas_Object *obj, Eina_Bool edit)
Contrtol if the image is 'editable'.
Definition efl_ui_image.c:2404
elm_image_aspect_fixed_set
void elm_image_aspect_fixed_set(Evas_Object *obj, Eina_Bool fixed)
Control whether the internal image's aspect ratio is fixed to the original image's aspect ratio.
Definition efl_ui_image.c:2657
ELM_IMAGE_FLIP_HORIZONTAL
@ ELM_IMAGE_FLIP_HORIZONTAL
flip image horizontally (along the x = width / 2 line)
Definition elm_image_legacy.h:398

Now some last touches in our object size hints, window and background, to display this image properly:

evas_object_size_hint_weight_set(image, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
elm_win_resize_object_add(win, image);
evas_object_show(image);
evas_object_resize(win, 320, 320);
evas_object_show(win);
elm_run();
return 0;
}
ELM_MAIN()
EVAS_HINT_EXPAND
#define EVAS_HINT_EXPAND
Use with evas_object_size_hint_weight_set(), evas_object_size_hint_weight_get(), evas_object_size_hin...
Definition Evas_Common.h:297
ELM_MAIN
#define ELM_MAIN()
macro to be used after the elm_main() function
Definition elm_general.h:556
elm_run
void elm_run(void)
Run Elementary's main loop.
Definition elm_main.c:1357
elm_win_resize_object_add
void elm_win_resize_object_add(Eo *obj, Evas_Object *subobj)
Add subobj as a resize object of window obj.
Definition efl_ui_win.c:9002
evas_object_show
EVAS_API void evas_object_show(Evas_Object *eo_obj)
Makes the given Evas object visible.
Definition evas_object_main.c:1814
evas_object_size_hint_weight_set
EVAS_API void evas_object_size_hint_weight_set(Evas_Object *obj, double x, double y)
Sets the hints for an object's weight.
Definition evas_object_main.c:2638
evas_object_resize
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

This example will look like this: