[dali_1.3.22] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / text-controls / text-field-devel.h
old mode 100644 (file)
new mode 100755 (executable)
index 4369126..5075358
@@ -17,6 +17,8 @@
  * limitations under the License.
  *
  */
+// EXTERNAL INCLUDES
+#include <dali/devel-api/adaptor-framework/input-method-context.h>
 
 // INTERNAL INCLUDES
 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
@@ -32,7 +34,7 @@ namespace DevelTextField
 
 namespace Property
 {
-  enum Type
+  enum
   {
       RENDERING_BACKEND = Dali::Toolkit::TextField::Property::RENDERING_BACKEND,
       TEXT = Dali::Toolkit::TextField::Property::TEXT,
@@ -81,65 +83,35 @@ namespace Property
       INPUT_EMBOSS = Dali::Toolkit::TextField::Property::INPUT_EMBOSS,
       OUTLINE = Dali::Toolkit::TextField::Property::OUTLINE,
       INPUT_OUTLINE = Dali::Toolkit::TextField::Property::INPUT_OUTLINE,
+      HIDDEN_INPUT_SETTINGS = Dali::Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS,
+      PIXEL_SIZE = Dali::Toolkit::TextField::Property::PIXEL_SIZE,
+      ENABLE_SELECTION = Dali::Toolkit::TextField::Property::ENABLE_SELECTION,
+      PLACEHOLDER = Dali::Toolkit::TextField::Property::PLACEHOLDER,
+      ELLIPSIS = Dali::Toolkit::TextField::Property::ELLIPSIS,
 
       /**
-       * @brief Hides the input characters and instead shows a default character for password or pin entry.
-       * @details name "hiddenInputSettings", type map.
-       * @note Optional.
-       *       This property is currently being used for some applications, so it can't be changed.
-       * @see HiddenInput
+       * @brief Enables Text selection using Shift key.
+       * @details Name "enableShiftSelection", type Property::BOOLEAN.
        */
-      HIDDEN_INPUT_SETTINGS = INPUT_OUTLINE + 1,
+      ENABLE_SHIFT_SELECTION = ELLIPSIS + 1,
 
       /**
-       * @brief The size of font in pixels.
-       *
-       * Conversion from Point size to Pixel size :
-       *  Pixel size = Point size * DPI / 72
-       * @details name "pixelSize", type float
+       * @brief Enables the grab handles for text selection.
+       * @details Name "enableGrabHandle", type Property::BOOLEAN.
+       * @note The default value is true, which means the grab handles are enabled by default.
        */
-      PIXEL_SIZE = INPUT_OUTLINE + 2,
-
-      /**
-       * @brief Enables Text selection, such as the cursor, handle, clipboard, and highlight color.
-       * @details name "enableSelection", type bool
-       */
-      ENABLE_SELECTION = INPUT_OUTLINE + 3,
-
-      /**
-       * @brief Sets the placeholder : text, color, font family, font style, point size, and pixel size.
-       *
-       * @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;
-       *
-       *   Property::Map fontStyleMap;
-       *   fontStyleMap.Insert( "weight", "bold" );
-       *   fontStyleMap.Insert( "width", "condensed" );
-       *   fontStyleMap.Insert( "slant", "italic" );
-       *   propertyMap["placeholderFontStyle"] = fontStyleMap;
-       *
-       *   field.SetProperty( DevelTextField::Property::PLACEHOLDER, propertyMap );
-       * @endcode
-       *
-       * @details name "placeholder", type MAP
-       */
-      PLACEHOLDER = INPUT_OUTLINE + 4,
-
-      /**
-       * @brief Enable or disable the ellipsis.
-       * @details name "ellipsis", type Property::BOOLEAN.
-       * @note PLACEHOLDER map is used to add ellipsis to placeholder text.
-       */
-      ELLIPSIS = INPUT_OUTLINE + 5
+      ENABLE_GRAB_HANDLE = ELLIPSIS + 2
   };
 } // namespace Property
 
+/**
+ * @brief Return the input method context of TextField.
+ *
+ * @param[in] textField The instance of TextField.
+ * @return InputMethodContext instance.
+ */
+DALI_IMPORT_API InputMethodContext GetInputMethodContext( TextField textField );
+
 } // namespace DevelText
 
 } // namespace Toolkit