1 #ifndef DALI_TOOLKIT_CONTROL_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_IMPL_H
5 * Copyright (c) 2019 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/events/long-press-gesture.h>
24 #include <dali/public-api/events/pan-gesture.h>
25 #include <dali/public-api/events/pinch-gesture.h>
26 #include <dali/public-api/events/tap-gesture.h>
27 #include <dali/public-api/object/property-index-ranges.h>
28 #include <dali/public-api/object/type-info.h>
31 #include <dali-toolkit/public-api/controls/control.h>
39 * @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
60 class Extension; ///< Forward declare future extension interface
62 // Creation & Destruction
65 * @brief Creates a new ControlImpl instance that does not require touch by default.
67 * If touch is required, then the user can connect to this class' touch signal.
69 * @return A handle to the ControlImpl instance
71 static Toolkit::Control New();
75 * @brief Virtual destructor.
84 * @copydoc Dali::Toolkit::Control::SetStyleName
86 void SetStyleName( const std::string& styleName );
89 * @copydoc Dali::Toolkit::Control::GetStyleName
91 const std::string& GetStyleName() const;
96 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
98 void SetBackgroundColor( const Vector4& color );
101 * @brief Sets the background with a property map.
104 * @param[in] map The background property map
106 void SetBackground(const Property::Map& map);
109 * @copydoc Dali::Toolkit::Control::ClearBackground
111 void ClearBackground();
114 * @brief Sets the shadow with a property map.
115 * @param[in] map The shadow property map
117 void SetShadow(const Property::Map& map);
120 * @brief Clear the shadow.
127 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
129 * Gesture detection can be enabled one at a time or in bitwise format as shown:
131 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
134 * @param[in] type The gesture type(s) to enable
136 void EnableGestureDetection( Gesture::Type type );
139 * @brief Allows deriving classes to disable any of the gesture detectors.
141 * Like EnableGestureDetection, this can also be called using bitwise or.
143 * @param[in] type The gesture type(s) to disable
144 * @see EnableGetureDetection
146 void DisableGestureDetection( Gesture::Type type );
149 * @brief If deriving classes wish to fine tune pinch gesture
150 * detection, then they can access the gesture detector through this
151 * API and modify the detection.
154 * @return The pinch gesture detector
155 * @pre Pinch detection should have been enabled via EnableGestureDetection().
156 * @see EnableGestureDetection
158 PinchGestureDetector GetPinchGestureDetector() const;
161 * @brief If deriving classes wish to fine tune pan gesture
162 * detection, then they can access the gesture detector through this
163 * API and modify the detection.
166 * @return The pan gesture detector
167 * @pre Pan detection should have been enabled via EnableGestureDetection().
168 * @see EnableGestureDetection
170 PanGestureDetector GetPanGestureDetector() const;
173 * @brief If deriving classes wish to fine tune tap gesture
174 * detection, then they can access the gesture detector through this
175 * API and modify the detection.
178 * @return The tap gesture detector
179 * @pre Tap detection should have been enabled via EnableGestureDetection().
180 * @see EnableGestureDetection
182 TapGestureDetector GetTapGestureDetector() const;
185 * @brief If deriving classes wish to fine tune long press gesture
186 * detection, then they can access the gesture detector through this
187 * API and modify the detection.
190 * @return The long press gesture detector
191 * @pre Long press detection should have been enabled via EnableGestureDetection().
192 * @see EnableGestureDetection
194 LongPressGestureDetector GetLongPressGestureDetector() const;
196 // Keyboard Navigation
199 * @brief Sets whether this control supports two dimensional
200 * keyboard navigation (i.e. whether it knows how to handle the
201 * keyboard focus movement between its child actors).
203 * The control doesn't support it by default.
205 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation
207 void SetKeyboardNavigationSupport( bool isSupported );
210 * @brief Gets whether this control supports two dimensional keyboard navigation.
213 * @return true if this control supports two dimensional keyboard navigation
215 bool IsKeyboardNavigationSupported();
220 * @copydoc Toolkit::Control::SetKeyInputFocus()
222 void SetKeyInputFocus();
225 * @copydoc Toolkit::Control::HasKeyInputFocus()
227 bool HasKeyInputFocus();
230 * @copydoc Toolkit::Control::ClearKeyInputFocus()
232 void ClearKeyInputFocus();
237 * @brief Sets whether this control is a focus group for keyboard navigation.
239 * (i.e. the scope of keyboard focus movement
240 * can be limited to its child actors). The control is not a focus group by default.
242 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation
244 void SetAsKeyboardFocusGroup( bool isFocusGroup );
247 * @brief Gets whether this control is a focus group for keyboard navigation.
250 * @return true if this control is set as a focus group for keyboard navigation
252 bool IsKeyboardFocusGroup();
256 * @brief Called by the AccessibilityManager to activate the Control.
259 DALI_INTERNAL void AccessibilityActivate();
262 * @brief Called by the KeyboardFocusManager.
265 DALI_INTERNAL void KeyboardEnter();
271 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
273 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
276 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
278 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
281 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
283 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
287 * @brief Called by the KeyInputFocusManager to emit key event signals.
290 * @param[in] event The key event
291 * @return True if the event was consumed
293 DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
296 protected: // For derived classes to call
299 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.
301 * Should be called last by the control after it acts on the Input Focus change.
304 * @param[in] focusGained True if gained, False if lost
306 void EmitKeyInputFocusSignal( bool focusGained );
308 protected: // From CustomActorImpl, not to be used by application developers
311 * @copydoc CustomActorImpl::OnStageConnection()
312 * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the end.
314 virtual void OnStageConnection( int depth );
317 * @copydoc CustomActorImpl::OnStageDisconnection()
318 * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
320 virtual void OnStageDisconnection();
323 * @copydoc CustomActorImpl::OnChildAdd()
324 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end.
326 virtual void OnChildAdd( Actor& child );
329 * @copydoc CustomActorImpl::OnChildRemove()
330 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
332 virtual void OnChildRemove( Actor& child );
335 * @copydoc CustomActorImpl::OnPropertySet()
336 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
338 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
341 * @copydoc CustomActorImpl::OnSizeSet()
342 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end.
344 virtual void OnSizeSet( const Vector3& targetSize );
347 * @copydoc CustomActorImpl::OnSizeAnimation()
348 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end.
350 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
353 * @copydoc CustomActorImpl::OnTouchEvent()
355 virtual bool OnTouchEvent( const TouchEvent& event );
358 * @copydoc CustomActorImpl::OnHoverEvent()
360 virtual bool OnHoverEvent( const HoverEvent& event );
363 * @copydoc CustomActorImpl::OnKeyEvent()
365 virtual bool OnKeyEvent( const KeyEvent& event );
368 * @copydoc CustomActorImpl::OnWheelEvent()
370 virtual bool OnWheelEvent( const WheelEvent& event );
373 * @copydoc CustomActorImpl::OnRelayout()
375 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
378 * @copydoc CustomActorImpl::OnSetResizePolicy()
380 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
383 * @copydoc CustomActorImpl::GetNaturalSize()
385 virtual Vector3 GetNaturalSize();
388 * @copydoc CustomActorImpl::CalculateChildSize()
390 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
393 * @copydoc CustomActorImpl::GetHeightForWidth()
395 virtual float GetHeightForWidth( float width );
398 * @copydoc CustomActorImpl::GetWidthForHeight()
400 virtual float GetWidthForHeight( float height );
403 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
405 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
408 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
410 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
413 * @copydoc CustomActorImpl::OnLayoutNegotiated()
415 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
417 protected: // Helpers for deriving classes
422 * @brief Flags for the constructor.
425 enum ControlBehaviour
427 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
428 REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change @SINCE_1_0.0 @DEPRECATED_1_2_10
429 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
431 DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10
433 LAST_CONTROL_BEHAVIOUR_FLAG
436 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
439 * @brief Control constructor.
442 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
444 Control( ControlBehaviour behaviourFlags );
447 * @brief Second phase initialization.
452 public: // API for derived classes to override
457 * @brief This method is called after the Control has been initialized.
459 * Derived classes should do any second phase initialization by overriding this method.
462 virtual void OnInitialize();
465 * @DEPRECATED_1_1.30. Override OnChildAdd instead.
467 * @brief Called whenever an Actor is added to the control.
469 * Could be overridden by derived classes.
472 * @param[in] child The added actor
474 virtual void OnControlChildAdd( Actor& child ) DALI_DEPRECATED_API;
477 * @DEPRECATED_1_1.30. Override OnChildRemove instead.
479 * @brief Called whenever an Actor is removed from the control.
481 * Could be overridden by derived classes.
484 * @param[in] child The removed actor
486 virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API;
491 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
494 * @param[in] styleManager The StyleManager object
495 * @param[in] change Information denoting what has changed
497 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
502 * @brief This method is called when the control is accessibility activated.
504 * Derived classes should override this to perform custom accessibility activation.
506 * @return true if this control can perform accessibility activation
508 virtual bool OnAccessibilityActivated();
511 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
515 * @param[in] gesture The pan gesture
516 * @return true if the pan gesture has been consumed by this control
518 virtual bool OnAccessibilityPan( PanGesture gesture );
521 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
525 * @param[in] touchEvent The touch event
526 * @return true if the touch event has been consumed by this control
528 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
531 * @brief This method should be overridden by deriving classes when they wish to respond
532 * the accessibility up and down action (i.e. value change of slider control).
535 * @param[in] isIncrease Whether the value should be increased or decreased
536 * @return true if the value changed action has been consumed by this control
538 virtual bool OnAccessibilityValueChange( bool isIncrease );
541 * @brief This method should be overridden by deriving classes when they wish to respond
542 * the accessibility zoom action.
545 * @return true if the zoom action has been consumed by this control
547 virtual bool OnAccessibilityZoom();
552 * @brief Called when the control gains key input focus.
554 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
557 virtual void OnKeyInputFocusGained();
560 * @brief Called when the control loses key input focus.
562 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
565 virtual void OnKeyInputFocusLost();
568 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
570 * A control needs to override this function in order to support two dimensional keyboard navigation.
572 * @param[in] currentFocusedActor The current focused actor
573 * @param[in] direction The direction to move the focus towards
574 * @param[in] loopEnabled Whether the focus movement should be looped within the control
575 * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused
577 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
580 * @brief Informs this control that its chosen focusable actor will be focused.
582 * This allows the application to perform any actions if wishes
583 * before the focus is actually moved to the chosen actor.
586 * @param[in] commitedFocusableActor The commited focusable actor
588 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
591 * @brief This method is called when the control has enter pressed on it.
593 * Derived classes should override this to perform custom actions.
595 * @return true if this control supported this action
597 virtual bool OnKeyboardEnter();
602 * @brief Called whenever a pinch gesture is detected on this control.
604 * This can be overridden by deriving classes when pinch detection
605 * is enabled. The default behaviour is to scale the control by the
609 * @param[in] pinch The pinch gesture
610 * @note If overridden, then the default behavior will not occur.
611 * @note Pinch detection should be enabled via EnableGestureDetection().
612 * @see EnableGestureDetection
614 virtual void OnPinch( const PinchGesture& pinch );
617 * @brief Called whenever a pan gesture is detected on this control.
619 * This should be overridden by deriving classes when pan detection
623 * @param[in] pan The pan gesture
624 * @note There is no default behavior with panning.
625 * @note Pan detection should be enabled via EnableGestureDetection().
626 * @see EnableGestureDetection
628 virtual void OnPan( const PanGesture& pan );
631 * @brief Called whenever a tap gesture is detected on this control.
633 * This should be overridden by deriving classes when tap detection
637 * @param[in] tap The tap gesture
638 * @note There is no default behavior with a tap.
639 * @note Tap detection should be enabled via EnableGestureDetection().
640 * @see EnableGestureDetection
642 virtual void OnTap( const TapGesture& tap );
645 * @brief Called whenever a long press gesture is detected on this control.
647 * This should be overridden by deriving classes when long press
648 * detection is enabled.
651 * @param[in] longPress The long press gesture
652 * @note There is no default behaviour associated with a long press.
653 * @note Long press detection should be enabled via EnableGestureDetection().
654 * @see EnableGestureDetection
656 virtual void OnLongPress( const LongPressGesture& longPress );
658 // From ConnectionTrackerInterface
661 * @copydoc ConnectionTrackerInterface::SignalConnected
663 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
666 * @copydoc ConnectionTrackerInterface::SignalDisconnected
668 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
671 * @brief Retrieves the extension for this control.
674 * @return The extension if available, NULL otherwise
676 virtual Extension* GetControlExtension()
685 DALI_INTERNAL Control( const Control& );
686 DALI_INTERNAL Control& operator=( const Control& );
689 class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl
698 * @brief Gets implementation from the handle.
702 * @return Implementation
703 * @pre handle is initialized and points to a control
705 DALI_TOOLKIT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
708 * @brief Gets implementation from the handle.
712 * @return Implementation
713 * @pre Handle is initialized and points to a control.
715 DALI_TOOLKIT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
717 } // namespace Internal
722 } // namespace Toolkit
726 #endif // DALI_TOOLKIT_CONTROL_IMPL_H