Add support to unselect text And Get_SelectedText

[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 48e0ef5..6ac1887 100644 (file)
--- a/dali-toolkit/public-api/controls/text-controls/text-field.h
+++ b/dali-toolkit/public-api/controls/text-controls/text-field.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_TEXT_FIELD_H__
-#define __DALI_TOOLKIT_TEXT_FIELD_H__
+#ifndef DALI_TOOLKIT_TEXT_FIELD_H
+#define DALI_TOOLKIT_TEXT_FIELD_H
 
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 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.
@@ -46,7 +46,7 @@ class TextField;
  * | maxLengthReached     | @ref MaxLengthReachedSignal()  | @SINCE_1_0.0       |
  * | inputStyleChanged    | @ref InputStyleChangedSignal() | @SINCE_1_2_2       |
  */
-class DALI_IMPORT_API TextField : public Control
+class DALI_TOOLKIT_API TextField : public Control
 {
 public:
 
@@ -138,16 +138,18 @@ public:
 
       /**
        * @brief The line horizontal alignment.
-       * @details Name "horizontalAlignment", type Property::STRING.
+       * @details Name "horizontalAlignment", type Property::STRING or type HorizontalAlignment::Type (Property::INTEGER)
        *          Values "BEGIN", "CENTER", "END".
+       * @note Return type is Property::STRING
        * @SINCE_1_0.0
        */
       HORIZONTAL_ALIGNMENT,
 
       /**
        * @brief The line vertical alignment.
-       * @details Name "verticalAlignment", type Property::STRING.
+       * @details Name "verticalAlignment", type Property::STRING type VerticalAlignment::Type (Property::INTEGER)
        *          Values "TOP",   "CENTER", "BOTTOM".
+       * @note Return type is Property::STRING
        * @SINCE_1_0.0
        */
       VERTICAL_ALIGNMENT,
@@ -167,20 +169,14 @@ public:
       PLACEHOLDER_TEXT_COLOR,
 
       /**
-       * @DEPRECATED_1_1.37 Use SHADOW instead.
-       * @brief The drop shadow offset 0 indicates no shadow.
-       * @details Name "shadowOffset", type Property::VECTOR2.
-       * @SINCE_1_0.0
+       * @brief This property is removed because it's deprecated.
        */
-      SHADOW_OFFSET,
+      RESERVED_PROPERTY_01,
 
       /**
-       * @DEPRECATED_1_1.37 Use SHADOW instead.
-       * @brief The color of a drop shadow.
-       * @details Name "shadowColor", type Property::VECTOR4.
-       * @SINCE_1_0.0
+       * @brief This property is removed because it's deprecated.
        */
-      SHADOW_COLOR,
+      RESERVED_PROPERTY_02,
 
       /**
        * @brief The color to apply to the primary cursor.
@@ -311,6 +307,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,
@@ -351,9 +367,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,
 
@@ -365,9 +379,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,
 
@@ -393,9 +405,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,
 
@@ -437,18 +447,18 @@ public:
        * Example Usage:
        * @code
        *   Property::Map propertyMap;
-       *   propertyMap["placeholderText"] = "Setting Placeholder Text";
-       *   propertyMap["placeholderTextFocused"] = "Setting Placeholder Text Focused";
-       *   propertyMap["placeholderColor"] = Color::RED;
-       *   propertyMap["placeholderFontFamily"] = "Arial";
-       *   propertyMap["placeholderPointSize"] = 12.0f;
-       *   propertyMap["placeholderEllipsis"] = true;
+       *   propertyMap[ Text::PlaceHolder::Property::TEXT ] = "Setting Placeholder Text";
+       *   propertyMap[ Text::PlaceHolder::Property::TEXT_FOCUSED] = "Setting Placeholder Text Focused";
+       *   propertyMap[ Text::PlaceHolder::Property::COLOR] = Color::RED;
+       *   propertyMap[ Text::PlaceHolder::Property::FONT_FAMILY ] = "Arial";
+       *   propertyMap[ Text::PlaceHolder::Property::POINT_SIZE ] = 12.0f;
+       *   propertyMap[ Text::PlaceHolder::Property::ELLIPSIS ] = true;
        *
        *   Property::Map fontStyleMap;
        *   fontStyleMap.Insert( "weight", "bold" );
        *   fontStyleMap.Insert( "width", "condensed" );
        *   fontStyleMap.Insert( "slant", "italic" );
-       *   propertyMap["placeholderFontStyle"] = fontStyleMap;
+       *   propertyMap[ Text::PlaceHolder::Property::FONT_STYLE] = fontStyleMap;
        *
        *   field.SetProperty( TextField::Property::PLACEHOLDER, propertyMap );
        * @endcode
@@ -462,7 +472,7 @@ public:
        * @SINCE_1_2.60
        * @note PLACEHOLDER map is used to add ellipsis to placeholder text.
        */
-      ELLIPSIS,
+      ELLIPSIS
     };
   };
 
@@ -640,4 +650,4 @@ public: // Not intended for application developers
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_TEXT_FIELD_H__
+#endif // DALI_TOOLKIT_TEXT_FIELD_H