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) 2020 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       /**
 108        * @brief name "image", type string if it is a url, map otherwise.
 109        * @SINCE_1_0.0
 110        */
 111       IMAGE = PROPERTY_START_INDEX,
 112
 113       /**
 114        * @brief name "preMultipliedAlpha", type Boolean.
 115        * @SINCE_1_1.18
 116        * @pre image must be initialized.
 117        */
 118       PRE_MULTIPLIED_ALPHA,
 119
 120
 121       // Animatable properties
 122
 123       /**
 124        * @brief name "pixelArea", type Vector4.
 125        * @details Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
 126        * @SINCE_1_1.18
 127        */
 128       PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX,
 129     };
 130   };
 131
 132 public:
 133
 134   /**
 135    * @brief Creates an uninitialized ImageView.
 136    * @SINCE_1_0.0
 137    */
 138   ImageView();
 139
 140   /**
 141    * @brief Create an initialized ImageView.
 142    *
 143    * @SINCE_1_0.0
 144    * @return A handle to a newly allocated Dali ImageView
 145    *
 146    * @note ImageView will not display anything.
 147    */
 148   static ImageView New();
 149
 150   /**
 151    * @brief Creates an initialized ImageView from an URL to an image resource.
 152    *
 153    * If the string is empty, ImageView will not display anything.
 154    *
 155    * @SINCE_1_0.0
 156    * @REMARK_INTERNET
 157    * @REMARK_STORAGE
 158    * @param[in] url The url of the image resource to display
 159    * @return A handle to a newly allocated ImageView
 160    */
 161   static ImageView New( const std::string& url );
 162
 163   /**
 164    * @brief Creates an initialized ImageView from a URL to an image resource.
 165    *
 166    * If the string is empty, ImageView will not display anything.
 167    *
 168    * @SINCE_1_1.10
 169    * @REMARK_INTERNET
 170    * @REMARK_STORAGE
 171    * @param[in] url The url of the image resource to display
 172    * @param [in] size The width and height to which to fit the loaded image
 173    * @return A handle to a newly allocated ImageView
 174    * @note A valid size is preferable for efficiency.
 175    *       However, do not set a size that is bigger than the actual image size, as up-scaling is not available.
 176    *       The content of the area not covered by the actual image is undefined and will not be cleared.
 177    */
 178   static ImageView New( const std::string& url, ImageDimensions size );
 179
 180   /**
 181    * @brief Destructor.
 182    *
 183    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 184    * @SINCE_1_0.0
 185    */
 186   ~ImageView();
 187
 188   /**
 189    * @brief Copy constructor.
 190    *
 191    * @SINCE_1_0.0
 192    * @param[in] imageView ImageView to copy. The copied ImageView will point at the same implementation
 193    */
 194   ImageView( const ImageView& imageView );
 195
 196   /**
 197    * @brief Assignment operator.
 198    *
 199    * @SINCE_1_0.0
 200    * @param[in] imageView The ImageView to assign from
 201    * @return The updated ImageView
 202    */
 203   ImageView& operator=( const ImageView& imageView );
 204
 205   /**
 206    * @brief Downcasts a handle to ImageView handle.
 207    *
 208    * If handle points to a ImageView, the downcast produces valid handle.
 209    * If not, the returned handle is left uninitialized.
 210    *
 211    * @SINCE_1_0.0
 212    * @param[in] handle Handle to an object
 213    * @return Handle to a ImageView or an uninitialized handle
 214    */
 215   static ImageView DownCast( BaseHandle handle );
 216
 217   /**
 218    * @brief Sets this ImageView from the given URL.
 219    *
 220    * If the URL is empty, ImageView will not display anything.
 221    *
 222    * @SINCE_1_1.4
 223    * @REMARK_INTERNET
 224    * @REMARK_STORAGE
 225    * @param[in] url The URL to the image resource to display
 226    */
 227   void SetImage( const std::string& url );
 228
 229   /**
 230    * @brief Sets this ImageView from the given URL.
 231    *
 232    * If the URL is empty, ImageView will not display anything.
 233    *
 234    * @SINCE_1_1.10
 235    * @REMARK_INTERNET
 236    * @REMARK_STORAGE
 237    * @param[in] url The URL to the image resource to display
 238    * @param [in] size The width and height to fit the loaded image to
 239    */
 240   void SetImage( const std::string& url, ImageDimensions size );
 241
 242 public: // Not intended for application developers
 243
 244   /// @cond internal
 245   /**
 246    * @brief Creates a handle using the Toolkit::Internal implementation.
 247    *
 248    * @SINCE_1_0.0
 249    * @param[in] implementation The ImageView implementation
 250    */
 251   DALI_INTERNAL ImageView( Internal::ImageView& implementation );
 252
 253   /**
 254    * @brief Allows the creation of this ImageView from an Internal::CustomActor pointer.
 255    *
 256    * @SINCE_1_0.0
 257    * @param[in] internal A pointer to the internal CustomActor
 258    */
 259   DALI_INTERNAL ImageView( Dali::Internal::CustomActor* internal );
 260   /// @endcond
 261
 262 };
 263
 264 /**
 265  * @}
 266  */
 267 } // namespace Toolkit
 268
 269 } // namespace Dali
 270
 271 #endif // DALI_TOOLKIT_IMAGE_VIEW_H