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.
54 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
58 class Extension; ///< Forward declare future extension interface
60 // Creation & Destruction
63 * @brief Create a new ControlImpl instance that does not require touch by default.
65 * If touch is required then the user can connect to this class' touch signal.
66 * @return A handle to the ControlImpl instance.
68 static Toolkit::Control New();
71 * @brief Virtual destructor.
78 * @copydoc Dali::Toolkit::Control::SetStyleName
80 void SetStyleName( const std::string& styleName );
83 * @copydoc Dali::Toolkit::Control::GetStyleName
85 const std::string& GetStyleName() const;
90 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
92 void SetBackgroundColor( const Vector4& color );
95 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
97 Vector4 GetBackgroundColor() const;
100 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
102 void SetBackgroundImage( Image image );
105 * @copydoc Dali::Toolkit::Control::ClearBackground
107 void ClearBackground();
112 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
114 * Gesture detection can be enabled one at a time or in bitwise format as shown:
116 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
118 * @param[in] type The gesture type(s) to enable.
120 void EnableGestureDetection( Gesture::Type type );
123 * @brief Allows deriving classes to disable any of the gesture detectors.
125 * Like EnableGestureDetection, this can also be called using bitwise or.
126 * @param[in] type The gesture type(s) to disable.
127 * @see EnableGetureDetection
129 void DisableGestureDetection( Gesture::Type type );
132 * @brief If deriving classes wish to fine tune pinch gesture
133 * detection then they can access the gesture detector through this
134 * API and modify the detection.
136 * @return The pinch gesture detector.
137 * @pre Pinch detection should have been enabled via EnableGestureDetection().
138 * @see EnableGestureDetection
140 PinchGestureDetector GetPinchGestureDetector() const;
143 * @brief If deriving classes wish to fine tune pan gesture
144 * detection then they can access the gesture detector through this
145 * API and modify the detection.
147 * @return The pan gesture detector.
148 * @pre Pan detection should have been enabled via EnableGestureDetection().
149 * @see EnableGestureDetection
151 PanGestureDetector GetPanGestureDetector() const;
154 * @brief If deriving classes wish to fine tune tap gesture
155 * detection then they can access the gesture detector through this
156 * API and modify the detection.
158 * @return The tap gesture detector.
159 * @pre Tap detection should have been enabled via EnableGestureDetection().
160 * @see EnableGestureDetection
162 TapGestureDetector GetTapGestureDetector() const;
165 * @brief If deriving classes wish to fine tune long press gesture
166 * detection then they can access the gesture detector through this
167 * API and modify the detection.
169 * @return The long press gesture detector.
170 * @pre Long press detection should have been enabled via EnableGestureDetection().
171 * @see EnableGestureDetection
173 LongPressGestureDetector GetLongPressGestureDetector() const;
175 // Keyboard Navigation
178 * @brief Sets whether this control supports two dimensional
179 * keyboard navigation (i.e. whether it knows how to handle the
180 * keyboard focus movement between its child actors).
182 * The control doesn't support it by default.
183 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
185 void SetKeyboardNavigationSupport( bool isSupported );
188 * @brief Gets whether this control supports two dimensional keyboard navigation.
190 * @return true if this control supports two dimensional keyboard navigation.
192 bool IsKeyboardNavigationSupported();
197 * @copydoc Toolkit::Control::SetKeyInputFocus()
199 void SetKeyInputFocus();
202 * @copydoc Toolkit::Control::HasKeyInputFocus()
204 bool HasKeyInputFocus();
207 * @copydoc Toolkit::Control::ClearKeyInputFocus()
209 void ClearKeyInputFocus();
214 * @brief Sets whether this control is a focus group for keyboard navigation.
216 * (i.e. the scope of keyboard focus movement
217 * can be limitied to its child actors). The control is not a focus group by default.
218 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
220 void SetAsKeyboardFocusGroup( bool isFocusGroup );
223 * @brief Gets whether this control is a focus group for keyboard navigation.
225 * @return true if this control is set as a focus group for keyboard navigation.
227 bool IsKeyboardFocusGroup();
230 * @brief Called by the AccessibilityManager to activate the Control.
232 DALI_INTERNAL void AccessibilityActivate();
235 * @brief Called by the KeyboardFocusManager.
237 DALI_INTERNAL void KeyboardEnter();
242 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
244 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
247 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
249 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
252 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
254 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
257 * @brief Called by the KeyInputFocusManager to emit key event signals.
259 * @param[in] event The key event.
260 * @return True if the event was consumed.
262 DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
264 protected: // For derived classes to call
267 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
269 * Should be called last by the control after it acts on the Input Focus change.
271 * @param[in] focusGained True if gained, False if lost
273 void EmitKeyInputFocusSignal( bool focusGained );
275 protected: // From CustomActorImpl, not to be used by application developers
278 * @copydoc CustomActorImpl::OnStageConnection()
280 virtual void OnStageConnection( int depth );
283 * @copydoc CustomActorImpl::OnStageDisconnection()
285 virtual void OnStageDisconnection();
288 * @copydoc CustomActorImpl::OnChildAdd()
290 virtual void OnChildAdd( Actor& child );
293 * @copydoc CustomActorImpl::OnChildRemove()
295 virtual void OnChildRemove( Actor& child );
298 * @copydoc CustomActorImpl::OnSizeSet()
300 virtual void OnSizeSet( const Vector3& targetSize );
303 * @copydoc CustomActorImpl::OnSizeAnimation()
305 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
308 * @copydoc CustomActorImpl::OnTouchEvent()
310 virtual bool OnTouchEvent( const TouchEvent& event );
313 * @copydoc CustomActorImpl::OnHoverEvent()
315 virtual bool OnHoverEvent( const HoverEvent& event );
318 * @copydoc CustomActorImpl::OnKeyEvent()
320 virtual bool OnKeyEvent( const KeyEvent& event );
323 * @copydoc CustomActorImpl::OnWheelEvent()
325 virtual bool OnWheelEvent( const WheelEvent& event );
328 * @copydoc CustomActorImpl::OnRelayout()
330 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
333 * @copydoc CustomActorImpl::OnSetResizePolicy()
335 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
338 * @copydoc CustomActorImpl::GetNaturalSize()
340 virtual Vector3 GetNaturalSize();
343 * @copydoc CustomActorImpl::CalculateChildSize()
345 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
348 * @copydoc CustomActorImpl::GetHeightForWidth()
350 virtual float GetHeightForWidth( float width );
353 * @copydoc CustomActorImpl::GetWidthForHeight()
355 virtual float GetWidthForHeight( float height );
358 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
360 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
363 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
365 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
368 * @copydoc CustomActorImpl::OnLayoutNegotiated()
370 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
372 protected: // Helpers for deriving classes
376 // Flags for the constructor
377 enum ControlBehaviour
379 REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change
380 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation
382 LAST_CONTROL_BEHAVIOUR_FLAG
385 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
388 * @brief Control constructor
390 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
392 Control( ControlBehaviour behaviourFlags );
395 * @brief Second phase initialization.
399 public: // API for derived classes to override
404 * @brief This method is called after the Control has been initialized.
406 * Derived classes should do any second phase initialization by overriding this method.
408 virtual void OnInitialize();
411 * @brief Called whenever an Actor is added to the control.
413 * Could be overridden by derived classes.
415 * @param[in] child The added actor.
417 virtual void OnControlChildAdd( Actor& child );
420 * @brief Called whenever an Actor is removed from the control.
422 * Could be overridden by derived classes.
424 * @param[in] child The removed actor.
426 virtual void OnControlChildRemove( Actor& child );
431 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
433 * @param[in] styleManager The StyleManager object.
434 * @param[in] change Information denoting what has changed.
436 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
441 * @brief This method is called when the control is accessibility activated.
443 * Derived classes should override this to perform custom accessibility activation.
444 * @return true if this control can perform accessibility activation.
446 virtual bool OnAccessibilityActivated();
449 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
452 * @param[in] gesture The pan gesture.
453 * @return true if the pan gesture has been consumed by this control
455 virtual bool OnAccessibilityPan( PanGesture gesture );
458 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
461 * @param[in] touchEvent The touch event.
462 * @return true if the touch event has been consumed by this control
464 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
467 * @brief This method should be overridden by deriving classes when they wish to respond
468 * the accessibility up and down action (i.e. value change of slider control).
470 * @param[in] isIncrease Whether the value should be increased or decreased
471 * @return true if the value changed action has been consumed by this control
473 virtual bool OnAccessibilityValueChange( bool isIncrease );
476 * @brief This method should be overridden by deriving classes when they wish to respond
477 * the accessibility zoom action
479 * @return true if the zoom action has been consumed by this control
481 virtual bool OnAccessibilityZoom();
486 * @brief Called when the control gains key input focus.
488 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
490 virtual void OnKeyInputFocusGained();
493 * @brief Called when the control loses key input focus.
495 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
497 virtual void OnKeyInputFocusLost();
500 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
502 * A control needs to override this function in order to support two dimensional keyboard navigation.
503 * @param[in] currentFocusedActor The current focused actor.
504 * @param[in] direction The direction to move the focus towards.
505 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
506 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
508 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
511 * @brief Informs this control that its chosen focusable actor will be focused.
513 * This allows the application to preform any actions if wishes
514 * before the focus is actually moved to the chosen actor.
516 * @param[in] commitedFocusableActor The commited focusable actor.
518 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
521 * @brief This method is called when the control has enter pressed on it.
523 * Derived classes should override this to perform custom actions.
524 * @return true if this control supported this action.
526 virtual bool OnKeyboardEnter();
531 * @brief Called whenever a pinch gesture is detected on this control.
533 * This can be overridden by deriving classes when pinch detection
534 * is enabled. The default behaviour is to scale the control by the
537 * @note If overridden, then the default behaviour will not occur.
538 * @note Pinch detection should be enabled via EnableGestureDetection().
539 * @param[in] pinch The pinch gesture.
540 * @see EnableGestureDetection
542 virtual void OnPinch( const PinchGesture& pinch );
545 * @brief Called whenever a pan gesture is detected on this control.
547 * This should be overridden by deriving classes when pan detection
550 * @note There is no default behaviour with panning.
551 * @note Pan detection should be enabled via EnableGestureDetection().
552 * @param[in] pan The pan gesture.
553 * @see EnableGestureDetection
555 virtual void OnPan( const PanGesture& pan );
558 * @brief Called whenever a tap gesture is detected on this control.
560 * This should be overridden by deriving classes when tap detection
563 * @note There is no default behaviour with a tap.
564 * @note Tap detection should be enabled via EnableGestureDetection().
565 * @param[in] tap The tap gesture.
566 * @see EnableGestureDetection
568 virtual void OnTap( const TapGesture& tap );
571 * @brief Called whenever a long press gesture is detected on this control.
573 * This should be overridden by deriving classes when long press
574 * detection is enabled.
576 * @note There is no default behaviour associated with a long press.
577 * @note Long press detection should be enabled via EnableGestureDetection().
578 * @param[in] longPress The long press gesture.
579 * @see EnableGestureDetection
581 virtual void OnLongPress( const LongPressGesture& longPress );
583 // From ConnectionTrackerInterface
586 * @copydoc ConnectionTrackerInterface::SignalConnected
588 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
591 * @copydoc ConnectionTrackerInterface::SignalDisconnected
593 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
596 * Retrieve the extension for this control
598 * @return The extension if available, NULL otherwise
600 virtual Extension* GetControlExtension()
608 DALI_INTERNAL Control( const Control& );
609 DALI_INTERNAL Control& operator=( const Control& );
617 * @brief Get implementation from the handle
619 * @pre handle is initialized and points to a control
621 * @return implementation
623 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
626 * @brief Get implementation from the handle
628 * @pre handle is initialized and points to a control
630 * @return implementation
632 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
634 } // namespace Internal
639 } // namespace Toolkit
643 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__