Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / images / resource-image.h

diff --git a/dali/public-api/images/resource-image.h b/dali/public-api/images/resource-image.h
index 8260241..da04bf0 100644 (file)
--- a/dali/public-api/images/resource-image.h
+++ b/dali/public-api/images/resource-image.h
@@ -45,20 +45,14 @@ class ResourceImage;
  * <h3>ResourceImage Loading</h3>
  *
  * When the ResourceImage is created, resource loading will be attempted unless
- * the ResourceImage is created with IMMEDIATE loading policy or a compatible resource is found in cache.
- * In case of loading images ON_DEMAND, resource loading will only be attempted if the associated ImageView
+ * the ResourceImage is created with ResourceImage::IMMEDIATE loading policy or a compatible resource is found in cache.
+ * In case of loading images ResourceImage::ON_DEMAND, resource loading will only be attempted if the associated Dali::Toolkit::ImageView
  * is put on Stage.
  * Scaling of images to a desired smaller size can be requested by providing desired dimensions,
  * scaling mode and filter mode to to ResourceImage::New().
  *
- * <i>LoadPolicies</i>
- * - IMMEDIATE: acquire image resource when creating ResourceImage.
- * - ON_DEMAND: only load in case the associated ImageView is put on Stage
- *
- * <i>Resolution of conflicting policies</i>
- * If the same image is created more than once with conflicting policies, LoadPolicy "IMMEDIATE" overrides "ON_DEMAND".
- *
  * <i>Custom load requests</i>
+ *
  * Size, scaling mode, filter mode, and orientation compensation can be set when requesting an image.
  *
  * <i>Compatible resources</i>
@@ -75,12 +69,8 @@ class ResourceImage;
  * If the file changed since the last load operation, this might result in a different resource.
  * Reload only takes effect if both of these conditions apply:
  * - The ResourceImage has already finished loading
- * - The ResourceImage is either on Stage or using IMMEDIATE load policy
+ * - The ResourceImage is either on Stage or using ResourceImage::IMMEDIATE load policy
  *
- * Signals
- * | %Signal Name           | Method                       |
- * |------------------------|------------------------------|
- * | image-loading-finished | @ref LoadingFinishedSignal() |
  * @since_tizen 2.4
  */
 class DALI_IMPORT_API ResourceImage : public Image
@@ -93,11 +83,13 @@ public:
   /**
    * @brief LoadPolicy controls the way images are loaded into memory.
    * @since_tizen 2.4
+   * @remarks This is an experimental feature and might not be supported in the next release.
+   * We do recommend not to use it.
    */
   enum LoadPolicy
   {
-    IMMEDIATE, ///< load image once it is created (default)
-    ON_DEMAND  ///< delay loading until the image is being used (a related actor is added to Stage)
+    IMMEDIATE, ///< Load image once it is created (default) @since_tizen 2.4
+    ON_DEMAND  ///< Delay loading until the image is being used (a related actor is added to Stage) @since_tizen 2.4
   };
 
   /**
@@ -182,6 +174,9 @@ public:
    * @since_tizen 2.4
    * @privlevel public
    * @privilege %http://tizen.org/privilege/internet
+   * @remarks ResourceImage::LoadPolicy and Image::ReleasePolicy are experimental features and might not be supported in the next release.
+   * We do recommend not to use this method.
+   * Please refer the Remarks of ResourceImage::LoadPolicy and Image::ReleasePolicy for more information.
    * @remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address.
    * @param [in] url The URL of the image file to use (can be a local file path, http or https address).
    * @param [in] loadPol    The LoadPolicy to apply when loading the image resource.
@@ -217,6 +212,9 @@ public:
    * @since_tizen 2.4
    * @privlevel public
    * @privilege %http://tizen.org/privilege/internet
+   * @remarks LoadPolicy and ReleasePolicy are experimental features and might not be supported in the next release.
+   * We do recommend not to use this method.
+   * Please refer the Remarks of LoadPolicy and ReleasePolicy for more information.
    * @remarks %http://tizen.org/privilege/internet is needed if @a url is a http or https address.
    * @param [in] url The URL of the image file to use (can be a local file path, http or https address).
    * @param [in] loadPol    The LoadPolicy to apply when loading the image resource.
@@ -238,13 +236,13 @@ public:
   ///@}
 
   /**
-   * @brief Downcast an Object handle to ResourceImage handle.
+   * @brief Downcast a handle to ResourceImage handle.
    *
    * If handle points to a ResourceImage object the
    * downcast produces valid handle. If not the returned handle is left uninitialized.
    * @since_tizen 2.4
-   * @param[in] handle to An object
-   * @return handle to a Image object or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a Image object or an uninitialized handle
    */
   static ResourceImage DownCast( BaseHandle handle );
 
@@ -252,7 +250,9 @@ public:
    * @brief Return load policy.
    *
    * @since_tizen 2.4
-   * @return resource load policy
+   * @remarks This is an experimental feature and might not be supported in the next release.
+   * We do recommend not to use it.
+   * @return Resource load policy
    */
   LoadPolicy GetLoadPolicy() const;