dali-toolkit/public-api/text/text-enumerations.h

   1 #ifndef DALI_TOOLKIT_TEXT_ENUMERATIONS_H
   2 #define DALI_TOOLKIT_TEXT_ENUMERATIONS_H
   3
   4 /*
   5  * Copyright (c) 2020 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 namespace Dali
  22 {
  23 namespace Toolkit
  24 {
  25 /**
  26  * @addtogroup dali_toolkit_controls_text_controls
  27  * @{
  28  */
  29
  30 namespace Text
  31 {
  32 /**
  33  * @brief The available Horizontal alignments for text.
  34  *
  35  * @SINCE_1_2.60
  36  */
  37 namespace HorizontalAlignment
  38 {
  39 /**
  40  * @brief Enumerations for Horizontal alignment.
  41  *
  42  * @SINCE_1_2.60
  43  */
  44 enum Type
  45 {
  46   BEGIN,  ///< @SINCE_1_2.60
  47   CENTER, ///< @SINCE_1_2.60
  48   END     ///< @SINCE_1_2.60
  49 };
  50
  51 } // namespace HorizontalAlignment
  52
  53 /**
  54  * @brief The available Vertical alignments for text.
  55  *
  56  * @SINCE_1_2.60
  57  */
  58 namespace VerticalAlignment
  59 {
  60 /**
  61  * @brief Enumerations for Vertical alignment.
  62  *
  63  * @SINCE_1_2.60
  64  */
  65 enum Type
  66 {
  67   TOP,    ///< @SINCE_1_2.60
  68   CENTER, ///< @SINCE_1_2.60
  69   BOTTOM  ///< @SINCE_1_2.60
  70 };
  71
  72 } // namespace VerticalAlignment
  73
  74 /**
  75  * @brief Contains modes which specify how lines are wrapped.
  76  *
  77  * If the layout width is too short to show the full text, then a wrapping mode can be specified.
  78  *
  79  * LineWrap::WORD mode will move an entire word to the next line:
  80  * @code
  81  * +---------+
  82  * |HELLO    |
  83  * |WORLD    |
  84  * +---------+
  85  * @endcode
  86  *
  87  * LineWrap::CHARACTER mode will move character by character to the next line:
  88  * @code
  89  * +---------+
  90  * |HELLO WOR|
  91  * |LD       |
  92  * +---------+
  93  * @endcode
  94  *
  95  * @SINCE_1_2.60
  96  */
  97 namespace LineWrap
  98 {
  99 /**
 100  * @brief Enumerations specifying how a line is wrapped.
 101  * @SINCE_1_2.60
 102  * @see LineWrap
 103  */
 104 enum Mode
 105 {
 106   WORD,     ///< @SINCE_1_2.60
 107   CHARACTER ///< @SINCE_1_2.60
 108 };
 109
 110 } // namespace LineWrap
 111
 112 } // namespace Text
 113
 114 /**
 115  * @}
 116  */
 117
 118 } // namespace Toolkit
 119
 120 } // namespace Dali
 121
 122 #endif //DALI_TOOLKIT_TEXT_ENUMERATIONS_H