-#ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_H__
-#define __DALI_TOOLKIT_TEXT_CONTROLLER_H__
+#ifndef DALI_TOOLKIT_TEXT_CONTROLLER_H
+#define DALI_TOOLKIT_TEXT_CONTROLLER_H
/*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 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.
*/
// EXTERNAL INCLUDES
-#include <dali/devel-api/adaptor-framework/imf-manager.h>
+#include <dali/devel-api/adaptor-framework/input-method-context.h>
#include <dali/public-api/events/gesture.h>
// INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
#include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup-callback-interface.h>
+#include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
#include <dali-toolkit/internal/text/decorator/text-decorator.h>
+#include <dali-toolkit/internal/text/hidden-text.h>
+#include <dali-toolkit/internal/text/input-filter.h>
#include <dali-toolkit/internal/text/layouts/layout-engine.h>
-#include <dali-toolkit/internal/text/text-control-interface.h>
+#include <dali-toolkit/internal/text/text-anchor-control-interface.h>
+#include <dali-toolkit/internal/text/text-model-interface.h>
+#include <dali-toolkit/internal/text/text-selectable-control-interface.h>
+#include <dali-toolkit/public-api/text/text-enumerations.h>
namespace Dali
{
-
namespace Toolkit
{
-
namespace Text
{
-
class Controller;
+class ControlInterface;
+class EditableControlInterface;
class View;
-
-typedef IntrusivePtr<Controller> ControllerPtr;
-typedef Dali::Toolkit::Text::ControlInterface ControlInterface;
+class RenderingController;
/**
- * @brief Different placeholder-text can be shown when the control is active/inactive.
- */
-enum PlaceholderType
+ * @brief Text selection operations .
+ */
+enum SelectionType
{
- PLACEHOLDER_TYPE_ACTIVE,
- PLACEHOLDER_TYPE_INACTIVE,
+ INTERACTIVE = 0x0000,
+ ALL = 0x0001,
+ NONE = 0x0002
};
+typedef IntrusivePtr<Controller> ControllerPtr;
+
/**
* @brief A Text Controller is used by UI Controls which display text.
*
*
* The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface.
*/
-class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface
+class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface, public HiddenText::Observer
{
-public:
-
+public: // Enumerated types.
/**
* @brief Text related operations to be done in the relayout process.
*/
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,
- COLOR = 0x1000,
- UPDATE_DIRECTION = 0x2000,
+ BIDI_INFO = 0x0010,
+ SHAPE_TEXT = 0x0020,
+ GET_GLYPH_METRICS = 0x0040,
+ LAYOUT = 0x0080,
+ UPDATE_LAYOUT_SIZE = 0x0100,
+ REORDER = 0x0200,
+ ALIGN = 0x0400,
+ COLOR = 0x0800,
+ UPDATE_DIRECTION = 0x1000,
ALL_OPERATIONS = 0xFFFF
};
/**
- * @brief Used to distinguish between regular key events and IMF events
+ * @brief Used to distinguish between regular key events and InputMethodContext events
*/
enum InsertType
{
};
/**
+ * @brief Used to specify what has been updated after the Relayout() method has been called.
+ */
+ enum UpdateTextType
+ {
+ NONE_UPDATED = 0x0, ///< Nothing has been updated.
+ MODEL_UPDATED = 0x1, ///< The text's model has been updated.
+ DECORATOR_UPDATED = 0x2 ///< The decoration has been updated.
+ };
+
+ /**
+ * @brief Different placeholder-text can be shown when the control is active/inactive.
+ */
+ enum PlaceholderType
+ {
+ PLACEHOLDER_TYPE_ACTIVE,
+ PLACEHOLDER_TYPE_INACTIVE,
+ };
+
+ /**
+ * @brief Enumeration for Font Size Type.
+ */
+ enum FontSizeType
+ {
+ POINT_SIZE, // The size of font in points.
+ PIXEL_SIZE // The size of font in pixels.
+ };
+
+ struct NoTextTap
+ {
+ enum Action
+ {
+ NO_ACTION, ///< Does no action if there is a tap on top of an area with no text.
+ HIGHLIGHT, ///< Highlights the nearest text (at the beginning or end of the text) and shows the text's selection popup.
+ SHOW_SELECTION_POPUP ///< Shows the text's selection popup.
+ };
+ };
+
+ struct TextFitInfo
+ {
+ enum Property
+ {
+ TEXT_FIT_ENABLE,
+ TEXT_FIT_MIN_SIZE,
+ TEXT_FIT_MAX_SIZE,
+ TEXT_FIT_STEP_SIZE,
+ TEXT_FIT_FONT_SIZE_TYPE
+ };
+ };
+
+public: // Constructor.
+ /**
* @brief Create a new instance of a Controller.
*
- * @param[in] controlInterface An interface used to request a text relayout.
* @return A pointer to a new Controller.
*/
- static ControllerPtr New( ControlInterface& controlInterface );
+ static ControllerPtr New();
/**
+ * @brief Create a new instance of a Controller.
+ *
+ * @param[in] controlInterface The control's interface.
+ *
+ * @return A pointer to a new Controller.
+ */
+ static ControllerPtr New(ControlInterface* controlInterface);
+
+ /**
+ * @brief Create a new instance of a Controller.
+ *
+ * @param[in] controlInterface The control's interface.
+ * @param[in] editableControlInterface The editable control's interface.
+ * @param[in] selectableControlInterface The selectable control's interface.
+ * @param[in] anchorControlInterface The anchor control's interface.
+ *
+ * @return A pointer to a new Controller.
+ */
+ static ControllerPtr New(ControlInterface* controlInterface,
+ EditableControlInterface* editableControlInterface,
+ SelectableControlInterface* selectableControlInterface,
+ AnchorControlInterface* anchorControlInterface);
+
+public: // Configure the text controller.
+ /**
* @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.
+ * @param[in] inputMethodContext Used to manager ime.
*/
- void EnableTextInput( DecoratorPtr decorator );
+ void EnableTextInput(DecoratorPtr decorator, InputMethodContext& inputMethodContext);
/**
* @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 );
+ void SetGlyphType(TextAbstraction::GlyphType glyphType);
/**
* @brief Enables/disables the mark-up processor.
*
* @param[in] enable Whether to enable the mark-up processor.
*/
- void SetMarkupProcessorEnabled( bool enable );
+ void SetMarkupProcessorEnabled(bool enable);
/**
* @brief Retrieves whether the mark-up processor is enabled.
bool IsMarkupProcessorEnabled() const;
/**
+ * @brief Retrieves whether the current text contains anchors.
+ *
+ * @return @e true if the current text contains anchors. @e false.
+ */
+ bool HasAnchors() 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 );
+ void SetAutoScrollEnabled(bool enable);
/**
* @brief Retrieves whether auto text scrolling is enabled.
CharacterDirection GetAutoScrollDirection() const;
/**
- * @brief Replaces any text previously set.
+ * @brief Get the alignment offset of the first line of text.
*
- * @note This will be converted into UTF-32 when stored in the text model.
- * @param[in] text A string of UTF-8 characters.
+ * @return The alignment offset.
*/
- void SetText( const std::string& text );
+ float GetAutoScrollLineAlignment() const;
/**
- * @brief Retrieve any text previously set.
+ * @brief Enables the horizontal scrolling.
*
- * @return A string of UTF-8 characters.
+ * @param[in] enable Whether to enable the horizontal scrolling.
*/
- void GetText( std::string& text ) const;
+ void SetHorizontalScrollEnabled(bool enable);
/**
- * @brief Remove a given number of characters
+ * @brief Retrieves whether the horizontal scrolling is enabled.
*
- * 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.
+ * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false.
+ */
+ bool IsHorizontalScrollEnabled() const;
+
+ /**
+ * @brief Enables the vertical scrolling.
*
- * @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.
+ * @param[in] enable Whether to enable the vertical scrolling.
*/
- bool RemoveText( int cursorOffset,
- int numberOfCharacters,
- UpdateInputStyleType type );
+ void SetVerticalScrollEnabled(bool enable);
/**
- * @brief Retrieve the current cursor position.
+ * @brief Retrieves whether the verticall scrolling is enabled.
*
- * @return The cursor position.
+ * @return @e true if the vertical scrolling is enabled, otherwise it returns @e false.
*/
- unsigned int GetLogicalCursorPosition() const;
+ bool IsVerticalScrollEnabled() const;
/**
- * @brief Replaces any placeholder text previously set.
+ * @brief Enables the smooth handle panning.
*
- * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
- * @param[in] text A string of UTF-8 characters.
+ * @param[in] enable Whether to enable the smooth handle panning.
*/
- void SetPlaceholderText( PlaceholderType type, const std::string& text );
+ void SetSmoothHandlePanEnabled(bool enable);
/**
- * @brief Retrieve any placeholder text previously set.
+ * @brief Retrieves whether the smooth handle panning is enabled.
*
- * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
- * @param[out] A string of UTF-8 characters.
+ * @return @e true if the smooth handle panning is enabled.
*/
- void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
+ bool IsSmoothHandlePanEnabled() const;
/**
* @brief Sets the maximum number of characters that can be inserted into the TextModel
*
* @param[in] maxCharacters maximum number of characters to be accepted
*/
- void SetMaximumNumberOfCharacters( Length maxCharacters );
+ void SetMaximumNumberOfCharacters(Length maxCharacters);
/**
* @brief Sets the maximum number of characters that can be inserted into the TextModel
int GetMaximumNumberOfCharacters();
/**
- * @brief Set the default font family.
+ * @brief Called to enable/disable cursor blink.
*
- * @param[in] defaultFontFamily The default font family.
+ * @note Only editable controls should calls this.
+ * @param[in] enabled Whether the cursor should blink or not.
*/
- void SetDefaultFontFamily( const std::string& defaultFontFamily );
+ void SetEnableCursorBlink(bool enable);
/**
- * @brief Retrieve the default font family.
+ * @brief Query whether cursor blink is enabled.
*
- * @return The default font family.
+ * @return Whether the cursor should blink or not.
*/
- const std::string& GetDefaultFontFamily() const;
+ bool GetEnableCursorBlink() 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 Whether to enable the multi-line layout.
*
- * @param[in] style The font's style string.
+ * @param[in] enable \e true enables the multi-line (by default)
*/
- void SetDefaultFontStyle( const std::string& style );
+ void SetMultiLineEnabled(bool enable);
/**
- * @brief Retrieves the font's style.
- *
- * @return The font's style.
+ * @return Whether the multi-line layout is enabled.
*/
- const std::string& GetDefaultFontStyle() const;
+ bool IsMultiLineEnabled() const;
/**
- * @brief Sets the default font weight.
+ * @brief Sets the text's horizontal alignment.
*
- * @param[in] weight The font weight.
+ * @param[in] alignment The horizontal alignment.
*/
- void SetDefaultFontWeight( FontWeight weight );
+ void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
/**
- * @brief Retrieves the default font weight.
- *
- * @return The default font weight.
+ * @copydoc ModelInterface::GetHorizontalAlignment()
*/
- FontWeight GetDefaultFontWeight() const;
+ HorizontalAlignment::Type GetHorizontalAlignment() const;
/**
- * @brief Sets the default font width.
+ * @brief Sets the text's vertical alignment.
*
- * @param[in] width The font width.
+ * @param[in] alignment The vertical alignment.
*/
- void SetDefaultFontWidth( FontWidth width );
+ void SetVerticalAlignment(VerticalAlignment::Type alignment);
/**
- * @brief Retrieves the default font width.
- *
- * @return The default font width.
+ * @copydoc ModelInterface::GetVerticalAlignment()
*/
- FontWidth GetDefaultFontWidth() const;
+ VerticalAlignment::Type GetVerticalAlignment() const;
/**
- * @brief Sets the default font slant.
- *
- * @param[in] slant The font slant.
+ * @brief Sets the text's wrap mode
+ * @param[in] text wrap mode The unit of wrapping
*/
- void SetDefaultFontSlant( FontSlant slant );
+ void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
/**
- * @brief Retrieves the default font slant.
- *
- * @return The default font slant.
+ * @brief Retrieve text wrap mode previously set.
+ * @return text wrap mode
*/
- FontSlant GetDefaultFontSlant() const;
+ Text::LineWrap::Mode GetLineWrapMode() const;
/**
- * @brief Set the default point size.
+ * @brief Enable or disable the text elide.
*
- * @param[in] pointSize The default point size.
+ * @param[in] enabled Whether to enable the text elide.
*/
- void SetDefaultPointSize( float pointSize );
+ void SetTextElideEnabled(bool enabled);
/**
- * @brief Retrieve the default point size.
- *
- * @return The default point size.
+ * @copydoc ModelInterface::IsTextElideEnabled()
*/
- float GetDefaultPointSize() const;
+ bool IsTextElideEnabled() const;
/**
- * @ brief Update the text after a font change
- * @param[in] newDefaultFont The new font to change to
+ * @brief Enable or disable the text fit.
+ *
+ * @param[in] enabled Whether to enable the text fit.
*/
- void UpdateAfterFontChange( const std::string& newDefaultFont );
+ void SetTextFitEnabled(bool enabled);
/**
- * @brief Set the text color
+ * @brief Whether the text fit is enabled or not.
*
- * @param textColor The text color
+ * @return True if the text fit is enabled
*/
- void SetTextColor( const Vector4& textColor );
+ bool IsTextFitEnabled() const;
/**
- * @brief Retrieve the text color
+ * @brief Sets minimum size valid for text fit.
*
- * @return The text color
+ * @param[in] minimum size value.
+ * @param[in] type The font size type is point size or pixel size
*/
- const Vector4& GetTextColor() const;
+ void SetTextFitMinSize(float pointSize, FontSizeType type);
/**
- * @brief Set the text color
+ * @brief Retrieves the minimum point size valid for text fit.
*
- * @param textColor The text color
+ * @return The minimum point size valid for text fit
*/
- void SetPlaceholderTextColor( const Vector4& textColor );
+ float GetTextFitMinSize() const;
/**
- * @brief Retrieve the text color
+ * @brief Sets maximum size valid for text fit.
*
- * @return The text color
+ * @param[in] maximum size value.
+ * @param[in] type The font size type is point size or pixel size
*/
- const Vector4& GetPlaceholderTextColor() const;
+ void SetTextFitMaxSize(float pointSize, FontSizeType type);
/**
- * @brief Set the shadow offset.
+ * @brief Retrieves the maximum point size valid for text fit.
*
- * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
+ * @return The maximum point size valid for text fit
*/
- void SetShadowOffset( const Vector2& shadowOffset );
+ float GetTextFitMaxSize() const;
/**
- * @brief Retrieve the shadow offset.
+ * @brief Sets step size for font increase valid for text fit.
*
- * @return The shadow offset.
+ * @param[in] step size value.
+ * @param[in] type The font size type is point size or pixel size
*/
- const Vector2& GetShadowOffset() const;
+ void SetTextFitStepSize(float step, FontSizeType type);
/**
- * @brief Set the shadow color.
+ * @brief Retrieves the step point size valid for text fit.
*
- * @param[in] shadowColor The shadow color.
+ * @return The step point size valid for text fit
*/
- void SetShadowColor( const Vector4& shadowColor );
+ float GetTextFitStepSize() const;
/**
- * @brief Retrieve the shadow color.
+ * @brief Sets content size valid for text fit.
*
- * @return The shadow color.
+ * @param[in] Content size value.
*/
- const Vector4& GetShadowColor() const;
+ void SetTextFitContentSize(Vector2 size);
/**
- * @brief Set the underline color.
+ * @brief Retrieves the content size valid for text fit.
*
- * @param[in] color color of underline.
+ * @return The content size valid for text fit
*/
- void SetUnderlineColor( const Vector4& color );
+ Vector2 GetTextFitContentSize() const;
/**
- * @brief Retrieve the underline color.
- *
- * @return The underline color.
+ * @brief Enable or disable the placeholder text elide.
+ * @param enabled Whether to enable the placeholder text elide.
*/
- const Vector4& GetUnderlineColor() const;
+ void SetPlaceholderTextElideEnabled(bool enabled);
/**
- * @brief Set the underline enabled flag.
- *
- * @param[in] enabled The underline enabled flag.
+ * @brief Whether the placeholder text elide property is enabled.
+ * @return True if the placeholder text elide property is enabled, false otherwise.
*/
- void SetUnderlineEnabled( bool enabled );
+ bool IsPlaceholderTextElideEnabled() const;
/**
- * @brief Returns whether the text is underlined or not.
- *
- * @return The underline state.
+ * @brief Enable or disable the text selection.
+ * @param[in] enabled Whether to enable the text selection.
*/
- bool IsUnderlineEnabled() const;
+ void SetSelectionEnabled(bool enabled);
/**
- * @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
+ * @brief Whether the text selection is enabled or not.
+ * @return True if the text selection is enabled
*/
- void SetUnderlineHeight( float height );
+ bool IsSelectionEnabled() const;
/**
- * @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.
+ * @brief Enable or disable the text selection using Shift key.
+ * @param enabled Whether to enable the text selection using Shift key
*/
- float GetUnderlineHeight() const;
+ void SetShiftSelectionEnabled(bool enabled);
/**
- * @brief Sets the input text's color.
- *
- * @param[in] color The input text's color.
+ * @brief Whether the text selection using Shift key is enabled or not.
+ * @return True if the text selection using Shift key is enabled
*/
- void SetInputColor( const Vector4& color );
+ bool IsShiftSelectionEnabled() const;
/**
- * @brief Retrieves the input text's color.
+ * @brief Enable or disable the grab handles for text selection.
*
- * @return The input text's color.
+ * @param[in] enabled Whether to enable the grab handles
*/
- const Vector4& GetInputColor() const;
+ void SetGrabHandleEnabled(bool enabled);
/**
- * @brief Sets the input text's font family name.
+ * @brief Returns whether the grab handles are enabled.
*
- * @param[in] fontFamily The text's font family name.
+ * @return True if the grab handles are enabled
*/
- void SetInputFontFamily( const std::string& fontFamily );
+ bool IsGrabHandleEnabled() const;
/**
- * @brief Retrieves the input text's font family name.
+ * @brief Enable or disable the grab handles for text selection.
*
- * @return The input text's font family name.
+ * @param[in] enabled Whether to enable the grab handles
*/
- const std::string& GetInputFontFamily() const;
+ void SetGrabHandlePopupEnabled(bool enabled);
/**
- * @brief Sets the input text's font style.
+ * @brief Returns whether the grab handles are enabled.
*
- * @param[in] fontStyle The input text's font style.
+ * @return True if the grab handles are enabled
*/
- void SetInputFontStyle( const std::string& fontStyle );
+ bool IsGrabHandlePopupEnabled() const;
/**
- * @brief Retrieves the input text's font style.
+ * @brief Sets input type to password
+ *
+ * @note The string is displayed hidden character
*
- * @return The input text's font style.
+ * @param[in] passwordInput True if password input is enabled.
*/
- const std::string& GetInputFontStyle() const;
+ void SetInputModePassword(bool passwordInput);
/**
- * @brief Sets the input font's weight.
+ * @brief Returns whether the input mode type is set as password.
*
- * @param[in] weight The input font's weight.
+ * @return True if input mode type is password
*/
- void SetInputFontWeight( FontWeight weight );
+ bool IsInputModePassword();
/**
- * @brief Retrieves the input font's weight.
+ * @brief Sets the action when there is a double tap event on top of a text area with no text.
*
- * @return The input font's weight.
+ * @param[in] action The action to do.
*/
- FontWeight GetInputFontWeight() const;
+ void SetNoTextDoubleTapAction(NoTextTap::Action action);
/**
- * @brief Sets the input font's width.
+ * @brief Retrieves the action when there is a double tap event on top of a text area with no text.
*
- * @param[in] width The input font's width.
+ * @return The action to do.
*/
- void SetInputFontWidth( FontWidth width );
+ NoTextTap::Action GetNoTextDoubleTapAction() const;
/**
- * @brief Retrieves the input font's width.
+ * @briefSets the action when there is a long press event on top of a text area with no text.
*
- * @return The input font's width.
+ * @param[in] action The action to do.
*/
- FontWidth GetInputFontWidth() const;
+ void SetNoTextLongPressAction(NoTextTap::Action action);
/**
- * @brief Sets the input font's slant.
+ * @brief Retrieves the action when there is a long press event on top of a text area with no text.
*
- * @param[in] slant The input font's slant.
+ * @return The action to do.
*/
- void SetInputFontSlant( FontSlant slant );
+ NoTextTap::Action GetNoTextLongPressAction() const;
/**
- * @brief Retrieves the input font's slant.
- *
- * @return The input font's slant.
+ * @brief Query if Underline settings were provided by string or map
+ * @return bool true if set by string
*/
- FontSlant GetInputFontSlant() const;
+ bool IsUnderlineSetByString();
/**
- * @brief Sets the input font's point size.
- *
- * @param[in] size The input font's point size.
+ * Set method underline setting were set by
+ * @param[in] bool, true if set by string
*/
- void SetInputFontPointSize( float size );
+ void UnderlineSetByString(bool setByString);
/**
- * @brief Retrieves the input font's point size.
- *
- * @return The input font's point size.
+ * @brief Query if shadow settings were provided by string or map
+ * @return bool true if set by string
*/
- float GetInputFontPointSize() const;
+ bool IsShadowSetByString();
/**
- * @brief Called to enable/disable cursor blink.
- *
- * @note Only editable controls should calls this.
- * @param[in] enabled Whether the cursor should blink or not.
+ * Set method shadow setting were set by
+ * @param[in] bool, true if set by string
*/
- void SetEnableCursorBlink( bool enable );
+ void ShadowSetByString(bool setByString);
/**
- * @brief Query whether cursor blink is enabled.
- *
- * @return Whether the cursor should blink or not.
+ * @brief Query if outline settings were provided by string or map
+ * @return bool true if set by string
*/
- bool GetEnableCursorBlink() const;
+ bool IsOutlineSetByString();
/**
- * @brief Query the current scroll position; the UI control is responsible for moving actors to this position.
- *
- * @return The scroll position.
+ * Set method outline setting were set by
+ * @param[in] bool, true if set by string
*/
- const Vector2& GetScrollPosition() const;
+ void OutlineSetByString(bool setByString);
/**
- * @brief Query the alignment offset.
- *
- * @return The alignmnet offset.
+ * @brief Query if font style settings were provided by string or map
+ * @return bool true if set by string
*/
- const Vector2& GetAlignmentOffset() const;
+ bool IsFontStyleSetByString();
/**
- * @copydoc Control::GetNaturalSize()
+ * Set method font style setting were set by
+ * @param[in] bool, true if set by string
*/
- Vector3 GetNaturalSize();
+ void FontStyleSetByString(bool setByString);
+public: // Update.
/**
- * @copydoc Control::GetHeightForWidth()
+ * @brief Replaces any text previously set.
+ *
+ * @note This will be converted into UTF-32 when stored in the text model.
+ * @param[in] text A string of UTF-8 characters.
*/
- float GetHeightForWidth( float width );
+ void SetText(const std::string& text);
/**
- * @brief Triggers a relayout which updates View (if necessary).
+ * @brief Retrieve any text previously set.
*
- * @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.
+ * @param[out] text A string of UTF-8 characters.
*/
- bool Relayout( const Size& size );
+ void GetText(std::string& text) const;
/**
- * @brief Process queued events which modify the model.
+ * @brief Replaces any placeholder text previously set.
+ *
+ * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
+ * @param[in] text A string of UTF-8 characters.
*/
- void ProcessModifyEvents();
+ void SetPlaceholderText(PlaceholderType type, const std::string& text);
/**
- * @brief Used to remove placeholder text.
+ * @brief Retrieve any placeholder text previously set.
+ *
+ * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
+ * @param[out] A string of UTF-8 characters.
*/
- void ResetText();
+ void GetPlaceholderText(PlaceholderType type, std::string& text) const;
/**
- * @brief Used to reset the cursor position after setting a new text.
- *
- * @param[in] cursorIndex Where to place the cursor.
+ * @ brief Update the text after a font change
+ * @param[in] newDefaultFont The new font to change to
*/
- void ResetCursorPosition( CharacterIndex cursorIndex );
+ void UpdateAfterFontChange(const std::string& newDefaultFont);
/**
- * @brief Used to reset the scroll position after setting a new text.
+ * @brief The method acquires currently selected text
+ * @param selectedText variable to place selected text in
*/
- void ResetScrollPosition();
+ void RetrieveSelection(std::string& selectedText) const;
/**
- * @brief Used to process an event queued from SetText()
+ * @brief The method sets selection in given range
+ * @param start index of first character
+ * @param end index of first character after selection
*/
- void TextReplacedEvent();
+ void SetSelection(int start, int end);
/**
- * @brief Used to process an event queued from key events etc.
+ * @brief This method retrieve indexes of current selection
+ *
+ * @return a pair, where first element is left index of selection and second is the right one
*/
- void TextInsertedEvent();
+ std::pair<int, int> GetSelectionIndexes() const;
/**
- * @brief Used to process an event queued from backspace key etc.
+ * Place string in system clipboard
+ * @param source std::string
*/
- void TextDeletedEvent();
+ void CopyStringToClipboard(const std::string& source);
/**
- * @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.
+ * Place currently selected text in system clipboard
+ * @param deleteAfterSending flag pointing if text should be deleted after sending to clipboard
*/
- bool DoRelayout( const Size& size,
- OperationsMask operations,
- Size& layoutSize );
+ void SendSelectionToClipboard(bool deleteAfterSending);
+public: // Default style & Input style
/**
- * @brief Whether to enable the multi-line layout.
+ * @brief Set the default font family.
*
- * @param[in] enable \e true enables the multi-line (by default)
+ * @param[in] defaultFontFamily The default font family.
*/
- void SetMultiLineEnabled( bool enable );
+ void SetDefaultFontFamily(const std::string& defaultFontFamily);
/**
- * @return Whether the multi-line layout is enabled.
+ * @brief Retrieve the default font family.
+ *
+ * @return The default font family.
*/
- bool IsMultiLineEnabled() const;
+ const std::string& GetDefaultFontFamily() const;
/**
- * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment()
+ * @brief Sets the placeholder text font family.
+ * @param[in] placeholderTextFontFamily The placeholder text font family.
*/
- void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment );
+ void SetPlaceholderFontFamily(const std::string& placeholderTextFontFamily);
/**
- * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment()
+ * @brief Retrieves the placeholder text font family.
+ *
+ * @return The placeholder text font family
*/
- LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const;
+ const std::string& GetPlaceholderFontFamily() const;
/**
- * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment()
+ * @brief Sets the default font weight.
+ *
+ * @param[in] weight The font weight.
*/
- void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment );
+ void SetDefaultFontWeight(FontWeight weight);
/**
- * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment()
+ * @brief Whether the font's weight has been defined.
*/
- LayoutEngine::VerticalAlignment GetVerticalAlignment() const;
+ bool IsDefaultFontWeightDefined() const;
/**
- * @brief Calulates the alignment of the whole text inside the bounding box.
+ * @brief Retrieves the default font weight.
*
- * @param[in] size The size of the bounding box.
+ * @return The default font weight.
+ */
+ FontWeight GetDefaultFontWeight() const;
+
+ /**
+ * @brief Sets the placeholder text font weight.
+ *
+ * @param[in] weight The font weight
+ */
+ void SetPlaceholderTextFontWeight(FontWeight weight);
+
+ /**
+ * @brief Whether the font's weight has been defined.
+ *
+ * @return True if the placeholder text font weight is defined
+ */
+ bool IsPlaceholderTextFontWeightDefined() const;
+
+ /**
+ * @brief Retrieves the placeholder text font weight.
+ *
+ * @return The placeholder text font weight
+ */
+ FontWeight GetPlaceholderTextFontWeight() const;
+
+ /**
+ * @brief Sets the default font width.
+ *
+ * @param[in] width The font width.
+ */
+ void SetDefaultFontWidth(FontWidth width);
+
+ /**
+ * @brief Whether the font's width has been defined.
+ */
+ bool IsDefaultFontWidthDefined() const;
+
+ /**
+ * @brief Retrieves the default font width.
+ *
+ * @return The default font width.
+ */
+ FontWidth GetDefaultFontWidth() const;
+
+ /**
+ * @brief Sets the placeholder text font width.
+ *
+ * @param[in] width The font width
+ */
+ void SetPlaceholderTextFontWidth(FontWidth width);
+
+ /**
+ * @brief Whether the font's width has been defined.
+ *
+ * @return True if the placeholder text font width is defined
+ */
+ bool IsPlaceholderTextFontWidthDefined() const;
+
+ /**
+ * @brief Retrieves the placeholder text font width.
+ *
+ * @return The placeholder text font width
+ */
+ FontWidth GetPlaceholderTextFontWidth() const;
+
+ /**
+ * @brief Sets the default font slant.
+ *
+ * @param[in] slant The font slant.
+ */
+ 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.
+ */
+ FontSlant GetDefaultFontSlant() const;
+
+ /**
+ * @brief Sets the placeholder text font slant.
+ *
+ * @param[in] slant The font slant
+ */
+ void SetPlaceholderTextFontSlant(FontSlant slant);
+
+ /**
+ * @brief Whether the font's slant has been defined.
+ *
+ * @return True if the placeholder text font slant is defined
+ */
+ bool IsPlaceholderTextFontSlantDefined() const;
+
+ /**
+ * @brief Retrieves the placeholder text font slant.
+ *
+ * @return The placeholder text font slant
+ */
+ FontSlant GetPlaceholderTextFontSlant() const;
+
+ /**
+ * @brief Set the default font size.
+ *
+ * @param[in] fontSize The default font size
+ * @param[in] type The font size type is point size or pixel size
+ */
+ void SetDefaultFontSize(float fontSize, FontSizeType type);
+
+ /**
+ * @brief Retrieve the default point size.
+ *
+ * @param[in] type The font size type
+ * @return The default point size.
+ */
+ float GetDefaultFontSize(FontSizeType type) const;
+
+ /**
+ * @brief Set the font size scale.
+ *
+ * @param[in] scale The font size scale
+ */
+ void SetFontSizeScale(float scale);
+
+ /**
+ * @brief Get the font size scale.
+ *
+ * @return The font size scale.
+ */
+ float GetFontSizeScale() const;
+
+ /**
+ * @brief Sets the Placeholder text font size.
+ * @param[in] fontSize The placeholder text font size
+ * @param[in] type The font size type is point size or pixel size
+ */
+ void SetPlaceholderTextFontSize(float fontSize, FontSizeType type);
+
+ /**
+ * @brief Retrieves the Placeholder text font size.
+ * @param[in] type The font size type
+ * @return The placeholder font size
+ */
+ float GetPlaceholderTextFontSize(FontSizeType type) const;
+
+ /**
+ * @brief Sets the text's default color.
+ *
+ * @param color The default color.
+ */
+ void SetDefaultColor(const Vector4& color);
+
+ /**
+ * @brief Retrieves the text's default color.
+ *
+ * @return The default color.
+ */
+ const Vector4& GetDefaultColor() const;
+
+ /**
+ * @brief Set the text color
+ *
+ * @param textColor The text color
+ */
+ void SetPlaceholderTextColor(const Vector4& textColor);
+
+ /**
+ * @brief Retrieve the text color
+ *
+ * @return The text color
+ */
+ const Vector4& GetPlaceholderTextColor() 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 shadow blur radius.
+ *
+ * @param[in] shadowBlurRadius The shadow blur radius, 0,0 indicates no blur.
+ */
+ void SetShadowBlurRadius(const float& shadowBlurRadius);
+
+ /**
+ * @brief Retrieve the shadow blur radius.
+ *
+ * @return The shadow blur radius.
+ */
+ const float& GetShadowBlurRadius() 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 Set the outline color.
+ *
+ * @param[in] color color of outline.
+ */
+ void SetOutlineColor(const Vector4& color);
+
+ /**
+ * @brief Retrieve the outline color.
+ *
+ * @return The outline color.
+ */
+ const Vector4& GetOutlineColor() const;
+
+ /**
+ * @brief Set the outline width
+ *
+ * @param[in] width The width in pixels of the outline, 0 indicates no outline
+ */
+ void SetOutlineWidth(uint16_t width);
+
+ /**
+ * @brief Retrieves the width of an outline
+ *
+ * @return The width of the outline.
+ */
+ uint16_t GetOutlineWidth() const;
+
+ /**
+ * @brief Set the background color.
+ *
+ * @param[in] color color of background.
+ */
+ void SetBackgroundColor(const Vector4& color);
+
+ /**
+ * @brief Retrieve the background color.
+ *
+ * @return The background color.
+ */
+ const Vector4& GetBackgroundColor() const;
+
+ /**
+ * @brief Set the background enabled flag.
+ *
+ * @param[in] enabled The background enabled flag.
+ */
+ void SetBackgroundEnabled(bool enabled);
+
+ /**
+ * @brief Returns whether to enable text background or not.
+ *
+ * @return Whether text background is enabled.
+ */
+ bool IsBackgroundEnabled() 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.
+ *
+ * @return True if lineSpacing has been updated, false otherwise
+ */
+ bool SetDefaultLineSpacing(float lineSpacing);
+
+ /**
+ * @brief Retrieves the default line spacing.
+ *
+ * @return The line spacing.
+ */
+ float GetDefaultLineSpacing() const;
+
+ /**
+ * @brief Sets the default line size.
+ *
+ * @param[in] lineSize The line size.
+ *
+ * @return True if lineSize has been updated, false otherwise
+ */
+ bool SetDefaultLineSize(float lineSize);
+
+ /**
+ * @brief Retrieves the default line size.
+ *
+ * @return The line size.
+ */
+ float GetDefaultLineSize() 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 Set the control's interface.
+ *
+ * @param[in] controlInterface The control's interface.
+ */
+ void SetControlInterface(ControlInterface* controlInterface);
+
+ /**
+ * @brief Set the anchor control's interface.
+ *
+ * @param[in] anchorControlInterface The control's interface.
+ */
+ void SetAnchorControlInterface(AnchorControlInterface* anchorControlInterface);
+
+public: // Queries & retrieves.
+ /**
+ * @brief Return the layout engine.
+ *
+ * @return A reference to the layout engine.
+ */
+ Layout::Engine& GetLayoutEngine();
+
+ /**
+ * @brief Return a view of the text.
+ *
+ * @return A reference to the view.
+ */
+ View& GetView();
+
+ /**
+ * @copydoc Control::GetNaturalSize()
+ */
+ Vector3 GetNaturalSize();
+
+ /**
+ * @copydoc Control::GetHeightForWidth()
+ */
+ float GetHeightForWidth(float width);
+
+ /**
+ * @brief Calculates the point size for text for given layout()
+ */
+ void FitPointSizeforLayout(Size layoutSize);
+
+ /**
+ * @brief Checks if the point size fits within the layout size.
+ *
+ * @return Whether the point size fits within the layout size.
*/
- void CalculateTextAlignment( const Size& size );
+ bool CheckForTextFit(float pointSize, Size& layoutSize);
/**
- * @brief Return the layout engine.
+ * @brief Retrieves the text's number of lines for a given width.
+ * @param[in] width The width of the text's area.
+ * @ return The number of lines.
+ */
+ int GetLineCount(float width);
+
+ /**
+ * @brief Retrieves the text's model.
*
- * @return A reference to the layout engine.
+ * @return A pointer to the text's model.
*/
- LayoutEngine& GetLayoutEngine();
+ const ModelInterface* const GetTextModel() const;
/**
- * @brief Return a view of the text.
+ * @brief Used to get scrolled distance by user input
*
- * @return A reference to the view.
+ * @return Distance from last scroll offset to new scroll offset
*/
- View& GetView();
+ float GetScrollAmountByUserInput();
+
+ /**
+ * @brief Get latest scroll amount, control size and layout size
+ *
+ * This method is used to get information of control's scroll
+ * @param[out] scrollPosition The current scrolled position
+ * @param[out] controlHeight The size of a UI control
+ * @param[out] layoutHeight The size of a bounding box to layout text within.
+ *
+ * @return Whether the text scroll position is changed or not after last update.
+ */
+ bool GetTextScrollInfo(float& scrollPosition, float& controlHeight, float& layoutHeight);
+
+ /**
+ * @brief Used to set the hidden input option
+ */
+ void SetHiddenInputOption(const Property::Map& options);
+
+ /**
+ * @brief Used to get the hidden input option
+ */
+ void GetHiddenInputOption(Property::Map& options);
+
+ /**
+ * @brief Used to set the input filter option
+ */
+ void SetInputFilterOption(const Property::Map& options);
+
+ /**
+ * @brief Used to get the input filter option
+ */
+ void GetInputFilterOption(Property::Map& options);
+
+ /**
+ * @brief Sets the Placeholder Properties.
+ *
+ * @param[in] map The placeholder property map
+ */
+ void SetPlaceholderProperty(const Property::Map& map);
+
+ /**
+ * @brief Retrieves the Placeholder Property map.
+ *
+ * @param[out] map The property map
+ */
+ void GetPlaceholderProperty(Property::Map& map);
+
+ /**
+ * @brief Checks text direction.
+ * @return The text direction.
+ */
+ Toolkit::DevelText::TextDirection::Type GetTextDirection();
+
+ /**
+ * @brief Retrieves vertical line alignment
+ * @return The vertical line alignment
+ */
+ Toolkit::DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const;
+
+ /**
+ * @brief Sets vertical line alignment
+ * @param[in] alignment The vertical line alignment for the text
+ */
+ void SetVerticalLineAlignment(Toolkit::DevelText::VerticalLineAlignment::Type alignment);
+
+ /**
+ * @brief Retrieves ellipsis position
+ * @return The ellipsis position
+ */
+ Toolkit::DevelText::EllipsisPosition::Type GetEllipsisPosition() const;
+
+ /**
+ * @brief Sets ellipsis position
+ * @param[in] ellipsisPosition The ellipsis position for the text
+ */
+ void SetEllipsisPosition(Toolkit::DevelText::EllipsisPosition::Type ellipsisPosition);
+
+ /**
+ * @brief Retrieves ignoreSpaceAfterText value from model
+ * @return The value of ignoreSpaceAfterText
+ */
+ bool IsIgnoreSpacesAfterText() const;
+
+ /**
+ * @brief Sets ignoreSpaceAfterText value to model
+ * @param[in] ignore The value of ignoreSpacesAfterText for the text
+ */
+ void SetIgnoreSpacesAfterText(bool ignore);
+
+ /**
+ * @brief Sets SetMatchLayoutDirection value to model
+ * @param[in] match The value of matchLayoutDirection for the text
+ */
+ void SetMatchLayoutDirection(DevelText::MatchLayoutDirection type);
+
+ /**
+ * @brief Retrieves matchLayoutDirection value from model
+ * @return The value of matchLayoutDirection
+ */
+ DevelText::MatchLayoutDirection GetMatchLayoutDirection() const;
+
+ /**
+ * @brief Sets layoutDirection type value.
+ * @param[in] layoutDirection The value of the layout direction type.
+ */
+ void SetLayoutDirection(Dali::LayoutDirection::Type layoutDirection);
+
+ /**
+ * @brief Gets layoutDirection type value.
+ * @param[in] actor The actor which will get the layout direction type.
+ * @return The value of the layout direction type.
+ */
+ Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
+
+ /**
+ * @brief Sets the layout direction changed.
+ */
+ void ChangedLayoutDirection();
+
+ /**
+ * @brief Retrieves if showing real text or not.
+ * @return The value of showing real text.
+ */
+ bool IsShowingRealText() const;
+
+public: // Relayout.
+ /**
+ * @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.
+ * @param[in] layoutDirection The direction of the system language.
+ *
+ * @return Whether the text model or decorations were updated.
+ */
+ UpdateTextType Relayout(const Size& size, Dali::LayoutDirection::Type layoutDirection = Dali::LayoutDirection::LEFT_TO_RIGHT);
+
+ /**
+ * @brief Request a relayout using the ControlInterface.
+ */
+ void RequestRelayout();
+
+public: // Input style change signals.
+ /**
+ * @return Whether the queue of input style changed signals is empty.
+ */
+ bool IsInputStyleChangedSignalsQueueEmpty();
- // Text-input Event Queuing
+ /**
+ * @brief Process all pending input style changed signals.
+ *
+ * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
+ * text controls. Text controls may send signals to state the input style has changed.
+ */
+ void ProcessInputStyleChangedSignals();
+public: // Text-input Event Queuing.
/**
* @brief Called by editable UI controls when keyboard focus is gained.
*/
* @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.
- */
- bool KeyEvent( const Dali::KeyEvent& event );
-
- /**
- * @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.
+ * @param[in] type Used to distinguish between regular key events and InputMethodContext events.
*/
- void InsertText( const std::string& text, InsertType type );
+ bool KeyEvent(const Dali::KeyEvent& event);
/**
- * @brief Checks if text is selected and if so removes it.
- * @return true if text was removed
+ * @brief Called by anchor when a tap gesture occurs.
+ * @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.
*/
- bool RemoveSelectedText();
+ void AnchorEvent(float x, float y);
/**
* @brief Called by editable UI controls when a tap gesture occurs.
* @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 TapEvent( unsigned int tapCount, float x, float y );
+ void TapEvent(unsigned int tapCount, float x, float y);
/**
* @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.
*/
- void PanEvent( Gesture::State state, const Vector2& displacement );
+ void PanEvent(GestureState state, const Vector2& displacement);
/**
* @brief Called by editable UI controls when a long press gesture occurs.
* @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 );
+ void LongPressEvent(GestureState state, float x, float y);
+
+ /**
+ * @brief Used to get the Primary cursor position.
+ *
+ * @return Primary cursor position.
+ */
+ CharacterIndex GetPrimaryCursorPosition() const;
+
+ /**
+ * @brief Used to set the Primary cursor position.
+ *
+ * @param[in] index for the Primary cursor position.
+ * @return[in] true if cursor position changed, false otherwise.
+ */
+ bool SetPrimaryCursorPosition(CharacterIndex index);
/**
* @brief Creates a selection event.
*
* @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.
+ * @param[in] selection type like the whole text is selected or unselected.
*/
- void SelectEvent( float x, float y, bool selectAll );
+ void SelectEvent(float x, float y, SelectionType selection);
/**
- * @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.
+ * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
*/
- ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
+ void SetTextSelectionRange(const uint32_t* start, const uint32_t* end);
/**
- * @brief Paste given string into Text model
- * @param[in] stringToPaste this string will be inserted into the text model
+ * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
+ */
+ Uint32Pair GetTextSelectionRange() const;
+
+ /**
+ * @copydoc Text::SelectableControlInterface::SelectWholeText()
+ */
+ void SelectWholeText();
+
+ /**
+ * @copydoc Text::SelectableControlInterface::SelectNone()
+ */
+ void SelectNone();
+
+ /**
+ * @copydoc Text::SelectableControlInterface::GetSelectedText()
+ */
+ string GetSelectedText() const;
+
+ /**
+ * @copydoc Text::EditableControlInterface::IsEditable()
+ */
+ virtual bool IsEditable() const;
+
+ /**
+ * @copydoc Text::EditableControlInterface::SetEditable()
+ */
+ virtual void SetEditable(bool editable);
+
+ /**
+ * @copydoc Dali::Toolkit::Internal::TextEditor::ScrollBy()
+ */
+ virtual void ScrollBy(Vector2 scroll);
+
+ /**
+ * @copydoc Dali::Toolkit::Internal::TextEditor::GetHorizontalScrollPosition()
+ */
+ float GetHorizontalScrollPosition();
+
+ /**
+ * @copydoc Dali::Toolkit::Internal::TextEditor::GetVerticalScrollPosition()
+ */
+ float GetVerticalScrollPosition();
+
+ /**
+ * @brief Event received from input method context
+ *
+ * @param[in] inputMethodContext The input method context.
+ * @param[in] inputMethodContextEvent The event received.
+ * @return A data struture indicating if update is needed, cursor position and current text.
*/
- void PasteText( const std::string& stringToPaste );
+ InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
/**
* @brief Event from Clipboard notifying an Item has been selected for pasting
void PasteClipboardItemEvent();
/**
+ * @brief Return true when text control should clear key input focus when escape key is pressed.
+ *
+ * @return Whether text control should clear key input focus or not when escape key is pressed.
+ */
+ bool ShouldClearFocusOnEscape() const;
+
+ /**
+ * @brief Create an actor that renders the text background color
+ *
+ * @return the created actor or an empty handle if no background color needs to be rendered.
+ */
+ Actor CreateBackgroundActor();
+
+ /**
+ * @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 The method acquires current position of cursor
+ * @return unsigned value with cursor position
+ */
+ CharacterIndex GetCursorPosition();
+
+protected: // Inherit from Text::Decorator::ControllerInterface.
+ /**
* @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
*/
- virtual void GetTargetSize( Vector2& targetSize );
+ void GetTargetSize(Vector2& targetSize) override;
/**
* @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
*/
- virtual void AddDecoration( Actor& actor, bool needsClipping );
+ void AddDecoration(Actor& actor, bool needsClipping) override;
/**
* @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
*/
- virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
+ void DecorationEvent(HandleType handle, HandleState state, float x, float y) override;
+protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
/**
* @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
*/
- virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
+ void TextPopupButtonTouched(Dali::Toolkit::TextSelectionPopup::Buttons button) override;
-protected:
+protected: // Inherit from HiddenText.
+ /**
+ * @brief Invoked from HiddenText when showing time of the last character was expired
+ */
+ void DisplayTimeExpired() override;
+private: // Update.
/**
- * @brief A reference counted object may only be deleted by calling Unreference().
+ * @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 InputMethodContext events.
*/
- virtual ~Controller();
+ void InsertText(const std::string& text, InsertType type);
-private:
+ /**
+ * @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 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,
+ UpdateInputStyleType type);
+
+ /**
+ * @brief Checks if text is selected and if so removes it.
+ * @return true if text was removed
+ */
+ bool RemoveSelectedText();
+
+ /**
+ * @brief Update anchor position from given number of inserted characters.
+ *
+ * @param[in] numberOfCharacters The number of inserted characters.
+ * @param[in] previousCursorIndex A cursor position before event occurs.
+ */
+ void InsertTextAnchor(int numberOfCharacters,
+ CharacterIndex previousCursorIndex);
+
+ /**
+ * @brief Update anchor position from given number of removed characters.
+ *
+ * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
+ * @param[in] numberOfCharacters The number of removed characters.
+ * @param[in] previousCursorIndex A cursor position before event occurs.
+ */
+ void RemoveTextAnchor(int cursorOffset,
+ int numberOfCharacters,
+ CharacterIndex previousCursorIndex);
+
+private: // Relayout.
+ /**
+ * @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 vertical offset to align the text inside the bounding box.
+ *
+ * @param[in] size The size of the bounding box.
+ */
+ void CalculateVerticalOffset(const Size& size);
+
+private: // Events.
+ /**
+ * @brief Process queued events which modify the model.
+ */
+ void ProcessModifyEvents();
+
+ /**
+ * @brief Used to process an event queued from SetText()
+ */
+ void TextReplacedEvent();
+
+ /**
+ * @brief Used to process an event queued from key events etc.
+ */
+ void TextInsertedEvent();
+
+ /**
+ * @brief Used to process an event queued from backspace key etc.
+ */
+ void TextDeletedEvent();
/**
- * @brief Helper to KeyEvent() to handle the backspace case.
+ * @brief Helper to KeyEvent() to handle the backspace or delete key case.
*
+ * @param[in] keyCode The keycode for the key pressed
* @return True if a character was deleted.
*/
- bool BackspaceKeyEvent();
+ bool DeleteEvent(int keyCode);
+private: // Helpers.
/**
- * @brief Helper to notify IMF manager with surrounding text & cursor changes.
+ * @brief Used to remove the text included the placeholder text.
*/
- void NotifyImfManager();
+ void ResetText();
/**
- * @brief Helper to clear font-specific data.
+ * @brief Helper to show the place holder text..
*/
void ShowPlaceholderText();
void ClearStyleData();
/**
+ * @brief Used to reset the scroll position after setting a new text.
+ */
+ void ResetScrollPosition();
+
+private: // Private contructors & copy operator.
+ /**
+ * @brief Private constructor.
+ */
+ Controller();
+
+ /**
+ * @brief Private constructor.
+ */
+ Controller(ControlInterface* controlInterface);
+
+ /**
* @brief Private constructor.
*/
- Controller( ControlInterface& controlInterface );
+ Controller(ControlInterface* controlInterface,
+ EditableControlInterface* editableControlInterface,
+ SelectableControlInterface* selectableControlInterface,
+ AnchorControlInterface* anchorControlInterface);
// Undefined
- Controller( const Controller& handle );
+ Controller(const Controller& handle);
// Undefined
- Controller& operator=( const Controller& handle );
+ Controller& operator=(const Controller& handle);
+
+protected: // Destructor.
+ /**
+ * @brief A reference counted object may only be deleted by calling Unreference().
+ */
+ virtual ~Controller();
+
+public:
+ struct Impl; ///< Made public for testing purposes
private:
+ struct EventHandler;
+ struct InputFontHandler;
+ struct PlaceholderHandler;
+ struct Relayouter;
+ struct TextUpdater;
- struct Impl;
Impl* mImpl;
};
} // namespace Dali
-#endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__
+#endif // DALI_TOOLKIT_TEXT_CONTROLLER_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff