Add APIs for floating mode (app-in-app)

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

diff --git a/src/lib/elm_image.h b/src/lib/elm_image.h
index bcc13eb..59a904f 100644 (file)
--- a/src/lib/elm_image.h
+++ b/src/lib/elm_image.h
@@ -1,5 +1,6 @@
 /**
  * @defgroup Image Image
+ * @ingroup Elementary
  *
  * @image html img/widget/image/preview-00.png
  * @image latex img/widget/image/preview-00.eps
@@ -134,8 +135,6 @@ EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj);
  *
  * This is the real size of the image, not the size of the object.
  *
- * On error, neither w and h will be fileld with 0.
- *
  * @ingroup Image
  */
 EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h);
@@ -150,10 +149,10 @@ EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w,
  * This function disables scaling of the elm_image widget through the
  * function elm_object_scale_set(). However, this does not affect the widget
  * size/resize in any way. For that effect, take a look at
- * elm_image_scale_set().
+ * elm_image_resizable_set().
  *
  * @see elm_image_no_scale_get()
- * @see elm_image_scale_set()
+ * @see elm_image_resizable_set()
  * @see elm_object_scale_set()
  *
  * @ingroup Image
@@ -176,33 +175,33 @@ EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj);
  * Set if the object is (up/down) resizable.
  *
  * @param obj The image object
- * @param scale_up A bool to set if the object is resizable up. Default is
+ * @param size_up A bool to set if the object is resizable up. Default is
  * @c EINA_TRUE.
- * @param scale_down A bool to set if the object is resizable down. Default
+ * @param size_down A bool to set if the object is resizable down. Default
  * is @c EINA_TRUE.
  *
- * This function limits the image resize ability. If @p scale_up is set to
+ * This function limits the image resize ability. If @p size_up is set to
  * @c EINA_FALSE, the object can't have its height or width resized to a value
- * higher than the original image size. Same is valid for @p scale_down.
+ * higher than the original image size. Same is valid for @p size_down.
  *
- * @see elm_image_scale_get()
+ * @see elm_image_resizable_get()
  *
  * @ingroup Image
  */
-EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down);
+EAPI void             elm_image_resizable_set(Evas_Object *obj, Eina_Bool size_up, Eina_Bool size_down);
 
 /**
  * Get if the object is (up/down) resizable.
  *
  * @param obj The image object
- * @param scale_up A bool to set if the object is resizable up
- * @param scale_down A bool to set if the object is resizable down
+ * @param size_up A bool to set if the object is resizable up
+ * @param size_down A bool to set if the object is resizable down
  *
- * @see elm_image_scale_set()
+ * @see elm_image_resizable_set()
  *
  * @ingroup Image
  */
-EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down);
+EAPI void             elm_image_resizable_get(const Evas_Object *obj, Eina_Bool *size_up, Eina_Bool *size_down);
 
 /**
  * Set if the image fills the entire object area, when keeping the aspect ratio.
@@ -240,6 +239,15 @@ EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fil
 EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj);
 
 /**
+ * Enable or disable preloading of the image
+ *
+ * @param obj The image object
+ * @param disabled If EINA_TRUE, preloading will be disabled
+ * @ingroup Icon
+ */
+EAPI void                  elm_image_preload_disabled_set(Evas_Object *obj, Eina_Bool disabled);
+
+/**
  * Set the prescale size for the image
  *
  * @param obj The image object
@@ -318,7 +326,7 @@ EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj);
 EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set);
 
 /**
- * Check if the image 'editable'.
+ * Check if the image is 'editable'.
  *
  * @param obj Image object.
  * @return Editability.
@@ -331,7 +339,7 @@ EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set);
 EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj);
 
 /**
- * Get the basic Evas_Image object from this object (widget).
+ * Get the inlined image object of the image widget.
  *
  * @param obj The image object to get the inlined image from
  * @return The inlined image object, or NULL if none exists