/**
* @defgroup Image Image
+ * @ingroup Elementary
*
* @image html img/widget/image/preview-00.png
* @image latex img/widget/image/preview-00.eps
*/
/**
- * @enum _Elm_Image_Orient
- * @typedef Elm_Image_Orient
- *
* Possible orientation options for elm_image_orient_set().
*
* @image html elm_image_orient_set.png
*
* @ingroup Image
*/
-typedef enum _Elm_Image_Orient
+typedef enum
{
ELM_IMAGE_ORIENT_NONE = 0, /**< no orientation change */
ELM_IMAGE_ORIENT_0 = 0, /**< no orientation change */
ELM_IMAGE_ROTATE_90 = 1, /**< rotate 90 degrees clockwise */
ELM_IMAGE_ROTATE_180 = 2, /**< rotate 180 degrees clockwise */
ELM_IMAGE_ROTATE_270 = 3, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
- // XXX: remove
- /*EINA_DEPRECATED */ ELM_IMAGE_ROTATE_90_CW = 1,
- /**< rotate 90 degrees clockwise */
- // XXX: remove
- /*EINA_DEPRECATED */ ELM_IMAGE_ROTATE_180_CW = 2,
- /**< rotate 180 degrees clockwise */
- // XXX: remove
- /*EINA_DEPRECATED */ ELM_IMAGE_ROTATE_90_CCW = 3,
- /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
ELM_IMAGE_FLIP_HORIZONTAL = 4, /**< flip image horizontally */
ELM_IMAGE_FLIP_VERTICAL = 5, /**< flip image vertically */
ELM_IMAGE_FLIP_TRANSPOSE = 6, /**< flip the image along the y = (width - x) line (bottom-left to top-right) */
*
* @ingroup Image
*/
-EAPI Evas_Object *
- elm_image_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_image_add(Evas_Object *parent);
/**
* Set the file that will be used as image.
*
* @ingroup Image
*/
-EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
+EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group);
/**
* Get the file that will be used as image.
*
* @ingroup Image
*/
-EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
+EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group);
/**
* Set the smooth effect for an image.
*
* @ingroup Image
*/
-EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
+EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth);
/**
* Get the smooth effect for an image.
*
* @ingroup Image
*/
-EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj);
/**
* Gets the current size of the image.
*
* 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) EINA_ARG_NONNULL(1);
+EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h);
/**
* Disable scaling of this object.
* 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
*/
-EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
+EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale);
/**
* Get whether scaling is disabled on the object.
*
* @ingroup Image
*/
-EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+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) EINA_ARG_NONNULL(1);
+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) EINA_ARG_NONNULL(1);
+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.
* and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
*
* @note This option will have no effect if
- * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
+ * elm_image_aspect_fixed_set() is set to @c EINA_FALSE.
*
* @see elm_image_fill_outside_get()
- * @see elm_image_aspect_ratio_retained_set()
+ * @see elm_image_aspect_fixed_set()
*
* @ingroup Image
*/
-EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
+EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside);
/**
* Get if the object is filled outside
*
* @ingroup Image
*/
-EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+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
*
* @ingroup Image
*/
-EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
+EAPI void elm_image_prescale_set(Evas_Object *obj, int size);
/**
* Get the prescale size for the image
*
* @ingroup Image
*/
-EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI int elm_image_prescale_get(const Evas_Object *obj);
/**
* Set the image orientation.
*
* @ingroup Image
*/
-EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
+EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient);
/**
* Get the image orientation.
*
* @ingroup Image
*/
-EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj);
/**
* Make the image 'editable'.
*
* @ingroup Image
*/
-EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
+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.
*
* @ingroup Image
*/
-EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+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
*
* @ingroup Image
*/
-EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj);
/**
* Set whether the original aspect ratio of the image should be kept on resize.
*
* @param obj The image object.
- * @param retained @c EINA_TRUE if the image should retain the aspect,
+ * @param fixed @c EINA_TRUE if the image should retain the aspect,
* @c EINA_FALSE otherwise.
*
* The original aspect ratio (width / height) of the image is usually
* this original aspect, and the way that the image is fit into the object's
* area depends on the option set by elm_image_fill_outside_set().
*
- * @see elm_image_aspect_ratio_retained_get()
+ * @see elm_image_aspect_fixed_get()
* @see elm_image_fill_outside_set()
*
* @ingroup Image
*/
-EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
+EAPI void elm_image_aspect_fixed_set(Evas_Object *obj, Eina_Bool fixed);
/**
* Get if the object retains the original aspect ratio.
*
* @ingroup Image
*/
-EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool elm_image_aspect_fixed_get(const Evas_Object *obj);
/**
* @}
projects / framework / uifw / elementary.git / blobdiff