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