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=999323743a7798fe39ef3e9f1defaa4bd41a01fd;hp=1cbf04fcb20a8e304531d3d3aeec253d7e3f9c21;hb=f4a28993f3f77f15015e5c9b4e1bedd06e23b926;hpb=2071317d301e9d5af326a3a2efcd2996263fbead diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index 1cbf04f..9993237 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -1,8 +1,8 @@ -#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) 2016 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. @@ -32,15 +32,20 @@ namespace Dali { - namespace Toolkit { +/** + * @addtogroup dali_toolkit_controls + * @{ + */ + class StyleManager; +class TransitionData; -namespace Internal DALI_INTERNAL +namespace Visual { -class KeyInputFocusManager; +class Base; } namespace Internal @@ -52,81 +57,103 @@ 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 { public: + class Extension; ///< Forward declare future extension interface + // Creation & Destruction /** * @brief Create 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. + * @SINCE_1_0.0 * @return A handle to the ControlImpl instance. */ static Toolkit::Control New(); /** * @brief Virtual destructor. + * @SINCE_1_0.0 */ 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::Control::GetNaturalSize() + * @copydoc Dali::Toolkit::Control::SetBackgroundColor */ - virtual Vector3 GetNaturalSize(); + void SetBackgroundColor( const Vector4& color ); /** - * @brief Retrieves the current Control's size. - * - * @return The control's size. + * @copydoc Dali::Toolkit::Control::GetBackgroundColor */ - const Vector3& GetControlSize() const; + Vector4 GetBackgroundColor() const; /** - * @brief Retrieves the Control's size set by the Application / Control. - * - * @return The control's size. + * @copydoc Dali::Toolkit::Control::SetBackgroundImage */ - const Vector3& GetSizeSet() const; - - // Key Input + void SetBackgroundImage( Image image ); /** - * @copydoc Toolkit::Control::SetKeyInputFocus() + * @brief Set the background with a property map. + * + * @SINCE_1_0.0 + * @param[in] map The background property map. */ - void SetKeyInputFocus(); + void SetBackground(const Property::Map& map); /** - * @copydoc Toolkit::Control::HasKeyInputFocus() + * @copydoc Dali::Toolkit::Control::ClearBackground */ - bool HasKeyInputFocus(); + void ClearBackground(); + + // Gesture Detection /** - * @copydoc Toolkit::Control::ClearKeyInputFocus() + * @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 + * @SINCE_1_0.0 + * @param[in] type The gesture type(s) to enable. */ - void ClearKeyInputFocus(); + void EnableGestureDetection( Gesture::Type type ); - // Gesture Detection + /** + * @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 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. * + * @SINCE_1_0.0 * @return The pinch gesture detector. * @pre Pinch detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection @@ -138,6 +165,7 @@ public: * detection then they can access the gesture detector through this * API and modify the detection. * + * @SINCE_1_0.0 * @return The pan gesture detector. * @pre Pan detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection @@ -149,6 +177,7 @@ public: * detection then they can access the gesture detector through this * API and modify the detection. * + * @SINCE_1_0.0 * @return The tap gesture detector. * @pre Tap detection should have been enabled via EnableGestureDetection(). * @see EnableGestureDetection @@ -160,498 +189,547 @@ public: * detection then they can access the gesture detector through this * API and modify the detection. * + * @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 + // Keyboard Navigation /** - * @copydoc Dali::Toolkit::Control::SetStyleName + * @brief Sets whether this control supports two dimensional + * keyboard navigation (i.e. whether it knows how to handle the + * keyboard focus movement between its child actors). + * + * The control doesn't support it by default. + * @SINCE_1_0.0 + * @param[in] isSupported Whether this control supports two dimensional keyboard navigation. */ - void SetStyleName( const std::string& styleName ); + void SetKeyboardNavigationSupport( bool isSupported ); /** - * @copydoc Dali::Toolkit::Control::GetStyleName + * @brief Gets whether this control supports two dimensional keyboard navigation. + * + * @SINCE_1_0.0 + * @return true if this control supports two dimensional keyboard navigation. */ - const std::string& GetStyleName() const; + bool IsKeyboardNavigationSupported(); + + // Key Input /** - * @copydoc Dali::Toolkit::Control::SetBackgroundColor + * @copydoc Toolkit::Control::SetKeyInputFocus() */ - void SetBackgroundColor( const Vector4& color ); + void SetKeyInputFocus(); /** - * @copydoc Dali::Toolkit::Control::GetBackgroundColor + * @copydoc Toolkit::Control::HasKeyInputFocus() */ - Vector4 GetBackgroundColor() const; + bool HasKeyInputFocus(); /** - * @copydoc Dali::Toolkit::Control::SetBackgroundImage + * @copydoc Toolkit::Control::ClearKeyInputFocus() */ - void SetBackgroundImage( Image image ); + void ClearKeyInputFocus(); + + // Keyboard Focus /** - * @copydoc Dali::Toolkit::Control::ClearBackground + * @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. + * @SINCE_1_0.0 + * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation. */ - void ClearBackground(); + void SetAsKeyboardFocusGroup( bool isFocusGroup ); /** - * @copydoc Dali::Toolkit::Control::GetBackgroundActor + * @brief Gets whether this control is a focus group for keyboard navigation. + * + * @SINCE_1_0.0 + * @return true if this control is set as a focus group for keyboard navigation. */ - Actor GetBackgroundActor() const; + bool IsKeyboardFocusGroup(); - // Keyboard Navigation + /// @cond internal + /** + * @brief Called by the AccessibilityManager to activate the Control. + * @SINCE_1_0.0 + */ + DALI_INTERNAL void AccessibilityActivate(); /** - * @brief Sets whether this control supports two dimensional - * keyboard navigation (i.e. whether it knows how to handle the - * 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. + * @brief Called by the KeyboardFocusManager. + * @SINCE_1_0.0 */ - void SetKeyboardNavigationSupport(bool isSupported); + DALI_INTERNAL void KeyboardEnter(); + /// @endcond + + // Signals /** - * @brief Gets whether this control supports two dimensional keyboard navigation. - * - * @return true if this control supports two dimensional keyboard navigation. + * @copydoc Dali::Toolkit::Control::KeyEventSignal() */ - bool IsKeyboardNavigationSupported(); + Toolkit::Control::KeyEventSignalType& KeyEventSignal(); - // Called by Focus Managers + /** + * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal() + */ + Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal(); /** - * @brief Called by the focus manager and keyboard focus manager to Activate the Control + * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal() */ - DALI_INTERNAL void Activate(); + Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal(); + /// @cond internal /** - * @brief This method should be overridden by deriving classes when they wish to respond the accessibility - * pan gesture. + * @brief Called by the KeyInputFocusManager to emit key event signals. * - * @param[in] gesture The pan gesture. - * @return true if the pan gesture has been consumed by this control + * @SINCE_1_0.0 + * @param[in] event The key event. + * @return True if the event was consumed. */ - virtual bool OnAccessibilityPan(PanGesture gesture); + DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event ); + /// @endcond + +protected: // For derived classes to call /** - * @brief This method should be overridden by deriving classes when they wish to respond the accessibility - * touch event. + * @brief Register a visual by Property Index, linking an Actor to visual when required. + * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle. + * No parenting is done during registration, this should be done by derived class. * - * @param[in] touchEvent The touch event. - * @return true if the touch event has been consumed by this control + * @SINCE_1_2.0 + * + * @param[in] index The Property index of the visual, used to reference visual + * @param[in] visual The visual to register + * @note Derived class should not call visual.SetOnStage(actor). It is the responsibility of the base class to connect/disconnect registered visual to stage. + * Use below API with enabled set to false if derived class wishes to control when visual is staged. */ - virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent); + void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual ); /** - * @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). + * @brief Register a visual by Property Index, linking an Actor to visual when required. + * In the case of the visual being an actor or control deeming visual not required then visual should be an empty handle. + * If enabled is false then the visual is not set on stage until enabled by the derived class. + * @see EnableVisual + * + * @SINCE_1_2.11 + * + * @param[in] index The Property index of the visual, used to reference visual + * @param[in] visual The visual to register + * @param[in] enabled false if derived class wants to control when visual is set on stage. * - * @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); + void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled ); - // Keyboard Focus + /** + * @brief Erase the entry matching the given index from the list of registered visuals + * @param[in] index The Property index of the visual, used to reference visual + * + * @SINCE_1_2.0 + */ + void UnregisterVisual( Property::Index index ); /** - * @brief Sets whether this control is a focus group for keyboard navigation. + * @brief Retrieve the visual associated with the given property index. * - * (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. + * @SINCE_1_2.2 + * + * @param[in] index The Property index of the visual. + * @return The registered visual if exist, otherwise empty handle. + * @note For managing object life-cycle, do not store the returned visual as a member which increments its reference count. */ - void SetAsKeyboardFocusGroup(bool isFocusGroup); + Toolkit::Visual::Base GetVisual( Property::Index index ) const; /** - * @brief Gets whether this control is a focus group for keyboard navigation. + * @brief Sets the given visual to be displayed or not when parent staged. * - * @return true if this control is set as a focus group for keyboard navigation. + * @SINCE_1_2.11 + * + * @param[in] index The Property index of the visual + * @param[in] enable flag to set enabled or disabled. */ - bool IsKeyboardFocusGroup(); + void EnableVisual( Property::Index index, bool enable ); /** - * @brief Gets the next keyboard focusable actor in this control towards the given direction. + * @brief Queries if the given visual is to be displayed when parent staged. * - * 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. + * @SINCE_1_2.11 + * + * @param[in] index The Property index of the visual + * @return bool whether visual is enabled or not */ - virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled); + bool IsVisualEnabled( Property::Index index ) const; /** - * @brief Informs this control that its chosen focusable actor will be focused. + * @brief Create a transition effect on the control. * - * This allows the application to preform any actions if wishes - * before the focus is actually moved to the chosen actor. + * @SINCE_1_2.12 * - * @param[in] commitedFocusableActor The commited focusable actor. + * @param[in] transitionData The transition data describing the effect to create + * @return A handle to an animation defined with the given effect, or an empty + * handle if no properties match. */ - virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor); + Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData ); /** * @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. * + * @SINCE_1_0.0 * @param[in] focusGained True if gained, False if lost */ 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() + * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start. */ - static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes); + virtual void OnStageConnection( int depth ); /** - * 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() + * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end. */ - static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor ); + virtual void OnStageDisconnection(); /** - * @copydoc Dali::Toolkit::Control::KeyEventSignal() + * @copydoc CustomActorImpl::OnChildAdd() + * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start. */ - Toolkit::Control::KeyEventSignalType& KeyEventSignal(); + virtual void OnChildAdd( Actor& child ); /** - * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal() + * @copydoc CustomActorImpl::OnChildRemove() + * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end. */ - Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal(); + virtual void OnChildRemove( Actor& child ); /** - * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal() + * @copydoc CustomActorImpl::OnSizeSet() + * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start. */ - 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() + * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start. */ - 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(); + virtual bool OnHoverEvent( const HoverEvent& event ); - // Gesture Detection + /** + * @copydoc CustomActorImpl::OnKeyEvent() + */ + virtual bool OnKeyEvent( const KeyEvent& 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::OnWheelEvent() */ - void EnableGestureDetection(Gesture::Type type); + virtual bool OnWheelEvent( const WheelEvent& 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::OnRelayout() */ - void DisableGestureDetection(Gesture::Type type); + virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ); /** - * @copydoc Dali::CustomActorImpl::RelayoutDependentOnChildren() + * @copydoc CustomActorImpl::OnSetResizePolicy() */ - virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); + virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ); -private: + /** + * @copydoc CustomActorImpl::GetNaturalSize() + */ + virtual Vector3 GetNaturalSize(); - // For derived classes to override + /** + * @copydoc CustomActorImpl::CalculateChildSize() + */ + virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ); /** - * @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::GetHeightForWidth() */ - virtual void OnInitialize(); + virtual float GetHeightForWidth( float width ); /** - * @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::GetWidthForHeight() */ - virtual void OnActivated(); + virtual float GetWidthForHeight( float height ); /** - * @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::RelayoutDependentOnChildren() */ - virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange change ); + virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); /** - * @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::OnCalculateRelayoutSize() */ - virtual void OnPinch(const PinchGesture& pinch); + virtual void OnCalculateRelayoutSize( Dimension::Type dimension ); /** - * @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::OnLayoutNegotiated() */ - virtual void OnPan( const PanGesture& pan ); + virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ); + +protected: // Helpers for deriving classes + + // Construction /** - * @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 + * @brief Flags for the constructor + * @SINCE_1_0.0 */ - virtual void OnTap( const TapGesture& tap ); + 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 /** - * @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. + * @brief Control constructor * - * @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 + * @SINCE_1_0.0 + * @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. + * @SINCE_1_0.0 */ - 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. + * @SINCE_1_0.0 */ - virtual void OnControlStageDisconnection(); + virtual void OnInitialize(); /** + * @DEPRECATED_1_1.30. Override OnChildAdd instead. + * * @brief Called whenever an Actor is added to the control. * * Could be overridden by derived classes. * + * @SINCE_1_0.0 * @param[in] child The added actor. */ virtual void OnControlChildAdd( Actor& child ); /** + * @DEPRECATED_1_1.30. Override OnChildRemove instead. + * * @brief Called whenever an Actor is removed from the control. * * Could be overridden by derived classes. * + * @SINCE_1_0.0 * @param[in] child The removed actor. */ 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. + * @SINCE_1_0.0 + * @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 ); + + // Accessibility /** - * @brief Called when the control loses key input focus. + * @brief This method is called when the control is accessibility activated. * - * Should be overridden by derived classes if they need to customize what happens when focus is lost. + * 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 OnKeyInputFocusLost(); - - // From CustomActorImpl, derived classes can override these. + virtual bool OnAccessibilityActivated(); /** - * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&) + * @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 OnSizeAnimation(Animation& animation, const Vector3& targetSize); + virtual bool OnAccessibilityPan( PanGesture gesture ); /** - * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&) + * @brief This method should be overridden by deriving classes when they wish to respond the accessibility + * touch event. + * + * @SINCE_1_0.0 + * @param[in] touchEvent The touch event. + * @return true if the touch event has been consumed by this control */ - virtual bool OnTouchEvent(const TouchEvent& event); + virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent ); /** - * @copydoc Dali::CustomActorImpl::OnHoverEvent(const HoverEvent&) + * @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 bool OnHoverEvent(const HoverEvent& event); + virtual bool OnAccessibilityValueChange( bool isIncrease ); /** - * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&) + * @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 bool OnKeyEvent(const KeyEvent& event); + virtual bool OnAccessibilityZoom(); - /** - * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&) - */ - virtual bool OnMouseWheelEvent(const MouseWheelEvent& event); + // Keyboard focus /** - * @copydoc Dali::CustomActorImpl::OnCalculateRelayoutSize() + * @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 void OnCalculateRelayoutSize( Dimension::Type dimension ); + virtual void OnKeyInputFocusGained(); /** - * @copydoc Dali::CustomActorImpl::OnLayoutNegotiated() + * @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 OnLayoutNegotiated( float size, Dimension::Type dimension ); + virtual void OnKeyInputFocusLost(); /** - * @copydoc Dali::CustomActorImpl::OnRelayout() + * @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. + * @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 void OnRelayout( const Vector2& size, RelayoutContainer& container ); + virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled ); /** - * @copydoc Dali::CustomActorImpl::OnSetResizePolicy() + * @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. + * + * @SINCE_1_0.0 + * @param[in] commitedFocusableActor The commited focusable actor. */ - virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ); + virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor ); /** - * @copydoc Dali::CustomActorImpl::CalculateChildSize() + * @brief This method is called when the control has enter pressed on it. + * + * Derived classes should override this to perform custom actions. + * @SINCE_1_0.0 + * @return true if this control supported this action. */ - virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ); + virtual bool OnKeyboardEnter(); - // 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. - * - * It calls OnControlStageConnection() to notify derived classes. + * @brief Called whenever a pinch gesture is detected on this control. * - * @see Dali::CustomActorImpl::OnStageConnection() - */ - virtual void OnStageConnection(); - - /** - * @brief Calls OnControlStageDisconnection() to notify derived classed. + * 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::OnStageDisconnection() + * @SINCE_1_0.0 + * @param[in] pinch The pinch gesture. + * @note If overridden, then the default behaviour will not occur. + * @note Pinch detection should be enabled via EnableGestureDetection(). + * @see EnableGestureDetection */ - virtual void OnStageDisconnection(); + virtual void OnPinch( const PinchGesture& pinch ); /** - * @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 pan gesture is detected on this control. * - * @param[in] child The added actor. + * This should be overridden by deriving classes when pan detection + * is enabled. * - * @see Dali::CustomActorImpl::OnChildAdd(Actor&) + * @SINCE_1_0.0 + * @param[in] pan The pan gesture. + * @note There is no default behaviour with panning. + * @note Pan detection should be enabled via EnableGestureDetection(). + * @see EnableGestureDetection */ - virtual void OnChildAdd(Actor& child); + virtual void OnPan( const PanGesture& pan ); /** - * @brief Sends a request to relayout this control. - * - * The control will be relaid out after the - * Dali::Stage::SignalMessageQueueFlushed() signal is emitted. It - * calls OnControlChildRemove() to notify derived classes. - * - * @note This method shouldn't be overridden by derived classes. + * @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 behaviour 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 @@ -665,22 +743,57 @@ private: */ virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ); + /** + * @brief Retrieve the extension for this control + * + * @SINCE_1_0.0 + * @return The extension if available, NULL otherwise + */ + virtual Extension* GetControlExtension() + { + return NULL; + } + private: + /// @cond internal // 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; + /// @endcond - friend class Internal::KeyInputFocusManager; ///< KeyInputFocusManager needs to call several methods which are private. // TODO: Remove }; +/** + * @brief Get implementation from the handle. + * + * @SINCE_1_0.0 + * @param handle + * @return implementation + * @pre handle is initialized and points to a control + */ +DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle ); + +/** + * @brief Get implementation from the handle. + * + * @SINCE_1_0.0 + * @param handle + * @return implementation + * @pre handle is initialized and points to a control + */ +DALI_IMPORT_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