dali-toolkit/internal/text/layouts/layout-parameters.h

   1 #ifndef DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H
   2 #define DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H
   3
   4 /*
   5  * Copyright (c) 2017 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 INCLUDES
  22 #include <dali/public-api/math/vector2.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/text/text-enumerations.h>
  26 #include <dali-toolkit/internal/text/text-definitions.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 namespace Text
  35 {
  36
  37 struct BidirectionalLineInfoRun;
  38
  39 namespace Layout
  40 {
  41
  42 /**
  43  * @brief Struct used to pass parameters.
  44  */
  45 struct Parameters
  46 {
  47   /**
  48    * Constructor with the needed parameters to layout the text.
  49    *
  50    * @param[in] boundingBox The size of the box containing the text.
  51    * @param[in] textBuffer The text buffer.
  52    * @param[in] lineBreakInfoBuffer The line break info.
  53    * @param[in] wordBreakInfoBuffer The word break info.
  54    * @param[in] characterDirectionBuffer Vector with the direction of each character.
  55    * @param[in] glyphsBuffer Vector with glyphs.
  56    * @param[in] glyphsToCharactersBuffer Vector with indices pointing the first character of each glyph.
  57    * @param[in] charactersPerGlyphBuffer Vector with the number of characters that forms each glyph.
  58    * @param[in] charactersToGlyphsBuffer Vector with indices pointing the first glyph of each character.
  59    * @param[in] glyphsPerCharacterBuffer Vector with the number of glyphs shaped from the character.
  60    * @param[in] totalNumberOfGlyphs The number of glyphs.
  61    * @param[in] horizontalAlignment The horizontal alignment.
  62    * @param[in] lineWrapMode The text wrap mode.
  63    */
  64   Parameters( const Vector2& boundingBox,
  65               const Character* const textBuffer,
  66               const LineBreakInfo* const lineBreakInfoBuffer,
  67               const WordBreakInfo* const wordBreakInfoBuffer,
  68               const CharacterDirection* const characterDirectionBuffer,
  69               const GlyphInfo* const glyphsBuffer,
  70               const CharacterIndex* const glyphsToCharactersBuffer,
  71               const Length* const charactersPerGlyphBuffer,
  72               const GlyphIndex* const charactersToGlyphsBuffer,
  73               const Length* const glyphsPerCharacterBuffer,
  74               Length totalNumberOfGlyphs,
  75               Text::HorizontalAlignment::Type horizontalAlignment,
  76               Text::LineWrap::Mode lineWrapMode,
  77               float outlineWidth,
  78               bool ignoreSpaceAfterText )
  79   : boundingBox( boundingBox ),
  80     textBuffer( textBuffer ),
  81     lineBreakInfoBuffer( lineBreakInfoBuffer ),
  82     wordBreakInfoBuffer( wordBreakInfoBuffer ),
  83     characterDirectionBuffer( characterDirectionBuffer ),
  84     glyphsBuffer( glyphsBuffer ),
  85     glyphsToCharactersBuffer( glyphsToCharactersBuffer ),
  86     charactersPerGlyphBuffer( charactersPerGlyphBuffer ),
  87     charactersToGlyphsBuffer( charactersToGlyphsBuffer ),
  88     glyphsPerCharacterBuffer( glyphsPerCharacterBuffer ),
  89     lineBidirectionalInfoRunsBuffer( NULL ),
  90     numberOfBidirectionalInfoRuns( 0u ),
  91     startGlyphIndex( 0u ),
  92     numberOfGlyphs( 0u ),
  93     totalNumberOfGlyphs( totalNumberOfGlyphs ),
  94     horizontalAlignment( horizontalAlignment ),
  95     startLineIndex( 0u ),
  96     estimatedNumberOfLines( 0u ),
  97     lineWrapMode( lineWrapMode ),
  98     outlineWidth( outlineWidth ),
  99     isLastNewParagraph( false ),
 100     ignoreSpaceAfterText( ignoreSpaceAfterText )
 101   {}
 102
 103   Vector2                         boundingBox;                     ///< The size of the box containing the text.
 104   const Character* const          textBuffer;                      ///< The text buffer.
 105   const LineBreakInfo* const      lineBreakInfoBuffer;             ///< The line break info.
 106   const WordBreakInfo* const      wordBreakInfoBuffer;             ///< The word break info.
 107   const CharacterDirection* const characterDirectionBuffer;        ///< Vector with the direction of each character.
 108   const GlyphInfo* const          glyphsBuffer;                    ///< Vector with glyphs.
 109   const CharacterIndex* const     glyphsToCharactersBuffer;        ///< Vector with indices pointing the first character of each glyph.
 110   const Length* const             charactersPerGlyphBuffer;        ///< Vector with the number of characters that forms each glyph.
 111   const GlyphIndex* const         charactersToGlyphsBuffer;        ///< Vector with indices pointing the first glyph of each character.
 112   const Length* const             glyphsPerCharacterBuffer;        ///< Vector with the number of glyphs shaped from the character.
 113   BidirectionalLineInfoRun*       lineBidirectionalInfoRunsBuffer; ///< Bidirectional conversion tables per line.
 114   Length                          numberOfBidirectionalInfoRuns;   ///< The number of lines with bidirectional info.
 115   GlyphIndex                      startGlyphIndex;                 ///< Index to the first glyph to layout.
 116   Length                          numberOfGlyphs;                  ///< The number of glyphs to layout.
 117   Length                          totalNumberOfGlyphs;             ///< The number of glyphs.
 118   HorizontalAlignment::Type       horizontalAlignment;             ///< The horizontal alignment.
 119   LineIndex                       startLineIndex;                  ///< The line index where to insert the new lines.
 120   Length                          estimatedNumberOfLines;          ///< The estimated number of lines.
 121   Text::LineWrap::Mode            lineWrapMode;                    ///< The line wrap mode for moving to next line.
 122   float                           outlineWidth;                    ///< The outline width.
 123   bool                            isLastNewParagraph:1;            ///< Whether the last character is a new paragraph character.
 124   bool                            ignoreSpaceAfterText:1;          ///< Whether ignoring spaces after text or not. Default is true.
 125 };
 126
 127 } // namespace Layout
 128
 129 } // namespace Text
 130
 131 } // namespace Toolkit
 132
 133 } // namespace Dali
 134
 135 #endif // DALI_TOOLKIT_TEXT_LAYOUT_PARAMETERS_H