#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 Image;
-class Vector2;
-class Vector4;
+struct Vector2;
+struct Vector4;
namespace Toolkit
{
-namespace Internal
-{
-class Control;
-}
-
namespace Text
{
ACTIVE_CURSOR_BOTH ///< Both primary and secondary cursor are active
};
-// The state information for grab handle events
-enum GrabHandleState
-{
- GRAB_HANDLE_TAPPED,
- GRAB_HANDLE_PRESSED,
- GRAB_HANDLE_RELEASED,
- GRAB_HANDLE_SCROLLING,
- GRAB_HANDLE_STOP_SCROLLING
-};
-
-// Used to set different grab handle images
-enum GrabHandleImageType
+// The state information for handle events.
+enum HandleState
{
- GRAB_HANDLE_IMAGE_PRESSED,
- GRAB_HANDLE_IMAGE_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
};
/**
*
* 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 Query the target size of the UI control.
*
- * @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, bool needsClipping ) = 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.
+ * @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.
* @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.
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] type A different image can be set for the pressed/released states.
+ * @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( GrabHandleImageType type, 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.
*
- * @param[in] type A different image can be set for the pressed/released states.
* @return The grab handle image.
*/
- Dali::Image GetGrabHandleImage( GrabHandleImageType type ) const;
+ Dali::Image GetHandleImage( HandleType handleType, HandleImageType handleImageType ) const;
/**
- * @brief Sets whether the selection handles and highlight are active.
+ * @brief Sets the color of the handles
*
- * @param[in] active True if the selection handles and highlight are active.
+ * @param[in] color The color to use.
*/
- void SetSelectionActive( bool active );
+ void SetHandleColor( const Vector4& color );
/**
- * @brief Query whether the selection handles and highlight are active.
+ * @brief Retrieves the handles color.
*
- * @return True if the selection handles and highlight are active.
+ * @return The color of the handles.
*/
- bool IsSelectionActive() const;
+ const Vector4& GetHandleColor() const;
/**
* @brief Sets the position of a selection handle.
*
- * @param[in] handle The handle to set.
+ * @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 SetPosition( SelectionHandle handle, float x, float y, float lineHeight );
+ void SetPosition( HandleType handleType, float x, float y, float lineHeight );
/**
* @brief Retrieves the position of a selection handle.
*
- * @param[in] handle The handle to get.
+ * @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] cursorHeight The logical cursor height at this position.
- */
- void GetPosition( SelectionHandle handle, float& x, float& y, float& cursorHeight ) const;
-
- /**
- * @brief Sets the image for one of the selection handles.
- *
- * @param[in] state A different image can be set for the pressed/released states.
- * @param[in] image The image to use.
+ * @param[out] lineHeight The logical line height at this position.
*/
- void SetLeftSelectionImage( SelectionHandleState state, Dali::Image image );
+ void GetPosition( HandleType handleType, float& x, float& y, float& lineHeight ) const;
/**
- * @brief Retrieves the image for a selection handle.
+ * @brief Retrieves the position of a selection handle.
*
- * @param[in] state A different image can be set for the pressed/released states.
- * @return The image.
- */
- Dali::Image GetLeftSelectionImage( SelectionHandleState state ) const;
-
- /**
- * @brief Sets the image for one of the selection handles.
+ * @param[in] handleType The handle to get.
*
- * @param[in] state A different image can be set for the pressed/released states.
- * @param[in] image The image to use.
+ * @return The position of the selection handle relative to the top-left of the parent control.
*/
- void SetRightSelectionImage( SelectionHandleState state, Dali::Image image );
+ const Vector2& GetPosition( HandleType handleType ) const;
/**
- * @brief Retrieves the image for a selection handle.
+ * @brief Swaps the selection handle's images.
*
- * @param[in] state A different image can be set for the pressed/released states.
- * @return The image.
+ * This method is called by the text controller to swap the handles
+ * when the start index is bigger than the end one.
*/
- Dali::Image GetRightSelectionImage( SelectionHandleState state ) const;
+ void SwapSelectionHandlesEnabled( bool enable );
/**
* @brief Adds a quad to the existing selection highlights.
/**
* @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
*/
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.
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:
/**
* @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 );
projects / platform / core / uifw / dali-toolkit.git / blobdiff