#define DALI_TOOLKIT_TEXT_CONTROLLER_H
/*
- * Copyright (c) 2018 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-toolkit/internal/text/layouts/layout-engine.h>
#include <dali-toolkit/internal/text/hidden-text.h>
#include <dali-toolkit/internal/text/text-model-interface.h>
+#include <dali-toolkit/internal/text/text-selectable-control-interface.h>
namespace Dali
{
class View;
class RenderingController;
+ /**
+ * @brief Text selection operations .
+ */
+ enum SelectionType
+ {
+ INTERACTIVE = 0x0000,
+ ALL = 0x0001,
+ NONE = 0x0002
+ };
+
typedef IntrusivePtr<Controller> ControllerPtr;
/**
*
* @param[in] controlInterface The control's interface.
* @param[in] editableControlInterface The editable control's interface.
+ * @param[in] selectableControlInterface The selectable control's interface.
*
* @return A pointer to a new Controller.
*/
static ControllerPtr New( ControlInterface* controlInterface,
- EditableControlInterface* editableControlInterface );
+ EditableControlInterface* editableControlInterface,
+ SelectableControlInterface* selectableControlInterface );
public: // Configure the text controller.
*/
void UpdateAfterFontChange( const std::string& newDefaultFont );
+ /**
+ * @brief The method acquires currently selected text
+ * @param selectedText variable to place selected text in
+ */
+ void RetrieveSelection( std::string& selectedText ) const;
+
+ /**
+ * @brief The method sets selection in given range
+ * @param start index of first character
+ * @param end index of first character after selection
+ */
+ void SetSelection( int start, int end );
+
+ /**
+ * @brief This method retrieve indexes of current selection
+ *
+ * @return a pair, where first element is left index of selection and second is the right one
+ */
+ std::pair< int, int > GetSelectionIndexes() const;
+
+ /**
+ * Place string in system clipboard
+ * @param source std::string
+ */
+ void CopyStringToClipboard( const std::string& source );
+
+ /**
+ * Place currently selected text in system clipboard
+ * @param deleteAfterSending flag pointing if text should be deleted after sending to clipboard
+ */
+ void SendSelectionToClipboard( bool deleteAfterSending );
+
public: // Default style & Input style
/**
float GetDefaultFontSize( FontSizeType type ) const;
/**
+ * @brief Set the font size scale.
+ *
+ * @param[in] scale The font size scale
+ */
+ void SetFontSizeScale( float scale );
+
+ /**
+ * @brief Get the font size scale.
+ *
+ * @return The font size scale.
+ */
+ float GetFontSizeScale() const;
+
+ /**
* @brief Sets the Placeholder text font size.
* @param[in] fontSize The placeholder text font size
* @param[in] type The font size type is point size or pixel size
float GetDefaultLineSpacing() const;
/**
+ * @brief Sets the default line size.
+ *
+ * @param[in] lineSize The line size.
+ *
+ * @return True if lineSize has been updated, false otherwise
+ */
+ bool SetDefaultLineSize( float lineSize );
+
+ /**
+ * @brief Retrieves the default line size.
+ *
+ * @return The line size.
+ */
+ float GetDefaultLineSize() const;
+
+ /**
* @brief Sets the input text's color.
*
* @param[in] color The input text's color.
* @param[in] state The state of the gesture.
* @param[in] displacement This distance panned since the last pan gesture.
*/
- void PanEvent( Gesture::State state, const Vector2& displacement );
+ void PanEvent( GestureState state, const Vector2& displacement );
/**
* @brief Called by editable UI controls when a long press gesture occurs.
* @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.
*/
- void LongPressEvent( Gesture::State state, float x, float y );
+ void LongPressEvent( GestureState state, float x, float y );
+
+ /**
+ * @brief Used to get the Primary cursor position.
+ *
+ * @return Primary cursor position.
+ */
+ CharacterIndex GetPrimaryCursorPosition() const;
+
+ /**
+ * @brief Used to set the Primary cursor position.
+ *
+ * @param[in] index for the Primary cursor position.
+ * @return[in] true if cursor position changed, false otherwise.
+ */
+ bool SetPrimaryCursorPosition( CharacterIndex index );
/**
* @brief Creates a selection event.
*
* @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] selectAll Whether the whole text is selected.
+ * @param[in] selection type like the whole text is selected or unselected.
+ */
+ void SelectEvent( float x, float y, SelectionType selection );
+
+ /**
+ * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
*/
- void SelectEvent( float x, float y, bool selectAll );
+ void SetTextSelectionRange(const uint32_t *start, const uint32_t *end);
+
+ /**
+ * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
+ */
+ Uint32Pair GetTextSelectionRange() const;
+
+ /**
+ * @copydoc Text::SelectableControlInterface::SelectWholeText()
+ */
+ void SelectWholeText();
+
+ /**
+ * @copydoc Text::SelectableControlInterface::SelectNone()
+ */
+ void SelectNone();
+
+ /**
+ * @copydoc Text::SelectableControlInterface::GetSelectedText()
+ */
+ string GetSelectedText() const;
+
+ /**
+ * @copydoc Text::EditableControlInterface::IsEditable()
+ */
+ virtual bool IsEditable() const;
+
+ /**
+ * @copydoc Text::EditableControlInterface::SetEditable()
+ */
+ virtual void SetEditable( bool editable );
+
+ /**
+ * @copydoc Dali::Toolkit::Internal::TextEditor::ScrollBy()
+ */
+ virtual void ScrollBy( Vector2 scroll );
+
+ /**
+ * @copydoc Dali::Toolkit::Internal::TextEditor::GetHorizontalScrollPosition()
+ */
+ float GetHorizontalScrollPosition();
+
+ /**
+ * @copydoc Dali::Toolkit::Internal::TextEditor::GetVerticalScrollPosition()
+ */
+ float GetVerticalScrollPosition();
/**
* @brief Event received from input method context
*/
bool ShouldClearFocusOnEscape() const;
+ /**
+ * @brief Create an actor that renders the text background color
+ *
+ * @return the created actor or an empty handle if no background color needs to be rendered.
+ */
+ Actor CreateBackgroundActor();
+
+ /**
+ * @brief Used to reset the cursor position after setting a new text.
+ *
+ * @param[in] cursorIndex Where to place the cursor.
+ */
+ void ResetCursorPosition( CharacterIndex cursorIndex );
+
+ /**
+ * @brief The method acquires current position of cursor
+ * @return unsigned value with cursor position
+ */
+ CharacterIndex GetCursorPosition();
+
protected: // Inherit from Text::Decorator::ControllerInterface.
/**
* @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
*/
- virtual void GetTargetSize( Vector2& targetSize );
+ void GetTargetSize( Vector2& targetSize ) override;
/**
* @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
*/
- virtual void AddDecoration( Actor& actor, bool needsClipping );
+ void AddDecoration( Actor& actor, bool needsClipping ) override;
/**
* @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
*/
- virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
+ void DecorationEvent( HandleType handle, HandleState state, float x, float y ) override;
protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
/**
* @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
*/
- virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
+ void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button ) override;
protected: // Inherit from HiddenText.
/**
* @brief Invoked from HiddenText when showing time of the last character was expired
*/
- virtual void DisplayTimeExpired();
+ void DisplayTimeExpired() override;
private: // Update.
void ClearStyleData();
/**
- * @brief Used to reset the cursor position after setting a new text.
- *
- * @param[in] cursorIndex Where to place the cursor.
- */
- void ResetCursorPosition( CharacterIndex cursorIndex );
-
- /**
* @brief Used to reset the scroll position after setting a new text.
*/
void ResetScrollPosition();
* @brief Private constructor.
*/
Controller( ControlInterface* controlInterface,
- EditableControlInterface* editableControlInterface );
+ EditableControlInterface* editableControlInterface,
+ SelectableControlInterface* selectableControlInterface );
// Undefined
Controller( const Controller& handle );
private:
+ struct EventHandler;
+ struct InputFontHandler;
+ struct PlaceholderHandler;
+ struct Relayouter;
+ struct TextUpdater;
+
Impl* mImpl;
};
projects / platform / core / uifw / dali-toolkit.git / blobdiff