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.
98 // Animatable properties
101 * @brief name "pixelArea", type Vector4
102 * @details Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
105 PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX,
112 * @brief Create an uninitialized ImageView.
118 * @brief Create an initialized ImageView.
121 * @return A handle to a newly allocated Dali ImageView.
123 * @note ImageView will not display anything.
125 static ImageView New();
128 * @DEPRECATED_1_2.8, use New( const std::string& ) instead.
130 * @brief Create an initialized ImageView from an Image instance.
132 * If the handle is empty, ImageView will not display anything.
135 * @param[in] image The Image instance to display.
136 * @return A handle to a newly allocated ImageView.
138 static ImageView New( Image image );
141 * @brief Create an initialized ImageView from an URL to an image resource.
143 * If the string is empty, ImageView will not display anything.
146 * @param[in] url The url of the image resource to display.
147 * @return A handle to a newly allocated ImageView.
149 static ImageView New( const std::string& url );
152 * @brief Create an initialized ImageView from a URL to an image resource.
154 * If the string is empty, ImageView will not display anything.
157 * @param[in] url The url of the image resource to display.
158 * @param [in] size The width and height to which to fit the loaded image.
159 * @return A handle to a newly allocated ImageView.
161 * @note A valid size is preferable for efficiency.
162 * However, do not set a size that is bigger than the actual image size, as up-scaling is not available.
163 * The content of the area not covered by the actual image is undefined and will not be cleared.
165 static ImageView New( const std::string& url, ImageDimensions size );
170 * This is non-virtual since derived Handle types must not contain data or virtual methods.
176 * @brief Copy constructor.
179 * @param[in] imageView ImageView to copy. The copied ImageView will point at the same implementation
181 ImageView( const ImageView& imageView );
184 * @brief Assignment operator.
187 * @param[in] imageView The ImageView to assign from.
188 * @return The updated ImageView.
190 ImageView& operator=( const ImageView& imageView );
193 * @brief Downcast a handle to ImageView handle.
195 * If handle points to a ImageView the downcast produces valid
196 * handle. If not the returned handle is left uninitialized.
199 * @param[in] handle Handle to an object
200 * @return handle to a ImageView or an uninitialized handle
202 static ImageView DownCast( BaseHandle handle );
205 * @DEPRECATED_1_2.8, use SetImage( const std::string& ) instead.
207 * @brief Sets this ImageView from an Image instance.
209 * If the handle is empty, ImageView will display nothing
211 * @param[in] image The Image instance to display.
213 void SetImage( Image image );
216 * @brief Sets this ImageView from the given URL.
218 * If the URL is empty, ImageView will not display anything.
221 * @param[in] url The URL to the image resource to display.
223 void SetImage( const std::string& url );
226 * @brief Sets this ImageView from the given URL.
228 * If the URL is empty, ImageView will not display anything.
231 * @param[in] url The URL to the image resource to display.
232 * @param [in] size The width and height to fit the loaded image to.
234 void SetImage( const std::string& url, ImageDimensions size );
238 * @brief Gets the Image instance handle used by the ImageView.
240 * A valid handle will be returned only if this instance was created with New(Image) or SetImage(Image) was called.
243 * @return The Image instance currently used by the ImageView.
245 Image GetImage() const;
247 public: // Not intended for application developers
251 * @brief Creates a handle using the Toolkit::Internal implementation.
254 * @param[in] implementation The ImageView implementation.
256 DALI_INTERNAL ImageView( Internal::ImageView& implementation );
259 * @brief Allows the creation of this ImageView from an Internal::CustomActor pointer.
262 * @param[in] internal A pointer to the internal CustomActor.
264 DALI_INTERNAL ImageView( Dali::Internal::CustomActor* internal );
272 } // namespace Toolkit
276 #endif // __DALI_TOOLKIT_IMAGE_VIEW_H__