base/dali-toolkit/public-api/text/rendering/text-renderer.h

   1 #ifndef __DALI_TOOLKIT_TEXT_RENDERER_H__
   2 #define __DALI_TOOLKIT_TEXT_RENDERER_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/actors/renderable-actor.h>
  23 #include <dali/public-api/common/intrusive-ptr.h>
  24 #include <dali/public-api/object/ref-object.h>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-toolkit/public-api/text/text-view-interface.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Text
  36 {
  37
  38 class Renderer;
  39 typedef IntrusivePtr<Renderer> RendererPtr;
  40
  41 /**
  42  * @brief Abstract base class for Text rendering back-ends.
  43  *
  44  * This is reponsible for rendering the glyphs from a ViewInterface in the specified positions.
  45  * It is implemented by returning a RenderableActor intended as the child of a UI control.
  46  */
  47 class Renderer : public RefObject
  48 {
  49 public:
  50
  51   /**
  52    * @brief Render the glyphs from a ViewInterface.
  53    *
  54    * @param[in] view The interface to a view.
  55    * @return The Renderable actor used to position the text.
  56    */
  57   virtual RenderableActor Render( ViewInterface& view ) = 0;
  58
  59 protected:
  60
  61   /**
  62    * @brief Constructor.
  63    */
  64   Renderer();
  65
  66   /**
  67    * @brief A reference counted object may only be deleted by calling Unreference().
  68    */
  69   virtual ~Renderer();
  70
  71 private:
  72
  73   // Undefined
  74   Renderer( const Renderer& handle );
  75
  76   // Undefined
  77   Renderer& operator=( const Renderer& handle );
  78 };
  79
  80 } // namespace Text
  81
  82 } // namespace Toolkit
  83
  84 } // namespace Dali
  85
  86 #endif // __DALI_TOOLKIT_TEXT_RENDERER_H__