dali-toolkit/internal/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 // EXTERNAL INCLUDE
  22 #include <dali/public-api/common/dali-vector.h>
  23 #include <dali/public-api/math/vector2.h>
  24
  25 // INTERNAL INCLUDE
  26 #include <dali-toolkit/internal/text/line-run.h>
  27
  28 namespace Dali
  29 {
  30
  31 struct Vector2;
  32
  33 namespace Toolkit
  34 {
  35
  36 namespace Text
  37 {
  38
  39 struct LayoutParameters;
  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 Query the required layout.
  73    *
  74    * @return The required layout.
  75    */
  76   unsigned int GetLayout() const;
  77
  78   /**
  79    * @brief Store the visual position of glyphs in the VisualModel.
  80    *
  81    * @param[in] layoutParameters The parameters needed to layout the text.
  82    * @param[out] glyphPositions The positions of all the glyphs.
  83    * @param[out] lines The laid-out lines.
  84    * @param[out] actualSize The size of the text after it has been laid-out.
  85    *
  86    * @return \e true if the text has been re-laid-out. \e false means the given width is too small to layout even a single character.
  87    */
  88   bool LayoutText( const LayoutParameters& layoutParameters,
  89                    Vector<Vector2>& glyphPositions,
  90                    Vector<LineRun>& lines,
  91                    Size& actualSize );
  92
  93   /**
  94    * Re-lays out those lines with right to left characters.
  95    *
  96    * It doesn't change the phisical position of the glyphs in the model but sets their new position.
  97    *
  98    * @param[in] layoutParameters The parameters needed to layout the text.
  99    * @param[in,out] glyphPositions The positions of all the glyphs.
 100    */
 101   void ReLayoutRightToLeftLines( const LayoutParameters& layoutParameters,
 102                                  Vector<Vector2>& glyphPositions );
 103
 104 private:
 105
 106   // Undefined
 107   LayoutEngine( const LayoutEngine& handle );
 108
 109   // Undefined
 110   LayoutEngine& operator=( const LayoutEngine& handle );
 111
 112 private:
 113
 114   struct Impl;
 115   Impl* mImpl;
 116 };
 117 } // namespace Text
 118
 119 } // namespace Toolkit
 120
 121 } // namespace Dali
 122
 123 #endif // __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__