*/
/**
- *
* @brief ImageView is a class for displaying an Image.
+ * @SINCE_1_0.0
+ *
*/
class DALI_IMPORT_API ImageView : public Control
{
public:
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_0.0
- 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
+ ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_1.18
+ ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices, @SINCE_1_1.18
};
/**
* @brief An enumeration of properties belonging to the ImageView class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
// 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.
+ RESOURCE_URL = PROPERTY_START_INDEX, ///< name "resourceUrl", @deprecated DALi 1.1.16 Use IMAGE instead. type string @SINCE_1_0.0
+ IMAGE, ///< name "image", @see SetImage(), type string if it is a url, map otherwise @SINCE_1_0.0
+ PRE_MULTIPLIED_ALPHA, ///< name "preMultipliedAlpha", type Boolean @pre image must be initialized. @SINCE_1_1.18
// 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].
+ PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX, ///< name "pixelArea", type Vector4, Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0]. @SINCE_1_1.18
};
};
/**
* @brief Create an uninitialized ImageView.
+ * @SINCE_1_0.0
*/
ImageView();
/**
* @brief Create an initialized ImageView.
*
+ * @SINCE_1_0.0
* @return A handle to a newly allocated Dali ImageView.
*
* @note ImageView will not display anything.
*
* If the handle is empty, ImageView will not display anything.
*
+ * @SINCE_1_0.0
* @param[in] image The Image to display.
* @return A handle to a newly allocated ImageView.
*/
*
* If the string is empty, ImageView will not display anything.
*
+ * @SINCE_1_0.0
* @param[in] url The url of the image resource to display.
* @return A handle to a newly allocated ImageView.
*/
*
* If the string is empty, ImageView will not display anything.
*
- * @since DALi 1.1.10
- *
+ * @SINCE_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.
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~ImageView();
/**
* @brief Copy constructor.
*
+ * @SINCE_1_0.0
* @param[in] imageView ImageView to copy. The copied ImageView will point at the same implementation
*/
ImageView( const ImageView& imageView );
/**
* @brief Assignment operator.
*
+ * @SINCE_1_0.0
* @param[in] imageView The ImageView to assign from.
* @return The updated ImageView.
*/
* If handle points to a ImageView the downcast produces valid
* handle. If not the returned handle is left uninitialized.
*
+ * @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return handle to a ImageView or an uninitialized handle
*/
* @brief Sets this ImageView from an Image
*
* If the handle is empty, ImageView will display nothing
+ * @SINCE_1_0.0
* @param[in] image The Image to display.
*/
void SetImage( Image image );
*
* If the URL is empty, ImageView will not display anything.
*
- * @since DALi 1.1.4
- *
+ * @SINCE_1_1.4
* @param[in] url The Image resource to display.
*/
void SetImage( const std::string& url );
*
* If the URL is empty, ImageView will not display anything.
*
- * @since DALi 1.1.10
- *
+ * @SINCE_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.
*/
/**
* @deprecated Gets the Image
*
+ * @SINCE_1_0.0
* @return The Image currently set to this ImageView
*/
Image GetImage() const;
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The ImageView implementation.
*/
DALI_INTERNAL ImageView( Internal::ImageView& implementation );
/**
* @brief Allows the creation of this ImageView from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
DALI_INTERNAL ImageView( Dali::Internal::CustomActor* internal );