X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Ftext-controls%2Ftext-field.h;h=7f7fd86b05e82d508608d493b2ba90502f3fa127;hb=aff52b6dbc13a5be62bbd5db2e4c76d3746d9e40;hp=5af78b213d38e8513fdd278ad42f8d26fc91a995;hpb=fedf87ade1e326c925e463906b0400a09b86ae0a;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git

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 5af78b2..7f7fd86 100644
--- 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 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,