1 #ifndef DALI_TOOLKIT_CONTROL_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_IMPL_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/public-api/adaptor-framework/style-change.h>
23 #include <dali/public-api/animation/alpha-function.h>
24 #include <dali/public-api/animation/time-period.h>
25 #include <dali/public-api/events/long-press-gesture.h>
26 #include <dali/public-api/events/pan-gesture.h>
27 #include <dali/public-api/events/pinch-gesture.h>
28 #include <dali/public-api/events/tap-gesture.h>
29 #include <dali/public-api/object/property-index-ranges.h>
30 #include <dali/public-api/object/type-info.h>
33 #include <dali-toolkit/public-api/controls/control.h>
40 * @addtogroup dali_toolkit_controls
49 * @brief This is the internal base class for all controls.
51 * It will provide some common functionality required by all controls.
52 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
53 * be disconnected automatically when the control is destroyed.
56 class DALI_TOOLKIT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
59 class Extension; ///< Forward declare future extension interface
61 // Creation & Destruction
64 * @brief Creates a new ControlImpl instance that does not require touch by default.
66 * If touch is required, then the user can connect to this class' touch signal.
68 * @return A handle to the ControlImpl instance
70 static Toolkit::Control New();
74 * @brief Virtual destructor.
83 * @copydoc Dali::Toolkit::Control::SetStyleName
85 void SetStyleName(const std::string& styleName);
88 * @copydoc Dali::Toolkit::Control::GetStyleName
90 const std::string& GetStyleName() const;
95 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
97 void SetBackgroundColor(const Vector4& color);
100 * @brief Sets the background with a property map.
103 * @param[in] map The background property map
105 void SetBackground(const Property::Map& map);
108 * @copydoc Dali::CustomActorImpl::RelayoutRequest()
110 void RelayoutRequest();
113 * @copydoc Dali::Toolkit::Control::ClearBackground
115 void ClearBackground();
120 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
122 * Gesture detection can be enabled one at a time or in bitwise format as shown:
124 * EnableGestureDetection(GestureType::Value(GestureType::PINCH | GestureType::TAP | GestureType::PAN));
127 * @param[in] type The gesture type(s) to enable
129 void EnableGestureDetection(GestureType::Value type);
132 * @brief Allows deriving classes to disable any of the gesture detectors.
134 * Like EnableGestureDetection, this can also be called using bitwise or.
136 * @param[in] type The gesture type(s) to disable
137 * @see EnableGetureDetection
139 void DisableGestureDetection(GestureType::Value type);
142 * @brief If deriving classes wish to fine tune pinch gesture
143 * detection, then they can access the gesture detector through this
144 * API and modify the detection.
147 * @return The pinch gesture detector
148 * @pre Pinch detection should have been enabled via EnableGestureDetection().
149 * @see EnableGestureDetection
151 PinchGestureDetector GetPinchGestureDetector() const;
154 * @brief If deriving classes wish to fine tune pan gesture
155 * detection, then they can access the gesture detector through this
156 * API and modify the detection.
159 * @return The pan gesture detector
160 * @pre Pan detection should have been enabled via EnableGestureDetection().
161 * @see EnableGestureDetection
163 PanGestureDetector GetPanGestureDetector() const;
166 * @brief If deriving classes wish to fine tune tap gesture
167 * detection, then they can access the gesture detector through this
168 * API and modify the detection.
171 * @return The tap gesture detector
172 * @pre Tap detection should have been enabled via EnableGestureDetection().
173 * @see EnableGestureDetection
175 TapGestureDetector GetTapGestureDetector() const;
178 * @brief If deriving classes wish to fine tune long press gesture
179 * detection, then they can access the gesture detector through this
180 * API and modify the detection.
183 * @return The long press gesture detector
184 * @pre Long press detection should have been enabled via EnableGestureDetection().
185 * @see EnableGestureDetection
187 LongPressGestureDetector GetLongPressGestureDetector() const;
189 // Keyboard Navigation
192 * @brief Sets whether this control supports two dimensional
193 * keyboard navigation (i.e. whether it knows how to handle the
194 * keyboard focus movement between its child actors).
196 * The control doesn't support it by default.
198 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation
200 void SetKeyboardNavigationSupport(bool isSupported);
203 * @brief Gets whether this control supports two dimensional keyboard navigation.
206 * @return true if this control supports two dimensional keyboard navigation
208 bool IsKeyboardNavigationSupported();
213 * @copydoc Toolkit::Control::SetKeyInputFocus()
215 void SetKeyInputFocus();
218 * @copydoc Toolkit::Control::HasKeyInputFocus()
220 bool HasKeyInputFocus();
223 * @copydoc Toolkit::Control::ClearKeyInputFocus()
225 void ClearKeyInputFocus();
230 * @brief Sets whether this control is a focus group for keyboard navigation.
232 * (i.e. the scope of keyboard focus movement
233 * can be limited to its child actors). The control is not a focus group by default.
235 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation
237 void SetAsKeyboardFocusGroup(bool isFocusGroup);
240 * @brief Gets whether this control is a focus group for keyboard navigation.
243 * @return true if this control is set as a focus group for keyboard navigation
245 bool IsKeyboardFocusGroup();
249 * @brief Called by the AccessibilityManager to activate the Control.
252 DALI_INTERNAL void AccessibilityActivate();
255 * @brief Called by the KeyboardFocusManager.
258 DALI_INTERNAL void KeyboardEnter();
265 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
267 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
270 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
272 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
275 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
277 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
281 * @brief Called by the KeyInputFocusManager to emit key event signals.
284 * @param[in] event The key event
285 * @return True if the event was consumed
287 DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event);
290 protected: // For derived classes to call
292 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.
294 * Should be called last by the control after it acts on the Input Focus change.
297 * @param[in] focusGained True if gained, False if lost
299 void EmitKeyInputFocusSignal(bool focusGained);
301 protected: // From CustomActorImpl
303 * @copydoc CustomActorImpl::OnSceneConnection()
304 * @note If overridden, then an up-call to Control::OnSceneConnection MUST be made at the end.
306 void OnSceneConnection(int depth) override;
309 * @copydoc CustomActorImpl::OnSceneDisconnection()
310 * @note If overridden, then an up-call to Control::OnSceneDisconnection MUST be made at the end.
312 void OnSceneDisconnection() override;
315 * @copydoc CustomActorImpl::OnChildAdd()
316 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end.
318 void OnChildAdd(Actor& child) override;
321 * @copydoc CustomActorImpl::OnChildRemove()
322 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
324 void OnChildRemove(Actor& child) override;
327 * @copydoc CustomActorImpl::OnPropertySet()
328 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
330 void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
333 * @copydoc CustomActorImpl::OnSizeSet()
334 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end.
336 void OnSizeSet(const Vector3& targetSize) override;
339 * @copydoc CustomActorImpl::OnSizeAnimation()
340 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end.
342 void OnSizeAnimation(Animation& animation, const Vector3& targetSize) override;
345 * @copydoc CustomActorImpl::OnRelayout()
347 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
350 * @copydoc CustomActorImpl::OnSetResizePolicy()
352 void OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension) override;
355 * @copydoc CustomActorImpl::GetNaturalSize()
357 Vector3 GetNaturalSize() override;
360 * @copydoc CustomActorImpl::CalculateChildSize()
362 float CalculateChildSize(const Dali::Actor& child, Dimension::Type dimension) override;
365 * @copydoc CustomActorImpl::GetHeightForWidth()
367 float GetHeightForWidth(float width) override;
370 * @copydoc CustomActorImpl::GetWidthForHeight()
372 float GetWidthForHeight(float height) override;
375 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
377 bool RelayoutDependentOnChildren(Dimension::Type dimension = Dimension::ALL_DIMENSIONS) override;
380 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
382 void OnCalculateRelayoutSize(Dimension::Type dimension) override;
385 * @copydoc CustomActorImpl::OnLayoutNegotiated()
387 void OnLayoutNegotiated(float size, Dimension::Type dimension) override;
389 protected: // Helpers for deriving classes
393 * @brief Flags for the constructor.
396 enum ControlBehaviour
398 CONTROL_BEHAVIOUR_DEFAULT = 0, ///< Default behaviour: Size negotiation is enabled & listens to Style Change signal, but doesn't receive event callbacks. @SINCE_1_2_10
399 NOT_IN_USE_1 = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 0),
400 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 1), ///< True if needs to support keyboard navigation @SINCE_1_0.0
401 DISABLE_STYLE_CHANGE_SIGNALS = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 2), ///< True if control should not monitor style change signals @SINCE_1_2_10
403 LAST_CONTROL_BEHAVIOUR_FLAG
406 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log<LAST_CONTROL_BEHAVIOUR_FLAG - 1>::value + 1; ///< Total count of flags
409 * @brief Control constructor.
412 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
414 Control(ControlBehaviour behaviourFlags);
417 * @brief Second phase initialization.
422 public: // API for derived classes to override
426 * @brief This method is called after the Control has been initialized.
428 * Derived classes should do any second phase initialization by overriding this method.
431 virtual void OnInitialize();
436 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
439 * @param[in] styleManager The StyleManager object
440 * @param[in] change Information denoting what has changed
442 virtual void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change);
447 * @brief This method is called when the control is accessibility activated.
449 * Derived classes should override this to perform custom accessibility activation.
451 * @return true if this control can perform accessibility activation
453 virtual bool OnAccessibilityActivated();
456 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
460 * @param[in] gesture The pan gesture
461 * @return true if the pan gesture has been consumed by this control
463 virtual bool OnAccessibilityPan(PanGesture gesture);
466 * @brief This method should be overridden by deriving classes when they wish to respond
467 * the accessibility up and down action (i.e. value change of slider control).
470 * @param[in] isIncrease Whether the value should be increased or decreased
471 * @return true if the value changed action has been consumed by this control
473 virtual bool OnAccessibilityValueChange(bool isIncrease);
476 * @brief This method should be overridden by deriving classes when they wish to respond
477 * the accessibility zoom action.
480 * @return true if the zoom action has been consumed by this control
482 virtual bool OnAccessibilityZoom();
487 * @brief Called when the control gains key input focus.
489 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
492 virtual void OnKeyInputFocusGained();
495 * @brief Called when the control loses key input focus.
497 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
500 virtual void OnKeyInputFocusLost();
503 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
505 * A control needs to override this function in order to support two dimensional keyboard navigation.
507 * @param[in] currentFocusedActor The current focused actor
508 * @param[in] direction The direction to move the focus towards
509 * @param[in] loopEnabled Whether the focus movement should be looped within the control
510 * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused
512 virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled);
515 * @brief Informs this control that its chosen focusable actor will be focused.
517 * This allows the application to perform any actions if wishes
518 * before the focus is actually moved to the chosen actor.
521 * @param[in] commitedFocusableActor The commited focusable actor
523 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
526 * @brief This method is called when the control has enter pressed on it.
528 * Derived classes should override this to perform custom actions.
530 * @return true if this control supported this action
532 virtual bool OnKeyboardEnter();
535 * @brief Called after a key-event is received by the actor that has had its focus set.
538 * @param[in] event The Key Event
539 * @return True if the event should be consumed
541 virtual bool OnKeyEvent(const KeyEvent& event);
546 * @brief Called whenever a pinch gesture is detected on this control.
548 * This can be overridden by deriving classes when pinch detection
549 * is enabled. The default behaviour is to scale the control by the
553 * @param[in] pinch The pinch gesture
554 * @note If overridden, then the default behavior will not occur.
555 * @note Pinch detection should be enabled via EnableGestureDetection().
556 * @see EnableGestureDetection
558 virtual void OnPinch(const PinchGesture& pinch);
561 * @brief Called whenever a pan gesture is detected on this control.
563 * This should be overridden by deriving classes when pan detection
567 * @param[in] pan The pan gesture
568 * @note There is no default behavior with panning.
569 * @note Pan detection should be enabled via EnableGestureDetection().
570 * @see EnableGestureDetection
572 virtual void OnPan(const PanGesture& pan);
575 * @brief Called whenever a tap gesture is detected on this control.
577 * This should be overridden by deriving classes when tap detection
581 * @param[in] tap The tap gesture
582 * @note There is no default behavior with a tap.
583 * @note Tap detection should be enabled via EnableGestureDetection().
584 * @see EnableGestureDetection
586 virtual void OnTap(const TapGesture& tap);
589 * @brief Called whenever a long press gesture is detected on this control.
591 * This should be overridden by deriving classes when long press
592 * detection is enabled.
595 * @param[in] longPress The long press gesture
596 * @note There is no default behaviour associated with a long press.
597 * @note Long press detection should be enabled via EnableGestureDetection().
598 * @see EnableGestureDetection
600 virtual void OnLongPress(const LongPressGesture& longPress);
602 // From ConnectionTrackerInterface
605 * @copydoc ConnectionTrackerInterface::SignalConnected
607 void SignalConnected(SlotObserver* slotObserver, CallbackBase* callback) override;
610 * @copydoc ConnectionTrackerInterface::SignalDisconnected
612 void SignalDisconnected(SlotObserver* slotObserver, CallbackBase* callback) override;
615 * @brief Retrieves the extension for this control.
618 * @return The extension if available, NULL otherwise
620 virtual Extension* GetControlExtension()
628 * @brief Retrieve visual property animations.
629 * This Control is a destination.
631 * @param[in] animation generated animation
632 * @param[in] source source control of the animation.
633 * @param[in] alphaFunction AlphaFunction of the animation
634 * @param[in] timePeriod TimePeriod of the animation
636 virtual void OnCreateTransitions(Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod timePeriod)
643 // Not copyable or movable
644 DALI_INTERNAL Control(const Control&) = delete; ///< Deleted copy constructor.
645 DALI_INTERNAL Control(Control&&) = delete; ///< Deleted move constructor.
646 DALI_INTERNAL Control& operator=(const Control&) = delete; ///< Deleted copy assignment operator.
647 DALI_INTERNAL Control& operator=(Control&&) = delete; ///< Deleted move assignment operator.
650 class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl
658 * @brief Gets implementation from the handle.
662 * @return Implementation
663 * @pre handle is initialized and points to a control
665 DALI_TOOLKIT_API Internal::Control& GetImplementation(Dali::Toolkit::Control& handle);
668 * @brief Gets implementation from the handle.
672 * @return Implementation
673 * @pre Handle is initialized and points to a control.
675 DALI_TOOLKIT_API const Internal::Control& GetImplementation(const Dali::Toolkit::Control& handle);
677 } // namespace Internal
682 } // namespace Toolkit
686 #endif // DALI_TOOLKIT_CONTROL_IMPL_H