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