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=7e2213422a5245870912be620632a0d39b2ac746;hb=406208364fe0ee31f31f475ba7ee7709e56d3e27;hpb=269ef791ecea99b85d6241ad8e39769e1db312b3 diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h index 7e22134..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. @@ -26,7 +26,6 @@ #include #include #include -#include namespace Dali { @@ -38,19 +37,11 @@ namespace Text { class Controller; +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. @@ -65,7 +56,7 @@ enum PlaceholderType */ class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface { -public: +public: // Enumerated types. /** * @brief Text related operations to be done in the relayout process. @@ -82,10 +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 }; @@ -99,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. * - * @param[in] controlInterface An interface used to request a text relayout. * @return A pointer to a new Controller. */ - static ControllerPtr New( ControlInterface& controlInterface ); + 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 The control's interface. + * @param[in] editableControlInterface The editable control's interface. + * + * @return A pointer to a new Controller. + */ + static ControllerPtr New( ControlInterface* controlInterface, + EditableControlInterface* editableControlInterface ); + +public: // Configure the text controller. /** * @brief Called to enable text input. @@ -115,6 +158,13 @@ public: void EnableTextInput( DecoratorPtr decorator ); /** + * @brief Used to switch between bitmap & vector based glyphs + * + * @param[in] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different. + */ + void SetGlyphType( TextAbstraction::GlyphType glyphType ); + + /** * @brief Enables/disables the mark-up processor. * * By default is disabled. @@ -133,51 +183,77 @@ public: bool IsMarkupProcessorEnabled() const; /** - * @brief Replaces any text previously set. + * @brief Enables/disables the auto text scrolling * - * @note This will be converted into UTF-32 when stored in the text model. - * @param[in] text A string of UTF-8 characters. + * By default is disabled. + * + * @param[in] enable Whether to enable the auto scrolling */ - void SetText( const std::string& text ); + void SetAutoScrollEnabled( bool enable ); /** - * @brief Retrieve any text previously set. + * @brief Retrieves whether auto text scrolling is enabled. + * + * By default is disabled. * - * @return A string of UTF-8 characters. + * @return @e true if auto scrolling is enabled, otherwise returns @e false. */ - void GetText( std::string& text ) const; + bool IsAutoScrollEnabled() const; /** - * @brief Remove a given number of characters + * @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] cursorOffset Start position from the current cursor position to start deleting characters. - * @param[in] numberOfCharacters The number of characters to delete from the cursorOffset. - * @return True if the remove was successful. + * @return The alignment offset. */ - bool RemoveText( int cursorOffset, int numberOfCharacters ); + float GetAutoScrollLineAlignment() const; /** - * @brief Retrieve the current cursor position. + * @brief Enables the horizontal scrolling. * - * @return The cursor position. + * @param[in] enable Whether to enable the horizontal scrolling. */ - unsigned int GetLogicalCursorPosition() const; + void SetHorizontalScrollEnabled( bool enable ); /** - * @brief Replaces any placeholder text previously set. + * @brief Retrieves whether the horizontal 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. + * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false. */ - void SetPlaceholderText( PlaceholderType type, const std::string& text ); + bool IsHorizontalScrollEnabled() const; /** - * @brief Retrieve any placeholder text previously set. + * @brief Enables the vertical scrolling. * - * @param[in] type Different placeholder-text can be shown when the control is active/inactive. - * @param[out] A string of UTF-8 characters. + * @param[in] enable Whether to enable the vertical scrolling. */ - void GetPlaceholderText( PlaceholderType type, std::string& text ) const; + 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 @@ -194,34 +270,106 @@ 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 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 ); /** - * @brief Sets the font's style string. + * @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. * - * @note The style set may be changed by the underlying font system. The string is stored to be recovered. + * @param[out] text A string of UTF-8 characters. + */ + void GetText( std::string& text ) const; + + /** + * @brief Replaces any placeholder text previously set. * - * @param[in] style The font's style string. + * @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 SetDefaultFontStyle( const std::string& style ); + void SetPlaceholderText( PlaceholderType type, const std::string& text ); /** - * @brief Retrieves the font's style. + * @brief Retrieve any placeholder text previously set. * - * @return The font's style. + * @param[in] type Different placeholder-text can be shown when the control is active/inactive. + * @param[out] A string of UTF-8 characters. */ - const std::string& GetDefaultFontStyle() const; + 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. + */ + void SetDefaultFontFamily( const std::string& defaultFontFamily ); + + /** + * @brief Retrieve the default font family. + * + * @return The default font family. + */ + const std::string& GetDefaultFontFamily() const; /** * @brief Sets the default font weight. @@ -231,6 +379,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. @@ -245,6 +398,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. @@ -259,6 +417,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. @@ -280,12 +443,6 @@ public: float GetDefaultPointSize() const; /** - * @ brief Update the text after a font change - * @param[in] newDefaultFont The new font to change to - */ - void UpdateAfterFontChange( const std::string& newDefaultFont ); - - /** * @brief Set the text color * * @param textColor The text color @@ -384,6 +541,52 @@ public: 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. @@ -412,20 +615,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. @@ -433,6 +622,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. @@ -447,6 +641,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. @@ -461,6 +660,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. @@ -482,157 +686,149 @@ public: float GetInputFontPointSize() const; /** - * @brief Called to enable/disable cursor blink. + * @brief Sets the input line spacing. * - * @note Only editable controls should calls this. - * @param[in] enabled Whether the cursor should blink or not. + * @param[in] lineSpacing The line spacing. */ - void SetEnableCursorBlink( bool enable ); + void SetInputLineSpacing( float lineSpacing ); /** - * @brief Query whether cursor blink is enabled. + * @brief Retrieves the input line spacing. * - * @return Whether the cursor should blink or not. + * @return The line spacing. */ - bool GetEnableCursorBlink() const; + float GetInputLineSpacing() const; /** - * @brief Query the current scroll position; the UI control is responsible for moving actors to this position. + * @brief Sets the input shadow's properties string. * - * @return The scroll position. - */ - const Vector2& GetScrollPosition() const; - - /** - * @brief Query the alignment offset. + * @note The string is stored to be recovered. * - * @return The alignmnet offset. + * @param[in] shadowProperties The shadow's properties string. */ - const Vector2& GetAlignmentOffset() const; + void SetInputShadowProperties( const std::string& shadowProperties ); /** - * @copydoc Control::GetNaturalSize() + * @brief Retrieves the input shadow's properties string. + * + * @return The shadow's properties string. */ - Vector3 GetNaturalSize(); + const std::string& GetInputShadowProperties() const; /** - * @copydoc Control::GetHeightForWidth() + * @brief Sets the input underline's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] underlineProperties The underline's properties string. */ - float GetHeightForWidth( float width ); + void SetInputUnderlineProperties( const std::string& underlineProperties ); /** - * @brief Triggers a relayout which updates View (if necessary). + * @brief Retrieves the input underline's properties string. * - * @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. + * @return The underline's properties string. */ - bool Relayout( const Size& size ); + const std::string& GetInputUnderlineProperties() const; /** - * @brief Process queued events which modify the model. + * @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 ProcessModifyEvents(); + void SetInputEmbossProperties( const std::string& embossProperties ); /** - * @brief Used to remove placeholder text. + * @brief Retrieves the input emboss's properties string. + * + * @return The emboss's properties string. */ - void ResetText(); + const std::string& GetInputEmbossProperties() const; /** - * @brief Used to reset the cursor position after setting a new text. + * @brief Sets input the outline's properties string. * - * @param[in] cursorIndex Where to place the cursor. + * @note The string is stored to be recovered. + * + * @param[in] outlineProperties The outline's properties string. */ - void ResetCursorPosition( CharacterIndex cursorIndex ); + void SetInputOutlineProperties( const std::string& outlineProperties ); /** - * @brief Used to reset the scroll position after setting a new text. + * @brief Retrieves the input outline's properties string. + * + * @return The outline's properties string. */ - void ResetScrollPosition(); + const std::string& GetInputOutlineProperties() const; - /** - * @brief Used to process an event queued from SetText() - */ - void TextReplacedEvent(); +public: // Queries & retrieves. /** - * @brief Used to process an event queued from key events etc. - */ - void TextInsertedEvent(); - - /** - * @brief Used to process an event queued from backspace key etc. + * @brief Return the layout engine. + * + * @return A reference to the layout engine. */ - void TextDeletedEvent(); + LayoutEngine& GetLayoutEngine(); /** - * @brief Lays-out the text. - * - * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method. + * @brief Return a view of the text. * - * @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 A reference to the view. */ - bool DoRelayout( const Size& size, - OperationsMask operations, - Size& layoutSize ); + View& GetView(); /** - * @brief Whether to enable the multi-line layout. + * @brief Query the current scroll position; the UI control is responsible for moving actors to this position. * - * @param[in] enable \e true enables the multi-line (by default) + * @return The scroll position. */ - void SetMultiLineEnabled( bool enable ); + const Vector2& GetScrollPosition() const; /** - * @return Whether the multi-line layout is enabled. + * @copydoc Control::GetNaturalSize() */ - bool IsMultiLineEnabled() const; + Vector3 GetNaturalSize(); /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment() + * @copydoc Control::GetHeightForWidth() */ - void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment ); + float GetHeightForWidth( float width ); - /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment() - */ - LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const; +public: // Relayout. /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment() + * @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. */ - void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment ); + UpdateTextType Relayout( const Size& size ); /** - * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment() + * @brief Request a relayout using the ControlInterface. */ - LayoutEngine::VerticalAlignment GetVerticalAlignment() const; + void RequestRelayout(); - /** - * @brief Calulates the alignment of the whole text inside the bounding box. - * - * @param[in] size The size of the bounding box. - */ - void CalculateTextAlignment( const Size& size ); +public: // Input style change signals. /** - * @brief Return the layout engine. - * - * @return A reference to the layout engine. + * @return Whether the queue of input style changed signals is empty. */ - LayoutEngine& GetLayoutEngine(); + bool IsInputStyleChangedSignalsQueueEmpty(); /** - * @brief Return a view of the text. + * @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. @@ -653,20 +849,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. @@ -692,17 +874,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. @@ -712,16 +883,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() */ @@ -737,19 +904,105 @@ 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: +private: // Update. /** - * @brief A reference counted object may only be deleted by calling Unreference(). + * @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. */ - virtual ~Controller(); + void InsertText( const std::string& text, InsertType type ); -private: + /** + * @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. @@ -758,20 +1011,17 @@ private: */ bool BackspaceKeyEvent(); - /** - * @brief Helper to notify IMF manager with surrounding text & cursor changes. - */ - void NotifyImfManager(); +private: // Helpers. /** - * @brief Helper to clear font-specific data. + * @brief Used to remove the text included the placeholder text. */ - void ShowPlaceholderText(); + void ResetText(); /** - * @brief Helper to clear all the model data except for LogicalModel::mText. + * @brief Helper to show the place holder text.. */ - void ClearModelData(); + void ShowPlaceholderText(); /** * @brief Helper to clear font-specific data (only). @@ -784,9 +1034,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( ControlInterface& controlInterface ); + Controller(); + + /** + * @brief Private constructor. + */ + Controller( ControlInterface* controlInterface ); + + /** + * @brief Private constructor. + */ + Controller( ControlInterface* controlInterface, + EditableControlInterface* editableControlInterface ); // Undefined Controller( const Controller& handle ); @@ -794,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; @@ -806,4 +1088,4 @@ private: } // namespace Dali -#endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__ +#endif // DALI_TOOLKIT_TEXT_CONTROLLER_H