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=9d6feacb494445f9ef880f69e727429c7c259301;hp=7b81c676532bf5782d6acb3ab1113834454715ab;hb=71c03dad71835226d820f790dbc53f5c538ec65c;hpb=6fa08daf440e496896babb230e404aae7e77a5bb diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index 7b81c67..9d6feac 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) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 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,6 +20,8 @@ // EXTERNAL INCLUDES #include +#include +#include #include #include #include @@ -34,23 +36,15 @@ namespace Dali { namespace Toolkit { - /** * @addtogroup dali_toolkit_controls * @{ */ class StyleManager; -class TransitionData; - -namespace Visual -{ -class Base; -} namespace Internal { - /** * @brief This is the internal base class for all controls. * @@ -59,10 +53,9 @@ namespace Internal * be disconnected automatically when the control is destroyed. * @SINCE_1_0.0 */ -class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface +class DALI_TOOLKIT_API Control : public CustomActorImpl, public ConnectionTrackerInterface { public: - class Extension; ///< Forward declare future extension interface // Creation & Destruction @@ -89,7 +82,7 @@ public: /** * @copydoc Dali::Toolkit::Control::SetStyleName */ - void SetStyleName( const std::string& styleName ); + void SetStyleName(const std::string& styleName); /** * @copydoc Dali::Toolkit::Control::GetStyleName @@ -101,17 +94,7 @@ public: /** * @copydoc Dali::Toolkit::Control::SetBackgroundColor */ - void SetBackgroundColor( const Vector4& color ); - - /** - * @copydoc Dali::Toolkit::Control::GetBackgroundColor - */ - Vector4 GetBackgroundColor() const; - - /** - * @copydoc Dali::Toolkit::Control::SetBackgroundImage - */ - void SetBackgroundImage( Image image ); + void SetBackgroundColor(const Vector4& color); /** * @brief Sets the background with a property map. @@ -122,6 +105,11 @@ public: void SetBackground(const Property::Map& map); /** + * @copydoc Dali::CustomActorImpl::RelayoutRequest() + */ + void RelayoutRequest(); + + /** * @copydoc Dali::Toolkit::Control::ClearBackground */ void ClearBackground(); @@ -133,12 +121,12 @@ public: * * 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)); + * EnableGestureDetection(GestureType::Value(GestureType::PINCH | GestureType::TAP | GestureType::PAN)); * @endcode * @SINCE_1_0.0 * @param[in] type The gesture type(s) to enable */ - void EnableGestureDetection( Gesture::Type type ); + void EnableGestureDetection(GestureType::Value type); /** * @brief Allows deriving classes to disable any of the gesture detectors. @@ -148,7 +136,7 @@ public: * @param[in] type The gesture type(s) to disable * @see EnableGetureDetection */ - void DisableGestureDetection( Gesture::Type type ); + void DisableGestureDetection(GestureType::Value type); /** * @brief If deriving classes wish to fine tune pinch gesture @@ -209,7 +197,7 @@ public: * @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. @@ -246,7 +234,7 @@ public: * @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. @@ -270,6 +258,7 @@ public: DALI_INTERNAL void KeyboardEnter(); /// @endcond + // Signals /** @@ -295,95 +284,10 @@ public: * @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); /// @endcond protected: // For derived classes to call - - /** - * @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. - * - * @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. - */ - void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual ); - - /** - * @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. - * - */ - void RegisterVisual( Property::Index index, Toolkit::Visual::Base& visual, bool enabled ); - - /** - * @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 Retrieve the visual associated with the given property index. - * - * @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. - */ - Toolkit::Visual::Base GetVisual( Property::Index index ) const; - - /** - * @brief Sets the given visual to be displayed or not when parent staged. - * - * @SINCE_1_2.11 - * - * @param[in] index The Property index of the visual - * @param[in] enable flag to set enabled or disabled. - */ - void EnableVisual( Property::Index index, bool enable ); - - /** - * @brief Queries if the given visual is to be displayed when parent staged. - * - * @SINCE_1_2.11 - * - * @param[in] index The Property index of the visual - * @return bool whether visual is enabled or not - */ - bool IsVisualEnabled( Property::Index index ) const; - - /** - * @brief Create a transition effect on the control. - * - * Only generates an animation if the properties described in the transition - * data are staged (e.g. the visual is Enabled and the control is on stage). - * Otherwise the target values are stored, and will get set onto the properties - * when the visual is next staged. - * - * @SINCE_1_2.12 - * - * @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. - */ - Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData ); - /** * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal. * @@ -392,119 +296,97 @@ protected: // For derived classes to call * @SINCE_1_0.0 * @param[in] focusGained True if gained, False if lost */ - void EmitKeyInputFocusSignal( bool focusGained ); - -protected: // From CustomActorImpl, not to be used by application developers + void EmitKeyInputFocusSignal(bool focusGained); +protected: // From CustomActorImpl /** - * @copydoc CustomActorImpl::OnStageConnection() - * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the end. + * @copydoc CustomActorImpl::OnSceneConnection() + * @note If overridden, then an up-call to Control::OnSceneConnection MUST be made at the end. */ - virtual void OnStageConnection( int depth ); + void OnSceneConnection(int depth) override; /** - * @copydoc CustomActorImpl::OnStageDisconnection() - * @note If overridden, then an up-call to Control::OnStageDisconnection MUST be made at the end. + * @copydoc CustomActorImpl::OnSceneDisconnection() + * @note If overridden, then an up-call to Control::OnSceneDisconnection MUST be made at the end. */ - virtual void OnStageDisconnection(); + void OnSceneDisconnection() override; /** * @copydoc CustomActorImpl::OnChildAdd() * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end. */ - virtual void OnChildAdd( Actor& child ); + void OnChildAdd(Actor& child) override; /** * @copydoc CustomActorImpl::OnChildRemove() * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end. */ - virtual void OnChildRemove( Actor& child ); + void OnChildRemove(Actor& child) override; /** * @copydoc CustomActorImpl::OnPropertySet() * @note If overridden, then an up-call to Control::OnChildRemove MUST be made at the end. */ - virtual void OnPropertySet( Property::Index index, Property::Value propertyValue ); + void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override; /** * @copydoc CustomActorImpl::OnSizeSet() * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end. */ - virtual void OnSizeSet( const Vector3& targetSize ); + void OnSizeSet(const Vector3& targetSize) override; /** * @copydoc CustomActorImpl::OnSizeAnimation() * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end. */ - 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::OnWheelEvent() - */ - virtual bool OnWheelEvent( const WheelEvent& event ); + void OnSizeAnimation(Animation& animation, const Vector3& targetSize) override; /** * @copydoc CustomActorImpl::OnRelayout() */ - virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ); + void OnRelayout(const Vector2& size, RelayoutContainer& container) override; /** * @copydoc CustomActorImpl::OnSetResizePolicy() */ - virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ); + void OnSetResizePolicy(ResizePolicy::Type policy, Dimension::Type dimension) override; /** * @copydoc CustomActorImpl::GetNaturalSize() */ - virtual Vector3 GetNaturalSize(); + Vector3 GetNaturalSize() override; /** * @copydoc CustomActorImpl::CalculateChildSize() */ - virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ); + float CalculateChildSize(const Dali::Actor& child, Dimension::Type dimension) override; /** * @copydoc CustomActorImpl::GetHeightForWidth() */ - virtual float GetHeightForWidth( float width ); + float GetHeightForWidth(float width) override; /** * @copydoc CustomActorImpl::GetWidthForHeight() */ - virtual float GetWidthForHeight( float height ); + float GetWidthForHeight(float height) override; /** * @copydoc CustomActorImpl::RelayoutDependentOnChildren() */ - virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); + bool RelayoutDependentOnChildren(Dimension::Type dimension = Dimension::ALL_DIMENSIONS) override; /** * @copydoc CustomActorImpl::OnCalculateRelayoutSize() */ - virtual void OnCalculateRelayoutSize( Dimension::Type dimension ); + void OnCalculateRelayoutSize(Dimension::Type dimension) override; /** * @copydoc CustomActorImpl::OnLayoutNegotiated() */ - virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ); + void OnLayoutNegotiated(float size, Dimension::Type dimension) override; protected: // Helpers for deriving classes - // Construction /** @@ -514,15 +396,14 @@ protected: // Helpers for deriving classes 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 + NOT_IN_USE_1 = 1 << (CustomActorImpl::ACTOR_FLAG_COUNT + 0), + 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 + static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log::value + 1; ///< Total count of flags /** * @brief Control constructor. @@ -530,7 +411,7 @@ protected: // Helpers for deriving classes * @SINCE_1_0.0 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum */ - Control( ControlBehaviour behaviourFlags ); + Control(ControlBehaviour behaviourFlags); /** * @brief Second phase initialization. @@ -539,7 +420,6 @@ protected: // Helpers for deriving classes void Initialize(); public: // API for derived classes to override - // Lifecycle /** @@ -550,30 +430,6 @@ public: // API for derived classes to override */ 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 ) DALI_DEPRECATED_API; - - /** - * @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 ) DALI_DEPRECATED_API; - // Styling /** @@ -583,7 +439,7 @@ public: // API for derived classes to override * @param[in] styleManager The StyleManager object * @param[in] change Information denoting what has changed */ - virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ); + virtual void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change); // Accessibility @@ -604,17 +460,7 @@ public: // API for derived classes to override * @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. - * - * @SINCE_1_0.0 - * @param[in] touchEvent The touch event - * @return true if the touch event has been consumed by this control - */ - virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent ); + virtual bool OnAccessibilityPan(PanGesture gesture); /** * @brief This method should be overridden by deriving classes when they wish to respond @@ -624,7 +470,7 @@ public: // API for derived classes to override * @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 ); + virtual bool OnAccessibilityValueChange(bool isIncrease); /** * @brief This method should be overridden by deriving classes when they wish to respond @@ -663,7 +509,7 @@ public: // API for derived classes to override * @param[in] loopEnabled Whether the focus movement should be looped within the control * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused */ - virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled ); + virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled); /** * @brief Informs this control that its chosen focusable actor will be focused. @@ -674,7 +520,7 @@ public: // API for derived classes to override * @SINCE_1_0.0 * @param[in] commitedFocusableActor The commited focusable actor */ - virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor ); + virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor); /** * @brief This method is called when the control has enter pressed on it. @@ -685,6 +531,15 @@ public: // API for derived classes to override */ virtual bool OnKeyboardEnter(); + /** + * @brief Called after a key-event is received by the actor that has had its focus set. + * + * @SINCE_1_0.0 + * @param[in] event The Key Event + * @return True if the event should be consumed + */ + virtual bool OnKeyEvent(const KeyEvent& event); + // Gestures /** @@ -700,7 +555,7 @@ public: // API for derived classes to override * @note Pinch detection should be enabled via EnableGestureDetection(). * @see EnableGestureDetection */ - virtual void OnPinch( const PinchGesture& pinch ); + virtual void OnPinch(const PinchGesture& pinch); /** * @brief Called whenever a pan gesture is detected on this control. @@ -714,7 +569,7 @@ public: // API for derived classes to override * @note Pan detection should be enabled via EnableGestureDetection(). * @see EnableGestureDetection */ - virtual void OnPan( const PanGesture& pan ); + virtual void OnPan(const PanGesture& pan); /** * @brief Called whenever a tap gesture is detected on this control. @@ -728,7 +583,7 @@ public: // API for derived classes to override * @note Tap detection should be enabled via EnableGestureDetection(). * @see EnableGestureDetection */ - virtual void OnTap( const TapGesture& tap ); + virtual void OnTap(const TapGesture& tap); /** * @brief Called whenever a long press gesture is detected on this control. @@ -742,19 +597,19 @@ public: // API for derived classes to override * @note Long press detection should be enabled via EnableGestureDetection(). * @see EnableGestureDetection */ - virtual void OnLongPress( const LongPressGesture& longPress ); + virtual void OnLongPress(const LongPressGesture& longPress); // From ConnectionTrackerInterface /** * @copydoc ConnectionTrackerInterface::SignalConnected */ - virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback ); + void SignalConnected(SlotObserver* slotObserver, CallbackBase* callback) override; /** * @copydoc ConnectionTrackerInterface::SignalDisconnected */ - virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ); + void SignalDisconnected(SlotObserver* slotObserver, CallbackBase* callback) override; /** * @brief Retrieves the extension for this control. @@ -767,20 +622,36 @@ public: // API for derived classes to override return NULL; } -private: + // Transition + + /** + * @brief Retrieve visual property animations. + * This Control is a destination. + * + * @param[in] animation generated animation + * @param[in] source source control of the animation. + * @param[in] alphaFunction AlphaFunction of the animation + * @param[in] timePeriod TimePeriod of the animation + */ + virtual void OnCreateTransitions(Dali::Animation& animation, Dali::Toolkit::Control source, AlphaFunction alphaFunction, TimePeriod timePeriod) + { + } +private: /// @cond internal - // Undefined - DALI_INTERNAL Control( const Control& ); - DALI_INTERNAL Control& operator=( const Control& ); + + // Not copyable or movable + DALI_INTERNAL Control(const Control&) = delete; ///< Deleted copy constructor. + DALI_INTERNAL Control(Control&&) = delete; ///< Deleted move constructor. + DALI_INTERNAL Control& operator=(const Control&) = delete; ///< Deleted copy assignment operator. + DALI_INTERNAL Control& operator=(Control&&) = delete; ///< Deleted move assignment operator. public: - class Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl + class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl private: Impl* mImpl; /// @endcond - }; /** @@ -791,7 +662,7 @@ private: * @return Implementation * @pre handle is initialized and points to a control */ -DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle ); +DALI_TOOLKIT_API Internal::Control& GetImplementation(Dali::Toolkit::Control& handle); /** * @brief Gets implementation from the handle. @@ -801,7 +672,7 @@ DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& ha * @return Implementation * @pre Handle is initialized and points to a control. */ -DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle ); +DALI_TOOLKIT_API const Internal::Control& GetImplementation(const Dali::Toolkit::Control& handle); } // namespace Internal