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>
44 * @brief This is the internal base class for all controls.
46 * It will provide some common functionality required by all controls.
47 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
48 * be disconnected automatically when the control is destroyed.
50 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
54 class Extension; ///< Forward declare future extension interface
56 // Creation & Destruction
59 * @brief Create a new ControlImpl instance that does not require touch by default.
61 * If touch is required then the user can connect to this class' touch signal.
62 * @return A handle to the ControlImpl instance.
64 static Toolkit::Control New();
67 * @brief Virtual destructor.
74 * @copydoc Dali::Toolkit::Control::SetStyleName
76 void SetStyleName( const std::string& styleName );
79 * @copydoc Dali::Toolkit::Control::GetStyleName
81 const std::string& GetStyleName() const;
86 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
88 void SetBackgroundColor( const Vector4& color );
91 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
93 Vector4 GetBackgroundColor() const;
96 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
98 void SetBackgroundImage( Image image );
101 * @copydoc Dali::Toolkit::Control::ClearBackground
103 void ClearBackground();
108 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
110 * Gesture detection can be enabled one at a time or in bitwise format as shown:
112 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
114 * @param[in] type The gesture type(s) to enable.
116 void EnableGestureDetection( Gesture::Type type );
119 * @brief Allows deriving classes to disable any of the gesture detectors.
121 * Like EnableGestureDetection, this can also be called using bitwise or.
122 * @param[in] type The gesture type(s) to disable.
123 * @see EnableGetureDetection
125 void DisableGestureDetection( Gesture::Type type );
128 * @brief If deriving classes wish to fine tune pinch gesture
129 * detection then they can access the gesture detector through this
130 * API and modify the detection.
132 * @return The pinch gesture detector.
133 * @pre Pinch detection should have been enabled via EnableGestureDetection().
134 * @see EnableGestureDetection
136 PinchGestureDetector GetPinchGestureDetector() const;
139 * @brief If deriving classes wish to fine tune pan gesture
140 * detection then they can access the gesture detector through this
141 * API and modify the detection.
143 * @return The pan gesture detector.
144 * @pre Pan detection should have been enabled via EnableGestureDetection().
145 * @see EnableGestureDetection
147 PanGestureDetector GetPanGestureDetector() const;
150 * @brief If deriving classes wish to fine tune tap gesture
151 * detection then they can access the gesture detector through this
152 * API and modify the detection.
154 * @return The tap gesture detector.
155 * @pre Tap detection should have been enabled via EnableGestureDetection().
156 * @see EnableGestureDetection
158 TapGestureDetector GetTapGestureDetector() const;
161 * @brief If deriving classes wish to fine tune long press gesture
162 * detection then they can access the gesture detector through this
163 * API and modify the detection.
165 * @return The long press gesture detector.
166 * @pre Long press detection should have been enabled via EnableGestureDetection().
167 * @see EnableGestureDetection
169 LongPressGestureDetector GetLongPressGestureDetector() const;
171 // Keyboard Navigation
174 * @brief Sets whether this control supports two dimensional
175 * keyboard navigation (i.e. whether it knows how to handle the
176 * keyboard focus movement between its child actors).
178 * The control doesn't support it by default.
179 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
181 void SetKeyboardNavigationSupport( bool isSupported );
184 * @brief Gets whether this control supports two dimensional keyboard navigation.
186 * @return true if this control supports two dimensional keyboard navigation.
188 bool IsKeyboardNavigationSupported();
193 * @copydoc Toolkit::Control::SetKeyInputFocus()
195 void SetKeyInputFocus();
198 * @copydoc Toolkit::Control::HasKeyInputFocus()
200 bool HasKeyInputFocus();
203 * @copydoc Toolkit::Control::ClearKeyInputFocus()
205 void ClearKeyInputFocus();
210 * @brief Sets whether this control is a focus group for keyboard navigation.
212 * (i.e. the scope of keyboard focus movement
213 * can be limitied to its child actors). The control is not a focus group by default.
214 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
216 void SetAsKeyboardFocusGroup( bool isFocusGroup );
219 * @brief Gets whether this control is a focus group for keyboard navigation.
221 * @return true if this control is set as a focus group for keyboard navigation.
223 bool IsKeyboardFocusGroup();
225 // Called by Focus Manager
228 * @brief Called by the accessibility focus manager and keyboard focus manager to activate the Control
230 DALI_INTERNAL void AccessibilityActivate();
235 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
237 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
240 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
242 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
245 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
247 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
250 * @brief Called by the KeyInputFocusManager to emit key event signals.
252 * @param[in] event The key event.
253 * @return True if the event was consumed.
255 DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
257 protected: // For derived classes to call
260 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
262 * Should be called last by the control after it acts on the Input Focus change.
264 * @param[in] focusGained True if gained, False if lost
266 void EmitKeyInputFocusSignal( bool focusGained );
268 protected: // From CustomActorImpl, not to be used by application developers
271 * @copydoc CustomActorImpl::OnStageConnection()
273 virtual void OnStageConnection();
276 * @copydoc CustomActorImpl::OnStageDisconnection()
278 virtual void OnStageDisconnection();
281 * @copydoc CustomActorImpl::OnChildAdd()
283 virtual void OnChildAdd( Actor& child );
286 * @copydoc CustomActorImpl::OnChildRemove()
288 virtual void OnChildRemove( Actor& child );
291 * @copydoc CustomActorImpl::OnSizeSet()
293 virtual void OnSizeSet( const Vector3& targetSize );
296 * @copydoc CustomActorImpl::OnSizeAnimation()
298 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
301 * @copydoc CustomActorImpl::OnTouchEvent()
303 virtual bool OnTouchEvent( const TouchEvent& event );
306 * @copydoc CustomActorImpl::OnHoverEvent()
308 virtual bool OnHoverEvent( const HoverEvent& event );
311 * @copydoc CustomActorImpl::OnKeyEvent()
313 virtual bool OnKeyEvent( const KeyEvent& event );
316 * @copydoc CustomActorImpl::OnWheelEvent()
318 virtual bool OnWheelEvent( const WheelEvent& event );
321 * @copydoc CustomActorImpl::OnRelayout()
323 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
326 * @copydoc CustomActorImpl::OnSetResizePolicy()
328 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
331 * @copydoc CustomActorImpl::GetNaturalSize()
333 virtual Vector3 GetNaturalSize();
336 * @copydoc CustomActorImpl::CalculateChildSize()
338 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
341 * @copydoc CustomActorImpl::GetHeightForWidth()
343 virtual float GetHeightForWidth( float width );
346 * @copydoc CustomActorImpl::GetWidthForHeight()
348 virtual float GetWidthForHeight( float height );
351 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
353 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
356 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
358 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
361 * @copydoc CustomActorImpl::OnLayoutNegotiated()
363 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
365 protected: // Helpers for deriving classes
369 // Flags for the constructor
370 enum ControlBehaviour
372 REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change
373 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation
375 LAST_CONTROL_BEHAVIOUR_FLAG
378 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
381 * @brief Control constructor
383 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
385 Control( ControlBehaviour behaviourFlags );
388 * @brief Second phase initialization.
392 public: // API for derived classes to override
397 * @brief This method is called after the Control has been initialized.
399 * Derived classes should do any second phase initialization by overriding this method.
401 virtual void OnInitialize();
404 * @brief Called whenever an Actor is added to the control.
406 * Could be overridden by derived classes.
408 * @param[in] child The added actor.
410 virtual void OnControlChildAdd( Actor& child );
413 * @brief Called whenever an Actor is removed from the control.
415 * Could be overridden by derived classes.
417 * @param[in] child The removed actor.
419 virtual void OnControlChildRemove( Actor& child );
424 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
426 * @param[in] styleManager The StyleManager object.
427 * @param[in] change Information denoting what has changed.
429 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
434 * @brief This method is called when the control is accessibility activated.
436 * Derived classes should override this to perform custom accessibility activation.
437 * @return true if this control can perform accessibility activation.
439 virtual bool OnAccessibilityActivated();
442 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
445 * @param[in] gesture The pan gesture.
446 * @return true if the pan gesture has been consumed by this control
448 virtual bool OnAccessibilityPan( PanGesture gesture );
451 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
454 * @param[in] touchEvent The touch event.
455 * @return true if the touch event has been consumed by this control
457 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
460 * @brief This method should be overridden by deriving classes when they wish to respond
461 * the accessibility up and down action (i.e. value change of slider control).
463 * @param[in] isIncrease Whether the value should be increased or decreased
464 * @return true if the value changed action has been consumed by this control
466 virtual bool OnAccessibilityValueChange( bool isIncrease );
471 * @brief Called when the control gains key input focus.
473 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
475 virtual void OnKeyInputFocusGained();
478 * @brief Called when the control loses key input focus.
480 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
482 virtual void OnKeyInputFocusLost();
485 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
487 * A control needs to override this function in order to support two dimensional keyboard navigation.
488 * @param[in] currentFocusedActor The current focused actor.
489 * @param[in] direction The direction to move the focus towards.
490 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
491 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
493 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
496 * @brief Informs this control that its chosen focusable actor will be focused.
498 * This allows the application to preform any actions if wishes
499 * before the focus is actually moved to the chosen actor.
501 * @param[in] commitedFocusableActor The commited focusable actor.
503 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
508 * @brief Called whenever a pinch gesture is detected on this control.
510 * This can be overridden by deriving classes when pinch detection
511 * is enabled. The default behaviour is to scale the control by the
514 * @note If overridden, then the default behaviour will not occur.
515 * @note Pinch detection should be enabled via EnableGestureDetection().
516 * @param[in] pinch The pinch gesture.
517 * @see EnableGestureDetection
519 virtual void OnPinch( const PinchGesture& pinch );
522 * @brief Called whenever a pan gesture is detected on this control.
524 * This should be overridden by deriving classes when pan detection
527 * @note There is no default behaviour with panning.
528 * @note Pan detection should be enabled via EnableGestureDetection().
529 * @param[in] pan The pan gesture.
530 * @see EnableGestureDetection
532 virtual void OnPan( const PanGesture& pan );
535 * @brief Called whenever a tap gesture is detected on this control.
537 * This should be overridden by deriving classes when tap detection
540 * @note There is no default behaviour with a tap.
541 * @note Tap detection should be enabled via EnableGestureDetection().
542 * @param[in] tap The tap gesture.
543 * @see EnableGestureDetection
545 virtual void OnTap( const TapGesture& tap );
548 * @brief Called whenever a long press gesture is detected on this control.
550 * This should be overridden by deriving classes when long press
551 * detection is enabled.
553 * @note There is no default behaviour associated with a long press.
554 * @note Long press detection should be enabled via EnableGestureDetection().
555 * @param[in] longPress The long press gesture.
556 * @see EnableGestureDetection
558 virtual void OnLongPress( const LongPressGesture& longPress );
560 // From ConnectionTrackerInterface
563 * @copydoc ConnectionTrackerInterface::SignalConnected
565 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
568 * @copydoc ConnectionTrackerInterface::SignalDisconnected
570 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
573 * Retrieve the extension for this control
575 * @return The extension if available, NULL otherwise
577 virtual Extension* GetControlExtension()
585 DALI_INTERNAL Control( const Control& );
586 DALI_INTERNAL Control& operator=( const Control& );
594 * @brief Get implementation from the handle
596 * @pre handle is initialized and points to a control
598 * @return implementation
600 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
603 * @brief Get implementation from the handle
605 * @pre handle is initialized and points to a control
607 * @return implementation
609 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
611 } // namespace Internal
613 } // namespace Toolkit
617 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__