dali-toolkit/public-api/controls/image-view/image-view.h

   1 #ifndef DALI_TOOLKIT_IMAGE_VIEW_H
   2 #define DALI_TOOLKIT_IMAGE_VIEW_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 // EXTERNAL INCLUDES
  25 #include <dali/public-api/images/image-operations.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Toolkit
  31 {
  32
  33 namespace Internal DALI_INTERNAL
  34 {
  35 class ImageView;
  36 }
  37 /**
  38  * @addtogroup dali_toolkit_controls_image_view
  39  * @{
  40  */
  41
  42 /**
  43  * @brief ImageView is a class for displaying an image resource.
  44  *
  45  * An instance of ImageView can be created using a URL or an Image instance.
  46  *
  47  * Some resources can be loaded before the ImageView is staged ( already cached ), in these cases if the connection to
  48  * ResouceReadySignal is done after the resource is set then signal will be missed.
  49  *
  50  * To protect against this, IsResourceReady() can be checked before connecting to ResourceReadySignal,
  51  * or the signal connection can be done before setting the resource.
  52  *
  53  * @code
  54  *    auto myImageView = ImageView::New( resourceUrl );
  55  *    if ( myImageView.IsResourceReady() )
  56  *    {
  57  *       // do something
  58  *    }
  59  *    else
  60  *    {
  61  *      myImageView.ResourceReadySignal.Connect( .... )
  62  *    }
  63  * @endcode
  64  *
  65  * OR Connect to signal before setting resource
  66  *
  67  * @code
  68  *    auto myImageView = ImageView::New();
  69  *    myImageView.ResourceReadySignal.Connect( .... )
  70  *    myImageView.SetProperty( ImageView::Property::IMAGE, resourceUrl );
  71  * @endcode
  72  *
  73  * @SINCE_1_0.0
  74  *
  75  */
  76 class DALI_TOOLKIT_API ImageView : public Control
  77 {
  78 public:
  79
  80   /**
  81    * @brief Enumeration for the start and end property ranges for this control.
  82    * @SINCE_1_0.0
  83    */
  84   enum PropertyRange
  85   {
  86     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,  ///< @SINCE_1_0.0
  87     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000,              ///< Reserve property indices @SINCE_1_0.0
  88
  89     ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX,        ///< @SINCE_1_1.18
  90     ANIMATABLE_PROPERTY_END_INDEX =   ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000  ///< Reserve animatable property indices, @SINCE_1_1.18
  91   };
  92
  93   /**
  94    * @brief Enumeration for the instance of properties belonging to the ImageView class.
  95    * @SINCE_1_0.0
  96    */
  97   struct Property
  98   {
  99     /**
 100      * @brief Enumeration for the instance of properties belonging to the ImageView class.
 101      * @SINCE_1_0.0
 102      */
 103     enum
 104     {
 105       // Event side properties
 106
 107       RESERVED_PROPERTY_01 = PROPERTY_START_INDEX, ///< Reserved index for a removed property.
 108
 109       /**
 110        * @brief name "image", type string if it is a url, map otherwise.
 111        * @SINCE_1_0.0
 112        */
 113       IMAGE,
 114
 115       /**
 116        * @brief name "preMultipliedAlpha", type Boolean.
 117        * @SINCE_1_1.18
 118        * @pre image must be initialized.
 119        */
 120       PRE_MULTIPLIED_ALPHA,
 121
 122
 123       // Animatable properties
 124
 125       /**
 126        * @brief name "pixelArea", type Vector4.
 127        * @details Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
 128        * @SINCE_1_1.18
 129        */
 130       PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX,
 131     };
 132   };
 133
 134 public:
 135
 136   /**
 137    * @brief Creates an uninitialized ImageView.
 138    * @SINCE_1_0.0
 139    */
 140   ImageView();
 141
 142   /**
 143    * @brief Create an initialized ImageView.
 144    *
 145    * @SINCE_1_0.0
 146    * @return A handle to a newly allocated Dali ImageView
 147    *
 148    * @note ImageView will not display anything.
 149    */
 150   static ImageView New();
 151
 152   /**
 153    * @DEPRECATED_1_2_8, use New( const std::string& ) instead.
 154    *
 155    * @brief Creates an initialized ImageView from an Image instance.
 156    *
 157    * If the handle is empty, ImageView will not display anything.
 158    *
 159    * @SINCE_1_0.0
 160    * @param[in] image The Image instance to display
 161    * @return A handle to a newly allocated ImageView
 162    */
 163   static ImageView New( Image image ) DALI_DEPRECATED_API;
 164
 165   /**
 166    * @brief Creates an initialized ImageView from an URL to an image resource.
 167    *
 168    * If the string is empty, ImageView will not display anything.
 169    *
 170    * @SINCE_1_0.0
 171    * @REMARK_INTERNET
 172    * @REMARK_STORAGE
 173    * @param[in] url The url of the image resource to display
 174    * @return A handle to a newly allocated ImageView
 175    */
 176   static ImageView New( const std::string& url );
 177
 178   /**
 179    * @brief Creates an initialized ImageView from a URL to an image resource.
 180    *
 181    * If the string is empty, ImageView will not display anything.
 182    *
 183    * @SINCE_1_1.10
 184    * @REMARK_INTERNET
 185    * @REMARK_STORAGE
 186    * @param[in] url The url of the image resource to display
 187    * @param [in] size The width and height to which to fit the loaded image
 188    * @return A handle to a newly allocated ImageView
 189    * @note A valid size is preferable for efficiency.
 190    *       However, do not set a size that is bigger than the actual image size, as up-scaling is not available.
 191    *       The content of the area not covered by the actual image is undefined and will not be cleared.
 192    */
 193   static ImageView New( const std::string& url, ImageDimensions size );
 194
 195   /**
 196    * @brief Destructor.
 197    *
 198    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 199    * @SINCE_1_0.0
 200    */
 201   ~ImageView();
 202
 203   /**
 204    * @brief Copy constructor.
 205    *
 206    * @SINCE_1_0.0
 207    * @param[in] imageView ImageView to copy. The copied ImageView will point at the same implementation
 208    */
 209   ImageView( const ImageView& imageView );
 210
 211   /**
 212    * @brief Assignment operator.
 213    *
 214    * @SINCE_1_0.0
 215    * @param[in] imageView The ImageView to assign from
 216    * @return The updated ImageView
 217    */
 218   ImageView& operator=( const ImageView& imageView );
 219
 220   /**
 221    * @brief Downcasts a handle to ImageView handle.
 222    *
 223    * If handle points to a ImageView, the downcast produces valid handle.
 224    * If not, the returned handle is left uninitialized.
 225    *
 226    * @SINCE_1_0.0
 227    * @param[in] handle Handle to an object
 228    * @return Handle to a ImageView or an uninitialized handle
 229    */
 230   static ImageView DownCast( BaseHandle handle );
 231
 232   /**
 233    * @DEPRECATED_1_2_8, use SetImage( const std::string& ) instead.
 234    *
 235    * @brief Sets this ImageView from an Image instance.
 236    *
 237    * If the handle is empty, ImageView will display nothing
 238    * @SINCE_1_0.0
 239    * @param[in] image The Image instance to display.
 240    */
 241   void SetImage( Image image ) DALI_DEPRECATED_API;
 242
 243   /**
 244    * @brief Sets this ImageView from the given URL.
 245    *
 246    * If the URL is empty, ImageView will not display anything.
 247    *
 248    * @SINCE_1_1.4
 249    * @REMARK_INTERNET
 250    * @REMARK_STORAGE
 251    * @param[in] url The URL to the image resource to display
 252    */
 253   void SetImage( const std::string& url );
 254
 255   /**
 256    * @brief Sets this ImageView from the given URL.
 257    *
 258    * If the URL is empty, ImageView will not display anything.
 259    *
 260    * @SINCE_1_1.10
 261    * @REMARK_INTERNET
 262    * @REMARK_STORAGE
 263    * @param[in] url The URL to the image resource to display
 264    * @param [in] size The width and height to fit the loaded image to
 265    */
 266   void SetImage( const std::string& url, ImageDimensions size );
 267
 268   /**
 269    * @DEPRECATED_1_1.4
 270    * @brief Gets the Image instance handle used by the ImageView.
 271    *
 272    * A valid handle will be returned only if this instance was created with New(Image) or SetImage(Image) was called.
 273    *
 274    * @SINCE_1_0.0
 275    * @return The Image instance currently used by the ImageView
 276    */
 277   Image GetImage() const DALI_DEPRECATED_API;
 278
 279 public: // Not intended for application developers
 280
 281   /// @cond internal
 282   /**
 283    * @brief Creates a handle using the Toolkit::Internal implementation.
 284    *
 285    * @SINCE_1_0.0
 286    * @param[in] implementation The ImageView implementation
 287    */
 288   DALI_INTERNAL ImageView( Internal::ImageView& implementation );
 289
 290   /**
 291    * @brief Allows the creation of this ImageView from an Internal::CustomActor pointer.
 292    *
 293    * @SINCE_1_0.0
 294    * @param[in] internal A pointer to the internal CustomActor
 295    */
 296   DALI_INTERNAL ImageView( Dali::Internal::CustomActor* internal );
 297   /// @endcond
 298
 299 };
 300
 301 /**
 302  * @}
 303  */
 304 } // namespace Toolkit
 305
 306 } // namespace Dali
 307
 308 #endif // DALI_TOOLKIT_IMAGE_VIEW_H