[dali_2.3.20] Merge branch 'devel/master'

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / text / text-enumerations.h

diff --git a/dali-toolkit/public-api/text/text-enumerations.h b/dali-toolkit/public-api/text/text-enumerations.h
index 9d9dff2..e5b7fbe 100644 (file)
--- a/dali-toolkit/public-api/text/text-enumerations.h
+++ b/dali-toolkit/public-api/text/text-enumerations.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_TEXT_ENUMERATIONS_H
 
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,64 +20,121 @@
 
 namespace Dali
 {
-
 namespace Toolkit
 {
-
 /**
- * @addtogroup dali_toolkit_controls
+ * @addtogroup dali_toolkit_controls_text_controls
  * @{
  */
 
 namespace Text
 {
-
 /**
- * @brief The available Horizontal alignments for text
+ * @brief The available Horizontal alignments for text.
+ *
  * @SINCE_1_2.60
  */
 namespace HorizontalAlignment
 {
-  /**
-   * @brief Enumerations for Horizontal alignment
-   *
-   * @SINCE_1_2.60
-   */
-  enum Type
-  {
-    BEGIN,   ///< @SINCE_1_2.60
-    CENTER,  ///< @SINCE_1_2.60
-    END      ///< @SINCE_1_2.60
-  };
-}
+/**
+ * @brief Enumerations for Horizontal alignment.
+ *
+ * @SINCE_1_2.60
+ */
+enum Type
+{
+  BEGIN,  ///< @SINCE_1_2.60
+  CENTER, ///< @SINCE_1_2.60
+  END     ///< @SINCE_1_2.60
+};
+
+} // namespace HorizontalAlignment
 
 /**
- * @brief The available Vertical alignments for text
+ * @brief The available Vertical alignments for text.
+ *
  * @SINCE_1_2.60
  */
 namespace VerticalAlignment
 {
-  /**
-   * @brief Enumerations for Vertical alignment
-   *
-   * @SINCE_1_2.60
-   */
-  enum Type
-  {
-    TOP,     ///< @SINCE_1_2.60
-    CENTER,  ///< @SINCE_1_2.60
-    BOTTOM   ///< @SINCE_1_2.60
-  };
-}
+/**
+ * @brief Enumerations for Vertical alignment.
+ *
+ * @SINCE_1_2.60
+ */
+enum Type
+{
+  TOP,    ///< @SINCE_1_2.60
+  CENTER, ///< @SINCE_1_2.60
+  BOTTOM  ///< @SINCE_1_2.60
+};
+
+} // namespace VerticalAlignment
+
+/**
+ * @brief Contains modes which specify how lines are wrapped.
+ *
+ * If the layout width is too short to show the full text, then a wrapping mode can be specified.
+ *
+ * LineWrap::WORD mode will move an entire word to the next line:
+ * @code
+ * +---------+
+ * |HELLO    |
+ * |WORLD    |
+ * +---------+
+ * @endcode
+ *
+ * LineWrap::CHARACTER mode will move character by character to the next line:
+ * @code
+ * +---------+
+ * |HELLO WOR|
+ * |LD       |
+ * +---------+
+ * @endcode
+ *
+ * @SINCE_1_2.60
+ */
+namespace LineWrap
+{
+/**
+ * @brief Enumerations specifying how a line is wrapped.
+ * @SINCE_1_2.60
+ * @see LineWrap
+ */
+enum Mode
+{
+  WORD,     ///< @SINCE_1_2.60
+  CHARACTER ///< @SINCE_1_2.60
+};
+
+} // namespace LineWrap
+
+/**
+ * @brief The available underline types for text.
+ * @SINCE_1_2.60
+ */
+namespace Underline
+{
+/**
+ * @brief Enumerations specifying the underline type.
+ */
+enum Type
+{
+  SOLID,
+  DASHED,
+  DOUBLE
+};
+
+} // namespace UnderlineType
 
-} // Text
+} // namespace Text
 
 /**
  * @}
  */
 
-} // Toolkit
+} // namespace Toolkit
 
-} // Dali
+} // namespace Dali
 
 #endif //DALI_TOOLKIT_TEXT_ENUMERATIONS_H