Merge "C# control dashboard demo" into devel/master

[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 bc401f1..7954884 100644 (file)
--- a/dali-toolkit/public-api/controls/image-view/image-view.h
+++ b/dali-toolkit/public-api/controls/image-view/image-view.h
@@ -70,6 +70,10 @@ public:
    */
   struct Property
   {
+    /**
+     * @brief An enumeration of properties belonging to the ImageView class.
+     * @SINCE_1_0.0
+     */
     enum
     {
       // Event side properties
@@ -125,6 +129,8 @@ public:
   static ImageView New();
 
   /**
+   * @DEPRECATED_1_2_8, use New( const std::string& ) instead.
+   *
    * @brief Create an initialized ImageView from an Image instance.
    *
    * If the handle is empty, ImageView will not display anything.
@@ -133,7 +139,7 @@ public:
    * @param[in] image The Image instance to display.
    * @return A handle to a newly allocated ImageView.
    */
-  static ImageView New( Image image );
+  static ImageView New( Image image ) DALI_DEPRECATED_API;
 
   /**
    * @brief Create an initialized ImageView from an URL to an image resource.
@@ -141,6 +147,8 @@ public:
    * If the string is empty, ImageView will not display anything.
    *
    * @SINCE_1_0.0
+   * @REMARK_INTERNET
+   * @REMARK_STORAGE
    * @param[in] url The url of the image resource to display.
    * @return A handle to a newly allocated ImageView.
    */
@@ -152,6 +160,8 @@ public:
    * If the string is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.10
+   * @REMARK_INTERNET
+   * @REMARK_STORAGE
    * @param[in] url The url of the image resource to display.
    * @param [in] size The width and height to which to fit the loaded image.
    * @return A handle to a newly allocated ImageView.
@@ -200,13 +210,15 @@ public:
   static ImageView DownCast( BaseHandle handle );
 
   /**
+   * @DEPRECATED_1_2_8, use SetImage( const std::string& ) instead.
+   *
    * @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 instance to display.
    */
-  void SetImage( Image image );
+  void SetImage( Image image ) DALI_DEPRECATED_API;
 
   /**
    * @brief Sets this ImageView from the given URL.
@@ -214,6 +226,8 @@ public:
    * If the URL is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.4
+   * @REMARK_INTERNET
+   * @REMARK_STORAGE
    * @param[in] url The URL to the image resource to display.
    */
   void SetImage( const std::string& url );
@@ -224,6 +238,8 @@ public:
    * If the URL is empty, ImageView will not display anything.
    *
    * @SINCE_1_1.10
+   * @REMARK_INTERNET
+   * @REMARK_STORAGE
    * @param[in] url The URL to the image resource to display.
    * @param [in] size The width and height to fit the loaded image to.
    */
@@ -238,10 +254,11 @@ public:
    * @SINCE_1_0.0
    * @return The Image instance currently used by the ImageView.
    */
-  Image GetImage() const;
+  Image GetImage() const DALI_DEPRECATED_API;
 
 public: // Not intended for application developers
 
+  /// @cond internal
   /**
    * @brief Creates a handle using the Toolkit::Internal implementation.
    *
@@ -257,6 +274,7 @@ public: // Not intended for application developers
    * @param[in]  internal  A pointer to the internal CustomActor.
    */
   DALI_INTERNAL ImageView( Dali::Internal::CustomActor* internal );
+  /// @endcond
 
 };