X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=base%2Fdali-toolkit%2Fpublic-api%2Fbuilder%2Fbuilder.h;h=98d3d8c8213f7e8b916f31cbfb2cc4855187faad;hp=b0db57e7ab21bef26cf020a2d225399c4f06e666;hb=87b3b1f9a40c85ab6120d77bc6c0d356ae45faf3;hpb=cb7bf8e43ac9cb3bb71ed6dcb2a82f44c1bfb294 diff --git a/base/dali-toolkit/public-api/builder/builder.h b/base/dali-toolkit/public-api/builder/builder.h index b0db57e..98d3d8c 100644 --- a/base/dali-toolkit/public-api/builder/builder.h +++ b/base/dali-toolkit/public-api/builder/builder.h @@ -18,10 +18,13 @@ * */ -// INTERNAL INCLUDES -#include +// EXTERNAL INCLUDES +#include +#include +#include +#include -namespace Dali DALI_IMPORT_API +namespace Dali { namespace Toolkit @@ -32,8 +35,6 @@ namespace Internal DALI_INTERNAL class Builder; } -typedef std::map PropertyValueMap; - /** * This class provides the ability to load and style an actor tree from a string representation. * @@ -116,7 +117,7 @@ typedef std::map PropertyValueMap; * */ -class Builder : public BaseHandle +class DALI_IMPORT_API Builder : public BaseHandle { public: /** @@ -161,14 +162,14 @@ class Builder : public BaseHandle * @brief Adds user defined constants to all future style template or animation expansions * * e.g. - * PropertyValueMap map; + * Property::Map map; * map["IMAGE_DIRECTORY"] = "/usr/share/images"; * builder.AddConstants( map ); * * @pre The Builder has been initialized. * @param map The user defined constants used in template expansions. */ - void AddConstants( const PropertyValueMap& map ); + void AddConstants( const Property::Map& map ); /** * @brief Adds or modifies a user defined constant to all future style template or animation expansions @@ -189,7 +190,7 @@ class Builder : public BaseHandle * * e.g. * @code - * PropertyValueMap map = builder.GetConstants(); // get copy of current constants + * Property::Map map = builder.GetConstants(); // get copy of current constants * map["IMAGE_DIRECTORY"] = "/usr/share/images"; // make modification * builder.AddConstants( map ); // write back changes * @endcode @@ -197,14 +198,14 @@ class Builder : public BaseHandle * @pre The Builder has been initialized. * @return A reference to the currently defined constants. */ - const PropertyValueMap& GetConstants() const; + const Property::Map& GetConstants() const; /** * @brief Gets a currently defined constant, or returns Property::INVALID * * e.g. * @code - * PropertyValueMap map = builder.GetConstants(); // get copy of current constants + * Property::Map map = builder.GetConstants(); // get copy of current constants * map["IMAGE_DIRECTORY"] = "/usr/share/images"; // make modification * builder.AddConstants( map ); // write back changes * @endcode @@ -231,7 +232,7 @@ class Builder : public BaseHandle * @brief Creates an animation from the set of known animations with user defined constants * * e.g. - * PropertyValueMap map; + * Property::Map map; * map["ACTOR"] = actor.GetName(); // replaces '{ACTOR} in the template * Animation a = builder.CreateAnimation( "wobble"); * @@ -243,7 +244,7 @@ class Builder : public BaseHandle * @param map The user defined constants used in style template expansion. * @returns The base handle of the created object */ - Animation CreateAnimation( const std::string& animationName, const PropertyValueMap& map ); + Animation CreateAnimation( const std::string& animationName, const Property::Map& map ); /** * @brief Creates an animation from the set of known animations. @@ -267,7 +268,7 @@ class Builder : public BaseHandle * * The animation is applied to a specific actor. * e.g. - * PropertyValueMap map; + * Property::Map map; * map["ACTOR"] = actor.GetName(); // replaces '{ACTOR} in the template * Actor myInstance = builder.Create( "template-actor-tree" ) * Animation a = builder.CreateAnimation( "wobble", myInstance); @@ -281,7 +282,7 @@ class Builder : public BaseHandle * @param sourceActor The starting point in an actor tree, from which to look for property owners * @returns The base handle of the created object */ - Animation CreateAnimation( const std::string& animationName, const PropertyValueMap& map, Dali::Actor sourceActor ); + Animation CreateAnimation( const std::string& animationName, const Property::Map& map, Dali::Actor sourceActor ); /** * @brief Creates an object (e.g. an actor) from the set of known style templates @@ -302,7 +303,7 @@ class Builder : public BaseHandle * @brief Creates an object from the style templates with user defined constants * * e.g. - * PropertyValueMap map; + * Property::Map map; * map["IMAGE_DIR"] = "/usr/share/images"; // replaces '{IMAGE_DIR} in the template * mActor.Add( Actor::DownCast(builder.Create( "default-image", map) ) ); * @@ -314,7 +315,7 @@ class Builder : public BaseHandle * @param map The user defined constants used in template expansion. * @returns The base handle of the created object */ - BaseHandle Create( const std::string& templateName, const PropertyValueMap& map ); + BaseHandle Create( const std::string& templateName, const Property::Map& map ); /** * @brief Creates an object (e.g. an actor) from given json snippet @@ -398,6 +399,15 @@ class Builder : public BaseHandle */ FrameBufferImage GetFrameBufferImage( const std::string &name ); + /** + * Get or create Path from the Path instance library. + * An empty handle is returned otherwise. + * @pre The Builder has been initialized. + * @param name The name of a Path in the loaded representation + * @return A handle to a Path if found, otherwise empty + */ + Path GetPath( const std::string &name ); + // Signals /** @@ -411,7 +421,7 @@ class Builder : public BaseHandle Signal& QuitSignal(); private: - Builder(Internal::Builder *impl); + explicit DALI_INTERNAL Builder(Internal::Builder *impl); }; // class Builder