X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fvisuals%2Fvisual-base-impl.h;h=ecf832cbda7c08bf6ac76f782f315371a002d5f9;hp=c450d913aa80b6fcee13b1222588a49c1d56d8cd;hb=0e6daac62ce7e42b15c22642a6c4b4f7f6e120d6;hpb=c5e1d2bfc9502a23cf781773d36d4aeffbc58a7b diff --git a/dali-toolkit/internal/visuals/visual-base-impl.h b/dali-toolkit/internal/visuals/visual-base-impl.h index c450d91..ecf832c 100644 --- a/dali-toolkit/internal/visuals/visual-base-impl.h +++ b/dali-toolkit/internal/visuals/visual-base-impl.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_INTERNAL_VISUAL_H /* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 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,6 +32,8 @@ #include #include #include +#include +#include namespace Dali { @@ -45,7 +47,9 @@ namespace Internal namespace Visual { -class ResourceObserver; +class EventObserver; + +using FittingMode = DevelVisual::FittingMode; /** * Base class for all Control rendering logic. A control may have multiple visuals. @@ -85,7 +89,7 @@ public: /** * @copydoc Toolkit::Visual::Base::GetName */ - const std::string& GetName(); + const std::string& GetName() const; /** * @copydoc Toolkit::Visual::Base::SetSize @@ -93,6 +97,14 @@ public: void SetTransformAndSize( const Property::Map& transform, Size controlSize ); /** + * @brief Performs an action on the visual with the given action name and attributes. + * + * @param[in] actionName The name of the action to perform this API only takes an Index + * @param[in] attributes The list of attributes for the action. ( optional for this data structure to have content ) + */ + void DoAction( const Dali::Property::Index actionName, const Dali::Property::Value attributes ); + + /** * @copydoc Toolkit::Visual::Base::GetHeightForWidth */ virtual float GetHeightForWidth( float width ); @@ -205,6 +217,9 @@ public: * If the visual isn't staged (i.e. it doesn't have a renderer), * then this will not add an animation. * + * If the animator is valid and the transition handle is empty - it will + * be created. + * * @param[in] transition The animation to create or attach to * @param[in] animator The animation parameters of the property. */ @@ -212,36 +227,53 @@ public: Internal::TransitionData::Animator& animator ); /** - * @brief Add an observer to watch for when the Visuals resources are loaded. + * @brief Add an observer to watch for when the Visuals have events to notify * Currently only supports a single observer - * */ - void AddResourceObserver( Visual::ResourceObserver& observer ); + void AddEventObserver( Visual::EventObserver& observer ); /** * @brief Remove an observer */ - void RemoveResourceObserver( Visual::ResourceObserver& observer ); + void RemoveEventObserver( Visual::EventObserver& observer ); /** * @brief Called when the visuals resources are loaded / ready */ - void ResourceReady(); + void ResourceReady( Toolkit::Visual::ResourceStatus resourceStatus ); /** * @brief Called when the visuals resources are loaded / ready * @return true if ready, false otherwise */ - bool IsResourceReady() const; + virtual bool IsResourceReady() const; -protected: + /** + * @brief Get the loading state of the visual resource + * @return Return the loading status (PREPARING, READY and FAILED) of visual resource + */ + Toolkit::Visual::ResourceStatus GetResourceStatus() const; + + /** + * @brief Get the fitting mode for the visual + */ + FittingMode GetFittingMode() const; + + /** + * @brief Get the actual Visual Object. + * @return The actual visual object + * @note Should be overridden by deriving controls if they are acting as a proxy to other visual objects. + */ + virtual Base& GetVisualObject(); + + protected: /** * @brief Constructor. * * @param[in] factoryCache A pointer pointing to the VisualFactoryCache object */ - Base( VisualFactoryCache& factoryCache ); + Base( VisualFactoryCache& factoryCache, FittingMode fittingMode ); /** * @brief A reference counted object may only be deleted by calling Unreference(). @@ -286,7 +318,7 @@ protected: * * @param[in] actor The actor applying this visual. */ - virtual void DoSetOnStage( Actor& actor )=0; + virtual void DoSetOnStage( Actor& actor ) = 0; /** * @brief Called by SetOffStage() allowing sub classes to respond to the SetOffStage event @@ -295,6 +327,14 @@ protected: */ virtual void DoSetOffStage( Actor& actor ); + /** + * @brief Called by DoAction() allowing sub classes to do the given action. + * + * @param[in] actionId The action to perform + * @param[in] attributes The list of attributes for the action. ( optional for this data structure to have content ) + */ + virtual void OnDoAction( const Property::Index actionId, const Property::Value& attributes ); + protected: /** @@ -304,6 +344,13 @@ protected: */ bool IsOnStage() const; + /** + * @brief Query whether the corners of the visual requires to be rounded. + * + * @return Returns true if the rounded corner is required, false otherwise. + */ + bool IsRoundedCornerRequired() const; + private: /**