1 #ifndef DALI_TOOLKIT_CONTROL_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_IMPL_H
5 * Copyright (c) 2016 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
55 * @brief This is the internal base class for all controls.
57 * It will provide some common functionality required by all controls.
58 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
59 * be disconnected automatically when the control is destroyed.
62 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
66 class Extension; ///< Forward declare future extension interface
68 // Creation & Destruction
71 * @brief Create a new ControlImpl instance that does not require touch by default.
73 * If touch is required then the user can connect to this class' touch signal.
75 * @return A handle to the ControlImpl instance.
77 static Toolkit::Control New();
82 * @copydoc Dali::Toolkit::Control::SetStyleName
84 void SetStyleName( const std::string& styleName );
87 * @copydoc Dali::Toolkit::Control::GetStyleName
89 const std::string& GetStyleName() const;
94 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
96 void SetBackgroundColor( const Vector4& color );
99 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
101 Vector4 GetBackgroundColor() const;
104 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
106 void SetBackgroundImage( Image image );
109 * @brief Set the background with a property map.
112 * @param[in] map The background property map.
114 void SetBackground(const Property::Map& map);
117 * @copydoc Dali::Toolkit::Control::ClearBackground
119 void ClearBackground();
124 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
126 * Gesture detection can be enabled one at a time or in bitwise format as shown:
128 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
131 * @param[in] type The gesture type(s) to enable.
133 void EnableGestureDetection( Gesture::Type type );
136 * @brief Allows deriving classes to disable any of the gesture detectors.
138 * Like EnableGestureDetection, this can also be called using bitwise or.
140 * @param[in] type The gesture type(s) to disable.
141 * @see EnableGetureDetection
143 void DisableGestureDetection( Gesture::Type type );
146 * @brief If deriving classes wish to fine tune pinch gesture
147 * detection then they can access the gesture detector through this
148 * API and modify the detection.
151 * @return The pinch gesture detector.
152 * @pre Pinch detection should have been enabled via EnableGestureDetection().
153 * @see EnableGestureDetection
155 PinchGestureDetector GetPinchGestureDetector() const;
158 * @brief If deriving classes wish to fine tune pan gesture
159 * detection then they can access the gesture detector through this
160 * API and modify the detection.
163 * @return The pan gesture detector.
164 * @pre Pan detection should have been enabled via EnableGestureDetection().
165 * @see EnableGestureDetection
167 PanGestureDetector GetPanGestureDetector() const;
170 * @brief If deriving classes wish to fine tune tap gesture
171 * detection then they can access the gesture detector through this
172 * API and modify the detection.
175 * @return The tap gesture detector.
176 * @pre Tap detection should have been enabled via EnableGestureDetection().
177 * @see EnableGestureDetection
179 TapGestureDetector GetTapGestureDetector() const;
182 * @brief If deriving classes wish to fine tune long press gesture
183 * detection then they can access the gesture detector through this
184 * API and modify the detection.
187 * @return The long press gesture detector.
188 * @pre Long press detection should have been enabled via EnableGestureDetection().
189 * @see EnableGestureDetection
191 LongPressGestureDetector GetLongPressGestureDetector() const;
193 // Keyboard Navigation
196 * @brief Sets whether this control supports two dimensional
197 * keyboard navigation (i.e. whether it knows how to handle the
198 * keyboard focus movement between its child actors).
200 * The control doesn't support it by default.
202 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
204 void SetKeyboardNavigationSupport( bool isSupported );
207 * @brief Gets whether this control supports two dimensional keyboard navigation.
210 * @return true if this control supports two dimensional keyboard navigation.
212 bool IsKeyboardNavigationSupported();
217 * @copydoc Toolkit::Control::SetKeyInputFocus()
219 void SetKeyInputFocus();
222 * @copydoc Toolkit::Control::HasKeyInputFocus()
224 bool HasKeyInputFocus();
227 * @copydoc Toolkit::Control::ClearKeyInputFocus()
229 void ClearKeyInputFocus();
234 * @brief Sets whether this control is a focus group for keyboard navigation.
236 * (i.e. the scope of keyboard focus movement
237 * can be limitied to its child actors). The control is not a focus group by default.
239 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
241 void SetAsKeyboardFocusGroup( bool isFocusGroup );
244 * @brief Gets whether this control is a focus group for keyboard navigation.
247 * @return true if this control is set as a focus group for keyboard navigation.
249 bool IsKeyboardFocusGroup();
253 * @brief Called by the AccessibilityManager to activate the Control.
256 DALI_INTERNAL void AccessibilityActivate();
259 * @brief Called by the KeyboardFocusManager.
262 DALI_INTERNAL void KeyboardEnter();
268 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
270 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
273 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
275 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
278 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
280 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
284 * @brief Called by the KeyInputFocusManager to emit key event signals.
287 * @param[in] event The key event.
288 * @return True if the event was consumed.
290 DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
293 protected: // For derived classes to call
296 * @brief Register a visual by Property Index, linking an Actor to visual when required.
297 * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
298 * No parenting is done during registration, this should be done by derived class.
302 * @param[in] index The Property index of the visual, used to reference visual
303 * @param[in] visual The visual to register
304 * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
305 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
307 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual );
310 * @brief Register a visual by Property Index, linking an Actor to visual when required.
311 * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
312 * If enabled is false then the visual is not set on stage until enabled by the derived class.
317 * @param[in] index The Property index of the visual, used to reference visual
318 * @param[in] visual The visual to register
319 * @param[in] enabled false if derived class wants to control when visual is set on stage.
322 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
325 * @brief Erase the entry matching the given index from the list of registered visuals
326 * @param[in] index The Property index of the visual, used to reference visual
330 void UnregisterVisual( Property::Index index );
333 * @brief Retrieve the visual associated with the given property index.
337 * @param[in] index The Property index of the visual.
338 * @return The registered visual if exist, otherwise empty handle.
339 * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
341 Toolkit::Visual::Base GetVisual( Property::Index index ) const;
344 * @brief Sets the given visual to be displayed or not when parent staged.
348 * @param[in] index The Property index of the visual
349 * @param[in] enable flag to set enabled or disabled.
351 void EnableVisual( Property::Index index, bool enable );
354 * @brief Queries if the given visual is to be displayed when parent staged.
358 * @param[in] index The Property index of the visual
359 * @return bool whether visual is enabled or not
361 bool IsVisualEnabled( Property::Index index ) const;
364 * @brief Create a transition effect on the control.
368 * @param[in] transitionData The transition data describing the effect to create
369 * @return A handle to an animation defined with the given effect, or an empty
370 * handle if no properties match.
372 Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData );
375 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
377 * Should be called last by the control after it acts on the Input Focus change.
380 * @param[in] focusGained True if gained, False if lost
382 void EmitKeyInputFocusSignal( bool focusGained );
384 protected: // From CustomActorImpl, not to be used by application developers
387 * @copydoc CustomActorImpl::OnStageConnection()
388 * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
390 virtual void OnStageConnection( int depth );
393 * @copydoc CustomActorImpl::OnStageDisconnection()
394 * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
396 virtual void OnStageDisconnection();
399 * @copydoc CustomActorImpl::OnChildAdd()
400 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
402 virtual void OnChildAdd( Actor& child );
405 * @copydoc CustomActorImpl::OnChildRemove()
406 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
408 virtual void OnChildRemove( Actor& child );
411 * @copydoc CustomActorImpl::OnSizeSet()
412 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
414 virtual void OnSizeSet( const Vector3& targetSize );
417 * @copydoc CustomActorImpl::OnSizeAnimation()
418 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
420 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
423 * @copydoc CustomActorImpl::OnTouchEvent()
425 virtual bool OnTouchEvent( const TouchEvent& event );
428 * @copydoc CustomActorImpl::OnHoverEvent()
430 virtual bool OnHoverEvent( const HoverEvent& event );
433 * @copydoc CustomActorImpl::OnKeyEvent()
435 virtual bool OnKeyEvent( const KeyEvent& event );
438 * @copydoc CustomActorImpl::OnWheelEvent()
440 virtual bool OnWheelEvent( const WheelEvent& event );
443 * @copydoc CustomActorImpl::OnRelayout()
445 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
448 * @copydoc CustomActorImpl::OnSetResizePolicy()
450 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
453 * @copydoc CustomActorImpl::GetNaturalSize()
455 virtual Vector3 GetNaturalSize();
458 * @copydoc CustomActorImpl::CalculateChildSize()
460 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
463 * @copydoc CustomActorImpl::GetHeightForWidth()
465 virtual float GetHeightForWidth( float width );
468 * @copydoc CustomActorImpl::GetWidthForHeight()
470 virtual float GetWidthForHeight( float height );
473 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
475 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
478 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
480 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
483 * @copydoc CustomActorImpl::OnLayoutNegotiated()
485 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
487 protected: // Helpers for deriving classes
492 * @brief Flags for the constructor
495 enum ControlBehaviour
497 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
498 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
499 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
501 DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10
503 LAST_CONTROL_BEHAVIOUR_FLAG
506 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
509 * @brief Control constructor
512 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
514 Control( ControlBehaviour behaviourFlags );
517 * @brief Virtual destructor.
523 * @brief Second phase initialization.
528 public: // API for derived classes to override
533 * @brief This method is called after the Control has been initialized.
535 * Derived classes should do any second phase initialization by overriding this method.
538 virtual void OnInitialize();
541 * @DEPRECATED_1_1.30. Override OnChildAdd instead.
543 * @brief Called whenever an Actor is added to the control.
545 * Could be overridden by derived classes.
548 * @param[in] child The added actor.
550 virtual void OnControlChildAdd( Actor& child );
553 * @DEPRECATED_1_1.30. Override OnChildRemove instead.
555 * @brief Called whenever an Actor is removed from the control.
557 * Could be overridden by derived classes.
560 * @param[in] child The removed actor.
562 virtual void OnControlChildRemove( Actor& child );
567 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
570 * @param[in] styleManager The StyleManager object.
571 * @param[in] change Information denoting what has changed.
573 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
578 * @brief This method is called when the control is accessibility activated.
580 * Derived classes should override this to perform custom accessibility activation.
582 * @return true if this control can perform accessibility activation.
584 virtual bool OnAccessibilityActivated();
587 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
591 * @param[in] gesture The pan gesture.
592 * @return true if the pan gesture has been consumed by this control
594 virtual bool OnAccessibilityPan( PanGesture gesture );
597 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
601 * @param[in] touchEvent The touch event.
602 * @return true if the touch event has been consumed by this control
604 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
607 * @brief This method should be overridden by deriving classes when they wish to respond
608 * the accessibility up and down action (i.e. value change of slider control).
611 * @param[in] isIncrease Whether the value should be increased or decreased
612 * @return true if the value changed action has been consumed by this control
614 virtual bool OnAccessibilityValueChange( bool isIncrease );
617 * @brief This method should be overridden by deriving classes when they wish to respond
618 * the accessibility zoom action.
621 * @return true if the zoom action has been consumed by this control
623 virtual bool OnAccessibilityZoom();
628 * @brief Called when the control gains key input focus.
630 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
633 virtual void OnKeyInputFocusGained();
636 * @brief Called when the control loses key input focus.
638 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
641 virtual void OnKeyInputFocusLost();
644 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
646 * A control needs to override this function in order to support two dimensional keyboard navigation.
648 * @param[in] currentFocusedActor The current focused actor.
649 * @param[in] direction The direction to move the focus towards.
650 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
651 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
653 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
656 * @brief Informs this control that its chosen focusable actor will be focused.
658 * This allows the application to preform any actions if wishes
659 * before the focus is actually moved to the chosen actor.
662 * @param[in] commitedFocusableActor The commited focusable actor.
664 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
667 * @brief This method is called when the control has enter pressed on it.
669 * Derived classes should override this to perform custom actions.
671 * @return true if this control supported this action.
673 virtual bool OnKeyboardEnter();
678 * @brief Called whenever a pinch gesture is detected on this control.
680 * This can be overridden by deriving classes when pinch detection
681 * is enabled. The default behaviour is to scale the control by the
685 * @param[in] pinch The pinch gesture.
686 * @note If overridden, then the default behaviour will not occur.
687 * @note Pinch detection should be enabled via EnableGestureDetection().
688 * @see EnableGestureDetection
690 virtual void OnPinch( const PinchGesture& pinch );
693 * @brief Called whenever a pan gesture is detected on this control.
695 * This should be overridden by deriving classes when pan detection
699 * @param[in] pan The pan gesture.
700 * @note There is no default behaviour with panning.
701 * @note Pan detection should be enabled via EnableGestureDetection().
702 * @see EnableGestureDetection
704 virtual void OnPan( const PanGesture& pan );
707 * @brief Called whenever a tap gesture is detected on this control.
709 * This should be overridden by deriving classes when tap detection
713 * @param[in] tap The tap gesture.
714 * @note There is no default behaviour with a tap.
715 * @note Tap detection should be enabled via EnableGestureDetection().
716 * @see EnableGestureDetection
718 virtual void OnTap( const TapGesture& tap );
721 * @brief Called whenever a long press gesture is detected on this control.
723 * This should be overridden by deriving classes when long press
724 * detection is enabled.
727 * @param[in] longPress The long press gesture.
728 * @note There is no default behaviour associated with a long press.
729 * @note Long press detection should be enabled via EnableGestureDetection().
730 * @see EnableGestureDetection
732 virtual void OnLongPress( const LongPressGesture& longPress );
734 // From ConnectionTrackerInterface
737 * @copydoc ConnectionTrackerInterface::SignalConnected
739 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
742 * @copydoc ConnectionTrackerInterface::SignalDisconnected
744 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
747 * @brief Retrieve the extension for this control
750 * @return The extension if available, NULL otherwise
752 virtual Extension* GetControlExtension()
761 DALI_INTERNAL Control( const Control& );
762 DALI_INTERNAL Control& operator=( const Control& );
771 * @brief Get implementation from the handle.
775 * @return implementation
776 * @pre handle is initialized and points to a control
778 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
781 * @brief Get implementation from the handle.
785 * @return implementation
786 * @pre handle is initialized and points to a control
788 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
790 } // namespace Internal
795 } // namespace Toolkit
799 #endif // DALI_TOOLKIT_CONTROL_IMPL_H