1 #ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_H__
2 #define __DALI_TOOLKIT_TEXT_CONTROLLER_H__
5 * Copyright (c) 2015 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/text-control-interface.h>
43 typedef IntrusivePtr<Controller> ControllerPtr;
44 typedef Dali::Toolkit::Text::ControlInterface ControlInterface;
47 * @brief Different placeholder-text can be shown when the control is active/inactive.
51 PLACEHOLDER_TYPE_ACTIVE,
52 PLACEHOLDER_TYPE_INACTIVE,
56 * @brief A Text Controller is used by UI Controls which display text.
58 * It manipulates the Logical & Visual text models on behalf of the UI Controls.
59 * It provides a view of the text that can be used by rendering back-ends.
61 * For selectable/editable UI controls, the controller handles input events from the UI control
62 * and decorations (grab handles etc) via the Decorator::ControllerInterface interface.
64 * The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface.
66 class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface
71 * @brief Text related operations to be done in the relayout process.
75 NO_OPERATION = 0x0000,
76 CONVERT_TO_UTF32 = 0x0001,
78 VALIDATE_FONTS = 0x0004,
79 GET_LINE_BREAKS = 0x0008,
80 GET_WORD_BREAKS = 0x0010,
83 GET_GLYPH_METRICS = 0x0080,
85 UPDATE_ACTUAL_SIZE = 0x0200,
89 ALL_OPERATIONS = 0xFFFF
93 * @brief Used to distinguish between regular key events and IMF events
102 * @brief Create a new instance of a Controller.
104 * @param[in] controlInterface An interface used to request a text relayout.
105 * @return A pointer to a new Controller.
107 static ControllerPtr New( ControlInterface& controlInterface );
110 * @brief Called to enable text input.
112 * @note Selectable or editable controls should call this once after Controller::New().
113 * @param[in] decorator Used to create cursor, selection handle decorations etc.
115 void EnableTextInput( DecoratorPtr decorator );
118 * @brief Used to switch between bitmap & vector based glyphs
120 * @param[in] glyphType The type of glyph; note that metrics for bitmap & vector based glyphs are different.
122 void SetGlyphType( TextAbstraction::GlyphType glyphType );
125 * @brief Enables/disables the mark-up processor.
127 * By default is disabled.
129 * @param[in] enable Whether to enable the mark-up processor.
131 void SetMarkupProcessorEnabled( bool enable );
134 * @brief Retrieves whether the mark-up processor is enabled.
136 * By default is disabled.
138 * @return @e true if the mark-up processor is enabled, otherwise returns @e false.
140 bool IsMarkupProcessorEnabled() const;
143 * @brief Replaces any text previously set.
145 * @note This will be converted into UTF-32 when stored in the text model.
146 * @param[in] text A string of UTF-8 characters.
148 void SetText( const std::string& text );
151 * @brief Retrieve any text previously set.
153 * @return A string of UTF-8 characters.
155 void GetText( std::string& text ) const;
158 * @brief Remove a given number of characters
160 * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
161 * @param[in] numberOfCharacters The number of characters to delete from the cursorOffset.
162 * @return True if the remove was successful.
164 bool RemoveText( int cursorOffset, int numberOfCharacters );
167 * @brief Retrieve the current cursor position.
169 * @return The cursor position.
171 unsigned int GetLogicalCursorPosition() const;
174 * @brief Replaces any placeholder text previously set.
176 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
177 * @param[in] text A string of UTF-8 characters.
179 void SetPlaceholderText( PlaceholderType type, const std::string& text );
182 * @brief Retrieve any placeholder text previously set.
184 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
185 * @param[out] A string of UTF-8 characters.
187 void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
190 * @brief Sets the maximum number of characters that can be inserted into the TextModel
192 * @param[in] maxCharacters maximum number of characters to be accepted
194 void SetMaximumNumberOfCharacters( Length maxCharacters );
197 * @brief Sets the maximum number of characters that can be inserted into the TextModel
199 * @param[in] maxCharacters maximum number of characters to be accepted
201 int GetMaximumNumberOfCharacters();
204 * @brief Set the default font family.
206 * @param[in] defaultFontFamily The default font family.
208 void SetDefaultFontFamily( const std::string& defaultFontFamily );
211 * @brief Retrieve the default font family.
213 * @return The default font family.
215 const std::string& GetDefaultFontFamily() const;
218 * @brief Sets the font's style string.
220 * @note The style set may be changed by the underlying font system. The string is stored to be recovered.
222 * @param[in] style The font's style string.
224 void SetDefaultFontStyle( const std::string& style );
227 * @brief Retrieves the font's style.
229 * @return The font's style.
231 const std::string& GetDefaultFontStyle() const;
234 * @brief Sets the default font weight.
236 * @param[in] weight The font weight.
238 void SetDefaultFontWeight( FontWeight weight );
241 * @brief Retrieves the default font weight.
243 * @return The default font weight.
245 FontWeight GetDefaultFontWeight() const;
248 * @brief Sets the default font width.
250 * @param[in] width The font width.
252 void SetDefaultFontWidth( FontWidth width );
255 * @brief Retrieves the default font width.
257 * @return The default font width.
259 FontWidth GetDefaultFontWidth() const;
262 * @brief Sets the default font slant.
264 * @param[in] slant The font slant.
266 void SetDefaultFontSlant( FontSlant slant );
269 * @brief Retrieves the default font slant.
271 * @return The default font slant.
273 FontSlant GetDefaultFontSlant() const;
276 * @brief Set the default point size.
278 * @param[in] pointSize The default point size.
280 void SetDefaultPointSize( float pointSize );
283 * @brief Retrieve the default point size.
285 * @return The default point size.
287 float GetDefaultPointSize() const;
290 * @ brief Update the text after a font change
291 * @param[in] newDefaultFont The new font to change to
293 void UpdateAfterFontChange( const std::string& newDefaultFont );
296 * @brief Set the text color
298 * @param textColor The text color
300 void SetTextColor( const Vector4& textColor );
303 * @brief Retrieve the text color
305 * @return The text color
307 const Vector4& GetTextColor() const;
310 * @brief Set the text color
312 * @param textColor The text color
314 void SetPlaceholderTextColor( const Vector4& textColor );
317 * @brief Retrieve the text color
319 * @return The text color
321 const Vector4& GetPlaceholderTextColor() const;
324 * @brief Set the shadow offset.
326 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
328 void SetShadowOffset( const Vector2& shadowOffset );
331 * @brief Retrieve the shadow offset.
333 * @return The shadow offset.
335 const Vector2& GetShadowOffset() const;
338 * @brief Set the shadow color.
340 * @param[in] shadowColor The shadow color.
342 void SetShadowColor( const Vector4& shadowColor );
345 * @brief Retrieve the shadow color.
347 * @return The shadow color.
349 const Vector4& GetShadowColor() const;
352 * @brief Set the underline color.
354 * @param[in] color color of underline.
356 void SetUnderlineColor( const Vector4& color );
359 * @brief Retrieve the underline color.
361 * @return The underline color.
363 const Vector4& GetUnderlineColor() const;
366 * @brief Set the underline enabled flag.
368 * @param[in] enabled The underline enabled flag.
370 void SetUnderlineEnabled( bool enabled );
373 * @brief Returns whether the text is underlined or not.
375 * @return The underline state.
377 bool IsUnderlineEnabled() const;
380 * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
382 * @param[in] height The height in pixels of the underline
384 void SetUnderlineHeight( float height );
387 * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
389 * @return The height of the underline, or 0 if height is not overrided.
391 float GetUnderlineHeight() const;
394 * @brief Sets the input text's color.
396 * @param[in] color The input text's color.
398 void SetInputColor( const Vector4& color );
401 * @brief Retrieves the input text's color.
403 * @return The input text's color.
405 const Vector4& GetInputColor() const;
408 * @brief Sets the input text's font family name.
410 * @param[in] fontFamily The text's font family name.
412 void SetInputFontFamily( const std::string& fontFamily );
415 * @brief Retrieves the input text's font family name.
417 * @return The input text's font family name.
419 const std::string& GetInputFontFamily() const;
422 * @brief Sets the input text's font style.
424 * @param[in] fontStyle The input text's font style.
426 void SetInputFontStyle( const std::string& fontStyle );
429 * @brief Retrieves the input text's font style.
431 * @return The input text's font style.
433 const std::string& GetInputFontStyle() const;
436 * @brief Sets the input font's weight.
438 * @param[in] weight The input font's weight.
440 void SetInputFontWeight( FontWeight weight );
443 * @brief Retrieves the input font's weight.
445 * @return The input font's weight.
447 FontWeight GetInputFontWeight() const;
450 * @brief Sets the input font's width.
452 * @param[in] width The input font's width.
454 void SetInputFontWidth( FontWidth width );
457 * @brief Retrieves the input font's width.
459 * @return The input font's width.
461 FontWidth GetInputFontWidth() const;
464 * @brief Sets the input font's slant.
466 * @param[in] slant The input font's slant.
468 void SetInputFontSlant( FontSlant slant );
471 * @brief Retrieves the input font's slant.
473 * @return The input font's slant.
475 FontSlant GetInputFontSlant() const;
478 * @brief Sets the input font's point size.
480 * @param[in] size The input font's point size.
482 void SetInputFontPointSize( float size );
485 * @brief Retrieves the input font's point size.
487 * @return The input font's point size.
489 float GetInputFontPointSize() const;
492 * @brief Called to enable/disable cursor blink.
494 * @note Only editable controls should calls this.
495 * @param[in] enabled Whether the cursor should blink or not.
497 void SetEnableCursorBlink( bool enable );
500 * @brief Query whether cursor blink is enabled.
502 * @return Whether the cursor should blink or not.
504 bool GetEnableCursorBlink() const;
507 * @brief Query the current scroll position; the UI control is responsible for moving actors to this position.
509 * @return The scroll position.
511 const Vector2& GetScrollPosition() const;
514 * @brief Query the alignment offset.
516 * @return The alignmnet offset.
518 const Vector2& GetAlignmentOffset() const;
521 * @copydoc Control::GetNaturalSize()
523 Vector3 GetNaturalSize();
526 * @copydoc Control::GetHeightForWidth()
528 float GetHeightForWidth( float width );
531 * @brief Triggers a relayout which updates View (if necessary).
533 * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
534 * @param[in] size A the size of a bounding box to layout text within.
535 * @return True if the text model or decorations were updated.
537 bool Relayout( const Size& size );
540 * @brief Process queued events which modify the model.
542 void ProcessModifyEvents();
545 * @brief Used to remove placeholder text.
550 * @brief Used to reset the cursor position after setting a new text.
552 * @param[in] cursorIndex Where to place the cursor.
554 void ResetCursorPosition( CharacterIndex cursorIndex );
557 * @brief Used to reset the scroll position after setting a new text.
559 void ResetScrollPosition();
562 * @brief Used to process an event queued from SetText()
564 void TextReplacedEvent();
567 * @brief Used to process an event queued from key events etc.
569 void TextInsertedEvent();
572 * @brief Used to process an event queued from backspace key etc.
574 void TextDeletedEvent();
577 * @brief Lays-out the text.
579 * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
581 * @param[in] size A the size of a bounding box to layout text within.
582 * @param[in] operations The layout operations which need to be done.
583 * @param[out] layoutSize The size of the laid-out text.
585 bool DoRelayout( const Size& size,
586 OperationsMask operations,
590 * @brief Whether to enable the multi-line layout.
592 * @param[in] enable \e true enables the multi-line (by default)
594 void SetMultiLineEnabled( bool enable );
597 * @return Whether the multi-line layout is enabled.
599 bool IsMultiLineEnabled() const;
602 * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment()
604 void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment );
607 * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment()
609 LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const;
612 * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment()
614 void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment );
617 * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment()
619 LayoutEngine::VerticalAlignment GetVerticalAlignment() const;
622 * @brief Calulates the alignment of the whole text inside the bounding box.
624 * @param[in] size The size of the bounding box.
626 void CalculateTextAlignment( const Size& size );
629 * @brief Return the layout engine.
631 * @return A reference to the layout engine.
633 LayoutEngine& GetLayoutEngine();
636 * @brief Return a view of the text.
638 * @return A reference to the view.
642 // Text-input Event Queuing
645 * @brief Called by editable UI controls when keyboard focus is gained.
647 void KeyboardFocusGainEvent();
650 * @brief Called by editable UI controls when focus is lost.
652 void KeyboardFocusLostEvent();
655 * @brief Called by editable UI controls when key events are received.
657 * @param[in] event The key event.
658 * @param[in] type Used to distinguish between regular key events and IMF events.
660 bool KeyEvent( const Dali::KeyEvent& event );
663 * @brief Called by editable UI controls when key events are received.
665 * @param[in] text The text to insert.
666 * @param[in] type Used to distinguish between regular key events and IMF events.
668 void InsertText( const std::string& text, InsertType type );
671 * @brief Checks if text is selected and if so removes it.
672 * @return true if text was removed
674 bool RemoveSelectedText();
677 * @brief Called by editable UI controls when a tap gesture occurs.
678 * @param[in] tapCount The number of taps.
679 * @param[in] x The x position relative to the top-left of the parent control.
680 * @param[in] y The y position relative to the top-left of the parent control.
682 void TapEvent( unsigned int tapCount, float x, float y );
685 * @brief Called by editable UI controls when a pan gesture occurs.
687 * @param[in] state The state of the gesture.
688 * @param[in] displacement This distance panned since the last pan gesture.
690 void PanEvent( Gesture::State state, const Vector2& displacement );
693 * @brief Called by editable UI controls when a long press gesture occurs.
695 * @param[in] state The state of the gesture.
696 * @param[in] x The x position relative to the top-left of the parent control.
697 * @param[in] y The y position relative to the top-left of the parent control.
699 void LongPressEvent( Gesture::State state, float x, float y );
702 * @brief Creates a selection event.
704 * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
706 * @param[in] x The x position relative to the top-left of the parent control.
707 * @param[in] y The y position relative to the top-left of the parent control.
708 * @param[in] selectAll Whether the whole text is selected.
710 void SelectEvent( float x, float y, bool selectAll );
713 * @brief Event received from IMF manager
715 * @param[in] imfManager The IMF manager.
716 * @param[in] imfEvent The event received.
717 * @return A data struture indicating if update is needed, cursor position and current text.
719 ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
722 * @brief Paste given string into Text model
723 * @param[in] stringToPaste this string will be inserted into the text model
725 void PasteText( const std::string& stringToPaste );
728 * @brief Event from Clipboard notifying an Item has been selected for pasting
730 void PasteClipboardItemEvent();
733 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
735 virtual void GetTargetSize( Vector2& targetSize );
738 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
740 virtual void AddDecoration( Actor& actor, bool needsClipping );
743 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
745 virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
748 * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
750 virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
755 * @brief A reference counted object may only be deleted by calling Unreference().
757 virtual ~Controller();
762 * @brief Helper to KeyEvent() to handle the backspace case.
764 * @return True if a character was deleted.
766 bool BackspaceKeyEvent();
769 * @brief Helper to notify IMF manager with surrounding text & cursor changes.
771 void NotifyImfManager();
774 * @brief Helper to clear font-specific data.
776 void ShowPlaceholderText();
779 * @brief Helper to clear font-specific data (only).
781 void ClearFontData();
784 * @brief Helper to clear text's style data.
786 void ClearStyleData();
789 * @brief Private constructor.
791 Controller( ControlInterface& controlInterface );
794 Controller( const Controller& handle );
797 Controller& operator=( const Controller& handle );
807 } // namespace Toolkit
811 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__