Refactor TextLabel to use text visual
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-controller.h
index efd6d1a..5cb079c 100644 (file)
 #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.
@@ -466,13 +480,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 +488,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.
    */
@@ -516,6 +516,19 @@ public: // Default style & Input style
   const std::string& GetDefaultFontFamily() const;
 
   /**
+   * @brief Sets the placeholder text font family.
+   * @param[in] placeholderTextFontFamily The placeholder text font family.
+   */
+  void SetPlaceholderFontFamily( const std::string& placeholderTextFontFamily );
+
+  /**
+   * @brief Retrieves the placeholder text font family.
+   *
+   * @return The placeholder text font family
+   */
+  const std::string& GetPlaceholderFontFamily() const;
+
+  /**
    * @brief Sets the default font weight.
    *
    * @param[in] weight The font weight.
@@ -535,6 +548,27 @@ public: // Default style & Input style
   FontWeight GetDefaultFontWeight() const;
 
   /**
+   * @brief Sets the placeholder text font weight.
+   *
+   * @param[in] weight The font weight
+   */
+  void SetPlaceholderTextFontWeight( FontWeight weight );
+
+  /**
+   * @brief Whether the font's weight has been defined.
+   *
+   * @return True if the placeholder text font weight is defined
+   */
+  bool IsPlaceholderTextFontWeightDefined() const;
+
+  /**
+   * @brief Retrieves the placeholder text font weight.
+   *
+   * @return The placeholder text font weight
+   */
+  FontWeight GetPlaceholderTextFontWeight() const;
+
+  /**
    * @brief Sets the default font width.
    *
    * @param[in] width The font width.
@@ -554,6 +588,27 @@ public: // Default style & Input style
   FontWidth GetDefaultFontWidth() const;
 
   /**
+   * @brief Sets the placeholder text font width.
+   *
+   * @param[in] width The font width
+   */
+  void SetPlaceholderTextFontWidth( FontWidth width );
+
+  /**
+   * @brief Whether the font's width has been defined.
+   *
+   * @return True if the placeholder text font width is defined
+   */
+  bool IsPlaceholderTextFontWidthDefined() const;
+
+  /**
+   * @brief Retrieves the placeholder text font width.
+   *
+   * @return The placeholder text font width
+   */
+  FontWidth GetPlaceholderTextFontWidth() const;
+
+  /**
    * @brief Sets the default font slant.
    *
    * @param[in] slant The font slant.
@@ -573,9 +628,30 @@ public: // Default style & Input style
   FontSlant GetDefaultFontSlant() const;
 
   /**
+   * @brief Sets the placeholder text font slant.
+   *
+   * @param[in] slant The font slant
+   */
+  void SetPlaceholderTextFontSlant( FontSlant slant );
+
+  /**
+   * @brief Whether the font's slant has been defined.
+   *
+   * @return True if the placeholder text font slant is defined
+   */
+  bool IsPlaceholderTextFontSlantDefined() const;
+
+  /**
+   * @brief Retrieves the placeholder text font slant.
+   *
+   * @return The placeholder text font slant
+   */
+  FontSlant GetPlaceholderTextFontSlant() const;
+
+  /**
    * @brief Set the default font size.
    *
-   * @param[in] size The default font size.
+   * @param[in] fontSize The default font size
    * @param[in] type The font size type is point size or pixel size
    */
   void SetDefaultFontSize( float fontSize, FontSizeType type );
@@ -589,6 +665,20 @@ public: // Default style & Input style
   float GetDefaultFontSize( FontSizeType type ) const;
 
   /**
+   * @brief Sets the Placeholder text font size.
+   * @param[in] fontSize The placeholder text font size
+   * @param[in] type The font size type is point size or pixel size
+   */
+  void SetPlaceholderTextFontSize( float fontSize, FontSizeType type );
+
+  /**
+   * @brief Retrieves the Placeholder text font size.
+   * @param[in] type The font size type
+   * @return The placeholder font size
+   */
+  float GetPlaceholderTextFontSize( FontSizeType type ) const;
+
+  /**
    * @brief Sets the text's default color.
    *
    * @param color The default color.
@@ -909,6 +999,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.
 
   /**
@@ -978,6 +1075,20 @@ public: // Queries & retrieves.
    */
   void GetHiddenInputOption( Property::Map& options );
 
+  /**
+   * @brief Sets the Placeholder Properties.
+   *
+   * @param[in] map The placeholder property map
+   */
+  void SetPlaceholderProperty( const Property::Map& map );
+
+  /**
+   * @brief Retrieves the Placeholder Property map.
+   *
+   * @param[out] map The property map
+   */
+  void GetPlaceholderProperty( Property::Map& map );
+
 public: // Relayout.
 
   /**