automated-tests/src/dali-toolkit-internal/dali-toolkit-test-utils/toolkit-text-model.h

   1 #ifndef __DALI_TOOLKIT_TEXT_MODEL_H__
   2 #define __DALI_TOOLKIT_TEXT_MODEL_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 INCLUDES
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-toolkit/internal/text/logical-model-impl.h>
  25 #include <dali-toolkit/internal/text/metrics.h>
  26 #include <dali-toolkit/internal/text/visual-model-impl.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 namespace Text
  35 {
  36
  37 /**
  38  * @brief Some layout options.
  39  */
  40 struct LayoutOptions
  41 {
  42   LayoutOptions()
  43   : reorder( true ),
  44     align( true )
  45   {}
  46
  47   bool reorder : 1; ///< Whether to reorder the bidirectional lines.
  48   bool align   : 1; ///< Whether to align the lines.
  49 };
  50
  51 /**
  52  * @brief Creates and fills all the vectors of a text model: characters in utf32, segmentation info,
  53  * scripts, fonts, bidi info, glyphs, conversion tables, etc.
  54  *
  55  * @param[in] text The given text.
  56  * @param[in] textArea The area where to layout the text.
  57  * @param[in] fontDescriptions The fonts to be used.
  58  * @param[in] options Layout options.
  59  * @param[out] layoutSize The laid-out size.
  60  * @param[out] logicalModel Pointer to a logical text model instance.
  61  * @param[out] visualModel Pointer to a visual text model instance.
  62  * @param[out] metrics Pointer to a wrapper around FontClient used to get metrics.
  63  */
  64 void CreateTextModel( const std::string& text,
  65                       const Size& textArea,
  66                       const Vector<FontDescriptionRun>& fontDescriptions,
  67                       const LayoutOptions& options,
  68                       Size& layoutSize,
  69                       LogicalModelPtr& logicalModel,
  70                       VisualModelPtr& visualModel,
  71                       MetricsPtr& metrics );
  72
  73 } // namespace Text
  74
  75 } // namespace Toolkit
  76
  77 } // namespace Dali
  78
  79 #endif // __DALI_TOOLKIT_TEXT_MODEL_H__