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
old mode 100644 (file)
new mode 100755 (executable)
index 5bc2654..fe8bc2e
--- 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.
@@ -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-editor.h>
@@ -34,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,
@@ -74,53 +75,90 @@ namespace Property
       INPUT_EMBOSS = Dali::Toolkit::TextEditor::Property::INPUT_EMBOSS,
       OUTLINE = Dali::Toolkit::TextEditor::Property::OUTLINE,
       INPUT_OUTLINE = Dali::Toolkit::TextEditor::Property::INPUT_OUTLINE,
+      SMOOTH_SCROLL = Dali::Toolkit::TextEditor::Property::SMOOTH_SCROLL,
+      SMOOTH_SCROLL_DURATION = Dali::Toolkit::TextEditor::Property::SMOOTH_SCROLL_DURATION,
+      ENABLE_SCROLL_BAR = Dali::Toolkit::TextEditor::Property::ENABLE_SCROLL_BAR,
+      SCROLL_BAR_SHOW_DURATION = Dali::Toolkit::TextEditor::Property::SCROLL_BAR_SHOW_DURATION,
+      SCROLL_BAR_FADE_DURATION = Dali::Toolkit::TextEditor::Property::SCROLL_BAR_FADE_DURATION,
+      PIXEL_SIZE = Dali::Toolkit::TextEditor::Property::PIXEL_SIZE,
+      LINE_COUNT = Dali::Toolkit::TextEditor::Property::LINE_COUNT,
+      ENABLE_SELECTION = Dali::Toolkit::TextEditor::Property::ENABLE_SELECTION,
+      PLACEHOLDER = Dali::Toolkit::TextEditor::Property::PLACEHOLDER,
+      LINE_WRAP_MODE = Dali::Toolkit::TextEditor::Property::LINE_WRAP_MODE,
 
       /**
-       * @brief name "smoothScroll", type bool
-       * @details Enable or disable the smooth scroll animation
+       * @brief The text to display when the TextEditor is empty and inactive.
+       * @details Name "placeholderText", type Property::STRING.
        */
-      SMOOTH_SCROLL = INPUT_OUTLINE + 1,
+      PLACEHOLDER_TEXT,
 
       /**
-       * @brief name "smoothScrollDuration", type float
-       * @details Sets the duration of smooth scroll animation
+       * @brief The placeholder-text color.
+       * @details Name "placeholderTextColor", type Property::VECTOR4.
        */
-      SMOOTH_SCROLL_DURATION,
+      PLACEHOLDER_TEXT_COLOR,
 
       /**
-       * @brief name "enableScrollBar", type bool
-       * @details Enable or disable the scroll bar
+       * @brief Enables Text selection using Shift key.
+       * @details Name "enableShiftSelection", type Property::BOOLEAN.
        */
-      ENABLE_SCROLL_BAR,
+      ENABLE_SHIFT_SELECTION,
 
       /**
-       * @brief name "scrollBarShowDuration", type float
-       * @details Sets the duration of scroll bar to show
+       * @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.
        */
-      SCROLL_BAR_SHOW_DURATION,
+      ENABLE_GRAB_HANDLE,
 
       /**
-       * @brief name "scrollBarFadeDuration", type float
-       * @details Sets the duration of scroll bar to fade out
+       * @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
        */
-      SCROLL_BAR_FADE_DURATION,
+      MATCH_SYSTEM_LANGUAGE_DIRECTION,
 
       /**
-       * @brief The size of font in pixels.
-       * @details name "pixelSize", type float
+       * @brief The type or rendering e.g. bitmap-based.
+       * @details Name "renderingBackend", type Property::INTEGER.
        */
-      PIXEL_SIZE,
+      RENDERING_BACKEND,
 
       /**
-       * @brief The line count of text.
-       * @details name "lineCount", type int
-       * @note this property is read-only.
+       * @brief The maximum number of characters that can be inserted.
+       * @details Name "maxLength", type Property::INTEGER.
        */
-      LINE_COUNT
+      MAX_LENGTH,
   };
+
 } // namespace Property
 
-} // namespace DevelText
+/**
+ * @brief Return the input method context of TextEditor.
+ *
+ * @param[in] textEditor The instance of TextEditor.
+ * @return InputMethodContext instance.
+ */
+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
 
 } // namespace Toolkit