(ImageView) Restore erroneously removed APIs & Fix SetImage behaviour

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / image-view / image-view.h

diff --git a/dali-toolkit/public-api/controls/image-view/image-view.h b/dali-toolkit/public-api/controls/image-view/image-view.h
index 4a7545e..f3b5416 100644 (file)
--- a/dali-toolkit/public-api/controls/image-view/image-view.h
+++ b/dali-toolkit/public-api/controls/image-view/image-view.h
@@ -77,32 +77,47 @@ public:
    * @brief Create an initialized ImageView.
    *
    * @return A handle to a newly allocated Dali ImageView.
    * @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.
    *
    */
   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 );
 
   /**
    * @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

    *
    *

-   * @note A valid size is preferable for efficiency.
-   *       However, do not set size that is bigger than the actual image size, as the up-scaling is not available,
-   *       the content of the area not covered by actual image is undefined, it will not be cleared.
+   * If the string is empty, ImageView will not display anything.
+   *
+   * @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

    *
    *

-   * If the string is empty, ImageView will display nothing

    * @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.
    * @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 = ImageDimensions() );
+  static ImageView New( const std::string& url, ImageDimensions size );

 
   /**
    * @brief Destructor
 
   /**
    * @brief Destructor


@@ -146,17 +161,27 @@ public:
   void SetImage( Image image );
 
   /**
   void SetImage( Image image );
 
   /**

-   * @brief Sets this ImageView from an Image url
+   * @brief Sets this ImageView from an Image URL

    *
    *

-   * If the handle is empty, ImageView will display nothing
+   * If the URL is empty, ImageView will not display anything.

    *
    * @since DALi 1.1.4
    *
    * @param[in] url The Image resource to display.
    *
    * @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.
    */
    * @param [in] size The width and height to fit the loaded image to.
    */

-  void SetImage( const std::string& url,
-                 ImageDimensions size = ImageDimensions() );
+  void SetImage( const std::string& url, ImageDimensions size );

 
   /**
    * @deprecated Gets the Image
 
   /**
    * @deprecated Gets the Image