2 * @defgroup Mapbuf Mapbuf
5 * @image html img/widget/mapbuf/preview-00.png
6 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
8 * This holds one content object and uses an Evas Map of transformation
9 * points to be later used with this content. So the content will be
10 * moved, resized, etc as a single image. So it will improve performance
12 * when you have a complex interafce, with a lot of elements, and will
13 * need to resize or move it frequently (the content object and its
16 * Default contents parts of the mapbuf widget that you can use for are:
18 * when you have a complex interface, with a lot of elements, and will
19 * need to resize or move it frequently (the content object and its
22 * Default content parts of the mapbuf widget that you can use for are:
23 >>>>>>> remotes/origin/upstream
24 * @li "default" - A content of the mapbuf
26 * Supported elm_object common APIs.
27 * @li elm_object_part_content_set
28 * @li elm_object_part_content_get
29 * @li elm_object_part_content_unset
31 * To enable map, elm_mapbuf_enabled_set() should be used.
33 * See how to use this widget in this example:
43 * Add a new mapbuf widget to the given parent Elementary
46 * @param parent The parent object.
47 * @return A new mapbuf widget handle or @c NULL, on errors.
49 * This function inserts a new mapbuf widget on the canvas.
53 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent);
56 * Enable or disable the map.
58 * @param obj The mapbuf object.
59 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
61 * This enables the map that is set or disables it. On enable, the object
62 * geometry will be saved, and the new geometry will change (position and
63 * size) to reflect the map geometry set.
65 * Also, when enabled, alpha and smooth states will be used, so if the
66 * content isn't solid, alpha should be enabled, for example, otherwise
68 * a black retangle will fill the content.
70 * a black rectangle will fill the content.
71 >>>>>>> remotes/origin/upstream
73 * When disabled, the stored map will be freed and geometry prior to
74 * enabling the map will be restored.
76 * It's disabled by default.
78 * @see elm_mapbuf_alpha_set()
79 * @see elm_mapbuf_smooth_set()
83 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled);
86 * Get a value whether map is enabled or not.
88 * @param obj The mapbuf object.
89 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
90 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
92 * @see elm_mapbuf_enabled_set() for details.
96 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj);
99 * Enable or disable smooth map rendering.
101 * @param obj The mapbuf object.
102 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
105 * This sets smoothing for map rendering. If the object is a type that has
106 * its own smoothing settings, then both the smooth settings for this object
107 * and the map must be turned off.
109 * By default smooth maps are enabled.
113 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth);
116 * Get a value whether smooth map rendering is enabled or not.
118 * @param obj The mapbuf object.
119 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
120 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
122 * @see elm_mapbuf_smooth_set() for details.
126 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj);
129 * Set or unset alpha flag for map rendering.
131 * @param obj The mapbuf object.
132 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
135 * This sets alpha flag for map rendering. If the object is a type that has
136 * its own alpha settings, then this will take precedence. Only image objects
137 * have this currently. It stops alpha blending of the map area, and is
138 * useful if you know the object and/or all sub-objects is 100% solid.
140 * Alpha is enabled by default.
144 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha);
147 * Get a value whether alpha blending is enabled or not.
149 * @param obj The mapbuf object.
150 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
151 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
153 * @see elm_mapbuf_alpha_set() for details.
157 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj);