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