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();
81 * @brief Virtual destructor.
90 * @copydoc Dali::Toolkit::Control::SetStyleName
92 void SetStyleName( const std::string& styleName );
95 * @copydoc Dali::Toolkit::Control::GetStyleName
97 const std::string& GetStyleName() const;
102 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
104 void SetBackgroundColor( const Vector4& color );
107 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
109 Vector4 GetBackgroundColor() const;
112 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
114 void SetBackgroundImage( Image image );
117 * @brief Set the background with a property map.
120 * @param[in] map The background property map.
122 void SetBackground(const Property::Map& map);
125 * @copydoc Dali::Toolkit::Control::ClearBackground
127 void ClearBackground();
132 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
134 * Gesture detection can be enabled one at a time or in bitwise format as shown:
136 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
139 * @param[in] type The gesture type(s) to enable.
141 void EnableGestureDetection( Gesture::Type type );
144 * @brief Allows deriving classes to disable any of the gesture detectors.
146 * Like EnableGestureDetection, this can also be called using bitwise or.
148 * @param[in] type The gesture type(s) to disable.
149 * @see EnableGetureDetection
151 void DisableGestureDetection( Gesture::Type type );
154 * @brief If deriving classes wish to fine tune pinch gesture
155 * detection then they can access the gesture detector through this
156 * API and modify the detection.
159 * @return The pinch gesture detector.
160 * @pre Pinch detection should have been enabled via EnableGestureDetection().
161 * @see EnableGestureDetection
163 PinchGestureDetector GetPinchGestureDetector() const;
166 * @brief If deriving classes wish to fine tune pan gesture
167 * detection then they can access the gesture detector through this
168 * API and modify the detection.
171 * @return The pan gesture detector.
172 * @pre Pan detection should have been enabled via EnableGestureDetection().
173 * @see EnableGestureDetection
175 PanGestureDetector GetPanGestureDetector() const;
178 * @brief If deriving classes wish to fine tune tap gesture
179 * detection then they can access the gesture detector through this
180 * API and modify the detection.
183 * @return The tap gesture detector.
184 * @pre Tap detection should have been enabled via EnableGestureDetection().
185 * @see EnableGestureDetection
187 TapGestureDetector GetTapGestureDetector() const;
190 * @brief If deriving classes wish to fine tune long press gesture
191 * detection then they can access the gesture detector through this
192 * API and modify the detection.
195 * @return The long press gesture detector.
196 * @pre Long press detection should have been enabled via EnableGestureDetection().
197 * @see EnableGestureDetection
199 LongPressGestureDetector GetLongPressGestureDetector() const;
201 // Keyboard Navigation
204 * @brief Sets whether this control supports two dimensional
205 * keyboard navigation (i.e. whether it knows how to handle the
206 * keyboard focus movement between its child actors).
208 * The control doesn't support it by default.
210 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
212 void SetKeyboardNavigationSupport( bool isSupported );
215 * @brief Gets whether this control supports two dimensional keyboard navigation.
218 * @return true if this control supports two dimensional keyboard navigation.
220 bool IsKeyboardNavigationSupported();
225 * @copydoc Toolkit::Control::SetKeyInputFocus()
227 void SetKeyInputFocus();
230 * @copydoc Toolkit::Control::HasKeyInputFocus()
232 bool HasKeyInputFocus();
235 * @copydoc Toolkit::Control::ClearKeyInputFocus()
237 void ClearKeyInputFocus();
242 * @brief Sets whether this control is a focus group for keyboard navigation.
244 * (i.e. the scope of keyboard focus movement
245 * can be limitied to its child actors). The control is not a focus group by default.
247 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
249 void SetAsKeyboardFocusGroup( bool isFocusGroup );
252 * @brief Gets whether this control is a focus group for keyboard navigation.
255 * @return true if this control is set as a focus group for keyboard navigation.
257 bool IsKeyboardFocusGroup();
261 * @brief Called by the AccessibilityManager to activate the Control.
264 DALI_INTERNAL void AccessibilityActivate();
267 * @brief Called by the KeyboardFocusManager.
270 DALI_INTERNAL void KeyboardEnter();
276 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
278 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
281 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
283 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
286 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
288 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
292 * @brief Called by the KeyInputFocusManager to emit key event signals.
295 * @param[in] event The key event.
296 * @return True if the event was consumed.
298 DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
301 protected: // For derived classes to call
304 * @brief Register a visual by Property Index, linking an Actor to visual when required.
305 * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
306 * No parenting is done during registration, this should be done by derived class.
310 * @param[in] index The Property index of the visual, used to reference visual
311 * @param[in] visual The visual to register
312 * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
313 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
315 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual );
318 * @brief Register a visual by Property Index, linking an Actor to visual when required.
319 * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
320 * If enabled is false then the visual is not set on stage until enabled by the derived class.
325 * @param[in] index The Property index of the visual, used to reference visual
326 * @param[in] visual The visual to register
327 * @param[in] enabled false if derived class wants to control when visual is set on stage.
330 void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled );
333 * @brief Erase the entry matching the given index from the list of registered visuals
334 * @param[in] index The Property index of the visual, used to reference visual
338 void UnregisterVisual( Property::Index index );
341 * @brief Retrieve the visual associated with the given property index.
345 * @param[in] index The Property index of the visual.
346 * @return The registered visual if exist, otherwise empty handle.
347 * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
349 Toolkit::Visual::Base GetVisual( Property::Index index ) const;
352 * @brief Sets the given visual to be displayed or not when parent staged.
356 * @param[in] index The Property index of the visual
357 * @param[in] enable flag to set enabled or disabled.
359 void EnableVisual( Property::Index index, bool enable );
362 * @brief Queries if the given visual is to be displayed when parent staged.
366 * @param[in] index The Property index of the visual
367 * @return bool whether visual is enabled or not
369 bool IsVisualEnabled( Property::Index index ) const;
372 * @brief Create a transition effect on the control.
376 * @param[in] transitionData The transition data describing the effect to create
377 * @return A handle to an animation defined with the given effect, or an empty
378 * handle if no properties match.
380 Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData );
383 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
385 * Should be called last by the control after it acts on the Input Focus change.
388 * @param[in] focusGained True if gained, False if lost
390 void EmitKeyInputFocusSignal( bool focusGained );
392 protected: // From CustomActorImpl, not to be used by application developers
395 * @copydoc CustomActorImpl::OnStageConnection()
396 * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
398 virtual void OnStageConnection( int depth );
401 * @copydoc CustomActorImpl::OnStageDisconnection()
402 * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
404 virtual void OnStageDisconnection();
407 * @copydoc CustomActorImpl::OnChildAdd()
408 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
410 virtual void OnChildAdd( Actor& child );
413 * @copydoc CustomActorImpl::OnChildRemove()
414 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
416 virtual void OnChildRemove( Actor& child );
419 * @copydoc CustomActorImpl::OnSizeSet()
420 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
422 virtual void OnSizeSet( const Vector3& targetSize );
425 * @copydoc CustomActorImpl::OnSizeAnimation()
426 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
428 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
431 * @copydoc CustomActorImpl::OnTouchEvent()
433 virtual bool OnTouchEvent( const TouchEvent& event );
436 * @copydoc CustomActorImpl::OnHoverEvent()
438 virtual bool OnHoverEvent( const HoverEvent& event );
441 * @copydoc CustomActorImpl::OnKeyEvent()
443 virtual bool OnKeyEvent( const KeyEvent& event );
446 * @copydoc CustomActorImpl::OnWheelEvent()
448 virtual bool OnWheelEvent( const WheelEvent& event );
451 * @copydoc CustomActorImpl::OnRelayout()
453 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
456 * @copydoc CustomActorImpl::OnSetResizePolicy()
458 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
461 * @copydoc CustomActorImpl::GetNaturalSize()
463 virtual Vector3 GetNaturalSize();
466 * @copydoc CustomActorImpl::CalculateChildSize()
468 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
471 * @copydoc CustomActorImpl::GetHeightForWidth()
473 virtual float GetHeightForWidth( float width );
476 * @copydoc CustomActorImpl::GetWidthForHeight()
478 virtual float GetWidthForHeight( float height );
481 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
483 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
486 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
488 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
491 * @copydoc CustomActorImpl::OnLayoutNegotiated()
493 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
495 protected: // Helpers for deriving classes
500 * @brief Flags for the constructor
503 enum ControlBehaviour
505 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
506 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
507 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
509 DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10
511 LAST_CONTROL_BEHAVIOUR_FLAG
514 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
517 * @brief Control constructor
520 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
522 Control( ControlBehaviour behaviourFlags );
525 * @brief Second phase initialization.
530 public: // API for derived classes to override
535 * @brief This method is called after the Control has been initialized.
537 * Derived classes should do any second phase initialization by overriding this method.
540 virtual void OnInitialize();
543 * @DEPRECATED_1_1.30. Override OnChildAdd instead.
545 * @brief Called whenever an Actor is added to the control.
547 * Could be overridden by derived classes.
550 * @param[in] child The added actor.
552 virtual void OnControlChildAdd( Actor& child ) DALI_DEPRECATED_API;
555 * @DEPRECATED_1_1.30. Override OnChildRemove instead.
557 * @brief Called whenever an Actor is removed from the control.
559 * Could be overridden by derived classes.
562 * @param[in] child The removed actor.
564 virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API;
569 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
572 * @param[in] styleManager The StyleManager object.
573 * @param[in] change Information denoting what has changed.
575 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
580 * @brief This method is called when the control is accessibility activated.
582 * Derived classes should override this to perform custom accessibility activation.
584 * @return true if this control can perform accessibility activation.
586 virtual bool OnAccessibilityActivated();
589 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
593 * @param[in] gesture The pan gesture.
594 * @return true if the pan gesture has been consumed by this control
596 virtual bool OnAccessibilityPan( PanGesture gesture );
599 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
603 * @param[in] touchEvent The touch event.
604 * @return true if the touch event has been consumed by this control
606 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
609 * @brief This method should be overridden by deriving classes when they wish to respond
610 * the accessibility up and down action (i.e. value change of slider control).
613 * @param[in] isIncrease Whether the value should be increased or decreased
614 * @return true if the value changed action has been consumed by this control
616 virtual bool OnAccessibilityValueChange( bool isIncrease );
619 * @brief This method should be overridden by deriving classes when they wish to respond
620 * the accessibility zoom action.
623 * @return true if the zoom action has been consumed by this control
625 virtual bool OnAccessibilityZoom();
630 * @brief Called when the control gains key input focus.
632 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
635 virtual void OnKeyInputFocusGained();
638 * @brief Called when the control loses key input focus.
640 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
643 virtual void OnKeyInputFocusLost();
646 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
648 * A control needs to override this function in order to support two dimensional keyboard navigation.
650 * @param[in] currentFocusedActor The current focused actor.
651 * @param[in] direction The direction to move the focus towards.
652 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
653 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
655 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
658 * @brief Informs this control that its chosen focusable actor will be focused.
660 * This allows the application to preform any actions if wishes
661 * before the focus is actually moved to the chosen actor.
664 * @param[in] commitedFocusableActor The commited focusable actor.
666 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
669 * @brief This method is called when the control has enter pressed on it.
671 * Derived classes should override this to perform custom actions.
673 * @return true if this control supported this action.
675 virtual bool OnKeyboardEnter();
680 * @brief Called whenever a pinch gesture is detected on this control.
682 * This can be overridden by deriving classes when pinch detection
683 * is enabled. The default behaviour is to scale the control by the
687 * @param[in] pinch The pinch gesture.
688 * @note If overridden, then the default behaviour will not occur.
689 * @note Pinch detection should be enabled via EnableGestureDetection().
690 * @see EnableGestureDetection
692 virtual void OnPinch( const PinchGesture& pinch );
695 * @brief Called whenever a pan gesture is detected on this control.
697 * This should be overridden by deriving classes when pan detection
701 * @param[in] pan The pan gesture.
702 * @note There is no default behaviour with panning.
703 * @note Pan detection should be enabled via EnableGestureDetection().
704 * @see EnableGestureDetection
706 virtual void OnPan( const PanGesture& pan );
709 * @brief Called whenever a tap gesture is detected on this control.
711 * This should be overridden by deriving classes when tap detection
715 * @param[in] tap The tap gesture.
716 * @note There is no default behaviour with a tap.
717 * @note Tap detection should be enabled via EnableGestureDetection().
718 * @see EnableGestureDetection
720 virtual void OnTap( const TapGesture& tap );
723 * @brief Called whenever a long press gesture is detected on this control.
725 * This should be overridden by deriving classes when long press
726 * detection is enabled.
729 * @param[in] longPress The long press gesture.
730 * @note There is no default behaviour associated with a long press.
731 * @note Long press detection should be enabled via EnableGestureDetection().
732 * @see EnableGestureDetection
734 virtual void OnLongPress( const LongPressGesture& longPress );
736 // From ConnectionTrackerInterface
739 * @copydoc ConnectionTrackerInterface::SignalConnected
741 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
744 * @copydoc ConnectionTrackerInterface::SignalDisconnected
746 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
749 * @brief Retrieve the extension for this control
752 * @return The extension if available, NULL otherwise
754 virtual Extension* GetControlExtension()
763 DALI_INTERNAL Control( const Control& );
764 DALI_INTERNAL Control& operator=( const Control& );
773 * @brief Get implementation from the handle.
777 * @return implementation
778 * @pre handle is initialized and points to a control
780 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
783 * @brief Get implementation from the handle.
787 * @return implementation
788 * @pre handle is initialized and points to a control
790 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
792 } // namespace Internal
797 } // namespace Toolkit
801 #endif // DALI_TOOLKIT_CONTROL_IMPL_H