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();
116 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
118 * Gesture detection can be enabled one at a time or in bitwise format as shown:
120 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
123 * @param[in] type The gesture type(s) to enable
125 void EnableGestureDetection( Gesture::Type type );
128 * @brief Allows deriving classes to disable any of the gesture detectors.
130 * Like EnableGestureDetection, this can also be called using bitwise or.
132 * @param[in] type The gesture type(s) to disable
133 * @see EnableGetureDetection
135 void DisableGestureDetection( Gesture::Type type );
138 * @brief If deriving classes wish to fine tune pinch gesture
139 * detection, then they can access the gesture detector through this
140 * API and modify the detection.
143 * @return The pinch gesture detector
144 * @pre Pinch detection should have been enabled via EnableGestureDetection().
145 * @see EnableGestureDetection
147 PinchGestureDetector GetPinchGestureDetector() const;
150 * @brief If deriving classes wish to fine tune pan gesture
151 * detection, then they can access the gesture detector through this
152 * API and modify the detection.
155 * @return The pan gesture detector
156 * @pre Pan detection should have been enabled via EnableGestureDetection().
157 * @see EnableGestureDetection
159 PanGestureDetector GetPanGestureDetector() const;
162 * @brief If deriving classes wish to fine tune tap gesture
163 * detection, then they can access the gesture detector through this
164 * API and modify the detection.
167 * @return The tap gesture detector
168 * @pre Tap detection should have been enabled via EnableGestureDetection().
169 * @see EnableGestureDetection
171 TapGestureDetector GetTapGestureDetector() const;
174 * @brief If deriving classes wish to fine tune long press gesture
175 * detection, then they can access the gesture detector through this
176 * API and modify the detection.
179 * @return The long press gesture detector
180 * @pre Long press detection should have been enabled via EnableGestureDetection().
181 * @see EnableGestureDetection
183 LongPressGestureDetector GetLongPressGestureDetector() const;
185 // Keyboard Navigation
188 * @brief Sets whether this control supports two dimensional
189 * keyboard navigation (i.e. whether it knows how to handle the
190 * keyboard focus movement between its child actors).
192 * The control doesn't support it by default.
194 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation
196 void SetKeyboardNavigationSupport( bool isSupported );
199 * @brief Gets whether this control supports two dimensional keyboard navigation.
202 * @return true if this control supports two dimensional keyboard navigation
204 bool IsKeyboardNavigationSupported();
209 * @copydoc Toolkit::Control::SetKeyInputFocus()
211 void SetKeyInputFocus();
214 * @copydoc Toolkit::Control::HasKeyInputFocus()
216 bool HasKeyInputFocus();
219 * @copydoc Toolkit::Control::ClearKeyInputFocus()
221 void ClearKeyInputFocus();
226 * @brief Sets whether this control is a focus group for keyboard navigation.
228 * (i.e. the scope of keyboard focus movement
229 * can be limited to its child actors). The control is not a focus group by default.
231 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation
233 void SetAsKeyboardFocusGroup( bool isFocusGroup );
236 * @brief Gets whether this control is a focus group for keyboard navigation.
239 * @return true if this control is set as a focus group for keyboard navigation
241 bool IsKeyboardFocusGroup();
245 * @brief Called by the AccessibilityManager to activate the Control.
248 DALI_INTERNAL void AccessibilityActivate();
251 * @brief Called by the KeyboardFocusManager.
254 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
288 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.
290 * Should be called last by the control after it acts on the Input Focus change.
293 * @param[in] focusGained True if gained, False if lost
295 void EmitKeyInputFocusSignal( bool focusGained );
297 protected: // From CustomActorImpl, not to be used by application developers
300 * @copydoc CustomActorImpl::OnStageConnection()
301 * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the end.
303 virtual void OnStageConnection( int depth );
306 * @copydoc CustomActorImpl::OnStageDisconnection()
307 * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
309 virtual void OnStageDisconnection();
312 * @copydoc CustomActorImpl::OnChildAdd()
313 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end.
315 virtual void OnChildAdd( Actor& child );
318 * @copydoc CustomActorImpl::OnChildRemove()
319 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
321 virtual void OnChildRemove( Actor& child );
324 * @copydoc CustomActorImpl::OnPropertySet()
325 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
327 virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
330 * @copydoc CustomActorImpl::OnSizeSet()
331 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end.
333 virtual void OnSizeSet( const Vector3& targetSize );
336 * @copydoc CustomActorImpl::OnSizeAnimation()
337 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end.
339 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
342 * @copydoc CustomActorImpl::OnTouchEvent()
344 virtual bool OnTouchEvent( const TouchEvent& event );
347 * @copydoc CustomActorImpl::OnHoverEvent()
349 virtual bool OnHoverEvent( const HoverEvent& event );
352 * @copydoc CustomActorImpl::OnKeyEvent()
354 virtual bool OnKeyEvent( const KeyEvent& event );
357 * @copydoc CustomActorImpl::OnWheelEvent()
359 virtual bool OnWheelEvent( const WheelEvent& event );
362 * @copydoc CustomActorImpl::OnRelayout()
364 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
367 * @copydoc CustomActorImpl::OnSetResizePolicy()
369 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
372 * @copydoc CustomActorImpl::GetNaturalSize()
374 virtual Vector3 GetNaturalSize();
377 * @copydoc CustomActorImpl::CalculateChildSize()
379 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
382 * @copydoc CustomActorImpl::GetHeightForWidth()
384 virtual float GetHeightForWidth( float width );
387 * @copydoc CustomActorImpl::GetWidthForHeight()
389 virtual float GetWidthForHeight( float height );
392 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
394 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
397 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
399 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
402 * @copydoc CustomActorImpl::OnLayoutNegotiated()
404 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
406 protected: // Helpers for deriving classes
411 * @brief Flags for the constructor.
414 enum ControlBehaviour
416 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
417 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
418 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
420 DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10
422 LAST_CONTROL_BEHAVIOUR_FLAG
425 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
428 * @brief Control constructor.
431 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
433 Control( ControlBehaviour behaviourFlags );
436 * @brief Second phase initialization.
441 public: // API for derived classes to override
446 * @brief This method is called after the Control has been initialized.
448 * Derived classes should do any second phase initialization by overriding this method.
451 virtual void OnInitialize();
454 * @DEPRECATED_1_1.30. Override OnChildAdd instead.
456 * @brief Called whenever an Actor is added to the control.
458 * Could be overridden by derived classes.
461 * @param[in] child The added actor
463 virtual void OnControlChildAdd( Actor& child ) DALI_DEPRECATED_API;
466 * @DEPRECATED_1_1.30. Override OnChildRemove instead.
468 * @brief Called whenever an Actor is removed from the control.
470 * Could be overridden by derived classes.
473 * @param[in] child The removed actor
475 virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API;
480 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
483 * @param[in] styleManager The StyleManager object
484 * @param[in] change Information denoting what has changed
486 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
491 * @brief This method is called when the control is accessibility activated.
493 * Derived classes should override this to perform custom accessibility activation.
495 * @return true if this control can perform accessibility activation
497 virtual bool OnAccessibilityActivated();
500 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
504 * @param[in] gesture The pan gesture
505 * @return true if the pan gesture has been consumed by this control
507 virtual bool OnAccessibilityPan( PanGesture gesture );
510 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
514 * @param[in] touchEvent The touch event
515 * @return true if the touch event has been consumed by this control
517 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
520 * @brief This method should be overridden by deriving classes when they wish to respond
521 * the accessibility up and down action (i.e. value change of slider control).
524 * @param[in] isIncrease Whether the value should be increased or decreased
525 * @return true if the value changed action has been consumed by this control
527 virtual bool OnAccessibilityValueChange( bool isIncrease );
530 * @brief This method should be overridden by deriving classes when they wish to respond
531 * the accessibility zoom action.
534 * @return true if the zoom action has been consumed by this control
536 virtual bool OnAccessibilityZoom();
541 * @brief Called when the control gains key input focus.
543 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
546 virtual void OnKeyInputFocusGained();
549 * @brief Called when the control loses key input focus.
551 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
554 virtual void OnKeyInputFocusLost();
557 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
559 * A control needs to override this function in order to support two dimensional keyboard navigation.
561 * @param[in] currentFocusedActor The current focused actor
562 * @param[in] direction The direction to move the focus towards
563 * @param[in] loopEnabled Whether the focus movement should be looped within the control
564 * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused
566 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
569 * @brief Informs this control that its chosen focusable actor will be focused.
571 * This allows the application to perform any actions if wishes
572 * before the focus is actually moved to the chosen actor.
575 * @param[in] commitedFocusableActor The commited focusable actor
577 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
580 * @brief This method is called when the control has enter pressed on it.
582 * Derived classes should override this to perform custom actions.
584 * @return true if this control supported this action
586 virtual bool OnKeyboardEnter();
591 * @brief Called whenever a pinch gesture is detected on this control.
593 * This can be overridden by deriving classes when pinch detection
594 * is enabled. The default behaviour is to scale the control by the
598 * @param[in] pinch The pinch gesture
599 * @note If overridden, then the default behavior will not occur.
600 * @note Pinch detection should be enabled via EnableGestureDetection().
601 * @see EnableGestureDetection
603 virtual void OnPinch( const PinchGesture& pinch );
606 * @brief Called whenever a pan gesture is detected on this control.
608 * This should be overridden by deriving classes when pan detection
612 * @param[in] pan The pan gesture
613 * @note There is no default behavior with panning.
614 * @note Pan detection should be enabled via EnableGestureDetection().
615 * @see EnableGestureDetection
617 virtual void OnPan( const PanGesture& pan );
620 * @brief Called whenever a tap gesture is detected on this control.
622 * This should be overridden by deriving classes when tap detection
626 * @param[in] tap The tap gesture
627 * @note There is no default behavior with a tap.
628 * @note Tap detection should be enabled via EnableGestureDetection().
629 * @see EnableGestureDetection
631 virtual void OnTap( const TapGesture& tap );
634 * @brief Called whenever a long press gesture is detected on this control.
636 * This should be overridden by deriving classes when long press
637 * detection is enabled.
640 * @param[in] longPress The long press gesture
641 * @note There is no default behaviour associated with a long press.
642 * @note Long press detection should be enabled via EnableGestureDetection().
643 * @see EnableGestureDetection
645 virtual void OnLongPress( const LongPressGesture& longPress );
647 // From ConnectionTrackerInterface
650 * @copydoc ConnectionTrackerInterface::SignalConnected
652 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
655 * @copydoc ConnectionTrackerInterface::SignalDisconnected
657 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
660 * @brief Retrieves the extension for this control.
663 * @return The extension if available, NULL otherwise
665 virtual Extension* GetControlExtension()
674 DALI_INTERNAL Control( const Control& );
675 DALI_INTERNAL Control& operator=( const Control& );
678 class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl
687 * @brief Gets implementation from the handle.
691 * @return Implementation
692 * @pre handle is initialized and points to a control
694 DALI_TOOLKIT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
697 * @brief Gets implementation from the handle.
701 * @return Implementation
702 * @pre Handle is initialized and points to a control.
704 DALI_TOOLKIT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
706 } // namespace Internal
711 } // namespace Toolkit
715 #endif // DALI_TOOLKIT_CONTROL_IMPL_H