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