-#ifndef __DALI_TOOLKIT_TEXT_DECORATOR_H__
-#define __DALI_TOOLKIT_TEXT_DECORATOR_H__
+#ifndef DALI_TOOLKIT_TEXT_DECORATOR_H
+#define DALI_TOOLKIT_TEXT_DECORATOR_H
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <dali/public-api/common/intrusive-ptr.h>
#include <dali/public-api/object/ref-object.h>
#include <dali/public-api/math/rect.h>
-#include <dali/public-api/math/vector2.h>
+
+// INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup.h>
namespace Dali
{
-class Actor;
-class Image;
-class Vector2;
-class Vector4;
+struct Vector2;
+struct Vector4;
namespace Toolkit
{
-namespace Internal
-{
-class Control;
-}
-
namespace Text
{
GRAB_HANDLE,
LEFT_SELECTION_HANDLE,
RIGHT_SELECTION_HANDLE,
+ LEFT_SELECTION_HANDLE_MARKER,
+ RIGHT_SELECTION_HANDLE_MARKER,
HANDLE_TYPE_COUNT
};
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;
*
* @param[in] decoration The actor displaying a decoration.
*/
- virtual void AddDecoration( Actor& actor ) = 0;
+ virtual void AddDecoration( Actor& actor, bool needsClipping ) = 0;
/**
* @brief An input event from one of the handles.
* @brief Create a new instance of a Decorator.
*
* @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( ControllerInterface& controller );
+ static DecoratorPtr New( ControllerInterface& controller,
+ TextSelectionPopupCallbackInterface& callbackInterface );
/**
* @brief Set the bounding box which handles, popup and similar decorations will not exceed.
* @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.
*/
const Vector2& GetPosition( Cursor cursor ) const;
+
+ /**
+ * @brief Sets the glyph offset of a cursor.
+ *
+ * @param[in] cursor The cursor to set.
+ * @param[in] glyphoffset The difference of line ascender and glyph ascender.
+ */
+ void SetGlyphOffset( Cursor cursor, float glyphOffset );
+
+ /**
+ * @brief Retrieves the glyph offset of a cursor.
+ *
+ * @param[in] cursor The cursor to get.
+ *
+ * @return The glyph offset. glyph offset means difference of line ascender and glyph ascender.
+ */
+ const float GetGlyphOffset( Cursor cursor ) const;
+
/**
* @brief Sets the color for a cursor.
*
* @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.
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.
bool IsHandleActive( HandleType handleType ) const;
/**
- * @brief Sets the image for one of the handles.
+ * @brief Sets the image file name 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.
+ * @param[in] imageFileName The image filename to use.
*/
- void SetHandleImage( HandleType handleType, HandleImageType handleImageType, Dali::Image image );
+ void SetHandleImage( HandleType handleType, HandleImageType handleImageType, const std::string& imageFileName );
/**
- * @brief Retrieves the image for one of the handles.
+ * @brief Retrieves the file name of 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.
+ * @return The grab handle image string.
*/
- Dali::Image GetHandleImage( HandleType handleType, HandleImageType handleImageType ) const;
+ const std::string& 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.
void GetPosition( HandleType handleType, float& x, float& y, float& lineHeight ) const;
/**
- * @brief Adds a quad to the existing selection highlights.
+ * @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. Vertices are in decorator's coordinates.
*
- * @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.
+ * @param[in] index Position in the vector where to add the quad.
+ * @param[in] quad The quad. The 'x' and 'y' coordinates store the min 'x' and min 'y'. The 'z' and 'w' coordinates store the max 'x' and max 'y'.
*/
- void AddHighlight( float x1, float y1, float x2, float y2 );
+ void AddHighlight( unsigned int index, const Vector4& quad );
+
+ /**
+ * @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.
+ * @param[in] outlineOffset The outline's offset.
+ */
+ void SetHighLightBox( const Vector2& position,
+ const Size& size,
+ float outlineOffset );
/**
* @brief Removes all of the previously added highlights.
void ClearHighlights();
/**
+ * @brief Reserves space for the highlight quads.
+ *
+ * @param[in] numberOfQuads The expected number of quads.
+ */
+ void ResizeHighlightQuads( unsigned int numberOfQuads );
+
+ /**
* @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 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 Retreives whether the highlight is shown or not.
+ *
+ * @return true if the highlight is visible, false otherwise.
+ */
+ bool IsHighlightVisible() 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
*/
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.
* 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;
/**
- * @brief Sets the scroll interval.
- *
- * @param[in] seconds The scroll interval in seconds.
+ * @brief Notifies the decorator the whole text has been scrolled.
*/
- void SetScrollTickInterval( float seconds );
+ void NotifyEndOfScroll();
/**
- * @brief Retrieves the scroll interval.
- *
- * @return The scroll interval.
+ * @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()
*/
- float GetScrollTickInterval() const;
+ bool IsSmoothHandlePanEnabled() const;
protected:
/**
* @brief Private constructor.
* @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( ControllerInterface& controller );
+ Decorator( ControllerInterface& controller,
+ TextSelectionPopupCallbackInterface& callbackInterface );
// Undefined
Decorator( const Decorator& handle );
} // namespace Dali
-#endif // __DALI_TOOLKIT_TEXT_DECORATOR_H__
+#endif // DALI_TOOLKIT_TEXT_DECORATOR_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff