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 * @brief Set the background with a property map.
107 * @param[in] map The background property map.
109 void SetBackground(const Property::Map& map);
112 * @copydoc Dali::Toolkit::Control::ClearBackground
114 void ClearBackground();
119 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
121 * Gesture detection can be enabled one at a time or in bitwise format as shown:
123 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
125 * @param[in] type The gesture type(s) to enable.
127 void EnableGestureDetection( Gesture::Type type );
130 * @brief Allows deriving classes to disable any of the gesture detectors.
132 * Like EnableGestureDetection, this can also be called using bitwise or.
133 * @param[in] type The gesture type(s) to disable.
134 * @see EnableGetureDetection
136 void DisableGestureDetection( Gesture::Type type );
139 * @brief If deriving classes wish to fine tune pinch gesture
140 * detection then they can access the gesture detector through this
141 * API and modify the detection.
143 * @return The pinch gesture detector.
144 * @pre Pinch detection should have been enabled via EnableGestureDetection().
145 * @see EnableGestureDetection
147 PinchGestureDetector GetPinchGestureDetector() const;
150 * @brief If deriving classes wish to fine tune pan gesture
151 * detection then they can access the gesture detector through this
152 * API and modify the detection.
154 * @return The pan gesture detector.
155 * @pre Pan detection should have been enabled via EnableGestureDetection().
156 * @see EnableGestureDetection
158 PanGestureDetector GetPanGestureDetector() const;
161 * @brief If deriving classes wish to fine tune tap gesture
162 * detection then they can access the gesture detector through this
163 * API and modify the detection.
165 * @return The tap gesture detector.
166 * @pre Tap detection should have been enabled via EnableGestureDetection().
167 * @see EnableGestureDetection
169 TapGestureDetector GetTapGestureDetector() const;
172 * @brief If deriving classes wish to fine tune long press gesture
173 * detection then they can access the gesture detector through this
174 * API and modify the detection.
176 * @return The long press gesture detector.
177 * @pre Long press detection should have been enabled via EnableGestureDetection().
178 * @see EnableGestureDetection
180 LongPressGestureDetector GetLongPressGestureDetector() const;
182 // Keyboard Navigation
185 * @brief Sets whether this control supports two dimensional
186 * keyboard navigation (i.e. whether it knows how to handle the
187 * keyboard focus movement between its child actors).
189 * The control doesn't support it by default.
190 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
192 void SetKeyboardNavigationSupport( bool isSupported );
195 * @brief Gets whether this control supports two dimensional keyboard navigation.
197 * @return true if this control supports two dimensional keyboard navigation.
199 bool IsKeyboardNavigationSupported();
204 * @copydoc Toolkit::Control::SetKeyInputFocus()
206 void SetKeyInputFocus();
209 * @copydoc Toolkit::Control::HasKeyInputFocus()
211 bool HasKeyInputFocus();
214 * @copydoc Toolkit::Control::ClearKeyInputFocus()
216 void ClearKeyInputFocus();
221 * @brief Sets whether this control is a focus group for keyboard navigation.
223 * (i.e. the scope of keyboard focus movement
224 * can be limitied to its child actors). The control is not a focus group by default.
225 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
227 void SetAsKeyboardFocusGroup( bool isFocusGroup );
230 * @brief Gets whether this control is a focus group for keyboard navigation.
232 * @return true if this control is set as a focus group for keyboard navigation.
234 bool IsKeyboardFocusGroup();
237 * @brief Called by the AccessibilityManager to activate the Control.
239 DALI_INTERNAL void AccessibilityActivate();
242 * @brief Called by the KeyboardFocusManager.
244 DALI_INTERNAL void KeyboardEnter();
249 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
251 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
254 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
256 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
259 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
261 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
264 * @brief Called by the KeyInputFocusManager to emit key event signals.
266 * @param[in] event The key event.
267 * @return True if the event was consumed.
269 DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
274 * Sets up the background image/color based on the current state.
275 * This will set the depth index (always), and add to stage if the control is on stage.
278 void UpdateBackgroundState();
280 protected: // For derived classes to call
283 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
285 * Should be called last by the control after it acts on the Input Focus change.
287 * @param[in] focusGained True if gained, False if lost
289 void EmitKeyInputFocusSignal( bool focusGained );
291 protected: // From CustomActorImpl, not to be used by application developers
294 * @copydoc CustomActorImpl::OnStageConnection()
296 virtual void OnStageConnection( int depth );
299 * @copydoc CustomActorImpl::OnStageDisconnection()
301 virtual void OnStageDisconnection();
304 * @copydoc CustomActorImpl::OnChildAdd()
306 virtual void OnChildAdd( Actor& child );
309 * @copydoc CustomActorImpl::OnChildRemove()
311 virtual void OnChildRemove( Actor& child );
314 * @copydoc CustomActorImpl::OnSizeSet()
316 virtual void OnSizeSet( const Vector3& targetSize );
319 * @copydoc CustomActorImpl::OnSizeAnimation()
321 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
324 * @copydoc CustomActorImpl::OnTouchEvent()
326 virtual bool OnTouchEvent( const TouchEvent& event );
329 * @copydoc CustomActorImpl::OnHoverEvent()
331 virtual bool OnHoverEvent( const HoverEvent& event );
334 * @copydoc CustomActorImpl::OnKeyEvent()
336 virtual bool OnKeyEvent( const KeyEvent& event );
339 * @copydoc CustomActorImpl::OnWheelEvent()
341 virtual bool OnWheelEvent( const WheelEvent& event );
344 * @copydoc CustomActorImpl::OnRelayout()
346 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
349 * @copydoc CustomActorImpl::OnSetResizePolicy()
351 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
354 * @copydoc CustomActorImpl::GetNaturalSize()
356 virtual Vector3 GetNaturalSize();
359 * @copydoc CustomActorImpl::CalculateChildSize()
361 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
364 * @copydoc CustomActorImpl::GetHeightForWidth()
366 virtual float GetHeightForWidth( float width );
369 * @copydoc CustomActorImpl::GetWidthForHeight()
371 virtual float GetWidthForHeight( float height );
374 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
376 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
379 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
381 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
384 * @copydoc CustomActorImpl::OnLayoutNegotiated()
386 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
388 protected: // Helpers for deriving classes
392 // Flags for the constructor
393 enum ControlBehaviour
395 REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change
396 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation
398 LAST_CONTROL_BEHAVIOUR_FLAG
401 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
404 * @brief Control constructor
406 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
408 Control( ControlBehaviour behaviourFlags );
411 * @brief Second phase initialization.
415 public: // API for derived classes to override
420 * @brief This method is called after the Control has been initialized.
422 * Derived classes should do any second phase initialization by overriding this method.
424 virtual void OnInitialize();
427 * @brief Called whenever an Actor is added to the control.
429 * Could be overridden by derived classes.
431 * @param[in] child The added actor.
433 virtual void OnControlChildAdd( Actor& child );
436 * @brief Called whenever an Actor is removed from the control.
438 * Could be overridden by derived classes.
440 * @param[in] child The removed actor.
442 virtual void OnControlChildRemove( Actor& child );
447 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
449 * @param[in] styleManager The StyleManager object.
450 * @param[in] change Information denoting what has changed.
452 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
457 * @brief This method is called when the control is accessibility activated.
459 * Derived classes should override this to perform custom accessibility activation.
460 * @return true if this control can perform accessibility activation.
462 virtual bool OnAccessibilityActivated();
465 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
468 * @param[in] gesture The pan gesture.
469 * @return true if the pan gesture has been consumed by this control
471 virtual bool OnAccessibilityPan( PanGesture gesture );
474 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
477 * @param[in] touchEvent The touch event.
478 * @return true if the touch event has been consumed by this control
480 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
483 * @brief This method should be overridden by deriving classes when they wish to respond
484 * the accessibility up and down action (i.e. value change of slider control).
486 * @param[in] isIncrease Whether the value should be increased or decreased
487 * @return true if the value changed action has been consumed by this control
489 virtual bool OnAccessibilityValueChange( bool isIncrease );
492 * @brief This method should be overridden by deriving classes when they wish to respond
493 * the accessibility zoom action
495 * @return true if the zoom action has been consumed by this control
497 virtual bool OnAccessibilityZoom();
502 * @brief Called when the control gains key input focus.
504 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
506 virtual void OnKeyInputFocusGained();
509 * @brief Called when the control loses key input focus.
511 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
513 virtual void OnKeyInputFocusLost();
516 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
518 * A control needs to override this function in order to support two dimensional keyboard navigation.
519 * @param[in] currentFocusedActor The current focused actor.
520 * @param[in] direction The direction to move the focus towards.
521 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
522 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
524 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
527 * @brief Informs this control that its chosen focusable actor will be focused.
529 * This allows the application to preform any actions if wishes
530 * before the focus is actually moved to the chosen actor.
532 * @param[in] commitedFocusableActor The commited focusable actor.
534 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
537 * @brief This method is called when the control has enter pressed on it.
539 * Derived classes should override this to perform custom actions.
540 * @return true if this control supported this action.
542 virtual bool OnKeyboardEnter();
547 * @brief Called whenever a pinch gesture is detected on this control.
549 * This can be overridden by deriving classes when pinch detection
550 * is enabled. The default behaviour is to scale the control by the
553 * @note If overridden, then the default behaviour will not occur.
554 * @note Pinch detection should be enabled via EnableGestureDetection().
555 * @param[in] pinch The pinch gesture.
556 * @see EnableGestureDetection
558 virtual void OnPinch( const PinchGesture& pinch );
561 * @brief Called whenever a pan gesture is detected on this control.
563 * This should be overridden by deriving classes when pan detection
566 * @note There is no default behaviour with panning.
567 * @note Pan detection should be enabled via EnableGestureDetection().
568 * @param[in] pan The pan gesture.
569 * @see EnableGestureDetection
571 virtual void OnPan( const PanGesture& pan );
574 * @brief Called whenever a tap gesture is detected on this control.
576 * This should be overridden by deriving classes when tap detection
579 * @note There is no default behaviour with a tap.
580 * @note Tap detection should be enabled via EnableGestureDetection().
581 * @param[in] tap The tap gesture.
582 * @see EnableGestureDetection
584 virtual void OnTap( const TapGesture& tap );
587 * @brief Called whenever a long press gesture is detected on this control.
589 * This should be overridden by deriving classes when long press
590 * detection is enabled.
592 * @note There is no default behaviour associated with a long press.
593 * @note Long press detection should be enabled via EnableGestureDetection().
594 * @param[in] longPress The long press gesture.
595 * @see EnableGestureDetection
597 virtual void OnLongPress( const LongPressGesture& longPress );
599 // From ConnectionTrackerInterface
602 * @copydoc ConnectionTrackerInterface::SignalConnected
604 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
607 * @copydoc ConnectionTrackerInterface::SignalDisconnected
609 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
612 * Retrieve the extension for this control
614 * @return The extension if available, NULL otherwise
616 virtual Extension* GetControlExtension()
624 DALI_INTERNAL Control( const Control& );
625 DALI_INTERNAL Control& operator=( const Control& );
633 * @brief Get implementation from the handle
635 * @pre handle is initialized and points to a control
637 * @return implementation
639 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
642 * @brief Get implementation from the handle
644 * @pre handle is initialized and points to a control
646 * @return implementation
648 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
650 } // namespace Internal
655 } // namespace Toolkit
659 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__