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=a7e2c91e2704e8a0c60237fda671fbaad4a68c1e;hp=68a9c4bd266b95bcdc87b6275d728c757a77bb13;hb=314399fefddfca7aad35a8392a17cff26434f418;hpb=c3cac93143d2055fcc4fe6531cbdb1afbd25cfb7 diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index 68a9c4b..a7e2c91 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -35,16 +35,13 @@ namespace Dali namespace Toolkit { - class StyleManager; -namespace Internal DALI_INTERNAL -{ -class KeyInputFocusManager; -} - namespace Internal { +class FocusManager; +class KeyboardFocusManager; +class KeyInputFocusManager; /** * @brief This is the internal base class for all controls. @@ -74,23 +71,6 @@ public: */ virtual ~Control(); - // Size negotiation - - /** - * @copydoc Dali::CustomActorImpl::GetHeightForWidth() - */ - virtual float GetHeightForWidth( float width ); - - /** - * @copydoc Dali::CustomActorImpl::GetWidthForHeight() - */ - virtual float GetWidthForHeight( float height ); - - /** - * @copydoc Toolkit::CustomActorImpl::GetNaturalSize() - */ - virtual Vector3 GetNaturalSize(); - // Key Input /** @@ -154,7 +134,7 @@ public: */ LongPressGestureDetector GetLongPressGestureDetector() const; - // Background + // Styling /** * @copydoc Dali::Toolkit::Control::SetStyleName @@ -166,6 +146,8 @@ public: */ const std::string& GetStyleName() const; + // Background + /** * @copydoc Dali::Toolkit::Control::SetBackgroundColor */ @@ -186,11 +168,6 @@ public: */ void ClearBackground(); - /** - * @copydoc Dali::Toolkit::Control::GetBackgroundActor - */ - Actor GetBackgroundActor() const; - // Keyboard Navigation /** @@ -217,33 +194,6 @@ public: */ DALI_INTERNAL void Activate(); - /** - * @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 OnAccessibilityPan(PanGesture gesture); - - /** - * @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 OnAccessibilityTouch(const TouchEvent& touchEvent); - - /** - * @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 OnAccessibilityValueChange(bool isIncrease); - // Keyboard Focus /** @@ -263,27 +213,6 @@ public: bool IsKeyboardFocusGroup(); /** - * @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 Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled); - - /** - * @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 void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor); - - /** * @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. @@ -338,7 +267,104 @@ public: */ DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event); -protected: +protected: // From CustomActorImpl, not to be used by application developers + + /** + * @copydoc CustomActorImpl::OnStageConnection() + */ + virtual void OnStageConnection(); + + /** + * @copydoc CustomActorImpl::OnStageDisconnection() + */ + virtual void OnStageDisconnection(); + + /** + * @copydoc CustomActorImpl::OnChildAdd() + */ + virtual void OnChildAdd(Actor& child); + + /** + * @copydoc CustomActorImpl::OnChildRemove() + */ + virtual void OnChildRemove(Actor& child); + + /** + * @copydoc CustomActorImpl::OnSizeSet() + */ + virtual void OnSizeSet(const Vector3& targetSize); + + /** + * @copydoc CustomActorImpl::OnSizeAnimation() + */ + virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize); + + /** + * @copydoc CustomActorImpl::OnTouchEvent() + */ + virtual bool OnTouchEvent(const TouchEvent& event); + + /** + * @copydoc CustomActorImpl::OnHoverEvent() + */ + virtual bool OnHoverEvent(const HoverEvent& event); + + /** + * @copydoc CustomActorImpl::OnKeyEvent() + */ + virtual bool OnKeyEvent(const KeyEvent& event); + + /** + * @copydoc CustomActorImpl::OnMouseWheelEvent() + */ + virtual bool OnMouseWheelEvent(const MouseWheelEvent& event); + + /** + * @copydoc CustomActorImpl::OnRelayout() + */ + virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ); + + /** + * @copydoc CustomActorImpl::OnSetResizePolicy() + */ + virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ); + + /** + * @copydoc CustomActorImpl::GetNaturalSize() + */ + virtual Vector3 GetNaturalSize(); + + /** + * @copydoc CustomActorImpl::CalculateChildSize() + */ + virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ); + + /** + * @copydoc CustomActorImpl::GetHeightForWidth() + */ + virtual float GetHeightForWidth( float width ); + + /** + * @copydoc CustomActorImpl::GetWidthForHeight() + */ + virtual float GetWidthForHeight( float height ); + + /** + * @copydoc CustomActorImpl::RelayoutDependentOnChildren() + */ + virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); + + /** + * @copydoc CustomActorImpl::OnCalculateRelayoutSize() + */ + virtual void OnCalculateRelayoutSize( Dimension::Type dimension ); + + /** + * @copydoc CustomActorImpl::OnLayoutNegotiated() + */ + virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ); + +protected: // Helpers for deriving classes // Construction @@ -354,11 +380,11 @@ protected: static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags /** - * @brief Create a Control. + * @brief Control constructor * * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum */ - Control(ControlBehaviour behaviourFlags); + Control( ControlBehaviour behaviourFlags ); /** * @brief Second phase initialization. @@ -376,7 +402,7 @@ protected: * @endcode * @param[in] type The gesture type(s) to enable. */ - void EnableGestureDetection(Gesture::Type type); + void EnableGestureDetection( Gesture::Type type ); /** * @brief Allows deriving classes to disable any of the gesture detectors. @@ -385,16 +411,11 @@ protected: * @param[in] type The gesture type(s) to disable. * @see EnableGetureDetection */ - void DisableGestureDetection(Gesture::Type type); + void DisableGestureDetection( Gesture::Type type ); - /** - * @copydoc Dali::CustomActorImpl::RelayoutDependentOnChildren() - */ - virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); +public: // API for derived classes to override -private: - - // For derived classes to override + // Lifecycle /** * @brief This method is called after the Control has been initialized. @@ -404,74 +425,6 @@ private: virtual void OnInitialize(); /** - * @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. - */ - virtual void OnActivated(); - - /** - * @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. - */ - virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ); - - /** - * @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 - */ - virtual void OnPinch(const PinchGesture& pinch); - - /** - * @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 OnPan( const PanGesture& pan ); - - /** - * @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 OnTap( const TapGesture& tap ); - - /** - * @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 OnLongPress( const LongPressGesture& longPress ); - - /** * @brief Called whenever the control is added to the stage. * * Could be overridden by derived classes. @@ -503,114 +456,152 @@ 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 ); + // Styling /** - * @brief Called when the control gains 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 gained. + * @param[in] styleManager The StyleManager object. + * @param[in] change Information denoting what has changed. */ - virtual void OnKeyInputFocusGained(); + virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ); + + // Size negotiation /** - * @brief Called when the control loses key input focus. + * @brief Called whenever the Control's size is set. * - * Should be overridden by derived classes if they need to customize what happens when focus is lost. + * @param[in] size The new size. */ - virtual void OnKeyInputFocusLost(); - - // From CustomActorImpl, derived classes can override these. + virtual void OnControlSizeSet( const Vector3& size ); - /** - * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&) - */ - virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize); + // Accessibility /** - * @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. */ - virtual bool OnTouchEvent(const TouchEvent& event); + virtual void 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::KeyboardFocusNavigationDirection 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 @@ -629,7 +620,7 @@ private: * * @return The extension if available, NULL otherwise */ - virtual Extension* GetExtension() + virtual Extension* GetControlExtension() { return NULL; } @@ -643,9 +634,26 @@ private: 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 + */ +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 + */ +const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle ); + } // namespace Internal } // namespace Toolkit