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=99c2ab09cb4f81bf04b80544298d5b5912db4e17;hp=d37efabc7b862663cfbf79a5d7094dcc5926ddaf;hb=5b3cf0e6742934674bdf62bbe15af00e39eae566;hpb=c11c7538e070434e84856ebd4af000dff4ca3f9a diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h index d37efab..99c2ab0 100644 --- a/dali-toolkit/internal/text/text-controller.h +++ b/dali-toolkit/internal/text/text-controller.h @@ -19,20 +19,14 @@ */ // EXTERNAL INCLUDES -#include -#include -#include +#include #include -#include -#include -#include -#include // INTERNAL INCLUDES +#include #include -#include +#include #include -#include namespace Dali { @@ -44,23 +38,34 @@ namespace Text { class Controller; -class LayoutEngine; +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. * * It manipulates the Logical & Visual text models on behalf of the UI Controls. * 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 observer 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::Observer +class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface { -private: +public: /** * @brief Text related operations to be done in the relayout process. @@ -83,7 +88,14 @@ private: ALL_OPERATIONS = 0xFFFF }; -public: + /** + * @brief Used to distinguish between regular key events and IMF events + */ + enum InsertType + { + COMMIT, + PRE_EDIT + }; /** * @brief Create a new instance of a Controller. @@ -94,6 +106,14 @@ public: static ControllerPtr New( ControlInterface& controlInterface ); /** + * @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. + */ + void EnableTextInput( DecoratorPtr decorator ); + + /** * @brief Replaces any text previously set. * * @note This will be converted into UTF-32 when stored in the text model. @@ -109,18 +129,50 @@ public: void GetText( std::string& text ) const; /** + * @brief Remove a given number of characters + * + * @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. + */ + bool RemoveText( int cursorOffset, int numberOfChars ); + + /** + * @brief Retrieve the current cursor position. + * + * @return The cursor position. + */ + unsigned int GetLogicalCursorPosition() 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( const std::string& text ); + void SetPlaceholderText( PlaceholderType type, const std::string& text ); /** * @brief Retrieve any placeholder text previously set. * - * @return A string of UTF-8 characters. + * @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( std::string& text ) const; + void GetPlaceholderText( PlaceholderType type, std::string& text ) const; + + /** + * @brief Sets the maximum number of characters that can be inserted into the TextModel + * + * @param[in] maxCharacters maximum number of characters to be accepted + */ + void SetMaximumNumberOfCharacters( int 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 Set the default font family. @@ -165,26 +217,32 @@ public: float GetDefaultPointSize() const; /** - * @brief Retrieve the default fonts. + * @brief Set the text color + * + * @param textColor The text color + */ + void SetTextColor( const Vector4& textColor ); + + /** + * @brief Retrieve the text color * - * @param[out] fonts The default font family, style and point sizes. - * @param[in] numberOfCharacters The number of characters in the logical model. + * @return The text color */ - void GetDefaultFonts( Dali::Vector& fonts, Length numberOfCharacters ) const; + const Vector4& GetTextColor() const; /** * @brief Set the text color * * @param textColor The text color */ - void SetTextColor( const Vector4& textColor ); + void SetPlaceholderTextColor( const Vector4& textColor ); /** * @brief Retrieve the text color * * @return The text color */ - const Vector4& GetTextColor() const; + const Vector4& GetPlaceholderTextColor() const; /** * @brief Set the shadow offset. @@ -257,14 +315,6 @@ public: float GetUnderlineHeight() const; /** - * @brief Called to enable text input. - * - * @note Only selectable or editable controls should calls this. - * @param[in] decorator Used to create cursor, selection handle decorations etc. - */ - void EnableTextInput( DecoratorPtr decorator ); - - /** * @brief Called to enable/disable cursor blink. * * @note Only editable controls should calls this. @@ -318,30 +368,36 @@ public: void ProcessModifyEvents(); /** - * @brief Used to process an event queued from SetText() - * - * @param[in] newText The new text to store in the logical model. + * @brief Used to remove placeholder text. */ - void ReplaceTextEvent( const std::string& newText ); + void ResetText(); /** - * @brief Used to process an event queued from key events etc. + * @brief Used to reset the cursor position after setting a new text. * - * @param[in] text The text to insert into the logical model. + * @param[in] cursorIndex Where to place the cursor. */ - void InsertTextEvent( const std::string& text ); + void ResetCursorPosition( CharacterIndex cursorIndex ); /** - * @brief Used to process an event queued from backspace key etc. + * @brief Used to reset the scroll position after setting a new text. */ - void DeleteTextEvent(); + void ResetScrollPosition(); /** - * @brief Update the model following text replace/insert etc. - * - * @param[in] operationsRequired The layout operations which need to be done. + * @brief Used to process an event queued from SetText() */ - void UpdateModel( OperationsMask operationsRequired ); + 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 Lays-out the text. @@ -357,6 +413,38 @@ public: Size& layoutSize ); /** + * @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; + + /** * @brief Calulates the alignment of the whole text inside the bounding box. * * @param[in] size The size of the bounding box. @@ -380,24 +468,39 @@ public: // Text-input Event Queuing /** - * @brief Caller by editable UI controls when keyboard focus is gained. + * @brief Called by editable UI controls when keyboard focus is gained. */ void KeyboardFocusGainEvent(); /** - * @brief Caller by editable UI controls when focus is lost. + * @brief Called by editable UI controls when focus is lost. */ void KeyboardFocusLostEvent(); /** - * @brief Caller by editable UI controls when key events are received. + * @brief Called by editable UI controls when key events are received. * * @param[in] event The key event. + * @param[in] type Used to distinguish between regular key events and IMF events. */ bool KeyEvent( const Dali::KeyEvent& event ); /** - * @brief Caller by editable UI controls when a tap gesture occurs. + * @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. * @param[in] y The y position relative to the top-left of the parent control. @@ -405,7 +508,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. @@ -413,9 +516,64 @@ public: void PanEvent( Gesture::State state, const Vector2& displacement ); /** - * @copydoc Dali::Toolkit::Text::Decorator::Observer::GrabHandleEvent() + * @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 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. */ - virtual void GrabHandleEvent( GrabHandleState state, float x, float y ); + void SelectEvent( float x, float y, bool selectAll ); + + /** + * @brief Event received from IMF manager + * + * @param[in] imfManager The IMF manager. + * @param[in] imfEvent The event received. + * @return A data struture indicating if update is needed, cursor position and current text. + */ + 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(); + + /** + * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize() + */ + virtual void GetTargetSize( Vector2& targetSize ); + + /** + * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration() + */ + virtual void AddDecoration( Actor& actor, bool needsClipping ); + + /** + * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent() + */ + virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y ); + + /** + * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched() + */ + virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button ); protected: @@ -427,6 +585,28 @@ protected: private: /** + * @brief Helper to KeyEvent() to handle the backspace case. + * + * @return True if a character was deleted. + */ + bool BackspaceKeyEvent(); + + /** + * @brief Helper to clear font-specific data. + */ + void ShowPlaceholderText(); + + /** + * @brief Helper to clear all the model data except for LogicalModel::mText. + */ + void ClearModelData(); + + /** + * @brief Helper to clear font-specific data (only). + */ + void ClearFontData(); + + /** * @brief Private constructor. */ Controller( ControlInterface& controlInterface );