1 #ifndef __DALI_TOOLKIT_IMAGE_VIEW_H__
2 #define __DALI_TOOLKIT_IMAGE_VIEW_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali-toolkit/public-api/controls/control.h>
25 #include <dali/public-api/images/image-operations.h>
33 namespace Internal DALI_INTERNAL
38 * @addtogroup dali_toolkit_controls_image_view
43 * @brief ImageView is a class for displaying an image resource.
45 * An instance of ImageView can be created using a URL or an Image instance.
50 class DALI_IMPORT_API ImageView : public Control
55 * @brief The start and end property ranges for this control.
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
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
68 * @brief An enumeration of properties belonging to the ImageView class.
75 // Event side properties
78 * @DEPRECATED_1_1.16. Use IMAGE instead.
79 * @brief name "resourceUrl", type string
82 RESOURCE_URL = PROPERTY_START_INDEX,
85 * @brief name "image", type string if it is a url, map otherwise
91 * @brief name "preMultipliedAlpha", type Boolean
93 * @pre image must be initialized.
97 // Animatable properties
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].
104 PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX,
111 * @brief Create an uninitialized ImageView.
117 * @brief Create an initialized ImageView.
120 * @return A handle to a newly allocated Dali ImageView.
122 * @note ImageView will not display anything.
124 static ImageView New();
127 * @brief Create an initialized ImageView from an Image instance.
129 * If the handle is empty, ImageView will not display anything.
132 * @param[in] image The Image instance to display.
133 * @return A handle to a newly allocated ImageView.
135 static ImageView New( Image image );
138 * @brief Create an initialized ImageView from an URL to an image resource.
140 * If the string is empty, ImageView will not display anything.
143 * @param[in] url The url of the image resource to display.
144 * @return A handle to a newly allocated ImageView.
146 static ImageView New( const std::string& url );
149 * @brief Create an initialized ImageView from a URL to an image resource.
151 * If the string is empty, ImageView will not display anything.
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.
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.
162 static ImageView New( const std::string& url, ImageDimensions size );
167 * This is non-virtual since derived Handle types must not contain data or virtual methods.
173 * @brief Copy constructor.
176 * @param[in] imageView ImageView to copy. The copied ImageView will point at the same implementation
178 ImageView( const ImageView& imageView );
181 * @brief Assignment operator.
184 * @param[in] imageView The ImageView to assign from.
185 * @return The updated ImageView.
187 ImageView& operator=( const ImageView& imageView );
190 * @brief Downcast a handle to ImageView handle.
192 * If handle points to a ImageView the downcast produces valid
193 * handle. If not the returned handle is left uninitialized.
196 * @param[in] handle Handle to an object
197 * @return handle to a ImageView or an uninitialized handle
199 static ImageView DownCast( BaseHandle handle );
202 * @brief Sets this ImageView from an Image instance.
204 * If the handle is empty, ImageView will display nothing
206 * @param[in] image The Image instance to display.
208 void SetImage( Image image );
211 * @brief Sets this ImageView from the given URL.
213 * If the URL is empty, ImageView will not display anything.
216 * @param[in] url The URL to the image resource to display.
218 void SetImage( const std::string& url );
221 * @brief Sets this ImageView from the given URL.
223 * If the URL is empty, ImageView will not display anything.
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.
229 void SetImage( const std::string& url, ImageDimensions size );
233 * @brief Gets the Image instance handle used by the ImageView.
235 * A valid handle will be returned only if this instance was created with New(Image) or SetImage(Image) was called.
238 * @return The Image instance currently used by the ImageView.
240 Image GetImage() const;
242 public: // Not intended for application developers
245 * @brief Creates a handle using the Toolkit::Internal implementation.
248 * @param[in] implementation The ImageView implementation.
250 DALI_INTERNAL ImageView( Internal::ImageView& implementation );
253 * @brief Allows the creation of this ImageView from an Internal::CustomActor pointer.
256 * @param[in] internal A pointer to the internal CustomActor.
258 DALI_INTERNAL ImageView( Dali::Internal::CustomActor* internal );
265 } // namespace Toolkit
269 #endif // __DALI_TOOLKIT_IMAGE_VIEW_H__