1 #ifndef DALI_TOOLKIT_CONTROL_IMPL_H
2 #define DALI_TOOLKIT_CONTROL_IMPL_H
5 * Copyright (c) 2016 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();
252 * @brief Called by the AccessibilityManager to activate the Control.
255 DALI_INTERNAL void AccessibilityActivate();
259 * @brief Called by the KeyboardFocusManager.
262 DALI_INTERNAL void KeyboardEnter();
267 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
269 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
272 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
274 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
277 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
279 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
283 * @brief Called by the KeyInputFocusManager to emit key event signals.
286 * @param[in] event The key event.
287 * @return True if the event was consumed.
289 DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
291 protected: // For derived classes to call
294 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
296 * Should be called last by the control after it acts on the Input Focus change.
299 * @param[in] focusGained True if gained, False if lost
301 void EmitKeyInputFocusSignal( bool focusGained );
303 protected: // From CustomActorImpl, not to be used by application developers
306 * @copydoc CustomActorImpl::OnStageConnection()
307 * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start.
309 virtual void OnStageConnection( int depth );
312 * @copydoc CustomActorImpl::OnStageDisconnection()
313 * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end.
315 virtual void OnStageDisconnection();
318 * @copydoc CustomActorImpl::OnChildAdd()
319 * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start.
321 virtual void OnChildAdd( Actor& child );
324 * @copydoc CustomActorImpl::OnChildRemove()
325 * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
327 virtual void OnChildRemove( Actor& child );
330 * @copydoc CustomActorImpl::OnSizeSet()
331 * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start.
333 virtual void OnSizeSet( const Vector3& targetSize );
336 * @copydoc CustomActorImpl::OnSizeAnimation()
337 * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start.
339 virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize );
342 * @copydoc CustomActorImpl::OnTouchEvent()
344 virtual bool OnTouchEvent( const TouchEvent& event );
347 * @copydoc CustomActorImpl::OnHoverEvent()
349 virtual bool OnHoverEvent( const HoverEvent& event );
352 * @copydoc CustomActorImpl::OnKeyEvent()
354 virtual bool OnKeyEvent( const KeyEvent& event );
357 * @copydoc CustomActorImpl::OnWheelEvent()
359 virtual bool OnWheelEvent( const WheelEvent& event );
362 * @copydoc CustomActorImpl::OnRelayout()
364 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
367 * @copydoc CustomActorImpl::OnSetResizePolicy()
369 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
372 * @copydoc CustomActorImpl::GetNaturalSize()
374 virtual Vector3 GetNaturalSize();
377 * @copydoc CustomActorImpl::CalculateChildSize()
379 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
382 * @copydoc CustomActorImpl::GetHeightForWidth()
384 virtual float GetHeightForWidth( float width );
387 * @copydoc CustomActorImpl::GetWidthForHeight()
389 virtual float GetWidthForHeight( float height );
392 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
394 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
397 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
399 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
402 * @copydoc CustomActorImpl::OnLayoutNegotiated()
404 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
406 protected: // Helpers for deriving classes
410 // Flags for the constructor
411 enum ControlBehaviour
413 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
414 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
416 LAST_CONTROL_BEHAVIOUR_FLAG
419 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
422 * @brief Control constructor
425 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
427 Control( ControlBehaviour behaviourFlags );
430 * @brief Second phase initialization.
435 public: // API for derived classes to override
440 * @brief This method is called after the Control has been initialized.
442 * Derived classes should do any second phase initialization by overriding this method.
445 virtual void OnInitialize();
448 * @DEPRECATED_1_1.30. Override OnChildAdd instead.
450 * @brief Called whenever an Actor is added to the control.
452 * Could be overridden by derived classes.
455 * @param[in] child The added actor.
457 virtual void OnControlChildAdd( Actor& child );
460 * @DEPRECATED_1_1.30. Override OnChildRemove instead.
462 * @brief Called whenever an Actor is removed from the control.
464 * Could be overridden by derived classes.
467 * @param[in] child The removed actor.
469 virtual void OnControlChildRemove( Actor& child );
474 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
477 * @param[in] styleManager The StyleManager object.
478 * @param[in] change Information denoting what has changed.
480 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
485 * @brief This method is called when the control is accessibility activated.
487 * Derived classes should override this to perform custom accessibility activation.
489 * @return true if this control can perform accessibility activation.
491 virtual bool OnAccessibilityActivated();
494 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
498 * @param[in] gesture The pan gesture.
499 * @return true if the pan gesture has been consumed by this control
501 virtual bool OnAccessibilityPan( PanGesture gesture );
504 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
508 * @param[in] touchEvent The touch event.
509 * @return true if the touch event has been consumed by this control
511 virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
514 * @brief This method should be overridden by deriving classes when they wish to respond
515 * the accessibility up and down action (i.e. value change of slider control).
518 * @param[in] isIncrease Whether the value should be increased or decreased
519 * @return true if the value changed action has been consumed by this control
521 virtual bool OnAccessibilityValueChange( bool isIncrease );
524 * @brief This method should be overridden by deriving classes when they wish to respond
525 * the accessibility zoom action.
528 * @return true if the zoom action has been consumed by this control
530 virtual bool OnAccessibilityZoom();
535 * @brief Called when the control gains key input focus.
537 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
540 virtual void OnKeyInputFocusGained();
543 * @brief Called when the control loses key input focus.
545 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
548 virtual void OnKeyInputFocusLost();
551 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
553 * A control needs to override this function in order to support two dimensional keyboard navigation.
555 * @param[in] currentFocusedActor The current focused actor.
556 * @param[in] direction The direction to move the focus towards.
557 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
558 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
560 virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
563 * @brief Informs this control that its chosen focusable actor will be focused.
565 * This allows the application to preform any actions if wishes
566 * before the focus is actually moved to the chosen actor.
569 * @param[in] commitedFocusableActor The commited focusable actor.
571 virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
574 * @brief This method is called when the control has enter pressed on it.
576 * Derived classes should override this to perform custom actions.
578 * @return true if this control supported this action.
580 virtual bool OnKeyboardEnter();
585 * @brief Called whenever a pinch gesture is detected on this control.
587 * This can be overridden by deriving classes when pinch detection
588 * is enabled. The default behaviour is to scale the control by the
592 * @param[in] pinch The pinch gesture.
593 * @note If overridden, then the default behaviour will not occur.
594 * @note Pinch detection should be enabled via EnableGestureDetection().
595 * @see EnableGestureDetection
597 virtual void OnPinch( const PinchGesture& pinch );
600 * @brief Called whenever a pan gesture is detected on this control.
602 * This should be overridden by deriving classes when pan detection
606 * @param[in] pan The pan gesture.
607 * @note There is no default behaviour with panning.
608 * @note Pan detection should be enabled via EnableGestureDetection().
609 * @see EnableGestureDetection
611 virtual void OnPan( const PanGesture& pan );
614 * @brief Called whenever a tap gesture is detected on this control.
616 * This should be overridden by deriving classes when tap detection
620 * @param[in] tap The tap gesture.
621 * @note There is no default behaviour with a tap.
622 * @note Tap detection should be enabled via EnableGestureDetection().
623 * @see EnableGestureDetection
625 virtual void OnTap( const TapGesture& tap );
628 * @brief Called whenever a long press gesture is detected on this control.
630 * This should be overridden by deriving classes when long press
631 * detection is enabled.
634 * @param[in] longPress The long press gesture.
635 * @note There is no default behaviour associated with a long press.
636 * @note Long press detection should be enabled via EnableGestureDetection().
637 * @see EnableGestureDetection
639 virtual void OnLongPress( const LongPressGesture& longPress );
641 // From ConnectionTrackerInterface
644 * @copydoc ConnectionTrackerInterface::SignalConnected
646 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
649 * @copydoc ConnectionTrackerInterface::SignalDisconnected
651 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
654 * @brief Retrieve the extension for this control
657 * @return The extension if available, NULL otherwise
659 virtual Extension* GetControlExtension()
667 DALI_INTERNAL Control( const Control& );
668 DALI_INTERNAL Control& operator=( const Control& );
676 * @brief Get implementation from the handle.
680 * @return implementation
681 * @pre handle is initialized and points to a control
683 DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
686 * @brief Get implementation from the handle.
690 * @return implementation
691 * @pre handle is initialized and points to a control
693 DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
695 } // namespace Internal
700 } // namespace Toolkit
704 #endif // DALI_TOOLKIT_CONTROL_IMPL_H