1 #ifndef __DALI_TOOLKIT_CONTROL_IMPL_H__
2 #define __DALI_TOOLKIT_CONTROL_IMPL_H__
5 * Copyright (c) 2015 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();
73 * @brief Virtual destructor.
81 * @copydoc Dali::Toolkit::Control::SetStyleName
83 void SetStyleName( const std::string& styleName );
86 * @copydoc Dali::Toolkit::Control::GetStyleName
88 const std::string& GetStyleName() const;
93 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
95 void SetBackgroundColor( const Vector4& color );
98 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
100 Vector4 GetBackgroundColor() const;
103 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
105 void SetBackgroundImage( Image image );
108 * @brief Set the background with a property map.
111 * @param[in] map The background property map.
113 void SetBackground(const Property::Map& map);
116 * @copydoc Dali::Toolkit::Control::ClearBackground
118 void ClearBackground();
123 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
125 * Gesture detection can be enabled one at a time or in bitwise format as shown:
127 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
130 * @param[in] type The gesture type(s) to enable.
132 void EnableGestureDetection( Gesture::Type type );
135 * @brief Allows deriving classes to disable any of the gesture detectors.
137 * Like EnableGestureDetection, this can also be called using bitwise or.
139 * @param[in] type The gesture type(s) to disable.
140 * @see EnableGetureDetection
142 void DisableGestureDetection( Gesture::Type type );
145 * @brief If deriving classes wish to fine tune pinch gesture
146 * detection then they can access the gesture detector through this
147 * API and modify the detection.
150 * @return The pinch gesture detector.
151 * @pre Pinch detection should have been enabled via EnableGestureDetection().
152 * @see EnableGestureDetection
154 PinchGestureDetector GetPinchGestureDetector() const;
157 * @brief If deriving classes wish to fine tune pan gesture
158 * detection then they can access the gesture detector through this
159 * API and modify the detection.
162 * @return The pan gesture detector.
163 * @pre Pan detection should have been enabled via EnableGestureDetection().
164 * @see EnableGestureDetection
166 PanGestureDetector GetPanGestureDetector() const;
169 * @brief If deriving classes wish to fine tune tap gesture
170 * detection then they can access the gesture detector through this
171 * API and modify the detection.
174 * @return The tap gesture detector.
175 * @pre Tap detection should have been enabled via EnableGestureDetection().
176 * @see EnableGestureDetection
178 TapGestureDetector GetTapGestureDetector() const;
181 * @brief If deriving classes wish to fine tune long press gesture
182 * detection then they can access the gesture detector through this
183 * API and modify the detection.
186 * @return The long press gesture detector.
187 * @pre Long press detection should have been enabled via EnableGestureDetection().
188 * @see EnableGestureDetection
190 LongPressGestureDetector GetLongPressGestureDetector() const;
192 // Keyboard Navigation
195 * @brief Sets whether this control supports two dimensional
196 * keyboard navigation (i.e. whether it knows how to handle the
197 * keyboard focus movement between its child actors).
199 * The control doesn't support it by default.
201 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
203 void SetKeyboardNavigationSupport( bool isSupported );
206 * @brief Gets whether this control supports two dimensional keyboard navigation.
209 * @return true if this control supports two dimensional keyboard navigation.
211 bool IsKeyboardNavigationSupported();
216 * @copydoc Toolkit::Control::SetKeyInputFocus()
218 void SetKeyInputFocus();
221 * @copydoc Toolkit::Control::HasKeyInputFocus()
223 bool HasKeyInputFocus();
226 * @copydoc Toolkit::Control::ClearKeyInputFocus()
228 void ClearKeyInputFocus();
233 * @brief Sets whether this control is a focus group for keyboard navigation.
235 * (i.e. the scope of keyboard focus movement
236 * can be limitied to its child actors). The control is not a focus group by default.
238 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
240 void SetAsKeyboardFocusGroup( bool isFocusGroup );
243 * @brief Gets whether this control is a focus group for keyboard navigation.
246 * @return true if this control is set as a focus group for keyboard navigation.
248 bool IsKeyboardFocusGroup();
251 * @brief Called by the AccessibilityManager to activate the Control.
254 DALI_INTERNAL void AccessibilityActivate();
257 * @brief Called by the KeyboardFocusManager.
260 DALI_INTERNAL void KeyboardEnter();
265 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
267 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
270 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
272 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
275 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
277 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
280 * @brief Called by the KeyInputFocusManager to emit key event signals.
283 * @param[in] event The key event.
284 * @return True if the event was consumed.
286 DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
288 protected: // For derived classes to call
291 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
293 * Should be called last by the control after it acts on the Input Focus change.
296 * @param[in] focusGained True if gained, False if lost
298 void EmitKeyInputFocusSignal( bool focusGained );
300 protected: // From CustomActorImpl, not to be used by application developers
303 * @copydoc CustomActorImpl::OnStageConnection()
304 * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
306 virtual void OnStageConnection( int depth );
309 * @copydoc CustomActorImpl::OnStageDisconnection()
310 * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
312 virtual void OnStageDisconnection();
315 * @copydoc CustomActorImpl::OnChildAdd()
316 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
318 virtual void OnChildAdd( Actor& child );
321 * @copydoc CustomActorImpl::OnChildRemove()
322 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
324 virtual void OnChildRemove( Actor& child );
327 * @copydoc CustomActorImpl::OnSizeSet()
328 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
330 virtual void OnSizeSet( const Vector3& targetSize );
333 * @copydoc CustomActorImpl::OnSizeAnimation()
334 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
336 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
339 * @copydoc CustomActorImpl::OnTouchEvent()
341 virtual bool OnTouchEvent( const TouchEvent& event );
344 * @copydoc CustomActorImpl::OnHoverEvent()
346 virtual bool OnHoverEvent( const HoverEvent& event );
349 * @copydoc CustomActorImpl::OnKeyEvent()
351 virtual bool OnKeyEvent( const KeyEvent& event );
354 * @copydoc CustomActorImpl::OnWheelEvent()
356 virtual bool OnWheelEvent( const WheelEvent& event );
359 * @copydoc CustomActorImpl::OnRelayout()
361 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
364 * @copydoc CustomActorImpl::OnSetResizePolicy()
366 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
369 * @copydoc CustomActorImpl::GetNaturalSize()
371 virtual Vector3 GetNaturalSize();
374 * @copydoc CustomActorImpl::CalculateChildSize()
376 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
379 * @copydoc CustomActorImpl::GetHeightForWidth()
381 virtual float GetHeightForWidth( float width );
384 * @copydoc CustomActorImpl::GetWidthForHeight()
386 virtual float GetWidthForHeight( float height );
389 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
391 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
394 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
396 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
399 * @copydoc CustomActorImpl::OnLayoutNegotiated()
401 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
403 protected: // Helpers for deriving classes
407 // Flags for the constructor
408 enum ControlBehaviour
410 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
411 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
413 LAST_CONTROL_BEHAVIOUR_FLAG
416 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
419 * @brief Control constructor
422 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
424 Control( ControlBehaviour behaviourFlags );
427 * @brief Second phase initialization.
432 public: // API for derived classes to override
437 * @brief This method is called after the Control has been initialized.
439 * Derived classes should do any second phase initialization by overriding this method.
442 virtual void OnInitialize();
445 * @DEPRECATED_1_1.30. Override OnChildAdd instead.
447 * @brief Called whenever an Actor is added to the control.
449 * Could be overridden by derived classes.
452 * @param[in] child The added actor.
454 virtual void OnControlChildAdd( Actor& child );
457 * @DEPRECATED_1_1.30. Override OnChildRemove instead.
459 * @brief Called whenever an Actor is removed from the control.
461 * Could be overridden by derived classes.
464 * @param[in] child The removed actor.
466 virtual void OnControlChildRemove( Actor& child );
471 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
474 * @param[in] styleManager The StyleManager object.
475 * @param[in] change Information denoting what has changed.
477 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
482 * @brief This method is called when the control is accessibility activated.
484 * Derived classes should override this to perform custom accessibility activation.
486 * @return true if this control can perform accessibility activation.
488 virtual bool OnAccessibilityActivated();
491 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
495 * @param[in] gesture The pan gesture.
496 * @return true if the pan gesture has been consumed by this control
498 virtual bool OnAccessibilityPan( PanGesture gesture );
501 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
505 * @param[in] touchEvent The touch event.
506 * @return true if the touch event has been consumed by this control
508 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
511 * @brief This method should be overridden by deriving classes when they wish to respond
512 * the accessibility up and down action (i.e. value change of slider control).
515 * @param[in] isIncrease Whether the value should be increased or decreased
516 * @return true if the value changed action has been consumed by this control
518 virtual bool OnAccessibilityValueChange( bool isIncrease );
521 * @brief This method should be overridden by deriving classes when they wish to respond
522 * the accessibility zoom action.
525 * @return true if the zoom action has been consumed by this control
527 virtual bool OnAccessibilityZoom();
532 * @brief Called when the control gains key input focus.
534 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
537 virtual void OnKeyInputFocusGained();
540 * @brief Called when the control loses key input focus.
542 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
545 virtual void OnKeyInputFocusLost();
548 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
550 * A control needs to override this function in order to support two dimensional keyboard navigation.
552 * @param[in] currentFocusedActor The current focused actor.
553 * @param[in] direction The direction to move the focus towards.
554 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
555 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
557 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
560 * @brief Informs this control that its chosen focusable actor will be focused.
562 * This allows the application to preform any actions if wishes
563 * before the focus is actually moved to the chosen actor.
566 * @param[in] commitedFocusableActor The commited focusable actor.
568 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
571 * @brief This method is called when the control has enter pressed on it.
573 * Derived classes should override this to perform custom actions.
575 * @return true if this control supported this action.
577 virtual bool OnKeyboardEnter();
582 * @brief Called whenever a pinch gesture is detected on this control.
584 * This can be overridden by deriving classes when pinch detection
585 * is enabled. The default behaviour is to scale the control by the
589 * @param[in] pinch The pinch gesture.
590 * @note If overridden, then the default behaviour will not occur.
591 * @note Pinch detection should be enabled via EnableGestureDetection().
592 * @see EnableGestureDetection
594 virtual void OnPinch( const PinchGesture& pinch );
597 * @brief Called whenever a pan gesture is detected on this control.
599 * This should be overridden by deriving classes when pan detection
603 * @param[in] pan The pan gesture.
604 * @note There is no default behaviour with panning.
605 * @note Pan detection should be enabled via EnableGestureDetection().
606 * @see EnableGestureDetection
608 virtual void OnPan( const PanGesture& pan );
611 * @brief Called whenever a tap gesture is detected on this control.
613 * This should be overridden by deriving classes when tap detection
617 * @param[in] tap The tap gesture.
618 * @note There is no default behaviour with a tap.
619 * @note Tap detection should be enabled via EnableGestureDetection().
620 * @see EnableGestureDetection
622 virtual void OnTap( const TapGesture& tap );
625 * @brief Called whenever a long press gesture is detected on this control.
627 * This should be overridden by deriving classes when long press
628 * detection is enabled.
631 * @param[in] longPress The long press gesture.
632 * @note There is no default behaviour associated with a long press.
633 * @note Long press detection should be enabled via EnableGestureDetection().
634 * @see EnableGestureDetection
636 virtual void OnLongPress( const LongPressGesture& longPress );
638 // From ConnectionTrackerInterface
641 * @copydoc ConnectionTrackerInterface::SignalConnected
643 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
646 * @copydoc ConnectionTrackerInterface::SignalDisconnected
648 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
651 * @brief Retrieve the extension for this control
654 * @return The extension if available, NULL otherwise
656 virtual Extension* GetControlExtension()
664 DALI_INTERNAL Control( const Control& );
665 DALI_INTERNAL Control& operator=( const Control& );
673 * @brief Get implementation from the handle.
677 * @return implementation
678 * @pre handle is initialized and points to a control
680 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
683 * @brief Get implementation from the handle.
687 * @return implementation
688 * @pre handle is initialized and points to a control
690 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
692 } // namespace Internal
697 } // namespace Toolkit
701 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__