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 controlRenderer when required.
300 * In the case of the visual being an actor or control deeming controlRenderer not required then controlRenderer 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 must NOT call visual.SetOnStage(placementActor). It is the responsibility of the base class to connect/disconnect registered visual to stage.
310 void RegisterVisual( Property::Index index, Actor& placementActor, Toolkit::Visual::Base& visual );
313 * @brief Erase the entry matching the given index from the list of registered visuals
314 * @param[in] index The Property index of the visual, used to reference visual
318 void UnregisterVisual( Property::Index index );
321 * @brief Retrieve the visual associated with the given property index.
325 * @param[in] index The Property index of the visual.
326 * @return The registered visual if exist, otherwise empty handle.
327 * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count.
329 Toolkit::Visual::Base GetVisual( Property::Index index ) const;
332 * @brief Retrieve the placement actor associated with the given index.
336 * @@param[in] index The Property index of the visual.
337 * @return Then placement actor if exist, otherwise empty handle.
338 * @note For managing object life-cycle, do not store the returned placement actor as a member which increments its reference count.
340 Actor GetPlacementActor( Property::Index index ) const;
343 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
345 * Should be called last by the control after it acts on the Input Focus change.
348 * @param[in] focusGained True if gained, False if lost
350 void EmitKeyInputFocusSignal( bool focusGained );
352 protected: // From CustomActorImpl, not to be used by application developers
355 * @copydoc CustomActorImpl::OnStageConnection()
356 * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
358 virtual void OnStageConnection( int depth );
361 * @copydoc CustomActorImpl::OnStageDisconnection()
362 * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
364 virtual void OnStageDisconnection();
367 * @copydoc CustomActorImpl::OnChildAdd()
368 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
370 virtual void OnChildAdd( Actor& child );
373 * @copydoc CustomActorImpl::OnChildRemove()
374 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
376 virtual void OnChildRemove( Actor& child );
379 * @copydoc CustomActorImpl::OnSizeSet()
380 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
382 virtual void OnSizeSet( const Vector3& targetSize );
385 * @copydoc CustomActorImpl::OnSizeAnimation()
386 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
388 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
391 * @copydoc CustomActorImpl::OnTouchEvent()
393 virtual bool OnTouchEvent( const TouchEvent& event );
396 * @copydoc CustomActorImpl::OnHoverEvent()
398 virtual bool OnHoverEvent( const HoverEvent& event );
401 * @copydoc CustomActorImpl::OnKeyEvent()
403 virtual bool OnKeyEvent( const KeyEvent& event );
406 * @copydoc CustomActorImpl::OnWheelEvent()
408 virtual bool OnWheelEvent( const WheelEvent& event );
411 * @copydoc CustomActorImpl::OnRelayout()
413 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
416 * @copydoc CustomActorImpl::OnSetResizePolicy()
418 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
421 * @copydoc CustomActorImpl::GetNaturalSize()
423 virtual Vector3 GetNaturalSize();
426 * @copydoc CustomActorImpl::CalculateChildSize()
428 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
431 * @copydoc CustomActorImpl::GetHeightForWidth()
433 virtual float GetHeightForWidth( float width );
436 * @copydoc CustomActorImpl::GetWidthForHeight()
438 virtual float GetWidthForHeight( float height );
441 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
443 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
446 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
448 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
451 * @copydoc CustomActorImpl::OnLayoutNegotiated()
453 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
455 protected: // Helpers for deriving classes
460 * @brief Flags for the constructor
463 enum ControlBehaviour
465 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
466 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
467 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
469 DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10
471 LAST_CONTROL_BEHAVIOUR_FLAG
474 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
477 * @brief Control constructor
480 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
482 Control( ControlBehaviour behaviourFlags );
485 * @brief Second phase initialization.
490 public: // API for derived classes to override
495 * @brief This method is called after the Control has been initialized.
497 * Derived classes should do any second phase initialization by overriding this method.
500 virtual void OnInitialize();
503 * @DEPRECATED_1_1.30. Override OnChildAdd instead.
505 * @brief Called whenever an Actor is added to the control.
507 * Could be overridden by derived classes.
510 * @param[in] child The added actor.
512 virtual void OnControlChildAdd( Actor& child );
515 * @DEPRECATED_1_1.30. Override OnChildRemove instead.
517 * @brief Called whenever an Actor is removed from the control.
519 * Could be overridden by derived classes.
522 * @param[in] child The removed actor.
524 virtual void OnControlChildRemove( Actor& child );
529 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
532 * @param[in] styleManager The StyleManager object.
533 * @param[in] change Information denoting what has changed.
535 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
540 * @brief This method is called when the control is accessibility activated.
542 * Derived classes should override this to perform custom accessibility activation.
544 * @return true if this control can perform accessibility activation.
546 virtual bool OnAccessibilityActivated();
549 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
553 * @param[in] gesture The pan gesture.
554 * @return true if the pan gesture has been consumed by this control
556 virtual bool OnAccessibilityPan( PanGesture gesture );
559 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
563 * @param[in] touchEvent The touch event.
564 * @return true if the touch event has been consumed by this control
566 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
569 * @brief This method should be overridden by deriving classes when they wish to respond
570 * the accessibility up and down action (i.e. value change of slider control).
573 * @param[in] isIncrease Whether the value should be increased or decreased
574 * @return true if the value changed action has been consumed by this control
576 virtual bool OnAccessibilityValueChange( bool isIncrease );
579 * @brief This method should be overridden by deriving classes when they wish to respond
580 * the accessibility zoom action.
583 * @return true if the zoom action has been consumed by this control
585 virtual bool OnAccessibilityZoom();
590 * @brief Called when the control gains key input focus.
592 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
595 virtual void OnKeyInputFocusGained();
598 * @brief Called when the control loses key input focus.
600 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
603 virtual void OnKeyInputFocusLost();
606 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
608 * A control needs to override this function in order to support two dimensional keyboard navigation.
610 * @param[in] currentFocusedActor The current focused actor.
611 * @param[in] direction The direction to move the focus towards.
612 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
613 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
615 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
618 * @brief Informs this control that its chosen focusable actor will be focused.
620 * This allows the application to preform any actions if wishes
621 * before the focus is actually moved to the chosen actor.
624 * @param[in] commitedFocusableActor The commited focusable actor.
626 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
629 * @brief This method is called when the control has enter pressed on it.
631 * Derived classes should override this to perform custom actions.
633 * @return true if this control supported this action.
635 virtual bool OnKeyboardEnter();
640 * @brief Called whenever a pinch gesture is detected on this control.
642 * This can be overridden by deriving classes when pinch detection
643 * is enabled. The default behaviour is to scale the control by the
647 * @param[in] pinch The pinch gesture.
648 * @note If overridden, then the default behaviour will not occur.
649 * @note Pinch detection should be enabled via EnableGestureDetection().
650 * @see EnableGestureDetection
652 virtual void OnPinch( const PinchGesture& pinch );
655 * @brief Called whenever a pan gesture is detected on this control.
657 * This should be overridden by deriving classes when pan detection
661 * @param[in] pan The pan gesture.
662 * @note There is no default behaviour with panning.
663 * @note Pan detection should be enabled via EnableGestureDetection().
664 * @see EnableGestureDetection
666 virtual void OnPan( const PanGesture& pan );
669 * @brief Called whenever a tap gesture is detected on this control.
671 * This should be overridden by deriving classes when tap detection
675 * @param[in] tap The tap gesture.
676 * @note There is no default behaviour with a tap.
677 * @note Tap detection should be enabled via EnableGestureDetection().
678 * @see EnableGestureDetection
680 virtual void OnTap( const TapGesture& tap );
683 * @brief Called whenever a long press gesture is detected on this control.
685 * This should be overridden by deriving classes when long press
686 * detection is enabled.
689 * @param[in] longPress The long press gesture.
690 * @note There is no default behaviour associated with a long press.
691 * @note Long press detection should be enabled via EnableGestureDetection().
692 * @see EnableGestureDetection
694 virtual void OnLongPress( const LongPressGesture& longPress );
696 // From ConnectionTrackerInterface
699 * @copydoc ConnectionTrackerInterface::SignalConnected
701 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
704 * @copydoc ConnectionTrackerInterface::SignalDisconnected
706 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
709 * @brief Retrieve the extension for this control
712 * @return The extension if available, NULL otherwise
714 virtual Extension* GetControlExtension()
723 DALI_INTERNAL Control( const Control& );
724 DALI_INTERNAL Control& operator=( const Control& );
733 * @brief Get implementation from the handle.
737 * @return implementation
738 * @pre handle is initialized and points to a control
740 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
743 * @brief Get implementation from the handle.
747 * @return implementation
748 * @pre handle is initialized and points to a control
750 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
752 } // namespace Internal
757 } // namespace Toolkit
761 #endif // DALI_TOOLKIT_CONTROL_IMPL_H