1 #ifndef DALI_TOOLKIT_IMAGE_VIEW_H
2 #define DALI_TOOLKIT_IMAGE_VIEW_H
5 * Copyright (c) 2023 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>
31 namespace Internal DALI_INTERNAL
36 * @addtogroup dali_toolkit_controls_image_view
41 * @brief ImageView is a class for displaying an image resource.
43 * An instance of ImageView can be created using a URL or an Image instance.
45 * Some resources can be loaded before the ImageView is staged ( already cached ), in these cases if the connection to
46 * ResouceReadySignal is done after the resource is set then signal will be missed.
48 * To protect against this, IsResourceReady() can be checked before connecting to ResourceReadySignal,
49 * or the signal connection can be done before setting the resource.
52 * auto myImageView = ImageView::New( resourceUrl );
53 * if ( myImageView.IsResourceReady() )
59 * myImageView.ResourceReadySignal.Connect( .... )
63 * OR Connect to signal before setting resource
66 * auto myImageView = ImageView::New();
67 * myImageView.ResourceReadySignal.Connect( .... )
68 * myImageView.SetProperty( ImageView::Property::IMAGE, resourceUrl );
74 class DALI_TOOLKIT_API ImageView : public Control
78 * @brief Enumeration for the start and end property ranges for this control.
83 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
84 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_0.0
86 ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_1.18
87 ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices, @SINCE_1_1.18
91 * @brief Enumeration for the instance of properties belonging to the ImageView class.
97 * @brief Enumeration for the instance of properties belonging to the ImageView class.
102 // Event side properties
105 * @brief name "image", type string if it is a url, map otherwise.
108 IMAGE = PROPERTY_START_INDEX,
111 * @brief name "preMultipliedAlpha", type Boolean.
113 * @pre image must be initialized.
115 PRE_MULTIPLIED_ALPHA,
118 * @brief name "placeholderImage", type string.
120 * placeholder image is shown when image view is waiting for the image to load.
126 * @brief name "enableTransitionEffect", type Boolean
128 * This effect is a crossfade effect when the image is replaced.
129 * the default duration of the crossfade effect is 1.5 seconds.
130 * if the placeholder is enabled, the cross effect applies when the image is changed from a placeholder image to a new image.
131 * if not, the cross effect applies when a new image is shown or is changed from the previous image to a new image.
134 ENABLE_TRANSITION_EFFECT,
136 // Animatable properties
139 * @brief name "pixelArea", type Vector4.
140 * @details Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
143 PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX,
149 * @brief Creates an uninitialized ImageView.
155 * @brief Create an initialized ImageView.
158 * @return A handle to a newly allocated Dali ImageView
160 * @note ImageView will not display anything.
162 static ImageView New();
165 * @brief Creates an initialized ImageView from an URL to an image resource.
167 * If the string is empty, ImageView will not display anything.
172 * @param[in] url The url of the image resource to display
173 * @return A handle to a newly allocated ImageView
175 static ImageView New(const std::string& url);
178 * @brief Creates an initialized ImageView from a URL to an image resource.
180 * If the string is empty, ImageView will not display anything.
185 * @param[in] url The url of the image resource to display
186 * @param [in] size The width and height to which to fit the loaded image
187 * @return A handle to a newly allocated ImageView
188 * @note A valid size is preferable for efficiency.
189 * However, do not set a size that is bigger than the actual image size, as up-scaling is not available.
190 * The content of the area not covered by the actual image is undefined and will not be cleared.
192 static ImageView New(const std::string& url, ImageDimensions size);
195 * @brief Create an initialized ImageView with additional behaviour.
198 * @param[in] additionalBehaviour Additional control behaviour
199 * @return A handle to a newly allocated Dali ImageView
201 * @note ImageView will not display anything.
203 static ImageView New(ControlBehaviour additionalBehaviour);
206 * @brief Creates an initialized ImageView from an URL to an image resource with additional behaviour.
208 * If the string is empty, ImageView will not display anything.
213 * @param[in] additionalBehaviour Additional control behaviour
214 * @param[in] url The url of the image resource to display
215 * @return A handle to a newly allocated ImageView
217 static ImageView New(ControlBehaviour additionalBehaviour, const std::string& url);
220 * @brief Creates an initialized ImageView from a URL to an image resource with additional behaviour.
222 * If the string is empty, ImageView will not display anything.
227 * @param[in] additionalBehaviour Additional control behaviour
228 * @param[in] url The url of the image resource to display
229 * @param[in] size The width and height to which to fit the loaded image
230 * @return A handle to a newly allocated ImageView
231 * @note A valid size is preferable for efficiency.
232 * However, do not set a size that is bigger than the actual image size, as up-scaling is not available.
233 * The content of the area not covered by the actual image is undefined and will not be cleared.
235 static ImageView New(ControlBehaviour additionalBehaviour, const std::string& url, ImageDimensions size);
240 * This is non-virtual since derived Handle types must not contain data or virtual methods.
246 * @brief Copy constructor.
249 * @param[in] imageView ImageView to copy. The copied ImageView will point at the same implementation
251 ImageView(const ImageView& imageView);
254 * @brief Move constructor
257 * @param[in] rhs A reference to the moved handle
259 ImageView(ImageView&& rhs) noexcept;
262 * @brief Assignment operator.
265 * @param[in] imageView The ImageView to assign from
266 * @return The updated ImageView
268 ImageView& operator=(const ImageView& imageView);
271 * @brief Move assignment
274 * @param[in] rhs A reference to the moved handle
275 * @return A reference to this
277 ImageView& operator=(ImageView&& rhs) noexcept;
280 * @brief Downcasts a handle to ImageView handle.
282 * If handle points to a ImageView, the downcast produces valid handle.
283 * If not, the returned handle is left uninitialized.
286 * @param[in] handle Handle to an object
287 * @return Handle to a ImageView or an uninitialized handle
289 static ImageView DownCast(BaseHandle handle);
292 * @brief Sets this ImageView from the given URL.
294 * If the URL is empty, ImageView will not display anything.
299 * @param[in] url The URL to the image resource to display
301 void SetImage(const std::string& url);
304 * @brief Sets this ImageView from the given URL.
306 * If the URL is empty, ImageView will not display anything.
311 * @param[in] url The URL to the image resource to display
312 * @param [in] size The width and height to fit the loaded image to
314 void SetImage(const std::string& url, ImageDimensions size);
316 public: // Not intended for application developers
319 * @brief Creates a handle using the Toolkit::Internal implementation.
322 * @param[in] implementation The ImageView implementation
324 DALI_INTERNAL ImageView(Internal::ImageView& implementation);
327 * @brief Allows the creation of this ImageView from an Internal::CustomActor pointer.
330 * @param[in] internal A pointer to the internal CustomActor
332 DALI_INTERNAL ImageView(Dali::Internal::CustomActor* internal);
339 } // namespace Toolkit
343 #endif // DALI_TOOLKIT_IMAGE_VIEW_H