Reposition the text's popup when the text is scrolled.

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / decorator / text-decorator.h

diff --git a/dali-toolkit/internal/text/decorator/text-decorator.h b/dali-toolkit/internal/text/decorator/text-decorator.h
index 4e36fa7..83388f4 100644 (file)
--- a/dali-toolkit/internal/text/decorator/text-decorator.h
+++ b/dali-toolkit/internal/text/decorator/text-decorator.h
@@ -284,7 +284,7 @@ public:
   /**
    * @brief Retrieves the blink-interval for a cursor.
    *
-   * @return The cursor blink-interval.
+   * @return The cursor blink-interval in seconds.
    */
   float GetCursorBlinkInterval() const;
 
@@ -298,7 +298,7 @@ public:
   /**
    * @brief Retrieves the blink-duration for a cursor.
    *
-   * @return The cursor blink-duration.
+   * @return The cursor blink-duration in seconds.
    */
   float GetCursorBlinkDuration() const;
 
@@ -397,6 +397,23 @@ public:
   const Vector2& GetPosition( HandleType handleType ) const;
 
   /**
+   * @brief Whether to flip vertically a handle.
+   *
+   * @param[in] handleType The handle to flip vertically.
+   * @param[in] flip Whether to flip vertically.
+   */
+  void FlipHandleVertically( HandleType handleType, bool flip );
+
+  /**
+   * @brief Retrieves whether the handle is vertically flipped.
+   *
+   * @param[in] handleType The handle to query.
+   *
+   * @return @e ture if the handle is vertically flipped.
+   */
+  bool IsHandleVerticallyFlipped( HandleType handleType ) const;
+
+  /**
    * @brief Whether to flip the selection handles as soon as they are crossed.
    *
    * By default they flip when the handle is released.
@@ -418,7 +435,7 @@ public:
   void SetSelectionHandleFlipState( bool indicesSwapped, bool left, bool right );
 
   /**
-   * @brief Adds a quad to the existing selection highlights.
+   * @brief Adds a quad to the existing selection highlights. Vertices are in decorator's coordinates.
    *
    * @param[in] x1 The top-left x position.
    * @param[in] y1 The top-left y position.
@@ -428,6 +445,18 @@ public:
   void AddHighlight( float x1, float y1, float x2, float y2 );
 
   /**
+   * @brief Sets the min 'x,y' coordinates and the size of the highlighted box.
+   *
+   * It's used to set the size and position of the highlight's actor and to translate each highlight quad from
+   * decorator's coordinates to the local coords of the highlight's actor.
+   *
+   * @param[in] position The position of the highlighted text in decorator's coords.
+   * @param[in] size The size of the highlighted text.
+   */
+  void SetHighLightBox( const Vector2& position,
+                        const Size& size );
+
+  /**
    * @brief Removes all of the previously added highlights.
    */
   void ClearHighlights();
@@ -447,6 +476,20 @@ public:
   const Vector4& GetHighlightColor() const;
 
   /**
+   * @brief Sets whether the highlight is active.
+   *
+   * @param[in] active Whether the highlight is active.
+   */
+  void SetHighlightActive( bool active );
+
+  /**
+   * @brief Retrieves whether the highlight is active.
+   *
+   * @return @e true if the highlight is active, @e false otherwise.
+   */
+  bool IsHighlightActive() const;
+
+  /**
    * @brief Sets into the decorator the depth used to render the text.
    *
    * @param[in] depth The text's depth.
@@ -484,14 +527,14 @@ public:
    * It defines a square area inside the control, close to the edge.
    * When the cursor enters this area, the decorator starts to send scroll events.
    *
-   * @param[in] threshold The scroll threshold.
+   * @param[in] threshold The scroll threshold in pixels.
    */
   void SetScrollThreshold( float threshold );
 
   /**
    * @brief Retrieves the scroll threshold.
    *
-   * @retunr The scroll threshold.
+   * @retunr The scroll threshold in pixels.
    */
   float GetScrollThreshold() const;
 
@@ -500,14 +543,14 @@ public:
    *
    * Is the distance the text is going to be scrolled during a scroll interval.
    *
-   * @param[in] speed The scroll speed.
+   * @param[in] speed The scroll speed in pixels/second.
    */
   void SetScrollSpeed( float speed );
 
   /**
    * @brief Retrieves the scroll speed.
    *
-   * @return The scroll speed.
+   * @return The scroll speed in pixels/second.
    */
   float GetScrollSpeed() const;
 
@@ -516,6 +559,36 @@ public:
    */
   void NotifyEndOfScroll();
 
+  /**
+   * @copydoc Text::Controller::SetHorizontalScrollEnabled()
+   */
+  void SetHorizontalScrollEnabled( bool enable );
+
+  /**
+   * @copydoc Text::Controller::IsHorizontalScrollEnabled()
+   */
+  bool IsHorizontalScrollEnabled() const;
+
+  /**
+   * @copydoc Text::Controller::SetVerticalScrollEnabled()
+   */
+  void SetVerticalScrollEnabled( bool enable );
+
+  /**
+   * @copydoc Text::Controller::IsVerticalScrollEnabled()
+   */
+  bool IsVerticalScrollEnabled() const;
+
+  /**
+   * @copydoc Text::Controller::SetSmoothHandlePanEnabled()
+   */
+  void SetSmoothHandlePanEnabled( bool enable );
+
+  /**
+   * @copydoc Text::Controller::IsSmoothHandlePanEnabled()
+   */
+  bool IsSmoothHandlePanEnabled() const;
+
 protected:
 
   /**