Add TextField BACKGROUND property and more Preedit style options

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

diff --git a/dali-toolkit/devel-api/controls/text-controls/text-field-devel.h b/dali-toolkit/devel-api/controls/text-controls/text-field-devel.h
old mode 100644 (file)
new mode 100755 (executable)
index 8e73c99..3a4864c
--- a/dali-toolkit/devel-api/controls/text-controls/text-field-devel.h
+++ b/dali-toolkit/devel-api/controls/text-controls/text-field-devel.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_TEXT_FIELD_DEVEL_H
 
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 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.
@@ -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>
@@ -47,8 +49,8 @@ namespace Property
       VERTICAL_ALIGNMENT = Dali::Toolkit::TextField::Property::VERTICAL_ALIGNMENT,
       TEXT_COLOR = Dali::Toolkit::TextField::Property::TEXT_COLOR,
       PLACEHOLDER_TEXT_COLOR = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_COLOR,
-      SHADOW_OFFSET = Dali::Toolkit::TextField::Property::SHADOW_OFFSET,
-      SHADOW_COLOR = Dali::Toolkit::TextField::Property::SHADOW_COLOR,
+      RESERVED_PROPERTY_01 = Dali::Toolkit::TextField::Property::RESERVED_PROPERTY_01,
+      RESERVED_PROPERTY_02 = Dali::Toolkit::TextField::Property::RESERVED_PROPERTY_02,
       PRIMARY_CURSOR_COLOR = Dali::Toolkit::TextField::Property::PRIMARY_CURSOR_COLOR,
       SECONDARY_CURSOR_COLOR = Dali::Toolkit::TextField::Property::SECONDARY_CURSOR_COLOR,
       ENABLE_CURSOR_BLINK = Dali::Toolkit::TextField::Property::ENABLE_CURSOR_BLINK,
@@ -91,10 +93,56 @@ namespace Property
        * @brief Enables Text selection using Shift key.
        * @details Name "enableShiftSelection", type Property::BOOLEAN.
        */
-      ENABLE_SHIFT_SELECTION = ELLIPSIS + 1
+      ENABLE_SHIFT_SELECTION = ELLIPSIS + 1,
+
+      /**
+       * @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.
+       */
+      ENABLE_GRAB_HANDLE = ELLIPSIS + 2,
+
+      /**
+       * @brief Modifies the default text alignment to match the direction of the system language.
+       * @details Name "matchSystemLanguageDirection", type (Property::BOOLEAN), Read/Write
+       * @note The default value is false
+       */
+      MATCH_SYSTEM_LANGUAGE_DIRECTION = ELLIPSIS + 3,
+
+      /**
+        * @brief Enables the grab handle popup for text selection.
+        * @details Name "enableGrabHandlePopup", type Property::BOOLEAN.
+        * @note The default value is true, which means the grab handle popup is enabled by default.
+        */
+      ENABLE_GRAB_HANDLE_POPUP = ELLIPSIS + 4,
+
+      /**
+       * @brief The default text background parameters.
+       * @details Name "textBackground", type Property::VECTOR4.
+       * @note Use "textBackground" as property name to avoid conflict with Control's "background" property.
+       * @note The default value is Color::TRANSPARENT.
+       */
+      BACKGROUND = ELLIPSIS + 5
+
   };
 } // namespace Property
 
+/**
+ * @brief Return the input method context of TextField.
+ *
+ * @param[in] textField The instance of TextField.
+ * @return InputMethodContext instance.
+ */
+DALI_TOOLKIT_API InputMethodContext GetInputMethodContext( TextField textField );
+
+/**
+ * @brief Select the whole text of TextField.
+ *
+ * @param[in] textField The instance of TextField.
+ * @return InputMethodContext instance.
+ */
+DALI_TOOLKIT_API void SelectWholeText( TextField textField );
+
 } // namespace DevelText
 
 } // namespace Toolkit