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=fa4f966f756917c17a72f57bc1e5201f520e1e2f;hp=4edd28117830a6cf7db2343daf16dfe4f47941cd;hb=785904f5477a648bc0005dcbb39bd3a85077e32d;hpb=09f35f81061ca470e79ac674024b9e587ff44e7f diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h index 4edd281..fa4f966 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,7 +38,7 @@ namespace Text { class Controller; -class LayoutEngine; +class View; typedef IntrusivePtr ControllerPtr; typedef Dali::Toolkit::Text::ControlInterface ControlInterface; @@ -65,9 +59,11 @@ 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 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 { public: @@ -110,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. @@ -125,7 +129,7 @@ public: void GetText( std::string& text ) const; /** - * @brief Replaces any placeholder text previously set. + * @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. @@ -174,8 +178,9 @@ public: * @brief Set the default font family. * * @param[in] defaultFontFamily The default font family. + * @param[in] userDefined If set by the user */ - void SetDefaultFontFamily( const std::string& defaultFontFamily ); + void SetDefaultFontFamily( const std::string& defaultFontFamily, bool userDefined ); /** * @brief Retrieve the default font family. @@ -213,6 +218,12 @@ public: float GetDefaultPointSize() const; /** + * @ brief Update the text after a font change + * @param[in] newDefaultFont The new font to change to + */ + void UpdateAfterFontChange( std::string& newDefaultFont ); + + /** * @brief Set the text color * * @param textColor The text color @@ -311,14 +322,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. @@ -377,6 +380,18 @@ public: void ResetText(); /** + * @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(); + + /** * @brief Used to process an event queued from SetText() */ void TextReplacedEvent(); @@ -405,6 +420,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. @@ -428,17 +475,17 @@ 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. @@ -446,7 +493,7 @@ public: bool KeyEvent( const Dali::KeyEvent& event ); /** - * @brief Caller by editable UI controls when key events are received. + * @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. @@ -454,7 +501,13 @@ public: void InsertText( const std::string& text, InsertType type ); /** - * @brief Caller by editable UI controls when a tap gesture occurs. + * @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. @@ -462,7 +515,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. @@ -470,9 +523,64 @@ public: void PanEvent( Gesture::State state, const Vector2& displacement ); /** - * @copydoc Dali::Toolkit::Text::Decorator::Observer::HandleEvent() + * @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. + */ + 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 */ - virtual void HandleEvent( HandleType handle, HandleState state, float x, float y ); + 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: @@ -484,6 +592,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 );