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>
37 //Forward declarations.
44 * @addtogroup dali_toolkit_controls
49 * @brief Control is the base class for all controls.
51 * The implementation of the control must be supplied; see Internal::Control for more details.
53 * @see Internal::Control
56 * | %Signal Name | Method |
57 * |------------------------|-----------------------------------------------------|
58 * | keyEvent | @ref KeyEventSignal() |
59 * | keyInputFocusGained | @ref KeyInputFocusGainedSignal() |
60 * | keyInputFocusLost | @ref KeyInputFocusLostSignal() |
61 * | resourceReady | @ref ResourceReadySignal() |
62 * | tapped | @ref GetTapGestureDetector().DetectedSignal() |
63 * | panned | @ref GetPanGestureDetector().DetectedSignal() |
64 * | pinched | @ref GetPinchGestureDetector().DetectedSignal() |
65 * | longPressed | @ref GetLongPressGestureDetector().DetectedSignal() |
68 * | %Action Name | %Control method called |
69 * |------------------------|----------------------------------------------------|
70 * | accessibilityActivated | %OnAccessibilityActivated() |
72 class DALI_IMPORT_API Control : public CustomActor
77 * @brief Enumeration for the start and end property ranges for control.
82 PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX, ///< Start index is used by the property registration macro. @SINCE_1_0.0
83 CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX, ///< Start index of Control properties. @SINCE_1_0.0
84 CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices. @SINCE_1_0.0
88 * @brief Enumeration for the instance of properties belonging to the Control class.
94 * @brief Enumeration for the instance of properties belonging to the Control class.
100 * @brief The name of the style to be applied to the control.
101 * @details Name "styleName", type Property::STRING.
102 * @see Toolkit::Control::SetStyleName()
105 STYLE_NAME = PROPERTY_START_INDEX,
109 * @brief The background color of the control.
111 * Mutually exclusive with BACKGROUND_IMAGE & BACKGROUND.
112 * @details Name "backgroundColor", type Property::VECTOR4.
113 * @see Toolkit::Control::SetStyleName()
120 * @brief The background image of the control.
122 * Mutually exclusive with BACKGROUND_COLOR & BACKGROUND.
123 * @details Name "backgroundImage", type Property::MAP.
129 * @brief Receives key events to the control.
130 * @details Name "keyInputFocus", type Property::BOOLEAN.
131 * @see Toolkit::Control::SetKeyInputFocus()
137 * @brief The background of the control.
139 * Mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE.
140 * @details Name "background", type Property::MAP or std::string for URL or Property::VECTOR4 for Color.
146 * @brief The outer space around the control.
147 * @details Name "margin", type Property::EXTENTS.
149 * @note Margin property is to be supported by Layout algorithms and containers in future.
154 * @brief The inner space of the control.
155 * @details Name "padding", type Property::EXTENTS.
163 * @brief Describes the direction to move the keyboard focus towards.
169 * @brief Keyboard focus direction.
174 LEFT, ///< Move keyboard focus towards the left direction @SINCE_1_0.0
175 RIGHT, ///< Move keyboard focus towards the right direction @SINCE_1_0.0
176 UP, ///< Move keyboard focus towards the up direction @SINCE_1_0.0
177 DOWN, ///< Move keyboard focus towards the down direction @SINCE_1_0.0
178 PAGE_UP, ///< Move keyboard focus towards the previous page direction @SINCE_1_2.14
179 PAGE_DOWN ///< Move keyboard focus towards the next page direction @SINCE_1_2.14
185 /// @brief Key Event signal type. @SINCE_1_0.0
186 typedef Signal<bool ( Control, const KeyEvent& ) > KeyEventSignalType;
188 /// @brief Key InputFocusType signal type. @SINCE_1_0.0
189 typedef Signal<void ( Control ) > KeyInputFocusSignalType;
191 /// @brief ResourceReady signal type. @SINCE_1_2.60
192 typedef Signal<void ( Control ) > ResourceReadySignalType;
194 public: // Creation & Destruction
197 * @brief Creates a new instance of a Control.
200 * @return A handle to a new Control
202 static Control New();
205 * @brief Creates an uninitialized Control handle.
207 * Only derived versions can be instantiated. Calling member
208 * functions with an uninitialized Dali::Object is not allowed.
214 * @brief Copy constructor.
216 * Creates another handle that points to the same real object.
218 * @param[in] uiControl Handle to copy
220 Control(const Control& uiControl);
223 * @brief Dali::Control is intended as a base class.
225 * This is non-virtual since derived Handle types must not contain data or virtual methods.
233 * @brief Assignment operator.
235 * Changes this handle to point to another real object.
237 * @param[in] handle Object to assign this to
238 * @return Reference to this
240 Control& operator=( const Control& handle );
245 * @brief Downcasts a handle to Control handle.
247 * If handle points to a Control, the downcast produces valid handle.
248 * If not, the returned handle is left uninitialized.
251 * @param[in] handle Handle to an object
252 * @return A handle to a Control or an uninitialized handle
254 static Control DownCast( BaseHandle handle );
259 * @brief This sets the control to receive key events.
261 * The key event can originate from a virtual or physical keyboard.
263 * @pre The Control has been initialized.
264 * @pre The Control should be on the stage before setting keyboard focus.
266 void SetKeyInputFocus();
269 * @brief Quries whether the control has key input focus.
272 * @return true if this control has keyboard input focus
273 * @pre The Control has been initialized.
274 * @pre The Control should be on the stage before setting keyboard focus.
275 * @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.
276 * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
277 * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
278 * controls above it in the focus stack.
279 * To query for the control which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().
281 bool HasKeyInputFocus();
284 * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
286 * A check is performed to ensure it was previously set, if this check fails then nothing is done.
288 * @pre The Actor has been initialized.
290 void ClearKeyInputFocus();
295 * @brief Retrieves the pinch gesture detector of the control.
298 * @return The pinch gesture detector
299 * @note Will return an empty handle if the control does not handle the gesture itself.
301 PinchGestureDetector GetPinchGestureDetector() const;
304 * @brief Retrieves the pan gesture detector of the control.
307 * @return The pan gesture detector
308 * @note Will return an empty handle if the control does not handle the gesture itself.
310 PanGestureDetector GetPanGestureDetector() const;
313 * @brief Retrieves the tap gesture detector of the control.
316 * @return The tap gesture detector
317 * @note Will return an empty handle if the control does not handle the gesture itself.
319 TapGestureDetector GetTapGestureDetector() const;
322 * @brief Retrieves the long press gesture detector of the control.
325 * @return The long press gesture detector
326 * @note Will return an empty handle if the control does not handle the gesture itself.
328 LongPressGestureDetector GetLongPressGestureDetector() const;
333 * @brief Sets the name of the style to be applied to the control.
336 * @param[in] styleName A string matching a style described in a stylesheet
338 void SetStyleName( const std::string& styleName );
341 * @brief Retrieves the name of the style to be applied to the control (if any).
343 * @return A string matching a style, or an empty string
345 const std::string& GetStyleName() const;
350 * @brief Sets the background color of the control.
353 * @param[in] color The required background color of the control
355 * @note If SetBackgroundImage is called later, this background color is removed.
357 * @note The background color fully blends with the actor color.
359 void SetBackgroundColor( const Vector4& color );
364 * @brief Retrieves the background color of the control.
367 * @return The background color of the control
369 Vector4 GetBackgroundColor() const DALI_DEPRECATED_API;
372 * @DEPRECATED_1_2_8, use Property::BACKGROUND instead
374 * @brief Sets an image as the background of the control.
377 * @param[in] image The image to set as the background
379 void SetBackgroundImage( Image image ) DALI_DEPRECATED_API;
382 * @brief Clears the background.
385 void ClearBackground();
390 * @brief Query if all resources required by a control are loaded and ready.
392 * Most resources are only loaded when the control is placed on stage.
394 * @return true if the resources are loaded and ready, false otherwise
396 bool IsResourceReady() const;
401 * @brief This signal is emitted when key event is received.
403 * A callback of the following type may be connected:
405 * bool YourCallbackName(Control control, const KeyEvent& event);
407 * The return value of True, indicates that the event should be consumed.
408 * Otherwise the signal will be emitted on the next parent of the actor.
410 * @return The signal to connect to
411 * @pre The Control has been initialized.
413 KeyEventSignalType& KeyEventSignal();
416 * @brief This signal is emitted when the control gets Key Input Focus.
418 * A callback of the following type may be connected:
420 * bool YourCallbackName( Control control );
422 * The return value of True, indicates that the event should be consumed.
423 * Otherwise the signal will be emitted on the next parent of the actor.
425 * @return The signal to connect to
426 * @pre The Control has been initialized.
428 KeyInputFocusSignalType& KeyInputFocusGainedSignal();
431 * @brief This signal is emitted when the control loses Key Input Focus.
433 * This could be due to it being gained by another Control or Actor or just cleared from
434 * this control as no longer required.
436 * A callback of the following type may be connected:
438 * bool YourCallbackName( Control control );
440 * The return value of True, indicates that the event should be consumed.
441 * Otherwise the signal will be emitted on the next parent of the actor.
443 * @return The signal to connect to
444 * @pre The Control has been initialized.
446 KeyInputFocusSignalType& KeyInputFocusLostSignal();
449 * @brief This signal is emitted after all resources required by a control are loaded and ready.
451 * Most resources are only loaded when the control is placed on stage.
453 * If resources are shared between ImageViews, they are cached.
454 * In this case, the ResourceReady signal may be sent before there is an object to connect to.
455 * To protect against this, IsResourceReady() can be checked first.
458 * auto newControl = Control::New();
459 * newControl.SetResource( resourceUrl );
460 * if ( newControl.IsResourceReady() )
466 * newControl.ResourceReadySignal.Connect( .... )
470 * A callback of the following type may be connected:
472 * void YourCallbackName( Control control );
476 * @return The signal to connect to
477 * @note A RelayoutRequest is queued by Control before this signal is emitted
479 ResourceReadySignalType& ResourceReadySignal();
481 public: // Intended for control developers
484 * @brief Creates an initialized Control.
487 * @param[in] implementation The implementation for this control
488 * @return A handle to a newly allocated Dali resource
489 * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
491 explicit Control(Internal::Control& implementation);
494 * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
495 * using an Internal CustomActor pointer.
498 * @param[in] internal A pointer to a newly allocated Dali resource
500 explicit Control(Dali::Internal::CustomActor* internal);
502 public: // Templates for Deriving Classes
505 * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
507 * @tparam T The handle class
508 * @tparam I The implementation class
510 * @param[in] handle Handle to an object
511 * @return Handle to a class T or an uninitialized handle
512 * @see DownCast(BaseHandle)
514 template<typename T, typename I>
515 DALI_INTERNAL static T DownCast( BaseHandle handle )
519 CustomActor custom = Dali::CustomActor::DownCast( handle );
522 CustomActorImpl& customImpl = custom.GetImplementation();
524 I* impl = dynamic_cast<I*>(&customImpl);
528 result = T(customImpl.GetOwner());
536 * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
537 * implementation of their class.
539 * @tparam I The implementation class
541 * @param[in] internal Pointer to the Internal::CustomActor
544 DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
546 // Can have a NULL pointer so we only need to check if the internal implementation is our class
547 // when there is a value.
550 DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
559 } // namespace Toolkit
563 #endif // __DALI_TOOLKIT_CONTROL_H__