1 #ifndef DALI_TOOLKIT_CONTROL_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_IMPL_H
5 * Copyright (c) 2020 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
300 * @copydoc CustomActorImpl::OnSceneConnection()
301 * @note If overridden, then an up-call to Control::OnSceneConnection MUST be made at the end.
303 virtual void OnSceneConnection( int depth ) override;
306 * @copydoc CustomActorImpl::OnSceneDisconnection()
307 * @note If overridden, then an up-call to Control::OnSceneDisconnection MUST be made at the end.
309 virtual void OnSceneDisconnection() override;
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 ) override;
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 ) override;
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 ) override;
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 ) override;
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 ) override;
342 * @copydoc CustomActorImpl::OnHoverEvent()
344 virtual bool OnHoverEvent( const HoverEvent& event ) override;
347 * @copydoc CustomActorImpl::OnKeyEvent()
349 virtual bool OnKeyEvent( const KeyEvent& event ) override;
352 * @copydoc CustomActorImpl::OnWheelEvent()
354 virtual bool OnWheelEvent( const WheelEvent& event ) override;
357 * @copydoc CustomActorImpl::OnRelayout()
359 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
362 * @copydoc CustomActorImpl::OnSetResizePolicy()
364 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) override;
367 * @copydoc CustomActorImpl::GetNaturalSize()
369 virtual Vector3 GetNaturalSize() override;
372 * @copydoc CustomActorImpl::CalculateChildSize()
374 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) override;
377 * @copydoc CustomActorImpl::GetHeightForWidth()
379 virtual float GetHeightForWidth( float width ) override;
382 * @copydoc CustomActorImpl::GetWidthForHeight()
384 virtual float GetWidthForHeight( float height ) override;
387 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
389 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) override;
392 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
394 virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) override;
397 * @copydoc CustomActorImpl::OnLayoutNegotiated()
399 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) override;
401 protected: // Helpers for deriving classes
406 * @brief Flags for the constructor.
409 enum ControlBehaviour
411 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
412 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
413 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
415 DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10
417 LAST_CONTROL_BEHAVIOUR_FLAG
420 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
423 * @brief Control constructor.
426 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
428 Control( ControlBehaviour behaviourFlags );
431 * @brief Second phase initialization.
436 public: // API for derived classes to override
441 * @brief This method is called after the Control has been initialized.
443 * Derived classes should do any second phase initialization by overriding this method.
446 virtual void OnInitialize();
451 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
454 * @param[in] styleManager The StyleManager object
455 * @param[in] change Information denoting what has changed
457 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
462 * @brief This method is called when the control is accessibility activated.
464 * Derived classes should override this to perform custom accessibility activation.
466 * @return true if this control can perform accessibility activation
468 virtual bool OnAccessibilityActivated();
471 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
475 * @param[in] gesture The pan gesture
476 * @return true if the pan gesture has been consumed by this control
478 virtual bool OnAccessibilityPan( PanGesture gesture );
481 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
485 * @param[in] touch The touch event
486 * @return true if the touch event has been consumed by this control
488 virtual bool OnAccessibilityTouch( const TouchEvent& touch );
491 * @brief This method should be overridden by deriving classes when they wish to respond
492 * the accessibility up and down action (i.e. value change of slider control).
495 * @param[in] isIncrease Whether the value should be increased or decreased
496 * @return true if the value changed action has been consumed by this control
498 virtual bool OnAccessibilityValueChange( bool isIncrease );
501 * @brief This method should be overridden by deriving classes when they wish to respond
502 * the accessibility zoom action.
505 * @return true if the zoom action has been consumed by this control
507 virtual bool OnAccessibilityZoom();
512 * @brief Called when the control gains key input focus.
514 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
517 virtual void OnKeyInputFocusGained();
520 * @brief Called when the control loses key input focus.
522 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
525 virtual void OnKeyInputFocusLost();
528 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
530 * A control needs to override this function in order to support two dimensional keyboard navigation.
532 * @param[in] currentFocusedActor The current focused actor
533 * @param[in] direction The direction to move the focus towards
534 * @param[in] loopEnabled Whether the focus movement should be looped within the control
535 * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused
537 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
540 * @brief Informs this control that its chosen focusable actor will be focused.
542 * This allows the application to perform any actions if wishes
543 * before the focus is actually moved to the chosen actor.
546 * @param[in] commitedFocusableActor The commited focusable actor
548 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
551 * @brief This method is called when the control has enter pressed on it.
553 * Derived classes should override this to perform custom actions.
555 * @return true if this control supported this action
557 virtual bool OnKeyboardEnter();
562 * @brief Called whenever a pinch gesture is detected on this control.
564 * This can be overridden by deriving classes when pinch detection
565 * is enabled. The default behaviour is to scale the control by the
569 * @param[in] pinch The pinch gesture
570 * @note If overridden, then the default behavior will not occur.
571 * @note Pinch detection should be enabled via EnableGestureDetection().
572 * @see EnableGestureDetection
574 virtual void OnPinch( const PinchGesture& pinch );
577 * @brief Called whenever a pan gesture is detected on this control.
579 * This should be overridden by deriving classes when pan detection
583 * @param[in] pan The pan gesture
584 * @note There is no default behavior with panning.
585 * @note Pan detection should be enabled via EnableGestureDetection().
586 * @see EnableGestureDetection
588 virtual void OnPan( const PanGesture& pan );
591 * @brief Called whenever a tap gesture is detected on this control.
593 * This should be overridden by deriving classes when tap detection
597 * @param[in] tap The tap gesture
598 * @note There is no default behavior with a tap.
599 * @note Tap detection should be enabled via EnableGestureDetection().
600 * @see EnableGestureDetection
602 virtual void OnTap( const TapGesture& tap );
605 * @brief Called whenever a long press gesture is detected on this control.
607 * This should be overridden by deriving classes when long press
608 * detection is enabled.
611 * @param[in] longPress The long press gesture
612 * @note There is no default behaviour associated with a long press.
613 * @note Long press detection should be enabled via EnableGestureDetection().
614 * @see EnableGestureDetection
616 virtual void OnLongPress( const LongPressGesture& longPress );
618 // From ConnectionTrackerInterface
621 * @copydoc ConnectionTrackerInterface::SignalConnected
623 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
626 * @copydoc ConnectionTrackerInterface::SignalDisconnected
628 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
631 * @brief Retrieves the extension for this control.
634 * @return The extension if available, NULL otherwise
636 virtual Extension* GetControlExtension()
645 DALI_INTERNAL Control( const Control& );
646 DALI_INTERNAL Control& operator=( const Control& );
649 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