Add a TextEditor property to limit input to maximum characters

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

diff --git a/dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h b/dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h
index fd2d4bb..fe8bc2e 100755 (executable)
--- a/dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h
+++ b/dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H
 
 /*
- * Copyright (c) 2017 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 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.
@@ -36,7 +36,6 @@ namespace Property
 {
   enum Type
   {
-      RENDERING_BACKEND = Dali::Toolkit::TextEditor::Property::RENDERING_BACKEND,
       TEXT = Dali::Toolkit::TextEditor::Property::TEXT,
       TEXT_COLOR = Dali::Toolkit::TextEditor::Property::TEXT_COLOR,
       FONT_FAMILY = Dali::Toolkit::TextEditor::Property::FONT_FAMILY,
@@ -110,7 +109,26 @@ namespace Property
        * @details Name "enableGrabHandle", type Property::BOOLEAN.
        * @note The default value is true, which means the grab handles are enabled by default.
        */
-      ENABLE_GRAB_HANDLE
+      ENABLE_GRAB_HANDLE,
+
+      /**
+       * @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,
+
+      /**
+       * @brief The type or rendering e.g. bitmap-based.
+       * @details Name "renderingBackend", type Property::INTEGER.
+       */
+      RENDERING_BACKEND,
+
+      /**
+       * @brief The maximum number of characters that can be inserted.
+       * @details Name "maxLength", type Property::INTEGER.
+       */
+      MAX_LENGTH,
   };
 
 } // namespace Property
@@ -121,7 +139,24 @@ namespace Property
  * @param[in] textEditor The instance of TextEditor.
  * @return InputMethodContext instance.
  */
-DALI_IMPORT_API InputMethodContext GetInputMethodContext( TextEditor textEditor );
+DALI_TOOLKIT_API InputMethodContext GetInputMethodContext( TextEditor textEditor );
+
+/**
+ * @brief Max Characters Exceed signal type.
+  */
+using MaxLengthReachedSignalType = Signal< void ( TextEditor ) >;
+
+/**
+ * @brief This signal is emitted when inserted text exceeds the maximum character limit.
+ *
+ * A callback of the following type may be connected:
+ * @code
+ *   void YourCallbackName( TextEditor textEditor );
+ * @endcode
+ * @param[in] textEditor The instance of TextEditor.
+ * @return The signal to connect to
+ */
+DALI_TOOLKIT_API MaxLengthReachedSignalType& MaxLengthReachedSignal( TextEditor textEditor );
 
 } // namespace DevelTextEditor