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

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

diff --git a/dali-toolkit/public-api/controls/text-controls/text-field.h b/dali-toolkit/public-api/controls/text-controls/text-field.h
index 0875753..d2d3ae5 100644 (file)
--- a/dali-toolkit/public-api/controls/text-controls/text-field.h
+++ b/dali-toolkit/public-api/controls/text-controls/text-field.h
@@ -313,6 +313,26 @@ public:
       /**
        * @brief The settings to relating to the System's Input Method, Key and Value.
        * @details Name "inputMethodSettings", type Property::MAP.
+       *
+       * @note VARIATION key can be changed depending on PANEL_LAYOUT.
+       * For example, when PANEL_LAYOUT key is InputMethod::PanelLayout::NORMAL,
+       * then VARIATION would be among NORMAL, WITH_FILENAME, and WITH_PERSON_NAME in Dali::InputMethod::NormalLayout.
+       * For more information, see @ref Dali::InputMethod::Category.
+       *
+       * Example Usage:
+       * @code
+       *   Property::Map propertyMap;
+       *   InputMethod::PanelLayout::Type panelLayout = InputMethod::PanelLayout::NUMBER;
+       *   InputMethod::AutoCapital::Type autoCapital = InputMethod::AutoCapital::WORD;
+       *   InputMethod::ButtonAction::Type buttonAction = InputMethod::ButtonAction::GO;
+       *   int inputVariation = 1;
+       *   propertyMap["PANEL_LAYOUT"] = panelLayout;
+       *   propertyMap["AUTO_CAPITALIZE"] = autoCapital;
+       *   propertyMap["BUTTON_ACTION"] = buttonAction;
+       *   propertyMap["VARIATION"] = inputVariation;
+       *
+       *   field.SetProperty( TextField::Property::INPUT_METHOD_SETTINGS, propertyMap );
+       * @endcode
        * @SINCE_1_0.0
        */
       INPUT_METHOD_SETTINGS,
@@ -353,9 +373,7 @@ public:
       INPUT_POINT_SIZE,
 
       /**
-       * @brief The default underline parameters.
-       * @details Name "underline", type Property::MAP.
-       * @SINCE_1_2.13
+       * @copydoc Dali::Toolkit::TextLabel::Property::UNDERLINE
        */
       UNDERLINE,
 
@@ -367,9 +385,7 @@ public:
       INPUT_UNDERLINE,
 
       /**
-       * @brief The default shadow parameters.
-       * @details Name "shadow", type Property::MAP.
-       * @SINCE_1_2.13
+       * @copydoc Dali::Toolkit::TextLabel::Property::SHADOW
        */
       SHADOW,
 
@@ -395,9 +411,7 @@ public:
       INPUT_EMBOSS,
 
       /**
-       * @brief The default outline parameters.
-       * @details Name "outline", type Property::MAP.
-       * @SINCE_1_2.13
+       * @copydoc Dali::Toolkit::TextLabel::Property::OUTLINE
        */
       OUTLINE,