1 #ifndef __DALI_TOOLKIT_CONTROL_H__
2 #define __DALI_TOOLKIT_CONTROL_H__
5 * Copyright (c) 2017 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/public-api/actors/custom-actor.h>
23 #include <dali/public-api/common/dali-common.h>
24 #include <dali/public-api/events/long-press-gesture-detector.h>
25 #include <dali/public-api/events/pan-gesture-detector.h>
26 #include <dali/public-api/events/pinch-gesture-detector.h>
27 #include <dali/public-api/events/tap-gesture-detector.h>
28 #include <dali/public-api/events/tap-gesture-detector.h>
29 #include <dali/public-api/images/image.h>
32 #include <dali-toolkit/public-api/visuals/visual-properties.h>
40 //Forward declarations.
47 * @addtogroup dali_toolkit_controls
52 * @brief Control is the base class for all controls.
54 * The implementation of the control must be supplied; see Internal::Control for more details.
56 * @see Internal::Control
59 * | %Signal Name | Method |
60 * |------------------------|-----------------------------------------------------|
61 * | keyEvent | @ref KeyEventSignal() |
62 * | keyInputFocusGained | @ref KeyInputFocusGainedSignal() |
63 * | keyInputFocusLost | @ref KeyInputFocusLostSignal() |
64 * | resourceReady | @ref ResourceReadySignal() |
65 * | tapped | @ref GetTapGestureDetector().DetectedSignal() |
66 * | panned | @ref GetPanGestureDetector().DetectedSignal() |
67 * | pinched | @ref GetPinchGestureDetector().DetectedSignal() |
68 * | longPressed | @ref GetLongPressGestureDetector().DetectedSignal() |
71 * | %Action Name | %Control method called |
72 * |------------------------|----------------------------------------------------|
73 * | accessibilityActivated | %OnAccessibilityActivated() |
75 class DALI_IMPORT_API Control : public CustomActor
80 * @brief Enumeration for the start and end property ranges for control.
85 PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX, ///< Start index is used by the property registration macro. @SINCE_1_0.0
86 CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX, ///< Start index of Control properties. @SINCE_1_0.0
87 CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices. @SINCE_1_0.0
91 * @brief Enumeration for the instance of properties belonging to the Control class.
97 * @brief Enumeration for the instance of properties belonging to the Control class.
103 * @brief The name of the style to be applied to the control.
104 * @details Name "styleName", type Property::STRING.
105 * @see Toolkit::Control::SetStyleName()
108 STYLE_NAME = PROPERTY_START_INDEX,
112 * @brief The background color of the control.
114 * Mutually exclusive with BACKGROUND_IMAGE & BACKGROUND.
115 * @details Name "backgroundColor", type Property::VECTOR4.
116 * @see Toolkit::Control::SetStyleName()
123 * @brief The background image of the control.
125 * Mutually exclusive with BACKGROUND_COLOR & BACKGROUND.
126 * @details Name "backgroundImage", type Property::MAP.
132 * @brief Receives key events to the control.
133 * @details Name "keyInputFocus", type Property::BOOLEAN.
134 * @see Toolkit::Control::SetKeyInputFocus()
140 * @brief The background of the control.
142 * Mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE.
143 * @details Name "background", type Property::MAP or std::string for URL or Property::VECTOR4 for Color.
149 * @brief The outer space around the control.
150 * @details Name "margin", type Property::EXTENTS.
152 * @note Margin property is to be supported by Layout algorithms and containers in future.
157 * @brief The inner space of the control.
158 * @details Name "padding", type Property::EXTENTS.
166 * @brief Describes the direction to move the keyboard focus towards.
172 * @brief Keyboard focus direction.
177 LEFT, ///< Move keyboard focus towards the left direction @SINCE_1_0.0
178 RIGHT, ///< Move keyboard focus towards the right direction @SINCE_1_0.0
179 UP, ///< Move keyboard focus towards the up direction @SINCE_1_0.0
180 DOWN, ///< Move keyboard focus towards the down direction @SINCE_1_0.0
181 PAGE_UP, ///< Move keyboard focus towards the previous page direction @SINCE_1_2.14
182 PAGE_DOWN ///< Move keyboard focus towards the next page direction @SINCE_1_2.14
188 /// @brief Key Event signal type. @SINCE_1_0.0
189 typedef Signal<bool ( Control, const KeyEvent& ) > KeyEventSignalType;
191 /// @brief Key InputFocusType signal type. @SINCE_1_0.0
192 typedef Signal<void ( Control ) > KeyInputFocusSignalType;
194 /// @brief ResourceReady signal type. @SINCE_1_2.60
195 typedef Signal<void ( Control ) > ResourceReadySignalType;
197 public: // Creation & Destruction
200 * @brief Creates a new instance of a Control.
203 * @return A handle to a new Control
205 static Control New();
208 * @brief Creates an uninitialized Control handle.
210 * Only derived versions can be instantiated. Calling member
211 * functions with an uninitialized Dali::Object is not allowed.
217 * @brief Copy constructor.
219 * Creates another handle that points to the same real object.
221 * @param[in] uiControl Handle to copy
223 Control(const Control& uiControl);
226 * @brief Dali::Control is intended as a base class.
228 * This is non-virtual since derived Handle types must not contain data or virtual methods.
236 * @brief Assignment operator.
238 * Changes this handle to point to another real object.
240 * @param[in] handle Object to assign this to
241 * @return Reference to this
243 Control& operator=( const Control& handle );
248 * @brief Downcasts a handle to Control handle.
250 * If handle points to a Control, the downcast produces valid handle.
251 * If not, the returned handle is left uninitialized.
254 * @param[in] handle Handle to an object
255 * @return A handle to a Control or an uninitialized handle
257 static Control DownCast( BaseHandle handle );
262 * @brief This sets the control to receive key events.
264 * The key event can originate from a virtual or physical keyboard.
266 * @pre The Control has been initialized.
267 * @pre The Control should be on the stage before setting keyboard focus.
269 void SetKeyInputFocus();
272 * @brief Quries whether the control has key input focus.
275 * @return true if this control has keyboard input focus
276 * @pre The Control has been initialized.
277 * @pre The Control should be on the stage before setting keyboard focus.
278 * @note The control can be set to have the focus and still not receive all the key events if another control has over ridden it.
279 * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
280 * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
281 * controls above it in the focus stack.
282 * To query for the control which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().
284 bool HasKeyInputFocus();
287 * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
289 * A check is performed to ensure it was previously set, if this check fails then nothing is done.
291 * @pre The Actor has been initialized.
293 void ClearKeyInputFocus();
298 * @brief Retrieves the pinch gesture detector of the control.
301 * @return The pinch gesture detector
302 * @note Will return an empty handle if the control does not handle the gesture itself.
304 PinchGestureDetector GetPinchGestureDetector() const;
307 * @brief Retrieves the pan gesture detector of the control.
310 * @return The pan gesture detector
311 * @note Will return an empty handle if the control does not handle the gesture itself.
313 PanGestureDetector GetPanGestureDetector() const;
316 * @brief Retrieves the tap gesture detector of the control.
319 * @return The tap gesture detector
320 * @note Will return an empty handle if the control does not handle the gesture itself.
322 TapGestureDetector GetTapGestureDetector() const;
325 * @brief Retrieves the long press gesture detector of the control.
328 * @return The long press gesture detector
329 * @note Will return an empty handle if the control does not handle the gesture itself.
331 LongPressGestureDetector GetLongPressGestureDetector() const;
336 * @brief Sets the name of the style to be applied to the control.
339 * @param[in] styleName A string matching a style described in a stylesheet
341 void SetStyleName( const std::string& styleName );
344 * @brief Retrieves the name of the style to be applied to the control (if any).
346 * @return A string matching a style, or an empty string
348 const std::string& GetStyleName() const;
353 * @brief Sets the background color of the control.
356 * @param[in] color The required background color of the control
358 * @note If SetBackgroundImage is called later, this background color is removed.
360 * @note The background color fully blends with the actor color.
362 void SetBackgroundColor( const Vector4& color );
367 * @brief Retrieves the background color of the control.
370 * @return The background color of the control
372 Vector4 GetBackgroundColor() const DALI_DEPRECATED_API;
375 * @DEPRECATED_1_2_8, use Property::BACKGROUND instead
377 * @brief Sets an image as the background of the control.
380 * @param[in] image The image to set as the background
382 void SetBackgroundImage( Image image ) DALI_DEPRECATED_API;
385 * @brief Clears the background.
388 void ClearBackground();
393 * @brief Query if all resources required by a control are loaded and ready.
395 * Most resources are only loaded when the control is placed on stage.
397 * @return true if the resources are loaded and ready, false otherwise
399 bool IsResourceReady() const;
402 * @brief Get the loading state of the visual resource.
405 * @param[in] index The Property index of the visual
406 * @return Return the loading status (PREPARING, READY and FAILED) of visual resource
408 Visual::ResourceStatus GetVisualResourceStatus( const Dali::Property::Index index );
413 * @brief This signal is emitted when key event is received.
415 * A callback of the following type may be connected:
417 * bool YourCallbackName(Control control, const KeyEvent& event);
419 * The return value of True, indicates that the event should be consumed.
420 * Otherwise the signal will be emitted on the next parent of the actor.
422 * @return The signal to connect to
423 * @pre The Control has been initialized.
425 KeyEventSignalType& KeyEventSignal();
428 * @brief This signal is emitted when the control gets Key Input Focus.
430 * A callback of the following type may be connected:
432 * bool YourCallbackName( Control control );
434 * The return value of True, indicates that the event should be consumed.
435 * Otherwise the signal will be emitted on the next parent of the actor.
437 * @return The signal to connect to
438 * @pre The Control has been initialized.
440 KeyInputFocusSignalType& KeyInputFocusGainedSignal();
443 * @brief This signal is emitted when the control loses Key Input Focus.
445 * This could be due to it being gained by another Control or Actor or just cleared from
446 * this control as no longer required.
448 * A callback of the following type may be connected:
450 * bool YourCallbackName( Control control );
452 * The return value of True, indicates that the event should be consumed.
453 * Otherwise the signal will be emitted on the next parent of the actor.
455 * @return The signal to connect to
456 * @pre The Control has been initialized.
458 KeyInputFocusSignalType& KeyInputFocusLostSignal();
461 * @brief This signal is emitted after all resources required by a control are loaded and ready.
463 * Most resources are only loaded when the control is placed on stage.
465 * If resources are shared between ImageViews, they are cached.
466 * In this case, the ResourceReady signal may be sent before there is an object to connect to.
467 * To protect against this, IsResourceReady() can be checked first.
470 * auto newControl = Control::New();
471 * newControl.SetResource( resourceUrl );
472 * if ( newControl.IsResourceReady() )
478 * newControl.ResourceReadySignal.Connect( .... )
482 * A callback of the following type may be connected:
484 * void YourCallbackName( Control control );
488 * @return The signal to connect to
489 * @note A RelayoutRequest is queued by Control before this signal is emitted
491 ResourceReadySignalType& ResourceReadySignal();
493 public: // Intended for control developers
496 * @brief Creates an initialized Control.
499 * @param[in] implementation The implementation for this control
500 * @return A handle to a newly allocated Dali resource
501 * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
503 explicit Control(Internal::Control& implementation);
506 * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
507 * using an Internal CustomActor pointer.
510 * @param[in] internal A pointer to a newly allocated Dali resource
512 explicit Control(Dali::Internal::CustomActor* internal);
514 public: // Templates for Deriving Classes
517 * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
519 * @tparam T The handle class
520 * @tparam I The implementation class
522 * @param[in] handle Handle to an object
523 * @return Handle to a class T or an uninitialized handle
524 * @see DownCast(BaseHandle)
526 template<typename T, typename I>
527 DALI_INTERNAL static T DownCast( BaseHandle handle )
531 CustomActor custom = Dali::CustomActor::DownCast( handle );
534 CustomActorImpl& customImpl = custom.GetImplementation();
536 I* impl = dynamic_cast<I*>(&customImpl);
540 result = T(customImpl.GetOwner());
548 * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
549 * implementation of their class.
551 * @tparam I The implementation class
553 * @param[in] internal Pointer to the Internal::CustomActor
556 DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
558 // Can have a NULL pointer so we only need to check if the internal implementation is our class
559 // when there is a value.
562 DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
571 } // namespace Toolkit
575 #endif // __DALI_TOOLKIT_CONTROL_H__