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=e3a7427a092ade6ce4e77d19f1b02914b91beed9;hp=304ad2f8aac76a78ab88b32a1079ad30687b1e21;hb=41d36118a13932bcf1db39b780ac437fcda8aa08;hpb=e3205fb690b51c9b1175650a47d7ed6c4b9ec93b diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h old mode 100644 new mode 100755 index 304ad2f..82a7a15 --- 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) 2018 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,14 +19,18 @@ */ // EXTERNAL INCLUDES -#include +#include #include // INTERNAL INCLUDES +#include #include +#include +#include #include #include -#include +#include +#include namespace Dali { @@ -38,19 +42,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 +60,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 +74,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,28 +104,95 @@ 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(); + + /** + * @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. * * @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 @@ -230,6 +293,326 @@ public: bool IsSmoothHandlePanEnabled() 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 + */ + void SetMaximumNumberOfCharacters( Length maxCharacters ); + + /** + * @brief Sets the maximum number of characters that can be inserted into the TextModel + * + * @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 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 ); + +public: // Update. + + /** * @brief Replaces any text previously set. * * @note This will be converted into UTF-32 when stored in the text model. @@ -245,22 +628,6 @@ public: void GetText( std::string& text ) const; /** - * @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 Replaces any placeholder text previously set. * * @param[in] type Different placeholder-text can be shown when the control is active/inactive. @@ -277,18 +644,12 @@ public: 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 - * - * @param[in] maxCharacters maximum number of characters to be accepted - */ - int GetMaximumNumberOfCharacters(); +public: // Default style & Input style /** * @brief Set the default font family. @@ -305,20 +666,17 @@ 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. @@ -328,6 +686,11 @@ public: void SetDefaultFontWeight( FontWeight weight ); /** + * @brief Whether the font's weight has been defined. + */ + bool IsDefaultFontWeightDefined() const; + + /** * @brief Retrieves the default font weight. * * @return The default font weight. @@ -335,6 +698,27 @@ 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. @@ -342,6 +726,11 @@ public: void SetDefaultFontWidth( FontWidth width ); /** + * @brief Whether the font's width has been defined. + */ + bool IsDefaultFontWidthDefined() const; + + /** * @brief Retrieves the default font width. * * @return The default font width. @@ -349,6 +738,27 @@ 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. @@ -356,6 +766,11 @@ public: void SetDefaultFontSlant( FontSlant slant ); /** + * @brief Whether the font's slant has been defined. + */ + bool IsDefaultFontSlantDefined() const; + + /** * @brief Retrieves the default font slant. * * @return The default font slant. @@ -363,38 +778,69 @@ 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 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 UpdateAfterFontChange( const std::string& newDefaultFont ); + void SetPlaceholderTextFontSize( float fontSize, FontSizeType type ); /** - * @brief Set the text color + * @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 textColor The text color + * @param color The default color. */ - void SetTextColor( const Vector4& textColor ); + void SetDefaultColor( const Vector4& color ); /** - * @brief Retrieve the text color + * @brief Retrieves the text's default color. * - * @return The text color + * @return The default color. */ - const Vector4& GetTextColor() const; + const Vector4& GetDefaultColor() const; /** * @brief Set the text color @@ -439,20 +885,18 @@ public: const Vector4& GetShadowColor() const; /** - * @brief Sets the shadow's properties string. + * @brief Set the shadow blur radius. * - * @note The string is stored to be recovered. - * - * @param[in] shadowProperties The shadow's properties string. + * @param[in] shadowBlurRadius The shadow blur radius, 0,0 indicates no blur. */ - void SetDefaultShadowProperties( const std::string& shadowProperties ); + void SetShadowBlurRadius( const float& shadowBlurRadius ); /** - * @brief Retrieves the shadow's properties string. + * @brief Retrieve the shadow blur radius. * - * @return The shadow's properties string. + * @return The shadow blur radius. */ - const std::string& GetDefaultShadowProperties() const; + const float& GetShadowBlurRadius() const; /** * @brief Set the underline color. @@ -473,44 +917,84 @@ public: * * @param[in] enabled The underline enabled flag. */ - void SetUnderlineEnabled( bool enabled ); + 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 Set the outline color. + * + * @param[in] color color of outline. + */ + void SetOutlineColor( const Vector4& color ); + + /** + * @brief Retrieve the outline color. + * + * @return The outline color. + */ + const Vector4& GetOutlineColor() const; + + /** + * @brief Set the outline width + * + * @param[in] width The width in pixels of the outline, 0 indicates no outline + */ + 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. @@ -548,8 +1032,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. @@ -587,20 +1073,6 @@ 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. - * - * @return The input text's font style. - */ - const std::string& GetInputFontStyle() const; - - /** * @brief Sets the input font's weight. * * @param[in] weight The input font's weight. @@ -608,6 +1080,11 @@ public: 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. @@ -622,6 +1099,11 @@ public: 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. @@ -636,6 +1118,11 @@ public: 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. @@ -735,26 +1222,27 @@ public: const std::string& GetInputOutlineProperties() const; /** - * @brief Called to enable/disable cursor blink. + * @brief Set the control's interface. * - * @note Only editable controls should calls this. - * @param[in] enabled Whether the cursor should blink or not. + * @param[in] controlInterface The control's interface. */ - void SetEnableCursorBlink( bool enable ); + void SetControlInterface( ControlInterface* controlInterface ); + +public: // Queries & retrieves. /** - * @brief Query whether cursor blink is enabled. + * @brief Return the layout engine. * - * @return Whether the cursor should blink or not. + * @return A reference to the layout engine. */ - bool GetEnableCursorBlink() const; + 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() @@ -767,119 +1255,162 @@ public: 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. - * - * @return Whether the text model or decorations were updated. + * @brief Calculates the point size for text for given layout() */ - UpdateTextType Relayout( const Size& size ); + void FitPointSizeforLayout( Size layoutSize ); /** - * @brief Process queued events which modify the model. + * @brief Checks if the point size fits within the layout size. + * + * @return Whether the point size fits within the layout size. */ - void ProcessModifyEvents(); + bool CheckForTextFit( float pointSize, Size& layoutSize ); /** - * @brief Used to remove placeholder text. + * @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 ResetText(); + int GetLineCount( float width ); /** - * @brief Used to reset the cursor position after setting a new text. + * @brief Retrieves the text's model. * - * @param[in] cursorIndex Where to place the cursor. + * @return A pointer to the text's model. */ - void ResetCursorPosition( CharacterIndex cursorIndex ); + const ModelInterface* const GetTextModel() const; /** - * @brief Used to reset the scroll position after setting a new text. + * @brief Used to get scrolled distance by user input + * + * @return Distance from last scroll offset to new scroll offset */ - void ResetScrollPosition(); + float GetScrollAmountByUserInput(); /** - * @brief Used to process an event queued from SetText() + * @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 TextReplacedEvent(); + bool GetTextScrollInfo( float& scrollPosition, float& controlHeight, float& layoutHeight ); /** - * @brief Used to process an event queued from key events etc. + * @brief Used to set the hidden input option */ - void TextInsertedEvent(); + void SetHiddenInputOption( const Property::Map& options ); /** - * @brief Used to process an event queued from backspace key etc. + * @brief Used to get the hidden input option */ - void TextDeletedEvent(); + void GetHiddenInputOption( 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(); /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment() + * @brief Retrieves vertical line alignment + * @return The vertical line alignment */ - void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment ); + Toolkit::DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const; /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment() + * @brief Sets vertical line alignment + * @param[in] alignment The vertical line alignment for the text */ - LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const; + void SetVerticalLineAlignment( Toolkit::DevelText::VerticalLineAlignment::Type alignment ); /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment() + * @brief Retrieves ignoreSpaceAfterText value from model + * @return The value of ignoreSpaceAfterText */ - void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment ); + bool IsIgnoreSpacesAfterText() const; /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment() + * @brief Sets ignoreSpaceAfterText value to model + * @param[in] ignore The value of ignoreSpacesAfterText for the text */ - LayoutEngine::VerticalAlignment GetVerticalAlignment() const; + void SetIgnoreSpacesAfterText( bool ignore ); /** - * @brief Calulates the vertical offset to align the text inside the bounding box. - * - * @param[in] size The size of the bounding box. + * @brief Retrieves matchSystemLanguageDirection value from model + * @return The value of matchSystemLanguageDirection */ - void CalculateVerticalOffset( const Size& size ); + bool IsMatchSystemLanguageDirection() const; /** - * @brief Return the layout engine. + * @brief Sets matchSystemLanguageDirection value to model + * @param[in] match The value of matchSystemLanguageDirection for the text + */ + void SetMatchSystemLanguageDirection( bool match ); + + /** + * @brief Sets layoutDirection value + * @param[in] layoutDirection The value of system language direction + */ + void SetLayoutDirection( Dali::LayoutDirection::Type layoutDirection ); + + /** + * @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 layout engine. + * @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. */ - LayoutEngine& GetLayoutEngine(); + UpdateTextType Relayout( const Size& size, Dali::LayoutDirection::Type layoutDirection = Dali::LayoutDirection::LEFT_TO_RIGHT ); /** - * @brief Return a view of the text. + * @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. * - * @return A reference to the view. + * 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. */ - View& GetView(); + void ProcessInputStyleChangedSignals(); - // Text-input Event Queuing +public: // Text-input Event Queuing. /** * @brief Called by editable UI controls when keyboard focus is gained. @@ -895,25 +1426,11 @@ 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. + * @param[in] type Used to distinguish between regular key events and InputMethodContext 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. - */ - 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. @@ -950,24 +1467,34 @@ public: void SelectEvent( float x, float y, bool selectAll ); /** - * @brief Event received from IMF manager + * @brief Event received from input method context * - * @param[in] imfManager The IMF manager. - * @param[in] imfEvent The event received. + * @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. */ - ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent ); + InputMethodContext::CallbackData OnInputMethodContextEvent( InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent ); /** - * @brief Paste given string into Text model - * @param[in] stringToPaste this string will be inserted into the text model + * @brief Event from Clipboard notifying an Item has been selected for pasting */ - void PasteText( const std::string& stringToPaste ); + void PasteClipboardItemEvent(); /** - * @brief Event from Clipboard notifying an Item has been selected for pasting + * @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. */ - void PasteClipboardItemEvent(); + bool ShouldClearFocusOnEscape() const; + + /** + * @brief Create an actor that renders the text background color + * + * @return the created actor or an empty handle if no background color needs to be rendered. + */ + Actor CreateBackgroundActor(); + +protected: // Inherit from Text::Decorator::ControllerInterface. /** * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize() @@ -984,29 +1511,119 @@ 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 InputMethodContext 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 Helper to KeyEvent() to handle the backspace case. + * @brief Used to process an event queued from backspace key etc. + */ + void TextDeletedEvent(); + + /** + * @brief Helper to KeyEvent() to handle the backspace or delete key case. * + * @param[in] keyCode The keycode for the key pressed * @return True if a character was deleted. */ - bool BackspaceKeyEvent(); + bool DeleteEvent( int keyCode ); + +private: // Helpers. + + /** + * @brief Used to remove the text included the placeholder text. + */ + void ResetText(); /** - * @brief Helper to clear font-specific data. + * @brief Helper to show the place holder text.. */ void ShowPlaceholderText(); @@ -1021,9 +1638,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 ); + + /** * @brief Private constructor. */ - Controller( ControlInterface& controlInterface ); + Controller( ControlInterface* controlInterface, + EditableControlInterface* editableControlInterface ); // Undefined Controller( const Controller& handle ); @@ -1031,9 +1673,19 @@ private: // 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 Impl; Impl* mImpl; }; @@ -1043,4 +1695,4 @@ private: } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__ +#endif // DALI_TOOLKIT_TEXT_CONTROLLER_H