Icon example

This example is as simple as possible. An icon 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 icon.

We start with the code for creating a window:

EAPI_MAIN int
elm_main(int argc EINA_UNUSED, char **argv EINA_UNUSED)
{
Evas_Object *win, *icon;
const char *path, *group, *name;
elm_policy_set(ELM_POLICY_QUIT, ELM_POLICY_QUIT_LAST_WINDOW_CLOSED);
win = elm_win_util_standard_add("icon", "Icon");
elm_win_autodel_set(win, EINA_TRUE);
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_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 icon object, and set lookup order of the icon, and choose the "home" icon:

icon = elm_icon_add(win);
elm_icon_standard_set(icon, "home");
elm_icon_standard_set
Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name)
Set the icon by icon standards names.
Definition elm_icon.c:876
elm_icon_add
Evas_Object * elm_icon_add(Evas_Object *parent)
Add a new icon object to the parent.
Definition elm_icon.c:604

An interesting thing is that after setting this, it's possible to check where in the filesystem is the theme used by this icon, and the name of the group used:

path = NULL;
group = NULL;
name = NULL;
elm_image_file_get(icon, &path, &group);
name = elm_icon_standard_get(icon);
printf("path = %s, group = %s, name = %s\n", path, group, name);
elm_icon_standard_get
const char * elm_icon_standard_get(const Evas_Object *obj)
Get the icon name set by icon standard names.
Definition elm_icon.c:897
elm_image_file_get
void elm_image_file_get(const Eo *obj, const char **file, const char **group)
Get the file that will be used as image.
Definition efl_ui_image.c:2441

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 icon anyway, just resize it).

elm_image_resizable_set() is used to allow the icon 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 icon to the new object size is going to be faster, but with a lower quality.

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

This is the code for setting these options:

elm_image_no_scale_set(icon, EINA_TRUE);
elm_image_resizable_set(icon, EINA_FALSE, EINA_TRUE);
elm_image_smooth_set(icon, EINA_FALSE);
elm_image_fill_outside_set(icon, 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

However, if you try this example you may notice that this image is not being affected by all of these options. This happens because the used icon will be from elementary theme, and thus it has its own set of options like smooth scaling and fill_outside options. You can change the "home" icon to use some image (from your system) and see that then those options will be respected.

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

evas_object_size_hint_weight_set(icon, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
elm_win_resize_object_add(win, icon);
evas_object_show(icon);
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: