Note that some Text propeties in devel api can't be changed

[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 d842559..f2fa947 100644 (file)
--- a/dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h
+++ b/dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h
@@ -78,21 +78,124 @@ namespace Property
       /**
        * @brief name "smoothScroll", type bool
        * @details Enable or disable the smooth scroll animation
+       * @note This property is currently being used for some applications, so it can't be changed.
        */
       SMOOTH_SCROLL = INPUT_OUTLINE + 1,
 
       /**
        * @brief name "smoothScrollDuration", type float
        * @details Sets the duration of smooth scroll animation
+       * @note This property is currently being used for some applications, so it can't be changed.
        */
-      SMOOTH_SCROLL_DURATION
+      SMOOTH_SCROLL_DURATION,
+
+      /**
+       * @brief name "enableScrollBar", type bool
+       * @details Enable or disable the scroll bar
+       * @note This property is currently being used for some applications, so it can't be changed.
+       */
+      ENABLE_SCROLL_BAR,
+
+      /**
+       * @brief name "scrollBarShowDuration", type float
+       * @details Sets the duration of scroll bar to show
+       * @note This property is currently being used for some applications, so it can't be changed.
+       */
+      SCROLL_BAR_SHOW_DURATION,
+
+      /**
+       * @brief name "scrollBarFadeDuration", type float
+       * @details Sets the duration of scroll bar to fade out
+       * @note This property is currently being used for some applications, so it can't be changed.
+       */
+      SCROLL_BAR_FADE_DURATION,
+
+      /**
+       * @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
+       */
+      PIXEL_SIZE,
+
+      /**
+       * @brief The line count of text.
+       * @details name "lineCount", type int
+       * @note this property is read-only.
+       */
+      LINE_COUNT,
+
+      /**
+       * @brief The text to display when the TextEditor is empty and inactive.
+       * @details name "placeholderText", type string
+       */
+      PLACEHOLDER_TEXT,
+
+      /**
+       * @brief The placeholder-text color.
+       * @details name "placeholderTextColor", type vector4
+       */
+      PLACEHOLDER_TEXT_COLOR,
+
+      /**
+       * @brief Enables Text selection, such as the cursor, handle, clipboard, and highlight color.
+       * @details name "enableSelection", type bool
+       */
+      ENABLE_SELECTION,
+
+      /**
+       * @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["placeholderColor"] = Color::RED;
+       *   propertyMap["placeholderFontFamily"] = "Arial";
+       *   propertyMap["placeholderPointSize"] = 12.0f;
+       *
+       *   Property::Map fontStyleMap;
+       *   fontstyleMap.Insert( "weight", "bold" );
+       *   fontstyleMap.Insert( "width", "condensed" );
+       *   fontstyleMap.Insert( "slant", "italic" );
+       *   propertyMap["placeholderFontStyle"] = fontStyleMap;
+       *
+       *   editor.SetProperty( DevelTextEditor::Property::PLACEHOLDER, propertyMap );
+       * @endcode
+       *
+       * @details name "placeholder", type MAP
+       */
+      PLACEHOLDER
   };
 } // namespace Property
 
-} // namespace DevelText
+namespace Scroll
+{
+  enum Type
+  {
+    STARTED,   ///< Scrolling is started.
+    FINISHED   ///< Scrolling is finished.
+  };
+} // namespace Scroll
+
+typedef Signal< void ( TextEditor, Scroll::Type ) > ScrollStateChangedSignalType;
+
+/**
+ * @brief This signal is emitted when TextEditor scrolling is started or finished.
+ *
+ * A callback of the following type may be connected:
+ * @code
+ *   void YourCallbackName( ScrollState::Type type );
+ * @endcode
+ * type: Whether the scrolling is started or finished.
+ * @return The signal to connect to
+ */
+DALI_IMPORT_API ScrollStateChangedSignalType& ScrollStateChangedSignal( TextEditor textEditor );
+
+} // namespace DevelTextEditor
 
 } // namespace Toolkit
 
 } // namespace Dali
 
-#endif // DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H
\ No newline at end of file
+#endif // DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H