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) 2017 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  * @SINCE_1_0.0
  48  *
  49  */
  50 class DALI_IMPORT_API ImageView : public Control
  51 {
  52 public:
  53
  54   /**
  55    * @brief Enumeration for the start and end property ranges for this control.
  56    * @SINCE_1_0.0
  57    */
  58   enum PropertyRange
  59   {
  60     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,  ///< @SINCE_1_0.0
  61     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000,              ///< Reserve property indices @SINCE_1_0.0
  62
  63     ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX,        ///< @SINCE_1_1.18
  64     ANIMATABLE_PROPERTY_END_INDEX =   ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000  ///< Reserve animatable property indices, @SINCE_1_1.18
  65   };
  66
  67   /**
  68    * @brief Enumeration for the instance of properties belonging to the ImageView class.
  69    * @SINCE_1_0.0
  70    */
  71   struct Property
  72   {
  73     /**
  74      * @brief Enumeration for the instance of properties belonging to the ImageView class.
  75      * @SINCE_1_0.0
  76      */
  77     enum
  78     {
  79       // Event side properties
  80
  81       /**
  82        * @DEPRECATED_1_1.16. Use IMAGE instead.
  83        * @brief name "resourceUrl", type string.
  84        * @SINCE_1_0.0
  85        */
  86       RESOURCE_URL = PROPERTY_START_INDEX,
  87
  88       /**
  89        * @brief name "image", type string if it is a url, map otherwise.
  90        * @SINCE_1_0.0
  91        */
  92       IMAGE,
  93
  94       /**
  95        * @brief name "preMultipliedAlpha", type Boolean.
  96        * @SINCE_1_1.18
  97        * @pre image must be initialized.
  98        */
  99       PRE_MULTIPLIED_ALPHA,
 100
 101
 102       // Animatable properties
 103
 104       /**
 105        * @brief name "pixelArea", type Vector4.
 106        * @details Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
 107        * @SINCE_1_1.18
 108        */
 109       PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX,
 110     };
 111   };
 112
 113 public:
 114
 115   /**
 116    * @brief Creates an uninitialized ImageView.
 117    * @SINCE_1_0.0
 118    */
 119   ImageView();
 120
 121   /**
 122    * @brief Create an initialized ImageView.
 123    *
 124    * @SINCE_1_0.0
 125    * @return A handle to a newly allocated Dali ImageView
 126    *
 127    * @note ImageView will not display anything.
 128    */
 129   static ImageView New();
 130
 131   /**
 132    * @brief Creates an initialized ImageView from an Image instance.
 133    *
 134    * If the handle is empty, ImageView will not display anything.
 135    *
 136    * @SINCE_1_0.0
 137    * @param[in] image The Image instance to display
 138    * @return A handle to a newly allocated ImageView
 139    */
 140   static ImageView New( Image image );
 141
 142   /**
 143    * @brief Creates an initialized ImageView from an URL to an image resource.
 144    *
 145    * If the string is empty, ImageView will not display anything.
 146    *
 147    * @SINCE_1_0.0
 148    * @REMARK_INTERNET
 149    * @REMARK_STORAGE
 150    * @param[in] url The url of the image resource to display
 151    * @return A handle to a newly allocated ImageView
 152    */
 153   static ImageView New( const std::string& url );
 154
 155   /**
 156    * @brief Creates an initialized ImageView from a URL to an image resource.
 157    *
 158    * If the string is empty, ImageView will not display anything.
 159    *
 160    * @SINCE_1_1.10
 161    * @REMARK_INTERNET
 162    * @REMARK_STORAGE
 163    * @param[in] url The url of the image resource to display
 164    * @param [in] size The width and height to which to fit the loaded image
 165    * @return A handle to a newly allocated ImageView
 166    * @note A valid size is preferable for efficiency.
 167    *       However, do not set a size that is bigger than the actual image size, as up-scaling is not available.
 168    *       The content of the area not covered by the actual image is undefined and will not be cleared.
 169    */
 170   static ImageView New( const std::string& url, ImageDimensions size );
 171
 172   /**
 173    * @brief Destructor.
 174    *
 175    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 176    * @SINCE_1_0.0
 177    */
 178   ~ImageView();
 179
 180   /**
 181    * @brief Copy constructor.
 182    *
 183    * @SINCE_1_0.0
 184    * @param[in] imageView ImageView to copy. The copied ImageView will point at the same implementation
 185    */
 186   ImageView( const ImageView& imageView );
 187
 188   /**
 189    * @brief Assignment operator.
 190    *
 191    * @SINCE_1_0.0
 192    * @param[in] imageView The ImageView to assign from
 193    * @return The updated ImageView
 194    */
 195   ImageView& operator=( const ImageView& imageView );
 196
 197   /**
 198    * @brief Downcasts a handle to ImageView handle.
 199    *
 200    * If handle points to a ImageView, the downcast produces valid handle.
 201    * If not, the returned handle is left uninitialized.
 202    *
 203    * @SINCE_1_0.0
 204    * @param[in] handle Handle to an object
 205    * @return Handle to a ImageView or an uninitialized handle
 206    */
 207   static ImageView DownCast( BaseHandle handle );
 208
 209   /**
 210    * @brief Sets this ImageView from an Image instance.
 211    *
 212    * If the handle is empty, ImageView will display nothing
 213    * @SINCE_1_0.0
 214    * @param[in] image The Image instance to display.
 215    */
 216   void SetImage( Image image );
 217
 218   /**
 219    * @brief Sets this ImageView from the given URL.
 220    *
 221    * If the URL is empty, ImageView will not display anything.
 222    *
 223    * @SINCE_1_1.4
 224    * @REMARK_INTERNET
 225    * @REMARK_STORAGE
 226    * @param[in] url The URL to the image resource to display
 227    */
 228   void SetImage( const std::string& url );
 229
 230   /**
 231    * @brief Sets this ImageView from the given URL.
 232    *
 233    * If the URL is empty, ImageView will not display anything.
 234    *
 235    * @SINCE_1_1.10
 236    * @REMARK_INTERNET
 237    * @REMARK_STORAGE
 238    * @param[in] url The URL to the image resource to display
 239    * @param [in] size The width and height to fit the loaded image to
 240    */
 241   void SetImage( const std::string& url, ImageDimensions size );
 242
 243   /**
 244    * @brief Gets the Image instance handle used by the ImageView.
 245    *
 246    * A valid handle will be returned only if this instance was created with New(Image) or SetImage(Image) was called.
 247    *
 248    * @SINCE_1_0.0
 249    * @return The Image instance currently used by the ImageView
 250    */
 251   Image GetImage() const;
 252
 253 public: // Not intended for application developers
 254
 255   /**
 256    * @internal
 257    * @brief Creates a handle using the Toolkit::Internal implementation.
 258    *
 259    * @SINCE_1_0.0
 260    * @param[in] implementation The ImageView implementation
 261    */
 262   DALI_INTERNAL ImageView( Internal::ImageView& implementation );
 263
 264   /**
 265    * @internal
 266    * @brief Allows the creation of this ImageView from an Internal::CustomActor pointer.
 267    *
 268    * @SINCE_1_0.0
 269    * @param[in] internal A pointer to the internal CustomActor
 270    */
 271   DALI_INTERNAL ImageView( Dali::Internal::CustomActor* internal );
 272
 273 };
 274
 275 /**
 276  * @}
 277  */
 278 } // namespace Toolkit
 279
 280 } // namespace Dali
 281
 282 #endif // __DALI_TOOLKIT_IMAGE_VIEW_H__