Mapbuf

Functions

Evas_Object * elm_mapbuf_add (Evas_Object *parent)
 Add a new mapbuf widget to the given parent Elementary (container) object.
void elm_mapbuf_enabled_set (Evas_Object *obj, Eina_Bool enabled)
 Enable or disable the map.
Eina_Bool elm_mapbuf_enabled_get (const Evas_Object *obj)
 Get a value whether map is enabled or not.
void elm_mapbuf_smooth_set (Evas_Object *obj, Eina_Bool smooth)
 Enable or disable smooth map rendering.
Eina_Bool elm_mapbuf_smooth_get (const Evas_Object *obj)
 Get a value whether smooth map rendering is enabled or not.
void elm_mapbuf_alpha_set (Evas_Object *obj, Eina_Bool alpha)
 Set or unset alpha flag for map rendering.
Eina_Bool elm_mapbuf_alpha_get (const Evas_Object *obj)
 Get a value whether alpha blending is enabled or not.

Detailed Description

mapbuf_inheritance_tree.png
preview-00.png

This holds one content object and uses an Evas Map of transformation points to be later used with this content. So the content will be moved, resized, etc as a single image. So it will improve performance when you have a complex interface, with a lot of elements, and will need to resize or move it frequently (the content object and its children).

This widget inherits from The Elementary Container Class, so that the functions meant to act on it will work for mapbuf objects:

Default content parts of the mapbuf widget that you can use are:

  • "default" - The main content of the mapbuf

To enable map, elm_mapbuf_enabled_set() should be used.

See how to use this widget in this example: Mapbuf Widget Example


Function Documentation

Evas_Object* elm_mapbuf_add ( Evas_Object *  parent)

Add a new mapbuf widget to the given parent Elementary (container) object.

Parameters:
parentThe parent object.
Returns:
A new mapbuf widget handle or NULL, on errors.

This function inserts a new mapbuf widget on the canvas.

Eina_Bool elm_mapbuf_alpha_get ( const Evas_Object *  obj)

Get a value whether alpha blending is enabled or not.

Parameters:
objThe mapbuf object.
Returns:
EINA_TRUE means alpha blending is enabled. EINA_FALSE indicates it's disabled. If obj is NULL, EINA_FALSE is returned.
See also:
elm_mapbuf_alpha_set() for details.
void elm_mapbuf_alpha_set ( Evas_Object *  obj,
Eina_Bool  alpha 
)

Set or unset alpha flag for map rendering.

Parameters:
objThe mapbuf object.
alphaEINA_TRUE to enable alpha blending or EINA_FALSE to disable it.

This sets alpha flag for map rendering. If the object is a type that has its own alpha settings, then this will take precedence. Only image objects have this currently. It stops alpha blending of the map area, and is useful if you know the object and/or all sub-objects is 100% solid.

Alpha is enabled by default.

Eina_Bool elm_mapbuf_enabled_get ( const Evas_Object *  obj)

Get a value whether map is enabled or not.

Parameters:
objThe mapbuf object.
Returns:
EINA_TRUE means map is enabled. EINA_FALSE indicates it's disabled. If obj is NULL, EINA_FALSE is returned.
See also:
elm_mapbuf_enabled_set() for details.
void elm_mapbuf_enabled_set ( Evas_Object *  obj,
Eina_Bool  enabled 
)

Enable or disable the map.

Parameters:
objThe mapbuf object.
enabledEINA_TRUE to enable map or EINA_FALSE to disable it.

This enables the map that is set or disables it. On enable, the object geometry will be saved, and the new geometry will change (position and size) to reflect the map geometry set.

Also, when enabled, alpha and smooth states will be used, so if the content isn't solid, alpha should be enabled, for example, otherwise a black rectangle will fill the content.

When disabled, the stored map will be freed and geometry prior to enabling the map will be restored.

It's disabled by default.

See also:
elm_mapbuf_alpha_set()
elm_mapbuf_smooth_set()
Eina_Bool elm_mapbuf_smooth_get ( const Evas_Object *  obj)

Get a value whether smooth map rendering is enabled or not.

Parameters:
objThe mapbuf object.
Returns:
EINA_TRUE means smooth map rendering is enabled. EINA_FALSE indicates it's disabled. If obj is NULL, EINA_FALSE is returned.
See also:
elm_mapbuf_smooth_set() for details.
void elm_mapbuf_smooth_set ( Evas_Object *  obj,
Eina_Bool  smooth 
)

Enable or disable smooth map rendering.

Parameters:
objThe mapbuf object.
smoothEINA_TRUE to enable smooth map rendering or EINA_FALSE to disable it.

This sets smoothing for map rendering. If the object is a type that has its own smoothing settings, then both the smooth settings for this object and the map must be turned off.

By default smooth maps are enabled.