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/layouts/layout-wrap-mode.h>
30 #include <dali-toolkit/internal/text/hidden-text.h>
31 #include <dali-toolkit/internal/text/text-model-interface.h>
44 class ControlInterface;
45 class EditableControlInterface;
47 class RenderingController;
49 typedef IntrusivePtr<Controller> ControllerPtr;
52 * @brief A Text Controller is used by UI Controls which display text.
54 * It manipulates the Logical & Visual text models on behalf of the UI Controls.
55 * It provides a view of the text that can be used by rendering back-ends.
57 * For selectable/editable UI controls, the controller handles input events from the UI control
58 * and decorations (grab handles etc) via the Decorator::ControllerInterface interface.
60 * The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface.
62 class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface, public HiddenText::Observer
64 public: // Enumerated types.
67 * @brief Text related operations to be done in the relayout process.
71 NO_OPERATION = 0x0000,
72 CONVERT_TO_UTF32 = 0x0001,
74 VALIDATE_FONTS = 0x0004,
75 GET_LINE_BREAKS = 0x0008,
76 GET_WORD_BREAKS = 0x0010,
79 GET_GLYPH_METRICS = 0x0080,
81 UPDATE_LAYOUT_SIZE = 0x0200,
85 UPDATE_DIRECTION = 0x2000,
86 ALL_OPERATIONS = 0xFFFF
90 * @brief Used to distinguish between regular key events and IMF events
99 * @brief Used to specify whether to update the input style.
101 enum UpdateInputStyleType
104 DONT_UPDATE_INPUT_STYLE
108 * @brief Used to specify what has been updated after the Relayout() method has been called.
112 NONE_UPDATED = 0x0, ///< Nothing has been updated.
113 MODEL_UPDATED = 0x1, ///< The text's model has been updated.
114 DECORATOR_UPDATED = 0x2 ///< The decoration has been updated.
118 * @brief Different placeholder-text can be shown when the control is active/inactive.
122 PLACEHOLDER_TYPE_ACTIVE,
123 PLACEHOLDER_TYPE_INACTIVE,
127 * @brief Enumeration for Font Size Type.
131 POINT_SIZE, // The size of font in points.
132 PIXEL_SIZE // The size of font in pixels.
139 NO_ACTION, ///< Does no action if there is a tap on top of an area with no text.
140 HIGHLIGHT, ///< Highlights the nearest text (at the beginning or end of the text) and shows the text's selection popup.
141 SHOW_SELECTION_POPUP ///< Shows the text's selection popup.
145 public: // Constructor.
148 * @brief Create a new instance of a Controller.
150 * @return A pointer to a new Controller.
152 static ControllerPtr New();
155 * @brief Create a new instance of a Controller.
157 * @param[in] controlInterface The control's interface.
159 * @return A pointer to a new Controller.
161 static ControllerPtr New( ControlInterface* controlInterface );
164 * @brief Create a new instance of a Controller.
166 * @param[in] controlInterface The control's interface.
167 * @param[in] editableControlInterface The editable control's interface.
169 * @return A pointer to a new Controller.
171 static ControllerPtr New( ControlInterface* controlInterface,
172 EditableControlInterface* editableControlInterface );
174 public: // Configure the text controller.
177 * @brief Called to enable text input.
179 * @note Selectable or editable controls should call this once after Controller::New().
180 * @param[in] decorator Used to create cursor, selection handle decorations etc.
182 void EnableTextInput( DecoratorPtr decorator );
185 * @brief Used to switch between bitmap & vector based glyphs
187 * @param[in] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different.
189 void SetGlyphType( TextAbstraction::GlyphType glyphType );
192 * @brief Enables/disables the mark-up processor.
194 * By default is disabled.
196 * @param[in] enable Whether to enable the mark-up processor.
198 void SetMarkupProcessorEnabled( bool enable );
201 * @brief Retrieves whether the mark-up processor is enabled.
203 * By default is disabled.
205 * @return @e true if the mark-up processor is enabled, otherwise returns @e false.
207 bool IsMarkupProcessorEnabled() const;
210 * @brief Enables/disables the auto text scrolling
212 * By default is disabled.
214 * @param[in] enable Whether to enable the auto scrolling
216 void SetAutoScrollEnabled( bool enable );
219 * @brief Retrieves whether auto text scrolling is enabled.
221 * By default is disabled.
223 * @return @e true if auto scrolling is enabled, otherwise returns @e false.
225 bool IsAutoScrollEnabled() const;
228 * @brief Get direction of the text from the first line of text,
229 * @return bool rtl (right to left) is true
231 CharacterDirection GetAutoScrollDirection() const;
234 * @brief Get the alignment offset of the first line of text.
236 * @return The alignment offset.
238 float GetAutoScrollLineAlignment() const;
241 * @brief Enables the horizontal scrolling.
243 * @param[in] enable Whether to enable the horizontal scrolling.
245 void SetHorizontalScrollEnabled( bool enable );
248 * @brief Retrieves whether the horizontal scrolling is enabled.
250 * @return @e true if the horizontal scrolling is enabled, otherwise it returns @e false.
252 bool IsHorizontalScrollEnabled() const;
255 * @brief Enables the vertical scrolling.
257 * @param[in] enable Whether to enable the vertical scrolling.
259 void SetVerticalScrollEnabled( bool enable );
262 * @brief Retrieves whether the verticall scrolling is enabled.
264 * @return @e true if the vertical scrolling is enabled, otherwise it returns @e false.
266 bool IsVerticalScrollEnabled() const;
269 * @brief Enables the smooth handle panning.
271 * @param[in] enable Whether to enable the smooth handle panning.
273 void SetSmoothHandlePanEnabled( bool enable );
276 * @brief Retrieves whether the smooth handle panning is enabled.
278 * @return @e true if the smooth handle panning is enabled.
280 bool IsSmoothHandlePanEnabled() const;
283 * @brief Sets the maximum number of characters that can be inserted into the TextModel
285 * @param[in] maxCharacters maximum number of characters to be accepted
287 void SetMaximumNumberOfCharacters( Length maxCharacters );
290 * @brief Sets the maximum number of characters that can be inserted into the TextModel
292 * @param[in] maxCharacters maximum number of characters to be accepted
294 int GetMaximumNumberOfCharacters();
297 * @brief Called to enable/disable cursor blink.
299 * @note Only editable controls should calls this.
300 * @param[in] enabled Whether the cursor should blink or not.
302 void SetEnableCursorBlink( bool enable );
305 * @brief Query whether cursor blink is enabled.
307 * @return Whether the cursor should blink or not.
309 bool GetEnableCursorBlink() const;
312 * @brief Whether to enable the multi-line layout.
314 * @param[in] enable \e true enables the multi-line (by default)
316 void SetMultiLineEnabled( bool enable );
319 * @return Whether the multi-line layout is enabled.
321 bool IsMultiLineEnabled() const;
324 * @brief Sets the text's horizontal alignment.
326 * @param[in] alignment The horizontal alignment.
328 void SetHorizontalAlignment( Layout::HorizontalAlignment alignment );
331 * @copydoc ModelInterface::GetHorizontalAlignment()
333 Layout::HorizontalAlignment GetHorizontalAlignment() const;
336 * @brief Sets the text's vertical alignment.
338 * @param[in] alignment The vertical alignment.
340 void SetVerticalAlignment( Layout::VerticalAlignment alignment );
343 * @copydoc ModelInterface::GetVerticalAlignment()
345 Layout::VerticalAlignment GetVerticalAlignment() const;
348 * @brief Sets the text's wrap mode
349 * @param[in] text wrap mode The unit of wrapping
351 void SetLineWrapMode( Layout::LineWrap::Mode textWarpMode );
354 * @brief Retrieve text wrap mode previously set.
355 * @return text wrap mode
357 Layout::LineWrap::Mode GetLineWrapMode() const;
360 * @brief Enable or disable the text elide.
362 * @param[in] enabled Whether to enable the text elide.
364 void SetTextElideEnabled( bool enabled );
367 * @copydoc ModelInterface::IsTextElideEnabled()
369 bool IsTextElideEnabled() const;
372 * @brief Enable or disable the placeholder text elide.
373 * @param enabled Whether to enable the placeholder text elide.
375 void SetPlaceholderTextElideEnabled( bool enabled );
378 * @brief Whether the placeholder text elide property is enabled.
379 * @return True if the placeholder text elide property is enabled, false otherwise.
381 bool IsPlaceholderTextElideEnabled() const;
384 * @brief Enable or disable the text selection.
385 * @param[in] enabled Whether to enable the text selection.
387 void SetSelectionEnabled( bool enabled );
390 * @brief Whether the text selection is enabled or not.
391 * @return True if the text selection is enabled
393 bool IsSelectionEnabled() const;
396 * @brief Sets input type to password
398 * @note The string is displayed hidden character
400 * @param[in] passwordInput True if password input is enabled.
402 void SetInputModePassword( bool passwordInput );
405 * @brief Returns whether the input mode type is set as password.
407 * @return True if input mode type is password
409 bool IsInputModePassword();
412 * @brief Sets the action when there is a double tap event on top of a text area with no text.
414 * @param[in] action The action to do.
416 void SetNoTextDoubleTapAction( NoTextTap::Action action );
419 * @brief Retrieves the action when there is a double tap event on top of a text area with no text.
421 * @return The action to do.
423 NoTextTap::Action GetNoTextDoubleTapAction() const;
426 * @briefSets the action when there is a long press event on top of a text area with no text.
428 * @param[in] action The action to do.
430 void SetNoTextLongPressAction( NoTextTap::Action action );
433 * @brief Retrieves the action when there is a long press event on top of a text area with no text.
435 * @return The action to do.
437 NoTextTap::Action GetNoTextLongPressAction() const;
440 * @brief Query if Underline settings were provided by string or map
441 * @return bool true if set by string
443 bool IsUnderlineSetByString();
446 * Set method underline setting were set by
447 * @param[in] bool, true if set by string
449 void UnderlineSetByString( bool setByString );
452 * @brief Query if shadow settings were provided by string or map
453 * @return bool true if set by string
455 bool IsShadowSetByString();
458 * Set method shadow setting were set by
459 * @param[in] bool, true if set by string
461 void ShadowSetByString( bool setByString );
464 * @brief Query if font style settings were provided by string or map
465 * @return bool true if set by string
467 bool IsFontStyleSetByString();
470 * Set method font style setting were set by
471 * @param[in] bool, true if set by string
473 void FontStyleSetByString( bool setByString );
478 * @brief Replaces any text previously set.
480 * @note This will be converted into UTF-32 when stored in the text model.
481 * @param[in] text A string of UTF-8 characters.
483 void SetText( const std::string& text );
486 * @brief Retrieve any text previously set.
488 * @param[out] text A string of UTF-8 characters.
490 void GetText( std::string& text ) const;
493 * @brief Replaces any placeholder text previously set.
495 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
496 * @param[in] text A string of UTF-8 characters.
498 void SetPlaceholderText( PlaceholderType type, const std::string& text );
501 * @brief Retrieve any placeholder text previously set.
503 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
504 * @param[out] A string of UTF-8 characters.
506 void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
509 * @ brief Update the text after a font change
510 * @param[in] newDefaultFont The new font to change to
512 void UpdateAfterFontChange( const std::string& newDefaultFont );
514 public: // Default style & Input style
517 * @brief Set the default font family.
519 * @param[in] defaultFontFamily The default font family.
521 void SetDefaultFontFamily( const std::string& defaultFontFamily );
524 * @brief Retrieve the default font family.
526 * @return The default font family.
528 const std::string& GetDefaultFontFamily() const;
531 * @brief Sets the placeholder text font family.
532 * @param[in] placeholderTextFontFamily The placeholder text font family.
534 void SetPlaceholderFontFamily( const std::string& placeholderTextFontFamily );
537 * @brief Retrieves the placeholder text font family.
539 * @return The placeholder text font family
541 const std::string& GetPlaceholderFontFamily() const;
544 * @brief Sets the default font weight.
546 * @param[in] weight The font weight.
548 void SetDefaultFontWeight( FontWeight weight );
551 * @brief Whether the font's weight has been defined.
553 bool IsDefaultFontWeightDefined() const;
556 * @brief Retrieves the default font weight.
558 * @return The default font weight.
560 FontWeight GetDefaultFontWeight() const;
563 * @brief Sets the placeholder text font weight.
565 * @param[in] weight The font weight
567 void SetPlaceholderTextFontWeight( FontWeight weight );
570 * @brief Whether the font's weight has been defined.
572 * @return True if the placeholder text font weight is defined
574 bool IsPlaceholderTextFontWeightDefined() const;
577 * @brief Retrieves the placeholder text font weight.
579 * @return The placeholder text font weight
581 FontWeight GetPlaceholderTextFontWeight() const;
584 * @brief Sets the default font width.
586 * @param[in] width The font width.
588 void SetDefaultFontWidth( FontWidth width );
591 * @brief Whether the font's width has been defined.
593 bool IsDefaultFontWidthDefined() const;
596 * @brief Retrieves the default font width.
598 * @return The default font width.
600 FontWidth GetDefaultFontWidth() const;
603 * @brief Sets the placeholder text font width.
605 * @param[in] width The font width
607 void SetPlaceholderTextFontWidth( FontWidth width );
610 * @brief Whether the font's width has been defined.
612 * @return True if the placeholder text font width is defined
614 bool IsPlaceholderTextFontWidthDefined() const;
617 * @brief Retrieves the placeholder text font width.
619 * @return The placeholder text font width
621 FontWidth GetPlaceholderTextFontWidth() const;
624 * @brief Sets the default font slant.
626 * @param[in] slant The font slant.
628 void SetDefaultFontSlant( FontSlant slant );
631 * @brief Whether the font's slant has been defined.
633 bool IsDefaultFontSlantDefined() const;
636 * @brief Retrieves the default font slant.
638 * @return The default font slant.
640 FontSlant GetDefaultFontSlant() const;
643 * @brief Sets the placeholder text font slant.
645 * @param[in] slant The font slant
647 void SetPlaceholderTextFontSlant( FontSlant slant );
650 * @brief Whether the font's slant has been defined.
652 * @return True if the placeholder text font slant is defined
654 bool IsPlaceholderTextFontSlantDefined() const;
657 * @brief Retrieves the placeholder text font slant.
659 * @return The placeholder text font slant
661 FontSlant GetPlaceholderTextFontSlant() const;
664 * @brief Set the default font size.
666 * @param[in] fontSize The default font size
667 * @param[in] type The font size type is point size or pixel size
669 void SetDefaultFontSize( float fontSize, FontSizeType type );
672 * @brief Retrieve the default point size.
674 * @param[in] type The font size type
675 * @return The default point size.
677 float GetDefaultFontSize( FontSizeType type ) const;
680 * @brief Sets the Placeholder text font size.
681 * @param[in] fontSize The placeholder text font size
682 * @param[in] type The font size type is point size or pixel size
684 void SetPlaceholderTextFontSize( float fontSize, FontSizeType type );
687 * @brief Retrieves the Placeholder text font size.
688 * @param[in] type The font size type
689 * @return The placeholder font size
691 float GetPlaceholderTextFontSize( FontSizeType type ) const;
694 * @brief Sets the text's default color.
696 * @param color The default color.
698 void SetDefaultColor( const Vector4& color );
701 * @brief Retrieves the text's default color.
703 * @return The default color.
705 const Vector4& GetDefaultColor() const;
708 * @brief Set the text color
710 * @param textColor The text color
712 void SetPlaceholderTextColor( const Vector4& textColor );
715 * @brief Retrieve the text color
717 * @return The text color
719 const Vector4& GetPlaceholderTextColor() const;
722 * @brief Set the shadow offset.
724 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
726 void SetShadowOffset( const Vector2& shadowOffset );
729 * @brief Retrieve the shadow offset.
731 * @return The shadow offset.
733 const Vector2& GetShadowOffset() const;
736 * @brief Set the shadow color.
738 * @param[in] shadowColor The shadow color.
740 void SetShadowColor( const Vector4& shadowColor );
743 * @brief Retrieve the shadow color.
745 * @return The shadow color.
747 const Vector4& GetShadowColor() const;
750 * @brief Set the underline color.
752 * @param[in] color color of underline.
754 void SetUnderlineColor( const Vector4& color );
757 * @brief Retrieve the underline color.
759 * @return The underline color.
761 const Vector4& GetUnderlineColor() const;
764 * @brief Set the underline enabled flag.
766 * @param[in] enabled The underline enabled flag.
768 void SetUnderlineEnabled( bool enabled );
771 * @brief Returns whether the text is underlined or not.
773 * @return The underline state.
775 bool IsUnderlineEnabled() const;
778 * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
780 * @param[in] height The height in pixels of the underline
782 void SetUnderlineHeight( float height );
785 * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
787 * @return The height of the underline, or 0 if height is not overrided.
789 float GetUnderlineHeight() const;
792 * @brief Set the outline color.
794 * @param[in] color color of outline.
796 void SetOutlineColor( const Vector4& color );
799 * @brief Retrieve the outline color.
801 * @return The outline color.
803 const Vector4& GetOutlineColor() const;
806 * @brief Set the outline width
808 * @param[in] width The width in pixels of the outline, 0 indicates no outline
810 void SetOutlineWidth( float width );
813 * @brief Retrieves the width of an outline
815 * @return The width of the outline.
817 float GetOutlineWidth() const;
820 * @brief Sets the emboss's properties string.
822 * @note The string is stored to be recovered.
824 * @param[in] embossProperties The emboss's properties string.
826 void SetDefaultEmbossProperties( const std::string& embossProperties );
829 * @brief Retrieves the emboss's properties string.
831 * @return The emboss's properties string.
833 const std::string& GetDefaultEmbossProperties() const;
836 * @brief Sets the outline's properties string.
838 * @note The string is stored to be recovered.
840 * @param[in] outlineProperties The outline's properties string.
842 void SetDefaultOutlineProperties( const std::string& outlineProperties );
845 * @brief Retrieves the outline's properties string.
847 * @return The outline's properties string.
849 const std::string& GetDefaultOutlineProperties() const;
852 * @brief Sets the default line spacing.
854 * @param[in] lineSpacing The line spacing.
856 void SetDefaultLineSpacing( float lineSpacing );
859 * @brief Retrieves the default line spacing.
861 * @return The line spacing.
863 float GetDefaultLineSpacing() const;
866 * @brief Sets the input text's color.
868 * @param[in] color The input text's color.
870 void SetInputColor( const Vector4& color );
873 * @brief Retrieves the input text's color.
875 * @return The input text's color.
877 const Vector4& GetInputColor() const;
880 * @brief Sets the input text's font family name.
882 * @param[in] fontFamily The text's font family name.
884 void SetInputFontFamily( const std::string& fontFamily );
887 * @brief Retrieves the input text's font family name.
889 * @return The input text's font family name.
891 const std::string& GetInputFontFamily() const;
894 * @brief Sets the input font's weight.
896 * @param[in] weight The input font's weight.
898 void SetInputFontWeight( FontWeight weight );
901 * @return Whether the font's weight has been defined.
903 bool IsInputFontWeightDefined() const;
906 * @brief Retrieves the input font's weight.
908 * @return The input font's weight.
910 FontWeight GetInputFontWeight() const;
913 * @brief Sets the input font's width.
915 * @param[in] width The input font's width.
917 void SetInputFontWidth( FontWidth width );
920 * @return Whether the font's width has been defined.
922 bool IsInputFontWidthDefined() const;
925 * @brief Retrieves the input font's width.
927 * @return The input font's width.
929 FontWidth GetInputFontWidth() const;
932 * @brief Sets the input font's slant.
934 * @param[in] slant The input font's slant.
936 void SetInputFontSlant( FontSlant slant );
939 * @return Whether the font's slant has been defined.
941 bool IsInputFontSlantDefined() const;
944 * @brief Retrieves the input font's slant.
946 * @return The input font's slant.
948 FontSlant GetInputFontSlant() const;
951 * @brief Sets the input font's point size.
953 * @param[in] size The input font's point size.
955 void SetInputFontPointSize( float size );
958 * @brief Retrieves the input font's point size.
960 * @return The input font's point size.
962 float GetInputFontPointSize() const;
965 * @brief Sets the input line spacing.
967 * @param[in] lineSpacing The line spacing.
969 void SetInputLineSpacing( float lineSpacing );
972 * @brief Retrieves the input line spacing.
974 * @return The line spacing.
976 float GetInputLineSpacing() const;
979 * @brief Sets the input shadow's properties string.
981 * @note The string is stored to be recovered.
983 * @param[in] shadowProperties The shadow's properties string.
985 void SetInputShadowProperties( const std::string& shadowProperties );
988 * @brief Retrieves the input shadow's properties string.
990 * @return The shadow's properties string.
992 const std::string& GetInputShadowProperties() const;
995 * @brief Sets the input underline's properties string.
997 * @note The string is stored to be recovered.
999 * @param[in] underlineProperties The underline's properties string.
1001 void SetInputUnderlineProperties( const std::string& underlineProperties );
1004 * @brief Retrieves the input underline's properties string.
1006 * @return The underline's properties string.
1008 const std::string& GetInputUnderlineProperties() const;
1011 * @brief Sets the input emboss's properties string.
1013 * @note The string is stored to be recovered.
1015 * @param[in] embossProperties The emboss's properties string.
1017 void SetInputEmbossProperties( const std::string& embossProperties );
1020 * @brief Retrieves the input emboss's properties string.
1022 * @return The emboss's properties string.
1024 const std::string& GetInputEmbossProperties() const;
1027 * @brief Sets input the outline's properties string.
1029 * @note The string is stored to be recovered.
1031 * @param[in] outlineProperties The outline's properties string.
1033 void SetInputOutlineProperties( const std::string& outlineProperties );
1036 * @brief Retrieves the input outline's properties string.
1038 * @return The outline's properties string.
1040 const std::string& GetInputOutlineProperties() const;
1043 * @brief Set the control's interface.
1045 * @param[in] controlInterface The control's interface.
1047 void SetControlInterface( ControlInterface* controlInterface );
1049 public: // Queries & retrieves.
1052 * @brief Return the layout engine.
1054 * @return A reference to the layout engine.
1056 Layout::Engine& GetLayoutEngine();
1059 * @brief Return a view of the text.
1061 * @return A reference to the view.
1066 * @copydoc Control::GetNaturalSize()
1068 Vector3 GetNaturalSize();
1071 * @copydoc Control::GetHeightForWidth()
1073 float GetHeightForWidth( float width );
1076 * @brief Retrieves the text's number of lines for a given width.
1077 * @param[in] width The width of the text's area.
1078 * @ return The number of lines.
1080 int GetLineCount( float width );
1083 * @brief Retrieves the text's model.
1085 * @return A pointer to the text's model.
1087 const ModelInterface* const GetTextModel() const;
1090 * @brief Used to get scrolled distance by user input
1092 * @return Distance from last scroll offset to new scroll offset
1094 float GetScrollAmountByUserInput();
1097 * @brief Get latest scroll amount, control size and layout size
1099 * This method is used to get information of control's scroll
1100 * @param[out] scrollPosition The current scrolled position
1101 * @param[out] controlHeight The size of a UI control
1102 * @param[out] layoutHeight The size of a bounding box to layout text within.
1104 * @return Whether the text scroll position is changed or not after last update.
1106 bool GetTextScrollInfo( float& scrollPosition, float& controlHeight, float& layoutHeight );
1109 * @brief Used to set the hidden input option
1111 void SetHiddenInputOption( const Property::Map& options );
1114 * @brief Used to get the hidden input option
1116 void GetHiddenInputOption( Property::Map& options );
1119 * @brief Sets the Placeholder Properties.
1121 * @param[in] map The placeholder property map
1123 void SetPlaceholderProperty( const Property::Map& map );
1126 * @brief Retrieves the Placeholder Property map.
1128 * @param[out] map The property map
1130 void GetPlaceholderProperty( Property::Map& map );
1132 public: // Relayout.
1135 * @brief Triggers a relayout which updates View (if necessary).
1137 * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
1138 * @param[in] size A the size of a bounding box to layout text within.
1140 * @return Whether the text model or decorations were updated.
1142 UpdateTextType Relayout( const Size& size );
1145 * @brief Request a relayout using the ControlInterface.
1147 void RequestRelayout();
1149 public: // Input style change signals.
1152 * @return Whether the queue of input style changed signals is empty.
1154 bool IsInputStyleChangedSignalsQueueEmpty();
1157 * @brief Process all pending input style changed signals.
1159 * Calls the Text::ControlInterface::InputStyleChanged() method which is overriden by the
1160 * text controls. Text controls may send signals to state the input style has changed.
1162 void ProcessInputStyleChangedSignals();
1164 public: // Text-input Event Queuing.
1167 * @brief Called by editable UI controls when keyboard focus is gained.
1169 void KeyboardFocusGainEvent();
1172 * @brief Called by editable UI controls when focus is lost.
1174 void KeyboardFocusLostEvent();
1177 * @brief Called by editable UI controls when key events are received.
1179 * @param[in] event The key event.
1180 * @param[in] type Used to distinguish between regular key events and IMF events.
1182 bool KeyEvent( const Dali::KeyEvent& event );
1185 * @brief Called by editable UI controls when a tap gesture occurs.
1186 * @param[in] tapCount The number of taps.
1187 * @param[in] x The x position relative to the top-left of the parent control.
1188 * @param[in] y The y position relative to the top-left of the parent control.
1190 void TapEvent( unsigned int tapCount, float x, float y );
1193 * @brief Called by editable UI controls when a pan gesture occurs.
1195 * @param[in] state The state of the gesture.
1196 * @param[in] displacement This distance panned since the last pan gesture.
1198 void PanEvent( Gesture::State state, const Vector2& displacement );
1201 * @brief Called by editable UI controls when a long press gesture occurs.
1203 * @param[in] state The state of the gesture.
1204 * @param[in] x The x position relative to the top-left of the parent control.
1205 * @param[in] y The y position relative to the top-left of the parent control.
1207 void LongPressEvent( Gesture::State state, float x, float y );
1210 * @brief Event received from IMF manager
1212 * @param[in] imfManager The IMF manager.
1213 * @param[in] imfEvent The event received.
1214 * @return A data struture indicating if update is needed, cursor position and current text.
1216 ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
1219 * @brief Event from Clipboard notifying an Item has been selected for pasting
1221 void PasteClipboardItemEvent();
1224 * @brief Return true when text control should clear key input focus when escape key is pressed.
1226 * @return Whether text control should clear key input focus or not when escape key is pressed.
1228 bool ShouldClearFocusOnEscape() const;
1230 protected: // Inherit from Text::Decorator::ControllerInterface.
1233 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
1235 virtual void GetTargetSize( Vector2& targetSize );
1238 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
1240 virtual void AddDecoration( Actor& actor, bool needsClipping );
1243 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
1245 virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
1247 protected: // Inherit from TextSelectionPopup::TextPopupButtonCallbackInterface.
1250 * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
1252 virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
1254 protected: // Inherit from HiddenText.
1257 * @brief Invoked from HiddenText when showing time of the last character was expired
1259 virtual void DisplayTimeExpired();
1264 * @brief Called by editable UI controls when key events are received.
1266 * @param[in] text The text to insert.
1267 * @param[in] type Used to distinguish between regular key events and IMF events.
1269 void InsertText( const std::string& text, InsertType type );
1272 * @brief Paste given string into Text model
1273 * @param[in] stringToPaste this string will be inserted into the text model
1275 void PasteText( const std::string& stringToPaste );
1278 * @brief Remove a given number of characters
1280 * When predictve text is used the pre-edit text is removed and inserted again with the new characters.
1281 * The UpdateInputStyleType @type parameter if set to DONT_UPDATE_INPUT_STYLE avoids to update the input
1282 * style when pre-edit text is removed.
1284 * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
1285 * @param[in] numberOfCharacters The number of characters to delete from the cursorOffset.
1286 * @param[in] type Whether to update the input style.
1287 * @return True if the remove was successful.
1289 bool RemoveText( int cursorOffset,
1290 int numberOfCharacters,
1291 UpdateInputStyleType type );
1294 * @brief Checks if text is selected and if so removes it.
1295 * @return true if text was removed
1297 bool RemoveSelectedText();
1299 private: // Relayout.
1302 * @brief Lays-out the text.
1304 * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
1306 * @param[in] size A the size of a bounding box to layout text within.
1307 * @param[in] operations The layout operations which need to be done.
1308 * @param[out] layoutSize The size of the laid-out text.
1310 bool DoRelayout( const Size& size,
1311 OperationsMask operations,
1315 * @brief Calulates the vertical offset to align the text inside the bounding box.
1317 * @param[in] size The size of the bounding box.
1319 void CalculateVerticalOffset( const Size& size );
1324 * @brief Process queued events which modify the model.
1326 void ProcessModifyEvents();
1329 * @brief Used to process an event queued from SetText()
1331 void TextReplacedEvent();
1334 * @brief Used to process an event queued from key events etc.
1336 void TextInsertedEvent();
1339 * @brief Used to process an event queued from backspace key etc.
1341 void TextDeletedEvent();
1344 * @brief Creates a selection event.
1346 * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
1348 * @param[in] x The x position relative to the top-left of the parent control.
1349 * @param[in] y The y position relative to the top-left of the parent control.
1350 * @param[in] selectAll Whether the whole text is selected.
1352 void SelectEvent( float x, float y, bool selectAll );
1355 * @brief Helper to KeyEvent() to handle the backspace case.
1357 * @return True if a character was deleted.
1359 bool BackspaceKeyEvent();
1361 private: // Helpers.
1364 * @brief Used to remove the text included the placeholder text.
1369 * @brief Helper to show the place holder text..
1371 void ShowPlaceholderText();
1374 * @brief Helper to clear font-specific data (only).
1376 void ClearFontData();
1379 * @brief Helper to clear text's style data.
1381 void ClearStyleData();
1384 * @brief Used to reset the cursor position after setting a new text.
1386 * @param[in] cursorIndex Where to place the cursor.
1388 void ResetCursorPosition( CharacterIndex cursorIndex );
1391 * @brief Used to reset the scroll position after setting a new text.
1393 void ResetScrollPosition();
1395 private: // Private contructors & copy operator.
1398 * @brief Private constructor.
1403 * @brief Private constructor.
1405 Controller( ControlInterface* controlInterface );
1408 * @brief Private constructor.
1410 Controller( ControlInterface* controlInterface,
1411 EditableControlInterface* editableControlInterface );
1414 Controller( const Controller& handle );
1417 Controller& operator=( const Controller& handle );
1419 protected: // Destructor.
1422 * @brief A reference counted object may only be deleted by calling Unreference().
1424 virtual ~Controller();
1434 } // namespace Toolkit
1438 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H