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=7b1e2ba18c020945145cabbb6b324a04d1b85bef;hp=3c6125dd77694f13c813a34ef15f28cc7defa3b3;hb=5af1500ee4cbc72412934b8b7c7dc4ec0c206405;hpb=dcf0eeebe1e683b311b675e93adcc21a0602e671 diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h index 3c6125d..7b1e2ba 100644 --- a/dali-toolkit/internal/text/text-controller.h +++ b/dali-toolkit/internal/text/text-controller.h @@ -2,7 +2,7 @@ #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. @@ -82,9 +82,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 }; @@ -98,6 +100,22 @@ public: }; /** + * @brief Used to specify whether to update the input style. + */ + enum UpdateInputStyleType + { + UPDATE_INPUT_STYLE, + DONT_UPDATE_INPUT_STYLE + }; + + enum UpdateTextType + { + NONE_UPDATED = 0x0, + MODEL_UPDATED = 0x1, + DECORATOR_UPDATED = 0x2 + }; + + /** * @brief Create a new instance of a Controller. * * @param[in] controlInterface An interface used to request a text relayout. @@ -114,6 +132,104 @@ 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. + * + * @param[in] enable Whether to enable the mark-up processor. + */ + void SetMarkupProcessorEnabled( bool enable ); + + /** + * @brief Retrieves whether the mark-up processor is enabled. + * + * By default is disabled. + * + * @return @e true if the mark-up processor is enabled, otherwise returns @e false. + */ + bool IsMarkupProcessorEnabled() const; + + /** + * @brief Enables/disables the auto text scrolling + * + * By default is disabled. + * + * @param[in] enable Whether to enable the auto scrolling + */ + void SetAutoScrollEnabled( bool enable ); + + /** + * @brief Retrieves whether auto text scrolling is enabled. + * + * By default is disabled. + * + * @return @e true if auto scrolling is enabled, otherwise returns @e false. + */ + bool IsAutoScrollEnabled() const; + + /** + * @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. + * + * @return The alignment offset. + */ + float GetAutoScrollLineAlignment() const; + + /** + * @brief Enables the horizontal scrolling. + * + * @param[in] enable Whether to enable the horizontal scrolling. + */ + void SetHorizontalScrollEnabled( bool enable ); + + /** + * @brief Retrieves whether the horizontal scrolling is enabled. + * + * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false. + */ + bool IsHorizontalScrollEnabled() const; + + /** + * @brief Enables the vertical scrolling. + * + * @param[in] enable Whether to enable the vertical scrolling. + */ + 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 Replaces any text previously set. * * @note This will be converted into UTF-32 when stored in the text model. @@ -124,25 +240,25 @@ public: /** * @brief Retrieve any text previously set. * - * @return A string of UTF-8 characters. + * @param[out] text A string of UTF-8 characters. */ void GetText( std::string& text ) const; /** * @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] numberOfChars The number of characters to delete from the cursorOffset. + * @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 numberOfChars ); - - /** - * @brief Retrieve the current cursor position. - * - * @return The cursor position. - */ - unsigned int GetLogicalCursorPosition() const; + bool RemoveText( int cursorOffset, + int numberOfCharacters, + UpdateInputStyleType type ); /** * @brief Replaces any placeholder text previously set. @@ -165,7 +281,7 @@ public: * * @param[in] maxCharacters maximum number of characters to be accepted */ - void SetMaximumNumberOfCharacters( int maxCharacters ); + void SetMaximumNumberOfCharacters( Length maxCharacters ); /** * @brief Sets the maximum number of characters that can be inserted into the TextModel @@ -178,9 +294,8 @@ 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, bool userDefined ); + void SetDefaultFontFamily( const std::string& defaultFontFamily ); /** * @brief Retrieve the default font family. @@ -190,48 +305,42 @@ public: const std::string& GetDefaultFontFamily() const; /** - * @brief Sets the font's style string. - * - * @note The style set may be changed by the underlying font system. The string is stored to be recovered. + * @brief Sets the default font weight. * - * @param[in] style The font's style string. + * @param[in] weight The font weight. */ - void SetDefaultFontStyle( const std::string& style ); + void SetDefaultFontWeight( FontWeight weight ); /** - * @brief Retrieves the font's style. - * - * @return The font's style. + * @brief Whether the font's weight has been defined. */ - const std::string& GetDefaultFontStyle() const; + bool IsDefaultFontWeightDefined() const; /** - * @brief Sets the default font width. + * @brief Retrieves the default font weight. * - * @param[in] width The font width. + * @return The default font weight. */ - void SetDefaultFontWidth( FontWidth width ); + FontWeight GetDefaultFontWeight() const; /** - * @brief Retrieves the default font width. + * @brief Sets the default font width. * - * @return The default font width. + * @param[in] width The font width. */ - FontWidth GetDefaultFontWidth() const; + void SetDefaultFontWidth( FontWidth width ); /** - * @brief Sets the default font weight. - * - * @param[in] weight The font weight. + * @brief Whether the font's width has been defined. */ - void SetDefaultFontWeight( FontWeight weight ); + bool IsDefaultFontWidthDefined() const; /** - * @brief Retrieves the default font weight. + * @brief Retrieves the default font width. * - * @return The default font weight. + * @return The default font width. */ - FontWeight GetDefaultFontWeight() const; + FontWidth GetDefaultFontWidth() const; /** * @brief Sets the default font slant. @@ -241,6 +350,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. @@ -265,7 +379,7 @@ public: * @ brief Update the text after a font change * @param[in] newDefaultFont The new font to change to */ - void UpdateAfterFontChange( std::string& newDefaultFont ); + void UpdateAfterFontChange( const std::string& newDefaultFont ); /** * @brief Set the text color @@ -324,6 +438,22 @@ public: const Vector4& GetShadowColor() const; /** + * @brief Sets the shadow's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] shadowProperties The shadow's properties string. + */ + void SetDefaultShadowProperties( const std::string& shadowProperties ); + + /** + * @brief Retrieves the shadow's properties string. + * + * @return The shadow's properties string. + */ + const std::string& GetDefaultShadowProperties() const; + + /** * @brief Set the underline color. * * @param[in] color color of underline. @@ -366,6 +496,245 @@ public: float GetUnderlineHeight() const; /** + * @brief Sets the underline's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] underlineProperties The underline's properties string. + */ + void SetDefaultUnderlineProperties( const std::string& underlineProperties ); + + /** + * @brief Retrieves the underline's properties string. + * + * @return The underline's properties string. + */ + const std::string& GetDefaultUnderlineProperties() 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. + */ + void SetInputColor( const Vector4& color ); + + /** + * @brief Retrieves the input text's color. + * + * @return The input text's color. + */ + const Vector4& GetInputColor() const; + + /** + * @brief Sets the input text's font family name. + * + * @param[in] fontFamily The text's font family name. + */ + void SetInputFontFamily( const std::string& fontFamily ); + + /** + * @brief Retrieves the input text's font family name. + * + * @return The input text's font family name. + */ + const std::string& GetInputFontFamily() const; + + /** + * @brief Sets the input font's weight. + * + * @param[in] weight The input font's weight. + */ + 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. + */ + FontWeight GetInputFontWeight() const; + + /** + * @brief Sets the input font's width. + * + * @param[in] width The input font's width. + */ + 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. + */ + FontWidth GetInputFontWidth() const; + + /** + * @brief Sets the input font's slant. + * + * @param[in] slant The input font's slant. + */ + 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. + */ + FontSlant GetInputFontSlant() const; + + /** + * @brief Sets the input font's point size. + * + * @param[in] size The input font's point size. + */ + void SetInputFontPointSize( float size ); + + /** + * @brief Retrieves the input font's point size. + * + * @return The input font's point size. + */ + float GetInputFontPointSize() const; + + /** + * @brief Sets the input line spacing. + * + * @param[in] lineSpacing The line spacing. + */ + void SetInputLineSpacing( float lineSpacing ); + + /** + * @brief Retrieves the input line spacing. + * + * @return The line spacing. + */ + float GetInputLineSpacing() const; + + /** + * @brief Sets the input shadow's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] shadowProperties The shadow's properties string. + */ + void SetInputShadowProperties( const std::string& shadowProperties ); + + /** + * @brief Retrieves the input shadow's properties string. + * + * @return The shadow's properties string. + */ + const std::string& GetInputShadowProperties() const; + + /** + * @brief Sets the input underline's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] underlineProperties The underline's properties string. + */ + void SetInputUnderlineProperties( const std::string& underlineProperties ); + + /** + * @brief Retrieves the input underline's properties string. + * + * @return The underline's properties string. + */ + const std::string& GetInputUnderlineProperties() const; + + /** + * @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 SetInputEmbossProperties( const std::string& embossProperties ); + + /** + * @brief Retrieves the input emboss's properties string. + * + * @return The emboss's properties string. + */ + const std::string& GetInputEmbossProperties() const; + + /** + * @brief Sets input the outline's properties string. + * + * @note The string is stored to be recovered. + * + * @param[in] outlineProperties The outline's properties string. + */ + void SetInputOutlineProperties( const std::string& outlineProperties ); + + /** + * @brief Retrieves the input outline's properties string. + * + * @return The outline's properties string. + */ + const std::string& GetInputOutlineProperties() const; + + /** * @brief Called to enable/disable cursor blink. * * @note Only editable controls should calls this. @@ -388,13 +757,6 @@ public: const Vector2& GetScrollPosition() const; /** - * @brief Query the alignment offset. - * - * @return The alignmnet offset. - */ - const Vector2& GetAlignmentOffset() const; - - /** * @copydoc Control::GetNaturalSize() */ Vector3 GetNaturalSize(); @@ -409,9 +771,10 @@ public: * * @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 Whether the text model or decorations were updated. */ - bool Relayout( const Size& size ); + UpdateTextType Relayout( const Size& size ); /** * @brief Process queued events which modify the model. @@ -496,11 +859,11 @@ public: LayoutEngine::VerticalAlignment GetVerticalAlignment() const; /** - * @brief Calulates the alignment of the whole text inside the bounding box. + * @brief Calulates the vertical offset to align the text inside the bounding box. * * @param[in] size The size of the bounding box. */ - void CalculateTextAlignment( const Size& size ); + void CalculateVerticalOffset( const Size& size ); /** * @brief Return the layout engine. @@ -643,24 +1006,19 @@ private: bool BackspaceKeyEvent(); /** - * @brief Helper to notify IMF manager with surrounding text & cursor changes. - */ - void NotifyImfManager(); - - /** * @brief Helper to clear font-specific data. */ void ShowPlaceholderText(); /** - * @brief Helper to clear all the model data except for LogicalModel::mText. + * @brief Helper to clear font-specific data (only). */ - void ClearModelData(); + void ClearFontData(); /** - * @brief Helper to clear font-specific data (only). + * @brief Helper to clear text's style data. */ - void ClearFontData(); + void ClearStyleData(); /** * @brief Private constructor.