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>
41 namespace Internal DALI_INTERNAL
43 class KeyInputFocusManager;
50 * @brief This is the internal base class for all controls.
52 * It will provide some common functionality required by all controls.
53 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
54 * be disconnected automatically when the control is destroyed.
56 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
60 class Extension; ///< Forward declare future extension interface
62 // Creation & Destruction
65 * @brief Create a new ControlImpl instance that does not require touch by default.
67 * 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.
80 * @copydoc Dali::CustomActorImpl::GetHeightForWidth()
82 virtual float GetHeightForWidth( float width );
85 * @copydoc Dali::CustomActorImpl::GetWidthForHeight()
87 virtual float GetWidthForHeight( float height );
90 * @copydoc Toolkit::CustomActorImpl::GetNaturalSize()
92 virtual Vector3 GetNaturalSize();
97 * @copydoc Toolkit::Control::SetKeyInputFocus()
99 void SetKeyInputFocus();
102 * @copydoc Toolkit::Control::HasKeyInputFocus()
104 bool HasKeyInputFocus();
107 * @copydoc Toolkit::Control::ClearKeyInputFocus()
109 void ClearKeyInputFocus();
114 * @brief If deriving classes wish to fine tune pinch gesture
115 * detection then they can access the gesture detector through this
116 * API and modify the detection.
118 * @return The pinch gesture detector.
119 * @pre Pinch detection should have been enabled via EnableGestureDetection().
120 * @see EnableGestureDetection
122 PinchGestureDetector GetPinchGestureDetector() const;
125 * @brief If deriving classes wish to fine tune pan gesture
126 * detection then they can access the gesture detector through this
127 * API and modify the detection.
129 * @return The pan gesture detector.
130 * @pre Pan detection should have been enabled via EnableGestureDetection().
131 * @see EnableGestureDetection
133 PanGestureDetector GetPanGestureDetector() const;
136 * @brief If deriving classes wish to fine tune tap gesture
137 * detection then they can access the gesture detector through this
138 * API and modify the detection.
140 * @return The tap gesture detector.
141 * @pre Tap detection should have been enabled via EnableGestureDetection().
142 * @see EnableGestureDetection
144 TapGestureDetector GetTapGestureDetector() const;
147 * @brief If deriving classes wish to fine tune long press gesture
148 * detection then they can access the gesture detector through this
149 * API and modify the detection.
151 * @return The long press gesture detector.
152 * @pre Long press detection should have been enabled via EnableGestureDetection().
153 * @see EnableGestureDetection
155 LongPressGestureDetector GetLongPressGestureDetector() const;
160 * @copydoc Dali::Toolkit::Control::SetStyleName
162 void SetStyleName( const std::string& styleName );
165 * @copydoc Dali::Toolkit::Control::GetStyleName
167 const std::string& GetStyleName() const;
170 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
172 void SetBackgroundColor( const Vector4& color );
175 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
177 Vector4 GetBackgroundColor() const;
180 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
182 void SetBackgroundImage( Image image );
185 * @copydoc Dali::Toolkit::Control::ClearBackground
187 void ClearBackground();
190 * @copydoc Dali::Toolkit::Control::GetBackgroundActor
192 Actor GetBackgroundActor() const;
194 // Keyboard Navigation
197 * @brief Sets whether this control supports two dimensional
198 * keyboard navigation (i.e. whether it knows how to handle the
199 * keyboard focus movement between its child actors).
201 * The control doesn't support it by default.
202 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
204 void SetKeyboardNavigationSupport(bool isSupported);
207 * @brief Gets whether this control supports two dimensional keyboard navigation.
209 * @return true if this control supports two dimensional keyboard navigation.
211 bool IsKeyboardNavigationSupported();
213 // Called by Focus Managers
216 * @brief Called by the focus manager and keyboard focus manager to Activate the Control
218 DALI_INTERNAL void Activate();
221 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
224 * @param[in] gesture The pan gesture.
225 * @return true if the pan gesture has been consumed by this control
227 virtual bool OnAccessibilityPan(PanGesture gesture);
230 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
233 * @param[in] touchEvent The touch event.
234 * @return true if the touch event has been consumed by this control
236 virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent);
239 * @brief This method should be overridden by deriving classes when they wish to respond
240 * the accessibility up and down action (i.e. value change of slider control).
242 * @param[in] isIncrease Whether the value should be increased or decreased
243 * @return true if the value changed action has been consumed by this control
245 virtual bool OnAccessibilityValueChange(bool isIncrease);
250 * @brief Sets whether this control is a focus group for keyboard navigation.
252 * (i.e. the scope of keyboard focus movement
253 * can be limitied to its child actors). The control is not a focus group by default.
254 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
256 void SetAsKeyboardFocusGroup(bool isFocusGroup);
259 * @brief Gets whether this control is a focus group for keyboard navigation.
261 * @return true if this control is set as a focus group for keyboard navigation.
263 bool IsKeyboardFocusGroup();
266 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
268 * A control needs to override this function in order to support two dimensional keyboard navigation.
269 * @param[in] currentFocusedActor The current focused actor.
270 * @param[in] direction The direction to move the focus towards.
271 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
272 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
274 virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
277 * @brief Informs this control that its chosen focusable actor will be focused.
279 * This allows the application to preform any actions if wishes
280 * before the focus is actually moved to the chosen actor.
282 * @param[in] commitedFocusableActor The commited focusable actor.
284 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
287 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
289 * Should be called last by the control after it acts on the Input Focus change.
291 * @param[in] focusGained True if gained, False if lost
293 void EmitKeyInputFocusSignal( bool focusGained );
298 * @brief Performs actions as requested using the action name.
300 * @param[in] object The object on which to perform the action.
301 * @param[in] actionName The action to perform.
302 * @param[in] attributes The attributes with which to perfrom this action.
303 * @return true if action has been accepted by this control
305 static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes);
308 * Connects a callback function with the object's signals.
309 * @param[in] object The object providing the signal.
310 * @param[in] tracker Used to disconnect the signal.
311 * @param[in] signalName The signal to connect to.
312 * @param[in] functor A newly allocated FunctorDelegate.
313 * @return True if the signal was connected.
314 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
316 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
319 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
321 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
324 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
326 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
329 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
331 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
334 * @brief Called by the KeyInputFocusManager to emit key event signals.
336 * @param[in] event The key event.
337 * @return True if the event was consumed.
339 DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event);
345 // Flags for the constructor
346 enum ControlBehaviour
348 REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change
349 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation
351 LAST_CONTROL_BEHAVIOUR_FLAG
354 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
357 * @brief Create a Control.
359 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
361 Control(ControlBehaviour behaviourFlags);
364 * @brief Second phase initialization.
371 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
373 * Gesture detection can be enabled one at a time or in bitwise format as shown:
375 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
377 * @param[in] type The gesture type(s) to enable.
379 void EnableGestureDetection(Gesture::Type type);
382 * @brief Allows deriving classes to disable any of the gesture detectors.
384 * Like EnableGestureDetection, this can also be called using bitwise or.
385 * @param[in] type The gesture type(s) to disable.
386 * @see EnableGetureDetection
388 void DisableGestureDetection(Gesture::Type type);
391 * @copydoc Dali::CustomActorImpl::RelayoutDependentOnChildren()
393 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
397 // 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 This method is called when the control is activated.
409 * Derived classes should override this if they wish to be notified when they are activated.
411 virtual void OnActivated();
414 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
416 * @param[in] styleManager The StyleManager object.
417 * @param[in] change Information denoting what has changed.
419 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
422 * @brief Called whenever a pinch gesture is detected on this control.
424 * This can be overridden by deriving classes when pinch detection
425 * is enabled. The default behaviour is to scale the control by the
428 * @note If overridden, then the default behaviour will not occur.
429 * @note Pinch detection should be enabled via EnableGestureDetection().
430 * @param[in] pinch The pinch gesture.
431 * @see EnableGestureDetection
433 virtual void OnPinch(const PinchGesture& pinch);
436 * @brief Called whenever a pan gesture is detected on this control.
438 * This should be overridden by deriving classes when pan detection
441 * @note There is no default behaviour with panning.
442 * @note Pan detection should be enabled via EnableGestureDetection().
443 * @param[in] pan The pan gesture.
444 * @see EnableGestureDetection
446 virtual void OnPan( const PanGesture& pan );
449 * @brief Called whenever a tap gesture is detected on this control.
451 * This should be overridden by deriving classes when tap detection
454 * @note There is no default behaviour with a tap.
455 * @note Tap detection should be enabled via EnableGestureDetection().
456 * @param[in] tap The tap gesture.
457 * @see EnableGestureDetection
459 virtual void OnTap( const TapGesture& tap );
462 * @brief Called whenever a long press gesture is detected on this control.
464 * This should be overridden by deriving classes when long press
465 * detection is enabled.
467 * @note There is no default behaviour associated with a long press.
468 * @note Long press detection should be enabled via EnableGestureDetection().
469 * @param[in] longPress The long press gesture.
470 * @see EnableGestureDetection
472 virtual void OnLongPress( const LongPressGesture& longPress );
475 * @brief Called whenever the control is added to the stage.
477 * Could be overridden by derived classes.
479 virtual void OnControlStageConnection();
482 * @brief Called whenever the control is removed from the stage.
484 * Could be overridden by derived classes.
486 virtual void OnControlStageDisconnection();
489 * @brief Called whenever an Actor is added to the control.
491 * Could be overridden by derived classes.
493 * @param[in] child The added actor.
495 virtual void OnControlChildAdd( Actor& child );
498 * @brief Called whenever an Actor is removed from the control.
500 * Could be overridden by derived classes.
502 * @param[in] child The removed actor.
504 virtual void OnControlChildRemove( Actor& child );
507 * @brief Called whenever the Control's size is set.
509 * Could be overridden by derived classes.
511 * @param[in] size The new size.
513 virtual void OnControlSizeSet( const Vector3& size );
516 * @brief Called when the control gains key input focus.
518 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
520 virtual void OnKeyInputFocusGained();
523 * @brief Called when the control loses key input focus.
525 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
527 virtual void OnKeyInputFocusLost();
529 // From CustomActorImpl, derived classes can override these.
532 * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
534 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
537 * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&)
539 virtual bool OnTouchEvent(const TouchEvent& event);
542 * @copydoc Dali::CustomActorImpl::OnHoverEvent(const HoverEvent&)
544 virtual bool OnHoverEvent(const HoverEvent& event);
547 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
549 virtual bool OnKeyEvent(const KeyEvent& event);
552 * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&)
554 virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
557 * @copydoc Dali::CustomActorImpl::OnCalculateRelayoutSize()
559 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
562 * @copydoc Dali::CustomActorImpl::OnLayoutNegotiated()
564 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
567 * @copydoc Dali::CustomActorImpl::OnRelayout()
569 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
572 * @copydoc Dali::CustomActorImpl::OnSetResizePolicy()
574 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
577 * @copydoc Dali::CustomActorImpl::CalculateChildSize()
579 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
581 // From CustomActorImpl, derived classes should NOT override these.
584 * @brief Sends a request to relayout this control.
586 * The control will be relaid out after the
587 * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.
589 * It calls OnControlStageConnection() to notify derived classes.
591 * @see Dali::CustomActorImpl::OnStageConnection()
593 virtual void OnStageConnection();
596 * @copydoc Dali::CustomActorImpl::OnStageDisconnection()
598 virtual void OnStageDisconnection();
601 * @copydoc Dali::CustomActorImpl::OnChildAdd(Actor&)
603 virtual void OnChildAdd(Actor& child);
606 * @copydoc Dali::CustomActorImpl::OnChildRemove(Actor&)
608 virtual void OnChildRemove(Actor& child);
611 * @copydoc Dali::CustomActorImpl::OnSizeSet(const Vector3&)
613 virtual void OnSizeSet(const Vector3& targetSize);
615 // From ConnectionTrackerInterface
618 * @copydoc ConnectionTrackerInterface::SignalConnected
620 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
623 * @copydoc ConnectionTrackerInterface::SignalDisconnected
625 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
628 * Retrieve the extension for this control
630 * @return The extension if available, NULL otherwise
632 virtual Extension* GetExtension()
640 DALI_INTERNAL Control(const Control&);
641 DALI_INTERNAL Control& operator=(const Control&);
646 friend class Internal::KeyInputFocusManager; ///< KeyInputFocusManager needs to call several methods which are private. // TODO: Remove
649 } // namespace Internal
651 } // namespace Toolkit
655 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__