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

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