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
52 * @brief This is the internal base class for all controls.
54 * It will provide some common functionality required by all controls.
55 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
56 * be disconnected automatically when the control is destroyed.
59 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
63 class Extension; ///< Forward declare future extension interface
65 // Creation & Destruction
68 * @brief Create a new ControlImpl instance that does not require touch by default.
70 * If touch is required then the user can connect to this class' touch signal.
72 * @return A handle to the ControlImpl instance.
74 static Toolkit::Control New();
77 * @brief Virtual destructor.
85 * @copydoc Dali::Toolkit::Control::SetStyleName
87 void SetStyleName( const std::string& styleName );
90 * @copydoc Dali::Toolkit::Control::GetStyleName
92 const std::string& GetStyleName() const;
97 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
99 void SetBackgroundColor( const Vector4& color );
102 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
104 Vector4 GetBackgroundColor() const;
107 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
109 void SetBackgroundImage( Image image );
112 * @brief Set the background with a property map.
115 * @param[in] map The background property map.
117 void SetBackground(const Property::Map& map);
120 * @copydoc Dali::Toolkit::Control::ClearBackground
122 void ClearBackground();
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 limitied 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 Register a visual by Property Index, linking an Actor to visual when required.
300 * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
301 * No parenting is done during registration, this should be done by derived class.
305 * @param[in] index The Property index of the visual, used to reference visual
306 * @param[in] placementActor The actor used to by the visual.
307 * @param[in] visual The visual to register
308 * @note Derived class should not call visual.SetOnStage(placementActor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
309 * Use below API with enabled set to false if derived class wishes to control when visual is staged.
311 void RegisterVisual( Property::Index index, Actor& placementActor, Toolkit::Visual::Base& visual );
314 * @brief Register a visual by Property Index, linking an Actor to visual when required.
315 * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle.
316 * If enabled is false then the visual is not set on stage until enabled by the derived class.
321 * @param[in] index The Property index of the visual, used to reference visual
322 * @param[in] placementActor The actor used to by the visual.
323 * @param[in] visual The visual to register
324 * @param[in] enabled false if derived class wants to control when visual is set on stage.
327 void RegisterVisual( Property::Index index, Actor& placementActor, Toolkit::Visual::Base& visual, bool enabled );
330 * @brief Erase the entry matching the given index from the list of registered visuals
331 * @param[in] index The Property index of the visual, used to reference visual
335 void UnregisterVisual( Property::Index index );
338 * @brief Retrieve the visual associated with the given property index.
342 * @param[in] index The Property index of the visual.
343 * @return The registered visual if exist, otherwise empty handle.
344 * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
346 Toolkit::Visual::Base GetVisual( Property::Index index ) const;
349 * @brief Sets the given visual to be displayed or not when parent staged.
353 * @param[in] index The Property index of the visual
354 * @param[in] enable flag to set enabled or disabled.
356 void EnableVisual( Property::Index index, bool enable );
359 * @brief Queries if the given visual is to be displayed when parent staged.
363 * @param[in] index The Property index of the visual
364 * @return bool whether visual is enabled or not
366 bool IsVisualEnabled( Property::Index index ) const;
369 * @brief Retrieve the placement actor associated with the given index.
373 * @@param[in] index The Property index of the visual.
374 * @return Then placement actor if exist, otherwise empty handle.
375 * @note For managing object life-cycle, do not store the returned placement actor as a member which increments its reference count.
377 Actor GetPlacementActor( Property::Index index ) const;
380 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
382 * Should be called last by the control after it acts on the Input Focus change.
385 * @param[in] focusGained True if gained, False if lost
387 void EmitKeyInputFocusSignal( bool focusGained );
389 protected: // From CustomActorImpl, not to be used by application developers
392 * @copydoc CustomActorImpl::OnStageConnection()
393 * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
395 virtual void OnStageConnection( int depth );
398 * @copydoc CustomActorImpl::OnStageDisconnection()
399 * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
401 virtual void OnStageDisconnection();
404 * @copydoc CustomActorImpl::OnChildAdd()
405 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
407 virtual void OnChildAdd( Actor& child );
410 * @copydoc CustomActorImpl::OnChildRemove()
411 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
413 virtual void OnChildRemove( Actor& child );
416 * @copydoc CustomActorImpl::OnSizeSet()
417 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
419 virtual void OnSizeSet( const Vector3& targetSize );
422 * @copydoc CustomActorImpl::OnSizeAnimation()
423 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
425 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
428 * @copydoc CustomActorImpl::OnTouchEvent()
430 virtual bool OnTouchEvent( const TouchEvent& event );
433 * @copydoc CustomActorImpl::OnHoverEvent()
435 virtual bool OnHoverEvent( const HoverEvent& event );
438 * @copydoc CustomActorImpl::OnKeyEvent()
440 virtual bool OnKeyEvent( const KeyEvent& event );
443 * @copydoc CustomActorImpl::OnWheelEvent()
445 virtual bool OnWheelEvent( const WheelEvent& event );
448 * @copydoc CustomActorImpl::OnRelayout()
450 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
453 * @copydoc CustomActorImpl::OnSetResizePolicy()
455 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
458 * @copydoc CustomActorImpl::GetNaturalSize()
460 virtual Vector3 GetNaturalSize();
463 * @copydoc CustomActorImpl::CalculateChildSize()
465 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
468 * @copydoc CustomActorImpl::GetHeightForWidth()
470 virtual float GetHeightForWidth( float width );
473 * @copydoc CustomActorImpl::GetWidthForHeight()
475 virtual float GetWidthForHeight( float height );
478 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
480 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
483 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
485 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
488 * @copydoc CustomActorImpl::OnLayoutNegotiated()
490 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
492 protected: // Helpers for deriving classes
497 * @brief Flags for the constructor
500 enum ControlBehaviour
502 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
503 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
504 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
506 DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10
508 LAST_CONTROL_BEHAVIOUR_FLAG
511 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
514 * @brief Control constructor
517 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
519 Control( ControlBehaviour behaviourFlags );
522 * @brief Second phase initialization.
527 public: // API for derived classes to override
532 * @brief This method is called after the Control has been initialized.
534 * Derived classes should do any second phase initialization by overriding this method.
537 virtual void OnInitialize();
540 * @DEPRECATED_1_1.30. Override OnChildAdd instead.
542 * @brief Called whenever an Actor is added to the control.
544 * Could be overridden by derived classes.
547 * @param[in] child The added actor.
549 virtual void OnControlChildAdd( Actor& child );
552 * @DEPRECATED_1_1.30. Override OnChildRemove instead.
554 * @brief Called whenever an Actor is removed from the control.
556 * Could be overridden by derived classes.
559 * @param[in] child The removed actor.
561 virtual void OnControlChildRemove( Actor& child );
566 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
569 * @param[in] styleManager The StyleManager object.
570 * @param[in] change Information denoting what has changed.
572 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
577 * @brief This method is called when the control is accessibility activated.
579 * Derived classes should override this to perform custom accessibility activation.
581 * @return true if this control can perform accessibility activation.
583 virtual bool OnAccessibilityActivated();
586 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
590 * @param[in] gesture The pan gesture.
591 * @return true if the pan gesture has been consumed by this control
593 virtual bool OnAccessibilityPan( PanGesture gesture );
596 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
600 * @param[in] touchEvent The touch event.
601 * @return true if the touch event has been consumed by this control
603 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
606 * @brief This method should be overridden by deriving classes when they wish to respond
607 * the accessibility up and down action (i.e. value change of slider control).
610 * @param[in] isIncrease Whether the value should be increased or decreased
611 * @return true if the value changed action has been consumed by this control
613 virtual bool OnAccessibilityValueChange( bool isIncrease );
616 * @brief This method should be overridden by deriving classes when they wish to respond
617 * the accessibility zoom action.
620 * @return true if the zoom action has been consumed by this control
622 virtual bool OnAccessibilityZoom();
627 * @brief Called when the control gains key input focus.
629 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
632 virtual void OnKeyInputFocusGained();
635 * @brief Called when the control loses key input focus.
637 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
640 virtual void OnKeyInputFocusLost();
643 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
645 * A control needs to override this function in order to support two dimensional keyboard navigation.
647 * @param[in] currentFocusedActor The current focused actor.
648 * @param[in] direction The direction to move the focus towards.
649 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
650 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
652 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
655 * @brief Informs this control that its chosen focusable actor will be focused.
657 * This allows the application to preform any actions if wishes
658 * before the focus is actually moved to the chosen actor.
661 * @param[in] commitedFocusableActor The commited focusable actor.
663 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
666 * @brief This method is called when the control has enter pressed on it.
668 * Derived classes should override this to perform custom actions.
670 * @return true if this control supported this action.
672 virtual bool OnKeyboardEnter();
677 * @brief Called whenever a pinch gesture is detected on this control.
679 * This can be overridden by deriving classes when pinch detection
680 * is enabled. The default behaviour is to scale the control by the
684 * @param[in] pinch The pinch gesture.
685 * @note If overridden, then the default behaviour will not occur.
686 * @note Pinch detection should be enabled via EnableGestureDetection().
687 * @see EnableGestureDetection
689 virtual void OnPinch( const PinchGesture& pinch );
692 * @brief Called whenever a pan gesture is detected on this control.
694 * This should be overridden by deriving classes when pan detection
698 * @param[in] pan The pan gesture.
699 * @note There is no default behaviour with panning.
700 * @note Pan detection should be enabled via EnableGestureDetection().
701 * @see EnableGestureDetection
703 virtual void OnPan( const PanGesture& pan );
706 * @brief Called whenever a tap gesture is detected on this control.
708 * This should be overridden by deriving classes when tap detection
712 * @param[in] tap The tap gesture.
713 * @note There is no default behaviour with a tap.
714 * @note Tap detection should be enabled via EnableGestureDetection().
715 * @see EnableGestureDetection
717 virtual void OnTap( const TapGesture& tap );
720 * @brief Called whenever a long press gesture is detected on this control.
722 * This should be overridden by deriving classes when long press
723 * detection is enabled.
726 * @param[in] longPress The long press gesture.
727 * @note There is no default behaviour associated with a long press.
728 * @note Long press detection should be enabled via EnableGestureDetection().
729 * @see EnableGestureDetection
731 virtual void OnLongPress( const LongPressGesture& longPress );
733 // From ConnectionTrackerInterface
736 * @copydoc ConnectionTrackerInterface::SignalConnected
738 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
741 * @copydoc ConnectionTrackerInterface::SignalDisconnected
743 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
746 * @brief Retrieve the extension for this control
749 * @return The extension if available, NULL otherwise
751 virtual Extension* GetControlExtension()
760 DALI_INTERNAL Control( const Control& );
761 DALI_INTERNAL Control& operator=( const Control& );
770 * @brief Get implementation from the handle.
774 * @return implementation
775 * @pre handle is initialized and points to a control
777 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
780 * @brief Get implementation from the handle.
784 * @return implementation
785 * @pre handle is initialized and points to a control
787 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
789 } // namespace Internal
794 } // namespace Toolkit
798 #endif // DALI_TOOLKIT_CONTROL_IMPL_H