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 VisualModel;
  39
  40 /**
  41  * @brief LayoutEngine is responsible for calculating the visual position of glyphs in layout.
  42  */
  43 class LayoutEngine
  44 {
  45 public:
  46
  47   enum Layout
  48   {
  49     SINGLE_LINE_BOX,
  50     MULTI_LINE_BOX
  51   };
  52
  53   /**
  54    * @brief Create a new instance of a LayoutEngine.
  55    */
  56   LayoutEngine();
  57
  58   /**
  59    * @brief Virtual destructor.
  60    */
  61   ~LayoutEngine();
  62
  63   /**
  64    * @brief Choose the required layout.
  65    *
  66    * @param[in] layout The required layout.
  67    */
  68   void SetLayout( Layout layout );
  69
  70   /**
  71    * @brief Query the required layout.
  72    *
  73    * @return The required layout.
  74    */
  75   unsigned int GetLayout() const;
  76
  77   /**
  78    * @brief Store the visual position of glyphs in the VisualModel.
  79    *
  80    * @param[in] boundingBox The size of the box containing the text.
  81    * @param[in] glyphs A vector with glyphs.
  82    * @param[in] characterIndices Vector with indices pointing the first character of each glyph.
  83    * @param[in] charactersPerGlyph Vector with the number of characters that forms each glyph.
  84    * @param[in] visualModel The visual model to update.
  85    */
  86   void UpdateVisualModel( const Vector2& boundingBox,
  87                           const Vector<GlyphInfo>& glyphs,
  88                           const Vector<CharacterIndex>& characterIndices,
  89                           const Vector<Length>& charactersPerGlyph,
  90                           VisualModel& visualModel );
  91
  92 private:
  93
  94   // Undefined
  95   LayoutEngine( const LayoutEngine& handle );
  96
  97   // Undefined
  98   LayoutEngine& operator=( const LayoutEngine& handle );
  99
 100 private:
 101
 102   struct Impl;
 103   Impl* mImpl;
 104 };
 105 } // namespace Text
 106
 107 } // namespace Toolkit
 108
 109 } // namespace Dali
 110
 111 #endif // __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__