Mapbuf Widget Example

This code places an Elementary mapbuf widget on a window, to exemplify part of the widget's API.

First we'll add an window with a background and a vertical box to pack our interface elements:

Next we'll simply add the mapbuf widget to the box:

But mapbuf is a container widget, it won't do anything alone. So let's create a table full of icons. For that we'll loop to fill each line of each column. See tutorial_table_01 if you don't know how to use tables:

Finally, setting mapbuf content:

Also, would be good a horizontal box with some controls to change mapbuf behavior:

By default map is disabled. So just setting content isn't enough. Alpha and smooth settings will be applied when map is enabled. So we'll add a check for that. Everytime the map properties are changed, map will need to be enabled again. So if you want to play a bit with our example, remember to always enable map again after concluding your changes.

We have added a callback function to this check, so it will enable or disable map:

static void
_alpha_cb(void *data, Evas_Object *obj, void *event_info EINA_UNUSED)
{
Evas_Object *mb = data;
elm_mapbuf_alpha_set(mb, elm_check_state_get(obj));
}
EINA_UNUSED
#define EINA_UNUSED
Used to indicate that a function parameter is purposely unused.
Definition: eina_types.h:339
elm_check_state_get
Eina_Bool elm_check_state_get(const Evas_Object *obj)
Get the state of the check object.
Definition: efl_ui_check.c:381
elm_mapbuf_alpha_set
void elm_mapbuf_alpha_set(Elm_Mapbuf *obj, Eina_Bool alpha)
Set or unset alpha flag for map rendering.
Definition: elm_mapbuf_eo.legacy.c:27
Evas_Object
Efl_Canvas_Object Evas_Object
An Evas Object handle.
Definition: Evas_Common.h:185

Let's add check boxes for alpha blending and smooth rendering:

tg = elm_check_add(win);
elm_check_add
Evas_Object * elm_check_add(Evas_Object *parent)
Add a new Check object.
Definition: efl_ui_check.c:516
elm_object_style_set(tg, "toggle");
elm_object_part_text_set(tg, "on", "Enabled");
elm_object_part_text_set(tg, "off", "Disabled");
elm_object_text_set(tg, "Map");
evas_object_smart_callback_add(tg, "changed", _enabled_cb, mb);
elm_box_pack_end(hbx, tg);
evas_object_show(tg);
elm_box_pack_end
void elm_box_pack_end(Elm_Box *obj, Efl_Canvas_Object *subobj)
Add an object at the end of the pack list.
Definition: elm_box_eo.legacy.c:57
elm_object_part_text_set
void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label)
Set a text of an object.
Definition: elm_main.c:1485
elm_object_style_set
Eina_Bool elm_object_style_set(Evas_Object *obj, const char *style)
Set the style to used by a given widget.
Definition: elm_main.c:1583
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_smart_callback_add
EVAS_API void evas_object_smart_callback_add(Evas_Object *eo_obj, const char *event, Evas_Smart_Cb func, const void *data)
Add (register) a callback function to the smart event specified by event on the smart object obj.
Definition: evas_object_smart.c:1040
ck = elm_check_add(win);
elm_object_text_set(ck, "Alpha");
elm_check_state_set(ck, EINA_TRUE);
evas_object_smart_callback_add(ck, "changed", _alpha_cb, mb);
elm_box_pack_end(hbx, ck);
evas_object_show(ck);
EINA_TRUE
#define EINA_TRUE
boolean value TRUE (numerical value 1)
Definition: eina_types.h:539
elm_check_state_set
void elm_check_state_set(Evas_Object *obj, Eina_Bool state)
Set the on/off state of the check object.
Definition: efl_ui_check.c:372

By default, mapbuf would enable alpha blending and smooth rendering, so we need to check boxes to be consistent with its behavior.

Callback functions look like the one added to the check. This way we could enable or disable the both properties:

static void
_smooth_cb(void *data, Evas_Object *obj, void *event_info EINA_UNUSED)
{
Evas_Object *mb = data;
elm_mapbuf_smooth_set(mb, elm_check_state_get(obj));
}
elm_mapbuf_smooth_set
void elm_mapbuf_smooth_set(Elm_Mapbuf *obj, Eina_Bool smooth)
Enable or disable smooth map rendering.
Definition: elm_mapbuf_eo.legacy.c:15
EAPI_MAIN int
elm_main(int argc EINA_UNUSED, char **argv EINA_UNUSED)
{
Evas_Object *win, *bx, *hbx, *tg, *ck, *mb, *tb, *ic;
unsigned int i, j;
elm_policy_set(ELM_POLICY_QUIT, ELM_POLICY_QUIT_LAST_WINDOW_CLOSED);
win = elm_win_util_standard_add("mapbuf", "Mapbuf Example");
elm_win_autodel_set(win, EINA_TRUE);
bx = elm_box_add(win);
evas_object_size_hint_weight_set(bx, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
elm_win_resize_object_add(win, bx);
evas_object_show(bx);
mb = elm_mapbuf_add(win);
evas_object_size_hint_weight_set(mb, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
evas_object_size_hint_align_set(mb, EVAS_HINT_FILL, EVAS_HINT_FILL);
elm_box_pack_end(bx, mb);
tb = elm_table_add(win);
evas_object_size_hint_weight_set(tb, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
evas_object_size_hint_align_set(tb, EVAS_HINT_FILL, EVAS_HINT_FILL);
evas_object_show(tb);
for (i = 0; i < 8; i++)
{
for (j = 0; j < 8; j++)
{
ic = elm_icon_add(win);
elm_icon_standard_set(ic, "home");
elm_image_resizable_set(ic, EINA_FALSE, EINA_FALSE);
evas_object_show(ic);
elm_table_pack(tb, ic, i, j, 1, 1);
}
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
EVAS_HINT_FILL
#define EVAS_HINT_FILL
Use with evas_object_size_hint_align_set(), evas_object_size_hint_align_get(), evas_object_size_hint_...
Definition: Evas_Common.h:298
EINA_FALSE
#define EINA_FALSE
boolean value FALSE (numerical value 0)
Definition: eina_types.h:533
elm_box_add
Evas_Object * elm_box_add(Evas_Object *parent)
Add a new box to the parent.
Definition: elm_box.c:363
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_icon_add
Evas_Object * elm_icon_add(Evas_Object *parent)
Add a new icon object to the parent.
Definition: elm_icon.c:613
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:885
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:2656
elm_mapbuf_add
Evas_Object * elm_mapbuf_add(Evas_Object *parent)
Add a new mapbuf widget to the given parent Elementary (container) object.
Definition: elm_mapbuf.c:310
elm_table_pack
void elm_table_pack(Elm_Table *obj, Efl_Canvas_Object *subobj, int column, int row, int colspan, int rowspan)
Add a subobject on the table with the coordinates passed.
Definition: elm_table_eo.legacy.c:57
elm_table_add
Evas_Object * elm_table_add(Evas_Object *parent)
Add a new table to the parent.
Definition: elm_table.c:134
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:8992
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:6189
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:9576
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_size_hint_align_set
EVAS_API void evas_object_size_hint_align_set(Evas_Object *obj, double x, double y)
Sets the hints for an object's alignment.
Definition: evas_object_main.c:2650

You'll see that disabling alpha blending will set a black rectangle below the icons. That's the reason you only should enable that when you're sure the mapbuf content is 100% solid.

See mapbuf_example.c, whose window should look like this picture: