X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Ftext-controller.h;h=069db55d8d9ba31dfc190d1a5fe2b453a82fc171;hb=29a52105283ce8ced672ed92545daeacf882316a;hp=304ad2f8aac76a78ab88b32a1079ad30687b1e21;hpb=4a2c09ae826a352ce60c50f9986167ae3d3e6693;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h index 304ad2f..069db55 100644 --- a/dali-toolkit/internal/text/text-controller.h +++ b/dali-toolkit/internal/text/text-controller.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_H__ -#define __DALI_TOOLKIT_TEXT_CONTROLLER_H__ +#ifndef DALI_TOOLKIT_TEXT_CONTROLLER_H +#define DALI_TOOLKIT_TEXT_CONTROLLER_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2022 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. @@ -19,39 +19,44 @@ */ // EXTERNAL INCLUDES -#include +#include #include // INTERNAL INCLUDES +#include +#include #include +#include #include +#include +#include #include -#include +#include +#include +#include +#include -namespace Dali +namespace Dali::Toolkit::Text { - -namespace Toolkit -{ - -namespace Text -{ - class Controller; +class ControlInterface; +class EditableControlInterface; class View; - -typedef IntrusivePtr ControllerPtr; -typedef Dali::Toolkit::Text::ControlInterface ControlInterface; +class RenderingController; /** - * @brief Different placeholder-text can be shown when the control is active/inactive. - */ -enum PlaceholderType + * @brief Text selection operations . + */ +enum SelectionType { - PLACEHOLDER_TYPE_ACTIVE, - PLACEHOLDER_TYPE_INACTIVE, + INTERACTIVE = 0x0000, ///< Select the word where the cursor is located. + ALL = 0x0001, ///< Select the whole text. + NONE = 0x0002, ///< Unselect the whole text. + RANGE = 0x0003 ///< Select the range text. }; +typedef IntrusivePtr ControllerPtr; + /** * @brief A Text Controller is used by UI Controls which display text. * @@ -63,10 +68,9 @@ enum PlaceholderType * * The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface. */ -class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface +class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface, public HiddenText::Observer { -public: - +public: // Enumerated types. /** * @brief Text related operations to be done in the relayout process. */ @@ -77,21 +81,20 @@ public: GET_SCRIPTS = 0x0002, VALIDATE_FONTS = 0x0004, GET_LINE_BREAKS = 0x0008, - GET_WORD_BREAKS = 0x0010, - BIDI_INFO = 0x0020, - SHAPE_TEXT = 0x0040, - GET_GLYPH_METRICS = 0x0080, - LAYOUT = 0x0100, - UPDATE_ACTUAL_SIZE = 0x0200, - REORDER = 0x0400, - ALIGN = 0x0800, - COLOR = 0x1000, - UPDATE_DIRECTION = 0x2000, + BIDI_INFO = 0x0010, + SHAPE_TEXT = 0x0020, + GET_GLYPH_METRICS = 0x0040, + LAYOUT = 0x0080, + UPDATE_LAYOUT_SIZE = 0x0100, + REORDER = 0x0200, + ALIGN = 0x0400, + COLOR = 0x0800, + UPDATE_DIRECTION = 0x1000, ALL_OPERATIONS = 0xFFFF }; /** - * @brief Used to distinguish between regular key events and IMF events + * @brief Used to distinguish between regular key events and InputMethodContext events */ enum InsertType { @@ -108,35 +111,116 @@ public: DONT_UPDATE_INPUT_STYLE }; + /** + * @brief Used to specify what has been updated after the Relayout() method has been called. + */ enum UpdateTextType { - NONE_UPDATED = 0x0, - MODEL_UPDATED = 0x1, - DECORATOR_UPDATED = 0x2 + NONE_UPDATED = 0x0, ///< Nothing has been updated. + MODEL_UPDATED = 0x1, ///< The text's model has been updated. + DECORATOR_UPDATED = 0x2 ///< The decoration has been updated. + }; + + /** + * @brief Different placeholder-text can be shown when the control is active/inactive. + */ + enum PlaceholderType + { + PLACEHOLDER_TYPE_ACTIVE, + PLACEHOLDER_TYPE_INACTIVE, + }; + + /** + * @brief Enumeration for Font Size Type. + */ + enum FontSizeType + { + POINT_SIZE, // The size of font in points. + PIXEL_SIZE // The size of font in pixels. + }; + + struct NoTextTap + { + enum Action + { + NO_ACTION, ///< Does no action if there is a tap on top of an area with no text. + HIGHLIGHT, ///< Highlights the nearest text (at the beginning or end of the text) and shows the text's selection popup. + SHOW_SELECTION_POPUP ///< Shows the text's selection popup. + }; }; + struct TextFitInfo + { + enum Property + { + TEXT_FIT_ENABLE, + TEXT_FIT_MIN_SIZE, + TEXT_FIT_MAX_SIZE, + TEXT_FIT_STEP_SIZE, + TEXT_FIT_FONT_SIZE_TYPE + }; + }; + +public: // Constructor. + /** + * @brief Create a new instance of a Controller. + * + * @return A pointer to a new Controller. + */ + static ControllerPtr New() + { + return ControllerPtr(new Controller()); + } + + /** + * @brief Create a new instance of a Controller. + * + * @param[in] controlInterface The control's interface. + * + * @return A pointer to a new Controller. + */ + static ControllerPtr New(ControlInterface* controlInterface) + { + return ControllerPtr(new Controller(controlInterface)); + } + /** * @brief Create a new instance of a Controller. * - * @param[in] controlInterface An interface used to request a text relayout. + * @param[in] controlInterface The control's interface. + * @param[in] editableControlInterface The editable control's interface. + * @param[in] selectableControlInterface The selectable control's interface. + * @param[in] anchorControlInterface The anchor control's interface. + * * @return A pointer to a new Controller. */ - static ControllerPtr New( ControlInterface& controlInterface ); + static ControllerPtr New(ControlInterface* controlInterface, + EditableControlInterface* editableControlInterface, + SelectableControlInterface* selectableControlInterface, + AnchorControlInterface* anchorControlInterface) + { + return ControllerPtr(new Controller(controlInterface, + editableControlInterface, + selectableControlInterface, + anchorControlInterface)); + } +public: // Configure the text controller. /** * @brief Called to enable text input. * * @note Selectable or editable controls should call this once after Controller::New(). * @param[in] decorator Used to create cursor, selection handle decorations etc. + * @param[in] inputMethodContext Used to manager ime. */ - void EnableTextInput( DecoratorPtr decorator ); + void EnableTextInput(DecoratorPtr decorator, InputMethodContext& inputMethodContext); /** * @brief Used to switch between bitmap & vector based glyphs * * @param[in] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different. */ - void SetGlyphType( TextAbstraction::GlyphType glyphType ); + void SetGlyphType(TextAbstraction::GlyphType glyphType); /** * @brief Enables/disables the mark-up processor. @@ -145,7 +229,7 @@ public: * * @param[in] enable Whether to enable the mark-up processor. */ - void SetMarkupProcessorEnabled( bool enable ); + void SetMarkupProcessorEnabled(bool enable); /** * @brief Retrieves whether the mark-up processor is enabled. @@ -157,13 +241,20 @@ public: bool IsMarkupProcessorEnabled() const; /** + * @brief Retrieves whether the current text contains anchors. + * + * @return @e true if the current text contains anchors. @e false. + */ + bool HasAnchors() const; + + /** * @brief Enables/disables the auto text scrolling * * By default is disabled. * * @param[in] enable Whether to enable the auto scrolling */ - void SetAutoScrollEnabled( bool enable ); + void SetAutoScrollEnabled(bool enable); /** * @brief Retrieves whether auto text scrolling is enabled. @@ -192,7 +283,7 @@ public: * * @param[in] enable Whether to enable the horizontal scrolling. */ - void SetHorizontalScrollEnabled( bool enable ); + void SetHorizontalScrollEnabled(bool enable); /** * @brief Retrieves whether the horizontal scrolling is enabled. @@ -206,7 +297,7 @@ public: * * @param[in] enable Whether to enable the vertical scrolling. */ - void SetVerticalScrollEnabled( bool enable ); + void SetVerticalScrollEnabled(bool enable); /** * @brief Retrieves whether the verticall scrolling is enabled. @@ -220,7 +311,7 @@ public: * * @param[in] enable Whether to enable the smooth handle panning. */ - void SetSmoothHandlePanEnabled( bool enable ); + void SetSmoothHandlePanEnabled(bool enable); /** * @brief Retrieves whether the smooth handle panning is enabled. @@ -230,35 +321,413 @@ public: bool IsSmoothHandlePanEnabled() const; /** - * @brief Replaces any text previously set. + * @brief Sets the maximum number of characters that can be inserted into the TextModel * - * @note This will be converted into UTF-32 when stored in the text model. - * @param[in] text A string of UTF-8 characters. + * @param[in] maxCharacters maximum number of characters to be accepted */ - void SetText( const std::string& text ); + void SetMaximumNumberOfCharacters(Length maxCharacters); /** - * @brief Retrieve any text previously set. + * @brief Sets the maximum number of characters that can be inserted into the TextModel * - * @param[out] text A string of UTF-8 characters. + * @param[in] maxCharacters maximum number of characters to be accepted + */ + int GetMaximumNumberOfCharacters(); + + /** + * @brief Called to enable/disable cursor blink. + * + * @note Only editable controls should calls this. + * @param[in] enabled Whether the cursor should blink or not. + */ + void SetEnableCursorBlink(bool enable); + + /** + * @brief Query whether cursor blink is enabled. + * + * @return Whether the cursor should blink or not. + */ + bool GetEnableCursorBlink() const; + + /** + * @brief Whether to enable the multi-line layout. + * + * @param[in] enable \e true enables the multi-line (by default) + */ + void SetMultiLineEnabled(bool enable); + + /** + * @return Whether the multi-line layout is enabled. + */ + bool IsMultiLineEnabled() const; + + /** + * @brief Sets the text's horizontal alignment. + * + * @param[in] alignment The horizontal alignment. + */ + void SetHorizontalAlignment(HorizontalAlignment::Type alignment); + + /** + * @copydoc ModelInterface::GetHorizontalAlignment() + */ + HorizontalAlignment::Type GetHorizontalAlignment() const; + + /** + * @brief Sets the text's vertical alignment. + * + * @param[in] alignment The vertical alignment. + */ + void SetVerticalAlignment(VerticalAlignment::Type alignment); + + /** + * @copydoc ModelInterface::GetVerticalAlignment() + */ + VerticalAlignment::Type GetVerticalAlignment() const; + + /** + * @brief Sets the text's wrap mode + * @param[in] text wrap mode The unit of wrapping + */ + void SetLineWrapMode(Text::LineWrap::Mode textWarpMode); + + /** + * @brief Retrieve text wrap mode previously set. + * @return text wrap mode + */ + Text::LineWrap::Mode GetLineWrapMode() const; + + /** + * @brief Enable or disable the text elide. + * + * @param[in] enabled Whether to enable the text elide. + */ + void SetTextElideEnabled(bool enabled); + + /** + * @copydoc ModelInterface::IsTextElideEnabled() + */ + bool IsTextElideEnabled() const; + + /** + * @brief Enable or disable the text fit. + * + * @param[in] enabled Whether to enable the text fit. + */ + void SetTextFitEnabled(bool enabled); + + /** + * @brief Whether the text fit is enabled or not. + * + * @return True if the text fit is enabled + */ + bool IsTextFitEnabled() const; + + /** + * @brief Sets minimum size valid for text fit. + * + * @param[in] minimum size value. + * @param[in] type The font size type is point size or pixel size + */ + void SetTextFitMinSize(float pointSize, FontSizeType type); + + /** + * @brief Retrieves the minimum point size valid for text fit. + * + * @return The minimum point size valid for text fit + */ + float GetTextFitMinSize() const; + + /** + * @brief Sets maximum size valid for text fit. + * + * @param[in] maximum size value. + * @param[in] type The font size type is point size or pixel size + */ + void SetTextFitMaxSize(float pointSize, FontSizeType type); + + /** + * @brief Retrieves the maximum point size valid for text fit. + * + * @return The maximum point size valid for text fit + */ + float GetTextFitMaxSize() const; + + /** + * @brief Sets step size for font increase valid for text fit. + * + * @param[in] step size value. + * @param[in] type The font size type is point size or pixel size + */ + void SetTextFitStepSize(float step, FontSizeType type); + + /** + * @brief Retrieves the step point size valid for text fit. + * + * @return The step point size valid for text fit + */ + float GetTextFitStepSize() const; + + /** + * @brief Sets content size valid for text fit. + * + * @param[in] Content size value. + */ + void SetTextFitContentSize(Vector2 size); + + /** + * @brief Retrieves the content size valid for text fit. + * + * @return The content size valid for text fit + */ + Vector2 GetTextFitContentSize() const; + + /** + * @brief Retrieve the fited point size. + * + * @return The fited point size. + */ + float GetTextFitPointSize() const; + + /** + * @brief Sets whether the text fit properties have changed. + * + * @param[in] changed Whether to changed the text fit. + */ + void SetTextFitChanged(bool changed); + + /** + * @brief Whether the text fit properties are changed or not. + * + * @return True if the text fit properties are changed + */ + bool IsTextFitChanged() const; + + /** + * @brief Enable or disable the placeholder text elide. + * @param enabled Whether to enable the placeholder text elide. + */ + void SetPlaceholderTextElideEnabled(bool enabled); + + /** + * @brief Whether the placeholder text elide property is enabled. + * @return True if the placeholder text elide property is enabled, false otherwise. + */ + bool IsPlaceholderTextElideEnabled() const; + + /** + * @brief Enable or disable the text selection. + * @param[in] enabled Whether to enable the text selection. + */ + void SetSelectionEnabled(bool enabled); + + /** + * @brief Whether the text selection is enabled or not. + * @return True if the text selection is enabled + */ + bool IsSelectionEnabled() const; + + /** + * @brief Enable or disable the text selection using Shift key. + * @param enabled Whether to enable the text selection using Shift key + */ + void SetShiftSelectionEnabled(bool enabled); + + /** + * @brief Whether the text selection using Shift key is enabled or not. + * @return True if the text selection using Shift key is enabled + */ + bool IsShiftSelectionEnabled() const; + + /** + * @brief Enable or disable the grab handles for text selection. + * + * @param[in] enabled Whether to enable the grab handles + */ + void SetGrabHandleEnabled(bool enabled); + + /** + * @brief Returns whether the grab handles are enabled. + * + * @return True if the grab handles are enabled + */ + bool IsGrabHandleEnabled() const; + + /** + * @brief Enable or disable the grab handles for text selection. + * + * @param[in] enabled Whether to enable the grab handles + */ + void SetGrabHandlePopupEnabled(bool enabled); + + /** + * @brief Returns whether the grab handles are enabled. + * + * @return True if the grab handles are enabled + */ + bool IsGrabHandlePopupEnabled() const; + + /** + * @brief Sets input type to password + * + * @note The string is displayed hidden character + * + * @param[in] passwordInput True if password input is enabled. + */ + void SetInputModePassword(bool passwordInput); + + /** + * @brief Returns whether the input mode type is set as password. + * + * @return True if input mode type is password + */ + bool IsInputModePassword(); + + /** + * @brief Sets the action when there is a double tap event on top of a text area with no text. + * + * @param[in] action The action to do. + */ + void SetNoTextDoubleTapAction(NoTextTap::Action action); + + /** + * @brief Retrieves the action when there is a double tap event on top of a text area with no text. + * + * @return The action to do. + */ + NoTextTap::Action GetNoTextDoubleTapAction() const; + + /** + * @briefSets the action when there is a long press event on top of a text area with no text. + * + * @param[in] action The action to do. + */ + void SetNoTextLongPressAction(NoTextTap::Action action); + + /** + * @brief Retrieves the action when there is a long press event on top of a text area with no text. + * + * @return The action to do. + */ + NoTextTap::Action GetNoTextLongPressAction() const; + + /** + * @brief Query if Underline settings were provided by string or map + * @return bool true if set by string + */ + bool IsUnderlineSetByString(); + + /** + * Set method underline setting were set by + * @param[in] bool, true if set by string + */ + void UnderlineSetByString(bool setByString); + + /** + * @brief Query if shadow settings were provided by string or map + * @return bool true if set by string + */ + bool IsShadowSetByString(); + + /** + * Set method shadow setting were set by + * @param[in] bool, true if set by string + */ + void ShadowSetByString(bool setByString); + + /** + * @brief Query if outline settings were provided by string or map + * @return bool true if set by string + */ + bool IsOutlineSetByString(); + + /** + * Set method outline setting were set by + * @param[in] bool, true if set by string + */ + void OutlineSetByString(bool setByString); + + /** + * @brief Query if font style settings were provided by string or map + * @return bool true if set by string + */ + bool IsFontStyleSetByString(); + + /** + * Set method font style setting were set by + * @param[in] bool, true if set by string + */ + void FontStyleSetByString(bool setByString); + + /** + * @brief Query if Strikethrough settings were provided by string or map + * @return bool true if set by string */ - void GetText( std::string& text ) const; + bool IsStrikethroughSetByString(); /** - * @brief Remove a given number of characters + * Set method Strikethrough setting were set by + * @param[in] bool, true if set by string + */ + void StrikethroughSetByString(bool setByString); + + /** + * @brief Set the override used for strikethrough height, 0 indicates height will be supplied by font metrics + * + * @param[in] height The height in pixels of the strikethrough + */ + void SetStrikethroughHeight(float height); + + /** + * @brief Retrieves the override height of an strikethrough, 0 indicates height is supplied by font metrics + * + * @return The height of the strikethrough, or 0 if height is not overrided. + */ + float GetStrikethroughHeight() const; + + /** + * @brief Set the strikethrough color. + * + * @param[in] color color of strikethrough. + */ + void SetStrikethroughColor(const Vector4& color); + + /** + * @brief Retrieve the strikethrough color. + * + * @return The strikethrough color. + */ + const Vector4& GetStrikethroughColor() const; + + /** + * @brief Set the strikethrough enabled flag. + * + * @param[in] enabled The strikethrough enabled flag. + */ + void SetStrikethroughEnabled(bool enabled); + + /** + * @brief Returns whether the text has a strikethrough or not. + * + * @return The strikethrough state. + */ + bool IsStrikethroughEnabled() const; + +public: // Update. + /** + * @brief Replaces any text previously set. * - * When predictve text is used the pre-edit text is removed and inserted again with the new characters. - * The UpdateInputStyleType @type parameter if set to DONT_UPDATE_INPUT_STYLE avoids to update the input - * style when pre-edit text is removed. + * @note This will be converted into UTF-32 when stored in the text model. + * @param[in] text A string of UTF-8 characters. + */ + void SetText(const std::string& text); + + /** + * @brief Retrieve any text previously set. * - * @param[in] cursorOffset Start position from the current cursor position to start deleting characters. - * @param[in] numberOfCharacters The number of characters to delete from the cursorOffset. - * @param[in] type Whether to update the input style. - * @return True if the remove was successful. + * @param[out] text A string of UTF-8 characters. */ - bool RemoveText( int cursorOffset, - int numberOfCharacters, - UpdateInputStyleType type ); + void GetText(std::string& text) const; /** * @brief Replaces any placeholder text previously set. @@ -266,7 +735,7 @@ public: * @param[in] type Different placeholder-text can be shown when the control is active/inactive. * @param[in] text A string of UTF-8 characters. */ - void SetPlaceholderText( PlaceholderType type, const std::string& text ); + void SetPlaceholderText(PlaceholderType type, const std::string& text); /** * @brief Retrieve any placeholder text previously set. @@ -274,28 +743,53 @@ public: * @param[in] type Different placeholder-text can be shown when the control is active/inactive. * @param[out] A string of UTF-8 characters. */ - void GetPlaceholderText( PlaceholderType type, std::string& text ) const; + void GetPlaceholderText(PlaceholderType type, std::string& text) const; /** - * @brief Sets the maximum number of characters that can be inserted into the TextModel - * - * @param[in] maxCharacters maximum number of characters to be accepted + * @ brief Update the text after a font change + * @param[in] newDefaultFont The new font to change to */ - void SetMaximumNumberOfCharacters( Length maxCharacters ); + void UpdateAfterFontChange(const std::string& newDefaultFont); /** - * @brief Sets the maximum number of characters that can be inserted into the TextModel + * @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 * - * @param[in] maxCharacters maximum number of characters to be accepted + * @return a pair, where first element is left index of selection and second is the right one */ - int GetMaximumNumberOfCharacters(); + std::pair 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 + /** * @brief Set the default font family. * * @param[in] defaultFontFamily The default font family. */ - void SetDefaultFontFamily( const std::string& defaultFontFamily ); + void SetDefaultFontFamily(const std::string& defaultFontFamily); /** * @brief Retrieve the default font family. @@ -305,27 +799,29 @@ public: const std::string& GetDefaultFontFamily() const; /** - * @brief Sets the font's style string. - * - * @note The style set may be changed by the underlying font system. The string is stored to be recovered. - * - * @param[in] style The font's style string. + * @brief Sets the placeholder text font family. + * @param[in] placeholderTextFontFamily The placeholder text font family. */ - void SetDefaultFontStyle( const std::string& style ); + void SetPlaceholderFontFamily(const std::string& placeholderTextFontFamily); /** - * @brief Retrieves the font's style. + * @brief Retrieves the placeholder text font family. * - * @return The font's style. + * @return The placeholder text font family */ - const std::string& GetDefaultFontStyle() const; + const std::string& GetPlaceholderFontFamily() const; /** * @brief Sets the default font weight. * * @param[in] weight The font weight. */ - void SetDefaultFontWeight( FontWeight weight ); + void SetDefaultFontWeight(FontWeight weight); + + /** + * @brief Whether the font's weight has been defined. + */ + bool IsDefaultFontWeightDefined() const; /** * @brief Retrieves the default font weight. @@ -335,11 +831,37 @@ public: FontWeight GetDefaultFontWeight() const; /** + * @brief Sets the placeholder text font weight. + * + * @param[in] weight The font weight + */ + void SetPlaceholderTextFontWeight(FontWeight weight); + + /** + * @brief Whether the font's weight has been defined. + * + * @return True if the placeholder text font weight is defined + */ + bool IsPlaceholderTextFontWeightDefined() const; + + /** + * @brief Retrieves the placeholder text font weight. + * + * @return The placeholder text font weight + */ + FontWeight GetPlaceholderTextFontWeight() const; + + /** * @brief Sets the default font width. * * @param[in] width The font width. */ - void SetDefaultFontWidth( FontWidth width ); + void SetDefaultFontWidth(FontWidth width); + + /** + * @brief Whether the font's width has been defined. + */ + bool IsDefaultFontWidthDefined() const; /** * @brief Retrieves the default font width. @@ -349,11 +871,37 @@ public: FontWidth GetDefaultFontWidth() const; /** + * @brief Sets the placeholder text font width. + * + * @param[in] width The font width + */ + void SetPlaceholderTextFontWidth(FontWidth width); + + /** + * @brief Whether the font's width has been defined. + * + * @return True if the placeholder text font width is defined + */ + bool IsPlaceholderTextFontWidthDefined() const; + + /** + * @brief Retrieves the placeholder text font width. + * + * @return The placeholder text font width + */ + FontWidth GetPlaceholderTextFontWidth() const; + + /** * @brief Sets the default font slant. * * @param[in] slant The font slant. */ - void SetDefaultFontSlant( FontSlant slant ); + void SetDefaultFontSlant(FontSlant slant); + + /** + * @brief Whether the font's slant has been defined. + */ + bool IsDefaultFontSlantDefined() const; /** * @brief Retrieves the default font slant. @@ -363,154 +911,291 @@ public: FontSlant GetDefaultFontSlant() const; /** - * @brief Set the default point size. + * @brief Sets the placeholder text font slant. + * + * @param[in] slant The font slant + */ + void SetPlaceholderTextFontSlant(FontSlant slant); + + /** + * @brief Whether the font's slant has been defined. + * + * @return True if the placeholder text font slant is defined + */ + bool IsPlaceholderTextFontSlantDefined() const; + + /** + * @brief Retrieves the placeholder text font slant. * - * @param[in] pointSize The default point size. + * @return The placeholder text font slant */ - void SetDefaultPointSize( float pointSize ); + FontSlant GetPlaceholderTextFontSlant() const; + + /** + * @brief Set the default font size. + * + * @param[in] fontSize The default font size + * @param[in] type The font size type is point size or pixel size + */ + void SetDefaultFontSize(float fontSize, FontSizeType type); /** * @brief Retrieve the default point size. * + * @param[in] type The font size type * @return The default point size. */ - float GetDefaultPointSize() const; + float GetDefaultFontSize(FontSizeType type) const; /** - * @ brief Update the text after a font change - * @param[in] newDefaultFont The new font to change to + * @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 Set the font size scale enabled flag. + * + * @param[in] enabled whether to enable the font size scale. + */ + void SetFontSizeScaleEnabled(bool enabled); + + /** + * @brief Returns whether the font size scale is enabled or not. + * + * @return @e true if the font size scale is enabled, otherwise returns @e false. + */ + bool IsFontSizeScaleEnabled() 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 + */ + void SetPlaceholderTextFontSize(float fontSize, FontSizeType type); + + /** + * @brief Retrieves the Placeholder text font size. + * @param[in] type The font size type + * @return The placeholder font size + */ + float GetPlaceholderTextFontSize(FontSizeType type) const; + + /** + * @brief Sets the text's default color. + * + * @param color The default color. */ - void UpdateAfterFontChange( const std::string& newDefaultFont ); + void SetDefaultColor(const Vector4& color); + + /** + * @brief Retrieves the text's default color. + * + * @return The default color. + */ + const Vector4& GetDefaultColor() const; /** * @brief Set the text color * * @param textColor The text color */ - void SetTextColor( const Vector4& textColor ); + void SetPlaceholderTextColor(const Vector4& textColor); /** * @brief Retrieve the text color * * @return The text color */ - const Vector4& GetTextColor() const; + const Vector4& GetPlaceholderTextColor() const; /** - * @brief Set the text color + * @brief Set the shadow offset. * - * @param textColor The text color + * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow. + */ + void SetShadowOffset(const Vector2& shadowOffset); + + /** + * @brief Retrieve the shadow offset. + * + * @return The shadow offset. + */ + const Vector2& GetShadowOffset() const; + + /** + * @brief Set the shadow color. + * + * @param[in] shadowColor The shadow color. + */ + void SetShadowColor(const Vector4& shadowColor); + + /** + * @brief Retrieve the shadow color. + * + * @return The shadow color. + */ + const Vector4& GetShadowColor() const; + + /** + * @brief Set the shadow blur radius. + * + * @param[in] shadowBlurRadius The shadow blur radius, 0,0 indicates no blur. + */ + void SetShadowBlurRadius(const float& shadowBlurRadius); + + /** + * @brief Retrieve the shadow blur radius. + * + * @return The shadow blur radius. + */ + const float& GetShadowBlurRadius() const; + + /** + * @brief Set the underline color. + * + * @param[in] color color of underline. + */ + void SetUnderlineColor(const Vector4& color); + + /** + * @brief Retrieve the underline color. + * + * @return The underline color. + */ + const Vector4& GetUnderlineColor() const; + + /** + * @brief Set the underline enabled flag. + * + * @param[in] enabled The underline enabled flag. + */ + void SetUnderlineEnabled(bool enabled); + + /** + * @brief Returns whether the text is underlined or not. + * + * @return The underline state. + */ + bool IsUnderlineEnabled() const; + + /** + * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics + * + * @param[in] height The height in pixels of the underline */ - void SetPlaceholderTextColor( const Vector4& textColor ); + void SetUnderlineHeight(float height); /** - * @brief Retrieve the text color + * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics * - * @return The text color + * @return The height of the underline, or 0 if height is not overrided. */ - const Vector4& GetPlaceholderTextColor() const; + float GetUnderlineHeight() const; /** - * @brief Set the shadow offset. - * - * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow. + * @brief Sets the underline type. + * @param[in] type The underline type. */ - void SetShadowOffset( const Vector2& shadowOffset ); + void SetUnderlineType(Text::Underline::Type type); /** - * @brief Retrieve the shadow offset. - * - * @return The shadow offset. + * @brief Retrieve underline type. + * @return The underline type. */ - const Vector2& GetShadowOffset() const; + Text::Underline::Type GetUnderlineType() const; /** - * @brief Set the shadow color. + * @brief Set the width of the dashes of the dashed underline. * - * @param[in] shadowColor The shadow color. + * @param[in] width The width in pixels of the dashes of the dashed underline. */ - void SetShadowColor( const Vector4& shadowColor ); + void SetDashedUnderlineWidth(float width); /** - * @brief Retrieve the shadow color. + * @brief Retrieves the width of the dashes of the dashed underline. * - * @return The shadow color. + * @return The width of the dashes of the dashed underline. */ - const Vector4& GetShadowColor() const; + float GetDashedUnderlineWidth() const; /** - * @brief Sets the shadow's properties string. - * - * @note The string is stored to be recovered. + * @brief Set the gap between the dashes of the dashed underline. * - * @param[in] shadowProperties The shadow's properties string. + * @param[in] gap The gap between the dashes of the dashed underline. */ - void SetDefaultShadowProperties( const std::string& shadowProperties ); + void SetDashedUnderlineGap(float gap); /** - * @brief Retrieves the shadow's properties string. + * @brief Retrieves the gap between the dashes of the dashed underline. * - * @return The shadow's properties string. + * @return The The gap between the dashes of the dashed underline. */ - const std::string& GetDefaultShadowProperties() const; + float GetDashedUnderlineGap() const; /** - * @brief Set the underline color. + * @brief Set the outline color. * - * @param[in] color color of underline. + * @param[in] color color of outline. */ - void SetUnderlineColor( const Vector4& color ); + void SetOutlineColor(const Vector4& color); /** - * @brief Retrieve the underline color. + * @brief Retrieve the outline color. * - * @return The underline color. + * @return The outline color. */ - const Vector4& GetUnderlineColor() const; + const Vector4& GetOutlineColor() const; /** - * @brief Set the underline enabled flag. + * @brief Set the outline width * - * @param[in] enabled The underline enabled flag. + * @param[in] width The width in pixels of the outline, 0 indicates no outline */ - void SetUnderlineEnabled( bool enabled ); + void SetOutlineWidth(uint16_t width); /** - * @brief Returns whether the text is underlined or not. + * @brief Retrieves the width of an outline * - * @return The underline state. + * @return The width of the outline. */ - bool IsUnderlineEnabled() const; + uint16_t GetOutlineWidth() const; /** - * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics + * @brief Set the background color. * - * @param[in] height The height in pixels of the underline + * @param[in] color color of background. */ - void SetUnderlineHeight( float height ); + void SetBackgroundColor(const Vector4& color); /** - * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics + * @brief Retrieve the background color. * - * @return The height of the underline, or 0 if height is not overrided. + * @return The background color. */ - float GetUnderlineHeight() const; + const Vector4& GetBackgroundColor() const; /** - * @brief Sets the underline's properties string. - * - * @note The string is stored to be recovered. + * @brief Set the background enabled flag. * - * @param[in] underlineProperties The underline's properties string. + * @param[in] enabled The background enabled flag. */ - void SetDefaultUnderlineProperties( const std::string& underlineProperties ); + void SetBackgroundEnabled(bool enabled); /** - * @brief Retrieves the underline's properties string. + * @brief Returns whether to enable text background or not. * - * @return The underline's properties string. + * @return Whether text background is enabled. */ - const std::string& GetDefaultUnderlineProperties() const; + bool IsBackgroundEnabled() const; /** * @brief Sets the emboss's properties string. @@ -519,7 +1204,7 @@ public: * * @param[in] embossProperties The emboss's properties string. */ - void SetDefaultEmbossProperties( const std::string& embossProperties ); + void SetDefaultEmbossProperties(const std::string& embossProperties); /** * @brief Retrieves the emboss's properties string. @@ -535,7 +1220,7 @@ public: * * @param[in] outlineProperties The outline's properties string. */ - void SetDefaultOutlineProperties( const std::string& outlineProperties ); + void SetDefaultOutlineProperties(const std::string& outlineProperties); /** * @brief Retrieves the outline's properties string. @@ -548,8 +1233,10 @@ public: * @brief Sets the default line spacing. * * @param[in] lineSpacing The line spacing. + * + * @return True if lineSpacing has been updated, false otherwise */ - void SetDefaultLineSpacing( float lineSpacing ); + bool SetDefaultLineSpacing(float lineSpacing); /** * @brief Retrieves the default line spacing. @@ -559,11 +1246,27 @@ public: 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. */ - void SetInputColor( const Vector4& color ); + void SetInputColor(const Vector4& color); /** * @brief Retrieves the input text's color. @@ -577,7 +1280,7 @@ public: * * @param[in] fontFamily The text's font family name. */ - void SetInputFontFamily( const std::string& fontFamily ); + void SetInputFontFamily(const std::string& fontFamily); /** * @brief Retrieves the input text's font family name. @@ -587,25 +1290,16 @@ public: const std::string& GetInputFontFamily() const; /** - * @brief Sets the input text's font style. - * - * @param[in] fontStyle The input text's font style. - */ - void SetInputFontStyle( const std::string& fontStyle ); - - /** - * @brief Retrieves the input text's font style. + * @brief Sets the input font's weight. * - * @return The input text's font style. + * @param[in] weight The input font's weight. */ - const std::string& GetInputFontStyle() const; + void SetInputFontWeight(FontWeight weight); /** - * @brief Sets the input font's weight. - * - * @param[in] weight The input font's weight. + * @return Whether the font's weight has been defined. */ - void SetInputFontWeight( FontWeight weight ); + bool IsInputFontWeightDefined() const; /** * @brief Retrieves the input font's weight. @@ -619,7 +1313,12 @@ public: * * @param[in] width The input font's width. */ - void SetInputFontWidth( FontWidth width ); + void SetInputFontWidth(FontWidth width); + + /** + * @return Whether the font's width has been defined. + */ + bool IsInputFontWidthDefined() const; /** * @brief Retrieves the input font's width. @@ -633,7 +1332,12 @@ public: * * @param[in] slant The input font's slant. */ - void SetInputFontSlant( FontSlant slant ); + void SetInputFontSlant(FontSlant slant); + + /** + * @return Whether the font's slant has been defined. + */ + bool IsInputFontSlantDefined() const; /** * @brief Retrieves the input font's slant. @@ -647,7 +1351,7 @@ public: * * @param[in] size The input font's point size. */ - void SetInputFontPointSize( float size ); + void SetInputFontPointSize(float size); /** * @brief Retrieves the input font's point size. @@ -661,7 +1365,7 @@ public: * * @param[in] lineSpacing The line spacing. */ - void SetInputLineSpacing( float lineSpacing ); + void SetInputLineSpacing(float lineSpacing); /** * @brief Retrieves the input line spacing. @@ -677,7 +1381,7 @@ public: * * @param[in] shadowProperties The shadow's properties string. */ - void SetInputShadowProperties( const std::string& shadowProperties ); + void SetInputShadowProperties(const std::string& shadowProperties); /** * @brief Retrieves the input shadow's properties string. @@ -693,7 +1397,7 @@ public: * * @param[in] underlineProperties The underline's properties string. */ - void SetInputUnderlineProperties( const std::string& underlineProperties ); + void SetInputUnderlineProperties(const std::string& underlineProperties); /** * @brief Retrieves the input underline's properties string. @@ -709,7 +1413,7 @@ public: * * @param[in] embossProperties The emboss's properties string. */ - void SetInputEmbossProperties( const std::string& embossProperties ); + void SetInputEmbossProperties(const std::string& embossProperties); /** * @brief Retrieves the input emboss's properties string. @@ -725,7 +1429,7 @@ public: * * @param[in] outlineProperties The outline's properties string. */ - void SetInputOutlineProperties( const std::string& outlineProperties ); + void SetInputOutlineProperties(const std::string& outlineProperties); /** * @brief Retrieves the input outline's properties string. @@ -735,26 +1439,49 @@ public: const std::string& GetInputOutlineProperties() const; /** - * @brief Called to enable/disable cursor blink. + * @brief Sets the input strikethrough's properties string. * - * @note Only editable controls should calls this. - * @param[in] enabled Whether the cursor should blink or not. + * @note The string is stored to be recovered. + * + * @param[in] strikethroughProperties The strikethrough's properties string. */ - void SetEnableCursorBlink( bool enable ); + void SetInputStrikethroughProperties(const std::string& strikethroughProperties); /** - * @brief Query whether cursor blink is enabled. + * @brief Retrieves the input strikethrough's properties string. * - * @return Whether the cursor should blink or not. + * @return The strikethrough's properties string. */ - bool GetEnableCursorBlink() const; + const std::string& GetInputStrikethroughProperties() const; + + /** + * @brief Set the control's interface. + * + * @param[in] controlInterface The control's interface. + */ + void SetControlInterface(ControlInterface* controlInterface); + + /** + * @brief Set the anchor control's interface. + * + * @param[in] anchorControlInterface The control's interface. + */ + void SetAnchorControlInterface(AnchorControlInterface* anchorControlInterface); + +public: // Queries & retrieves. + /** + * @brief Return the layout engine. + * + * @return A reference to the layout engine. + */ + Layout::Engine& GetLayoutEngine(); /** - * @brief Query the current scroll position; the UI control is responsible for moving actors to this position. + * @brief Return a view of the text. * - * @return The scroll position. + * @return A reference to the view. */ - const Vector2& GetScrollPosition() const; + View& GetView(); /** * @copydoc Control::GetNaturalSize() @@ -764,123 +1491,219 @@ public: /** * @copydoc Control::GetHeightForWidth() */ - float GetHeightForWidth( float width ); + float GetHeightForWidth(float width); /** - * @brief Triggers a relayout which updates View (if necessary). - * - * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation. - * @param[in] size A the size of a bounding box to layout text within. + * @brief Calculates the point size for text for given layout() + */ + void FitPointSizeforLayout(Size layoutSize); + + /** + * @brief Checks if the point size fits within the layout size. * - * @return Whether the text model or decorations were updated. + * @return Whether the point size fits within the layout size. */ - UpdateTextType Relayout( const Size& size ); + bool CheckForTextFit(float pointSize, Size& layoutSize); /** - * @brief Process queued events which modify the model. + * @brief Retrieves the text's number of lines for a given width. + * @param[in] width The width of the text's area. + * @ return The number of lines. */ - void ProcessModifyEvents(); + int GetLineCount(float width); /** - * @brief Used to remove placeholder text. + * @brief Retrieves the text's model. + * + * @return A pointer to the text's model. */ - void ResetText(); + const ModelInterface* const GetTextModel() const; /** - * @brief Used to reset the cursor position after setting a new text. + * @brief Used to get scrolled distance by user input * - * @param[in] cursorIndex Where to place the cursor. + * @return Distance from last scroll offset to new scroll offset + */ + float GetScrollAmountByUserInput(); + + /** + * @brief Get latest scroll amount, control size and layout size + * + * This method is used to get information of control's scroll + * @param[out] scrollPosition The current scrolled position + * @param[out] controlHeight The size of a UI control + * @param[out] layoutHeight The size of a bounding box to layout text within. + * + * @return Whether the text scroll position is changed or not after last update. */ - void ResetCursorPosition( CharacterIndex cursorIndex ); + bool GetTextScrollInfo(float& scrollPosition, float& controlHeight, float& layoutHeight); /** - * @brief Used to reset the scroll position after setting a new text. + * @brief Used to set the hidden input option */ - void ResetScrollPosition(); + void SetHiddenInputOption(const Property::Map& options); /** - * @brief Used to process an event queued from SetText() + * @brief Used to get the hidden input option */ - void TextReplacedEvent(); + void GetHiddenInputOption(Property::Map& options); /** - * @brief Used to process an event queued from key events etc. + * @brief Used to set the input filter option */ - void TextInsertedEvent(); + void SetInputFilterOption(const Property::Map& options); /** - * @brief Used to process an event queued from backspace key etc. + * @brief Used to get the input filter option */ - void TextDeletedEvent(); + void GetInputFilterOption(Property::Map& options); /** - * @brief Lays-out the text. - * - * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method. + * @brief Sets the Placeholder Properties. * - * @param[in] size A the size of a bounding box to layout text within. - * @param[in] operations The layout operations which need to be done. - * @param[out] layoutSize The size of the laid-out text. + * @param[in] map The placeholder property map */ - bool DoRelayout( const Size& size, - OperationsMask operations, - Size& layoutSize ); + void SetPlaceholderProperty(const Property::Map& map); /** - * @brief Whether to enable the multi-line layout. + * @brief Retrieves the Placeholder Property map. * - * @param[in] enable \e true enables the multi-line (by default) + * @param[out] map The property map */ - void SetMultiLineEnabled( bool enable ); + void GetPlaceholderProperty(Property::Map& map); /** - * @return Whether the multi-line layout is enabled. + * @brief Checks text direction. + * @return The text direction. */ - bool IsMultiLineEnabled() const; + Toolkit::DevelText::TextDirection::Type GetTextDirection(); + + /** + * @brief Retrieves vertical line alignment + * @return The vertical line alignment + */ + Toolkit::DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const; + + /** + * @brief Sets vertical line alignment + * @param[in] alignment The vertical line alignment for the text + */ + void SetVerticalLineAlignment(Toolkit::DevelText::VerticalLineAlignment::Type alignment); + + /** + * @brief Retrieves ellipsis position + * @return The ellipsis position + */ + Toolkit::DevelText::EllipsisPosition::Type GetEllipsisPosition() const; + + /** + * @brief Sets ellipsis position + * @param[in] ellipsisPosition The ellipsis position for the text + */ + void SetEllipsisPosition(Toolkit::DevelText::EllipsisPosition::Type ellipsisPosition); + + /** + * @brief Retrieves ignoreSpaceAfterText value from model + * @return The value of ignoreSpaceAfterText + */ + bool IsIgnoreSpacesAfterText() const; /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment() + * @brief Sets ignoreSpaceAfterText value to model + * @param[in] ignore The value of ignoreSpacesAfterText for the text */ - void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment ); + void SetIgnoreSpacesAfterText(bool ignore); /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment() + * @brief Sets SetMatchLayoutDirection value to model + * @param[in] match The value of matchLayoutDirection for the text */ - LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const; + void SetMatchLayoutDirection(DevelText::MatchLayoutDirection type); /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment() + * @brief Retrieves matchLayoutDirection value from model + * @return The value of matchLayoutDirection */ - void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment ); + DevelText::MatchLayoutDirection GetMatchLayoutDirection() const; /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment() + * @brief Sets layoutDirection type value. + * @param[in] layoutDirection The value of the layout direction type. */ - LayoutEngine::VerticalAlignment GetVerticalAlignment() const; + void SetLayoutDirection(Dali::LayoutDirection::Type layoutDirection); /** - * @brief Calulates the vertical offset to align the text inside the bounding box. + * @brief Gets layoutDirection type value. + * @param[in] actor The actor which will get the layout direction type. + * @return The value of the layout direction type. + */ + Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const; + + /** + * @brief Get the rendered size of a specific text range. + * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line. + * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction. * - * @param[in] size The size of the bounding box. + * @param[in] startIndex start index of the text requested to calculate size for. + * @param[in] endIndex end index(included) of the text requested to calculate size for. + * @return list of sizes of the reuested text. */ - void CalculateVerticalOffset( const Size& size ); + Vector GetTextSize(CharacterIndex startIndex, CharacterIndex endIndex); /** - * @brief Return the layout engine. + * @brief Get the top/left rendered position of a specific text range. + * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line. + * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction. * - * @return A reference to the layout engine. + * @param[in] startIndex start index of the text requested to get position to. + * @param[in] endIndex end index(included) of the text requested to get position to. + * @return list of positions of the requested text. */ - LayoutEngine& GetLayoutEngine(); + Vector GetTextPosition(CharacterIndex startIndex, CharacterIndex endIndex); /** - * @brief Return a view of the text. + * @brief Sets the layout direction changed. + */ + void ChangedLayoutDirection(); + + /** + * @brief Retrieves if showing real text or not. + * @return The value of showing real text. + */ + bool IsShowingRealText() const; + +public: // Relayout. + /** + * @brief Triggers a relayout which updates View (if necessary). * - * @return A reference to the view. + * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation. + * @param[in] size A the size of a bounding box to layout text within. + * @param[in] layoutDirection The direction of the system language. + * + * @return Whether the text model or decorations were updated. */ - View& GetView(); + UpdateTextType Relayout(const Size& size, Dali::LayoutDirection::Type layoutDirection = Dali::LayoutDirection::LEFT_TO_RIGHT); + + /** + * @brief Request a relayout using the ControlInterface. + */ + void RequestRelayout(); + +public: // Input style change signals. + /** + * @return Whether the queue of input style changed signals is empty. + */ + bool IsInputStyleChangedSignalsQueueEmpty(); - // Text-input Event Queuing + /** + * @brief Process all pending input style changed signals. + * + * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the + * text controls. Text controls may send signals to state the input style has changed. + */ + void ProcessInputStyleChangedSignals(); +public: // Text-input Event Queuing. /** * @brief Called by editable UI controls when keyboard focus is gained. */ @@ -895,23 +1718,16 @@ public: * @brief Called by editable UI controls when key events are received. * * @param[in] event The key event. - * @param[in] type Used to distinguish between regular key events and IMF events. - */ - bool KeyEvent( const Dali::KeyEvent& event ); - - /** - * @brief Called by editable UI controls when key events are received. - * - * @param[in] text The text to insert. - * @param[in] type Used to distinguish between regular key events and IMF events. + * @param[in] type Used to distinguish between regular key events and InputMethodContext events. */ - void InsertText( const std::string& text, InsertType type ); + bool KeyEvent(const Dali::KeyEvent& event); /** - * @brief Checks if text is selected and if so removes it. - * @return true if text was removed + * @brief Called by anchor when a tap 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. */ - bool RemoveSelectedText(); + void AnchorEvent(float x, float y); /** * @brief Called by editable UI controls when a tap gesture occurs. @@ -919,7 +1735,7 @@ 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. */ - void TapEvent( unsigned int tapCount, float x, float y ); + void TapEvent(unsigned int tapCount, float x, float y); /** * @brief Called by editable UI controls when a pan gesture occurs. @@ -927,7 +1743,7 @@ public: * @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. @@ -936,7 +1752,23 @@ 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. */ - 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. + * @param[in] focused true if UI control has gained focus to receive key event, false otherwise. + * @return[in] true if cursor position changed, false otherwise. + */ + bool SetPrimaryCursorPosition(CharacterIndex index, bool focused); /** * @brief Creates a selection event. @@ -945,24 +1777,88 @@ 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. - * @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, bool selectAll ); + void SelectEvent(float x, float y, SelectionType selection); /** - * @brief Event received from IMF manager - * - * @param[in] imfManager The IMF manager. - * @param[in] imfEvent The event received. - * @return A data struture indicating if update is needed, cursor position and current text. + * @copydoc Text::SelectableControlInterface::SetTextSelectionRange() + */ + 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::EditableControlInterface::CopyText() + */ + string CopyText(); + + /** + * @copydoc Text::EditableControlInterface::CutText() + */ + string CutText(); + + /** + * @copydoc Text::EditableControlInterface::PasteText() + */ + void PasteText(); + + /** + * @copydoc Text::SelectableControlInterface::SelectNone() + */ + void SelectNone(); + + /** + * @copydoc Text::SelectableControlInterface::SelectText() + */ + void SelectText(const uint32_t start, const uint32_t end); + + /** + * @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() */ - ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent ); + float GetVerticalScrollPosition(); /** - * @brief Paste given string into Text model - * @param[in] stringToPaste this string will be inserted into the text model + * @brief Event received from input method context + * + * @param[in] inputMethodContext The input method context. + * @param[in] inputMethodContextEvent The event received. + * @return A data struture indicating if update is needed, cursor position and current text. */ - void PasteText( const std::string& stringToPaste ); + InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent); /** * @brief Event from Clipboard notifying an Item has been selected for pasting @@ -970,77 +1866,124 @@ public: void PasteClipboardItemEvent(); /** - * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize() + * @brief Return true when text control should clear key input focus when escape key is pressed. + * + * @return Whether text control should clear key input focus or not when escape key is pressed. */ - virtual void GetTargetSize( Vector2& targetSize ); + bool ShouldClearFocusOnEscape() const; /** - * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration() + * @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. */ - virtual void AddDecoration( Actor& actor, bool needsClipping ); + Actor CreateBackgroundActor(); /** - * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent() + * @brief Used to reset the cursor position after setting a new text. + * + * @param[in] cursorIndex Where to place the cursor. */ - virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y ); + void ResetCursorPosition(CharacterIndex cursorIndex); /** - * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched() + * @brief The method acquires current position of cursor + * @return unsigned value with cursor position + */ + CharacterIndex GetCursorPosition(); + + /** + * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text + * + * @param[out] anchorActors the vector of actor (empty collection if no anchors available). */ - virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button ); + void GetAnchorActors(std::vector& anchorActors); -protected: + /** + * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset + * + * @param[in] characterOffset A position in text coords. + * + * @return the index in anchor vector (-1 if an anchor not found) + */ + int GetAnchorIndex(size_t characterOffset); +protected: // Inherit from Text::Decorator::ControllerInterface. /** - * @brief A reference counted object may only be deleted by calling Unreference(). + * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize() */ - virtual ~Controller(); + void GetTargetSize(Vector2& targetSize) override; -private: + /** + * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration() + */ + void AddDecoration(Actor& actor, bool needsClipping) override; /** - * @brief Helper to KeyEvent() to handle the backspace case. - * - * @return True if a character was deleted. + * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent() */ - bool BackspaceKeyEvent(); + void DecorationEvent(HandleType handle, HandleState state, float x, float y) override; +protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface. /** - * @brief Helper to clear font-specific data. + * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched() + */ + 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 */ - void ShowPlaceholderText(); + void DisplayTimeExpired() override; +private: // Private contructors & copy operator. /** - * @brief Helper to clear font-specific data (only). + * @brief Private constructor. */ - void ClearFontData(); + Controller() + : Controller(nullptr, nullptr, nullptr, nullptr) + { + } /** - * @brief Helper to clear text's style data. + * @brief Private constructor. */ - void ClearStyleData(); + Controller(ControlInterface* controlInterface) + : Controller(controlInterface, nullptr, nullptr, nullptr) + { + } /** * @brief Private constructor. */ - Controller( ControlInterface& controlInterface ); + Controller(ControlInterface* controlInterface, + EditableControlInterface* editableControlInterface, + SelectableControlInterface* selectableControlInterface, + AnchorControlInterface* anchorControlInterface); - // Undefined - Controller( const Controller& handle ); + Controller(const Controller& handle) = delete; + Controller& operator=(const Controller& handle) = delete; - // Undefined - Controller& operator=( const Controller& handle ); +protected: // Destructor. + /** + * @brief A reference counted object may only be deleted by calling Unreference(). + */ + virtual ~Controller(); + +public: + struct Impl; ///< Made public for testing purposes private: + struct EventHandler; + struct InputFontHandler; + struct InputProperties; + struct PlaceholderHandler; + struct Relayouter; + struct TextUpdater; - struct Impl; Impl* mImpl; }; -} // namespace Text - -} // namespace Toolkit - -} // namespace Dali +} // namespace Dali::Toolkit::Text -#endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__ +#endif // DALI_TOOLKIT_TEXT_CONTROLLER_H