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=b3d0c1e2c59e32f416878cdfc16f3d6e2e95e1eb;hp=a441b072a479e24ec6ffbd7cf447329da55e77c3;hb=848787435a85536032861126d0feffe7b1870911;hpb=2d176ad7e81d50e266dced075281b7a2a92f6b45 diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index a441b07..b3d0c1e 100644 --- a/dali-toolkit/public-api/controls/control-impl.h +++ b/dali-toolkit/public-api/controls/control-impl.h @@ -2,7 +2,7 @@ #define __DALI_TOOLKIT_CONTROL_IMPL_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2015 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. @@ -20,7 +20,6 @@ // EXTERNAL INCLUDES #include -#include #include #include #include @@ -36,142 +35,118 @@ namespace Dali namespace Toolkit { +/** + * @addtogroup dali_toolkit_controls + * @{ + */ class StyleManager; -namespace Internal DALI_INTERNAL -{ -class RelayoutControllerImpl; -class KeyInputFocusManager; -} - -typedef std::pair< Actor, Vector2 > ActorSizePair; ///< Pair of actor and size -typedef std::vector< ActorSizePair > ActorSizeContainer; ///< Container of actors and their sizes - namespace Internal { - /** * @brief This is the internal base class for all controls. * * 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 - - /** - * @copydoc Toolkit::Control::SetSizePolicy() - */ - void SetSizePolicy( Toolkit::Control::SizePolicy widthPolicy, Toolkit::Control::SizePolicy heightPolicy ); + // Styling /** - * @copydoc Toolkit::Control::GetSizePolicy() + * @copydoc Dali::Toolkit::Control::SetStyleName */ - void GetSizePolicy( Toolkit::Control::SizePolicy& widthPolicy, Toolkit::Control::SizePolicy& heightPolicy ) const; + void SetStyleName( const std::string& styleName ); /** - * @copydoc Toolkit::Control::SetMinimumSize() + * @copydoc Dali::Toolkit::Control::GetStyleName */ - void SetMinimumSize( const Vector3& size ); + const std::string& GetStyleName() const; - /** - * @copydoc Toolkit::Control::GetMinimumSize() - */ - const Vector3& GetMinimumSize() const; + // Background /** - * @copydoc Toolkit::Control::SetMaximumSize() + * @copydoc Dali::Toolkit::Control::SetBackgroundColor */ - void SetMaximumSize( const Vector3& size ); + void SetBackgroundColor( const Vector4& color ); /** - * @copydoc Toolkit::Control::GetMaximumSize() + * @copydoc Dali::Toolkit::Control::GetBackgroundColor */ - const Vector3& GetMaximumSize() const; + Vector4 GetBackgroundColor() const; /** - * @copydoc Toolkit::Control::GetNaturalSize() + * @copydoc Dali::Toolkit::Control::SetBackgroundImage */ - virtual Vector3 GetNaturalSize(); + void SetBackgroundImage( Image image ); /** - * @brief This method is called during size negotiation when a height is required for a given width. + * @brief Set the background with a property map. * - * Derived classes should override this if they wish to customize the height returned. - * - * @param width to use. - * @return the height based on the width. + * @SINCE_1_0.0 + * @param[in] map The background property map. */ - virtual float GetHeightForWidth( float width ); + void SetBackground(const Property::Map& map); /** - * @brief This method is called during size negotiation when a width is required for a given height. - * - * Derived classes should override this if they wish to customize the width returned. - * - * @param height to use. - * @return the width based on the width. + * @copydoc Dali::Toolkit::Control::ClearBackground */ - virtual float GetWidthForHeight( float height ); + void ClearBackground(); - /** - * @brief Retrieves the current Control's size. - * - * @return The control's size. - */ - const Vector3& GetControlSize() const; + // Gesture Detection /** - * @brief Retrieves the Control's size set by the Application / Control. + * @brief Allows deriving classes to enable any of the gesture detectors that are available. * - * @return The control's size. - */ - const Vector3& GetSizeSet() const; - - // Key Input - - /** - * @copydoc Toolkit::Control::SetKeyInputFocus() - */ - void SetKeyInputFocus(); - - /** - * @copydoc Toolkit::Control::HasKeyInputFocus() + * 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. */ - bool HasKeyInputFocus(); + void EnableGestureDetection( Gesture::Type 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( 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 @@ -183,6 +158,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 @@ -194,6 +170,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 @@ -205,107 +182,50 @@ 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 - - /** - * @copydoc Dali::Toolkit::Control::SetBackgroundColor - */ - void SetBackgroundColor( const Vector4& color ); - - /** - * @copydoc Dali::Toolkit::Control::GetBackgroundColor - */ - Vector4 GetBackgroundColor() const; - - /** - * @copydoc Dali::Toolkit::Control::SetBackground - */ - void SetBackground( Image image ); - - /** - * @copydoc Dali::Toolkit::Control::ClearBackground - */ - void ClearBackground(); - - /** - * @copydoc Dali::Toolkit::Control::GetBackgroundActor - */ - Actor GetBackgroundActor() const; - // Keyboard Navigation /** * @brief Sets whether this control supports two dimensional * keyboard navigation (i.e. whether it knows how to handle the - * keyboardn focus movement between its child actors). + * 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 SetKeyboardNavigationSupport(bool isSupported); + void SetKeyboardNavigationSupport( bool isSupported ); /** * @brief Gets whether 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(); - - /** - * @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); + // Key Input /** - * @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::SetKeyInputFocus() */ - virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent); + void SetKeyInputFocus(); /** - * @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::HasKeyInputFocus() */ - virtual bool OnAccessibilityValueChange(bool isIncrease); - - // Called by the RelayoutController + bool HasKeyInputFocus(); /** - * @brief Called by the RelayoutController to negotiate the size of a control. - * - * The size allocated by the the algorithm is passed in which the - * control must adhere to. A container is passed in as well which - * the control should populate with actors it has not / or does not - * need to handle in its size negotiation. - * - * @param[in] size The allocated size. - * @param[in,out] container The container that holds actors that are fed back into the - * RelayoutController algorithm. + * @copydoc Toolkit::Control::ClearKeyInputFocus() */ - DALI_INTERNAL void NegotiateSize( const Vector2& size, ActorSizeContainer& container ); + void ClearKeyInputFocus(); // Keyboard Focus @@ -314,257 +234,213 @@ public: * * (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 SetAsKeyboardFocusGroup(bool isFocusGroup); + void SetAsKeyboardFocusGroup( bool isFocusGroup ); /** * @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. */ 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. + * @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(); - // Actions & Signals + // 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 + * @copydoc Dali::Toolkit::Control::KeyEventSignal() */ - static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes); + Toolkit::Control::KeyEventSignalType& KeyEventSignal(); /** - * 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 Dali::Toolkit::Control::KeyInputFocusGainedSignal() */ - static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor ); + Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal(); /** - * @copydoc Dali::Toolkit::Control::KeyEventSignal() + * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal() */ - Toolkit::Control::KeyEventSignalType& KeyEventSignal(); + Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal(); /** * @brief Called by the KeyInputFocusManager to emit key event signals. * + * @SINCE_1_0.0 * @param[in] event The key event. * @return True if the event was consumed. */ - DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event); + DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event ); -protected: +protected: // For derived classes to call - // Construction + /** + * @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 ); - // Flags for the constructor - enum ControlBehaviour - { - CONTROL_BEHAVIOUR_NONE = 0, - REQUIRES_TOUCH_EVENTS = 1<<1, ///< True if the OnTouchEvent() callback is required. - REQUIRES_STYLE_CHANGE_SIGNALS = 1<<2, ///< True if needs to monitor style change signals such as theme/font change - NO_SIZE_NEGOTIATION = 1<<3, ///< True if control does not need size negotiation, i.e. it can be skipped in the algorithm - REQUIRES_HOVER_EVENTS = 1<<4, ///< True if the OnHoverEvent() callback is required. - REQUIRES_MOUSE_WHEEL_EVENTS = 1<<5 ///< True if the OnMouseWheelEvent() callback is required. - }; +protected: // From CustomActorImpl, not to be used by application developers /** - * @brief Create a Control. - * - * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum + * @copydoc CustomActorImpl::OnStageConnection() */ - Control(ControlBehaviour behaviourFlags); + virtual void OnStageConnection( int depth ); /** - * @brief Second phase initialization. + * @copydoc CustomActorImpl::OnStageDisconnection() */ - void Initialize(); + virtual void OnStageDisconnection(); - // Gesture Detection + /** + * @copydoc CustomActorImpl::OnChildAdd() + */ + virtual void OnChildAdd( Actor& child ); /** - * @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::OnChildRemove() */ - void EnableGestureDetection(Gesture::Type type); + virtual void OnChildRemove( Actor& child ); /** - * @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::OnSizeSet() */ - void DisableGestureDetection(Gesture::Type type); + virtual void OnSizeSet( const Vector3& targetSize ); - // Size Negotiation + /** + * @copydoc CustomActorImpl::OnSizeAnimation() + */ + virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize ); /** - * @brief Request a relayout, which means performing a size negotiation on this control, its parent and children (and potentially whole scene) - * - * This method is automatically called from OnStageConnection(), OnChildAdd(), - * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and SetMaximumSize(). - * - * This method can also be called from a derived class every time it needs a different size. - * At the end of event processing, the relayout process starts and - * all controls which requested Relayout will have their sizes (re)negotiated. - * - * @note RelayoutRequest() can be called multiple times; the size negotiation is still - * only performed once, i.e. there is no need to keep track of this in the calling side. + * @copydoc CustomActorImpl::OnTouchEvent() */ - void RelayoutRequest(); + virtual bool OnTouchEvent( const TouchEvent& event ); /** - * @brief Helper method for controls to Relayout their children if - * they do not know whether that child is a control or not. - * - * @param[in] actor The actor to relayout. - * @param[in] size The size to allocate to the actor. - * @param[in,out] container The container that holds actors that have not been allocated a size yet. + * @copydoc CustomActorImpl::OnHoverEvent() */ - static void Relayout( Actor actor, const Vector2& size, ActorSizeContainer& container ); + virtual bool OnHoverEvent( const HoverEvent& event ); -private: + /** + * @copydoc CustomActorImpl::OnKeyEvent() + */ + virtual bool OnKeyEvent( const KeyEvent& event ); - // For derived classes to override + /** + * @copydoc CustomActorImpl::OnWheelEvent() + */ + virtual bool OnWheelEvent( const WheelEvent& event ); /** - * @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::OnRelayout() */ - virtual void OnInitialize(); + virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ); /** - * @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::OnSetResizePolicy() */ - virtual void OnActivated(); + virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ); /** - * @brief This method should be overridden by deriving classes when - * they wish to be notified when the style manager changes the theme. - * - * @param[in] styleManager The StyleManager object. + * @copydoc CustomActorImpl::GetNaturalSize() */ - virtual void OnThemeChange( Toolkit::StyleManager styleManager ); + virtual Vector3 GetNaturalSize(); /** - * @brief This method should be overridden by deriving classes when - * they wish to be notified when the style changes the default font. - * - * @param[in] defaultFontChange Information denoting whether the default font has changed. - * @param[in] defaultFontSizeChange Information denoting whether the default font size has changed. + * @copydoc CustomActorImpl::CalculateChildSize() */ - virtual void OnFontChange( bool defaultFontChange, bool defaultFontSizeChange ); + virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ); /** - * @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::GetHeightForWidth() */ - virtual void OnPinch(const PinchGesture& pinch); + virtual float GetHeightForWidth( float width ); /** - * @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::GetWidthForHeight() */ - virtual void OnPan( const PanGesture& pan ); + virtual float GetWidthForHeight( float height ); /** - * @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::RelayoutDependentOnChildren() */ - virtual void OnTap( const TapGesture& tap ); + virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); /** - * @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::OnCalculateRelayoutSize() */ - virtual void OnLongPress( const LongPressGesture& longPress ); + virtual void OnCalculateRelayoutSize( Dimension::Type dimension ); + + /** + * @copydoc CustomActorImpl::OnLayoutNegotiated() + */ + 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 @SINCE_1_0.0 + REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0 + + 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 the control is added to the stage. + * @brief Control constructor * - * Could be overridden by derived classes. + * @SINCE_1_0.0 + * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum */ - virtual void OnControlStageConnection(); + Control( ControlBehaviour behaviourFlags ); /** - * @brief Called whenever the control is removed from the stage. + * @brief Second phase initialization. + * @SINCE_1_0.0 + */ + void Initialize(); + +public: // API for derived classes to override + + // Lifecycle + + /** + * @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(); /** * @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 ); @@ -574,140 +450,180 @@ private: * * Could be overridden by derived classes. * + * @SINCE_1_0.0 * @param[in] child The removed actor. */ virtual void OnControlChildRemove( Actor& child ); + // Styling + /** - * @brief Called whenever the Control's size is set. + * @brief This method should be overridden by deriving classes requiring notifications when the style changes. * - * Could be overridden by derived classes. - * - * @param[in] size The new size. + * @SINCE_1_0.0 + * @param[in] styleManager The StyleManager object. + * @param[in] change Information denoting what has changed. */ - virtual void OnControlSizeSet( const Vector3& size ); + virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ); + + // Accessibility /** - * @brief Called after the size negotiation has been finished for this control. - * - * The control is expected to assign this given size to itself/its children. - * - * Should be overridden by derived classes if they need to layout - * actors differently after certain operations like add or remove - * actors, resize or after changing specific properties. - * - * Note! As this function is called from inside the size negotiation algorithm, you cannot - * call RequestRelayout (the call would just be ignored) + * @brief This method is called when the control is accessibility activated. * - * @param[in] size The allocated size. - * @param[in,out] container The control should add actors to this container that it is not able - * to allocate a size for. + * 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 OnRelayout( const Vector2& size, ActorSizeContainer& container ); + virtual bool OnAccessibilityActivated(); /** - * @brief Called when the control gains key input focus. + * @brief This method should be overridden by deriving classes when they wish to respond the accessibility + * pan gesture. * - * Should be overridden by derived classes if they need to customize what happens when focus is gained. + * @SINCE_1_0.0 + * @param[in] gesture The pan gesture. + * @return true if the pan gesture has been consumed by this control */ - virtual void OnKeyInputFocusGained(); + virtual bool OnAccessibilityPan( PanGesture gesture ); /** - * @brief Called when the control loses key input focus. + * @brief This method should be overridden by deriving classes when they wish to respond the accessibility + * touch event. * - * Should be overridden by derived classes if they need to customize what happens when focus is lost. + * @SINCE_1_0.0 + * @param[in] touchEvent The touch event. + * @return true if the touch event has been consumed by this control */ - virtual void OnKeyInputFocusLost(); - - // From CustomActorImpl, derived classes can override these. + virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent ); /** - * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&) + * @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 OnSizeAnimation(Animation& animation, const Vector3& targetSize); + virtual bool OnAccessibilityValueChange( bool isIncrease ); /** - * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&) + * @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 OnTouchEvent(const TouchEvent& event); + virtual bool OnAccessibilityZoom(); + + // Keyboard focus /** - * @copydoc Dali::CustomActorImpl::OnHoverEvent(const HoverEvent&) + * @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 bool OnHoverEvent(const HoverEvent& event); + virtual void OnKeyInputFocusGained(); /** - * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&) + * @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 bool OnKeyEvent(const KeyEvent& event); + virtual void OnKeyInputFocusLost(); /** - * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&) + * @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 bool OnMouseWheelEvent(const MouseWheelEvent& event); - - // From CustomActorImpl, derived classes should NOT override these. + virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled ); /** - * @brief Sends a request to relayout this control. - * - * The control will be relaid out after the - * Dali::Stage::SignalMessageQueueFlushed() signal is emitted. + * @brief Informs this control that its chosen focusable actor will be focused. * - * It calls OnControlStageConnection() to notify derived classes. + * This allows the application to preform 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 behaviour 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 behaviour 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 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 @@ -721,30 +637,53 @@ private: */ virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ); - // Style - /** - * @brief This method is the callback for the StyleChangeSignal from StyleManager + * @brief Retrieve the extension for this control * - * @param[in] styleManager The StyleManager Object - * @param[in] change Information denoting what has changed. + * @SINCE_1_0.0 + * @return The extension if available, NULL otherwise */ - DALI_INTERNAL void DoStyleChange( Toolkit::StyleManager styleManager, StyleChange change ); + 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. + * + * @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