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 * @brief Virtual destructor.
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();
260 * @brief Called by the KeyboardFocusManager.
263 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 );
292 protected: // For derived classes to call
295 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
297 * Should be called last by the control after it acts on the Input Focus change.
300 * @param[in] focusGained True if gained, False if lost
302 void EmitKeyInputFocusSignal( bool focusGained );
304 protected: // From CustomActorImpl, not to be used by application developers
307 * @copydoc CustomActorImpl::OnStageConnection()
308 * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
310 virtual void OnStageConnection( int depth );
313 * @copydoc CustomActorImpl::OnStageDisconnection()
314 * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
316 virtual void OnStageDisconnection();
319 * @copydoc CustomActorImpl::OnChildAdd()
320 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
322 virtual void OnChildAdd( Actor& child );
325 * @copydoc CustomActorImpl::OnChildRemove()
326 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
328 virtual void OnChildRemove( Actor& child );
331 * @copydoc CustomActorImpl::OnSizeSet()
332 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
334 virtual void OnSizeSet( const Vector3& targetSize );
337 * @copydoc CustomActorImpl::OnSizeAnimation()
338 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
340 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
343 * @copydoc CustomActorImpl::OnTouchEvent()
345 virtual bool OnTouchEvent( const TouchEvent& event );
348 * @copydoc CustomActorImpl::OnHoverEvent()
350 virtual bool OnHoverEvent( const HoverEvent& event );
353 * @copydoc CustomActorImpl::OnKeyEvent()
355 virtual bool OnKeyEvent( const KeyEvent& event );
358 * @copydoc CustomActorImpl::OnWheelEvent()
360 virtual bool OnWheelEvent( const WheelEvent& event );
363 * @copydoc CustomActorImpl::OnRelayout()
365 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
368 * @copydoc CustomActorImpl::OnSetResizePolicy()
370 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
373 * @copydoc CustomActorImpl::GetNaturalSize()
375 virtual Vector3 GetNaturalSize();
378 * @copydoc CustomActorImpl::CalculateChildSize()
380 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
383 * @copydoc CustomActorImpl::GetHeightForWidth()
385 virtual float GetHeightForWidth( float width );
388 * @copydoc CustomActorImpl::GetWidthForHeight()
390 virtual float GetWidthForHeight( float height );
393 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
395 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
398 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
400 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
403 * @copydoc CustomActorImpl::OnLayoutNegotiated()
405 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
407 protected: // Helpers for deriving classes
412 * @brief Flags for the constructor
415 enum ControlBehaviour
417 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
418 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
419 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
421 DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10
423 LAST_CONTROL_BEHAVIOUR_FLAG
426 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
429 * @brief Control constructor
432 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
434 Control( ControlBehaviour behaviourFlags );
437 * @brief Second phase initialization.
442 public: // API for derived classes to override
447 * @brief This method is called after the Control has been initialized.
449 * Derived classes should do any second phase initialization by overriding this method.
452 virtual void OnInitialize();
455 * @DEPRECATED_1_1.30. Override OnChildAdd instead.
457 * @brief Called whenever an Actor is added to the control.
459 * Could be overridden by derived classes.
462 * @param[in] child The added actor.
464 virtual void OnControlChildAdd( Actor& child ) DALI_DEPRECATED_API;
467 * @DEPRECATED_1_1.30. Override OnChildRemove instead.
469 * @brief Called whenever an Actor is removed from the control.
471 * Could be overridden by derived classes.
474 * @param[in] child The removed actor.
476 virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API;
481 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
484 * @param[in] styleManager The StyleManager object.
485 * @param[in] change Information denoting what has changed.
487 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
492 * @brief This method is called when the control is accessibility activated.
494 * Derived classes should override this to perform custom accessibility activation.
496 * @return true if this control can perform accessibility activation.
498 virtual bool OnAccessibilityActivated();
501 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
505 * @param[in] gesture The pan gesture.
506 * @return true if the pan gesture has been consumed by this control
508 virtual bool OnAccessibilityPan( PanGesture gesture );
511 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
515 * @param[in] touchEvent The touch event.
516 * @return true if the touch event has been consumed by this control
518 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
521 * @brief This method should be overridden by deriving classes when they wish to respond
522 * the accessibility up and down action (i.e. value change of slider control).
525 * @param[in] isIncrease Whether the value should be increased or decreased
526 * @return true if the value changed action has been consumed by this control
528 virtual bool OnAccessibilityValueChange( bool isIncrease );
531 * @brief This method should be overridden by deriving classes when they wish to respond
532 * the accessibility zoom action.
535 * @return true if the zoom action has been consumed by this control
537 virtual bool OnAccessibilityZoom();
542 * @brief Called when the control gains key input focus.
544 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
547 virtual void OnKeyInputFocusGained();
550 * @brief Called when the control loses key input focus.
552 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
555 virtual void OnKeyInputFocusLost();
558 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
560 * A control needs to override this function in order to support two dimensional keyboard navigation.
562 * @param[in] currentFocusedActor The current focused actor.
563 * @param[in] direction The direction to move the focus towards.
564 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
565 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
567 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
570 * @brief Informs this control that its chosen focusable actor will be focused.
572 * This allows the application to preform any actions if wishes
573 * before the focus is actually moved to the chosen actor.
576 * @param[in] commitedFocusableActor The commited focusable actor.
578 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
581 * @brief This method is called when the control has enter pressed on it.
583 * Derived classes should override this to perform custom actions.
585 * @return true if this control supported this action.
587 virtual bool OnKeyboardEnter();
592 * @brief Called whenever a pinch gesture is detected on this control.
594 * This can be overridden by deriving classes when pinch detection
595 * is enabled. The default behaviour is to scale the control by the
599 * @param[in] pinch The pinch gesture.
600 * @note If overridden, then the default behaviour will not occur.
601 * @note Pinch detection should be enabled via EnableGestureDetection().
602 * @see EnableGestureDetection
604 virtual void OnPinch( const PinchGesture& pinch );
607 * @brief Called whenever a pan gesture is detected on this control.
609 * This should be overridden by deriving classes when pan detection
613 * @param[in] pan The pan gesture.
614 * @note There is no default behaviour with panning.
615 * @note Pan detection should be enabled via EnableGestureDetection().
616 * @see EnableGestureDetection
618 virtual void OnPan( const PanGesture& pan );
621 * @brief Called whenever a tap gesture is detected on this control.
623 * This should be overridden by deriving classes when tap detection
627 * @param[in] tap The tap gesture.
628 * @note There is no default behaviour with a tap.
629 * @note Tap detection should be enabled via EnableGestureDetection().
630 * @see EnableGestureDetection
632 virtual void OnTap( const TapGesture& tap );
635 * @brief Called whenever a long press gesture is detected on this control.
637 * This should be overridden by deriving classes when long press
638 * detection is enabled.
641 * @param[in] longPress The long press gesture.
642 * @note There is no default behaviour associated with a long press.
643 * @note Long press detection should be enabled via EnableGestureDetection().
644 * @see EnableGestureDetection
646 virtual void OnLongPress( const LongPressGesture& longPress );
648 // From ConnectionTrackerInterface
651 * @copydoc ConnectionTrackerInterface::SignalConnected
653 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
656 * @copydoc ConnectionTrackerInterface::SignalDisconnected
658 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
661 * @brief Retrieve the extension for this control
664 * @return The extension if available, NULL otherwise
666 virtual Extension* GetControlExtension()
674 DALI_INTERNAL Control( const Control& );
675 DALI_INTERNAL Control& operator=( const Control& );
683 * @brief Get implementation from the handle.
687 * @return implementation
688 * @pre handle is initialized and points to a control
690 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
693 * @brief Get implementation from the handle.
697 * @return implementation
698 * @pre handle is initialized and points to a control
700 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
702 } // namespace Internal
707 } // namespace Toolkit
711 #endif // DALI_TOOLKIT_CONTROL_IMPL_H