Rename of Control Renderers to Visuals

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / visual-factory / visual-factory.h

diff --git a/dali-toolkit/devel-api/controls/renderer-factory/renderer-factory.h b/dali-toolkit/devel-api/controls/visual-factory/visual-factory.h
similarity index 74%
rename from dali-toolkit/devel-api/controls/renderer-factory/renderer-factory.h
rename to dali-toolkit/devel-api/controls/visual-factory/visual-factory.h
index 52e0d5c..d6678b9 100644 (file)
--- a/dali-toolkit/devel-api/controls/renderer-factory/renderer-factory.h
+++ b/dali-toolkit/devel-api/controls/visual-factory/visual-factory.h
@@ -22,8 +22,8 @@
 #include <dali/public-api/images/image-operations.h>
 #include <dali/public-api/object/property-map.h>
 
-// INTERNAK INCLUDES
-#include <dali-toolkit/devel-api/controls/renderer-factory/control-renderer.h>
+// INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/controls/visual-factory/visual.h>
 
 namespace Dali
 {
@@ -35,11 +35,11 @@ namespace Toolkit
 
 namespace Internal DALI_INTERNAL
 {
-class RendererFactory;
+class VisualFactory;
 }
 
 /**
- * @brief RendererFactory is a singleton object that provides and shares renderers for controls
+ * @brief VisualFactory is a singleton object that provides and shares renderers for controls
  *
  * By setting environment variable 'DALI_DEBUG_RENDERING', all concrete renderer is replaced with the debug renderer which renders a quad wireframe.
  *
@@ -49,37 +49,37 @@ class RendererFactory;
  * |--------------------------|------------------|
  * | rendererType             | STRING           |
  */
-class DALI_IMPORT_API RendererFactory : public BaseHandle
+class DALI_IMPORT_API VisualFactory : public BaseHandle
 {
 public:
 
   /**
-   * @brief Create or retrieve RendererFactory singleton.
+   * @brief Create or retrieve VisualFactory singleton.
    *
-   * @return A handle to the RendererFactory control.
+   * @return A handle to the VisualFactory control.
    */
-  static RendererFactory Get();
+  static VisualFactory Get();
 
   /**
-   * @brief Create a RendererFactory handle.
+   * @brief Create a VisualFactory handle.
    *
    * Calling member functions with an uninitialised handle is not allowed.
    */
-  RendererFactory();
+  VisualFactory();
 
   /**
    * @brief Destructor
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
    */
-  ~RendererFactory();
+  ~VisualFactory();
 
   /**
    * @brief This copy constructor is required for (smart) pointer semantics.
    *
    * @param[in] handle A reference to the copied handle.
    */
-  RendererFactory( const RendererFactory& handle );
+  VisualFactory( const VisualFactory& handle );
 
   /**
    * @brief This assignment operator is required for (smart) pointer semantics.
@@ -87,7 +87,7 @@ public:
    * @param [in] handle  A reference to the copied handle.
    * @return A reference to this.
    */
-  RendererFactory& operator=( const RendererFactory& handle );
+  VisualFactory& operator=( const VisualFactory& handle );
 
   /**
    * @brief Request the control renderer
@@ -96,7 +96,7 @@ public:
    *            Depends on the content of the map, different kind of renderer would be returned.
    * @return The pointer pointing to control renderer
    */
-  ControlRenderer CreateControlRenderer( const Property::Map& propertyMap  );
+  Visual CreateVisual( const Property::Map& propertyMap  );
 
   /**
    * @brief Request the control renderer to render the image.
@@ -104,7 +104,7 @@ public:
    * @param[in] image The image to be rendered.
    * @return The pointer pointing to the control renderer
    */
-  ControlRenderer CreateControlRenderer( const Image& image );
+  Visual CreateVisual( const Image& image );
 
   /**
    * @brief Request the control renderer to render the given resource at the url.
@@ -113,11 +113,11 @@ public:
    * @param[in] size The width and height to fit the loaded image to.
    * @return The pointer pointing to the control renderer
    */
-  ControlRenderer CreateControlRenderer( const std::string& url, ImageDimensions size );
+  Visual CreateVisual( const std::string& url, ImageDimensions size );
 
 private:
 
-  explicit DALI_INTERNAL RendererFactory(Internal::RendererFactory *impl);
+  explicit DALI_INTERNAL VisualFactory(Internal::VisualFactory *impl);
 
 };
 
@@ -125,8 +125,8 @@ private:
 /**
  * @brief Template to allow discard old renderer, get new one and set it on stage if possible
  *
- * @tparam ParameterType0 The type of first argument passed to the CreateControlRenderer()
- * @tparam ParameterType1 The type of second argument passed to the CreateControlRenderer()
+ * @tparam ParameterType0 The type of first argument passed to the CreateVisual()
+ * @tparam ParameterType1 The type of second argument passed to the CreateVisual()
  * @SINCE_1_0.39
  * @param[in] actor Actor for which the renderer will be replaced
  * @param[in,out] renderer The renderer object to be replaced
@@ -134,10 +134,10 @@ private:
  * @param[in] param1 Second template based argument passed to the renderer factory
  */
 template< class ParameterType0, class ParameterType1 >
-void InitializeControlRenderer( Actor& actor, ControlRenderer& renderer, ParameterType0& param0, ParameterType1& param1 )
+void InitializeVisual( Actor& actor, Visual& renderer, ParameterType0& param0, ParameterType1& param1 )
 {
   renderer.RemoveAndReset( actor );
-  renderer = Toolkit::RendererFactory::Get().CreateControlRenderer( param0, param1 );
+  renderer = Toolkit::VisualFactory::Get().CreateVisual( param0, param1 );
   if( renderer && actor && actor.OnStage() )
   {
     renderer.SetOnStage( actor );
@@ -147,17 +147,17 @@ void InitializeControlRenderer( Actor& actor, ControlRenderer& renderer, Paramet
 /**
  * @brief Template to allow discard old renderer, get new one and set it on stage if possible
  *
- * @tparam ParameterType The type of argument passed to the CreateControlRenderer()
+ * @tparam ParameterType The type of argument passed to the CreateVisual()
  * @SINCE_1_0.39
  * @param[in] actor Actor for which the renderer will be replaced
  * @param[in,out] renderer The renderer object to be replaced
  * @param[in] param Template based argument passed to the renderer factory
  */
 template< class ParameterType >
-void InitializeControlRenderer( Actor& actor, ControlRenderer& renderer, ParameterType& param )
+void InitializeVisual( Actor& actor, Visual& renderer, ParameterType& param )
 {
   renderer.RemoveAndReset( actor );
-  renderer =  Toolkit::RendererFactory::Get().CreateControlRenderer( param );
+  renderer =  Toolkit::VisualFactory::Get().CreateVisual( param );
   if( renderer && actor && actor.OnStage() )
   {
     renderer.SetOnStage( actor );