/**
* @brief Retrieves the blink-interval for a cursor.
*
- * @return The cursor blink-interval.
+ * @return The cursor blink-interval in seconds.
*/
float GetCursorBlinkInterval() const;
/**
* @brief Retrieves the blink-duration for a cursor.
*
- * @return The cursor blink-duration.
+ * @return The cursor blink-duration in seconds.
*/
float GetCursorBlinkDuration() const;
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.
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();
* 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;
*
* 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;
*/
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:
/**