X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Ftext-controller.h;h=9c80fc7c7574d2392e834ae03a2494eac1feb5d5;hp=5a96349ea4320c8f1aac6eaaf773b0fc2175530c;hb=427f642f46df778c141cc7ab9718ce33d0ce01e1;hpb=00fdaec1c1d0ae69756e720ac5d3bc3acc5bd2a9 diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h index 5a96349..9c80fc7 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) 2017 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. @@ -26,7 +26,8 @@ #include #include #include -#include +#include +#include namespace Dali { @@ -38,19 +39,12 @@ namespace Text { class Controller; +class ControlInterface; +class EditableControlInterface; class View; +class RenderingController; typedef IntrusivePtr ControllerPtr; -typedef Dali::Toolkit::Text::ControlInterface ControlInterface; - -/** - * @brief Different placeholder-text can be shown when the control is active/inactive. - */ -enum PlaceholderType -{ - PLACEHOLDER_TYPE_ACTIVE, - PLACEHOLDER_TYPE_INACTIVE, -}; /** * @brief A Text Controller is used by UI Controls which display text. @@ -63,9 +57,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. @@ -82,7 +76,7 @@ public: SHAPE_TEXT = 0x0040, GET_GLYPH_METRICS = 0x0080, LAYOUT = 0x0100, - UPDATE_ACTUAL_SIZE = 0x0200, + UPDATE_LAYOUT_SIZE = 0x0200, REORDER = 0x0400, ALIGN = 0x0800, COLOR = 0x1000, @@ -109,12 +103,73 @@ public: }; /** + * @brief Used to specify what has been updated after the Relayout() method has been called. + */ + enum UpdateTextType + { + 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. + }; + }; + +public: // Constructor. + + /** + * @brief Create a new instance of a Controller. + * + * @return A pointer to a new Controller. + */ + static ControllerPtr New(); + + /** + * @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 ); + + /** * @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. + * * @return A pointer to a new Controller. */ - static ControllerPtr New( ControlInterface& controlInterface ); + static ControllerPtr New( ControlInterface* controlInterface, + EditableControlInterface* editableControlInterface ); + +public: // Configure the text controller. /** * @brief Called to enable text input. @@ -174,58 +229,53 @@ public: CharacterDirection GetAutoScrollDirection() const; /** - * @brief Replaces any text previously set. + * @brief Get the alignment offset of the first line of text. * - * @note This will be converted into UTF-32 when stored in the text model. - * @param[in] text A string of UTF-8 characters. + * @return The alignment offset. */ - void SetText( const std::string& text ); + float GetAutoScrollLineAlignment() const; /** - * @brief Retrieve any text previously set. + * @brief Enables the horizontal scrolling. * - * @return A string of UTF-8 characters. + * @param[in] enable Whether to enable the horizontal scrolling. */ - void GetText( std::string& text ) const; + void SetHorizontalScrollEnabled( bool enable ); /** - * @brief Remove a given number of characters + * @brief Retrieves whether the horizontal scrolling is enabled. * - * 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. + * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false. + */ + bool IsHorizontalScrollEnabled() const; + + /** + * @brief Enables the vertical scrolling. * - * @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[in] enable Whether to enable the vertical scrolling. */ - bool RemoveText( int cursorOffset, - int numberOfCharacters, - UpdateInputStyleType type ); + void SetVerticalScrollEnabled( bool enable ); /** - * @brief Retrieve the current cursor position. + * @brief Retrieves whether the verticall scrolling is enabled. * - * @return The cursor position. + * @return @e true if the vertical scrolling is enabled, otherwise it returns @e false. */ - unsigned int GetLogicalCursorPosition() const; + bool IsVerticalScrollEnabled() const; /** - * @brief Replaces any placeholder text previously set. + * @brief Enables the smooth handle panning. * - * @param[in] type Different placeholder-text can be shown when the control is active/inactive. - * @param[in] text A string of UTF-8 characters. + * @param[in] enable Whether to enable the smooth handle panning. */ - void SetPlaceholderText( PlaceholderType type, const std::string& text ); + void SetSmoothHandlePanEnabled( bool enable ); /** - * @brief Retrieve any placeholder text previously set. + * @brief Retrieves whether the smooth handle panning is enabled. * - * @param[in] type Different placeholder-text can be shown when the control is active/inactive. - * @param[out] A string of UTF-8 characters. + * @return @e true if the smooth handle panning is enabled. */ - void GetPlaceholderText( PlaceholderType type, std::string& text ) const; + bool IsSmoothHandlePanEnabled() const; /** * @brief Sets the maximum number of characters that can be inserted into the TextModel @@ -242,436 +292,721 @@ public: int GetMaximumNumberOfCharacters(); /** - * @brief Set the default font family. + * @brief Called to enable/disable cursor blink. * - * @param[in] defaultFontFamily The default font family. + * @note Only editable controls should calls this. + * @param[in] enabled Whether the cursor should blink or not. */ - void SetDefaultFontFamily( const std::string& defaultFontFamily ); + void SetEnableCursorBlink( bool enable ); /** - * @brief Retrieve the default font family. + * @brief Query whether cursor blink is enabled. * - * @return The default font family. + * @return Whether the cursor should blink or not. */ - const std::string& GetDefaultFontFamily() const; + bool GetEnableCursorBlink() 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. + * @brief Whether to enable the multi-line layout. * - * @param[in] style The font's style string. + * @param[in] enable \e true enables the multi-line (by default) */ - void SetDefaultFontStyle( const std::string& style ); + void SetMultiLineEnabled( bool enable ); /** - * @brief Retrieves the font's style. - * - * @return The font's style. + * @return Whether the multi-line layout is enabled. */ - const std::string& GetDefaultFontStyle() const; + bool IsMultiLineEnabled() const; /** - * @brief Sets the default font weight. + * @brief Sets the text's horizontal alignment. * - * @param[in] weight The font weight. + * @param[in] alignment The horizontal alignment. */ - void SetDefaultFontWeight( FontWeight weight ); + void SetHorizontalAlignment( Layout::HorizontalAlignment alignment ); /** - * @brief Retrieves the default font weight. - * - * @return The default font weight. + * @copydoc ModelInterface::GetHorizontalAlignment() */ - FontWeight GetDefaultFontWeight() const; + Layout::HorizontalAlignment GetHorizontalAlignment() const; /** - * @brief Sets the default font width. + * @brief Sets the text's vertical alignment. * - * @param[in] width The font width. + * @param[in] alignment The vertical alignment. */ - void SetDefaultFontWidth( FontWidth width ); + void SetVerticalAlignment( Layout::VerticalAlignment alignment ); /** - * @brief Retrieves the default font width. - * - * @return The default font width. + * @copydoc ModelInterface::GetVerticalAlignment() */ - FontWidth GetDefaultFontWidth() const; + Layout::VerticalAlignment GetVerticalAlignment() const; /** - * @brief Sets the default font slant. + * @brief Enable or disable the text elide. * - * @param[in] slant The font slant. + * @param[in] enabled Whether to enable the text elide. */ - void SetDefaultFontSlant( FontSlant slant ); + void SetTextElideEnabled( bool enabled ); /** - * @brief Retrieves the default font slant. - * - * @return The default font slant. + * @copydoc ModelInterface::IsTextElideEnabled() */ - FontSlant GetDefaultFontSlant() const; + bool IsTextElideEnabled() const; /** - * @brief Set the default point size. - * - * @param[in] pointSize The default point size. + * @brief Enable or disable the text selection. + * @param[in] enabled Whether to enable the text selection. */ - void SetDefaultPointSize( float pointSize ); + void SetSelectionEnabled( bool enabled ); /** - * @brief Retrieve the default point size. - * - * @return The default point size. + * @brief Whether the text selection is enabled or not. + * @return True if the text selection is enabled */ - float GetDefaultPointSize() const; + bool IsSelectionEnabled() const; /** - * @ brief Update the text after a font change - * @param[in] newDefaultFont The new font to change to + * @brief Sets input type to password + * + * @note The string is displayed hidden character + * + * @param[in] passwordInput True if password input is enabled. */ - void UpdateAfterFontChange( const std::string& newDefaultFont ); + void SetInputModePassword( bool passwordInput ); /** - * @brief Set the text color + * @brief Returns whether the input mode type is set as password. * - * @param textColor The text color + * @return True if input mode type is password */ - void SetTextColor( const Vector4& textColor ); + bool IsInputModePassword(); /** - * @brief Retrieve the text color + * @brief Sets the action when there is a double tap event on top of a text area with no text. * - * @return The text color + * @param[in] action The action to do. */ - const Vector4& GetTextColor() const; + void SetNoTextDoubleTapAction( NoTextTap::Action action ); /** - * @brief Set the text color + * @brief Retrieves the action when there is a double tap event on top of a text area with no text. * - * @param textColor The text color + * @return The action to do. */ - void SetPlaceholderTextColor( const Vector4& textColor ); + NoTextTap::Action GetNoTextDoubleTapAction() const; /** - * @brief Retrieve the text color + * @briefSets the action when there is a long press event on top of a text area with no text. * - * @return The text color + * @param[in] action The action to do. */ - const Vector4& GetPlaceholderTextColor() const; + void SetNoTextLongPressAction( NoTextTap::Action action ); /** - * @brief Set the shadow offset. + * @brief Retrieves the action when there is a long press event on top of a text area with no text. * - * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow. + * @return The action to do. */ - void SetShadowOffset( const Vector2& shadowOffset ); + NoTextTap::Action GetNoTextLongPressAction() const; /** - * @brief Retrieve the shadow offset. - * - * @return The shadow offset. + * @brief Query if Underline settings were provided by string or map + * @return bool true if set by string */ - const Vector2& GetShadowOffset() const; + bool IsUnderlineSetByString(); /** - * @brief Set the shadow color. - * - * @param[in] shadowColor The shadow color. + * Set method underline setting were set by + * @param[in] bool, true if set by string */ - void SetShadowColor( const Vector4& shadowColor ); + void UnderlineSetByString( bool setByString ); /** - * @brief Retrieve the shadow color. - * - * @return The shadow color. + * @brief Query if shadow settings were provided by string or map + * @return bool true if set by string */ - const Vector4& GetShadowColor() const; + bool IsShadowSetByString(); /** - * @brief Set the underline color. - * - * @param[in] color color of underline. + * Set method shadow setting were set by + * @param[in] bool, true if set by string */ - void SetUnderlineColor( const Vector4& color ); + void ShadowSetByString( bool setByString ); /** - * @brief Retrieve the underline color. - * - * @return The underline color. + * @brief Query if font style settings were provided by string or map + * @return bool true if set by string */ - const Vector4& GetUnderlineColor() const; + bool IsFontStyleSetByString(); /** - * @brief Set the underline enabled flag. - * - * @param[in] enabled The underline enabled flag. + * Set method font style setting were set by + * @param[in] bool, true if set by string */ - void SetUnderlineEnabled( bool enabled ); + void FontStyleSetByString( bool setByString ); + +public: // Update. /** - * @brief Returns whether the text is underlined or not. + * @brief Replaces any text previously set. * - * @return The underline state. + * @note This will be converted into UTF-32 when stored in the text model. + * @param[in] text A string of UTF-8 characters. */ - bool IsUnderlineEnabled() const; + void SetText( const std::string& text ); /** - * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics + * @brief Retrieve any text previously set. * - * @param[in] height The height in pixels of the underline + * @param[out] text A string of UTF-8 characters. */ - void SetUnderlineHeight( float height ); + void GetText( std::string& text ) const; /** - * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics + * @brief Replaces any placeholder text previously set. * - * @return The height of the underline, or 0 if height is not overrided. + * @param[in] text A string of UTF-8 characters. */ - float GetUnderlineHeight() const; + void SetPlaceholderText( const std::string& text ); /** - * @brief Sets the input text's color. + * @brief Replaces any placeholder text previously set. * - * @param[in] color The input text's color. + * @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 SetInputColor( const Vector4& color ); + void SetPlaceholderText( PlaceholderType type, const std::string& text ); /** - * @brief Retrieves the input text's color. + * @brief Retrieve any placeholder text previously set. * - * @return The input text's color. + * @param[out] A string of UTF-8 characters. */ - const Vector4& GetInputColor() const; + void GetPlaceholderText( std::string& text ) const; /** - * @brief Sets the input text's font family name. + * @brief Retrieve any placeholder text previously set. * - * @param[in] fontFamily The text's font family name. + * @param[in] type Different placeholder-text can be shown when the control is active/inactive. + * @param[out] A string of UTF-8 characters. */ - void SetInputFontFamily( const std::string& fontFamily ); + void GetPlaceholderText( PlaceholderType type, std::string& text ) const; /** - * @brief Retrieves the input text's font family name. - * - * @return The input text's font family name. + * @ brief Update the text after a font change + * @param[in] newDefaultFont The new font to change to */ - const std::string& GetInputFontFamily() const; + void UpdateAfterFontChange( const std::string& newDefaultFont ); + +public: // Default style & Input style /** - * @brief Sets the input text's font style. + * @brief Set the default font family. * - * @param[in] fontStyle The input text's font style. + * @param[in] defaultFontFamily The default font family. */ - void SetInputFontStyle( const std::string& fontStyle ); + void SetDefaultFontFamily( const std::string& defaultFontFamily ); /** - * @brief Retrieves the input text's font style. + * @brief Retrieve the default font family. * - * @return The input text's font style. + * @return The default font family. */ - const std::string& GetInputFontStyle() const; + const std::string& GetDefaultFontFamily() const; /** - * @brief Sets the input font's weight. - * - * @param[in] weight The input font's weight. + * @brief Sets the placeholder text font family. + * @param[in] placeholderTextFontFamily The placeholder text font family. */ - void SetInputFontWeight( FontWeight weight ); + void SetPlaceholderFontFamily( const std::string& placeholderTextFontFamily ); /** - * @brief Retrieves the input font's weight. + * @brief Retrieves the placeholder text font family. * - * @return The input font's weight. + * @return The placeholder text font family */ - FontWeight GetInputFontWeight() const; + const std::string& GetPlaceholderFontFamily() const; /** - * @brief Sets the input font's width. + * @brief Sets the default font weight. * - * @param[in] width The input font's width. + * @param[in] weight The font weight. */ - void SetInputFontWidth( FontWidth width ); + void SetDefaultFontWeight( FontWeight weight ); /** - * @brief Retrieves the input font's width. - * - * @return The input font's width. + * @brief Whether the font's weight has been defined. */ - FontWidth GetInputFontWidth() const; + bool IsDefaultFontWeightDefined() const; /** - * @brief Sets the input font's slant. + * @brief Retrieves the default font weight. * - * @param[in] slant The input font's slant. + * @return The default font weight. */ - void SetInputFontSlant( FontSlant slant ); + FontWeight GetDefaultFontWeight() const; /** - * @brief Retrieves the input font's slant. + * @brief Sets the placeholder text font weight. * - * @return The input font's slant. + * @param[in] weight The font weight */ - FontSlant GetInputFontSlant() const; + void SetPlaceholderTextFontWeight( FontWeight weight ); /** - * @brief Sets the input font's point size. + * @brief Whether the font's weight has been defined. * - * @param[in] size The input font's point size. + * @return True if the placeholder text font weight is defined */ - void SetInputFontPointSize( float size ); + bool IsPlaceholderTextFontWeightDefined() const; /** - * @brief Retrieves the input font's point size. + * @brief Retrieves the placeholder text font weight. * - * @return The input font's point size. + * @return The placeholder text font weight */ - float GetInputFontPointSize() const; + FontWeight GetPlaceholderTextFontWeight() const; /** - * @brief Called to enable/disable cursor blink. + * @brief Sets the default font width. * - * @note Only editable controls should calls this. - * @param[in] enabled Whether the cursor should blink or not. + * @param[in] width The font width. */ - void SetEnableCursorBlink( bool enable ); + void SetDefaultFontWidth( FontWidth width ); /** - * @brief Query whether cursor blink is enabled. - * - * @return Whether the cursor should blink or not. + * @brief Whether the font's width has been defined. */ - bool GetEnableCursorBlink() const; + bool IsDefaultFontWidthDefined() const; /** - * @brief Query the current scroll position; the UI control is responsible for moving actors to this position. + * @brief Retrieves the default font width. * - * @return The scroll position. + * @return The default font width. */ - const Vector2& GetScrollPosition() const; + FontWidth GetDefaultFontWidth() const; /** - * @brief Query the alignment offset. + * @brief Sets the placeholder text font width. * - * @return The alignmnet offset. + * @param[in] width The font width */ - const Vector2& GetAlignmentOffset() const; + void SetPlaceholderTextFontWidth( FontWidth width ); /** - * @copydoc Control::GetNaturalSize() + * @brief Whether the font's width has been defined. + * + * @return True if the placeholder text font width is defined */ - Vector3 GetNaturalSize(); + bool IsPlaceholderTextFontWidthDefined() const; /** - * @copydoc Control::GetHeightForWidth() + * @brief Retrieves the placeholder text font width. + * + * @return The placeholder text font width */ - float GetHeightForWidth( float width ); + FontWidth GetPlaceholderTextFontWidth() const; /** - * @brief Triggers a relayout which updates View (if necessary). + * @brief Sets the default font slant. * - * @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. - * @return True if the text model or decorations were updated. + * @param[in] slant The font slant. */ - bool Relayout( const Size& size ); + void SetDefaultFontSlant( FontSlant slant ); /** - * @brief Process queued events which modify the model. + * @brief Whether the font's slant has been defined. */ - void ProcessModifyEvents(); + bool IsDefaultFontSlantDefined() const; /** - * @brief Used to remove placeholder text. + * @brief Retrieves the default font slant. + * + * @return The default font slant. */ - void ResetText(); + FontSlant GetDefaultFontSlant() const; /** - * @brief Used to reset the cursor position after setting a new text. + * @brief Sets the placeholder text font slant. * - * @param[in] cursorIndex Where to place the cursor. + * @param[in] slant The font slant */ - void ResetCursorPosition( CharacterIndex cursorIndex ); + void SetPlaceholderTextFontSlant( FontSlant slant ); /** - * @brief Used to reset the scroll position after setting a new text. + * @brief Whether the font's slant has been defined. + * + * @return True if the placeholder text font slant is defined */ - void ResetScrollPosition(); + bool IsPlaceholderTextFontSlantDefined() const; /** - * @brief Used to process an event queued from SetText() + * @brief Retrieves the placeholder text font slant. + * + * @return The placeholder text font slant */ - void TextReplacedEvent(); + FontSlant GetPlaceholderTextFontSlant() const; /** - * @brief Used to process an event queued from key events etc. + * @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 TextInsertedEvent(); + void SetDefaultFontSize( float fontSize, FontSizeType type ); /** - * @brief Used to process an event queued from backspace key etc. + * @brief Retrieve the default point size. + * + * @param[in] type The font size type + * @return The default point size. */ - void TextDeletedEvent(); + float GetDefaultFontSize( FontSizeType type ) const; /** - * @brief Lays-out the text. + * @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. * - * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method. + * @param color The default color. + */ + void SetDefaultColor( const Vector4& color ); + + /** + * @brief Retrieves the text's default color. * - * @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. + * @return The default color. */ - bool DoRelayout( const Size& size, - OperationsMask operations, - Size& layoutSize ); + const Vector4& GetDefaultColor() const; /** - * @brief Whether to enable the multi-line layout. + * @brief Set the text color * - * @param[in] enable \e true enables the multi-line (by default) + * @param textColor The text color */ - void SetMultiLineEnabled( bool enable ); + void SetPlaceholderTextColor( const Vector4& textColor ); /** - * @return Whether the multi-line layout is enabled. + * @brief Retrieve the text color + * + * @return The text color */ - bool IsMultiLineEnabled() const; + const Vector4& GetPlaceholderTextColor() const; /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment() + * @brief Set the shadow offset. + * + * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow. */ - void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment ); + void SetShadowOffset( const Vector2& shadowOffset ); /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment() + * @brief Retrieve the shadow offset. + * + * @return The shadow offset. */ - LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const; + const Vector2& GetShadowOffset() const; /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment() + * @brief Set the shadow color. + * + * @param[in] shadowColor The shadow color. */ - void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment ); + void SetShadowColor( const Vector4& shadowColor ); /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment() + * @brief Retrieve the shadow color. + * + * @return The shadow color. */ - LayoutEngine::VerticalAlignment GetVerticalAlignment() const; + const Vector4& GetShadowColor() const; /** - * @brief Calulates the alignment of the whole text inside the bounding box. + * @brief Set the underline color. * - * @param[in] size The size of the bounding box. + * @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 SetUnderlineHeight( float height ); + + /** + * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics + * + * @return The height of the underline, or 0 if height is not overrided. + */ + float GetUnderlineHeight() const; + + /** + * @brief Sets the emboss's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] embossProperties The emboss's properties string. + */ + void SetDefaultEmbossProperties( const std::string& embossProperties ); + + /** + * @brief Retrieves the emboss's properties string. + * + * @return The emboss's properties string. + */ + const std::string& GetDefaultEmbossProperties() const; + + /** + * @brief Sets the outline's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] outlineProperties The outline's properties string. + */ + void SetDefaultOutlineProperties( const std::string& outlineProperties ); + + /** + * @brief Retrieves the outline's properties string. + * + * @return The outline's properties string. + */ + const std::string& GetDefaultOutlineProperties() const; + + /** + * @brief Sets the default line spacing. + * + * @param[in] lineSpacing The line spacing. + */ + void SetDefaultLineSpacing( float lineSpacing ); + + /** + * @brief Retrieves the default line spacing. + * + * @return The line spacing. + */ + float GetDefaultLineSpacing() const; + + /** + * @brief Sets the input text's color. + * + * @param[in] color The input text's color. + */ + void SetInputColor( const Vector4& color ); + + /** + * @brief Retrieves the input text's color. + * + * @return The input text's color. */ - void CalculateTextAlignment( const Size& size ); + const Vector4& GetInputColor() const; + + /** + * @brief Sets the input text's font family name. + * + * @param[in] fontFamily The text's font family name. + */ + void SetInputFontFamily( const std::string& fontFamily ); + + /** + * @brief Retrieves the input text's font family name. + * + * @return The input text's font family name. + */ + const std::string& GetInputFontFamily() const; + + /** + * @brief Sets the input font's weight. + * + * @param[in] weight The input font's weight. + */ + void SetInputFontWeight( FontWeight weight ); + + /** + * @return Whether the font's weight has been defined. + */ + bool IsInputFontWeightDefined() const; + + /** + * @brief Retrieves the input font's weight. + * + * @return The input font's weight. + */ + FontWeight GetInputFontWeight() const; + + /** + * @brief Sets the input font's width. + * + * @param[in] width The input font's width. + */ + void SetInputFontWidth( FontWidth width ); + + /** + * @return Whether the font's width has been defined. + */ + bool IsInputFontWidthDefined() const; + + /** + * @brief Retrieves the input font's width. + * + * @return The input font's width. + */ + FontWidth GetInputFontWidth() const; + + /** + * @brief Sets the input font's slant. + * + * @param[in] slant The input font's slant. + */ + void SetInputFontSlant( FontSlant slant ); + + /** + * @return Whether the font's slant has been defined. + */ + bool IsInputFontSlantDefined() const; + + /** + * @brief Retrieves the input font's slant. + * + * @return The input font's slant. + */ + FontSlant GetInputFontSlant() const; + + /** + * @brief Sets the input font's point size. + * + * @param[in] size The input font's point size. + */ + void SetInputFontPointSize( float size ); + + /** + * @brief Retrieves the input font's point size. + * + * @return The input font's point size. + */ + float GetInputFontPointSize() const; + + /** + * @brief Sets the input line spacing. + * + * @param[in] lineSpacing The line spacing. + */ + void SetInputLineSpacing( float lineSpacing ); + + /** + * @brief Retrieves the input line spacing. + * + * @return The line spacing. + */ + float GetInputLineSpacing() const; + + /** + * @brief Sets the input shadow's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] shadowProperties The shadow's properties string. + */ + void SetInputShadowProperties( const std::string& shadowProperties ); + + /** + * @brief Retrieves the input shadow's properties string. + * + * @return The shadow's properties string. + */ + const std::string& GetInputShadowProperties() const; + + /** + * @brief Sets the input underline's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] underlineProperties The underline's properties string. + */ + void SetInputUnderlineProperties( const std::string& underlineProperties ); + + /** + * @brief Retrieves the input underline's properties string. + * + * @return The underline's properties string. + */ + const std::string& GetInputUnderlineProperties() const; + + /** + * @brief Sets the input emboss's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] embossProperties The emboss's properties string. + */ + void SetInputEmbossProperties( const std::string& embossProperties ); + + /** + * @brief Retrieves the input emboss's properties string. + * + * @return The emboss's properties string. + */ + const std::string& GetInputEmbossProperties() const; + + /** + * @brief Sets input the outline's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] outlineProperties The outline's properties string. + */ + void SetInputOutlineProperties( const std::string& outlineProperties ); + + /** + * @brief Retrieves the input outline's properties string. + * + * @return The outline's properties string. + */ + const std::string& GetInputOutlineProperties() const; + +public: // Queries & retrieves. /** * @brief Return the layout engine. * * @return A reference to the layout engine. */ - LayoutEngine& GetLayoutEngine(); + Layout::Engine& GetLayoutEngine(); /** * @brief Return a view of the text. @@ -680,7 +1015,106 @@ public: */ View& GetView(); - // Text-input Event Queuing + /** + * @copydoc Control::GetNaturalSize() + */ + Vector3 GetNaturalSize(); + + /** + * @copydoc Control::GetHeightForWidth() + */ + float GetHeightForWidth( float width ); + + /** + * @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. + */ + int GetLineCount( float width ); + + /** + * @brief Retrieves the text's model. + * + * @return A pointer to the text's model. + */ + const ModelInterface* const GetTextModel() const; + + /** + * @brief Used to get scrolled distance by user input + * + * @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. + */ + bool GetTextScrollInfo( float& scrollPosition, float& controlHeight, float& layoutHeight ); + + /** + * @brief Used to set the hidden input option + */ + void SetHiddenInputOption( const Property::Map& options ); + + /** + * @brief Used to get the hidden input option + */ + void GetHiddenInputOption( Property::Map& options ); + + /** + * @brief Sets the Placeholder Properties. + * + * @param[in] map The placeholder property map + */ + void SetPlaceholderProperty( const Property::Map& map ); + + /** + * @brief Retrieves the Placeholder Property map. + * + * @param[out] map The property map + */ + void GetPlaceholderProperty( Property::Map& map ); + +public: // Relayout. + + /** + * @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. + * + * @return Whether the text model or decorations were updated. + */ + UpdateTextType Relayout( const Size& size ); + + /** + * @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(); + + /** + * @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. @@ -701,20 +1135,6 @@ public: 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. - */ - void InsertText( const std::string& text, InsertType type ); - - /** - * @brief Checks if text is selected and if so removes it. - * @return true if text was removed - */ - bool RemoveSelectedText(); - - /** * @brief Called by editable UI controls when a tap gesture occurs. * @param[in] tapCount The number of taps. * @param[in] x The x position relative to the top-left of the parent control. @@ -740,17 +1160,6 @@ public: void LongPressEvent( Gesture::State state, float x, float y ); /** - * @brief Creates a selection event. - * - * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed. - * - * @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. - */ - void SelectEvent( float x, float y, bool selectAll ); - - /** * @brief Event received from IMF manager * * @param[in] imfManager The IMF manager. @@ -760,16 +1169,12 @@ public: ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent ); /** - * @brief Paste given string into Text model - * @param[in] stringToPaste this string will be inserted into the text model - */ - void PasteText( const std::string& stringToPaste ); - - /** * @brief Event from Clipboard notifying an Item has been selected for pasting */ void PasteClipboardItemEvent(); +protected: // Inherit from Text::Decorator::ControllerInterface. + /** * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize() */ @@ -785,19 +1190,112 @@ public: */ virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y ); +protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface. + /** * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched() */ virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button ); -protected: +protected: // Inherit from HiddenText. /** - * @brief A reference counted object may only be deleted by calling Unreference(). + * @brief Invoked from HiddenText when showing time of the last character was expired */ - virtual ~Controller(); + virtual void DisplayTimeExpired(); -private: +private: // Update. + + /** + * @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. + */ + void InsertText( const std::string& text, InsertType type ); + + /** + * @brief Paste given string into Text model + * @param[in] stringToPaste this string will be inserted into the text model + */ + void PasteText( const std::string& stringToPaste ); + + /** + * @brief Remove a given number of characters + * + * 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. + * + * @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. + */ + bool RemoveText( int cursorOffset, + int numberOfCharacters, + UpdateInputStyleType type ); + + /** + * @brief Checks if text is selected and if so removes it. + * @return true if text was removed + */ + bool RemoveSelectedText(); + +private: // Relayout. + + /** + * @brief Lays-out the text. + * + * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method. + * + * @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. + */ + bool DoRelayout( const Size& size, + OperationsMask operations, + Size& layoutSize ); + + /** + * @brief Calulates the vertical offset to align the text inside the bounding box. + * + * @param[in] size The size of the bounding box. + */ + void CalculateVerticalOffset( const Size& size ); + +private: // Events. + + /** + * @brief Process queued events which modify the model. + */ + void ProcessModifyEvents(); + + /** + * @brief Used to process an event queued from SetText() + */ + void TextReplacedEvent(); + + /** + * @brief Used to process an event queued from key events etc. + */ + void TextInsertedEvent(); + + /** + * @brief Used to process an event queued from backspace key etc. + */ + void TextDeletedEvent(); + + /** + * @brief Creates a selection event. + * + * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed. + * + * @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. + */ + void SelectEvent( float x, float y, bool selectAll ); /** * @brief Helper to KeyEvent() to handle the backspace case. @@ -806,13 +1304,15 @@ private: */ bool BackspaceKeyEvent(); +private: // Helpers. + /** - * @brief Helper to notify IMF manager with surrounding text & cursor changes. + * @brief Used to remove the text included the placeholder text. */ - void NotifyImfManager(); + void ResetText(); /** - * @brief Helper to clear font-specific data. + * @brief Helper to show the place holder text.. */ void ShowPlaceholderText(); @@ -827,9 +1327,34 @@ private: 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(); + +private: // Private contructors & copy operator. + + /** + * @brief Private constructor. + */ + Controller(); + + /** * @brief Private constructor. */ - Controller( ControlInterface& controlInterface ); + Controller( ControlInterface* controlInterface ); + + /** + * @brief Private constructor. + */ + Controller( ControlInterface* controlInterface, + EditableControlInterface* editableControlInterface ); // Undefined Controller( const Controller& handle ); @@ -837,6 +1362,13 @@ private: // Undefined Controller& operator=( const Controller& handle ); +protected: // Destructor. + + /** + * @brief A reference counted object may only be deleted by calling Unreference(). + */ + virtual ~Controller(); + private: struct Impl; @@ -849,4 +1381,4 @@ private: } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__ +#endif // DALI_TOOLKIT_TEXT_CONTROLLER_H