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=b271b7b30abab039660597efcae74edef5ce5141;hp=9ea86c6d7bcfe0647d0f558b4d91fd52e043d184;hb=0a602bfd2ebfc87655895aaaabecce8de5c12d33;hpb=10d2080e1d25b75347daa2f8c2dcee494fbcb175 diff --git a/dali-toolkit/internal/text/decorator/text-decorator.h b/dali-toolkit/internal/text/decorator/text-decorator.h index 9ea86c6..b271b7b 100644 --- a/dali-toolkit/internal/text/decorator/text-decorator.h +++ b/dali-toolkit/internal/text/decorator/text-decorator.h @@ -22,10 +22,12 @@ #include #include #include +#include namespace Dali { +class Actor; class Image; class Vector2; class Vector4; @@ -60,26 +62,31 @@ enum ActiveCursor ACTIVE_CURSOR_BOTH ///< Both primary and secondary cursor are active }; -// The state information for grab handle events -enum GrabHandleState +// The state information for handle events. +enum HandleState { - GRAB_HANDLE_TAPPED, - GRAB_HANDLE_PRESSED, - GRAB_HANDLE_RELEASED + HANDLE_TAPPED, + HANDLE_PRESSED, + HANDLE_RELEASED, + HANDLE_SCROLLING, + HANDLE_STOP_SCROLLING }; -// The set the selection-handle positions etc. -enum SelectionHandle +// Used to set different handle images +enum HandleImageType { - PRIMARY_SELECTION_HANDLE, - SECONDARY_SELECTION_HANDLE, - SELECTION_HANDLE_COUNT + HANDLE_IMAGE_PRESSED, + HANDLE_IMAGE_RELEASED, + HANDLE_IMAGE_TYPE_COUNT }; -enum SelectionHandleState +// Types of handles. +enum HandleType { - SELECTION_HANDLE_PRESSED, - SELECTION_HANDLE_RELEASED + GRAB_HANDLE, + LEFT_SELECTION_HANDLE, + RIGHT_SELECTION_HANDLE, + HANDLE_TYPE_COUNT }; /** @@ -92,45 +99,59 @@ enum SelectionHandleState * * 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 An input event from the grab handle. + * @brief An input event from one of the handles. * - * @param[in] state The grab handle state. + * @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 ) = 0; + + /** + * @brief An input event from one of the handles. + * + * @param[in] handleType The handle's type. + * @param[in] state The handle's state. * @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 GrabHandleEvent( GrabHandleState 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. * @return A pointer to a new Decorator. */ - static DecoratorPtr New( Dali::Toolkit::Internal::Control& parent, Observer& observer ); + static DecoratorPtr New( ControllerInterface& controller ); /** * @brief Set the bounding box which handles, popup and similar decorations will not exceed. @@ -166,9 +187,15 @@ public: * @brief The decorator waits until a relayout before creating actors etc. * * @param[in] size The size of the parent control after size-negotiation. - * @param[in] scrollPosition The cursor, grab-handle positions etc. should be offset by this. */ - void Relayout( const Dali::Vector2& size, const Vector2& scrollPosition ); + void Relayout( const Dali::Vector2& size ); + + /** + * @brief Updates the decorator's actor positions after scrolling. + * + * @param[in] scrollOffset The scroll offset. + */ + void UpdatePositions( const Vector2& scrollOffset ); /** * @brief Sets which of the cursors are active. @@ -191,19 +218,30 @@ public: * @param[in] cursor The cursor to set. * @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. - * @param[in] height The logical height of the cursor. + * @param[in] cursorHeight The logical height of the cursor. + * @param[in] lineHeight The logical height of the line. */ - void SetPosition( Cursor cursor, float x, float y, float height ); + void SetPosition( Cursor cursor, float x, float y, float cursorHeight, float lineHeight ); /** - * @brief Retrieves the position of a cursor. + * @brief Retrieves the position, height and lineHeight of a cursor. * * @param[in] cursor The cursor to get. * @param[out] x The x position relative to the top-left of the parent control. * @param[out] y The y position relative to the top-left of the parent control. - * @param[out] height The logical height of the cursor. + * @param[out] cursorHeight The logical height of the cursor. + * @param[out] lineHeight The logical height of the line. */ - void GetPosition( Cursor cursor, float& x, float& y, float& height ) const; + void GetPosition( Cursor cursor, float& x, float& y, float& cursorHeight, float& lineHeight ) const; + + /** + * @brief Retrieves the position of a cursor. + * + * @param[in] cursor The cursor to get. + * + * @return The position. + */ + const Vector2& GetPosition( Cursor cursor ) const; /** * @brief Sets the color for a cursor. @@ -260,95 +298,150 @@ public: float GetCursorBlinkDuration() const; /** - * @brief Sets whether the grab handle is active. + * @brief Sets whether a handle is active. * - * @note The grab handle follows the cursor position set with SetPosition(Cursor, ...) - * @param[in] active True if the grab handle should be active. + * @param[in] handleType One of the handles. + * @param[in] active True if the handle should be active. */ - void SetGrabHandleActive( bool active ); + void SetHandleActive( HandleType handleType, + bool active ); /** - * @brief Query whether the grab handle is active. + * @brief Query whether a handle is active. * - * @return True if the grab handle should be active. + * @param[in] handleType One of the handles. + * + * @return True if the handle is active. */ - bool IsGrabHandleActive() const; + bool IsHandleActive( HandleType handleType ) const; /** - * @brief Sets the image for the grab handle. + * @brief Sets the image for one of the handles. * + * @param[in] handleType One of the handles. + * @param[in] handleImageType A different image can be set for the pressed/released states. * @param[in] image The image to use. */ - void SetGrabHandleImage( Dali::Image image ); + void SetHandleImage( HandleType handleType, HandleImageType handleImageType, Dali::Image image ); /** - * @brief Retrieves the image for the grab handle. + * @brief Retrieves the image for one of the handles. + * + * @param[in] handleType One of the handles. + * @param[in] handleImageType A different image can be set for the pressed/released states. * * @return The grab handle image. */ - Dali::Image GetGrabHandleImage() const; + Dali::Image GetHandleImage( HandleType handleType, HandleImageType handleImageType ) const; /** - * @brief Sets whether the selection handles and highlight are active. + * @brief Sets the position of a selection handle. * - * @param[in] active True if the selection handles and highlight are active. + * @param[in] handleType The handle to set. + * @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. + * @param[in] lineHeight The logical line height at this position. */ - void SetSelectionActive( bool active ); + void SetPosition( HandleType handleType, float x, float y, float lineHeight ); /** - * @brief Query whether the selection handles and highlight are active. + * @brief Retrieves the position of a selection handle. * - * @return True if the selection handles and highlight are active. + * @param[in] handleType The handle to get. + * @param[out] x The x position relative to the top-left of the parent control. + * @param[out] y The y position relative to the top-left of the parent control. + * @param[out] lineHeight The logical line height at this position. */ - bool IsSelectionActive() const; + void GetPosition( HandleType handleType, float& x, float& y, float& lineHeight ) const; /** - * @brief Sets the position of a selection handle. + * @brief Adds a quad to the existing selection highlights. * - * @param[in] handle The handle to set. - * @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. - * @param[in] cursorHeight The logical cursor height at this position. + * @param[in] x1 The top-left x position. + * @param[in] y1 The top-left y position. + * @param[in] x2 The bottom-right x position. + * @param[in] y3 The bottom-right y position. */ - void SetPosition( SelectionHandle handle, float x, float y, float cursorHeight ); + void AddHighlight( float x1, float y1, float x2, float y2 ); /** - * @brief Retrieves the position of a selection handle. - * - * @param[in] handle The handle to get. - * @param[out] x The x position relative to the top-left of the parent control. - * @param[out] y The y position relative to the top-left of the parent control. - * @param[out] cursorHeight The logical cursor height at this position. + * @brief Removes all of the previously added highlights. */ - void GetPosition( SelectionHandle handle, float& x, float& y, float& cursorHeight ) const; + void ClearHighlights(); /** - * @brief Sets the image for one of the selection handles. + * @brief Sets the selection highlight color. * - * @param[in] handle The selection handle. - * @param[in] state A different image can be set for the pressed/released states. * @param[in] image The image to use. */ - void SetImage( SelectionHandle handle, SelectionHandleState state, Dali::Image image ); + void SetHighlightColor( const Vector4& color ); /** - * @brief Retrieves the image for a selection handle. + * @brief Retrieves the selection highlight color. * - * @param[in] handle The selection handle. - * @param[in] state A different image can be set for the pressed/released states. * @return The image. */ - Dali::Image GetImage( SelectionHandle handle, SelectionHandleState state ) const; + const Vector4& GetHighlightColor() const; + + /** + * @brief Set the Selection Popup to show or hide via the active flaf + * @param[in] active true to show, false to hide + */ + void SetPopupActive( bool active ); + + /** + * @brief Query whether the Selection Popup is active. + * + * @return True if the Selection Popup should be active. + */ + bool IsPopupActive() const; /** - * @brief Show the Copy and Paste Popup + * @brief Sets the scroll threshold. + * + * 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. */ - void ShowPopup(); + void SetScrollThreshold( float threshold ); /** - * @brief Hide the Copy and Paste Popup + * @brief Retrieves the scroll threshold. + * + * @retunr The scroll threshold. + */ + float GetScrollThreshold() const; + + /** + * @brief Sets the scroll speed. + * + * Is the distance the text is going to be scrolled during a scroll interval. + * + * @param[in] speed The scroll speed. + */ + void SetScrollSpeed( float speed ); + + /** + * @brief Retrieves the scroll speed. + * + * @return The scroll speed. + */ + 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. */ - void HidePopup(); + float GetScrollTickInterval() const; protected: @@ -361,10 +454,9 @@ 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. */ - Decorator(Dali::Toolkit::Internal::Control& parent, Observer& observer ); + Decorator( ControllerInterface& controller ); // Undefined Decorator( const Decorator& handle );