Merge upstream with r75974

[framework/uifw/elementary.git] / src / lib / elm_mapbuf.h

diff --git a/src/lib/elm_mapbuf.h b/src/lib/elm_mapbuf.h
index 4522f0f..462d758 100644 (file)
--- a/src/lib/elm_mapbuf.h
+++ b/src/lib/elm_mapbuf.h
@@ -8,13 +8,18 @@
  * 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 interafce, with a lot of elements, and will
+ * 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).
  *
- * Default contents parts of the mapbuf widget that you can use for are:
+ * Default content parts of the mapbuf widget that you can use for are:
  * @li "default" - A content of the mapbuf
  *
+ * Supported elm_object common APIs.
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
+ *
  * To enable map, elm_mapbuf_enabled_set() should be used.
  *
  * See how to use this widget in this example:
@@ -37,59 +42,7 @@
  *
  * @ingroup Mapbuf
  */
-EAPI Evas_Object *
-                                  elm_mapbuf_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
-
-/**
- * Set the content of the mapbuf.
- *
- * @param obj The mapbuf object.
- * @param content The content that will be filled in this mapbuf object.
- *
- * Once the content object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_mapbuf_content_unset() function.
- *
- * To enable map, elm_mapbuf_enabled_set() should be used.
- *
- * @deprecated use elm_object_content_set() instead
- *
- * @ingroup Mapbuf
- */
-EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
-
-/**
- * Get the content of the mapbuf.
- *
- * @param obj The mapbuf object.
- * @return The content that is being used.
- *
- * Return the content object which is set for this widget.
- *
- * @see elm_mapbuf_content_set() for details.
- *
- * @deprecated use elm_object_content_get() instead
- *
- * @ingroup Mapbuf
- */
-EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-
-/**
- * Unset the content of the mapbuf.
- *
- * @param obj The mapbuf object.
- * @return The content that was being used.
- *
- * Unparent and return the content object which was set for this widget.
- *
- * @see elm_mapbuf_content_set() for details.
- *
- * @deprecated use elm_object_content_unset() instead
- *
- * @ingroup Mapbuf
- */
-EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Object                 *elm_mapbuf_add(Evas_Object *parent);
 
 /**
  * Enable or disable the map.
@@ -103,7 +56,7 @@ EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EIN
  *
  * 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 retangle will fill the content.
+ * 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.
@@ -115,7 +68,7 @@ EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EIN
  *
  * @ingroup Mapbuf
  */
-EAPI void                         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
+EAPI void                         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled);
 
 /**
  * Get a value whether map is enabled or not.
@@ -128,7 +81,7 @@ EAPI void                         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_
  *
  * @ingroup Mapbuf
  */
-EAPI Eina_Bool                    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                    elm_mapbuf_enabled_get(const Evas_Object *obj);
 
 /**
  * Enable or disable smooth map rendering.
@@ -145,7 +98,7 @@ EAPI Eina_Bool                    elm_mapbuf_enabled_get(const Evas_Object *obj)
  *
  * @ingroup Mapbuf
  */
-EAPI void                         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
+EAPI void                         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth);
 
 /**
  * Get a value whether smooth map rendering is enabled or not.
@@ -158,7 +111,7 @@ EAPI void                         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_B
  *
  * @ingroup Mapbuf
  */
-EAPI Eina_Bool                    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                    elm_mapbuf_smooth_get(const Evas_Object *obj);
 
 /**
  * Set or unset alpha flag for map rendering.
@@ -176,7 +129,7 @@ EAPI Eina_Bool                    elm_mapbuf_smooth_get(const Evas_Object *obj)
  *
  * @ingroup Mapbuf
  */
-EAPI void                         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
+EAPI void                         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha);
 
 /**
  * Get a value whether alpha blending is enabled or not.
@@ -189,7 +142,7 @@ EAPI void                         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bo
  *
  * @ingroup Mapbuf
  */
-EAPI Eina_Bool                    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool                    elm_mapbuf_alpha_get(const Evas_Object *obj);
 
 /**
  * @}