#include <dali-toolkit/public-api/controls/control.h>
// EXTERNAL INCLUDES
-#include <dali/devel-api/rendering/renderer.h>
+#include <dali/public-api/images/image-operations.h>
namespace Dali
{
{
class ImageView;
}
+/**
+ * @addtogroup dali_toolkit_controls_image_view
+ * @{
+ */
/**
*
enum PropertyRange
{
PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices
+
+ ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @since DALi 1.1.18
+ ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices, @since DALi 1.1.18
};
/**
{
enum
{
- RESOURCE_URL = PROPERTY_START_INDEX, ///< name "resource-url", @see SetImage(), type string
+ // Event side properties
+ RESOURCE_URL = PROPERTY_START_INDEX, ///< name "resourceUrl", @deprecated DALi 1.1.16 Use IMAGE instead. type string
+ IMAGE, ///< name "image", @see SetImage(), type string if it is a url, map otherwise
+ PRE_MULTIPLIED_ALPHA, ///< name "preMultipliedAlpha", @since DALi 1.1.18 type Boolean @pre image must be initialized.
+
+ // Animatable properties
+ PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX, ///< name "pixelArea", @since DALi 1.1.18 type Vector4, Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
};
};
* @brief Create an initialized ImageView.
*
* @return A handle to a newly allocated Dali ImageView.
+ *
+ * @note ImageView will not display anything.
*/
static ImageView New();
/**
* @brief Create an initialized ImageView from an Image.
*
- * If the handle is empty, ImageView will display nothing
+ * If the handle is empty, ImageView will not display anything.
+ *
* @param[in] image The Image to display.
* @return A handle to a newly allocated ImageView.
*/
static ImageView New( Image image );
/**
- * @brief Create an initialized ImageView from an Image resource url
+ * @brief Create an initialized ImageView from an Image resource URL
+ *
+ * If the string is empty, ImageView will not display anything.
*
- * If the string is empty, ImageView will display nothing
* @param[in] url The url of the image resource to display.
* @return A handle to a newly allocated ImageView.
*/
static ImageView New( const std::string& url );
/**
+ * @brief Create an initialized ImageView from an Image resource URL
+ *
+ * If the string is empty, ImageView will not display anything.
+ *
+ * @since DALi 1.1.10
+ *
+ * @param[in] url The url of the image resource to display.
+ * @param [in] size The width and height to fit the loaded image to.
+ * @return A handle to a newly allocated ImageView.
+ *
+ * @note A valid size is preferable for efficiency.
+ * However, do not set a size that is bigger than the actual image size, as up-scaling is not available.
+ * The content of the area not covered by the actual image is undefined and will not be cleared.
+ */
+ static ImageView New( const std::string& url, ImageDimensions size );
+
+ /**
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
void SetImage( Image image );
/**
- * @brief Gets the Image
+ * @brief Sets this ImageView from an Image URL
+ *
+ * If the URL is empty, ImageView will not display anything.
+ *
+ * @since DALi 1.1.4
+ *
+ * @param[in] url The Image resource to display.
+ */
+ void SetImage( const std::string& url );
+
+ /**
+ * @brief Sets this ImageView from an Image URL
+ *
+ * If the URL is empty, ImageView will not display anything.
+ *
+ * @since DALi 1.1.10
+ *
+ * @param[in] url A URL to the image resource to display.
+ * @param [in] size The width and height to fit the loaded image to.
+ */
+ void SetImage( const std::string& url, ImageDimensions size );
+
+ /**
+ * @deprecated Gets the Image
*
* @return The Image currently set to this ImageView
*/
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali