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   enum HorizontalAlignment
  55   {
  56     HORIZONTAL_ALIGN_BEGIN,
  57     HORIZONTAL_ALIGN_CENTER,
  58     HORIZONTAL_ALIGN_END
  59   };
  60
  61   enum VerticalAlignment
  62   {
  63     VERTICAL_ALIGN_TOP,
  64     VERTICAL_ALIGN_CENTER,
  65     VERTICAL_ALIGN_BOTTOM
  66   };
  67
  68   /**
  69    * @brief Create a new instance of a LayoutEngine.
  70    */
  71   LayoutEngine();
  72
  73   /**
  74    * @brief Virtual destructor.
  75    */
  76   ~LayoutEngine();
  77
  78   /**
  79    * @brief Choose the required layout.
  80    *
  81    * @param[in] layout The required layout.
  82    */
  83   void SetLayout( Layout layout );
  84
  85   /**
  86    * @brief Query the required layout.
  87    *
  88    * @return The required layout.
  89    */
  90   unsigned int GetLayout() const;
  91
  92   /**
  93    * @brief Choose the required text horizontal alignment.
  94    *
  95    * @param[in] alignment The required alignment.
  96    */
  97   void SetHorizontalAlignment( HorizontalAlignment alignment );
  98
  99   /**
 100    * @brief Query the required text horizontal alignment.
 101    *
 102    * @return The required alignment.
 103    */
 104   HorizontalAlignment GetHorizontalAlignment() const;
 105
 106   /**
 107    * @brief Choose the required text vertical alignment.
 108    *
 109    * @param[in] alignment The required alignment.
 110    */
 111   void SetVerticalAlignment( VerticalAlignment alignment );
 112
 113   /**
 114    * @brief Query the required text vertical alignment.
 115    *
 116    * @return The required alignment.
 117    */
 118   VerticalAlignment GetVerticalAlignment() const;
 119
 120   /**
 121    * @brief Store the visual position of glyphs in the VisualModel.
 122    *
 123    * @param[in] layoutParameters The parameters needed to layout the text.
 124    * @param[out] glyphPositions The positions of all the glyphs.
 125    * @param[out] lines The laid-out lines.
 126    * @param[out] actualSize The size of the text after it has been laid-out.
 127    *
 128    * @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.
 129    */
 130   bool LayoutText( const LayoutParameters& layoutParameters,
 131                    Vector<Vector2>& glyphPositions,
 132                    Vector<LineRun>& lines,
 133                    Size& actualSize );
 134
 135   /**
 136    * @brief Re-lays out those lines with right to left characters.
 137    *
 138    * It doesn't change the phisical position of the glyphs in the model but sets their new position.
 139    *
 140    * @param[in] layoutParameters The parameters needed to layout the text.
 141    * @param[in,out] glyphPositions The positions of all the glyphs.
 142    */
 143   void ReLayoutRightToLeftLines( const LayoutParameters& layoutParameters,
 144                                  Vector<Vector2>& glyphPositions );
 145
 146   /**
 147    * @brief Aligns the laid out lines.
 148    *
 149    * @param[in] layoutParameters The parameters needed to layout the text.
 150    * @param[in] layoutSize The size of the laid out the text.
 151    * @param[in] lines The laid-out lines.
 152    * @param[in,out] glyphPositions The positions of all the glyphs.
 153    */
 154   void Align( const LayoutParameters& layoutParameters,
 155               const Size& layoutSize,
 156               const Vector<LineRun>& lines,
 157               Vector<Vector2>& glyphPositions );
 158
 159 private:
 160
 161   // Undefined
 162   LayoutEngine( const LayoutEngine& handle );
 163
 164   // Undefined
 165   LayoutEngine& operator=( const LayoutEngine& handle );
 166
 167 private:
 168
 169   struct Impl;
 170   Impl* mImpl;
 171 };
 172 } // namespace Text
 173
 174 } // namespace Toolkit
 175
 176 } // namespace Dali
 177
 178 #endif // __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__