1 #ifndef DALI_TOOLKIT_CONTROL_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_IMPL_H
5 * Copyright (c) 2022 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
50 * @brief This is the internal base class for all controls.
52 * It will provide some common functionality required by all controls.
53 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
54 * be disconnected automatically when the control is destroyed.
57 class DALI_TOOLKIT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
60 class Extension; ///< Forward declare future extension interface
62 // 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::Toolkit::Control::ClearBackground
110 void ClearBackground();
115 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
117 * Gesture detection can be enabled one at a time or in bitwise format as shown:
119 * EnableGestureDetection(GestureType::Value(GestureType::PINCH | GestureType::TAP | GestureType::PAN));
122 * @param[in] type The gesture type(s) to enable
124 void EnableGestureDetection(GestureType::Value type);
127 * @brief Allows deriving classes to disable any of the gesture detectors.
129 * Like EnableGestureDetection, this can also be called using bitwise or.
131 * @param[in] type The gesture type(s) to disable
132 * @see EnableGetureDetection
134 void DisableGestureDetection(GestureType::Value type);
137 * @brief If deriving classes wish to fine tune pinch gesture
138 * detection, then they can access the gesture detector through this
139 * API and modify the detection.
142 * @return The pinch gesture detector
143 * @pre Pinch detection should have been enabled via EnableGestureDetection().
144 * @see EnableGestureDetection
146 PinchGestureDetector GetPinchGestureDetector() const;
149 * @brief If deriving classes wish to fine tune pan gesture
150 * detection, then they can access the gesture detector through this
151 * API and modify the detection.
154 * @return The pan gesture detector
155 * @pre Pan detection should have been enabled via EnableGestureDetection().
156 * @see EnableGestureDetection
158 PanGestureDetector GetPanGestureDetector() const;
161 * @brief If deriving classes wish to fine tune tap gesture
162 * detection, then they can access the gesture detector through this
163 * API and modify the detection.
166 * @return The tap gesture detector
167 * @pre Tap detection should have been enabled via EnableGestureDetection().
168 * @see EnableGestureDetection
170 TapGestureDetector GetTapGestureDetector() const;
173 * @brief If deriving classes wish to fine tune long press gesture
174 * detection, then they can access the gesture detector through this
175 * API and modify the detection.
178 * @return The long press gesture detector
179 * @pre Long press detection should have been enabled via EnableGestureDetection().
180 * @see EnableGestureDetection
182 LongPressGestureDetector GetLongPressGestureDetector() const;
184 // Keyboard Navigation
187 * @brief Sets whether this control supports two dimensional
188 * keyboard navigation (i.e. whether it knows how to handle the
189 * keyboard focus movement between its child actors).
191 * The control doesn't support it by default.
193 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation
195 void SetKeyboardNavigationSupport(bool isSupported);
198 * @brief Gets whether this control supports two dimensional keyboard navigation.
201 * @return true if this control supports two dimensional keyboard navigation
203 bool IsKeyboardNavigationSupported();
208 * @copydoc Toolkit::Control::SetKeyInputFocus()
210 void SetKeyInputFocus();
213 * @copydoc Toolkit::Control::HasKeyInputFocus()
215 bool HasKeyInputFocus();
218 * @copydoc Toolkit::Control::ClearKeyInputFocus()
220 void ClearKeyInputFocus();
225 * @brief Sets whether this control is a focus group for keyboard navigation.
227 * (i.e. the scope of keyboard focus movement
228 * can be limited to its child actors). The control is not a focus group by default.
230 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation
232 void SetAsKeyboardFocusGroup(bool isFocusGroup);
235 * @brief Gets whether this control is a focus group for keyboard navigation.
238 * @return true if this control is set as a focus group for keyboard navigation
240 bool IsKeyboardFocusGroup();
244 * @brief Called by the AccessibilityManager to activate the Control.
247 DALI_INTERNAL void AccessibilityActivate();
250 * @brief Called by the KeyboardFocusManager.
253 DALI_INTERNAL void KeyboardEnter();
260 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
262 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
265 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
267 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
270 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
272 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
276 * @brief Called by the KeyInputFocusManager to emit key event signals.
279 * @param[in] event The key event
280 * @return True if the event was consumed
282 DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event);
285 protected: // For derived classes to call
287 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.
289 * Should be called last by the control after it acts on the Input Focus change.
292 * @param[in] focusGained True if gained, False if lost
294 void EmitKeyInputFocusSignal(bool focusGained);
296 protected: // From CustomActorImpl
298 * @copydoc CustomActorImpl::OnSceneConnection()
299 * @note If overridden, then an up-call to Control::OnSceneConnection MUST be made at the end.
301 void OnSceneConnection(int depth) override;
304 * @copydoc CustomActorImpl::OnSceneDisconnection()
305 * @note If overridden, then an up-call to Control::OnSceneDisconnection MUST be made at the end.
307 void OnSceneDisconnection() override;
310 * @copydoc CustomActorImpl::OnChildAdd()
311 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end.
313 void OnChildAdd(Actor& child) override;
316 * @copydoc CustomActorImpl::OnChildRemove()
317 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
319 void OnChildRemove(Actor& child) override;
322 * @copydoc CustomActorImpl::OnPropertySet()
323 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
325 void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
328 * @copydoc CustomActorImpl::OnSizeSet()
329 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end.
331 void OnSizeSet(const Vector3& targetSize) override;
334 * @copydoc CustomActorImpl::OnSizeAnimation()
335 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end.
337 void OnSizeAnimation(Animation& animation, const Vector3& targetSize) override;
340 * @copydoc CustomActorImpl::OnRelayout()
342 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
345 * @copydoc CustomActorImpl::OnSetResizePolicy()
347 void OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension) override;
350 * @copydoc CustomActorImpl::GetNaturalSize()
352 Vector3 GetNaturalSize() override;
355 * @copydoc CustomActorImpl::CalculateChildSize()
357 float CalculateChildSize(const Dali::Actor& child, Dimension::Type dimension) override;
360 * @copydoc CustomActorImpl::GetHeightForWidth()
362 float GetHeightForWidth(float width) override;
365 * @copydoc CustomActorImpl::GetWidthForHeight()
367 float GetWidthForHeight(float height) override;
370 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
372 bool RelayoutDependentOnChildren(Dimension::Type dimension = Dimension::ALL_DIMENSIONS) override;
375 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
377 void OnCalculateRelayoutSize(Dimension::Type dimension) override;
380 * @copydoc CustomActorImpl::OnLayoutNegotiated()
382 void OnLayoutNegotiated(float size, Dimension::Type dimension) override;
384 public: // Helpers for deriving classes
387 * @brief Flags for the constructor.
390 enum ControlBehaviour
392 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
393 NOT_IN_USE_1 = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 0),
394 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 1), ///< True if needs to support keyboard navigation @SINCE_1_0.0
395 DISABLE_STYLE_CHANGE_SIGNALS = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 2), ///< True if control should not monitor style change signals @SINCE_1_2_10
397 LAST_CONTROL_BEHAVIOUR_FLAG
400 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log<LAST_CONTROL_BEHAVIOUR_FLAG - 1>::value + 1; ///< Total count of flags
403 * @brief Creates a new ControlImpl instance that does not require touch by default.
405 * If touch is required, then the user can connect to this class' touch signal.
407 * @param[in] additionalBehaviour Additional control behaviour.
408 * @return A handle to the ControlImpl instance
410 static Toolkit::Control New(ControlBehaviour additionalBehaviour);
416 * @brief Control constructor.
419 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
421 Control(ControlBehaviour behaviourFlags);
424 * @brief Second phase initialization.
429 public: // API for derived classes to override
433 * @brief This method is called after the Control has been initialized.
435 * Derived classes should do any second phase initialization by overriding this method.
438 virtual void OnInitialize();
443 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
446 * @param[in] styleManager The StyleManager object
447 * @param[in] change Information denoting what has changed
449 virtual void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change);
454 * @brief This method is called when the control is accessibility activated.
456 * Derived classes should override this to perform custom accessibility activation.
458 * @return true if this control can perform accessibility activation
460 virtual bool OnAccessibilityActivated();
463 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
467 * @param[in] gesture The pan gesture
468 * @return true if the pan gesture has been consumed by this control
470 virtual bool OnAccessibilityPan(PanGesture gesture);
473 * @brief This method should be overridden by deriving classes when they wish to respond
474 * the accessibility up and down action (i.e. value change of slider control).
477 * @param[in] isIncrease Whether the value should be increased or decreased
478 * @return true if the value changed action has been consumed by this control
480 virtual bool OnAccessibilityValueChange(bool isIncrease);
483 * @brief This method should be overridden by deriving classes when they wish to respond
484 * the accessibility zoom action.
487 * @return true if the zoom action has been consumed by this control
489 virtual bool OnAccessibilityZoom();
494 * @brief Called when the control gains key input focus.
496 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
499 virtual void OnKeyInputFocusGained();
502 * @brief Called when the control loses key input focus.
504 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
507 virtual void OnKeyInputFocusLost();
510 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
512 * A control needs to override this function in order to support two dimensional keyboard navigation.
514 * @param[in] currentFocusedActor The current focused actor
515 * @param[in] direction The direction to move the focus towards
516 * @param[in] loopEnabled Whether the focus movement should be looped within the control
517 * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused
519 virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled);
522 * @brief Informs this control that its chosen focusable actor will be focused.
524 * This allows the application to perform any actions if wishes
525 * before the focus is actually moved to the chosen actor.
528 * @param[in] commitedFocusableActor The commited focusable actor
530 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
533 * @brief This method is called when the control has enter pressed on it.
535 * Derived classes should override this to perform custom actions.
537 * @return true if this control supported this action
539 virtual bool OnKeyboardEnter();
542 * @brief Called after a key-event is received by the actor that has had its focus set.
545 * @param[in] event The Key Event
546 * @return True if the event should be consumed
548 virtual bool OnKeyEvent(const KeyEvent& event);
553 * @brief Called whenever a pinch gesture is detected on this control.
555 * This can be overridden by deriving classes when pinch detection
556 * is enabled. The default behaviour is to scale the control by the
560 * @param[in] pinch The pinch gesture
561 * @note If overridden, then the default behavior will not occur.
562 * @note Pinch detection should be enabled via EnableGestureDetection().
563 * @see EnableGestureDetection
565 virtual void OnPinch(const PinchGesture& pinch);
568 * @brief Called whenever a pan gesture is detected on this control.
570 * This should be overridden by deriving classes when pan detection
574 * @param[in] pan The pan gesture
575 * @note There is no default behavior with panning.
576 * @note Pan detection should be enabled via EnableGestureDetection().
577 * @see EnableGestureDetection
579 virtual void OnPan(const PanGesture& pan);
582 * @brief Called whenever a tap gesture is detected on this control.
584 * This should be overridden by deriving classes when tap detection
588 * @param[in] tap The tap gesture
589 * @note There is no default behavior with a tap.
590 * @note Tap detection should be enabled via EnableGestureDetection().
591 * @see EnableGestureDetection
593 virtual void OnTap(const TapGesture& tap);
596 * @brief Called whenever a long press gesture is detected on this control.
598 * This should be overridden by deriving classes when long press
599 * detection is enabled.
602 * @param[in] longPress The long press gesture
603 * @note There is no default behaviour associated with a long press.
604 * @note Long press detection should be enabled via EnableGestureDetection().
605 * @see EnableGestureDetection
607 virtual void OnLongPress(const LongPressGesture& longPress);
609 // From ConnectionTrackerInterface
612 * @copydoc ConnectionTrackerInterface::SignalConnected
614 void SignalConnected(SlotObserver* slotObserver, CallbackBase* callback) override;
617 * @copydoc ConnectionTrackerInterface::SignalDisconnected
619 void SignalDisconnected(SlotObserver* slotObserver, CallbackBase* callback) override;
622 * @brief Retrieves the extension for this control.
625 * @return The extension if available, NULL otherwise
627 virtual Extension* GetControlExtension()
635 * @brief Make visual transition from source control to destination control about specific Visual.
636 * If both of source and destination control have same visual index, than generates information for the transition of this Control.
638 * @param[out] sourcePropertyMap Source property map to be applied on this Control.
639 * @param[out] destinationPropertyMap Destination property map to be applied on this Control.
640 * @param[in] source Source control of the animation.
641 * @param[in] destination Destination control of the animation.
642 * @param[in] visualIndex Property::Index to make animation.
644 void MakeVisualTransition(Dali::Property::Map& sourcePropertyMap, Dali::Property::Map& destinationPropertyMap,
645 Dali::Toolkit::Control source, Dali::Toolkit::Control destination, Dali::Property::Index visualIndex);
648 * @brief Retrieves source and destination visual properties for the Transition of this Control.
649 * The properties of this Control will be transitioned from the propeties of source Control to that of destination control.
650 * If a property value is different between source and destination Control,
651 * the property information of each Control will be included in sourceProperties and destinationProperties.
653 * @param[out] sourceProperties Source property list to be applied on this Control.
654 * @param[out] destinationProperties Destination property list to be applied on this Control.
655 * @param[in] source Source control of the animation.
656 * @param[in] destination Destination control of the animation.
658 * @note This method do not handle Actor properties.
659 * And the size and order of the sourceProperties and destinationProperties must be synchronized.
661 virtual void OnCreateTransitions(std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& sourceProperties,
662 std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& destinationProperties,
663 Dali::Toolkit::Control source,
664 Dali::Toolkit::Control destination)
669 * @brief Update visual properties.
670 * @param[in] properties Property list to be used to update visual properties of this Control.
672 virtual void OnUpdateVisualProperties(const std::vector<std::pair<Dali::Property::Index, Dali::Property::Map>>& properties)
679 // Not copyable or movable
680 DALI_INTERNAL Control(const Control&) = delete; ///< Deleted copy constructor.
681 DALI_INTERNAL Control(Control&&) = delete; ///< Deleted move constructor.
682 DALI_INTERNAL Control& operator=(const Control&) = delete; ///< Deleted copy assignment operator.
683 DALI_INTERNAL Control& operator=(Control&&) = delete; ///< Deleted move assignment operator.
686 class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl
694 * @brief Gets implementation from the handle.
698 * @return Implementation
699 * @pre handle is initialized and points to a control
701 DALI_TOOLKIT_API Internal::Control& GetImplementation(Dali::Toolkit::Control& handle);
704 * @brief Gets implementation from the handle.
708 * @return Implementation
709 * @pre Handle is initialized and points to a control.
711 DALI_TOOLKIT_API const Internal::Control& GetImplementation(const Dali::Toolkit::Control& handle);
713 } // namespace Internal
718 } // namespace Toolkit
722 #endif // DALI_TOOLKIT_CONTROL_IMPL_H