1 #ifndef DALI_TOOLKIT_TEXT_CONTROLLER_H
2 #define DALI_TOOLKIT_TEXT_CONTROLLER_H
5 * Copyright (c) 2017 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/imf-manager.h>
23 #include <dali/public-api/events/gesture.h>
26 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup-callback-interface.h>
27 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
28 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
29 #include <dali-toolkit/internal/text/hidden-text.h>
30 #include <dali-toolkit/internal/text/text-model-interface.h>
42 class ControlInterface;
43 class EditableControlInterface;
45 class RenderingController;
47 typedef IntrusivePtr<Controller> ControllerPtr;
50 * @brief A Text Controller is used by UI Controls which display text.
52 * It manipulates the Logical & Visual text models on behalf of the UI Controls.
53 * It provides a view of the text that can be used by rendering back-ends.
55 * For selectable/editable UI controls, the controller handles input events from the UI control
56 * and decorations (grab handles etc) via the Decorator::ControllerInterface interface.
58 * The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface.
60 class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface, public HiddenText::Observer
62 public: // Enumerated types.
65 * @brief Text related operations to be done in the relayout process.
69 NO_OPERATION = 0x0000,
70 CONVERT_TO_UTF32 = 0x0001,
72 VALIDATE_FONTS = 0x0004,
73 GET_LINE_BREAKS = 0x0008,
74 GET_WORD_BREAKS = 0x0010,
77 GET_GLYPH_METRICS = 0x0080,
79 UPDATE_LAYOUT_SIZE = 0x0200,
83 UPDATE_DIRECTION = 0x2000,
84 ALL_OPERATIONS = 0xFFFF
88 * @brief Used to distinguish between regular key events and IMF events
97 * @brief Used to specify whether to update the input style.
99 enum UpdateInputStyleType
102 DONT_UPDATE_INPUT_STYLE
106 * @brief Used to specify what has been updated after the Relayout() method has been called.
110 NONE_UPDATED = 0x0, ///< Nothing has been updated.
111 MODEL_UPDATED = 0x1, ///< The text's model has been updated.
112 DECORATOR_UPDATED = 0x2 ///< The decoration has been updated.
116 * @brief Different placeholder-text can be shown when the control is active/inactive.
120 PLACEHOLDER_TYPE_ACTIVE,
121 PLACEHOLDER_TYPE_INACTIVE,
128 NO_ACTION, ///< Does no action if there is a tap on top of an area with no text.
129 HIGHLIGHT, ///< Highlights the nearest text (at the beginning or end of the text) and shows the text's selection popup.
130 SHOW_SELECTION_POPUP ///< Shows the text's selection popup.
134 public: // Constructor.
137 * @brief Create a new instance of a Controller.
139 * @return A pointer to a new Controller.
141 static ControllerPtr New();
144 * @brief Create a new instance of a Controller.
146 * @param[in] controlInterface The control's interface.
148 * @return A pointer to a new Controller.
150 static ControllerPtr New( ControlInterface* controlInterface );
153 * @brief Create a new instance of a Controller.
155 * @param[in] controlInterface The control's interface.
156 * @param[in] editableControlInterface The editable control's interface.
158 * @return A pointer to a new Controller.
160 static ControllerPtr New( ControlInterface* controlInterface,
161 EditableControlInterface* editableControlInterface );
163 public: // Configure the text controller.
166 * @brief Called to enable text input.
168 * @note Selectable or editable controls should call this once after Controller::New().
169 * @param[in] decorator Used to create cursor, selection handle decorations etc.
171 void EnableTextInput( DecoratorPtr decorator );
174 * @brief Used to switch between bitmap & vector based glyphs
176 * @param[in] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different.
178 void SetGlyphType( TextAbstraction::GlyphType glyphType );
181 * @brief Enables/disables the mark-up processor.
183 * By default is disabled.
185 * @param[in] enable Whether to enable the mark-up processor.
187 void SetMarkupProcessorEnabled( bool enable );
190 * @brief Retrieves whether the mark-up processor is enabled.
192 * By default is disabled.
194 * @return @e true if the mark-up processor is enabled, otherwise returns @e false.
196 bool IsMarkupProcessorEnabled() const;
199 * @brief Enables/disables the auto text scrolling
201 * By default is disabled.
203 * @param[in] enable Whether to enable the auto scrolling
205 void SetAutoScrollEnabled( bool enable );
208 * @brief Retrieves whether auto text scrolling is enabled.
210 * By default is disabled.
212 * @return @e true if auto scrolling is enabled, otherwise returns @e false.
214 bool IsAutoScrollEnabled() const;
217 * @brief Get direction of the text from the first line of text,
218 * @return bool rtl (right to left) is true
220 CharacterDirection GetAutoScrollDirection() const;
223 * @brief Get the alignment offset of the first line of text.
225 * @return The alignment offset.
227 float GetAutoScrollLineAlignment() const;
230 * @brief Enables the horizontal scrolling.
232 * @param[in] enable Whether to enable the horizontal scrolling.
234 void SetHorizontalScrollEnabled( bool enable );
237 * @brief Retrieves whether the horizontal scrolling is enabled.
239 * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false.
241 bool IsHorizontalScrollEnabled() const;
244 * @brief Enables the vertical scrolling.
246 * @param[in] enable Whether to enable the vertical scrolling.
248 void SetVerticalScrollEnabled( bool enable );
251 * @brief Retrieves whether the verticall scrolling is enabled.
253 * @return @e true if the vertical scrolling is enabled, otherwise it returns @e false.
255 bool IsVerticalScrollEnabled() const;
258 * @brief Enables the smooth handle panning.
260 * @param[in] enable Whether to enable the smooth handle panning.
262 void SetSmoothHandlePanEnabled( bool enable );
265 * @brief Retrieves whether the smooth handle panning is enabled.
267 * @return @e true if the smooth handle panning is enabled.
269 bool IsSmoothHandlePanEnabled() const;
272 * @brief Sets the maximum number of characters that can be inserted into the TextModel
274 * @param[in] maxCharacters maximum number of characters to be accepted
276 void SetMaximumNumberOfCharacters( Length maxCharacters );
279 * @brief Sets the maximum number of characters that can be inserted into the TextModel
281 * @param[in] maxCharacters maximum number of characters to be accepted
283 int GetMaximumNumberOfCharacters();
286 * @brief Called to enable/disable cursor blink.
288 * @note Only editable controls should calls this.
289 * @param[in] enabled Whether the cursor should blink or not.
291 void SetEnableCursorBlink( bool enable );
294 * @brief Query whether cursor blink is enabled.
296 * @return Whether the cursor should blink or not.
298 bool GetEnableCursorBlink() const;
301 * @brief Whether to enable the multi-line layout.
303 * @param[in] enable \e true enables the multi-line (by default)
305 void SetMultiLineEnabled( bool enable );
308 * @return Whether the multi-line layout is enabled.
310 bool IsMultiLineEnabled() const;
313 * @brief Sets the text's horizontal alignment.
315 * @param[in] alignment The horizontal alignment.
317 void SetHorizontalAlignment( Layout::HorizontalAlignment alignment );
320 * @copydoc ModelInterface::GetHorizontalAlignment()
322 Layout::HorizontalAlignment GetHorizontalAlignment() const;
325 * @brief Sets the text's vertical alignment.
327 * @param[in] alignment The vertical alignment.
329 void SetVerticalAlignment( Layout::VerticalAlignment alignment );
332 * @copydoc ModelInterface::GetVerticalAlignment()
334 Layout::VerticalAlignment GetVerticalAlignment() const;
337 * @brief Enable or disable the text elide.
339 * @param[in] enabled Whether to enable the text elide.
341 void SetTextElideEnabled( bool enabled );
344 * @copydoc ModelInterface::IsTextElideEnabled()
346 bool IsTextElideEnabled() const;
349 * @brief Sets input type to password
351 * @note The string is displayed hidden character
353 * @param[in] passwordInput True if password input is enabled.
355 void SetInputModePassword( bool passwordInput );
358 * @brief Returns whether the input mode type is set as password.
360 * @return True if input mode type is password
362 bool IsInputModePassword();
365 * @brief Sets the action when there is a double tap event on top of a text area with no text.
367 * @param[in] action The action to do.
369 void SetNoTextDoubleTapAction( NoTextTap::Action action );
372 * @brief Retrieves the action when there is a double tap event on top of a text area with no text.
374 * @return The action to do.
376 NoTextTap::Action GetNoTextDoubleTapAction() const;
379 * @briefSets the action when there is a long press event on top of a text area with no text.
381 * @param[in] action The action to do.
383 void SetNoTextLongPressAction( NoTextTap::Action action );
386 * @brief Retrieves the action when there is a long press event on top of a text area with no text.
388 * @return The action to do.
390 NoTextTap::Action GetNoTextLongPressAction() const;
395 * @brief Replaces any text previously set.
397 * @note This will be converted into UTF-32 when stored in the text model.
398 * @param[in] text A string of UTF-8 characters.
400 void SetText( const std::string& text );
403 * @brief Retrieve any text previously set.
405 * @param[out] text A string of UTF-8 characters.
407 void GetText( std::string& text ) const;
410 * @brief Replaces any placeholder text previously set.
412 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
413 * @param[in] text A string of UTF-8 characters.
415 void SetPlaceholderText( PlaceholderType type, const std::string& text );
418 * @brief Retrieve any placeholder text previously set.
420 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
421 * @param[out] A string of UTF-8 characters.
423 void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
426 * @ brief Update the text after a font change
427 * @param[in] newDefaultFont The new font to change to
429 void UpdateAfterFontChange( const std::string& newDefaultFont );
431 public: // Default style & Input style
434 * @brief Set the default font family.
436 * @param[in] defaultFontFamily The default font family.
438 void SetDefaultFontFamily( const std::string& defaultFontFamily );
441 * @brief Retrieve the default font family.
443 * @return The default font family.
445 const std::string& GetDefaultFontFamily() const;
448 * @brief Sets the default font weight.
450 * @param[in] weight The font weight.
452 void SetDefaultFontWeight( FontWeight weight );
455 * @brief Whether the font's weight has been defined.
457 bool IsDefaultFontWeightDefined() const;
460 * @brief Retrieves the default font weight.
462 * @return The default font weight.
464 FontWeight GetDefaultFontWeight() const;
467 * @brief Sets the default font width.
469 * @param[in] width The font width.
471 void SetDefaultFontWidth( FontWidth width );
474 * @brief Whether the font's width has been defined.
476 bool IsDefaultFontWidthDefined() const;
479 * @brief Retrieves the default font width.
481 * @return The default font width.
483 FontWidth GetDefaultFontWidth() const;
486 * @brief Sets the default font slant.
488 * @param[in] slant The font slant.
490 void SetDefaultFontSlant( FontSlant slant );
493 * @brief Whether the font's slant has been defined.
495 bool IsDefaultFontSlantDefined() const;
498 * @brief Retrieves the default font slant.
500 * @return The default font slant.
502 FontSlant GetDefaultFontSlant() const;
505 * @brief Set the default point size.
507 * @param[in] pointSize The default point size.
509 void SetDefaultPointSize( float pointSize );
512 * @brief Retrieve the default point size.
514 * @return The default point size.
516 float GetDefaultPointSize() const;
519 * @brief Sets the text's default color.
521 * @param color The default color.
523 void SetDefaultColor( const Vector4& color );
526 * @brief Retrieves the text's default color.
528 * @return The default color.
530 const Vector4& GetDefaultColor() const;
533 * @brief Set the text color
535 * @param textColor The text color
537 void SetPlaceholderTextColor( const Vector4& textColor );
540 * @brief Retrieve the text color
542 * @return The text color
544 const Vector4& GetPlaceholderTextColor() const;
547 * @brief Set the shadow offset.
549 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
551 void SetShadowOffset( const Vector2& shadowOffset );
554 * @brief Retrieve the shadow offset.
556 * @return The shadow offset.
558 const Vector2& GetShadowOffset() const;
561 * @brief Set the shadow color.
563 * @param[in] shadowColor The shadow color.
565 void SetShadowColor( const Vector4& shadowColor );
568 * @brief Retrieve the shadow color.
570 * @return The shadow color.
572 const Vector4& GetShadowColor() const;
575 * @brief Set the underline color.
577 * @param[in] color color of underline.
579 void SetUnderlineColor( const Vector4& color );
582 * @brief Retrieve the underline color.
584 * @return The underline color.
586 const Vector4& GetUnderlineColor() const;
589 * @brief Set the underline enabled flag.
591 * @param[in] enabled The underline enabled flag.
593 void SetUnderlineEnabled( bool enabled );
596 * @brief Returns whether the text is underlined or not.
598 * @return The underline state.
600 bool IsUnderlineEnabled() const;
603 * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
605 * @param[in] height The height in pixels of the underline
607 void SetUnderlineHeight( float height );
610 * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
612 * @return The height of the underline, or 0 if height is not overrided.
614 float GetUnderlineHeight() const;
617 * @brief Sets the emboss's properties string.
619 * @note The string is stored to be recovered.
621 * @param[in] embossProperties The emboss's properties string.
623 void SetDefaultEmbossProperties( const std::string& embossProperties );
626 * @brief Retrieves the emboss's properties string.
628 * @return The emboss's properties string.
630 const std::string& GetDefaultEmbossProperties() const;
633 * @brief Sets the outline's properties string.
635 * @note The string is stored to be recovered.
637 * @param[in] outlineProperties The outline's properties string.
639 void SetDefaultOutlineProperties( const std::string& outlineProperties );
642 * @brief Retrieves the outline's properties string.
644 * @return The outline's properties string.
646 const std::string& GetDefaultOutlineProperties() const;
649 * @brief Sets the default line spacing.
651 * @param[in] lineSpacing The line spacing.
653 void SetDefaultLineSpacing( float lineSpacing );
656 * @brief Retrieves the default line spacing.
658 * @return The line spacing.
660 float GetDefaultLineSpacing() const;
663 * @brief Sets the input text's color.
665 * @param[in] color The input text's color.
667 void SetInputColor( const Vector4& color );
670 * @brief Retrieves the input text's color.
672 * @return The input text's color.
674 const Vector4& GetInputColor() const;
677 * @brief Sets the input text's font family name.
679 * @param[in] fontFamily The text's font family name.
681 void SetInputFontFamily( const std::string& fontFamily );
684 * @brief Retrieves the input text's font family name.
686 * @return The input text's font family name.
688 const std::string& GetInputFontFamily() const;
691 * @brief Sets the input font's weight.
693 * @param[in] weight The input font's weight.
695 void SetInputFontWeight( FontWeight weight );
698 * @return Whether the font's weight has been defined.
700 bool IsInputFontWeightDefined() const;
703 * @brief Retrieves the input font's weight.
705 * @return The input font's weight.
707 FontWeight GetInputFontWeight() const;
710 * @brief Sets the input font's width.
712 * @param[in] width The input font's width.
714 void SetInputFontWidth( FontWidth width );
717 * @return Whether the font's width has been defined.
719 bool IsInputFontWidthDefined() const;
722 * @brief Retrieves the input font's width.
724 * @return The input font's width.
726 FontWidth GetInputFontWidth() const;
729 * @brief Sets the input font's slant.
731 * @param[in] slant The input font's slant.
733 void SetInputFontSlant( FontSlant slant );
736 * @return Whether the font's slant has been defined.
738 bool IsInputFontSlantDefined() const;
741 * @brief Retrieves the input font's slant.
743 * @return The input font's slant.
745 FontSlant GetInputFontSlant() const;
748 * @brief Sets the input font's point size.
750 * @param[in] size The input font's point size.
752 void SetInputFontPointSize( float size );
755 * @brief Retrieves the input font's point size.
757 * @return The input font's point size.
759 float GetInputFontPointSize() const;
762 * @brief Sets the input line spacing.
764 * @param[in] lineSpacing The line spacing.
766 void SetInputLineSpacing( float lineSpacing );
769 * @brief Retrieves the input line spacing.
771 * @return The line spacing.
773 float GetInputLineSpacing() const;
776 * @brief Sets the input shadow's properties string.
778 * @note The string is stored to be recovered.
780 * @param[in] shadowProperties The shadow's properties string.
782 void SetInputShadowProperties( const std::string& shadowProperties );
785 * @brief Retrieves the input shadow's properties string.
787 * @return The shadow's properties string.
789 const std::string& GetInputShadowProperties() const;
792 * @brief Sets the input underline's properties string.
794 * @note The string is stored to be recovered.
796 * @param[in] underlineProperties The underline's properties string.
798 void SetInputUnderlineProperties( const std::string& underlineProperties );
801 * @brief Retrieves the input underline's properties string.
803 * @return The underline's properties string.
805 const std::string& GetInputUnderlineProperties() const;
808 * @brief Sets the input emboss's properties string.
810 * @note The string is stored to be recovered.
812 * @param[in] embossProperties The emboss's properties string.
814 void SetInputEmbossProperties( const std::string& embossProperties );
817 * @brief Retrieves the input emboss's properties string.
819 * @return The emboss's properties string.
821 const std::string& GetInputEmbossProperties() const;
824 * @brief Sets input the outline's properties string.
826 * @note The string is stored to be recovered.
828 * @param[in] outlineProperties The outline's properties string.
830 void SetInputOutlineProperties( const std::string& outlineProperties );
833 * @brief Retrieves the input outline's properties string.
835 * @return The outline's properties string.
837 const std::string& GetInputOutlineProperties() const;
839 public: // Queries & retrieves.
842 * @brief Return the layout engine.
844 * @return A reference to the layout engine.
846 Layout::Engine& GetLayoutEngine();
849 * @brief Return a view of the text.
851 * @return A reference to the view.
856 * @copydoc Control::GetNaturalSize()
858 Vector3 GetNaturalSize();
861 * @copydoc Control::GetHeightForWidth()
863 float GetHeightForWidth( float width );
866 * @brief Retrieves the text's model.
868 * @return A pointer to the text's model.
870 const ModelInterface* const GetTextModel() const;
873 * @brief Used to get scrolled distance by user input
875 * @return Distance from last scroll offset to new scroll offset
877 float GetScrollAmountByUserInput();
880 * @brief Get latest scroll amount, control size and layout size
882 * This method is used to get information of control's scroll
883 * @param[out] scrollPosition The current scrolled position
884 * @param[out] controlHeight The size of a UI control
885 * @param[out] layoutHeight The size of a bounding box to layout text within.
887 * @return Whether the text scroll position is changed or not after last update.
889 bool GetTextScrollInfo( float& scrollPosition, float& controlHeight, float& layoutHeight );
892 * @brief Used to set the hidden input option
894 void SetHiddenInputOption( const Property::Map& options );
897 * @brief Used to get the hidden input option
899 void GetHiddenInputOption( Property::Map& options );
904 * @brief Triggers a relayout which updates View (if necessary).
906 * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
907 * @param[in] size A the size of a bounding box to layout text within.
909 * @return Whether the text model or decorations were updated.
911 UpdateTextType Relayout( const Size& size );
914 * @brief Request a relayout using the ControlInterface.
916 void RequestRelayout();
918 public: // Input style change signals.
921 * @return Whether the queue of input style changed signals is empty.
923 bool IsInputStyleChangedSignalsQueueEmpty();
926 * @brief Process all pending input style changed signals.
928 * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
929 * text controls. Text controls may send signals to state the input style has changed.
931 void ProcessInputStyleChangedSignals();
933 public: // Text-input Event Queuing.
936 * @brief Called by editable UI controls when keyboard focus is gained.
938 void KeyboardFocusGainEvent();
941 * @brief Called by editable UI controls when focus is lost.
943 void KeyboardFocusLostEvent();
946 * @brief Called by editable UI controls when key events are received.
948 * @param[in] event The key event.
949 * @param[in] type Used to distinguish between regular key events and IMF events.
951 bool KeyEvent( const Dali::KeyEvent& event );
954 * @brief Called by editable UI controls when a tap gesture occurs.
955 * @param[in] tapCount The number of taps.
956 * @param[in] x The x position relative to the top-left of the parent control.
957 * @param[in] y The y position relative to the top-left of the parent control.
959 void TapEvent( unsigned int tapCount, float x, float y );
962 * @brief Called by editable UI controls when a pan gesture occurs.
964 * @param[in] state The state of the gesture.
965 * @param[in] displacement This distance panned since the last pan gesture.
967 void PanEvent( Gesture::State state, const Vector2& displacement );
970 * @brief Called by editable UI controls when a long press gesture occurs.
972 * @param[in] state The state of the gesture.
973 * @param[in] x The x position relative to the top-left of the parent control.
974 * @param[in] y The y position relative to the top-left of the parent control.
976 void LongPressEvent( Gesture::State state, float x, float y );
979 * @brief Event received from IMF manager
981 * @param[in] imfManager The IMF manager.
982 * @param[in] imfEvent The event received.
983 * @return A data struture indicating if update is needed, cursor position and current text.
985 ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
988 * @brief Event from Clipboard notifying an Item has been selected for pasting
990 void PasteClipboardItemEvent();
992 protected: // Inherit from Text::Decorator::ControllerInterface.
995 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
997 virtual void GetTargetSize( Vector2& targetSize );
1000 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
1002 virtual void AddDecoration( Actor& actor, bool needsClipping );
1005 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
1007 virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
1009 protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
1012 * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
1014 virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
1016 protected: // Inherit from HiddenText.
1019 * @brief Invoked from HiddenText when showing time of the last character was expired
1021 virtual void DisplayTimeExpired();
1026 * @brief Called by editable UI controls when key events are received.
1028 * @param[in] text The text to insert.
1029 * @param[in] type Used to distinguish between regular key events and IMF events.
1031 void InsertText( const std::string& text, InsertType type );
1034 * @brief Paste given string into Text model
1035 * @param[in] stringToPaste this string will be inserted into the text model
1037 void PasteText( const std::string& stringToPaste );
1040 * @brief Remove a given number of characters
1042 * When predictve text is used the pre-edit text is removed and inserted again with the new characters.
1043 * The UpdateInputStyleType @type parameter if set to DONT_UPDATE_INPUT_STYLE avoids to update the input
1044 * style when pre-edit text is removed.
1046 * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
1047 * @param[in] numberOfCharacters The number of characters to delete from the cursorOffset.
1048 * @param[in] type Whether to update the input style.
1049 * @return True if the remove was successful.
1051 bool RemoveText( int cursorOffset,
1052 int numberOfCharacters,
1053 UpdateInputStyleType type );
1056 * @brief Checks if text is selected and if so removes it.
1057 * @return true if text was removed
1059 bool RemoveSelectedText();
1061 private: // Relayout.
1064 * @brief Lays-out the text.
1066 * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
1068 * @param[in] size A the size of a bounding box to layout text within.
1069 * @param[in] operations The layout operations which need to be done.
1070 * @param[out] layoutSize The size of the laid-out text.
1072 bool DoRelayout( const Size& size,
1073 OperationsMask operations,
1077 * @brief Calulates the vertical offset to align the text inside the bounding box.
1079 * @param[in] size The size of the bounding box.
1081 void CalculateVerticalOffset( const Size& size );
1086 * @brief Process queued events which modify the model.
1088 void ProcessModifyEvents();
1091 * @brief Used to process an event queued from SetText()
1093 void TextReplacedEvent();
1096 * @brief Used to process an event queued from key events etc.
1098 void TextInsertedEvent();
1101 * @brief Used to process an event queued from backspace key etc.
1103 void TextDeletedEvent();
1106 * @brief Creates a selection event.
1108 * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
1110 * @param[in] x The x position relative to the top-left of the parent control.
1111 * @param[in] y The y position relative to the top-left of the parent control.
1112 * @param[in] selectAll Whether the whole text is selected.
1114 void SelectEvent( float x, float y, bool selectAll );
1117 * @brief Helper to KeyEvent() to handle the backspace case.
1119 * @return True if a character was deleted.
1121 bool BackspaceKeyEvent();
1123 private: // Helpers.
1126 * @brief Used to remove the text included the placeholder text.
1131 * @brief Helper to show the place holder text..
1133 void ShowPlaceholderText();
1136 * @brief Helper to clear font-specific data (only).
1138 void ClearFontData();
1141 * @brief Helper to clear text's style data.
1143 void ClearStyleData();
1146 * @brief Used to reset the cursor position after setting a new text.
1148 * @param[in] cursorIndex Where to place the cursor.
1150 void ResetCursorPosition( CharacterIndex cursorIndex );
1153 * @brief Used to reset the scroll position after setting a new text.
1155 void ResetScrollPosition();
1157 private: // Private contructors & copy operator.
1160 * @brief Private constructor.
1165 * @brief Private constructor.
1167 Controller( ControlInterface* controlInterface );
1170 * @brief Private constructor.
1172 Controller( ControlInterface* controlInterface,
1173 EditableControlInterface* editableControlInterface );
1176 Controller( const Controller& handle );
1179 Controller& operator=( const Controller& handle );
1181 protected: // Destructor.
1184 * @brief A reference counted object may only be deleted by calling Unreference().
1186 virtual ~Controller();
1196 } // namespace Toolkit
1200 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H