Control::UnregisterVisual does not remove renderers from actor
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / text-controls / text-label.h
index 105690a..829d086 100644 (file)
@@ -42,24 +42,24 @@ class TextLabel;
  * Text labels are lightweight, non-editable and do not respond to user input.
  *
  * @section TextLabelProperties Properties
- * |%Property enum                    |String name          |Type          |Writable|Animatable|
- * |----------------------------------|---------------------|--------------|--------|----------|
- * | Property::RENDERING_BACKEND      | renderingBackend    |  INTEGER     | O      | X        |
- * | Property::TEXT                   | text                |  STRING      | O      | X        |
- * | Property::FONT_FAMILY            | fontFamily          |  STRING      | O      | X        |
- * | Property::FONT_STYLE             | fontStyle           |  STRING      | O      | X        |
- * | Property::POINT_SIZE             | pointSize           |  FLOAT       | O      | X        |
- * | Property::MULTI_LINE             | multiLine           |  BOOLEAN     | O      | X        |
- * | Property::HORIZONTAL_ALIGNMENT   | horizontalAlignment |  STRING      | O      | X        |
- * | Property::VERTICAL_ALIGNMENT     | verticalAlignment   |  STRING      | O      | X        |
- * | Property::TEXT_COLOR             | textColor           |  VECTOR4     | O      | X        |
- * | Property::ENABLE_MARKUP          | enableMarkup        |  BOOLEAN     | O      | X        |
- * | Property::ENABLE_AUTO_SCROLL     | enableAutoScroll    |  BOOLEAN     | O      | X        |
- * | Property::AUTO_SCROLL_SPEED      | autoScrollSpeed     |  INTEGER     | O      | X        |
- * | Property::AUTO_SCROLL_LOOP_COUNT | autoScrollLoopCount |  INTEGER     | O      | X        |
- * | Property::AUTO_SCROLL_GAP        | autoScrollGap       |  INTEGER     | O      | X        |
- * | Property::SHADOW                 | shadow              |  STRING      | O      | X        |
- * | Property::UNDERLINE              | underline           |  STRING      | O      | X        |
+ * |%Property enum                    |String name          |Type            |Writable|Animatable|
+ * |----------------------------------|---------------------|----------------|--------|----------|
+ * | Property::RENDERING_BACKEND      | renderingBackend    |  INTEGER       | O      | X        |
+ * | Property::TEXT                   | text                |  STRING        | O      | X        |
+ * | Property::FONT_FAMILY            | fontFamily          |  STRING        | O      | X        |
+ * | Property::FONT_STYLE             | fontStyle           |  STRING or MAP | O      | X        |
+ * | Property::POINT_SIZE             | pointSize           |  FLOAT         | O      | X        |
+ * | Property::MULTI_LINE             | multiLine           |  BOOLEAN       | O      | X        |
+ * | Property::HORIZONTAL_ALIGNMENT   | horizontalAlignment |  STRING        | O      | X        |
+ * | Property::VERTICAL_ALIGNMENT     | verticalAlignment   |  STRING        | O      | X        |
+ * | Property::TEXT_COLOR             | textColor           |  VECTOR4       | O      | X        |
+ * | Property::ENABLE_MARKUP          | enableMarkup        |  BOOLEAN       | O      | X        |
+ * | Property::ENABLE_AUTO_SCROLL     | enableAutoScroll    |  BOOLEAN       | O      | X        |
+ * | Property::AUTO_SCROLL_SPEED      | autoScrollSpeed     |  INTEGER       | O      | X        |
+ * | Property::AUTO_SCROLL_LOOP_COUNT | autoScrollLoopCount |  INTEGER       | O      | X        |
+ * | Property::AUTO_SCROLL_GAP        | autoScrollGap       |  INTEGER       | O      | X        |
+ * | Property::SHADOW                 | shadow              |  STRING or MAP | O      | X        |
+ * | Property::UNDERLINE              | underline           |  STRING or MAP | O      | X        |
  *
  * @SINCE_1_0.0
  */
@@ -108,8 +108,8 @@ public:
 
       /**
        * @brief The requested font style to use,
-       * @details name "fontStyle", type STRING
-       * @SINCE_1_0.0
+       * @details name "fontStyle", type STRING or MAP
+       * @SINCE_1_2.13
        */
       FONT_STYLE,
 
@@ -122,7 +122,7 @@ public:
 
       /**
        * @brief The single-line or multi-line layout option
-       * @details name "multiLine", type FLOAT, default SINGLE_LINE_BOX
+       * @details name "multiLine", type BOOLEAN, default false
        * @SINCE_1_0.0
        */
       MULTI_LINE,
@@ -150,7 +150,7 @@ public:
 
       /**
        * @brief The drop shadow offset 0 indicates no shadow
-       * @details name "shadowOffset", type VECTOR4
+       * @details name "shadowOffset", type VECTOR2
        * @DEPRECATED_1_1.37 Use SHADOW instead
        */
       SHADOW_OFFSET,
@@ -192,13 +192,13 @@ public:
 
       /**
        * @brief  Start or stop auto scrolling,
-       * @details name "enableMarkup", type BOOLEAN, default is false
+       * @details name "enableAutoScroll", type BOOLEAN, default is false
        * @SINCE_1_1.35
        */
       ENABLE_AUTO_SCROLL,
 
       /**
-       * @brief  Start or stop auto scrolling,
+       * @brief Sets the speed of scrolling in pixels per second,
        * @details name "autoScrollSpeed", type INT, default in style sheet
        * @SINCE_1_1.35
        */
@@ -227,29 +227,29 @@ public:
 
       /**
        * @brief The default underline parameters.
-       * @details name "underline", type STRING.
-       * @SINCE_1_1.37
+       * @details name "underline", type MAP.
+       * @SINCE_1_2.13
        */
       UNDERLINE,
 
       /**
        * @brief The default shadow parameters.
-       * @details name "shadow", type STRING.
-       * @SINCE_1_1.37
+       * @details name "shadow", type MAP.
+       * @SINCE_1_2.13
        */
       SHADOW,
 
       /**
        * @brief The default emboss parameters.
-       * @details name "emboss", type STRING.
-       * @SINCE_1_1.37
+       * @details name "emboss", type MAP.
+       * @SINCE_1_2.13
        */
       EMBOSS,
 
       /**
        * @brief The default outline parameters.
-       * @details name "outline", type STRING.
-       * @SINCE_1_1.37
+       * @details name "outline", type MAP.
+       * @SINCE_1_2.13
        */
       OUTLINE,
     };
@@ -317,6 +317,7 @@ public:
 
 public: // Not intended for application developers
 
+  /// @cond internal
   /**
    * @brief Creates a handle using the Toolkit::Internal implementation.
    *
@@ -332,6 +333,7 @@ public: // Not intended for application developers
    * @param[in]  internal  A pointer to the internal CustomActor.
    */
   explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
+  /// @endcond
 };
 
 /**