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) 2016 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 #include <dali/public-api/actors/actor-enumerations.h>
  25
  26 // INTERNAL INCLUDE
  27 #include <dali-toolkit/public-api/text/text-enumerations.h>
  28 #include <dali-toolkit/internal/text/line-run.h>
  29 #include <dali-toolkit/internal/text/metrics.h>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 namespace Text
  38 {
  39
  40 namespace Layout
  41 {
  42
  43 struct Parameters;
  44
  45 /**
  46  * @brief LayoutEngine is responsible for calculating the visual position of glyphs in layout.
  47  */
  48 class Engine
  49 {
  50 public:
  51
  52   enum Type
  53   {
  54     SINGLE_LINE_BOX,
  55     MULTI_LINE_BOX
  56   };
  57
  58   /**
  59    * @brief Create a new instance of a LayoutEngine.
  60    */
  61   Engine();
  62
  63   /**
  64    * @brief Virtual destructor.
  65    */
  66   ~Engine();
  67
  68   /**
  69    * @brief Provide the wrapper around FontClient used to get metrics
  70    *
  71    * @param[in] metrics Used to get metrics
  72    */
  73   void SetMetrics( MetricsPtr& metrics );
  74
  75   /**
  76    * @brief Choose the required layout.
  77    *
  78    * @param[in] layout The required layout.
  79    */
  80   void SetLayout( Type layout );
  81
  82   /**
  83    * @brief Query the required layout.
  84    *
  85    * @return The required layout.
  86    */
  87   Type GetLayout() const;
  88
  89   /**
  90    * @brief Sets the width of the cursor.
  91    *
  92    * @param[in] width The width of the cursor in pixels.
  93    */
  94   void SetCursorWidth( int width );
  95
  96   /**
  97    * @brief Retrieves the width of the cursor.
  98    *
  99    * @return The width of the cursor in pixels.
 100    */
 101   int GetCursorWidth() const;
 102
 103   /**
 104    * @brief Store the visual position of glyphs in the VisualModel.
 105    *
 106    * Builds the bidirectional info and reorders RTL lines.
 107    *
 108    * @param[in,out] layoutParameters The parameters needed to layout the text.
 109    * @param[out] layoutSize The size of the text after it has been laid-out.
 110    * @param[in] elideTextEnabled Whether the text elide is enabled.
 111    * @param[in,out] isAutoScrollEnabled If the isAutoScrollEnabled is true and the height of the text exceeds the boundaries of the control the text is elided and the isAutoScrollEnabled is set to false to disable the autoscroll
 112    *
 113    * @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.
 114    */
 115   bool LayoutText( Parameters& layoutParameters,
 116                    Size& layoutSize,
 117                    bool elideTextEnabled,
 118                    bool& isAutoScrollEnabled );
 119
 120   /**
 121    * @brief Aligns the laid out lines.
 122    *
 123    * @param[in] size The size of the container where the text is laid-out.
 124    * @param[in] startIndex Character index of the line from where the lines are aligned.
 125    * @param[in] numberOfCharacters The number of characters.
 126    * @param[in] horizontalAlignment The horizontal alignment.
 127    * @param[in,out] lines The laid-out lines.
 128    * @param[out] alignmentOffset The alignment offset.
 129    * @param[in] layoutDirection The direction of the system language.
 130    * @param[in] matchSystemLanguageDirection Whether match align for system language direction or not.
 131    */
 132   void Align( const Size& size,
 133               CharacterIndex startIndex,
 134               Length numberOfCharacters,
 135               Text::HorizontalAlignment::Type horizontalAlignment,
 136               Vector<LineRun>& lines,
 137               float& alignmentOffset,
 138               Dali::LayoutDirection::Type layoutDirection,
 139               bool matchSystemLanguageDirection );
 140
 141   /**
 142    * @brief Sets the default line spacing.
 143    *
 144    * @param[in] lineSpacing The line spacing.
 145    */
 146   void SetDefaultLineSpacing( float lineSpacing );
 147
 148   /**
 149    * @brief Retrieves the default line spacing.
 150    *
 151    * @return The line spacing.
 152    */
 153   float GetDefaultLineSpacing() const;
 154
 155 private:
 156
 157   // Undefined
 158   Engine( const Engine& handle );
 159
 160   // Undefined
 161   Engine& operator=( const Engine& handle );
 162
 163 private:
 164
 165   struct Impl;
 166   Impl* mImpl;
 167 };
 168
 169 } // namespace Layout
 170
 171 } // namespace Text
 172
 173 } // namespace Toolkit
 174
 175 } // namespace Dali
 176
 177 #endif // DALI_TOOLKIT_TEXT_LAYOUT_ENGINE_H