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=e1d831ecd36a2b74fac6ec7cd1ff23fd8aed3fe8;hp=3fa7c60685ad8806dbffb873f3dd0de408a6c05b;hb=0207e16930421216c5a22a0fd3ac409f3bd2a7b0;hpb=beacebbb139c15b44535e3d28c835fc31b412c7c diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h index 3fa7c60..e1d831e 100644 --- a/dali-toolkit/internal/text/text-controller.h +++ b/dali-toolkit/internal/text/text-controller.h @@ -18,17 +18,20 @@ * */ -// INTERNAL INCLUDES -#include -#include -#include - // EXTERNAL INCLUDES +#include +#include #include +#include #include #include #include -#include + +// INTERNAL INCLUDES +#include +#include +#include +#include namespace Dali { @@ -69,14 +72,13 @@ private: VALIDATE_FONTS = 0x0004, GET_LINE_BREAKS = 0x0008, GET_WORD_BREAKS = 0x0010, - SHAPE_TEXT = 0x0020, - GET_GLYPH_METRICS = 0x0040, - LAYOUT = 0x0080, - UPDATE_ACTUAL_SIZE = 0x0100, - UPDATE_POSITIONS = 0x0200, + BIDI_INFO = 0x0020, + SHAPE_TEXT = 0x0040, + GET_GLYPH_METRICS = 0x0080, + LAYOUT = 0x0100, + UPDATE_ACTUAL_SIZE = 0x0200, REORDER = 0x0400, - ALIGNMENT = 0x0800, - RENDER = 0x1000, + ALIGN = 0x0800, ALL_OPERATIONS = 0xFFFF }; @@ -106,6 +108,20 @@ public: void GetText( std::string& text ) const; /** + * @brief Replaces any placeholder text previously set. + * + * @param[in] text A string of UTF-8 characters. + */ + void SetPlaceholderText( const std::string& text ); + + /** + * @brief Retrieve any placeholder text previously set. + * + * @return A string of UTF-8 characters. + */ + void GetPlaceholderText( std::string& text ) const; + + /** * @brief Set the default font family. * * @param[in] defaultFontFamily The default font family. @@ -117,7 +133,7 @@ public: * * @return The default font family. */ - const std::string& GetDefaultFontFamily() const; + const std::string& GetDefaultFontFamily() const; /** * @brief Set the default font style. @@ -131,7 +147,7 @@ public: * * @return The default font style. */ - const std::string& GetDefaultFontStyle() const; + const std::string& GetDefaultFontStyle() const; /** * @brief Set the default point size. @@ -145,7 +161,15 @@ public: * * @return The default point size. */ - float GetDefaultPointSize() const; + float GetDefaultPointSize() const; + + /** + * @brief Retrieve the default fonts. + * + * @param[out] fonts The default font family, style and point sizes. + * @param[in] numberOfCharacters The number of characters in the logical model. + */ + void GetDefaultFonts( Dali::Vector& fonts, Length numberOfCharacters ); /** * @brief Called to enable text input. @@ -156,6 +180,31 @@ public: void EnableTextInput( DecoratorPtr decorator ); /** + * @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; + + /** + * @copydoc Control::GetNaturalSize() + */ + Vector3 GetNaturalSize(); + + /** + * @copydoc Control::GetHeightForWidth() + */ + 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. @@ -165,24 +214,48 @@ public: bool Relayout( const Vector2& size ); /** - * @brief Lays-out the text. + * @brief Process queued events which modify the model. + */ + void ProcessModifyEvents(); + + /** + * @brief Used to process an event queued from SetText() * - * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method. + * @param[in] newText The new text to store in the logical model. + */ + void ReplaceTextEvent( const std::string& newText ); + + /** + * @brief Used to process an event queued from key events etc. * - * @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[in] text The text to insert into the logical model. */ - bool DoRelayout( const Vector2& size, OperationsMask operations ); + void InsertTextEvent( const std::string& text ); /** - * @copydoc Control::GetNaturalSize() + * @brief Used to process an event queued from backspace key etc. */ - Vector3 GetNaturalSize(); + void DeleteTextEvent(); /** - * @copydoc Control::GetHeightForWidth() + * @brief Update the model following text replace/insert etc. + * + * @param[in] operationsRequired The layout operations which need to be done. */ - float GetHeightForWidth( float width ); + void UpdateModel( OperationsMask operationsRequired ); + + /** + * @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 Vector2& size, + OperationsMask operations, + Size& layoutSize ); /** * @brief Return the layout engine. @@ -198,6 +271,8 @@ public: */ View& GetView(); + // Text-input Event Queuing + /** * @brief Caller by editable UI controls when keyboard focus is gained. */ @@ -209,6 +284,13 @@ public: void KeyboardFocusLostEvent(); /** + * @brief Caller by editable UI controls when key events are received. + * + * @param[in] event The key event. + */ + bool KeyEvent( const Dali::KeyEvent& event ); + + /** * @brief Caller 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.