X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Fdecorator%2Ftext-decorator.h;h=83388f4bb36c32eaa15166ceb69bd7454f411b86;hp=4a1fc5f5ca5f01d803de650ee4cc9cb5383336b0;hb=549dd9160d48572dcbfbae6ae87ae6d8f749aa83;hpb=d15b9def82b922ae3013ea250e4f6fe260417a79 diff --git a/dali-toolkit/internal/text/decorator/text-decorator.h b/dali-toolkit/internal/text/decorator/text-decorator.h index 4a1fc5f..83388f4 100644 --- a/dali-toolkit/internal/text/decorator/text-decorator.h +++ b/dali-toolkit/internal/text/decorator/text-decorator.h @@ -22,7 +22,6 @@ #include #include #include -#include // INTERNAL INCLUDES #include @@ -30,21 +29,12 @@ namespace Dali { -class Actor; -class Image; -class Vector2; -class Vector4; +struct Vector2; +struct Vector4; namespace Toolkit { -class TextSelectionPopupCallbackInterface; - -namespace Internal -{ -class Control; -} - namespace Text { @@ -91,6 +81,8 @@ enum HandleType GRAB_HANDLE, LEFT_SELECTION_HANDLE, RIGHT_SELECTION_HANDLE, + LEFT_SELECTION_HANDLE_MARKER, + RIGHT_SELECTION_HANDLE_MARKER, HANDLE_TYPE_COUNT }; @@ -126,9 +118,9 @@ public: virtual ~ControllerInterface() {}; /** - * @brief An input event from one of the handles. + * @brief Query the target size of the UI control. * - * @param[out] targetSize The Size of the UI control the decorator is adding it's decorations to. + * @param[out] targetSize The size of the UI control the decorator is adding it's decorations to. */ virtual void GetTargetSize( Vector2& targetSize ) = 0; @@ -187,9 +179,9 @@ public: * @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 the bounding box origin, width and height + * @param[out] boundingBox The bounding box origin, width and height. */ - const Rect& GetBoundingBox() const; + void GetBoundingBox( Rect& boundingBox ) const; /** * @brief The decorator waits until a relayout before creating actors etc. @@ -278,6 +270,11 @@ public: 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. @@ -287,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; @@ -301,11 +298,25 @@ public: /** * @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. @@ -386,15 +397,45 @@ public: 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. @@ -404,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(); @@ -423,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. @@ -460,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; @@ -476,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; @@ -492,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: /**