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=d850eb4afccf7273a53b31a093a660463e76569e;hp=eb7d6a92fb0dd7bb28bd7ff47b3cc4b119284162;hb=cf58f2980b99438db9784a284e126d80893e6138;hpb=670cb07df58286ca6f155c1b8e1455af948aac84 diff --git a/dali-toolkit/public-api/controls/control-impl.h b/dali-toolkit/public-api/controls/control-impl.h index eb7d6a9..d850eb4 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) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 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,22 +32,25 @@ 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. * @@ -73,12 +76,14 @@ public: */ static Toolkit::Control New(); +protected: /** * @brief Virtual destructor. * @SINCE_1_0.0 */ virtual ~Control(); +public: // Styling /** @@ -303,78 +308,76 @@ protected: // For derived classes to call * @SINCE_1_2.0 * * @param[in] index The Property index of the visual, used to reference visual - * @param[in] placementActor The actor used to by the visual. * @param[in] visual The visual to register - * @note Derived class should not call visual.SetOnStage(placementActor). It is the responsibility of the base class to connect/disconnect registered visual to stage. + * @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, Actor& placementActor, 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] placementActor The actor used to by the 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, Actor& placementActor, 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 Retrieve the placement actor associated with the given index. - * - * @SINCE_1_2.2 - * - * @@param[in] index The Property index of the visual. - * @return Then placement actor if exist, otherwise empty handle. - * @note For managing object life-cycle, do not store the returned placement actor as a member which increments its reference count. - */ - Actor GetPlacementActor( Property::Index index ) const; + 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. + * + * @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 @@ -390,7 +393,7 @@ protected: // From CustomActorImpl, not to be used by application developers /** * @copydoc CustomActorImpl::OnStageConnection() - * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the start. + * @note If overridden, then an up-call to Control::OnStageConnection MUST be made at the end. */ virtual void OnStageConnection( int depth ); @@ -402,7 +405,7 @@ protected: // From CustomActorImpl, not to be used by application developers /** * @copydoc CustomActorImpl::OnChildAdd() - * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the start. + * @note If overridden, then an up-call to Control::OnChildAdd MUST be made at the end. */ virtual void OnChildAdd( Actor& child ); @@ -413,14 +416,20 @@ protected: // From CustomActorImpl, not to be used by application developers virtual void OnChildRemove( Actor& child ); /** + * @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 ); + + /** * @copydoc CustomActorImpl::OnSizeSet() - * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the start. + * @note If overridden, then an up-call to Control::OnSizeSet MUST be made at the end. */ virtual void OnSizeSet( const Vector3& targetSize ); /** * @copydoc CustomActorImpl::OnSizeAnimation() - * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the start. + * @note If overridden, then an up-call to Control::OnSizeAnimation MUST be made at the end. */ virtual void OnSizeAnimation( Animation& animation, const Vector3& targetSize ); @@ -546,7 +555,7 @@ public: // API for derived classes to override * @SINCE_1_0.0 * @param[in] child The added actor. */ - virtual void OnControlChildAdd( Actor& child ); + virtual void OnControlChildAdd( Actor& child ) DALI_DEPRECATED_API; /** * @DEPRECATED_1_1.30. Override OnChildRemove instead. @@ -558,7 +567,7 @@ public: // API for derived classes to override * @SINCE_1_0.0 * @param[in] child The removed actor. */ - virtual void OnControlChildRemove( Actor& child ); + virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API; // Styling