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=a78d0ebdda13a8792b89a869fb6d746da5b2798a;hp=66bf3a00cb450aceded822d5b2ad7f4a4efb5ea2;hb=406208364fe0ee31f31f475ba7ee7709e56d3e27;hpb=2f04666b2b18b76b7310b0e8f9332b67583dbe2e diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h index 66bf3a0..a78d0eb 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) 2016 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,22 +19,13 @@ */ // EXTERNAL INCLUDES -#include #include -#include -#include #include -#include -#include -#include -#include // INTERNAL INCLUDES +#include #include -#include #include -#include -#include namespace Dali { @@ -46,19 +37,11 @@ namespace Text { class Controller; -class LayoutEngine; +class ControlInterface; +class EditableControlInterface; +class View; 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. @@ -67,11 +50,13 @@ enum PlaceholderType * It provides a view of the text that can be used by rendering back-ends. * * For selectable/editable UI controls, the controller handles input events from the UI control - * and decorations (grab handles etc) via an interface. + * and decorations (grab handles etc) via the Decorator::ControllerInterface interface. + * + * The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface. */ -class Controller : public RefObject, public Decorator::ControllerInterface +class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface { -public: +public: // Enumerated types. /** * @brief Text related operations to be done in the relayout process. @@ -88,9 +73,11 @@ public: SHAPE_TEXT = 0x0040, GET_GLYPH_METRICS = 0x0080, LAYOUT = 0x0100, - UPDATE_ACTUAL_SIZE = 0x0200, + UPDATE_LAYOUT_SIZE = 0x0200, REORDER = 0x0400, ALIGN = 0x0800, + COLOR = 0x1000, + UPDATE_DIRECTION = 0x2000, ALL_OPERATIONS = 0xFFFF }; @@ -104,12 +91,63 @@ public: }; /** + * @brief Used to specify whether to update the input style. + */ + enum UpdateInputStyleType + { + UPDATE_INPUT_STYLE, + DONT_UPDATE_INPUT_STYLE + }; + + /** + * @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, + }; + +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. @@ -120,58 +158,109 @@ public: void EnableTextInput( DecoratorPtr decorator ); /** - * @brief Replaces any text previously set. + * @brief Used to switch between bitmap & vector based glyphs * - * @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] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different. */ - void SetText( const std::string& text ); + void SetGlyphType( TextAbstraction::GlyphType glyphType ); /** - * @brief Retrieve any text previously set. + * @brief Enables/disables the mark-up processor. + * + * By default is disabled. * - * @return A string of UTF-8 characters. + * @param[in] enable Whether to enable the mark-up processor. */ - void GetText( std::string& text ) const; + void SetMarkupProcessorEnabled( bool enable ); /** - * @brief Replaces any placeholder text previously set. + * @brief Retrieves whether the mark-up processor is enabled. * - * @param[in] cursorOffset Start position from the current cursor position to start deleting characters. - * @param[in] numberOfChars The number of characters to delete from the cursorOffset. - * @return True if the remove was successful. + * By default is disabled. + * + * @return @e true if the mark-up processor is enabled, otherwise returns @e false. */ - bool RemoveText( int cursorOffset, int numberOfChars ); + bool IsMarkupProcessorEnabled() const; /** - * @brief Retrieve the current cursor position. + * @brief Enables/disables the auto text scrolling * - * @return The cursor position. + * By default is disabled. + * + * @param[in] enable Whether to enable the auto scrolling */ - unsigned int GetLogicalCursorPosition() const; + void SetAutoScrollEnabled( bool enable ); /** - * @brief Replaces any placeholder text previously set. + * @brief Retrieves whether auto text scrolling is enabled. * - * @param[in] type Different placeholder-text can be shown when the control is active/inactive. - * @param[in] text A string of UTF-8 characters. + * By default is disabled. + * + * @return @e true if auto scrolling is enabled, otherwise returns @e false. */ - void SetPlaceholderText( PlaceholderType type, const std::string& text ); + bool IsAutoScrollEnabled() const; /** - * @brief Retrieve any placeholder text previously set. + * @brief Get direction of the text from the first line of text, + * @return bool rtl (right to left) is true + */ + CharacterDirection GetAutoScrollDirection() const; + + /** + * @brief Get the alignment offset of the first line of text. * - * @param[in] type Different placeholder-text can be shown when the control is active/inactive. - * @param[out] A string of UTF-8 characters. + * @return The alignment offset. */ - void GetPlaceholderText( PlaceholderType type, std::string& text ) const; + float GetAutoScrollLineAlignment() const; + + /** + * @brief Enables the horizontal scrolling. + * + * @param[in] enable Whether to enable the horizontal scrolling. + */ + void SetHorizontalScrollEnabled( bool enable ); + + /** + * @brief Retrieves whether the horizontal scrolling is enabled. + * + * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false. + */ + bool IsHorizontalScrollEnabled() const; + + /** + * @brief Enables the vertical scrolling. + * + * @param[in] enable Whether to enable the vertical scrolling. + */ + void SetVerticalScrollEnabled( bool enable ); + + /** + * @brief Retrieves whether the verticall scrolling is enabled. + * + * @return @e true if the vertical scrolling is enabled, otherwise it returns @e false. + */ + bool IsVerticalScrollEnabled() const; + + /** + * @brief Enables the smooth handle panning. + * + * @param[in] enable Whether to enable the smooth handle panning. + */ + void SetSmoothHandlePanEnabled( bool enable ); + + /** + * @brief Retrieves whether the smooth handle panning is enabled. + * + * @return @e true if the smooth handle panning is enabled. + */ + 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( int maxCharacters ); + void SetMaximumNumberOfCharacters( Length maxCharacters ); /** * @brief Sets the maximum number of characters that can be inserted into the TextModel @@ -181,6 +270,94 @@ public: 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; + + /** + * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment() + */ + void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment ); + + /** + * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment() + */ + LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const; + + /** + * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment() + */ + void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment ); + + /** + * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment() + */ + LayoutEngine::VerticalAlignment GetVerticalAlignment() const; + +public: // Update. + + /** + * @brief Replaces any text previously set. + * + * @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[out] text A string of UTF-8 characters. + */ + void GetText( std::string& text ) const; + + /** + * @brief Replaces any placeholder text previously set. + * + * @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 ); + + /** + * @brief Retrieve any placeholder text previously set. + * + * @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; + + /** + * @ brief Update the text after a font change + * @param[in] newDefaultFont The new font to change to + */ + void UpdateAfterFontChange( const std::string& newDefaultFont ); + +public: // Default style & Input style + + /** * @brief Set the default font family. * * @param[in] defaultFontFamily The default font family. @@ -195,23 +372,66 @@ public: const std::string& GetDefaultFontFamily() const; /** - * @brief Set the default font style. + * @brief Sets the default font weight. * - * @param[in] defaultFontStyle The default font style. + * @param[in] weight The font weight. + */ + void SetDefaultFontWeight( FontWeight weight ); + + /** + * @brief Whether the font's weight has been defined. */ - void SetDefaultFontStyle( const std::string& defaultFontStyle ); + bool IsDefaultFontWeightDefined() const; /** - * @brief Retrieve the default font style. + * @brief Retrieves the default font weight. * - * @return The default font style. + * @return The default font weight. */ - const std::string& GetDefaultFontStyle() const; + FontWeight GetDefaultFontWeight() const; + + /** + * @brief Sets the default font width. + * + * @param[in] width The font width. + */ + 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. + */ + FontWidth GetDefaultFontWidth() const; + + /** + * @brief Sets the default font slant. + * + * @param[in] slant The font slant. + */ + 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. + */ + FontSlant GetDefaultFontSlant() const; /** * @brief Set the default point size. * - * @param[in] defaultFontStyle The default point size. + * @param[in] pointSize The default point size. */ void SetDefaultPointSize( float pointSize ); @@ -321,141 +541,229 @@ public: float GetUnderlineHeight() const; /** - * @brief Called to enable/disable cursor blink. + * @brief Sets the emboss'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] embossProperties The emboss's properties string. */ - void SetEnableCursorBlink( bool enable ); + void SetDefaultEmbossProperties( const std::string& embossProperties ); /** - * @brief Query whether cursor blink is enabled. + * @brief Retrieves the emboss's properties string. * - * @return Whether the cursor should blink or not. + * @return The emboss's properties string. */ - bool GetEnableCursorBlink() const; + const std::string& GetDefaultEmbossProperties() const; /** - * @brief Query the current scroll position; the UI control is responsible for moving actors to this position. + * @brief Sets the outline's properties string. * - * @return The scroll position. + * @note The string is stored to be recovered. + * + * @param[in] outlineProperties The outline's properties string. */ - const Vector2& GetScrollPosition() const; + void SetDefaultOutlineProperties( const std::string& outlineProperties ); /** - * @brief Query the alignment offset. + * @brief Retrieves the outline's properties string. * - * @return The alignmnet offset. + * @return The outline's properties string. */ - const Vector2& GetAlignmentOffset() const; + const std::string& GetDefaultOutlineProperties() const; /** - * @copydoc Control::GetNaturalSize() + * @brief Sets the default line spacing. + * + * @param[in] lineSpacing The line spacing. */ - Vector3 GetNaturalSize(); + void SetDefaultLineSpacing( float lineSpacing ); /** - * @copydoc Control::GetHeightForWidth() + * @brief Retrieves the default line spacing. + * + * @return The line spacing. */ - float GetHeightForWidth( float width ); + float GetDefaultLineSpacing() const; /** - * @brief Triggers a relayout which updates View (if necessary). + * @brief Sets the input text's color. * - * @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] color The input text's color. */ - bool Relayout( const Size& size ); + void SetInputColor( const Vector4& color ); /** - * @brief Process queued events which modify the model. + * @brief Retrieves the input text's color. + * + * @return The input text's color. */ - void ProcessModifyEvents(); + const Vector4& GetInputColor() const; /** - * @brief Used to remove placeholder text. + * @brief Sets the input text's font family name. + * + * @param[in] fontFamily The text's font family name. */ - void ResetText(); + void SetInputFontFamily( const std::string& fontFamily ); /** - * @brief Used to reset the cursor position after setting a new text. + * @brief Retrieves the input text's font family name. * - * @param[in] cursorIndex Where to place the cursor. + * @return The input text's font family name. */ - void ResetCursorPosition( CharacterIndex cursorIndex ); + const std::string& GetInputFontFamily() const; /** - * @brief Used to reset the scroll position after setting a new text. + * @brief Sets the input font's weight. + * + * @param[in] weight The input font's weight. */ - void ResetScrollPosition(); + void SetInputFontWeight( FontWeight weight ); /** - * @brief Used to process an event queued from SetText() + * @return Whether the font's weight has been defined. */ - void TextReplacedEvent(); + bool IsInputFontWeightDefined() const; /** - * @brief Used to process an event queued from key events etc. + * @brief Retrieves the input font's weight. + * + * @return The input font's weight. */ - void TextInsertedEvent(); + FontWeight GetInputFontWeight() const; /** - * @brief Used to process an event queued from backspace key etc. + * @brief Sets the input font's width. + * + * @param[in] width The input font's width. */ - void TextDeletedEvent(); + void SetInputFontWidth( FontWidth width ); /** - * @brief Lays-out the text. + * @return Whether the font's width has been defined. + */ + bool IsInputFontWidthDefined() const; + + /** + * @brief Retrieves the input font's width. * - * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method. + * @return The input font's width. + */ + FontWidth GetInputFontWidth() const; + + /** + * @brief Sets the input font's slant. * - * @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] slant The input font's slant. */ - bool DoRelayout( const Size& size, - OperationsMask operations, - Size& layoutSize ); + void SetInputFontSlant( FontSlant slant ); /** - * @brief Whether to enable the multi-line layout. + * @return Whether the font's slant has been defined. + */ + bool IsInputFontSlantDefined() const; + + /** + * @brief Retrieves the input font's slant. * - * @param[in] enable \e true enables the multi-line (by default) + * @return The input font's slant. */ - void SetMultiLineEnabled( bool enable ); + FontSlant GetInputFontSlant() const; /** - * @return Whether the multi-line layout is enabled. + * @brief Sets the input font's point size. + * + * @param[in] size The input font's point size. */ - bool IsMultiLineEnabled() const; + void SetInputFontPointSize( float size ); /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment() + * @brief Retrieves the input font's point size. + * + * @return The input font's point size. */ - void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment ); + float GetInputFontPointSize() const; /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment() + * @brief Sets the input line spacing. + * + * @param[in] lineSpacing The line spacing. */ - LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const; + void SetInputLineSpacing( float lineSpacing ); /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment() + * @brief Retrieves the input line spacing. + * + * @return The line spacing. */ - void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment ); + float GetInputLineSpacing() const; /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment() + * @brief Sets the input shadow's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] shadowProperties The shadow's properties string. */ - LayoutEngine::VerticalAlignment GetVerticalAlignment() const; + void SetInputShadowProperties( const std::string& shadowProperties ); /** - * @brief Calulates the alignment of the whole text inside the bounding box. + * @brief Retrieves the input shadow's properties string. * - * @param[in] size The size of the bounding box. + * @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 CalculateTextAlignment( const Size& size ); + 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. @@ -471,36 +779,77 @@ public: */ View& GetView(); - // Text-input Event Queuing + /** + * @brief Query the current scroll position; the UI control is responsible for moving actors to this position. + * + * @return The scroll position. + */ + const Vector2& GetScrollPosition() const; /** - * @brief Caller by editable UI controls when keyboard focus is gained. + * @copydoc Control::GetNaturalSize() */ - void KeyboardFocusGainEvent(); + Vector3 GetNaturalSize(); /** - * @brief Caller by editable UI controls when focus is lost. + * @copydoc Control::GetHeightForWidth() */ - void KeyboardFocusLostEvent(); + float GetHeightForWidth( float width ); + +public: // Relayout. /** - * @brief Caller by editable UI controls when key events are received. + * @brief Triggers a relayout which updates View (if necessary). * - * @param[in] event The key event. - * @param[in] type Used to distinguish between regular key events and IMF events. + * @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. */ - bool KeyEvent( const Dali::KeyEvent& event ); + UpdateTextType Relayout( const Size& size ); /** - * @brief Caller by editable UI controls when key events are received. + * @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. * - * @param[in] text The text to insert. + * 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. + */ + void KeyboardFocusGainEvent(); + + /** + * @brief Called by editable UI controls when focus is lost. + */ + void KeyboardFocusLostEvent(); + + /** + * @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. */ - void InsertText( const std::string& text, InsertType type ); + bool KeyEvent( const Dali::KeyEvent& event ); /** - * @brief Caller by editable UI controls when a tap gesture occurs. + * @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. * @param[in] y The y position relative to the top-left of the parent control. @@ -508,7 +857,7 @@ public: void TapEvent( unsigned int tapCount, float x, float y ); /** - * @brief Caller by editable UI controls when a pan gesture occurs. + * @brief Called by editable UI controls when a pan gesture occurs. * * @param[in] state The state of the gesture. * @param[in] displacement This distance panned since the last pan gesture. @@ -516,6 +865,15 @@ public: void PanEvent( Gesture::State state, const Vector2& displacement ); /** + * @brief Called by editable UI controls when a long press gesture occurs. + * + * @param[in] state The state of the gesture. + * @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 ); + + /** * @brief Event received from IMF manager * * @param[in] imfManager The IMF manager. @@ -525,6 +883,13 @@ public: ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent ); /** + * @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() */ virtual void GetTargetSize( Vector2& targetSize ); @@ -539,24 +904,124 @@ public: */ virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y ); -protected: +protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface. /** - * @brief A reference counted object may only be deleted by calling Unreference(). + * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched() */ - virtual ~Controller(); + virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button ); -private: +private: // Update. /** - * @brief Helper to clear font-specific data. + * @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 ShowPlaceholderText(); + 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 Helper to clear all the model data except for LogicalModel::mText. + * @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. */ - void ClearModelData(); + 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. + * + * @return True if a character was deleted. + */ + bool BackspaceKeyEvent(); + +private: // Helpers. + + /** + * @brief Used to remove the text included the placeholder text. + */ + void ResetText(); + + /** + * @brief Helper to show the place holder text.. + */ + void ShowPlaceholderText(); /** * @brief Helper to clear font-specific data (only). @@ -564,9 +1029,39 @@ private: void ClearFontData(); /** + * @brief Helper to clear text's style data. + */ + 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( ControlInterface& controlInterface ); + Controller(); + + /** + * @brief Private constructor. + */ + Controller( ControlInterface* controlInterface ); + + /** + * @brief Private constructor. + */ + Controller( ControlInterface* controlInterface, + EditableControlInterface* editableControlInterface ); // Undefined Controller( const Controller& handle ); @@ -574,6 +1069,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; @@ -586,4 +1088,4 @@ private: } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__ +#endif // DALI_TOOLKIT_TEXT_CONTROLLER_H