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