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=d37efabc7b862663cfbf79a5d7094dcc5926ddaf;hp=8857203a4f27205483dbec647d81e79e24c48d9f;hb=c11c7538e070434e84856ebd4af000dff4ca3f9a;hpb=c6b64a162088c12ef1b69aa40234e6d4dd772763 diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h index 8857203..d37efab 100644 --- a/dali-toolkit/internal/text/text-controller.h +++ b/dali-toolkit/internal/text/text-controller.h @@ -18,17 +18,21 @@ * */ -// INTERNAL INCLUDES -#include -#include -#include - // EXTERNAL INCLUDES +#include +#include #include +#include +#include #include #include #include -#include + +// INTERNAL INCLUDES +#include +#include +#include +#include namespace Dali { @@ -63,19 +67,20 @@ private: */ enum OperationsMask { - NO_OPERATION = 0x0, - CONVERT_TO_UTF32 = 0x1, - GET_SCRIPTS = 0x2, - VALIDATE_FONTS = 0x4, - GET_LINE_BREAKS = 0x8, - GET_WORD_BREAKS = 0x10, - SHAPE_TEXT = 0x20, - GET_GLYPH_METRICS = 0x40, - LAYOUT = 0x80, - REORDER = 0x100, - ALIGNMENT = 0x200, - RENDER = 0x400, - ALL_OPERATIONS = 0xFFF + NO_OPERATION = 0x0000, + CONVERT_TO_UTF32 = 0x0001, + GET_SCRIPTS = 0x0002, + VALIDATE_FONTS = 0x0004, + GET_LINE_BREAKS = 0x0008, + GET_WORD_BREAKS = 0x0010, + BIDI_INFO = 0x0020, + SHAPE_TEXT = 0x0040, + GET_GLYPH_METRICS = 0x0080, + LAYOUT = 0x0100, + UPDATE_ACTUAL_SIZE = 0x0200, + REORDER = 0x0400, + ALIGN = 0x0800, + ALL_OPERATIONS = 0xFFFF }; public: @@ -101,7 +106,155 @@ public: * * @return A string of UTF-8 characters. */ - void GetText( std::string& text ); + 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. + */ + void SetDefaultFontFamily( const std::string& defaultFontFamily ); + + /** + * @brief Retrieve the default font family. + * + * @return The default font family. + */ + const std::string& GetDefaultFontFamily() const; + + /** + * @brief Set the default font style. + * + * @param[in] defaultFontStyle The default font style. + */ + void SetDefaultFontStyle( const std::string& defaultFontStyle ); + + /** + * @brief Retrieve the default font style. + * + * @return The default font style. + */ + const std::string& GetDefaultFontStyle() const; + + /** + * @brief Set the default point size. + * + * @param[in] defaultFontStyle The default point size. + */ + void SetDefaultPointSize( float pointSize ); + + /** + * @brief Retrieve the default point size. + * + * @return The default point size. + */ + 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 ) const; + + /** + * @brief Set the text color + * + * @param textColor The text color + */ + void SetTextColor( const Vector4& textColor ); + + /** + * @brief Retrieve the text color + * + * @return The text color + */ + const Vector4& GetTextColor() const; + + /** + * @brief Set the shadow offset. + * + * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow. + */ + void SetShadowOffset( const Vector2& shadowOffset ); + + /** + * @brief Retrieve the shadow offset. + * + * @return The shadow offset. + */ + const Vector2& GetShadowOffset() const; + + /** + * @brief Set the shadow color. + * + * @param[in] shadowColor The shadow color. + */ + void SetShadowColor( const Vector4& shadowColor ); + + /** + * @brief Retrieve the shadow color. + * + * @return The shadow color. + */ + const Vector4& GetShadowColor() const; + + /** + * @brief Set the underline color. + * + * @param[in] color color of underline. + */ + void SetUnderlineColor( const Vector4& color ); + + /** + * @brief Retrieve the underline color. + * + * @return The underline color. + */ + const Vector4& GetUnderlineColor() const; + + /** + * @brief Set the underline enabled flag. + * + * @param[in] enabled The underline enabled flag. + */ + void SetUnderlineEnabled( bool enabled ); + + /** + * @brief Returns whether the text is underlined or not. + * + * @return The underline state. + */ + bool IsUnderlineEnabled() const; + + /** + * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics + * + * @param[in] height The height in pixels of the underline + */ + void SetUnderlineHeight( float height ); + + /** + * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics + * + * @return The height of the underline, or 0 if height is not overrided. + */ + float GetUnderlineHeight() const; /** * @brief Called to enable text input. @@ -112,18 +265,33 @@ public: void EnableTextInput( DecoratorPtr decorator ); /** - * @brief Triggers a relayout which updates View (if necessary). + * @brief Called to enable/disable cursor blink. * - * @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. + * @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 Query the current scroll position; the UI control is responsible for moving actors to this position. + * + * @return The scroll position. */ - bool Relayout( const Vector2& size ); + const Vector2& GetScrollPosition() const; /** + * @brief Query the alignment offset. * + * @return The alignmnet offset. */ - bool DoRelayout( const Vector2& size, OperationsMask operations ); + const Vector2& GetAlignmentOffset() const; /** * @copydoc Control::GetNaturalSize() @@ -136,6 +304,66 @@ public: 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. + * @param[in] size A the size of a bounding box to layout text within. + * @return True if the text model or decorations were updated. + */ + bool Relayout( const Size& size ); + + /** + * @brief Process queued events which modify the model. + */ + void ProcessModifyEvents(); + + /** + * @brief Used to process an event queued from SetText() + * + * @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] text The text to insert into the logical model. + */ + void InsertTextEvent( const std::string& text ); + + /** + * @brief Used to process an event queued from backspace key etc. + */ + void DeleteTextEvent(); + + /** + * @brief Update the model following text replace/insert etc. + * + * @param[in] operationsRequired The layout operations which need to be done. + */ + 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 Size& size, + OperationsMask operations, + Size& layoutSize ); + + /** + * @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 ); + + /** * @brief Return the layout engine. * * @return A reference to the layout engine. @@ -149,6 +377,8 @@ public: */ View& GetView(); + // Text-input Event Queuing + /** * @brief Caller by editable UI controls when keyboard focus is gained. */ @@ -160,6 +390,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. @@ -168,6 +405,14 @@ public: void TapEvent( unsigned int tapCount, float x, float y ); /** + * @brief Caller 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. + */ + void PanEvent( Gesture::State state, const Vector2& displacement ); + + /** * @copydoc Dali::Toolkit::Text::Decorator::Observer::GrabHandleEvent() */ virtual void GrabHandleEvent( GrabHandleState state, float x, float y ); @@ -182,11 +427,6 @@ protected: private: /** - * @brief Request a relayout using the ControlInterface. - */ - void RequestRelayout(); - - /** * @brief Private constructor. */ Controller( ControlInterface& controlInterface ); @@ -201,9 +441,6 @@ private: struct Impl; Impl* mImpl; - - // Avoid allocating this for non-editable controls - struct TextInput; }; } // namespace Text