X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Fdecorator%2Ftext-decorator.h;h=4bcd012519449d11f5121c5e2bdbe48719dc0e17;hb=96ffd67201c91f09328e018326fa37ec97249ada;hp=e341e2b4c8640b71e6ddeda8c0746cf975bdaf13;hpb=620ac79821b89142af1926f3577c7fa003f16ad3;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/text/decorator/text-decorator.h b/dali-toolkit/internal/text/decorator/text-decorator.h index e341e2b..4bcd012 100644 --- a/dali-toolkit/internal/text/decorator/text-decorator.h +++ b/dali-toolkit/internal/text/decorator/text-decorator.h @@ -22,23 +22,19 @@ #include #include #include -#include + +// INTERNAL INCLUDES +#include namespace Dali { -class Image; -class Vector2; -class Vector4; +struct Vector2; +struct Vector4; namespace Toolkit { -namespace Internal -{ -class Control; -} - namespace Text { @@ -85,6 +81,8 @@ enum HandleType GRAB_HANDLE, LEFT_SELECTION_HANDLE, RIGHT_SELECTION_HANDLE, + LEFT_SELECTION_HANDLE_MARKER, + RIGHT_SELECTION_HANDLE_MARKER, HANDLE_TYPE_COUNT }; @@ -98,26 +96,40 @@ enum HandleType * * Selection handles will be flipped around to ensure they do not exceed the Decoration Bounding Box. ( Stay visible ). * - * Decorator components forward input events to a controller class through an observer interface. + * Decorator components forward input events to a controller class through an interface. * The controller is responsible for selecting which components are active. */ class Decorator : public RefObject { public: - class Observer + class ControllerInterface { public: /** * @brief Constructor. */ - Observer() {}; + ControllerInterface() {}; /** * @brief Virtual destructor. */ - virtual ~Observer() {}; + virtual ~ControllerInterface() {}; + + /** + * @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. + */ + virtual void GetTargetSize( Vector2& targetSize ) = 0; + + /** + * @brief Add a decoration to the parent UI control. + * + * @param[in] decoration The actor displaying a decoration. + */ + virtual void AddDecoration( Actor& actor, bool needsClipping ) = 0; /** * @brief An input event from one of the handles. @@ -127,17 +139,19 @@ public: * @param[in] x The x position relative to the top-left of the parent control. * @param[in] y The y position relative to the top-left of the parent control. */ - virtual void HandleEvent( HandleType handleType, HandleState state, float x, float y ) = 0; + virtual void DecorationEvent( HandleType handleType, HandleState state, float x, float y ) = 0; }; /** * @brief Create a new instance of a Decorator. * - * @param[in] parent Decorations will be added to this parent control. - * @param[in] observer A class which receives input events from Decorator components. + * @param[in] controller The controller which receives input events from Decorator components. + * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks. + * * @return A pointer to a new Decorator. */ - static DecoratorPtr New( Dali::Toolkit::Internal::Control& parent, Observer& observer ); + static DecoratorPtr New( ControllerInterface& controller, + TextSelectionPopupCallbackInterface& callbackInterface ); /** * @brief Set the bounding box which handles, popup and similar decorations will not exceed. @@ -165,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. @@ -235,7 +249,7 @@ public: * @param[in] cursor Whether this color is for the primary or secondary cursor. * @param[in] color The color to use. */ - void SetColor( Cursor cursor, const Dali::Vector4& color ); + void SetCursorColor( Cursor cursor, const Dali::Vector4& color ); /** * @brief Retrieves the color for a cursor. @@ -256,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. @@ -284,6 +303,20 @@ public: 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. @@ -321,6 +354,20 @@ public: Dali::Image GetHandleImage( HandleType handleType, HandleImageType handleImageType ) const; /** + * @brief Sets the color of the handles + * + * @param[in] color The color to use. + */ + void SetHandleColor( const Vector4& color ); + + /** + * @brief Retrieves the handles color. + * + * @return The color of the handles. + */ + const Vector4& GetHandleColor() const; + + /** * @brief Sets the position of a selection handle. * * @param[in] handleType The handle to set. @@ -341,6 +388,53 @@ public: void GetPosition( HandleType handleType, float& x, float& y, float& lineHeight ) const; /** + * @brief Retrieves the position of a selection handle. + * + * @param[in] handleType The handle to get. + * + * @return The position of the selection handle relative to the top-left of the parent control. + */ + 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. + * + * @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. * * @param[in] x1 The top-left x position. @@ -358,18 +452,25 @@ public: /** * @brief Sets the selection highlight color. * - * @param[in] image The image to use. + * @param[in] color The color to use. */ void SetHighlightColor( const Vector4& color ); /** * @brief Retrieves the selection highlight color. * - * @return The image. + * @return The color of the highlight */ const Vector4& GetHighlightColor() const; /** + * @brief Sets into the decorator the depth used to render the text. + * + * @param[in] depth The text's depth. + */ + void SetTextDepth( int textDepth ); + + /** * @brief Set the Selection Popup to show or hide via the active flaf * @param[in] active true to show, false to hide */ @@ -383,6 +484,18 @@ public: bool IsPopupActive() const; /** + * @brief Set a bit mask of the buttons to be shown by Popup + * @param[in] enabledButtonsBitMask from TextSelectionPopup::Buttons enum + */ + void SetEnabledPopupButtons( TextSelectionPopup::Buttons& enabledButtonsBitMask ); + + /** + * @brief Get the current bit mask of buttons to be shown by Popup + * @return bitmask of TextSelectionPopup::Buttons + */ + TextSelectionPopup::Buttons& GetEnabledPopupButtons(); + + /** * @brief Sets the scroll threshold. * * It defines a square area inside the control, close to the edge. @@ -416,18 +529,9 @@ public: float GetScrollSpeed() const; /** - * @brief Sets the scroll interval. - * - * @param[in] seconds The scroll interval in seconds. - */ - void SetScrollTickInterval( float seconds ); - - /** - * @brief Retrieves the scroll interval. - * - * @return The scroll interval. + * @brief Notifies the decorator the whole text has been scrolled. */ - float GetScrollTickInterval() const; + void NotifyEndOfScroll(); protected: @@ -440,10 +544,11 @@ private: /** * @brief Private constructor. - * @param[in] parent Decorations will be added to this parent control. - * @param[in] observer A class which receives input events from Decorator components. + * @param[in] controller The controller which receives input events from Decorator components. + * @param[in] callbackInterface The text popup callback interface which receives the button click callbacks. */ - Decorator(Dali::Toolkit::Internal::Control& parent, Observer& observer ); + Decorator( ControllerInterface& controller, + TextSelectionPopupCallbackInterface& callbackInterface ); // Undefined Decorator( const Decorator& handle );