dali-toolkit/public-api/text/layouts/layout-engine.h

   1 #ifndef __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__
   2 #define __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_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 // INTERNAL INCLUDE
  22 #include <dali-toolkit/public-api/text/text-definitions.h>
  23
  24 // EXTERNAL INCLUDE
  25 #include <dali/public-api/common/dali-vector.h>
  26
  27 namespace Dali
  28 {
  29
  30 struct Vector2;
  31
  32 namespace Toolkit
  33 {
  34
  35 namespace Text
  36 {
  37
  38 class LogicalModel;
  39 class VisualModel;
  40
  41 /**
  42  * @brief LayoutEngine is responsible for calculating the visual position of glyphs in layout.
  43  */
  44 class LayoutEngine
  45 {
  46 public:
  47
  48   enum Layout
  49   {
  50     SINGLE_LINE_BOX,
  51     MULTI_LINE_BOX
  52   };
  53
  54   /**
  55    * @brief Create a new instance of a LayoutEngine.
  56    */
  57   LayoutEngine();
  58
  59   /**
  60    * @brief Virtual destructor.
  61    */
  62   ~LayoutEngine();
  63
  64   /**
  65    * @brief Choose the required layout.
  66    *
  67    * @param[in] layout The required layout.
  68    */
  69   void SetLayout( Layout layout );
  70
  71   /**
  72    * @brief Store the visual position of glyphs in the VisualModel.
  73    *
  74    * @param[in] boundingBox The size of the box containing the text.
  75    * @param[in] glyphs A vector with glyphs.
  76    * @param[in] characterIndices Vector with indices pointing the first character of each glyph.
  77    * @param[in] charactersPerGlyph Vector with the number of characters that forms each glyph.
  78    * @param[in] visualModel The visual model to update.
  79    */
  80   void UpdateVisualModel( const Vector2& boundingBox,
  81                           const Vector<GlyphInfo>& glyphs,
  82                           const Vector<CharacterIndex>& characterIndices,
  83                           const Vector<Length>& charactersPerGlyph,
  84                           VisualModel& visualModel );
  85
  86 private:
  87
  88   // Undefined
  89   LayoutEngine( const LayoutEngine& handle );
  90
  91   // Undefined
  92   LayoutEngine& operator=( const LayoutEngine& handle );
  93
  94 private:
  95
  96   struct Impl;
  97   Impl* mImpl;
  98 };
  99 } // namespace Text
 100
 101 } // namespace Toolkit
 102
 103 } // namespace Dali
 104
 105 #endif // __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__