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=304ad2f8aac76a78ab88b32a1079ad30687b1e21;hp=7e2213422a5245870912be620632a0d39b2ac746;hb=e3205fb690b51c9b1175650a47d7ed6c4b9ec93b;hpb=269ef791ecea99b85d6241ad8e39769e1db312b3 diff --git a/dali-toolkit/internal/text/text-controller.h b/dali-toolkit/internal/text/text-controller.h index 7e22134..304ad2f 100644 --- a/dali-toolkit/internal/text/text-controller.h +++ b/dali-toolkit/internal/text/text-controller.h @@ -86,6 +86,7 @@ public: REORDER = 0x0400, ALIGN = 0x0800, COLOR = 0x1000, + UPDATE_DIRECTION = 0x2000, ALL_OPERATIONS = 0xFFFF }; @@ -99,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. @@ -115,6 +132,13 @@ 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. @@ -133,6 +157,79 @@ public: 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. @@ -143,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] 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 numberOfCharacters ); - - /** - * @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. @@ -342,6 +439,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. @@ -384,6 +497,68 @@ 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. @@ -482,6 +657,84 @@ public: 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. @@ -504,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(); @@ -525,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. @@ -612,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. @@ -759,21 +1006,11 @@ 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. - */ - void ClearModelData(); - - /** * @brief Helper to clear font-specific data (only). */ void ClearFontData();