END_TEST;
}
+
+int UtcDaliImageViewGetImageP1(void)
+{
+ ToolkitTestApplication application;
+
+ ImageView imageView = ImageView::New();
+ DALI_TEST_CHECK( ! imageView.GetImage() );
+
+ Image image = CreateBufferImage();
+ imageView.SetImage( image );
+ DALI_TEST_CHECK( imageView.GetImage() == image );
+
+ END_TEST;
+}
+
+int UtcDaliImageViewGetImageP2(void)
+{
+ ToolkitTestApplication application;
+
+ BufferImage image = CreateBufferImage();
+ ImageView imageView = ImageView::New( image );
+ DALI_TEST_CHECK( imageView.GetImage() == image );
+
+ END_TEST;
+}
+
+int UtcDaliImageViewGetImageN(void)
+{
+ ToolkitTestApplication application;
+
+ ImageView imageView = ImageView::New( TEST_IMAGE_FILE_NAME );
+ DALI_TEST_CHECK( ! imageView.GetImage() );
+
+ Image image = CreateBufferImage();
+ imageView.SetImage( image );
+ DALI_TEST_CHECK( imageView.GetImage() == image );
+
+ imageView.SetImage( TEST_IMAGE_FILE_NAME );
+ DALI_TEST_CHECK( ! imageView.GetImage() );
+
+ END_TEST;
+}
+
*/
/**
- * @brief ImageView is a class for displaying an Image.
+ * @brief ImageView is a class for displaying an image resource.
+ *
+ * An instance of ImageView can be created using a URL or an Image instance.
+ *
* @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
* @SINCE_1_0.0
*/
RESOURCE_URL = PROPERTY_START_INDEX,
+
/**
* @brief name "image", type string if it is a url, map otherwise
* @SINCE_1_0.0
*/
IMAGE,
+
/**
* @brief name "preMultipliedAlpha", type Boolean
* @SINCE_1_1.18
// Animatable properties
-
/**
* @brief name "pixelArea", type Vector4
* @details Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
static ImageView New();
/**
- * @brief Create an initialized ImageView from an Image.
+ * @brief Create an initialized ImageView from an Image instance.
*
* If the handle is empty, ImageView will not display anything.
*
* @SINCE_1_0.0
- * @param[in] image The Image to display.
+ * @param[in] image The Image instance 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 URL to an image resource.
*
* If the string is empty, ImageView will not display anything.
*
static ImageView New( const std::string& url );
/**
- * @brief Create an initialized ImageView from an Image resource URL
+ * @brief Create an initialized ImageView from a URL to an image resource.
*
* If the string is empty, ImageView will not display anything.
*
* @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.
+ * @param [in] size The width and height to which to fit the loaded image.
* @return A handle to a newly allocated ImageView.
*
* @note A valid size is preferable for efficiency.
static ImageView DownCast( BaseHandle handle );
/**
- * @brief Sets this ImageView from an Image
+ * @brief Sets this ImageView from an Image instance.
*
* If the handle is empty, ImageView will display nothing
* @SINCE_1_0.0
- * @param[in] image The Image to display.
+ * @param[in] image The Image instance to display.
*/
void SetImage( Image image );
/**
- * @brief Sets this ImageView from an Image URL
+ * @brief Sets this ImageView from the given URL.
*
* If the URL is empty, ImageView will not display anything.
*
* @SINCE_1_1.4
- * @param[in] url The Image resource to display.
+ * @param[in] url The URL to the image resource to display.
*/
void SetImage( const std::string& url );
/**
- * @brief Sets this ImageView from an Image URL
+ * @brief Sets this ImageView from the given URL.
*
* If the URL is empty, ImageView will not display anything.
*
* @SINCE_1_1.10
- * @param[in] url A URL to the image resource to display.
+ * @param[in] url The 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_1_1.4
- * @brief Gets the Image
+ * @brief Gets the Image instance handle used by the ImageView.
+ *
+ * A valid handle will be returned only if this instance was created with New(Image) or SetImage(Image) was called.
*
* @SINCE_1_0.0
- * @remarks Calls to this method should be avoided as this may return an empty handle if the image has not been created yet.
- * @return The Image currently set to this ImageView
+ * @return The Image instance currently used by the ImageView.
*/
Image GetImage() const;