-#ifndef __DALI_TOOLKIT_CONTROL_IMPL_H__
-#define __DALI_TOOLKIT_CONTROL_IMPL_H__
+#ifndef DALI_TOOLKIT_CONTROL_IMPL_H
+#define DALI_TOOLKIT_CONTROL_IMPL_H
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
// EXTERNAL INCLUDES
#include <dali/public-api/adaptor-framework/style-change.h>
-#include <dali/public-api/common/vector-wrapper.h>
#include <dali/public-api/events/long-press-gesture.h>
#include <dali/public-api/events/pan-gesture.h>
#include <dali/public-api/events/pinch-gesture.h>
namespace Dali
{
-
namespace Toolkit
{
-class StyleManager;
+/**
+ * @addtogroup dali_toolkit_controls
+ * @{
+ */
-namespace Internal DALI_INTERNAL
-{
-class KeyInputFocusManager;
-}
+class StyleManager;
namespace Internal
{
* It will provide some common functionality required by all controls.
* Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
* be disconnected automatically when the control is destroyed.
+ * @SINCE_1_0.0
*/
-class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
+class DALI_TOOLKIT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
{
public:
+ class Extension; ///< Forward declare future extension interface
+
// Creation & Destruction
/**
- * @brief Create a new ControlImpl instance that does not require touch by default.
+ * @brief Creates a new ControlImpl instance that does not require touch by default.
*
- * If touch is required then the user can connect to this class' touch signal.
- * @return A handle to the ControlImpl instance.
+ * If touch is required, then the user can connect to this class' touch signal.
+ * @SINCE_1_0.0
+ * @return A handle to the ControlImpl instance
*/
static Toolkit::Control New();
+protected:
/**
* @brief Virtual destructor.
+ * @SINCE_1_0.0
*/
virtual ~Control();
- // Size negotiation
+public:
+ // Styling
/**
- * @copydoc Dali::CustomActorImpl::GetHeightForWidth()
+ * @copydoc Dali::Toolkit::Control::SetStyleName
*/
- virtual float GetHeightForWidth( float width );
+ void SetStyleName( const std::string& styleName );
/**
- * @copydoc Dali::CustomActorImpl::GetWidthForHeight()
+ * @copydoc Dali::Toolkit::Control::GetStyleName
*/
- virtual float GetWidthForHeight( float height );
+ const std::string& GetStyleName() const;
- /**
- * @copydoc Toolkit::Control::GetNaturalSize()
- */
- virtual Vector3 GetNaturalSize();
+ // Background
/**
- * @brief Retrieves the current Control's size.
- *
- * @return The control's size.
+ * @copydoc Dali::Toolkit::Control::SetBackgroundColor
*/
- const Vector3& GetControlSize() const;
+ void SetBackgroundColor( const Vector4& color );
/**
- * @brief Retrieves the Control's size set by the Application / Control.
+ * @brief Sets the background with a property map.
*
- * @return The control's size.
+ * @SINCE_1_0.0
+ * @param[in] map The background property map
*/
- const Vector3& GetSizeSet() const;
-
- // Key Input
+ void SetBackground(const Property::Map& map);
/**
- * @copydoc Toolkit::Control::SetKeyInputFocus()
+ * @copydoc Dali::Toolkit::Control::ClearBackground
*/
- void SetKeyInputFocus();
+ void ClearBackground();
+
+ // Gesture Detection
/**
- * @copydoc Toolkit::Control::HasKeyInputFocus()
+ * @brief Allows deriving classes to enable any of the gesture detectors that are available.
+ *
+ * Gesture detection can be enabled one at a time or in bitwise format as shown:
+ * @code
+ * EnableGestureDetection(GestureType::Value(GestureType::PINCH | GestureType::TAP | GestureType::PAN));
+ * @endcode
+ * @SINCE_1_0.0
+ * @param[in] type The gesture type(s) to enable
*/
- bool HasKeyInputFocus();
+ void EnableGestureDetection( GestureType::Value type );
/**
- * @copydoc Toolkit::Control::ClearKeyInputFocus()
+ * @brief Allows deriving classes to disable any of the gesture detectors.
+ *
+ * Like EnableGestureDetection, this can also be called using bitwise or.
+ * @SINCE_1_0.0
+ * @param[in] type The gesture type(s) to disable
+ * @see EnableGetureDetection
*/
- void ClearKeyInputFocus();
-
- // Gesture Detection
+ void DisableGestureDetection( GestureType::Value type );
/**
* @brief If deriving classes wish to fine tune pinch gesture
- * detection then they can access the gesture detector through this
+ * detection, then they can access the gesture detector through this
* API and modify the detection.
*
- * @return The pinch gesture detector.
+ * @SINCE_1_0.0
+ * @return The pinch gesture detector
* @pre Pinch detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
/**
* @brief If deriving classes wish to fine tune pan gesture
- * detection then they can access the gesture detector through this
+ * detection, then they can access the gesture detector through this
* API and modify the detection.
*
- * @return The pan gesture detector.
+ * @SINCE_1_0.0
+ * @return The pan gesture detector
* @pre Pan detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
/**
* @brief If deriving classes wish to fine tune tap gesture
- * detection then they can access the gesture detector through this
+ * detection, then they can access the gesture detector through this
* API and modify the detection.
*
- * @return The tap gesture detector.
+ * @SINCE_1_0.0
+ * @return The tap gesture detector
* @pre Tap detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
/**
* @brief If deriving classes wish to fine tune long press gesture
- * detection then they can access the gesture detector through this
+ * detection, then they can access the gesture detector through this
* API and modify the detection.
*
- * @return The long press gesture detector.
+ * @SINCE_1_0.0
+ * @return The long press gesture detector
* @pre Long press detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
LongPressGestureDetector GetLongPressGestureDetector() const;
- // Background
-
- /**
- * @copydoc Dali::Toolkit::Control::SetStyleName
- */
- void SetStyleName( const std::string& styleName );
-
- /**
- * @copydoc Dali::Toolkit::Control::GetStyleName
- */
- const std::string& GetStyleName() const;
-
- /**
- * @copydoc Dali::Toolkit::Control::SetBackgroundColor
- */
- void SetBackgroundColor( const Vector4& color );
-
- /**
- * @copydoc Dali::Toolkit::Control::GetBackgroundColor
- */
- Vector4 GetBackgroundColor() const;
-
- /**
- * @copydoc Dali::Toolkit::Control::SetBackgroundImage
- */
- void SetBackgroundImage( Image image );
-
- /**
- * @copydoc Dali::Toolkit::Control::ClearBackground
- */
- void ClearBackground();
-
- /**
- * @copydoc Dali::Toolkit::Control::GetBackgroundActor
- */
- Actor GetBackgroundActor() const;
-
// Keyboard Navigation
/**
* keyboard focus movement between its child actors).
*
* The control doesn't support it by default.
- * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
+ * @SINCE_1_0.0
+ * @param[in] isSupported Whether this control supports two dimensional keyboard navigation
*/
- void SetKeyboardNavigationSupport(bool isSupported);
+ void SetKeyboardNavigationSupport( bool isSupported );
/**
* @brief Gets whether this control supports two dimensional keyboard navigation.
*
- * @return true if this control supports two dimensional keyboard navigation.
+ * @SINCE_1_0.0
+ * @return true if this control supports two dimensional keyboard navigation
*/
bool IsKeyboardNavigationSupported();
- // Called by Focus Managers
-
- /**
- * @brief Called by the focus manager and keyboard focus manager to Activate the Control
- */
- DALI_INTERNAL void Activate();
+ // Key Input
/**
- * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
- * pan gesture.
- *
- * @param[in] gesture The pan gesture.
- * @return true if the pan gesture has been consumed by this control
+ * @copydoc Toolkit::Control::SetKeyInputFocus()
*/
- virtual bool OnAccessibilityPan(PanGesture gesture);
+ void SetKeyInputFocus();
/**
- * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
- * touch event.
- *
- * @param[in] touchEvent The touch event.
- * @return true if the touch event has been consumed by this control
+ * @copydoc Toolkit::Control::HasKeyInputFocus()
*/
- virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent);
+ bool HasKeyInputFocus();
/**
- * @brief This method should be overridden by deriving classes when they wish to respond
- * the accessibility up and down action (i.e. value change of slider control).
- *
- * @param[in] isIncrease Whether the value should be increased or decreased
- * @return true if the value changed action has been consumed by this control
+ * @copydoc Toolkit::Control::ClearKeyInputFocus()
*/
- virtual bool OnAccessibilityValueChange(bool isIncrease);
+ void ClearKeyInputFocus();
// Keyboard Focus
* @brief Sets whether this control is a focus group for keyboard navigation.
*
* (i.e. the scope of keyboard focus movement
- * can be limitied to its child actors). The control is not a focus group by default.
- * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
+ * can be limited to its child actors). The control is not a focus group by default.
+ * @SINCE_1_0.0
+ * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation
*/
- void SetAsKeyboardFocusGroup(bool isFocusGroup);
+ void SetAsKeyboardFocusGroup( bool isFocusGroup );
/**
* @brief Gets whether this control is a focus group for keyboard navigation.
*
- * @return true if this control is set as a focus group for keyboard navigation.
+ * @SINCE_1_0.0
+ * @return true if this control is set as a focus group for keyboard navigation
*/
bool IsKeyboardFocusGroup();
+ /// @cond internal
/**
- * @brief Gets the next keyboard focusable actor in this control towards the given direction.
- *
- * A control needs to override this function in order to support two dimensional keyboard navigation.
- * @param[in] currentFocusedActor The current focused actor.
- * @param[in] direction The direction to move the focus towards.
- * @param[in] loopEnabled Whether the focus movement should be looped within the control.
- * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
+ * @brief Called by the AccessibilityManager to activate the Control.
+ * @SINCE_1_0.0
*/
- virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
+ DALI_INTERNAL void AccessibilityActivate();
/**
- * @brief Informs this control that its chosen focusable actor will be focused.
- *
- * This allows the application to preform any actions if wishes
- * before the focus is actually moved to the chosen actor.
- *
- * @param[in] commitedFocusableActor The commited focusable actor.
+ * @brief Called by the KeyboardFocusManager.
+ * @SINCE_1_0.0
*/
- virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
+ DALI_INTERNAL void KeyboardEnter();
+ /// @endcond
- /**
- * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
- *
- * Should be called last by the control after it acts on the Input Focus change.
- *
- * @param[in] focusGained True if gained, False if lost
- */
- void EmitKeyInputFocusSignal( bool focusGained );
-
- // Actions & Signals
-
- /**
- * @brief Performs actions as requested using the action name.
- *
- * @param[in] object The object on which to perform the action.
- * @param[in] actionName The action to perform.
- * @param[in] attributes The attributes with which to perfrom this action.
- * @return true if action has been accepted by this control
- */
- static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes);
-
- /**
- * Connects a callback function with the object's signals.
- * @param[in] object The object providing the signal.
- * @param[in] tracker Used to disconnect the signal.
- * @param[in] signalName The signal to connect to.
- * @param[in] functor A newly allocated FunctorDelegate.
- * @return True if the signal was connected.
- * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
- */
- static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
+ // Signals
/**
* @copydoc Dali::Toolkit::Control::KeyEventSignal()
*/
Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
+ /// @cond internal
/**
* @brief Called by the KeyInputFocusManager to emit key event signals.
*
- * @param[in] event The key event.
- * @return True if the event was consumed.
+ * @SINCE_1_0.0
+ * @param[in] event The key event
+ * @return True if the event was consumed
*/
- DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event);
-
-protected:
-
- // Construction
-
- // Flags for the constructor
- enum ControlBehaviour
- {
- REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change
- REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation
+ DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
+ /// @endcond
- LAST_CONTROL_BEHAVIOUR_FLAG
- };
-
- static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
+protected: // For derived classes to call
/**
- * @brief Create a Control.
+ * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.
*
- * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
+ * Should be called last by the control after it acts on the Input Focus change.
+ *
+ * @SINCE_1_0.0
+ * @param[in] focusGained True if gained, False if lost
*/
- Control(ControlBehaviour behaviourFlags);
+ void EmitKeyInputFocusSignal( bool focusGained );
+
+protected: // From CustomActorImpl
/**
- * @brief Second phase initialization.
+ * @copydoc CustomActorImpl::OnSceneConnection()
+ * @note If overridden, then an up-call to Control::OnSceneConnection MUST be made at the end.
*/
- void Initialize();
-
- // Gesture Detection
+ virtual void OnSceneConnection( int depth ) override;
/**
- * @brief Allows deriving classes to enable any of the gesture detectors that are available.
- *
- * Gesture detection can be enabled one at a time or in bitwise format as shown:
- * @code
- * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
- * @endcode
- * @param[in] type The gesture type(s) to enable.
+ * @copydoc CustomActorImpl::OnSceneDisconnection()
+ * @note If overridden, then an up-call to Control::OnSceneDisconnection MUST be made at the end.
*/
- void EnableGestureDetection(Gesture::Type type);
+ virtual void OnSceneDisconnection() override;
/**
- * @brief Allows deriving classes to disable any of the gesture detectors.
- *
- * Like EnableGestureDetection, this can also be called using bitwise or.
- * @param[in] type The gesture type(s) to disable.
- * @see EnableGetureDetection
+ * @copydoc CustomActorImpl::OnChildAdd()
+ * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end.
*/
- void DisableGestureDetection(Gesture::Type type);
+ virtual void OnChildAdd( Actor& child ) override;
/**
- * @copydoc Dali::CustomActorImpl::RelayoutDependentOnChildren()
+ * @copydoc CustomActorImpl::OnChildRemove()
+ * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
*/
- virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
+ virtual void OnChildRemove( Actor& child ) override;
-private:
-
- // For derived classes to override
+ /**
+ * @copydoc CustomActorImpl::OnPropertySet()
+ * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end.
+ */
+ void OnPropertySet( Property::Index index, const Property::Value& propertyValue ) override;
/**
- * @brief This method is called after the Control has been initialized.
- *
- * Derived classes should do any second phase initialization by overriding this method.
+ * @copydoc CustomActorImpl::OnSizeSet()
+ * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end.
*/
- virtual void OnInitialize();
+ virtual void OnSizeSet( const Vector3& targetSize ) override;
/**
- * @brief This method is called when the control is activated.
- *
- * Derived classes should override this if they wish to be notified when they are activated.
+ * @copydoc CustomActorImpl::OnSizeAnimation()
+ * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end.
*/
- virtual void OnActivated();
+ virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize ) override;
/**
- * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
- *
- * @param[in] styleManager The StyleManager object.
- * @param[in] change Information denoting what has changed.
+ * @copydoc CustomActorImpl::OnHoverEvent()
*/
- virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange change );
+ virtual bool OnHoverEvent( const HoverEvent& event ) override;
/**
- * @brief Called whenever a pinch gesture is detected on this control.
- *
- * This can be overridden by deriving classes when pinch detection
- * is enabled. The default behaviour is to scale the control by the
- * pinch scale.
- *
- * @note If overridden, then the default behaviour will not occur.
- * @note Pinch detection should be enabled via EnableGestureDetection().
- * @param[in] pinch The pinch gesture.
- * @see EnableGestureDetection
+ * @copydoc CustomActorImpl::OnKeyEvent()
*/
- virtual void OnPinch(const PinchGesture& pinch);
+ virtual bool OnKeyEvent( const KeyEvent& event ) override;
/**
- * @brief Called whenever a pan gesture is detected on this control.
- *
- * This should be overridden by deriving classes when pan detection
- * is enabled.
- *
- * @note There is no default behaviour with panning.
- * @note Pan detection should be enabled via EnableGestureDetection().
- * @param[in] pan The pan gesture.
- * @see EnableGestureDetection
+ * @copydoc CustomActorImpl::OnWheelEvent()
*/
- virtual void OnPan( const PanGesture& pan );
+ virtual bool OnWheelEvent( const WheelEvent& event ) override;
/**
- * @brief Called whenever a tap gesture is detected on this control.
- *
- * This should be overridden by deriving classes when tap detection
- * is enabled.
- *
- * @note There is no default behaviour with a tap.
- * @note Tap detection should be enabled via EnableGestureDetection().
- * @param[in] tap The tap gesture.
- * @see EnableGestureDetection
+ * @copydoc CustomActorImpl::OnRelayout()
*/
- virtual void OnTap( const TapGesture& tap );
+ virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
/**
- * @brief Called whenever a long press gesture is detected on this control.
- *
- * This should be overridden by deriving classes when long press
- * detection is enabled.
- *
- * @note There is no default behaviour associated with a long press.
- * @note Long press detection should be enabled via EnableGestureDetection().
- * @param[in] longPress The long press gesture.
- * @see EnableGestureDetection
+ * @copydoc CustomActorImpl::OnSetResizePolicy()
*/
- virtual void OnLongPress( const LongPressGesture& longPress );
+ virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) override;
/**
- * @brief Called whenever the control is added to the stage.
- *
- * Could be overridden by derived classes.
+ * @copydoc CustomActorImpl::GetNaturalSize()
*/
- virtual void OnControlStageConnection();
+ virtual Vector3 GetNaturalSize() override;
/**
- * @brief Called whenever the control is removed from the stage.
- *
- * Could be overridden by derived classes.
+ * @copydoc CustomActorImpl::CalculateChildSize()
*/
- virtual void OnControlStageDisconnection();
+ virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) override;
/**
- * @brief Called whenever an Actor is added to the control.
- *
- * Could be overridden by derived classes.
- *
- * @param[in] child The added actor.
+ * @copydoc CustomActorImpl::GetHeightForWidth()
*/
- virtual void OnControlChildAdd( Actor& child );
+ virtual float GetHeightForWidth( float width ) override;
/**
- * @brief Called whenever an Actor is removed from the control.
- *
- * Could be overridden by derived classes.
- *
- * @param[in] child The removed actor.
+ * @copydoc CustomActorImpl::GetWidthForHeight()
*/
- virtual void OnControlChildRemove( Actor& child );
+ virtual float GetWidthForHeight( float height ) override;
/**
- * @brief Called whenever the Control's size is set.
- *
- * Could be overridden by derived classes.
- *
- * @param[in] size The new size.
+ * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
*/
- virtual void OnControlSizeSet( const Vector3& size );
+ virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) override;
/**
- * @brief Called when the control gains key input focus.
- *
- * Should be overridden by derived classes if they need to customize what happens when focus is gained.
+ * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
*/
- virtual void OnKeyInputFocusGained();
+ virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) override;
/**
- * @brief Called when the control loses key input focus.
- *
- * Should be overridden by derived classes if they need to customize what happens when focus is lost.
+ * @copydoc CustomActorImpl::OnLayoutNegotiated()
*/
- virtual void OnKeyInputFocusLost();
+ virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) override;
+
+protected: // Helpers for deriving classes
- // From CustomActorImpl, derived classes can override these.
+ // Construction
/**
- * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
+ * @brief Flags for the constructor.
+ * @SINCE_1_0.0
*/
- virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
+ enum ControlBehaviour
+ {
+ CONTROL_BEHAVIOUR_DEFAULT = 0, ///< Default behaviour: Size negotiation is enabled & listens to Style Change signal, but doesn't receive event callbacks. @SINCE_1_2_10
+ 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 @DEPRECATED_1_2_10
+ REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
+
+ DISABLE_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 2 ), ///< True if control should not monitor style change signals @SINCE_1_2_10
+
+ LAST_CONTROL_BEHAVIOUR_FLAG
+ };
+
+ static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
/**
- * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&)
+ * @brief Control constructor.
+ *
+ * @SINCE_1_0.0
+ * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
*/
- virtual bool OnTouchEvent(const TouchEvent& event);
+ Control( ControlBehaviour behaviourFlags );
/**
- * @copydoc Dali::CustomActorImpl::OnHoverEvent(const HoverEvent&)
+ * @brief Second phase initialization.
+ * @SINCE_1_0.0
*/
- virtual bool OnHoverEvent(const HoverEvent& event);
+ void Initialize();
+
+public: // API for derived classes to override
+
+ // Lifecycle
/**
- * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
+ * @brief This method is called after the Control has been initialized.
+ *
+ * Derived classes should do any second phase initialization by overriding this method.
+ * @SINCE_1_0.0
*/
- virtual bool OnKeyEvent(const KeyEvent& event);
+ virtual void OnInitialize();
+
+ // Styling
/**
- * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&)
+ * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
+ *
+ * @SINCE_1_0.0
+ * @param[in] styleManager The StyleManager object
+ * @param[in] change Information denoting what has changed
*/
- virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
+ virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
+
+ // Accessibility
/**
- * @copydoc Dali::CustomActorImpl::OnCalculateRelayoutSize()
+ * @brief This method is called when the control is accessibility activated.
+ *
+ * Derived classes should override this to perform custom accessibility activation.
+ * @SINCE_1_0.0
+ * @return true if this control can perform accessibility activation
*/
- virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
+ virtual bool OnAccessibilityActivated();
/**
- * @copydoc Dali::CustomActorImpl::OnLayoutNegotiated()
+ * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
+ * pan gesture.
+ *
+ * @SINCE_1_0.0
+ * @param[in] gesture The pan gesture
+ * @return true if the pan gesture has been consumed by this control
*/
- virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
+ virtual bool OnAccessibilityPan( PanGesture gesture );
/**
- * @copydoc Dali::CustomActorImpl::OnRelayout()
+ * @brief This method should be overridden by deriving classes when they wish to respond
+ * the accessibility up and down action (i.e. value change of slider control).
+ *
+ * @SINCE_1_0.0
+ * @param[in] isIncrease Whether the value should be increased or decreased
+ * @return true if the value changed action has been consumed by this control
*/
- virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
+ virtual bool OnAccessibilityValueChange( bool isIncrease );
/**
- * @copydoc Dali::CustomActorImpl::OnSetResizePolicy()
+ * @brief This method should be overridden by deriving classes when they wish to respond
+ * the accessibility zoom action.
+ *
+ * @SINCE_1_0.0
+ * @return true if the zoom action has been consumed by this control
*/
- virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
+ virtual bool OnAccessibilityZoom();
+
+ // Keyboard focus
/**
- * @copydoc Dali::CustomActorImpl::CalculateChildSize()
+ * @brief Called when the control gains key input focus.
+ *
+ * Should be overridden by derived classes if they need to customize what happens when focus is gained.
+ * @SINCE_1_0.0
*/
- virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
+ virtual void OnKeyInputFocusGained();
- // From CustomActorImpl, derived classes should NOT override these.
+ /**
+ * @brief Called when the control loses key input focus.
+ *
+ * Should be overridden by derived classes if they need to customize what happens when focus is lost.
+ * @SINCE_1_0.0
+ */
+ virtual void OnKeyInputFocusLost();
/**
- * @brief Sends a request to relayout this control.
+ * @brief Gets the next keyboard focusable actor in this control towards the given direction.
*
- * The control will be relaid out after the
- * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.
+ * A control needs to override this function in order to support two dimensional keyboard navigation.
+ * @SINCE_1_0.0
+ * @param[in] currentFocusedActor The current focused actor
+ * @param[in] direction The direction to move the focus towards
+ * @param[in] loopEnabled Whether the focus movement should be looped within the control
+ * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused
+ */
+ virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
+
+ /**
+ * @brief Informs this control that its chosen focusable actor will be focused.
*
- * It calls OnControlStageConnection() to notify derived classes.
+ * This allows the application to perform any actions if wishes
+ * before the focus is actually moved to the chosen actor.
*
- * @see Dali::CustomActorImpl::OnStageConnection()
+ * @SINCE_1_0.0
+ * @param[in] commitedFocusableActor The commited focusable actor
*/
- virtual void OnStageConnection();
+ virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
/**
- * @brief Calls OnControlStageDisconnection() to notify derived classed.
+ * @brief This method is called when the control has enter pressed on it.
*
- * @see Dali::CustomActorImpl::OnStageDisconnection()
+ * Derived classes should override this to perform custom actions.
+ * @SINCE_1_0.0
+ * @return true if this control supported this action
*/
- virtual void OnStageDisconnection();
+ virtual bool OnKeyboardEnter();
+
+ // Gestures
/**
- * @brief Sends a request to relayout this control.
- *
- * The control will be relaid out after the
- * Dali::Stage::SignalMessageQueueFlushed() signal is emitted. It
- * calls OnControlChildAdd() to notify derived classes.
- *
- * @note This method shouldn't be overridden by derived classes.
+ * @brief Called whenever a pinch gesture is detected on this control.
*
- * @param[in] child The added actor.
+ * This can be overridden by deriving classes when pinch detection
+ * is enabled. The default behaviour is to scale the control by the
+ * pinch scale.
*
- * @see Dali::CustomActorImpl::OnChildAdd(Actor&)
+ * @SINCE_1_0.0
+ * @param[in] pinch The pinch gesture
+ * @note If overridden, then the default behavior will not occur.
+ * @note Pinch detection should be enabled via EnableGestureDetection().
+ * @see EnableGestureDetection
*/
- virtual void OnChildAdd(Actor& child);
+ virtual void OnPinch( const PinchGesture& pinch );
/**
- * @brief Sends a request to relayout this control.
+ * @brief Called whenever a pan gesture is detected on this control.
*
- * The control will be relaid out after the
- * Dali::Stage::SignalMessageQueueFlushed() signal is emitted. It
- * calls OnControlChildRemove() to notify derived classes.
+ * This should be overridden by deriving classes when pan detection
+ * is enabled.
*
- * @note This method shouldn't be overridden by derived classes.
+ * @SINCE_1_0.0
+ * @param[in] pan The pan gesture
+ * @note There is no default behavior with panning.
+ * @note Pan detection should be enabled via EnableGestureDetection().
+ * @see EnableGestureDetection
+ */
+ virtual void OnPan( const PanGesture& pan );
+
+ /**
+ * @brief Called whenever a tap gesture is detected on this control.
*
- * @param[in] child The removed actor.
+ * This should be overridden by deriving classes when tap detection
+ * is enabled.
*
- * @see Dali::CustomActorImpl::OnChildRemove(Actor&)
+ * @SINCE_1_0.0
+ * @param[in] tap The tap gesture
+ * @note There is no default behavior with a tap.
+ * @note Tap detection should be enabled via EnableGestureDetection().
+ * @see EnableGestureDetection
*/
- virtual void OnChildRemove(Actor& child);
+ virtual void OnTap( const TapGesture& tap );
/**
- * @brief It stores the size set by size negotiation and relayout.
- *
- * It also keeps a backup of the size set through the Actor's API used in the size negotiation.
- * It calls the OnControlSizeSet() to notify derived classes.
+ * @brief Called whenever a long press gesture is detected on this control.
*
- * @param[in] targetSize The new size.
+ * This should be overridden by deriving classes when long press
+ * detection is enabled.
*
- * @see Dali::CustomActorImpl::OnSizeSet(const Vector3&)
+ * @SINCE_1_0.0
+ * @param[in] longPress The long press gesture
+ * @note There is no default behaviour associated with a long press.
+ * @note Long press detection should be enabled via EnableGestureDetection().
+ * @see EnableGestureDetection
*/
- virtual void OnSizeSet(const Vector3& targetSize);
+ virtual void OnLongPress( const LongPressGesture& longPress );
// From ConnectionTrackerInterface
/**
* @copydoc ConnectionTrackerInterface::SignalConnected
*/
- virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
+ virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback ) override;
/**
* @copydoc ConnectionTrackerInterface::SignalDisconnected
*/
- virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
+ virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ) override;
+
+ /**
+ * @brief Retrieves the extension for this control.
+ *
+ * @SINCE_1_0.0
+ * @return The extension if available, NULL otherwise
+ */
+ virtual Extension* GetControlExtension()
+ {
+ return NULL;
+ }
private:
- // Undefined
- DALI_INTERNAL Control(const Control&);
- DALI_INTERNAL Control& operator=(const Control&);
+ /// @cond internal
- class Impl;
+ // Not copyable or movable
+ DALI_INTERNAL Control( const Control& ) = delete; ///< Deleted copy constructor.
+ DALI_INTERNAL Control( Control&& ) = delete; ///< Deleted move constructor.
+ DALI_INTERNAL Control& operator=( const Control& ) = delete; ///< Deleted copy assignment operator.
+ DALI_INTERNAL Control& operator=( Control&& ) = delete; ///< Deleted move assignment operator.
+
+public:
+ class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl
+
+private:
Impl* mImpl;
+ /// @endcond
- friend class Internal::KeyInputFocusManager; ///< KeyInputFocusManager needs to call several methods which are private. // TODO: Remove
};
+/**
+ * @brief Gets implementation from the handle.
+ *
+ * @SINCE_1_0.0
+ * @param handle
+ * @return Implementation
+ * @pre handle is initialized and points to a control
+ */
+DALI_TOOLKIT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
+
+/**
+ * @brief Gets implementation from the handle.
+ *
+ * @SINCE_1_0.0
+ * @param handle
+ * @return Implementation
+ * @pre Handle is initialized and points to a control.
+ */
+DALI_TOOLKIT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
+
} // namespace Internal
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
-#endif // __DALI_TOOLKIT_CONTROL_IMPL_H__
+#endif // DALI_TOOLKIT_CONTROL_IMPL_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff