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 Enable or disable the text ellipsis.
  94    *
  95    * @param[in] enabled Whether to enable the text ellipsis.
  96    */
  97   void SetTextEllipsisEnabled( bool enabled );
  98
  99   /**
 100    * @return Whether the text ellipsis is enabled.
 101    */
 102   bool GetTextEllipsisEnabled() const;
 103
 104   /**
 105    * @brief Choose the required text horizontal alignment.
 106    *
 107    * @param[in] alignment The required alignment.
 108    */
 109   void SetHorizontalAlignment( HorizontalAlignment alignment );
 110
 111   /**
 112    * @brief Query the required text horizontal alignment.
 113    *
 114    * @return The required alignment.
 115    */
 116   HorizontalAlignment GetHorizontalAlignment() const;
 117
 118   /**
 119    * @brief Choose the required text vertical alignment.
 120    *
 121    * @param[in] alignment The required alignment.
 122    */
 123   void SetVerticalAlignment( VerticalAlignment alignment );
 124
 125   /**
 126    * @brief Query the required text vertical alignment.
 127    *
 128    * @return The required alignment.
 129    */
 130   VerticalAlignment GetVerticalAlignment() const;
 131
 132   /**
 133    * @brief Store the visual position of glyphs in the VisualModel.
 134    *
 135    * @param[in] layoutParameters The parameters needed to layout the text.
 136    * @param[out] glyphPositions The positions of all the glyphs.
 137    * @param[out] lines The laid-out lines.
 138    * @param[out] actualSize The size of the text after it has been laid-out.
 139    *
 140    * @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.
 141    */
 142   bool LayoutText( const LayoutParameters& layoutParameters,
 143                    Vector<Vector2>& glyphPositions,
 144                    Vector<LineRun>& lines,
 145                    Size& actualSize );
 146
 147   /**
 148    * @brief Re-lays out those lines with right to left characters.
 149    *
 150    * It doesn't change the phisical position of the glyphs in the model but sets their new position.
 151    *
 152    * @param[in] layoutParameters The parameters needed to layout the text.
 153    * @param[in,out] glyphPositions The positions of all the glyphs.
 154    */
 155   void ReLayoutRightToLeftLines( const LayoutParameters& layoutParameters,
 156                                  Vector<Vector2>& glyphPositions );
 157
 158   /**
 159    * @brief Aligns the laid out lines.
 160    *
 161    * @param[in] layoutSize The size of the laid out the text.
 162    * @param[in,out] lines The laid-out lines.
 163    */
 164   void Align( const Size& layoutSize,
 165               Vector<LineRun>& lines );
 166
 167 private:
 168
 169   // Undefined
 170   LayoutEngine( const LayoutEngine& handle );
 171
 172   // Undefined
 173   LayoutEngine& operator=( const LayoutEngine& handle );
 174
 175 private:
 176
 177   struct Impl;
 178   Impl* mImpl;
 179 };
 180 } // namespace Text
 181
 182 } // namespace Toolkit
 183
 184 } // namespace Dali
 185
 186 #endif // __DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H__