Merge "Note that some Text propeties in devel api can't be changed" into devel/master

[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 f95fc94..3560363 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,35 +78,43 @@ 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,
 
       /**
        * @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,
@@ -128,7 +136,43 @@ namespace Property
        * @brief The placeholder-text color.
        * @details name "placeholderTextColor", type vector4
        */
-      PLACEHOLDER_TEXT_COLOR
+      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["placeholderTextFocused"] = "Setting Placeholder Text Focused";
+       *   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,
+
+      /**
+       * @brief line wrap mode when the text lines over layout width.
+       * @details name "lineWrapMode", type string.
+       */
+      LINE_WRAP_MODE
   };
 } // namespace Property