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
48 * @brief This is the internal base class for all controls.
50 * It will provide some common functionality required by all controls.
51 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
52 * be disconnected automatically when the control is destroyed.
55 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
59 class Extension; ///< Forward declare future extension interface
61 // Creation & Destruction
64 * @brief Create a new ControlImpl instance that does not require touch by default.
66 * If touch is required then the user can connect to this class' touch signal.
68 * @return A handle to the ControlImpl instance.
70 static Toolkit::Control New();
74 * @brief Virtual destructor.
83 * @copydoc Dali::Toolkit::Control::SetStyleName
85 void SetStyleName( const std::string& styleName );
88 * @copydoc Dali::Toolkit::Control::GetStyleName
90 const std::string& GetStyleName() const;
95 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
97 void SetBackgroundColor( const Vector4& color );
100 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
102 Vector4 GetBackgroundColor() const;
105 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
107 void SetBackgroundImage( Image image );
110 * @brief Set the background with a property map.
113 * @param[in] map The background property map.
115 void SetBackground(const Property::Map& map);
118 * @copydoc Dali::Toolkit::Control::ClearBackground
120 void ClearBackground();
125 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
127 * Gesture detection can be enabled one at a time or in bitwise format as shown:
129 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
132 * @param[in] type The gesture type(s) to enable.
134 void EnableGestureDetection( Gesture::Type type );
137 * @brief Allows deriving classes to disable any of the gesture detectors.
139 * Like EnableGestureDetection, this can also be called using bitwise or.
141 * @param[in] type The gesture type(s) to disable.
142 * @see EnableGetureDetection
144 void DisableGestureDetection( Gesture::Type type );
147 * @brief If deriving classes wish to fine tune pinch gesture
148 * detection then they can access the gesture detector through this
149 * API and modify the detection.
152 * @return The pinch gesture detector.
153 * @pre Pinch detection should have been enabled via EnableGestureDetection().
154 * @see EnableGestureDetection
156 PinchGestureDetector GetPinchGestureDetector() const;
159 * @brief If deriving classes wish to fine tune pan gesture
160 * detection then they can access the gesture detector through this
161 * API and modify the detection.
164 * @return The pan gesture detector.
165 * @pre Pan detection should have been enabled via EnableGestureDetection().
166 * @see EnableGestureDetection
168 PanGestureDetector GetPanGestureDetector() const;
171 * @brief If deriving classes wish to fine tune tap gesture
172 * detection then they can access the gesture detector through this
173 * API and modify the detection.
176 * @return The tap gesture detector.
177 * @pre Tap detection should have been enabled via EnableGestureDetection().
178 * @see EnableGestureDetection
180 TapGestureDetector GetTapGestureDetector() const;
183 * @brief If deriving classes wish to fine tune long press gesture
184 * detection then they can access the gesture detector through this
185 * API and modify the detection.
188 * @return The long press gesture detector.
189 * @pre Long press detection should have been enabled via EnableGestureDetection().
190 * @see EnableGestureDetection
192 LongPressGestureDetector GetLongPressGestureDetector() const;
194 // Keyboard Navigation
197 * @brief Sets whether this control supports two dimensional
198 * keyboard navigation (i.e. whether it knows how to handle the
199 * keyboard focus movement between its child actors).
201 * The control doesn't support it by default.
203 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
205 void SetKeyboardNavigationSupport( bool isSupported );
208 * @brief Gets whether this control supports two dimensional keyboard navigation.
211 * @return true if this control supports two dimensional keyboard navigation.
213 bool IsKeyboardNavigationSupported();
218 * @copydoc Toolkit::Control::SetKeyInputFocus()
220 void SetKeyInputFocus();
223 * @copydoc Toolkit::Control::HasKeyInputFocus()
225 bool HasKeyInputFocus();
228 * @copydoc Toolkit::Control::ClearKeyInputFocus()
230 void ClearKeyInputFocus();
235 * @brief Sets whether this control is a focus group for keyboard navigation.
237 * (i.e. the scope of keyboard focus movement
238 * can be limitied to its child actors). The control is not a focus group by default.
240 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
242 void SetAsKeyboardFocusGroup( bool isFocusGroup );
245 * @brief Gets whether this control is a focus group for keyboard navigation.
248 * @return true if this control is set as a focus group for keyboard navigation.
250 bool IsKeyboardFocusGroup();
254 * @brief Called by the AccessibilityManager to activate the Control.
257 DALI_INTERNAL void AccessibilityActivate();
261 * @brief Called by the KeyboardFocusManager.
264 DALI_INTERNAL void KeyboardEnter();
269 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
271 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
274 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
276 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
279 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
281 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
285 * @brief Called by the KeyInputFocusManager to emit key event signals.
288 * @param[in] event The key event.
289 * @return True if the event was consumed.
291 DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
293 protected: // For derived classes to call
296 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
298 * Should be called last by the control after it acts on the Input Focus change.
301 * @param[in] focusGained True if gained, False if lost
303 void EmitKeyInputFocusSignal( bool focusGained );
305 protected: // From CustomActorImpl, not to be used by application developers
308 * @copydoc CustomActorImpl::OnStageConnection()
309 * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
311 virtual void OnStageConnection( int depth );
314 * @copydoc CustomActorImpl::OnStageDisconnection()
315 * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
317 virtual void OnStageDisconnection();
320 * @copydoc CustomActorImpl::OnChildAdd()
321 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
323 virtual void OnChildAdd( Actor& child );
326 * @copydoc CustomActorImpl::OnChildRemove()
327 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
329 virtual void OnChildRemove( Actor& child );
332 * @copydoc CustomActorImpl::OnSizeSet()
333 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
335 virtual void OnSizeSet( const Vector3& targetSize );
338 * @copydoc CustomActorImpl::OnSizeAnimation()
339 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
341 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
344 * @copydoc CustomActorImpl::OnTouchEvent()
346 virtual bool OnTouchEvent( const TouchEvent& event );
349 * @copydoc CustomActorImpl::OnHoverEvent()
351 virtual bool OnHoverEvent( const HoverEvent& event );
354 * @copydoc CustomActorImpl::OnKeyEvent()
356 virtual bool OnKeyEvent( const KeyEvent& event );
359 * @copydoc CustomActorImpl::OnWheelEvent()
361 virtual bool OnWheelEvent( const WheelEvent& event );
364 * @copydoc CustomActorImpl::OnRelayout()
366 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
369 * @copydoc CustomActorImpl::OnSetResizePolicy()
371 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
374 * @copydoc CustomActorImpl::GetNaturalSize()
376 virtual Vector3 GetNaturalSize();
379 * @copydoc CustomActorImpl::CalculateChildSize()
381 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
384 * @copydoc CustomActorImpl::GetHeightForWidth()
386 virtual float GetHeightForWidth( float width );
389 * @copydoc CustomActorImpl::GetWidthForHeight()
391 virtual float GetWidthForHeight( float height );
394 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
396 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
399 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
401 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
404 * @copydoc CustomActorImpl::OnLayoutNegotiated()
406 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
408 protected: // Helpers for deriving classes
413 * @brief Flags for the constructor
416 enum ControlBehaviour
418 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
419 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
420 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
422 DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10
424 LAST_CONTROL_BEHAVIOUR_FLAG
427 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
430 * @brief Control constructor
433 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
435 Control( ControlBehaviour behaviourFlags );
438 * @brief Second phase initialization.
443 public: // API for derived classes to override
448 * @brief This method is called after the Control has been initialized.
450 * Derived classes should do any second phase initialization by overriding this method.
453 virtual void OnInitialize();
456 * @DEPRECATED_1_1.30. Override OnChildAdd instead.
458 * @brief Called whenever an Actor is added to the control.
460 * Could be overridden by derived classes.
463 * @param[in] child The added actor.
465 virtual void OnControlChildAdd( Actor& child ) DALI_DEPRECATED_API;
468 * @DEPRECATED_1_1.30. Override OnChildRemove instead.
470 * @brief Called whenever an Actor is removed from the control.
472 * Could be overridden by derived classes.
475 * @param[in] child The removed actor.
477 virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API;
482 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
485 * @param[in] styleManager The StyleManager object.
486 * @param[in] change Information denoting what has changed.
488 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
493 * @brief This method is called when the control is accessibility activated.
495 * Derived classes should override this to perform custom accessibility activation.
497 * @return true if this control can perform accessibility activation.
499 virtual bool OnAccessibilityActivated();
502 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
506 * @param[in] gesture The pan gesture.
507 * @return true if the pan gesture has been consumed by this control
509 virtual bool OnAccessibilityPan( PanGesture gesture );
512 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
516 * @param[in] touchEvent The touch event.
517 * @return true if the touch event has been consumed by this control
519 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
522 * @brief This method should be overridden by deriving classes when they wish to respond
523 * the accessibility up and down action (i.e. value change of slider control).
526 * @param[in] isIncrease Whether the value should be increased or decreased
527 * @return true if the value changed action has been consumed by this control
529 virtual bool OnAccessibilityValueChange( bool isIncrease );
532 * @brief This method should be overridden by deriving classes when they wish to respond
533 * the accessibility zoom action.
536 * @return true if the zoom action has been consumed by this control
538 virtual bool OnAccessibilityZoom();
543 * @brief Called when the control gains key input focus.
545 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
548 virtual void OnKeyInputFocusGained();
551 * @brief Called when the control loses key input focus.
553 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
556 virtual void OnKeyInputFocusLost();
559 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
561 * A control needs to override this function in order to support two dimensional keyboard navigation.
563 * @param[in] currentFocusedActor The current focused actor.
564 * @param[in] direction The direction to move the focus towards.
565 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
566 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
568 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
571 * @brief Informs this control that its chosen focusable actor will be focused.
573 * This allows the application to preform any actions if wishes
574 * before the focus is actually moved to the chosen actor.
577 * @param[in] commitedFocusableActor The commited focusable actor.
579 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
582 * @brief This method is called when the control has enter pressed on it.
584 * Derived classes should override this to perform custom actions.
586 * @return true if this control supported this action.
588 virtual bool OnKeyboardEnter();
593 * @brief Called whenever a pinch gesture is detected on this control.
595 * This can be overridden by deriving classes when pinch detection
596 * is enabled. The default behaviour is to scale the control by the
600 * @param[in] pinch The pinch gesture.
601 * @note If overridden, then the default behaviour will not occur.
602 * @note Pinch detection should be enabled via EnableGestureDetection().
603 * @see EnableGestureDetection
605 virtual void OnPinch( const PinchGesture& pinch );
608 * @brief Called whenever a pan gesture is detected on this control.
610 * This should be overridden by deriving classes when pan detection
614 * @param[in] pan The pan gesture.
615 * @note There is no default behaviour with panning.
616 * @note Pan detection should be enabled via EnableGestureDetection().
617 * @see EnableGestureDetection
619 virtual void OnPan( const PanGesture& pan );
622 * @brief Called whenever a tap gesture is detected on this control.
624 * This should be overridden by deriving classes when tap detection
628 * @param[in] tap The tap gesture.
629 * @note There is no default behaviour with a tap.
630 * @note Tap detection should be enabled via EnableGestureDetection().
631 * @see EnableGestureDetection
633 virtual void OnTap( const TapGesture& tap );
636 * @brief Called whenever a long press gesture is detected on this control.
638 * This should be overridden by deriving classes when long press
639 * detection is enabled.
642 * @param[in] longPress The long press gesture.
643 * @note There is no default behaviour associated with a long press.
644 * @note Long press detection should be enabled via EnableGestureDetection().
645 * @see EnableGestureDetection
647 virtual void OnLongPress( const LongPressGesture& longPress );
649 // From ConnectionTrackerInterface
652 * @copydoc ConnectionTrackerInterface::SignalConnected
654 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
657 * @copydoc ConnectionTrackerInterface::SignalDisconnected
659 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
662 * @brief Retrieve the extension for this control
665 * @return The extension if available, NULL otherwise
667 virtual Extension* GetControlExtension()
675 DALI_INTERNAL Control( const Control& );
676 DALI_INTERNAL Control& operator=( const Control& );
684 * @brief Get implementation from the handle.
688 * @return implementation
689 * @pre handle is initialized and points to a control
691 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
694 * @brief Get implementation from the handle.
698 * @return implementation
699 * @pre handle is initialized and points to a control
701 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
703 } // namespace Internal
708 } // namespace Toolkit
712 #endif // DALI_TOOLKIT_CONTROL_IMPL_H