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.
153 * @brief The inner space of the control.
154 * @details Name "padding", type Property::EXTENTS.
162 * @brief Describes the direction to move the keyboard focus towards.
168 * @brief Keyboard focus direction.
173 LEFT, ///< Move keyboard focus towards the left direction @SINCE_1_0.0
174 RIGHT, ///< Move keyboard focus towards the right direction @SINCE_1_0.0
175 UP, ///< Move keyboard focus towards the up direction @SINCE_1_0.0
176 DOWN, ///< Move keyboard focus towards the down direction @SINCE_1_0.0
177 PAGE_UP, ///< Move keyboard focus towards the previous page direction @SINCE_1_2.14
178 PAGE_DOWN ///< Move keyboard focus towards the next page direction @SINCE_1_2.14
184 /// @brief Key Event signal type. @SINCE_1_0.0
185 typedef Signal<bool ( Control, const KeyEvent& ) > KeyEventSignalType;
187 /// @brief Key InputFocusType signal type. @SINCE_1_0.0
188 typedef Signal<void ( Control ) > KeyInputFocusSignalType;
190 /// @brief ResourceReady signal type. @SINCE_1_2.60
191 typedef Signal<void ( Control ) > ResourceReadySignalType;
193 public: // Creation & Destruction
196 * @brief Creates a new instance of a Control.
199 * @return A handle to a new Control
201 static Control New();
204 * @brief Creates an uninitialized Control handle.
206 * Only derived versions can be instantiated. Calling member
207 * functions with an uninitialized Dali::Object is not allowed.
213 * @brief Copy constructor.
215 * Creates another handle that points to the same real object.
217 * @param[in] uiControl Handle to copy
219 Control(const Control& uiControl);
222 * @brief Dali::Control is intended as a base class.
224 * This is non-virtual since derived Handle types must not contain data or virtual methods.
232 * @brief Assignment operator.
234 * Changes this handle to point to another real object.
236 * @param[in] handle Object to assign this to
237 * @return Reference to this
239 Control& operator=( const Control& handle );
244 * @brief Downcasts a handle to Control handle.
246 * If handle points to a Control, the downcast produces valid handle.
247 * If not, the returned handle is left uninitialized.
250 * @param[in] handle Handle to an object
251 * @return A handle to a Control or an uninitialized handle
253 static Control DownCast( BaseHandle handle );
258 * @brief This sets the control to receive key events.
260 * The key event can originate from a virtual or physical keyboard.
262 * @pre The Control has been initialized.
263 * @pre The Control should be on the stage before setting keyboard focus.
265 void SetKeyInputFocus();
268 * @brief Quries whether the control has key input focus.
271 * @return true if this control has keyboard input focus
272 * @pre The Control has been initialized.
273 * @pre The Control should be on the stage before setting keyboard focus.
274 * @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.
275 * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
276 * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
277 * controls above it in the focus stack.
278 * To query for the control which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().
280 bool HasKeyInputFocus();
283 * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
285 * A check is performed to ensure it was previously set, if this check fails then nothing is done.
287 * @pre The Actor has been initialized.
289 void ClearKeyInputFocus();
294 * @brief Retrieves the pinch gesture detector of the control.
297 * @return The pinch gesture detector
298 * @note Will return an empty handle if the control does not handle the gesture itself.
300 PinchGestureDetector GetPinchGestureDetector() const;
303 * @brief Retrieves the pan gesture detector of the control.
306 * @return The pan gesture detector
307 * @note Will return an empty handle if the control does not handle the gesture itself.
309 PanGestureDetector GetPanGestureDetector() const;
312 * @brief Retrieves the tap gesture detector of the control.
315 * @return The tap gesture detector
316 * @note Will return an empty handle if the control does not handle the gesture itself.
318 TapGestureDetector GetTapGestureDetector() const;
321 * @brief Retrieves the long press gesture detector of the control.
324 * @return The long press gesture detector
325 * @note Will return an empty handle if the control does not handle the gesture itself.
327 LongPressGestureDetector GetLongPressGestureDetector() const;
332 * @brief Sets the name of the style to be applied to the control.
335 * @param[in] styleName A string matching a style described in a stylesheet
337 void SetStyleName( const std::string& styleName );
340 * @brief Retrieves the name of the style to be applied to the control (if any).
342 * @return A string matching a style, or an empty string
344 const std::string& GetStyleName() const;
349 * @brief Sets the background color of the control.
352 * @param[in] color The required background color of the control
354 * @note If SetBackgroundImage is called later, this background color is removed.
356 * @note The background color fully blends with the actor color.
358 void SetBackgroundColor( const Vector4& color );
363 * @brief Retrieves the background color of the control.
366 * @return The background color of the control
368 Vector4 GetBackgroundColor() const DALI_DEPRECATED_API;
371 * @DEPRECATED_1_2_8, use Property::BACKGROUND instead
373 * @brief Sets an image as the background of the control.
376 * @param[in] image The image to set as the background
378 void SetBackgroundImage( Image image ) DALI_DEPRECATED_API;
381 * @brief Clears the background.
384 void ClearBackground();
389 * @brief Query if all resources required by a control are loaded and ready.
391 * Most resources are only loaded when the control is placed on stage.
393 * @return true if the resources are loaded and ready, false otherwise
395 bool IsResourceReady() const;
400 * @brief This signal is emitted when key event is received.
402 * A callback of the following type may be connected:
404 * bool YourCallbackName(Control control, const KeyEvent& event);
406 * The return value of True, indicates that the event should be consumed.
407 * Otherwise the signal will be emitted on the next parent of the actor.
409 * @return The signal to connect to
410 * @pre The Control has been initialized.
412 KeyEventSignalType& KeyEventSignal();
415 * @brief This signal is emitted when the control gets Key Input Focus.
417 * A callback of the following type may be connected:
419 * bool YourCallbackName( Control control );
421 * The return value of True, indicates that the event should be consumed.
422 * Otherwise the signal will be emitted on the next parent of the actor.
424 * @return The signal to connect to
425 * @pre The Control has been initialized.
427 KeyInputFocusSignalType& KeyInputFocusGainedSignal();
430 * @brief This signal is emitted when the control loses Key Input Focus.
432 * This could be due to it being gained by another Control or Actor or just cleared from
433 * this control as no longer required.
435 * A callback of the following type may be connected:
437 * bool YourCallbackName( Control control );
439 * The return value of True, indicates that the event should be consumed.
440 * Otherwise the signal will be emitted on the next parent of the actor.
442 * @return The signal to connect to
443 * @pre The Control has been initialized.
445 KeyInputFocusSignalType& KeyInputFocusLostSignal();
448 * @brief This signal is emitted after all resources required by a control are loaded and ready.
450 * Most resources are only loaded when the control is placed on stage.
452 * A callback of the following type may be connected:
454 * void YourCallbackName( Control control );
458 * @note A RelayoutRequest is queued by Control before this signal is emitted
460 ResourceReadySignalType& ResourceReadySignal();
462 public: // Intended for control developers
465 * @brief Creates an initialized Control.
468 * @param[in] implementation The implementation for this control
469 * @return A handle to a newly allocated Dali resource
470 * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
472 explicit Control(Internal::Control& implementation);
475 * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
476 * using an Internal CustomActor pointer.
479 * @param[in] internal A pointer to a newly allocated Dali resource
481 explicit Control(Dali::Internal::CustomActor* internal);
483 public: // Templates for Deriving Classes
486 * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
488 * @tparam T The handle class
489 * @tparam I The implementation class
491 * @param[in] handle Handle to an object
492 * @return Handle to a class T or an uninitialized handle
493 * @see DownCast(BaseHandle)
495 template<typename T, typename I>
496 DALI_INTERNAL static T DownCast( BaseHandle handle )
500 CustomActor custom = Dali::CustomActor::DownCast( handle );
503 CustomActorImpl& customImpl = custom.GetImplementation();
505 I* impl = dynamic_cast<I*>(&customImpl);
509 result = T(customImpl.GetOwner());
517 * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
518 * implementation of their class.
520 * @tparam I The implementation class
522 * @param[in] internal Pointer to the Internal::CustomActor
525 DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
527 // Can have a NULL pointer so we only need to check if the internal implementation is our class
528 // when there is a value.
531 DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
540 } // namespace Toolkit
544 #endif // __DALI_TOOLKIT_CONTROL_H__