dali-toolkit/internal/text/rendering/text-renderer.h

   1 #ifndef DALI_TOOLKIT_TEXT_RENDERER_H
   2 #define DALI_TOOLKIT_TEXT_RENDERER_H
   3
   4 /*
   5  * Copyright (c) 2019 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/actor.h>
  23 #include <dali/public-api/common/intrusive-ptr.h>
  24 #include <dali/public-api/object/ref-object.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Toolkit
  30 {
  31
  32 namespace Text
  33 {
  34
  35 class Renderer;
  36 typedef IntrusivePtr<Renderer> RendererPtr;
  37
  38 class ViewInterface;
  39
  40 /**
  41  * @brief Abstract base class for Text renderers.
  42  *
  43  * This is reponsible for rendering the glyphs from a ViewInterface in the specified positions.
  44  * It is implemented by returning an Actor intended as the child of a UI control.
  45  */
  46 class Renderer : public RefObject
  47 {
  48 public:
  49
  50   /**
  51    * @brief Render the glyphs from a ViewInterface.
  52    *
  53    * @param[in] view The interface to a view.
  54    * @param[in] textControl handle to the text control
  55    * @param[in] animatablePropertyIndex textControl specific animatable property
  56    * @param[out] alignmentOffset Offset used to internally align the placement actor.
  57    * @param[in] depth The depth in the tree of the parent.
  58    * @return The Renderable actor used to position the text.
  59    */
  60   virtual Actor Render( ViewInterface& view,
  61                         Actor textContol,
  62                         Property::Index animatablePropertyIndex,
  63                         float& alignmentOffset,
  64                         int depth ) = 0;
  65
  66 protected:
  67
  68   /**
  69    * @brief Constructor.
  70    */
  71   Renderer();
  72
  73   /**
  74    * @brief A reference counted object may only be deleted by calling Unreference().
  75    */
  76   virtual ~Renderer();
  77
  78 private:
  79
  80   // Undefined
  81   Renderer( const Renderer& handle );
  82
  83   // Undefined
  84   Renderer& operator=( const Renderer& handle );
  85 };
  86
  87 } // namespace Text
  88
  89 } // namespace Toolkit
  90
  91 } // namespace Dali
  92
  93 #endif // DALI_TOOLKIT_TEXT_RENDERER_H