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=f1273174d75f670d223b9f5b577a0a055be5b709;hp=45eff9f61a4d3421b30f74e328e6b4b6ab6caa1a;hb=29540fc153880d6949c85786b78b8583ae8f1d37;hpb=867aa572372bf901975516db0fa77630754a8c27 diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index 45eff9f..f127317 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) 2020 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. @@ -41,12 +41,6 @@ namespace Toolkit */ class StyleManager; -class TransitionData; - -namespace Visual -{ -class Base; -} namespace Internal { @@ -59,7 +53,7 @@ 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: @@ -104,16 +98,6 @@ public: void SetBackgroundColor( const Vector4& color ); /** - * @copydoc Dali::Toolkit::Control::GetBackgroundColor - */ - Vector4 GetBackgroundColor() const; - - /** - * @copydoc Dali::Toolkit::Control::SetBackgroundImage - */ - void SetBackgroundImage( Image image ); - - /** * @brief Sets the background with a property map. * * @SINCE_1_0.0 @@ -301,90 +285,6 @@ public: 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. * * Should be called last by the control after it acts on the Input Focus change. @@ -394,114 +294,114 @@ protected: // For derived classes to call */ void EmitKeyInputFocusSignal( bool focusGained ); -protected: // From CustomActorImpl, not to be used by application developers +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 ); + virtual 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(); + virtual 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 ); + virtual 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 ); + virtual 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 ); + virtual void OnPropertySet( Property::Index index, 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 ); + virtual 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 ); + virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize ) override; /** * @copydoc CustomActorImpl::OnTouchEvent() */ - virtual bool OnTouchEvent( const TouchEvent& event ); + virtual bool OnTouchEvent( const TouchEvent& event ) override; /** * @copydoc CustomActorImpl::OnHoverEvent() */ - virtual bool OnHoverEvent( const HoverEvent& event ); + virtual bool OnHoverEvent( const HoverEvent& event ) override; /** * @copydoc CustomActorImpl::OnKeyEvent() */ - virtual bool OnKeyEvent( const KeyEvent& event ); + virtual bool OnKeyEvent( const KeyEvent& event ) override; /** * @copydoc CustomActorImpl::OnWheelEvent() */ - virtual bool OnWheelEvent( const WheelEvent& event ); + virtual bool OnWheelEvent( const WheelEvent& event ) override; /** * @copydoc CustomActorImpl::OnRelayout() */ - virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ); + virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) override; /** * @copydoc CustomActorImpl::OnSetResizePolicy() */ - virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ); + virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) override; /** * @copydoc CustomActorImpl::GetNaturalSize() */ - virtual Vector3 GetNaturalSize(); + virtual Vector3 GetNaturalSize() override; /** * @copydoc CustomActorImpl::CalculateChildSize() */ - virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ); + virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) override; /** * @copydoc CustomActorImpl::GetHeightForWidth() */ - virtual float GetHeightForWidth( float width ); + virtual float GetHeightForWidth( float width ) override; /** * @copydoc CustomActorImpl::GetWidthForHeight() */ - virtual float GetWidthForHeight( float height ); + virtual float GetWidthForHeight( float height ) override; /** * @copydoc CustomActorImpl::RelayoutDependentOnChildren() */ - virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ); + virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) override; /** * @copydoc CustomActorImpl::OnCalculateRelayoutSize() */ - virtual void OnCalculateRelayoutSize( Dimension::Type dimension ); + virtual void OnCalculateRelayoutSize( Dimension::Type dimension ) override; /** * @copydoc CustomActorImpl::OnLayoutNegotiated() */ - virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ); + virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) override; protected: // Helpers for deriving classes @@ -550,30 +450,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 /** @@ -774,7 +650,10 @@ private: DALI_INTERNAL Control( const Control& ); DALI_INTERNAL Control& operator=( const Control& ); - class Impl; +public: + class DALI_INTERNAL Impl; // Class declaration is public so we can internally add devel API's to the Controls Impl + +private: Impl* mImpl; /// @endcond @@ -788,7 +667,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. @@ -798,7 +677,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