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>
43 class KeyboardFocusManager;
44 class KeyInputFocusManager;
47 * @brief This is the internal base class for all controls.
49 * It will provide some common functionality required by all controls.
50 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
51 * be disconnected automatically when the control is destroyed.
53 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
57 class Extension; ///< Forward declare future extension interface
59 // Creation & Destruction
62 * @brief Create a new ControlImpl instance that does not require touch by default.
64 * If touch is required then the user can connect to this class' touch signal.
65 * @return A handle to the ControlImpl instance.
67 static Toolkit::Control New();
70 * @brief Virtual destructor.
77 * @copydoc Dali::Toolkit::Control::SetStyleName
79 void SetStyleName( const std::string& styleName );
82 * @copydoc Dali::Toolkit::Control::GetStyleName
84 const std::string& GetStyleName() const;
89 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
91 void SetBackgroundColor( const Vector4& color );
94 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
96 Vector4 GetBackgroundColor() const;
99 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
101 void SetBackgroundImage( Image image );
104 * @copydoc Dali::Toolkit::Control::ClearBackground
106 void ClearBackground();
111 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
113 * Gesture detection can be enabled one at a time or in bitwise format as shown:
115 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
117 * @param[in] type The gesture type(s) to enable.
119 void EnableGestureDetection( Gesture::Type type );
122 * @brief Allows deriving classes to disable any of the gesture detectors.
124 * Like EnableGestureDetection, this can also be called using bitwise or.
125 * @param[in] type The gesture type(s) to disable.
126 * @see EnableGetureDetection
128 void DisableGestureDetection( Gesture::Type type );
131 * @brief If deriving classes wish to fine tune pinch gesture
132 * detection then they can access the gesture detector through this
133 * API and modify the detection.
135 * @return The pinch gesture detector.
136 * @pre Pinch detection should have been enabled via EnableGestureDetection().
137 * @see EnableGestureDetection
139 PinchGestureDetector GetPinchGestureDetector() const;
142 * @brief If deriving classes wish to fine tune pan gesture
143 * detection then they can access the gesture detector through this
144 * API and modify the detection.
146 * @return The pan gesture detector.
147 * @pre Pan detection should have been enabled via EnableGestureDetection().
148 * @see EnableGestureDetection
150 PanGestureDetector GetPanGestureDetector() const;
153 * @brief If deriving classes wish to fine tune tap gesture
154 * detection then they can access the gesture detector through this
155 * API and modify the detection.
157 * @return The tap gesture detector.
158 * @pre Tap detection should have been enabled via EnableGestureDetection().
159 * @see EnableGestureDetection
161 TapGestureDetector GetTapGestureDetector() const;
164 * @brief If deriving classes wish to fine tune long press gesture
165 * detection then they can access the gesture detector through this
166 * API and modify the detection.
168 * @return The long press gesture detector.
169 * @pre Long press detection should have been enabled via EnableGestureDetection().
170 * @see EnableGestureDetection
172 LongPressGestureDetector GetLongPressGestureDetector() const;
174 // Keyboard Navigation
177 * @brief Sets whether this control supports two dimensional
178 * keyboard navigation (i.e. whether it knows how to handle the
179 * keyboard focus movement between its child actors).
181 * The control doesn't support it by default.
182 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
184 void SetKeyboardNavigationSupport( bool isSupported );
187 * @brief Gets whether this control supports two dimensional keyboard navigation.
189 * @return true if this control supports two dimensional keyboard navigation.
191 bool IsKeyboardNavigationSupported();
196 * @copydoc Toolkit::Control::SetKeyInputFocus()
198 void SetKeyInputFocus();
201 * @copydoc Toolkit::Control::HasKeyInputFocus()
203 bool HasKeyInputFocus();
206 * @copydoc Toolkit::Control::ClearKeyInputFocus()
208 void ClearKeyInputFocus();
213 * @brief Sets whether this control is a focus group for keyboard navigation.
215 * (i.e. the scope of keyboard focus movement
216 * can be limitied to its child actors). The control is not a focus group by default.
217 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
219 void SetAsKeyboardFocusGroup( bool isFocusGroup );
222 * @brief Gets whether this control is a focus group for keyboard navigation.
224 * @return true if this control is set as a focus group for keyboard navigation.
226 bool IsKeyboardFocusGroup();
228 // Called by Focus Manager
231 * @brief Called by the focus manager and keyboard focus manager to Activate the Control
233 DALI_INTERNAL void AccessibilityActivate();
238 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
240 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
243 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
245 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
248 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
250 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
253 * @brief Called by the KeyInputFocusManager to emit key event signals.
255 * @param[in] event The key event.
256 * @return True if the event was consumed.
258 DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
260 protected: // For derived classes to call
263 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
265 * Should be called last by the control after it acts on the Input Focus change.
267 * @param[in] focusGained True if gained, False if lost
269 void EmitKeyInputFocusSignal( bool focusGained );
271 protected: // From CustomActorImpl, not to be used by application developers
274 * @copydoc CustomActorImpl::OnStageConnection()
276 virtual void OnStageConnection();
279 * @copydoc CustomActorImpl::OnStageDisconnection()
281 virtual void OnStageDisconnection();
284 * @copydoc CustomActorImpl::OnChildAdd()
286 virtual void OnChildAdd( Actor& child );
289 * @copydoc CustomActorImpl::OnChildRemove()
291 virtual void OnChildRemove( Actor& child );
294 * @copydoc CustomActorImpl::OnSizeSet()
296 virtual void OnSizeSet( const Vector3& targetSize );
299 * @copydoc CustomActorImpl::OnSizeAnimation()
301 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
304 * @copydoc CustomActorImpl::OnTouchEvent()
306 virtual bool OnTouchEvent( const TouchEvent& event );
309 * @copydoc CustomActorImpl::OnHoverEvent()
311 virtual bool OnHoverEvent( const HoverEvent& event );
314 * @copydoc CustomActorImpl::OnKeyEvent()
316 virtual bool OnKeyEvent( const KeyEvent& event );
319 * @copydoc CustomActorImpl::OnWheelEvent()
321 virtual bool OnWheelEvent( const WheelEvent& event );
324 * @copydoc CustomActorImpl::OnRelayout()
326 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
329 * @copydoc CustomActorImpl::OnSetResizePolicy()
331 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
334 * @copydoc CustomActorImpl::GetNaturalSize()
336 virtual Vector3 GetNaturalSize();
339 * @copydoc CustomActorImpl::CalculateChildSize()
341 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
344 * @copydoc CustomActorImpl::GetHeightForWidth()
346 virtual float GetHeightForWidth( float width );
349 * @copydoc CustomActorImpl::GetWidthForHeight()
351 virtual float GetWidthForHeight( float height );
354 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
356 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
359 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
361 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
364 * @copydoc CustomActorImpl::OnLayoutNegotiated()
366 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
368 protected: // Helpers for deriving classes
372 // Flags for the constructor
373 enum ControlBehaviour
375 REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change
376 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation
378 LAST_CONTROL_BEHAVIOUR_FLAG
381 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
384 * @brief Control constructor
386 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
388 Control( ControlBehaviour behaviourFlags );
391 * @brief Second phase initialization.
395 public: // API for derived classes to override
400 * @brief This method is called after the Control has been initialized.
402 * Derived classes should do any second phase initialization by overriding this method.
404 virtual void OnInitialize();
407 * @brief Called whenever an Actor is added to the control.
409 * Could be overridden by derived classes.
411 * @param[in] child The added actor.
413 virtual void OnControlChildAdd( Actor& child );
416 * @brief Called whenever an Actor is removed from the control.
418 * Could be overridden by derived classes.
420 * @param[in] child The removed actor.
422 virtual void OnControlChildRemove( Actor& child );
427 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
429 * @param[in] styleManager The StyleManager object.
430 * @param[in] change Information denoting what has changed.
432 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
437 * @brief This method is called when the control is accessibility activated.
439 * Derived classes should override this to perform custom accessibility activation.
440 * @return true if this control can perform accessibility activation.
442 virtual bool OnAccessibilityActivated();
445 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
448 * @param[in] gesture The pan gesture.
449 * @return true if the pan gesture has been consumed by this control
451 virtual bool OnAccessibilityPan( PanGesture gesture );
454 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
457 * @param[in] touchEvent The touch event.
458 * @return true if the touch event has been consumed by this control
460 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
463 * @brief This method should be overridden by deriving classes when they wish to respond
464 * the accessibility up and down action (i.e. value change of slider control).
466 * @param[in] isIncrease Whether the value should be increased or decreased
467 * @return true if the value changed action has been consumed by this control
469 virtual bool OnAccessibilityValueChange( bool isIncrease );
474 * @brief Called when the control gains key input focus.
476 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
478 virtual void OnKeyInputFocusGained();
481 * @brief Called when the control loses key input focus.
483 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
485 virtual void OnKeyInputFocusLost();
488 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
490 * A control needs to override this function in order to support two dimensional keyboard navigation.
491 * @param[in] currentFocusedActor The current focused actor.
492 * @param[in] direction The direction to move the focus towards.
493 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
494 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
496 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
499 * @brief Informs this control that its chosen focusable actor will be focused.
501 * This allows the application to preform any actions if wishes
502 * before the focus is actually moved to the chosen actor.
504 * @param[in] commitedFocusableActor The commited focusable actor.
506 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
511 * @brief Called whenever a pinch gesture is detected on this control.
513 * This can be overridden by deriving classes when pinch detection
514 * is enabled. The default behaviour is to scale the control by the
517 * @note If overridden, then the default behaviour will not occur.
518 * @note Pinch detection should be enabled via EnableGestureDetection().
519 * @param[in] pinch The pinch gesture.
520 * @see EnableGestureDetection
522 virtual void OnPinch( const PinchGesture& pinch );
525 * @brief Called whenever a pan gesture is detected on this control.
527 * This should be overridden by deriving classes when pan detection
530 * @note There is no default behaviour with panning.
531 * @note Pan detection should be enabled via EnableGestureDetection().
532 * @param[in] pan The pan gesture.
533 * @see EnableGestureDetection
535 virtual void OnPan( const PanGesture& pan );
538 * @brief Called whenever a tap gesture is detected on this control.
540 * This should be overridden by deriving classes when tap detection
543 * @note There is no default behaviour with a tap.
544 * @note Tap detection should be enabled via EnableGestureDetection().
545 * @param[in] tap The tap gesture.
546 * @see EnableGestureDetection
548 virtual void OnTap( const TapGesture& tap );
551 * @brief Called whenever a long press gesture is detected on this control.
553 * This should be overridden by deriving classes when long press
554 * detection is enabled.
556 * @note There is no default behaviour associated with a long press.
557 * @note Long press detection should be enabled via EnableGestureDetection().
558 * @param[in] longPress The long press gesture.
559 * @see EnableGestureDetection
561 virtual void OnLongPress( const LongPressGesture& longPress );
563 // From ConnectionTrackerInterface
566 * @copydoc ConnectionTrackerInterface::SignalConnected
568 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
571 * @copydoc ConnectionTrackerInterface::SignalDisconnected
573 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
576 * Retrieve the extension for this control
578 * @return The extension if available, NULL otherwise
580 virtual Extension* GetControlExtension()
588 DALI_INTERNAL Control( const Control& );
589 DALI_INTERNAL Control& operator=( const Control& );
597 * @brief Get implementation from the handle
599 * @pre handle is initialized and points to a control
601 * @return implementation
603 Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
606 * @brief Get implementation from the handle
608 * @pre handle is initialized and points to a control
610 * @return implementation
612 const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
614 } // namespace Internal
616 } // namespace Toolkit
620 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__