1 #ifndef DALI_TOOLKIT_TEXT_CONTROLLER_H
2 #define DALI_TOOLKIT_TEXT_CONTROLLER_H
5 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/devel-api/adaptor-framework/input-method-context.h>
23 #include <dali/public-api/events/gesture.h>
26 #include <dali-toolkit/devel-api/controls/text-controls/text-anchor-devel.h>
27 #include <dali-toolkit/devel-api/controls/text-controls/text-label-devel.h>
28 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup-callback-interface.h>
29 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
30 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
31 #include <dali-toolkit/internal/text/hidden-text.h>
32 #include <dali-toolkit/internal/text/input-filter.h>
33 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
34 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
35 #include <dali-toolkit/internal/text/text-model-interface.h>
36 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
37 #include <dali-toolkit/public-api/text/text-enumerations.h>
39 namespace Dali::Toolkit::Text
42 class ControlInterface;
43 class EditableControlInterface;
45 class RenderingController;
48 * @brief Text selection operations .
52 INTERACTIVE = 0x0000, ///< Select the word where the cursor is located.
53 ALL = 0x0001, ///< Select the whole text.
54 NONE = 0x0002, ///< Unselect the whole text.
55 RANGE = 0x0003 ///< Select the range text.
58 typedef IntrusivePtr<Controller> ControllerPtr;
61 * @brief A Text Controller is used by UI Controls which display text.
63 * It manipulates the Logical & Visual text models on behalf of the UI Controls.
64 * It provides a view of the text that can be used by rendering back-ends.
66 * For selectable/editable UI controls, the controller handles input events from the UI control
67 * and decorations (grab handles etc) via the Decorator::ControllerInterface interface.
69 * The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface.
71 class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface, public HiddenText::Observer
73 public: // Enumerated types.
75 * @brief Text related operations to be done in the relayout process.
79 NO_OPERATION = 0x0000,
80 CONVERT_TO_UTF32 = 0x0001,
82 VALIDATE_FONTS = 0x0004,
83 GET_LINE_BREAKS = 0x0008,
86 GET_GLYPH_METRICS = 0x0040,
88 UPDATE_LAYOUT_SIZE = 0x0100,
92 UPDATE_DIRECTION = 0x1000,
93 ALL_OPERATIONS = 0xFFFF
97 * @brief Used to distinguish between regular key events and InputMethodContext events
106 * @brief Used to specify whether to update the input style.
108 enum UpdateInputStyleType
111 DONT_UPDATE_INPUT_STYLE
115 * @brief Used to specify what has been updated after the Relayout() method has been called.
119 NONE_UPDATED = 0x0, ///< Nothing has been updated.
120 MODEL_UPDATED = 0x1, ///< The text's model has been updated.
121 DECORATOR_UPDATED = 0x2 ///< The decoration has been updated.
125 * @brief Different placeholder-text can be shown when the control is active/inactive.
129 PLACEHOLDER_TYPE_ACTIVE,
130 PLACEHOLDER_TYPE_INACTIVE,
134 * @brief Enumeration for Font Size Type.
138 POINT_SIZE, // The size of font in points.
139 PIXEL_SIZE // The size of font in pixels.
146 NO_ACTION, ///< Does no action if there is a tap on top of an area with no text.
147 HIGHLIGHT, ///< Highlights the nearest text (at the beginning or end of the text) and shows the text's selection popup.
148 SHOW_SELECTION_POPUP ///< Shows the text's selection popup.
160 TEXT_FIT_FONT_SIZE_TYPE
164 public: // Constructor.
166 * @brief Create a new instance of a Controller.
168 * @return A pointer to a new Controller.
170 static ControllerPtr New()
172 return ControllerPtr(new Controller());
176 * @brief Create a new instance of a Controller.
178 * @param[in] controlInterface The control's interface.
180 * @return A pointer to a new Controller.
182 static ControllerPtr New(ControlInterface* controlInterface)
184 return ControllerPtr(new Controller(controlInterface));
188 * @brief Create a new instance of a Controller.
190 * @param[in] controlInterface The control's interface.
191 * @param[in] editableControlInterface The editable control's interface.
192 * @param[in] selectableControlInterface The selectable control's interface.
193 * @param[in] anchorControlInterface The anchor control's interface.
195 * @return A pointer to a new Controller.
197 static ControllerPtr New(ControlInterface* controlInterface,
198 EditableControlInterface* editableControlInterface,
199 SelectableControlInterface* selectableControlInterface,
200 AnchorControlInterface* anchorControlInterface)
202 return ControllerPtr(new Controller(controlInterface,
203 editableControlInterface,
204 selectableControlInterface,
205 anchorControlInterface));
208 public: // Configure the text controller.
210 * @brief Called to enable text input.
212 * @note Selectable or editable controls should call this once after Controller::New().
213 * @param[in] decorator Used to create cursor, selection handle decorations etc.
214 * @param[in] inputMethodContext Used to manager ime.
216 void EnableTextInput(DecoratorPtr decorator, InputMethodContext& inputMethodContext);
219 * @brief Used to switch between bitmap & vector based glyphs
221 * @param[in] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different.
223 void SetGlyphType(TextAbstraction::GlyphType glyphType);
226 * @brief Enables/disables the mark-up processor.
228 * By default is disabled.
230 * @param[in] enable Whether to enable the mark-up processor.
232 void SetMarkupProcessorEnabled(bool enable);
235 * @brief Retrieves whether the mark-up processor is enabled.
237 * By default is disabled.
239 * @return @e true if the mark-up processor is enabled, otherwise returns @e false.
241 bool IsMarkupProcessorEnabled() const;
244 * @brief Retrieves whether the current text contains anchors.
246 * @return @e true if the current text contains anchors. @e false.
248 bool HasAnchors() const;
251 * @brief Enables/disables the auto text scrolling
253 * By default is disabled.
255 * @param[in] enable Whether to enable the auto scrolling
257 void SetAutoScrollEnabled(bool enable);
260 * @brief Retrieves whether auto text scrolling is enabled.
262 * By default is disabled.
264 * @return @e true if auto scrolling is enabled, otherwise returns @e false.
266 bool IsAutoScrollEnabled() const;
269 * @brief Get direction of the text from the first line of text,
270 * @return bool rtl (right to left) is true
272 CharacterDirection GetAutoScrollDirection() const;
275 * @brief Get the alignment offset of the first line of text.
277 * @return The alignment offset.
279 float GetAutoScrollLineAlignment() const;
282 * @brief Enables the horizontal scrolling.
284 * @param[in] enable Whether to enable the horizontal scrolling.
286 void SetHorizontalScrollEnabled(bool enable);
289 * @brief Retrieves whether the horizontal scrolling is enabled.
291 * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false.
293 bool IsHorizontalScrollEnabled() const;
296 * @brief Enables the vertical scrolling.
298 * @param[in] enable Whether to enable the vertical scrolling.
300 void SetVerticalScrollEnabled(bool enable);
303 * @brief Retrieves whether the verticall scrolling is enabled.
305 * @return @e true if the vertical scrolling is enabled, otherwise it returns @e false.
307 bool IsVerticalScrollEnabled() const;
310 * @brief Enables the smooth handle panning.
312 * @param[in] enable Whether to enable the smooth handle panning.
314 void SetSmoothHandlePanEnabled(bool enable);
317 * @brief Retrieves whether the smooth handle panning is enabled.
319 * @return @e true if the smooth handle panning is enabled.
321 bool IsSmoothHandlePanEnabled() const;
324 * @brief Sets the maximum number of characters that can be inserted into the TextModel
326 * @param[in] maxCharacters maximum number of characters to be accepted
328 void SetMaximumNumberOfCharacters(Length maxCharacters);
331 * @brief Sets the maximum number of characters that can be inserted into the TextModel
333 * @param[in] maxCharacters maximum number of characters to be accepted
335 int GetMaximumNumberOfCharacters();
338 * @brief Called to enable/disable cursor blink.
340 * @note Only editable controls should calls this.
341 * @param[in] enabled Whether the cursor should blink or not.
343 void SetEnableCursorBlink(bool enable);
346 * @brief Query whether cursor blink is enabled.
348 * @return Whether the cursor should blink or not.
350 bool GetEnableCursorBlink() const;
353 * @brief Whether to enable the multi-line layout.
355 * @param[in] enable \e true enables the multi-line (by default)
357 void SetMultiLineEnabled(bool enable);
360 * @return Whether the multi-line layout is enabled.
362 bool IsMultiLineEnabled() const;
365 * @brief Sets the text's horizontal alignment.
367 * @param[in] alignment The horizontal alignment.
369 void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
372 * @copydoc ModelInterface::GetHorizontalAlignment()
374 HorizontalAlignment::Type GetHorizontalAlignment() const;
377 * @brief Sets the text's vertical alignment.
379 * @param[in] alignment The vertical alignment.
381 void SetVerticalAlignment(VerticalAlignment::Type alignment);
384 * @copydoc ModelInterface::GetVerticalAlignment()
386 VerticalAlignment::Type GetVerticalAlignment() const;
389 * @brief Sets the text's wrap mode
390 * @param[in] text wrap mode The unit of wrapping
392 void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
395 * @brief Retrieve text wrap mode previously set.
396 * @return text wrap mode
398 Text::LineWrap::Mode GetLineWrapMode() const;
401 * @brief Enable or disable the text elide.
403 * @param[in] enabled Whether to enable the text elide.
405 void SetTextElideEnabled(bool enabled);
408 * @copydoc ModelInterface::IsTextElideEnabled()
410 bool IsTextElideEnabled() const;
413 * @brief Enable or disable the text fit.
415 * @param[in] enabled Whether to enable the text fit.
417 void SetTextFitEnabled(bool enabled);
420 * @brief Whether the text fit is enabled or not.
422 * @return True if the text fit is enabled
424 bool IsTextFitEnabled() const;
427 * @brief Sets minimum size valid for text fit.
429 * @param[in] minimum size value.
430 * @param[in] type The font size type is point size or pixel size
432 void SetTextFitMinSize(float pointSize, FontSizeType type);
435 * @brief Retrieves the minimum point size valid for text fit.
437 * @return The minimum point size valid for text fit
439 float GetTextFitMinSize() const;
442 * @brief Sets maximum size valid for text fit.
444 * @param[in] maximum size value.
445 * @param[in] type The font size type is point size or pixel size
447 void SetTextFitMaxSize(float pointSize, FontSizeType type);
450 * @brief Retrieves the maximum point size valid for text fit.
452 * @return The maximum point size valid for text fit
454 float GetTextFitMaxSize() const;
457 * @brief Sets step size for font increase valid for text fit.
459 * @param[in] step size value.
460 * @param[in] type The font size type is point size or pixel size
462 void SetTextFitStepSize(float step, FontSizeType type);
465 * @brief Retrieves the step point size valid for text fit.
467 * @return The step point size valid for text fit
469 float GetTextFitStepSize() const;
472 * @brief Sets content size valid for text fit.
474 * @param[in] Content size value.
476 void SetTextFitContentSize(Vector2 size);
479 * @brief Retrieves the content size valid for text fit.
481 * @return The content size valid for text fit
483 Vector2 GetTextFitContentSize() const;
486 * @brief Retrieve the fited point size.
488 * @return The fited point size.
490 float GetTextFitPointSize() const;
493 * @brief Sets whether the text fit properties have changed.
495 * @param[in] changed Whether to changed the text fit.
497 void SetTextFitChanged(bool changed);
500 * @brief Whether the text fit properties are changed or not.
502 * @return True if the text fit properties are changed
504 bool IsTextFitChanged() const;
507 * @brief Sets disabled color opacity.
509 * @param[in] opacity The color opacity value in disabled state.
511 void SetDisabledColorOpacity(float opacity);
514 * @brief Retrieves the disabled color opacity.
516 * @return The disabled color opacity value for disabled state.
518 float GetDisabledColorOpacity() const;
521 * @brief Enable or disable the placeholder text elide.
522 * @param enabled Whether to enable the placeholder text elide.
524 void SetPlaceholderTextElideEnabled(bool enabled);
527 * @brief Whether the placeholder text elide property is enabled.
528 * @return True if the placeholder text elide property is enabled, false otherwise.
530 bool IsPlaceholderTextElideEnabled() const;
533 * @brief Enable or disable the text selection.
534 * @param[in] enabled Whether to enable the text selection.
536 void SetSelectionEnabled(bool enabled);
539 * @brief Whether the text selection is enabled or not.
540 * @return True if the text selection is enabled
542 bool IsSelectionEnabled() const;
545 * @brief Enable or disable the text selection using Shift key.
546 * @param enabled Whether to enable the text selection using Shift key
548 void SetShiftSelectionEnabled(bool enabled);
551 * @brief Whether the text selection using Shift key is enabled or not.
552 * @return True if the text selection using Shift key is enabled
554 bool IsShiftSelectionEnabled() const;
557 * @brief Enable or disable the grab handles for text selection.
559 * @param[in] enabled Whether to enable the grab handles
561 void SetGrabHandleEnabled(bool enabled);
564 * @brief Returns whether the grab handles are enabled.
566 * @return True if the grab handles are enabled
568 bool IsGrabHandleEnabled() const;
571 * @brief Enable or disable the grab handles for text selection.
573 * @param[in] enabled Whether to enable the grab handles
575 void SetGrabHandlePopupEnabled(bool enabled);
578 * @brief Returns whether the grab handles are enabled.
580 * @return True if the grab handles are enabled
582 bool IsGrabHandlePopupEnabled() const;
585 * @brief Sets input type to password
587 * @note The string is displayed hidden character
589 * @param[in] passwordInput True if password input is enabled.
591 void SetInputModePassword(bool passwordInput);
594 * @brief Returns whether the input mode type is set as password.
596 * @return True if input mode type is password
598 bool IsInputModePassword();
601 * @brief Sets the action when there is a double tap event on top of a text area with no text.
603 * @param[in] action The action to do.
605 void SetNoTextDoubleTapAction(NoTextTap::Action action);
608 * @brief Retrieves the action when there is a double tap event on top of a text area with no text.
610 * @return The action to do.
612 NoTextTap::Action GetNoTextDoubleTapAction() const;
615 * @briefSets the action when there is a long press event on top of a text area with no text.
617 * @param[in] action The action to do.
619 void SetNoTextLongPressAction(NoTextTap::Action action);
622 * @brief Retrieves the action when there is a long press event on top of a text area with no text.
624 * @return The action to do.
626 NoTextTap::Action GetNoTextLongPressAction() const;
629 * @brief Query if Underline settings were provided by string or map
630 * @return bool true if set by string
632 bool IsUnderlineSetByString();
635 * Set method underline setting were set by
636 * @param[in] bool, true if set by string
638 void UnderlineSetByString(bool setByString);
641 * @brief Query if shadow settings were provided by string or map
642 * @return bool true if set by string
644 bool IsShadowSetByString();
647 * Set method shadow setting were set by
648 * @param[in] bool, true if set by string
650 void ShadowSetByString(bool setByString);
653 * @brief Query if outline settings were provided by string or map
654 * @return bool true if set by string
656 bool IsOutlineSetByString();
659 * Set method outline setting were set by
660 * @param[in] bool, true if set by string
662 void OutlineSetByString(bool setByString);
665 * @brief Query if font style settings were provided by string or map
666 * @return bool true if set by string
668 bool IsFontStyleSetByString();
671 * Set method font style setting were set by
672 * @param[in] bool, true if set by string
674 void FontStyleSetByString(bool setByString);
677 * @brief Query if Strikethrough settings were provided by string or map
678 * @return bool true if set by string
680 bool IsStrikethroughSetByString();
683 * Set method Strikethrough setting were set by
684 * @param[in] bool, true if set by string
686 void StrikethroughSetByString(bool setByString);
689 * @brief Set the override used for strikethrough height, 0 indicates height will be supplied by font metrics
691 * @param[in] height The height in pixels of the strikethrough
693 void SetStrikethroughHeight(float height);
696 * @brief Retrieves the override height of an strikethrough, 0 indicates height is supplied by font metrics
698 * @return The height of the strikethrough, or 0 if height is not overrided.
700 float GetStrikethroughHeight() const;
703 * @brief Set the strikethrough color.
705 * @param[in] color color of strikethrough.
707 void SetStrikethroughColor(const Vector4& color);
710 * @brief Retrieve the strikethrough color.
712 * @return The strikethrough color.
714 const Vector4& GetStrikethroughColor() const;
717 * @brief Set the strikethrough enabled flag.
719 * @param[in] enabled The strikethrough enabled flag.
721 void SetStrikethroughEnabled(bool enabled);
724 * @brief Returns whether the text has a strikethrough or not.
726 * @return The strikethrough state.
728 bool IsStrikethroughEnabled() const;
732 * @brief Replaces any text previously set.
734 * @note This will be converted into UTF-32 when stored in the text model.
735 * @param[in] text A string of UTF-8 characters.
737 void SetText(const std::string& text);
740 * @brief Retrieve any text previously set.
742 * @param[out] text A string of UTF-8 characters.
744 void GetText(std::string& text) const;
747 * @brief Replaces any placeholder text previously set.
749 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
750 * @param[in] text A string of UTF-8 characters.
752 void SetPlaceholderText(PlaceholderType type, const std::string& text);
755 * @brief Retrieve any placeholder text previously set.
757 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
758 * @param[out] A string of UTF-8 characters.
760 void GetPlaceholderText(PlaceholderType type, std::string& text) const;
763 * @ brief Update the text after a font change
764 * @param[in] newDefaultFont The new font to change to
766 void UpdateAfterFontChange(const std::string& newDefaultFont);
769 * @brief The method acquires currently selected text
770 * @param selectedText variable to place selected text in
772 void RetrieveSelection(std::string& selectedText) const;
775 * @brief The method sets selection in given range
776 * @param start index of first character
777 * @param end index of first character after selection
779 void SetSelection(int start, int end);
782 * @brief This method retrieve indexes of current selection
784 * @return a pair, where first element is left index of selection and second is the right one
786 std::pair<int, int> GetSelectionIndexes() const;
789 * Place string in system clipboard
790 * @param source std::string
792 void CopyStringToClipboard(const std::string& source);
795 * Place currently selected text in system clipboard
796 * @param deleteAfterSending flag pointing if text should be deleted after sending to clipboard
798 void SendSelectionToClipboard(bool deleteAfterSending);
800 public: // Default style & Input style
802 * @brief Set the default font family.
804 * @param[in] defaultFontFamily The default font family.
806 void SetDefaultFontFamily(const std::string& defaultFontFamily);
809 * @brief Retrieve the default font family.
811 * @return The default font family.
813 const std::string& GetDefaultFontFamily() const;
816 * @brief Sets the placeholder text font family.
817 * @param[in] placeholderTextFontFamily The placeholder text font family.
819 void SetPlaceholderFontFamily(const std::string& placeholderTextFontFamily);
822 * @brief Retrieves the placeholder text font family.
824 * @return The placeholder text font family
826 const std::string& GetPlaceholderFontFamily() const;
829 * @brief Sets the default font weight.
831 * @param[in] weight The font weight.
833 void SetDefaultFontWeight(FontWeight weight);
836 * @brief Whether the font's weight has been defined.
838 bool IsDefaultFontWeightDefined() const;
841 * @brief Retrieves the default font weight.
843 * @return The default font weight.
845 FontWeight GetDefaultFontWeight() const;
848 * @brief Sets the placeholder text font weight.
850 * @param[in] weight The font weight
852 void SetPlaceholderTextFontWeight(FontWeight weight);
855 * @brief Whether the font's weight has been defined.
857 * @return True if the placeholder text font weight is defined
859 bool IsPlaceholderTextFontWeightDefined() const;
862 * @brief Retrieves the placeholder text font weight.
864 * @return The placeholder text font weight
866 FontWeight GetPlaceholderTextFontWeight() const;
869 * @brief Sets the default font width.
871 * @param[in] width The font width.
873 void SetDefaultFontWidth(FontWidth width);
876 * @brief Whether the font's width has been defined.
878 bool IsDefaultFontWidthDefined() const;
881 * @brief Retrieves the default font width.
883 * @return The default font width.
885 FontWidth GetDefaultFontWidth() const;
888 * @brief Sets the placeholder text font width.
890 * @param[in] width The font width
892 void SetPlaceholderTextFontWidth(FontWidth width);
895 * @brief Whether the font's width has been defined.
897 * @return True if the placeholder text font width is defined
899 bool IsPlaceholderTextFontWidthDefined() const;
902 * @brief Retrieves the placeholder text font width.
904 * @return The placeholder text font width
906 FontWidth GetPlaceholderTextFontWidth() const;
909 * @brief Sets the default font slant.
911 * @param[in] slant The font slant.
913 void SetDefaultFontSlant(FontSlant slant);
916 * @brief Whether the font's slant has been defined.
918 bool IsDefaultFontSlantDefined() const;
921 * @brief Retrieves the default font slant.
923 * @return The default font slant.
925 FontSlant GetDefaultFontSlant() const;
928 * @brief Sets the placeholder text font slant.
930 * @param[in] slant The font slant
932 void SetPlaceholderTextFontSlant(FontSlant slant);
935 * @brief Whether the font's slant has been defined.
937 * @return True if the placeholder text font slant is defined
939 bool IsPlaceholderTextFontSlantDefined() const;
942 * @brief Retrieves the placeholder text font slant.
944 * @return The placeholder text font slant
946 FontSlant GetPlaceholderTextFontSlant() const;
949 * @brief Set the default font size.
951 * @param[in] fontSize The default font size
952 * @param[in] type The font size type is point size or pixel size
954 void SetDefaultFontSize(float fontSize, FontSizeType type);
957 * @brief Retrieve the default point size.
959 * @param[in] type The font size type
960 * @return The default point size.
962 float GetDefaultFontSize(FontSizeType type) const;
965 * @brief Set the font size scale.
967 * @param[in] scale The font size scale
969 void SetFontSizeScale(float scale);
972 * @brief Get the font size scale.
974 * @return The font size scale.
976 float GetFontSizeScale() const;
979 * @brief Set the font size scale enabled flag.
981 * @param[in] enabled whether to enable the font size scale.
983 void SetFontSizeScaleEnabled(bool enabled);
986 * @brief Returns whether the font size scale is enabled or not.
988 * @return @e true if the font size scale is enabled, otherwise returns @e false.
990 bool IsFontSizeScaleEnabled() const;
993 * @brief Sets the Placeholder text font size.
994 * @param[in] fontSize The placeholder text font size
995 * @param[in] type The font size type is point size or pixel size
997 void SetPlaceholderTextFontSize(float fontSize, FontSizeType type);
1000 * @brief Retrieves the Placeholder text font size.
1001 * @param[in] type The font size type
1002 * @return The placeholder font size
1004 float GetPlaceholderTextFontSize(FontSizeType type) const;
1007 * @brief Sets the text's default color.
1009 * @param color The default color.
1011 void SetDefaultColor(const Vector4& color);
1014 * @brief Retrieves the text's default color.
1016 * @return The default color.
1018 const Vector4& GetDefaultColor() const;
1021 * @brief Sets the user interaction enabled.
1023 * @param enabled whether to enable the user interaction.
1025 void SetUserInteractionEnabled(bool enabled);
1028 * @brief Whether the user interaction is enabled.
1030 * @return true if the user interaction is enabled, false otherwise.
1032 bool IsUserInteractionEnabled() const;
1035 * @brief Set the text color
1037 * @param textColor The text color
1039 void SetPlaceholderTextColor(const Vector4& textColor);
1042 * @brief Retrieve the text color
1044 * @return The text color
1046 const Vector4& GetPlaceholderTextColor() const;
1049 * @brief Set the shadow offset.
1051 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
1053 void SetShadowOffset(const Vector2& shadowOffset);
1056 * @brief Retrieve the shadow offset.
1058 * @return The shadow offset.
1060 const Vector2& GetShadowOffset() const;
1063 * @brief Set the shadow color.
1065 * @param[in] shadowColor The shadow color.
1067 void SetShadowColor(const Vector4& shadowColor);
1070 * @brief Retrieve the shadow color.
1072 * @return The shadow color.
1074 const Vector4& GetShadowColor() const;
1077 * @brief Set the shadow blur radius.
1079 * @param[in] shadowBlurRadius The shadow blur radius, 0,0 indicates no blur.
1081 void SetShadowBlurRadius(const float& shadowBlurRadius);
1084 * @brief Retrieve the shadow blur radius.
1086 * @return The shadow blur radius.
1088 const float& GetShadowBlurRadius() const;
1091 * @brief Set the underline color.
1093 * @param[in] color color of underline.
1095 void SetUnderlineColor(const Vector4& color);
1098 * @brief Retrieve the underline color.
1100 * @return The underline color.
1102 const Vector4& GetUnderlineColor() const;
1105 * @brief Set the underline enabled flag.
1107 * @param[in] enabled The underline enabled flag.
1109 void SetUnderlineEnabled(bool enabled);
1112 * @brief Returns whether the text is underlined or not.
1114 * @return The underline state.
1116 bool IsUnderlineEnabled() const;
1119 * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
1121 * @param[in] height The height in pixels of the underline
1123 void SetUnderlineHeight(float height);
1126 * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
1128 * @return The height of the underline, or 0 if height is not overrided.
1130 float GetUnderlineHeight() const;
1133 * @brief Sets the underline type.
1134 * @param[in] type The underline type.
1136 void SetUnderlineType(Text::Underline::Type type);
1139 * @brief Retrieve underline type.
1140 * @return The underline type.
1142 Text::Underline::Type GetUnderlineType() const;
1145 * @brief Set the width of the dashes of the dashed underline.
1147 * @param[in] width The width in pixels of the dashes of the dashed underline.
1149 void SetDashedUnderlineWidth(float width);
1152 * @brief Retrieves the width of the dashes of the dashed underline.
1154 * @return The width of the dashes of the dashed underline.
1156 float GetDashedUnderlineWidth() const;
1159 * @brief Set the gap between the dashes of the dashed underline.
1161 * @param[in] gap The gap between the dashes of the dashed underline.
1163 void SetDashedUnderlineGap(float gap);
1166 * @brief Retrieves the gap between the dashes of the dashed underline.
1168 * @return The The gap between the dashes of the dashed underline.
1170 float GetDashedUnderlineGap() const;
1173 * @brief Set the outline color.
1175 * @param[in] color color of outline.
1177 void SetOutlineColor(const Vector4& color);
1180 * @brief Retrieve the outline color.
1182 * @return The outline color.
1184 const Vector4& GetOutlineColor() const;
1187 * @brief Set the outline width
1189 * @param[in] width The width in pixels of the outline, 0 indicates no outline
1191 void SetOutlineWidth(uint16_t width);
1194 * @brief Retrieves the width of an outline
1196 * @return The width of the outline.
1198 uint16_t GetOutlineWidth() const;
1201 * @brief Set the background color.
1203 * @param[in] color color of background.
1205 void SetBackgroundColor(const Vector4& color);
1208 * @brief Retrieve the background color.
1210 * @return The background color.
1212 const Vector4& GetBackgroundColor() const;
1215 * @brief Set the background enabled flag.
1217 * @param[in] enabled The background enabled flag.
1219 void SetBackgroundEnabled(bool enabled);
1222 * @brief Returns whether to enable text background or not.
1224 * @return Whether text background is enabled.
1226 bool IsBackgroundEnabled() const;
1229 * @brief Sets the emboss's properties string.
1231 * @note The string is stored to be recovered.
1233 * @param[in] embossProperties The emboss's properties string.
1235 void SetDefaultEmbossProperties(const std::string& embossProperties);
1238 * @brief Retrieves the emboss's properties string.
1240 * @return The emboss's properties string.
1242 const std::string& GetDefaultEmbossProperties() const;
1245 * @brief Sets the outline's properties string.
1247 * @note The string is stored to be recovered.
1249 * @param[in] outlineProperties The outline's properties string.
1251 void SetDefaultOutlineProperties(const std::string& outlineProperties);
1254 * @brief Retrieves the outline's properties string.
1256 * @return The outline's properties string.
1258 const std::string& GetDefaultOutlineProperties() const;
1261 * @brief Sets the default line spacing.
1263 * @param[in] lineSpacing The line spacing.
1265 * @return True if lineSpacing has been updated, false otherwise
1267 bool SetDefaultLineSpacing(float lineSpacing);
1270 * @brief Retrieves the default line spacing.
1272 * @return The line spacing.
1274 float GetDefaultLineSpacing() const;
1277 * @brief Sets the default line size.
1279 * @param[in] lineSize The line size.
1281 * @return True if lineSize has been updated, false otherwise
1283 bool SetDefaultLineSize(float lineSize);
1286 * @brief Retrieves the default line size.
1288 * @return The line size.
1290 float GetDefaultLineSize() const;
1293 * @brief Sets the relative line size to the original line size.
1295 * @param[in] relativeLineSize The relativeline size.
1297 * @return True if relativeLineSize has been updated, false otherwise
1299 bool SetRelativeLineSize(float lineSize);
1302 * @brief Retrieves the relative line size.
1304 * @return The relative line size.
1306 float GetRelativeLineSize() const;
1309 * @brief Sets the input text's color.
1311 * @param[in] color The input text's color.
1313 void SetInputColor(const Vector4& color);
1316 * @brief Retrieves the input text's color.
1318 * @return The input text's color.
1320 const Vector4& GetInputColor() const;
1323 * @brief Sets the input text's font family name.
1325 * @param[in] fontFamily The text's font family name.
1327 void SetInputFontFamily(const std::string& fontFamily);
1330 * @brief Retrieves the input text's font family name.
1332 * @return The input text's font family name.
1334 const std::string& GetInputFontFamily() const;
1337 * @brief Sets the input font's weight.
1339 * @param[in] weight The input font's weight.
1341 void SetInputFontWeight(FontWeight weight);
1344 * @return Whether the font's weight has been defined.
1346 bool IsInputFontWeightDefined() const;
1349 * @brief Retrieves the input font's weight.
1351 * @return The input font's weight.
1353 FontWeight GetInputFontWeight() const;
1356 * @brief Sets the input font's width.
1358 * @param[in] width The input font's width.
1360 void SetInputFontWidth(FontWidth width);
1363 * @return Whether the font's width has been defined.
1365 bool IsInputFontWidthDefined() const;
1368 * @brief Retrieves the input font's width.
1370 * @return The input font's width.
1372 FontWidth GetInputFontWidth() const;
1375 * @brief Sets the input font's slant.
1377 * @param[in] slant The input font's slant.
1379 void SetInputFontSlant(FontSlant slant);
1382 * @return Whether the font's slant has been defined.
1384 bool IsInputFontSlantDefined() const;
1387 * @brief Retrieves the input font's slant.
1389 * @return The input font's slant.
1391 FontSlant GetInputFontSlant() const;
1394 * @brief Sets the input font's point size.
1396 * @param[in] size The input font's point size.
1398 void SetInputFontPointSize(float size);
1401 * @brief Retrieves the input font's point size.
1403 * @return The input font's point size.
1405 float GetInputFontPointSize() const;
1408 * @brief Sets the input line spacing.
1410 * @param[in] lineSpacing The line spacing.
1412 void SetInputLineSpacing(float lineSpacing);
1415 * @brief Retrieves the input line spacing.
1417 * @return The line spacing.
1419 float GetInputLineSpacing() const;
1422 * @brief Sets the input shadow's properties string.
1424 * @note The string is stored to be recovered.
1426 * @param[in] shadowProperties The shadow's properties string.
1428 void SetInputShadowProperties(const std::string& shadowProperties);
1431 * @brief Retrieves the input shadow's properties string.
1433 * @return The shadow's properties string.
1435 const std::string& GetInputShadowProperties() const;
1438 * @brief Sets the input underline's properties string.
1440 * @note The string is stored to be recovered.
1442 * @param[in] underlineProperties The underline's properties string.
1444 void SetInputUnderlineProperties(const std::string& underlineProperties);
1447 * @brief Retrieves the input underline's properties string.
1449 * @return The underline's properties string.
1451 const std::string& GetInputUnderlineProperties() const;
1454 * @brief Sets the input emboss's properties string.
1456 * @note The string is stored to be recovered.
1458 * @param[in] embossProperties The emboss's properties string.
1460 void SetInputEmbossProperties(const std::string& embossProperties);
1463 * @brief Retrieves the input emboss's properties string.
1465 * @return The emboss's properties string.
1467 const std::string& GetInputEmbossProperties() const;
1470 * @brief Sets input the outline's properties string.
1472 * @note The string is stored to be recovered.
1474 * @param[in] outlineProperties The outline's properties string.
1476 void SetInputOutlineProperties(const std::string& outlineProperties);
1479 * @brief Retrieves the input outline's properties string.
1481 * @return The outline's properties string.
1483 const std::string& GetInputOutlineProperties() const;
1486 * @brief Sets the input strikethrough's properties string.
1488 * @note The string is stored to be recovered.
1490 * @param[in] strikethroughProperties The strikethrough's properties string.
1492 void SetInputStrikethroughProperties(const std::string& strikethroughProperties);
1495 * @brief Retrieves the input strikethrough's properties string.
1497 * @return The strikethrough's properties string.
1499 const std::string& GetInputStrikethroughProperties() const;
1502 * @brief Set the control's interface.
1504 * @param[in] controlInterface The control's interface.
1506 void SetControlInterface(ControlInterface* controlInterface);
1509 * @brief Set the anchor control's interface.
1511 * @param[in] anchorControlInterface The control's interface.
1513 void SetAnchorControlInterface(AnchorControlInterface* anchorControlInterface);
1516 * @brief Sets the character spacing.
1518 * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
1520 * @param[in] characterSpacing The character spacing.
1522 void SetCharacterSpacing(float characterSpacing);
1525 * @brief Retrieves the character spacing.
1527 * @note A positive value will make the characters far apart (expanded) and a negative value will bring them closer (condensed).
1529 * @return The character spacing.
1531 const float GetCharacterSpacing() const;
1533 public: // Queries & retrieves.
1535 * @brief Return the layout engine.
1537 * @return A reference to the layout engine.
1539 Layout::Engine& GetLayoutEngine();
1542 * @brief Return a view of the text.
1544 * @return A reference to the view.
1549 * @copydoc Control::GetNaturalSize()
1551 Vector3 GetNaturalSize();
1554 * @copydoc Control::GetHeightForWidth()
1556 float GetHeightForWidth(float width);
1559 * @brief Calculates the point size for text for given layout()
1561 void FitPointSizeforLayout(Size layoutSize);
1564 * @brief Checks if the point size fits within the layout size.
1566 * @return Whether the point size fits within the layout size.
1568 bool CheckForTextFit(float pointSize, Size& layoutSize);
1571 * @brief Retrieves the text's number of lines for a given width.
1572 * @param[in] width The width of the text's area.
1573 * @ return The number of lines.
1575 int GetLineCount(float width);
1578 * @brief Retrieves the text's model.
1580 * @return A pointer to the text's model.
1582 const ModelInterface* const GetTextModel() const;
1585 * @brief Used to get scrolled distance by user input
1587 * @return Distance from last scroll offset to new scroll offset
1589 float GetScrollAmountByUserInput();
1592 * @brief Get latest scroll amount, control size and layout size
1594 * This method is used to get information of control's scroll
1595 * @param[out] scrollPosition The current scrolled position
1596 * @param[out] controlHeight The size of a UI control
1597 * @param[out] layoutHeight The size of a bounding box to layout text within.
1599 * @return Whether the text scroll position is changed or not after last update.
1601 bool GetTextScrollInfo(float& scrollPosition, float& controlHeight, float& layoutHeight);
1604 * @brief Used to set the hidden input option
1606 void SetHiddenInputOption(const Property::Map& options);
1609 * @brief Used to get the hidden input option
1611 void GetHiddenInputOption(Property::Map& options);
1614 * @brief Used to set the input filter option
1616 void SetInputFilterOption(const Property::Map& options);
1619 * @brief Used to get the input filter option
1621 void GetInputFilterOption(Property::Map& options);
1624 * @brief Sets the Placeholder Properties.
1626 * @param[in] map The placeholder property map
1628 void SetPlaceholderProperty(const Property::Map& map);
1631 * @brief Retrieves the Placeholder Property map.
1633 * @param[out] map The property map
1635 void GetPlaceholderProperty(Property::Map& map);
1638 * @brief Checks text direction.
1639 * @return The text direction.
1641 Toolkit::DevelText::TextDirection::Type GetTextDirection();
1644 * @brief Retrieves vertical line alignment
1645 * @return The vertical line alignment
1647 Toolkit::DevelText::VerticalLineAlignment::Type GetVerticalLineAlignment() const;
1650 * @brief Sets vertical line alignment
1651 * @param[in] alignment The vertical line alignment for the text
1653 void SetVerticalLineAlignment(Toolkit::DevelText::VerticalLineAlignment::Type alignment);
1656 * @brief Retrieves ellipsis position
1657 * @return The ellipsis position
1659 Toolkit::DevelText::EllipsisPosition::Type GetEllipsisPosition() const;
1662 * @brief Sets ellipsis position
1663 * @param[in] ellipsisPosition The ellipsis position for the text
1665 void SetEllipsisPosition(Toolkit::DevelText::EllipsisPosition::Type ellipsisPosition);
1668 * @brief Retrieves ignoreSpaceAfterText value from model
1669 * @return The value of ignoreSpaceAfterText
1671 bool IsIgnoreSpacesAfterText() const;
1674 * @brief Sets ignoreSpaceAfterText value to model
1675 * @param[in] ignore The value of ignoreSpacesAfterText for the text
1677 void SetIgnoreSpacesAfterText(bool ignore);
1680 * @brief Sets SetMatchLayoutDirection value to model
1681 * @param[in] match The value of matchLayoutDirection for the text
1683 void SetMatchLayoutDirection(DevelText::MatchLayoutDirection type);
1686 * @brief Retrieves matchLayoutDirection value from model
1687 * @return The value of matchLayoutDirection
1689 DevelText::MatchLayoutDirection GetMatchLayoutDirection() const;
1692 * @brief Sets layoutDirection type value.
1693 * @param[in] layoutDirection The value of the layout direction type.
1695 void SetLayoutDirection(Dali::LayoutDirection::Type layoutDirection);
1698 * @brief Gets layoutDirection type value.
1699 * @param[in] actor The actor which will get the layout direction type.
1700 * @return The value of the layout direction type.
1702 Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
1705 * @brief Get the rendered size of a specific text range.
1706 * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
1707 * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
1709 * @param[in] startIndex start index of the text requested to calculate size for.
1710 * @param[in] endIndex end index(included) of the text requested to calculate size for.
1711 * @return list of sizes of the reuested text.
1713 Vector<Vector2> GetTextSize(CharacterIndex startIndex, CharacterIndex endIndex);
1716 * @brief Get the top/left rendered position of a specific text range.
1717 * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
1718 * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
1720 * @param[in] startIndex start index of the text requested to get position to.
1721 * @param[in] endIndex end index(included) of the text requested to get position to.
1722 * @return list of positions of the requested text.
1724 Vector<Vector2> GetTextPosition(CharacterIndex startIndex, CharacterIndex endIndex);
1727 * @brief Gets the bounding box of a specific text range.
1729 * @param[in] startIndex start index of the text requested to get bounding box to.
1730 * @param[in] endIndex end index(included) of the text requested to get bounding box to.
1731 * @return bounding box of the requested text.
1733 Rect<> GetTextBoundingRectangle(CharacterIndex startIndex, CharacterIndex endIndex);
1736 * @brief Sets the layout direction changed.
1738 void ChangedLayoutDirection();
1741 * @brief Retrieves if showing real text or not.
1742 * @return The value of showing real text.
1744 bool IsShowingRealText() const;
1746 public: // Relayout.
1748 * @brief Triggers a relayout which updates View (if necessary).
1750 * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
1751 * @param[in] size A the size of a bounding box to layout text within.
1752 * @param[in] layoutDirection The direction of the system language.
1754 * @return Whether the text model or decorations were updated.
1756 UpdateTextType Relayout(const Size& size, Dali::LayoutDirection::Type layoutDirection = Dali::LayoutDirection::LEFT_TO_RIGHT);
1759 * @brief Request a relayout using the ControlInterface.
1761 void RequestRelayout();
1763 public: // Input style change signals.
1765 * @return Whether the queue of input style changed signals is empty.
1767 bool IsInputStyleChangedSignalsQueueEmpty();
1770 * @brief Process all pending input style changed signals.
1772 * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
1773 * text controls. Text controls may send signals to state the input style has changed.
1775 void ProcessInputStyleChangedSignals();
1777 public: // Text-input Event Queuing.
1779 * @brief Called by editable UI controls when keyboard focus is gained.
1781 void KeyboardFocusGainEvent();
1784 * @brief Called by editable UI controls when focus is lost.
1786 void KeyboardFocusLostEvent();
1789 * @brief Called by editable UI controls when key events are received.
1791 * @param[in] event The key event.
1792 * @param[in] type Used to distinguish between regular key events and InputMethodContext events.
1794 bool KeyEvent(const Dali::KeyEvent& event);
1797 * @brief Called by anchor when a tap gesture occurs.
1798 * @param[in] x The x position relative to the top-left of the parent control.
1799 * @param[in] y The y position relative to the top-left of the parent control.
1801 void AnchorEvent(float x, float y);
1804 * @brief Called by editable UI controls when a tap gesture occurs.
1805 * @param[in] tapCount The number of taps.
1806 * @param[in] x The x position relative to the top-left of the parent control.
1807 * @param[in] y The y position relative to the top-left of the parent control.
1809 void TapEvent(unsigned int tapCount, float x, float y);
1812 * @brief Called by editable UI controls when a pan gesture occurs.
1814 * @param[in] state The state of the gesture.
1815 * @param[in] displacement This distance panned since the last pan gesture.
1817 void PanEvent(GestureState state, const Vector2& displacement);
1820 * @brief Called by editable UI controls when a long press gesture occurs.
1822 * @param[in] state The state of the gesture.
1823 * @param[in] x The x position relative to the top-left of the parent control.
1824 * @param[in] y The y position relative to the top-left of the parent control.
1826 void LongPressEvent(GestureState state, float x, float y);
1829 * @brief Used to get the Primary cursor position.
1831 * @return Primary cursor position.
1833 CharacterIndex GetPrimaryCursorPosition() const;
1836 * @brief Used to set the Primary cursor position.
1838 * @param[in] index for the Primary cursor position.
1839 * @param[in] focused true if UI control has gained focus to receive key event, false otherwise.
1840 * @return[in] true if cursor position changed, false otherwise.
1842 bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
1845 * @brief Creates a selection event.
1847 * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
1849 * @param[in] x The x position relative to the top-left of the parent control.
1850 * @param[in] y The y position relative to the top-left of the parent control.
1851 * @param[in] selection type like the whole text is selected or unselected.
1853 void SelectEvent(float x, float y, SelectionType selection);
1856 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
1858 void SetTextSelectionRange(const uint32_t* start, const uint32_t* end);
1861 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
1863 Uint32Pair GetTextSelectionRange() const;
1866 * @copydoc Text::SelectableControlInterface::SelectWholeText()
1868 void SelectWholeText();
1871 * @copydoc Text::EditableControlInterface::CopyText()
1876 * @copydoc Text::EditableControlInterface::CutText()
1881 * @copydoc Text::EditableControlInterface::PasteText()
1886 * @copydoc Text::SelectableControlInterface::SelectNone()
1891 * @copydoc Text::SelectableControlInterface::SelectText()
1893 void SelectText(const uint32_t start, const uint32_t end);
1896 * @copydoc Text::SelectableControlInterface::GetSelectedText()
1898 string GetSelectedText() const;
1901 * @copydoc Text::EditableControlInterface::IsEditable()
1903 virtual bool IsEditable() const;
1906 * @copydoc Text::EditableControlInterface::SetEditable()
1908 virtual void SetEditable(bool editable);
1911 * @copydoc Dali::Toolkit::Internal::TextEditor::ScrollBy()
1913 virtual void ScrollBy(Vector2 scroll);
1916 * @copydoc Dali::Toolkit::Internal::TextEditor::GetHorizontalScrollPosition()
1918 float GetHorizontalScrollPosition();
1921 * @copydoc Dali::Toolkit::Internal::TextEditor::GetVerticalScrollPosition()
1923 float GetVerticalScrollPosition();
1926 * @brief Event received from input method context
1928 * @param[in] inputMethodContext The input method context.
1929 * @param[in] inputMethodContextEvent The event received.
1930 * @return A data struture indicating if update is needed, cursor position and current text.
1932 InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
1935 * @brief Event from Clipboard notifying an Item has been selected for pasting
1937 void PasteClipboardItemEvent();
1940 * @brief Return true when text control should clear key input focus when escape key is pressed.
1942 * @return Whether text control should clear key input focus or not when escape key is pressed.
1944 bool ShouldClearFocusOnEscape() const;
1947 * @brief Create an actor that renders the text background color
1949 * @return the created actor or an empty handle if no background color needs to be rendered.
1951 Actor CreateBackgroundActor();
1954 * @brief Used to reset the cursor position after setting a new text.
1956 * @param[in] cursorIndex Where to place the cursor.
1958 void ResetCursorPosition(CharacterIndex cursorIndex);
1961 * @brief The method acquires current position of cursor
1962 * @return unsigned value with cursor position
1964 CharacterIndex GetCursorPosition();
1967 * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
1969 * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
1971 void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
1974 * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
1976 * @param[in] characterOffset A position in text coords.
1978 * @return the index in anchor vector (-1 if an anchor not found)
1980 int GetAnchorIndex(size_t characterOffset);
1982 protected: // Inherit from Text::Decorator::ControllerInterface.
1984 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
1986 void GetTargetSize(Vector2& targetSize) override;
1989 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
1991 void AddDecoration(Actor& actor, DecorationType type, bool needsClipping) override;
1994 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
1996 void DecorationEvent(HandleType handle, HandleState state, float x, float y) override;
1998 protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
2000 * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
2002 void TextPopupButtonTouched(Dali::Toolkit::TextSelectionPopup::Buttons button) override;
2004 protected: // Inherit from HiddenText.
2006 * @brief Invoked from HiddenText when showing time of the last character was expired
2008 void DisplayTimeExpired() override;
2010 private: // Private contructors & copy operator.
2012 * @brief Private constructor.
2015 : Controller(nullptr, nullptr, nullptr, nullptr)
2020 * @brief Private constructor.
2022 Controller(ControlInterface* controlInterface)
2023 : Controller(controlInterface, nullptr, nullptr, nullptr)
2028 * @brief Private constructor.
2030 Controller(ControlInterface* controlInterface,
2031 EditableControlInterface* editableControlInterface,
2032 SelectableControlInterface* selectableControlInterface,
2033 AnchorControlInterface* anchorControlInterface);
2035 Controller(const Controller& handle) = delete;
2036 Controller& operator=(const Controller& handle) = delete;
2038 protected: // Destructor.
2040 * @brief A reference counted object may only be deleted by calling Unreference().
2042 virtual ~Controller();
2045 struct Impl; ///< Made public for testing purposes
2048 struct EventHandler;
2049 struct InputFontHandler;
2050 struct InputProperties;
2051 struct PlaceholderHandler;
2058 } // namespace Dali::Toolkit::Text
2060 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H