X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fcontrol-impl.h;h=63ea4e95dedecb712340ddd8522b482f88be21f7;hp=249fed526f0d9abe7daf031ddf6c2cd8b1799ec5;hb=3475577c01591f3ff05d632b7f5dc774ceb87ddc;hpb=f17aee578d095c3a7c53355fbff3259070883de3 diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index 249fed5..63ea4e9 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -35,14 +35,8 @@ namespace Dali namespace Toolkit { - class StyleManager; -namespace Internal DALI_INTERNAL -{ -class KeyInputFocusManager; -} - namespace Internal { @@ -57,6 +51,8 @@ class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTracker { public: + class Extension; ///< Forward declare future extension interface + // Creation & Destruction /** @@ -72,43 +68,63 @@ public: */ virtual ~Control(); - // Size negotiation + // 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; + + // Background /** - * @copydoc Toolkit::CustomActorImpl::GetNaturalSize() + * @copydoc Dali::Toolkit::Control::SetBackgroundColor */ - virtual Vector3 GetNaturalSize(); - - // Key Input + void SetBackgroundColor( const Vector4& color ); /** - * @copydoc Toolkit::Control::SetKeyInputFocus() + * @copydoc Dali::Toolkit::Control::GetBackgroundColor */ - void SetKeyInputFocus(); + Vector4 GetBackgroundColor() const; /** - * @copydoc Toolkit::Control::HasKeyInputFocus() + * @copydoc Dali::Toolkit::Control::SetBackgroundImage */ - bool HasKeyInputFocus(); + void SetBackgroundImage( Image image ); /** - * @copydoc Toolkit::Control::ClearKeyInputFocus() + * @copydoc Dali::Toolkit::Control::ClearBackground */ - void ClearKeyInputFocus(); + void ClearBackground(); // Gesture Detection /** + * @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. + */ + void EnableGestureDetection( Gesture::Type type ); + + /** + * @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 + */ + void DisableGestureDetection( Gesture::Type type ); + + /** * @brief If deriving classes wish to fine tune pinch gesture * detection then they can access the gesture detector through this * API and modify the detection. @@ -152,43 +168,6 @@ public: */ 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 /** @@ -199,7 +178,7 @@ public: * The control doesn't support it by default. * @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. @@ -208,39 +187,22 @@ public: */ 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 @@ -251,7 +213,7 @@ public: * 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. */ - void SetAsKeyboardFocusGroup(bool isFocusGroup); + void SetAsKeyboardFocusGroup( bool isFocusGroup ); /** * @brief Gets whether this control is a focus group for keyboard navigation. @@ -260,26 +222,39 @@ public: */ bool IsKeyboardFocusGroup(); + // Called by Focus Manager + /** - * @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 accessibility focus manager and keyboard focus manager to activate the Control */ - virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled); + DALI_INTERNAL void AccessibilityActivate(); + + // Signals /** - * @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. + * @copydoc Dali::Toolkit::Control::KeyEventSignal() + */ + Toolkit::Control::KeyEventSignalType& KeyEventSignal(); + + /** + * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal() + */ + Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal(); + + /** + * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal() + */ + Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal(); + + /** + * @brief Called by the KeyInputFocusManager to emit key event signals. * - * @param[in] commitedFocusableActor The commited focusable actor. + * @param[in] event The key event. + * @return True if the event was consumed. */ - virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor); + DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event ); + +protected: // For derived classes to call /** * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal @@ -290,198 +265,140 @@ public: */ void EmitKeyInputFocusSignal( bool focusGained ); - // Actions & Signals +protected: // From CustomActorImpl, not to be used by application developers /** - * @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 + * @copydoc CustomActorImpl::OnStageConnection() */ - static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes); + virtual void OnStageConnection(); /** - * 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. + * @copydoc CustomActorImpl::OnStageDisconnection() */ - static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor ); + virtual void OnStageDisconnection(); /** - * @copydoc Dali::Toolkit::Control::KeyEventSignal() + * @copydoc CustomActorImpl::OnChildAdd() */ - Toolkit::Control::KeyEventSignalType& KeyEventSignal(); + virtual void OnChildAdd( Actor& child ); /** - * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal() + * @copydoc CustomActorImpl::OnChildRemove() */ - Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal(); + virtual void OnChildRemove( Actor& child ); /** - * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal() + * @copydoc CustomActorImpl::OnSizeSet() */ - Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal(); + virtual void OnSizeSet( const Vector3& targetSize ); /** - * @brief Called by the KeyInputFocusManager to emit key event signals. - * - * @param[in] event The key event. - * @return True if the event was consumed. + * @copydoc CustomActorImpl::OnSizeAnimation() */ - 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 - - LAST_CONTROL_BEHAVIOUR_FLAG - }; - - static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags + virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize ); /** - * @brief Create a Control. - * - * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum + * @copydoc CustomActorImpl::OnTouchEvent() */ - Control(ControlBehaviour behaviourFlags); + virtual bool OnTouchEvent( const TouchEvent& event ); /** - * @brief Second phase initialization. + * @copydoc CustomActorImpl::OnHoverEvent() */ - void Initialize(); - - // Gesture Detection + virtual bool OnHoverEvent( const HoverEvent& event ); /** - * @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::OnKeyEvent() */ - void EnableGestureDetection(Gesture::Type type); + virtual bool OnKeyEvent( const KeyEvent& event ); /** - * @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::OnWheelEvent() */ - void DisableGestureDetection(Gesture::Type type); + virtual bool OnWheelEvent( const WheelEvent& event ); /** - * @copydoc Dali::CustomActorImpl::RelayoutDependentOnChildren() + * @copydoc CustomActorImpl::OnRelayout() */ - virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); + virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ); -private: + /** + * @copydoc CustomActorImpl::OnSetResizePolicy() + */ + virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ); - // For derived classes to override + /** + * @copydoc CustomActorImpl::GetNaturalSize() + */ + virtual Vector3 GetNaturalSize(); /** - * @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::CalculateChildSize() */ - virtual void OnInitialize(); + virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ); /** - * @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::GetHeightForWidth() */ - virtual void OnActivated(); + virtual float GetHeightForWidth( float width ); /** - * @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::GetWidthForHeight() */ - virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange change ); + virtual float GetWidthForHeight( float height ); /** - * @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::RelayoutDependentOnChildren() */ - virtual void OnPinch(const PinchGesture& pinch); + virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); /** - * @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::OnCalculateRelayoutSize() */ - virtual void OnPan( const PanGesture& pan ); + virtual void OnCalculateRelayoutSize( Dimension::Type dimension ); /** - * @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::OnLayoutNegotiated() */ - virtual void OnTap( const TapGesture& tap ); + virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ); + +protected: // Helpers for deriving classes + + // 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 + + LAST_CONTROL_BEHAVIOUR_FLAG + }; + + static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags /** - * @brief Called whenever a long press gesture is detected on this control. + * @brief Control constructor * - * 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 + * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum */ - virtual void OnLongPress( const LongPressGesture& longPress ); + Control( ControlBehaviour behaviourFlags ); /** - * @brief Called whenever the control is added to the stage. - * - * Could be overridden by derived classes. + * @brief Second phase initialization. */ - virtual void OnControlStageConnection(); + void Initialize(); + +public: // API for derived classes to override + + // Lifecycle /** - * @brief Called whenever the control is removed from the stage. + * @brief This method is called after the Control has been initialized. * - * Could be overridden by derived classes. + * Derived classes should do any second phase initialization by overriding this method. */ - virtual void OnControlStageDisconnection(); + virtual void OnInitialize(); /** * @brief Called whenever an Actor is added to the control. @@ -501,114 +418,144 @@ private: */ virtual void OnControlChildRemove( Actor& child ); - /** - * @brief Called whenever the Control's size is set. - * - * Could be overridden by derived classes. - * - * @param[in] size The new size. - */ - virtual void OnControlSizeSet( const Vector3& size ); - - /** - * @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. - */ - virtual void OnKeyInputFocusGained(); + // Styling /** - * @brief Called when the control loses key input focus. + * @brief This method should be overridden by deriving classes requiring notifications when the style changes. * - * Should be overridden by derived classes if they need to customize what happens when focus is lost. + * @param[in] styleManager The StyleManager object. + * @param[in] change Information denoting what has changed. */ - virtual void OnKeyInputFocusLost(); + virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ); - // From CustomActorImpl, derived classes can override these. + // Accessibility /** - * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&) - */ - virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize); - - /** - * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&) + * @brief This method is called when the control is accessibility activated. + * + * Derived classes should override this to perform custom accessibility activation. + * @return true if this control can perform accessibility activation. */ - virtual bool OnTouchEvent(const TouchEvent& event); + virtual bool OnAccessibilityActivated(); /** - * @copydoc Dali::CustomActorImpl::OnHoverEvent(const HoverEvent&) + * @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 */ - virtual bool OnHoverEvent(const HoverEvent& event); + virtual bool OnAccessibilityPan( PanGesture gesture ); /** - * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&) + * @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 */ - virtual bool OnKeyEvent(const KeyEvent& event); + virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent ); /** - * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&) + * @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 */ - virtual bool OnMouseWheelEvent(const MouseWheelEvent& event); + virtual bool OnAccessibilityValueChange( bool isIncrease ); - /** - * @copydoc Dali::CustomActorImpl::OnCalculateRelayoutSize() - */ - virtual void OnCalculateRelayoutSize( Dimension::Type dimension ); + // Keyboard focus /** - * @copydoc Dali::CustomActorImpl::OnLayoutNegotiated() + * @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. */ - virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ); + virtual void OnKeyInputFocusGained(); /** - * @copydoc Dali::CustomActorImpl::OnRelayout() + * @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. */ - virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ); + virtual void OnKeyInputFocusLost(); /** - * @copydoc Dali::CustomActorImpl::OnSetResizePolicy() + * @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. */ - virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ); + virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled ); /** - * @copydoc Dali::CustomActorImpl::CalculateChildSize() + * @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. */ - virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ); + virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor ); - // From CustomActorImpl, derived classes should NOT override these. + // Gestures /** - * @brief Sends a request to relayout this control. - * - * The control will be relaid out after the - * Dali::Stage::SignalMessageQueueFlushed() signal is emitted. + * @brief Called whenever a pinch gesture is detected on this control. * - * It calls OnControlStageConnection() to notify derived classes. + * 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::OnStageConnection() - */ - virtual void OnStageConnection(); - - /** - * @copydoc Dali::CustomActorImpl::OnStageDisconnection() + * @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 */ - virtual void OnStageDisconnection(); + virtual void OnPinch( const PinchGesture& pinch ); /** - * @copydoc Dali::CustomActorImpl::OnChildAdd(Actor&) + * @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 */ - virtual void OnChildAdd(Actor& child); + virtual void OnPan( const PanGesture& pan ); /** - * @copydoc Dali::CustomActorImpl::OnChildRemove(Actor&) + * @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 */ - virtual void OnChildRemove(Actor& child); + virtual void OnTap( const TapGesture& tap ); /** - * @copydoc Dali::CustomActorImpl::OnSizeSet(const Vector3&) + * @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 */ - virtual void OnSizeSet(const Vector3& targetSize); + virtual void OnLongPress( const LongPressGesture& longPress ); // From ConnectionTrackerInterface @@ -622,18 +569,45 @@ private: */ virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ); + /** + * Retrieve the extension for this control + * + * @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&); + DALI_INTERNAL Control( const Control& ); + DALI_INTERNAL Control& operator=( const Control& ); class Impl; Impl* mImpl; - friend class Internal::KeyInputFocusManager; ///< KeyInputFocusManager needs to call several methods which are private. // TODO: Remove }; +/** + * @brief Get implementation from the handle + * + * @pre handle is initialized and points to a control + * @param handle + * @return implementation + */ +DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle ); + +/** + * @brief Get implementation from the handle + * + * @pre handle is initialized and points to a control + * @param handle + * @return implementation + */ +DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle ); + } // namespace Internal } // namespace Toolkit