Fix text outline property related native TCT
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-controller.h
old mode 100644 (file)
new mode 100755 (executable)
index 9c80fc7..fc75596
 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup-callback-interface.h>
 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
+#include <dali-toolkit/internal/text/layouts/layout-wrap-mode.h>
 #include <dali-toolkit/internal/text/hidden-text.h>
 #include <dali-toolkit/internal/text/text-model-interface.h>
 
+
 namespace Dali
 {
 
@@ -343,6 +345,18 @@ public: // Configure the text controller.
   Layout::VerticalAlignment GetVerticalAlignment() const;
 
   /**
+   * @brief Sets the text's wrap mode
+   * @param[in] text wrap mode The unit of wrapping
+   */
+  void SetLineWrapMode( Layout::LineWrap::Mode textWarpMode );
+
+  /**
+   * @brief Retrieve text wrap mode previously set.
+   * @return text wrap mode
+   */
+  Layout::LineWrap::Mode GetLineWrapMode() const;
+
+  /**
    * @brief Enable or disable the text elide.
    *
    * @param[in] enabled Whether to enable the text elide.
@@ -355,6 +369,18 @@ public: // Configure the text controller.
   bool IsTextElideEnabled() const;
 
   /**
+   * @brief Enable or disable the placeholder text elide.
+   * @param enabled Whether to enable the placeholder text elide.
+   */
+  void SetPlaceholderTextElideEnabled( bool enabled );
+
+  /**
+   * @brief Whether the placeholder text elide property is enabled.
+   * @return True if the placeholder text elide property is enabled, false otherwise.
+   */
+  bool IsPlaceholderTextElideEnabled() const;
+
+  /**
    * @brief Enable or disable the text selection.
    * @param[in] enabled Whether to enable the text selection.
    */
@@ -435,6 +461,18 @@ public: // Configure the text controller.
   void ShadowSetByString( bool setByString );
 
   /**
+   * @brief Query if outline settings were provided by string or map
+   * @return bool true if set by string
+   */
+  bool IsOutlineSetByString();
+
+  /**
+   * Set method outline setting were set by
+   * @param[in] bool, true if set by string
+   */
+  void OutlineSetByString( bool setByString );
+
+  /**
    * @brief Query if font style settings were provided by string or map
    * @return bool true if set by string
    */
@@ -466,13 +504,6 @@ public: // Update.
   /**
    * @brief Replaces any placeholder text previously set.
    *
-   * @param[in] text A string of UTF-8 characters.
-   */
-  void SetPlaceholderText( const std::string& text );
-
-  /**
-   * @brief Replaces any placeholder text previously set.
-   *
    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
    * @param[in] text A string of UTF-8 characters.
    */
@@ -481,13 +512,6 @@ public: // Update.
   /**
    * @brief Retrieve any placeholder text previously set.
    *
-   * @param[out] A string of UTF-8 characters.
-   */
-  void GetPlaceholderText( std::string& text ) const;
-
-  /**
-   * @brief Retrieve any placeholder text previously set.
-   *
    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
    * @param[out] A string of UTF-8 characters.
    */
@@ -777,6 +801,34 @@ public: // Default style & Input style
   float GetUnderlineHeight() const;
 
   /**
+   * @brief Set the outline color.
+   *
+   * @param[in] color color of outline.
+   */
+  void SetOutlineColor( const Vector4& color );
+
+  /**
+   * @brief Retrieve the outline color.
+   *
+   * @return The outline color.
+   */
+  const Vector4& GetOutlineColor() const;
+
+  /**
+   * @brief Set the outline width
+   *
+   * @param[in] width The width in pixels of the outline, 0 indicates no outline
+   */
+  void SetOutlineWidth( float width );
+
+  /**
+   * @brief Retrieves the width of an outline
+   *
+   * @return The width of the outline.
+   */
+  float GetOutlineWidth() const;
+
+  /**
    * @brief Sets the emboss's properties string.
    *
    * @note The string is stored to be recovered.
@@ -999,6 +1051,13 @@ public: // Default style & Input style
    */
   const std::string& GetInputOutlineProperties() const;
 
+  /**
+   * @brief Set the control's interface.
+   *
+   * @param[in] controlInterface The control's interface.
+   */
+  void SetControlInterface( ControlInterface* controlInterface );
+
 public: // Queries & retrieves.
 
   /**
@@ -1173,6 +1232,13 @@ public: // Text-input Event Queuing.
    */
   void PasteClipboardItemEvent();
 
+  /**
+   * @brief Return true when text control should clear key input focus when escape key is pressed.
+   *
+   * @return Whether text control should clear key input focus or not when escape key is pressed.
+   */
+  bool ShouldClearFocusOnEscape() const;
+
 protected: // Inherit from Text::Decorator::ControllerInterface.
 
   /**