1 #ifndef DALI_TOOLKIT_CONTROL_H
2 #define DALI_TOOLKIT_CONTROL_H
5 * Copyright (c) 2021 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/dali-toolkit-common.h>
23 #include <dali/public-api/actors/custom-actor.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>
30 #include <dali-toolkit/public-api/visuals/visual-properties.h>
36 //Forward declarations.
43 * @addtogroup dali_toolkit_controls
48 * @brief Control is the base class for all controls.
50 * The implementation of the control must be supplied; see Internal::Control for more details.
52 * @see Internal::Control
55 * | %Signal Name | Method |
56 * |------------------------|-----------------------------------------------------|
57 * | keyEvent | @ref KeyEventSignal() |
58 * | keyInputFocusGained | @ref KeyInputFocusGainedSignal() |
59 * | keyInputFocusLost | @ref KeyInputFocusLostSignal() |
60 * | resourceReady | @ref ResourceReadySignal() |
61 * | tapped | @ref GetTapGestureDetector().DetectedSignal() |
62 * | panned | @ref GetPanGestureDetector().DetectedSignal() |
63 * | pinched | @ref GetPinchGestureDetector().DetectedSignal() |
64 * | longPressed | @ref GetLongPressGestureDetector().DetectedSignal() |
67 * | %Action Name | %Control method called |
68 * |------------------------|----------------------------------------------------|
69 * | accessibilityActivated | %OnAccessibilityActivated() |
71 class DALI_TOOLKIT_API Control : public CustomActor
75 * @brief Enumeration for the start and end property ranges for control.
80 PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX, ///< Start index is used by the property registration macro. @SINCE_1_0.0
81 CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX, ///< Start index of Control properties. @SINCE_1_0.0
82 CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices. @SINCE_1_0.0
86 * @brief Enumeration for the instance of properties belonging to the Control class.
92 * @brief Enumeration for the instance of properties belonging to the Control class.
98 * @brief The name of the style to be applied to the control.
99 * @details Name "styleName", type Property::STRING.
100 * @see Toolkit::Control::SetStyleName()
103 STYLE_NAME = PROPERTY_START_INDEX,
106 * @brief Receives key events to the control.
107 * @details Name "keyInputFocus", type Property::BOOLEAN.
108 * @see Toolkit::Control::SetKeyInputFocus()
114 * @brief The background of the control.
116 * @details Name "background", type Property::MAP or std::string for URL or Property::VECTOR4 for Color.
122 * @brief The outer space around the control.
123 * @details Name "margin", type Property::EXTENTS.
125 * @note Margin property is to be supported by Layout algorithms and containers in future.
130 * @brief The inner space of the control.
131 * @details Name "padding", type Property::EXTENTS.
139 * @brief Describes the direction to move the keyboard focus towards.
145 * @brief Keyboard focus direction.
150 LEFT, ///< Move keyboard focus towards the left direction @SINCE_1_0.0
151 RIGHT, ///< Move keyboard focus towards the right direction @SINCE_1_0.0
152 UP, ///< Move keyboard focus towards the up direction @SINCE_1_0.0
153 DOWN, ///< Move keyboard focus towards the down direction @SINCE_1_0.0
154 PAGE_UP, ///< Move keyboard focus towards the previous page direction @SINCE_1_2.14
155 PAGE_DOWN ///< Move keyboard focus towards the next page direction @SINCE_1_2.14
161 /// @brief Key Event signal type. @SINCE_1_0.0
162 typedef Signal<bool(Control, const KeyEvent&)> KeyEventSignalType;
164 /// @brief Key InputFocusType signal type. @SINCE_1_0.0
165 typedef Signal<void(Control)> KeyInputFocusSignalType;
167 /// @brief ResourceReady signal type. @SINCE_1_2.60
168 typedef Signal<void(Control)> ResourceReadySignalType;
170 public: // Creation & Destruction
172 * @brief Creates a new instance of a Control.
175 * @return A handle to a new Control
177 static Control New();
180 * @brief Creates an uninitialized Control handle.
182 * Only derived versions can be instantiated. Calling member
183 * functions with an uninitialized Dali::Object is not allowed.
189 * @brief Copy constructor.
191 * Creates another handle that points to the same real object.
193 * @param[in] uiControl Handle to copy
195 Control(const Control& uiControl);
198 * @brief Move constructor.
201 * @param[in] rhs Handle to move
203 Control(Control&& rhs);
206 * @brief Dali::Control is intended as a base class.
208 * This is non-virtual since derived Handle types must not contain data or virtual methods.
215 * @brief Copy assignment operator.
217 * Changes this handle to point to another real object.
219 * @param[in] handle Object to assign this to
220 * @return Reference to this
222 Control& operator=(const Control& handle);
225 * @brief Move assignment operator.
228 * @param[in] rhs Object to assign this to
229 * @return Reference to this
231 Control& operator=(Control&& rhs);
235 * @brief Downcasts a handle to Control handle.
237 * If handle points to a Control, the downcast produces valid handle.
238 * If not, the returned handle is left uninitialized.
241 * @param[in] handle Handle to an object
242 * @return A handle to a Control or an uninitialized handle
244 static Control DownCast(BaseHandle handle);
249 * @brief This sets the control to receive key events.
251 * The key event can originate from a virtual or physical keyboard.
253 * @pre The Control has been initialized.
254 * @pre The Control should be on the stage before setting keyboard focus.
256 void SetKeyInputFocus();
259 * @brief Quries whether the control has key input focus.
262 * @return true if this control has keyboard input focus
263 * @pre The Control has been initialized.
264 * @pre The Control should be on the stage before setting keyboard focus.
265 * @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.
266 * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
267 * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
268 * controls above it in the focus stack.
269 * To query for the control which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().
271 bool HasKeyInputFocus();
274 * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
276 * A check is performed to ensure it was previously set, if this check fails then nothing is done.
278 * @pre The Actor has been initialized.
280 void ClearKeyInputFocus();
285 * @brief Retrieves the pinch gesture detector of the control.
288 * @return The pinch gesture detector
289 * @note Will return an empty handle if the control does not handle the gesture itself.
291 PinchGestureDetector GetPinchGestureDetector() const;
294 * @brief Retrieves the pan gesture detector of the control.
297 * @return The pan gesture detector
298 * @note Will return an empty handle if the control does not handle the gesture itself.
300 PanGestureDetector GetPanGestureDetector() const;
303 * @brief Retrieves the tap gesture detector of the control.
306 * @return The tap gesture detector
307 * @note Will return an empty handle if the control does not handle the gesture itself.
309 TapGestureDetector GetTapGestureDetector() const;
312 * @brief Retrieves the long press gesture detector of the control.
315 * @return The long press gesture detector
316 * @note Will return an empty handle if the control does not handle the gesture itself.
318 LongPressGestureDetector GetLongPressGestureDetector() const;
323 * @brief Sets the name of the style to be applied to the control.
326 * @param[in] styleName A string matching a style described in a stylesheet
328 void SetStyleName(const std::string& styleName);
331 * @brief Retrieves the name of the style to be applied to the control (if any).
333 * @return A string matching a style, or an empty string
335 const std::string& GetStyleName() const;
340 * @brief Sets the background color of the control.
343 * @param[in] color The required background color of the control
345 * @note If SetBackgroundImage is called later, this background color is removed.
347 * @note The background color fully blends with the actor color.
349 void SetBackgroundColor(const Vector4& color);
352 * @brief Clears the background.
355 void ClearBackground();
360 * @brief Query if all resources required by a control are loaded and ready.
362 * Most resources are only loaded when the control is placed on stage.
364 * @return true if the resources are loaded and ready, false otherwise
366 bool IsResourceReady() const;
369 * @brief Get the loading state of the visual resource.
372 * @param[in] index The Property index of the visual
373 * @return Return the loading status (PREPARING, READY and FAILED) of visual resource
375 Visual::ResourceStatus GetVisualResourceStatus(const Dali::Property::Index index);
380 * @brief This signal is emitted when key event is received.
382 * A callback of the following type may be connected:
384 * bool YourCallbackName(Control control, const KeyEvent& event);
386 * The return value of True, indicates that the event should be consumed.
387 * Otherwise the signal will be emitted on the next parent of the actor.
389 * @return The signal to connect to
390 * @pre The Control has been initialized.
392 KeyEventSignalType& KeyEventSignal();
395 * @brief This signal is emitted when the control gets Key Input Focus.
397 * A callback of the following type may be connected:
399 * bool YourCallbackName( Control control );
401 * The return value of True, indicates that the event should be consumed.
402 * Otherwise the signal will be emitted on the next parent of the actor.
404 * @return The signal to connect to
405 * @pre The Control has been initialized.
407 KeyInputFocusSignalType& KeyInputFocusGainedSignal();
410 * @brief This signal is emitted when the control loses Key Input Focus.
412 * This could be due to it being gained by another Control or Actor or just cleared from
413 * this control as no longer required.
415 * A callback of the following type may be connected:
417 * bool YourCallbackName( Control control );
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 KeyInputFocusSignalType& KeyInputFocusLostSignal();
428 * @brief This signal is emitted after all resources required by a control are loaded and ready.
430 * Most resources are only loaded when the control is placed on stage.
432 * If resources are shared between ImageViews, they are cached.
433 * In this case, the ResourceReady signal may be sent before there is an object to connect to.
434 * To protect against this, IsResourceReady() can be checked first.
437 * auto newControl = Control::New();
438 * newControl.SetResource( resourceUrl );
439 * if ( newControl.IsResourceReady() )
445 * newControl.ResourceReadySignal.Connect( .... )
449 * A callback of the following type may be connected:
451 * void YourCallbackName( Control control );
455 * @return The signal to connect to
456 * @note A RelayoutRequest is queued by Control before this signal is emitted
458 ResourceReadySignalType& ResourceReadySignal();
460 public: // Intended for control developers
462 * @brief Creates an initialized Control.
465 * @param[in] implementation The implementation for this control
466 * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
468 explicit Control(Internal::Control& implementation);
471 * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
472 * using an Internal CustomActor pointer.
475 * @param[in] internal A pointer to a newly allocated Dali resource
477 explicit Control(Dali::Internal::CustomActor* internal);
479 public: // Templates for Deriving Classes
481 * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
483 * @tparam T The handle class
484 * @tparam I The implementation class
486 * @param[in] handle Handle to an object
487 * @return Handle to a class T or an uninitialized handle
488 * @see DownCast(BaseHandle)
490 template<typename T, typename I>
491 DALI_INTERNAL static T DownCast(BaseHandle handle)
495 CustomActor custom = Dali::CustomActor::DownCast(handle);
498 CustomActorImpl& customImpl = custom.GetImplementation();
500 I* impl = dynamic_cast<I*>(&customImpl);
504 result = T(customImpl.GetOwner());
512 * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
513 * implementation of their class.
515 * @tparam I The implementation class
517 * @param[in] internal Pointer to the Internal::CustomActor
520 DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
522 // Can have a NULL pointer so we only need to check if the internal implementation is our class
523 // when there is a value.
526 DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
534 } // namespace Toolkit
538 #endif // DALI_TOOLKIT_CONTROL_H