* @brief Retrieve the bounding box origin and dimensions.
*
* default is set once control is added to stage, before this the return vector will be Vector4:ZERO
- * @return Rect<int> the bounding box origin, width and height
+ * @param[out] boundingBox The bounding box origin, width and height.
*/
- const Rect<int>& GetBoundingBox() const;
+ void GetBoundingBox( Rect<int>& boundingBox ) const;
/**
* @brief The decorator waits until a relayout before creating actors etc.
void StopCursorBlink();
/**
+ * @brief Temporarily stops the cursor from blinking.
+ */
+ void DelayCursorBlink();
+
+ /**
* @brief Set the interval between cursor blinks.
*
* @param[in] seconds The interval in seconds.
/**
* @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;
/**
+ * @brief Sets the width of the cursors.
+ *
+ * @param[in] width The width of the cursor in pixels.
+ */
+ void SetCursorWidth( int width );
+
+ /**
+ * @brief Retrieves the width of the cursors.
+ *
+ * @return The width of the cursors in pixels.
+ */
+ int GetCursorWidth() const;
+
+ /**
* @brief Sets whether a handle is active.
*
* @param[in] handleType One of the handles.
const Vector2& GetPosition( HandleType handleType ) const;
/**
- * @brief Swaps the selection handle's images.
+ * @brief Whether to flip vertically a handle.
*
- * This method is called by the text controller to swap the handles
- * when the start index is bigger than the end one.
+ * @param[in] handleType The handle to flip vertically.
+ * @param[in] flip Whether to flip vertically.
*/
- void SwapSelectionHandlesEnabled( bool enable );
+ void FlipHandleVertically( HandleType handleType, bool flip );
/**
- * @brief Adds a quad to the existing selection highlights.
+ * @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.
+ *
+ * @param[in] enable If @e true the selection handles will flip as soon as they are crossed.
+ */
+ void FlipSelectionHandlesOnCrossEnabled( bool enable );
+
+ /**
+ * @brief Sets info to calculate the handle flip state.
+ *
+ * Sets the character's direction where the handles are pointing.
+ * It resets the decorator internal flip state when there is a new selection.
+ *
+ * @param[in] indicesSwapped Whether the selection handle indices are swapped (start > end).
+ * @param[in] left The direction of the character pointed by the primary selection handle.
+ * @param[in] right The direction of the character pointed by the secondary selection handle.
+ */
+ void SetSelectionHandleFlipState( bool indicesSwapped, bool left, bool right );
+
+ /**
+ * @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();
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.
* 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:
/**
projects / platform / core / uifw / dali-toolkit.git / blobdiff