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,
88 ALL_OPERATIONS = 0xFFFF
92 * @brief Used to distinguish between regular key events and IMF events
101 * @brief Create a new instance of a Controller.
103 * @param[in] controlInterface An interface used to request a text relayout.
104 * @return A pointer to a new Controller.
106 static ControllerPtr New( ControlInterface& controlInterface );
109 * @brief Called to enable text input.
111 * @note Selectable or editable controls should call this once after Controller::New().
112 * @param[in] decorator Used to create cursor, selection handle decorations etc.
114 void EnableTextInput( DecoratorPtr decorator );
117 * @brief Enables/disables the mark-up processor.
119 * By default is disabled.
121 * @param[in] enable Whether to enable the mark-up processor.
123 void SetMarkupProcessorEnabled( bool enable );
126 * @brief Retrieves whether the mark-up processor is enabled.
128 * By default is disabled.
130 * @return @e true if the mark-up processor is enabled, otherwise returns @e false.
132 bool IsMarkupProcessorEnabled() const;
135 * @brief Replaces any text previously set.
137 * @note This will be converted into UTF-32 when stored in the text model.
138 * @param[in] text A string of UTF-8 characters.
140 void SetText( const std::string& text );
143 * @brief Retrieve any text previously set.
145 * @return A string of UTF-8 characters.
147 void GetText( std::string& text ) const;
150 * @brief Remove a given number of characters
152 * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
153 * @param[in] numberOfChars The number of characters to delete from the cursorOffset.
154 * @return True if the remove was successful.
156 bool RemoveText( int cursorOffset, int numberOfChars );
159 * @brief Retrieve the current cursor position.
161 * @return The cursor position.
163 unsigned int GetLogicalCursorPosition() const;
166 * @brief Replaces any placeholder text previously set.
168 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
169 * @param[in] text A string of UTF-8 characters.
171 void SetPlaceholderText( PlaceholderType type, const std::string& text );
174 * @brief Retrieve any placeholder text previously set.
176 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
177 * @param[out] A string of UTF-8 characters.
179 void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
182 * @brief Sets the maximum number of characters that can be inserted into the TextModel
184 * @param[in] maxCharacters maximum number of characters to be accepted
186 void SetMaximumNumberOfCharacters( int maxCharacters );
189 * @brief Sets the maximum number of characters that can be inserted into the TextModel
191 * @param[in] maxCharacters maximum number of characters to be accepted
193 int GetMaximumNumberOfCharacters();
196 * @brief Set the default font family.
198 * @param[in] defaultFontFamily The default font family.
200 void SetDefaultFontFamily( const std::string& defaultFontFamily );
203 * @brief Retrieve the default font family.
205 * @return The default font family.
207 const std::string& GetDefaultFontFamily() const;
210 * @brief Sets the font's style string.
212 * @note The style set may be changed by the underlying font system. The string is stored to be recovered.
214 * @param[in] style The font's style string.
216 void SetDefaultFontStyle( const std::string& style );
219 * @brief Retrieves the font's style.
221 * @return The font's style.
223 const std::string& GetDefaultFontStyle() const;
226 * @brief Sets the default font width.
228 * @param[in] width The font width.
230 void SetDefaultFontWidth( FontWidth width );
233 * @brief Retrieves the default font width.
235 * @return The default font width.
237 FontWidth GetDefaultFontWidth() const;
240 * @brief Sets the default font weight.
242 * @param[in] weight The font weight.
244 void SetDefaultFontWeight( FontWeight weight );
247 * @brief Retrieves the default font weight.
249 * @return The default font weight.
251 FontWeight GetDefaultFontWeight() const;
254 * @brief Sets the default font slant.
256 * @param[in] slant The font slant.
258 void SetDefaultFontSlant( FontSlant slant );
261 * @brief Retrieves the default font slant.
263 * @return The default font slant.
265 FontSlant GetDefaultFontSlant() const;
268 * @brief Set the default point size.
270 * @param[in] pointSize The default point size.
272 void SetDefaultPointSize( float pointSize );
275 * @brief Retrieve the default point size.
277 * @return The default point size.
279 float GetDefaultPointSize() const;
282 * @ brief Update the text after a font change
283 * @param[in] newDefaultFont The new font to change to
285 void UpdateAfterFontChange( std::string& newDefaultFont );
288 * @brief Set the text color
290 * @param textColor The text color
292 void SetTextColor( const Vector4& textColor );
295 * @brief Retrieve the text color
297 * @return The text color
299 const Vector4& GetTextColor() const;
302 * @brief Set the text color
304 * @param textColor The text color
306 void SetPlaceholderTextColor( const Vector4& textColor );
309 * @brief Retrieve the text color
311 * @return The text color
313 const Vector4& GetPlaceholderTextColor() const;
316 * @brief Set the shadow offset.
318 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
320 void SetShadowOffset( const Vector2& shadowOffset );
323 * @brief Retrieve the shadow offset.
325 * @return The shadow offset.
327 const Vector2& GetShadowOffset() const;
330 * @brief Set the shadow color.
332 * @param[in] shadowColor The shadow color.
334 void SetShadowColor( const Vector4& shadowColor );
337 * @brief Retrieve the shadow color.
339 * @return The shadow color.
341 const Vector4& GetShadowColor() const;
344 * @brief Set the underline color.
346 * @param[in] color color of underline.
348 void SetUnderlineColor( const Vector4& color );
351 * @brief Retrieve the underline color.
353 * @return The underline color.
355 const Vector4& GetUnderlineColor() const;
358 * @brief Set the underline enabled flag.
360 * @param[in] enabled The underline enabled flag.
362 void SetUnderlineEnabled( bool enabled );
365 * @brief Returns whether the text is underlined or not.
367 * @return The underline state.
369 bool IsUnderlineEnabled() const;
372 * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
374 * @param[in] height The height in pixels of the underline
376 void SetUnderlineHeight( float height );
379 * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
381 * @return The height of the underline, or 0 if height is not overrided.
383 float GetUnderlineHeight() const;
386 * @brief Called to enable/disable cursor blink.
388 * @note Only editable controls should calls this.
389 * @param[in] enabled Whether the cursor should blink or not.
391 void SetEnableCursorBlink( bool enable );
394 * @brief Query whether cursor blink is enabled.
396 * @return Whether the cursor should blink or not.
398 bool GetEnableCursorBlink() const;
401 * @brief Query the current scroll position; the UI control is responsible for moving actors to this position.
403 * @return The scroll position.
405 const Vector2& GetScrollPosition() const;
408 * @brief Query the alignment offset.
410 * @return The alignmnet offset.
412 const Vector2& GetAlignmentOffset() const;
415 * @copydoc Control::GetNaturalSize()
417 Vector3 GetNaturalSize();
420 * @copydoc Control::GetHeightForWidth()
422 float GetHeightForWidth( float width );
425 * @brief Triggers a relayout which updates View (if necessary).
427 * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
428 * @param[in] size A the size of a bounding box to layout text within.
429 * @return True if the text model or decorations were updated.
431 bool Relayout( const Size& size );
434 * @brief Process queued events which modify the model.
436 void ProcessModifyEvents();
439 * @brief Used to remove placeholder text.
444 * @brief Used to reset the cursor position after setting a new text.
446 * @param[in] cursorIndex Where to place the cursor.
448 void ResetCursorPosition( CharacterIndex cursorIndex );
451 * @brief Used to reset the scroll position after setting a new text.
453 void ResetScrollPosition();
456 * @brief Used to process an event queued from SetText()
458 void TextReplacedEvent();
461 * @brief Used to process an event queued from key events etc.
463 void TextInsertedEvent();
466 * @brief Used to process an event queued from backspace key etc.
468 void TextDeletedEvent();
471 * @brief Lays-out the text.
473 * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
475 * @param[in] size A the size of a bounding box to layout text within.
476 * @param[in] operations The layout operations which need to be done.
477 * @param[out] layoutSize The size of the laid-out text.
479 bool DoRelayout( const Size& size,
480 OperationsMask operations,
484 * @brief Whether to enable the multi-line layout.
486 * @param[in] enable \e true enables the multi-line (by default)
488 void SetMultiLineEnabled( bool enable );
491 * @return Whether the multi-line layout is enabled.
493 bool IsMultiLineEnabled() const;
496 * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment()
498 void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment );
501 * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment()
503 LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const;
506 * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment()
508 void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment );
511 * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment()
513 LayoutEngine::VerticalAlignment GetVerticalAlignment() const;
516 * @brief Calulates the alignment of the whole text inside the bounding box.
518 * @param[in] size The size of the bounding box.
520 void CalculateTextAlignment( const Size& size );
523 * @brief Return the layout engine.
525 * @return A reference to the layout engine.
527 LayoutEngine& GetLayoutEngine();
530 * @brief Return a view of the text.
532 * @return A reference to the view.
536 // Text-input Event Queuing
539 * @brief Called by editable UI controls when keyboard focus is gained.
541 void KeyboardFocusGainEvent();
544 * @brief Called by editable UI controls when focus is lost.
546 void KeyboardFocusLostEvent();
549 * @brief Called by editable UI controls when key events are received.
551 * @param[in] event The key event.
552 * @param[in] type Used to distinguish between regular key events and IMF events.
554 bool KeyEvent( const Dali::KeyEvent& event );
557 * @brief Called by editable UI controls when key events are received.
559 * @param[in] text The text to insert.
560 * @param[in] type Used to distinguish between regular key events and IMF events.
562 void InsertText( const std::string& text, InsertType type );
565 * @brief Checks if text is selected and if so removes it.
566 * @return true if text was removed
568 bool RemoveSelectedText();
571 * @brief Called by editable UI controls when a tap gesture occurs.
572 * @param[in] tapCount The number of taps.
573 * @param[in] x The x position relative to the top-left of the parent control.
574 * @param[in] y The y position relative to the top-left of the parent control.
576 void TapEvent( unsigned int tapCount, float x, float y );
579 * @brief Called by editable UI controls when a pan gesture occurs.
581 * @param[in] state The state of the gesture.
582 * @param[in] displacement This distance panned since the last pan gesture.
584 void PanEvent( Gesture::State state, const Vector2& displacement );
587 * @brief Called by editable UI controls when a long press gesture occurs.
589 * @param[in] state The state of the gesture.
590 * @param[in] x The x position relative to the top-left of the parent control.
591 * @param[in] y The y position relative to the top-left of the parent control.
593 void LongPressEvent( Gesture::State state, float x, float y );
596 * @brief Creates a selection event.
598 * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
600 * @param[in] x The x position relative to the top-left of the parent control.
601 * @param[in] y The y position relative to the top-left of the parent control.
602 * @param[in] selectAll Whether the whole text is selected.
604 void SelectEvent( float x, float y, bool selectAll );
607 * @brief Event received from IMF manager
609 * @param[in] imfManager The IMF manager.
610 * @param[in] imfEvent The event received.
611 * @return A data struture indicating if update is needed, cursor position and current text.
613 ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
616 * @brief Paste given string into Text model
617 * @param[in] stringToPaste this string will be inserted into the text model
619 void PasteText( const std::string& stringToPaste );
622 * @brief Event from Clipboard notifying an Item has been selected for pasting
624 void PasteClipboardItemEvent();
627 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
629 virtual void GetTargetSize( Vector2& targetSize );
632 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
634 virtual void AddDecoration( Actor& actor, bool needsClipping );
637 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
639 virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
642 * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
644 virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
649 * @brief A reference counted object may only be deleted by calling Unreference().
651 virtual ~Controller();
656 * @brief Helper to KeyEvent() to handle the backspace case.
658 * @return True if a character was deleted.
660 bool BackspaceKeyEvent();
663 * @brief Helper to notify IMF manager with surrounding text & cursor changes.
665 void NotifyImfManager();
668 * @brief Helper to clear font-specific data.
670 void ShowPlaceholderText();
673 * @brief Helper to clear all the model data except for LogicalModel::mText.
675 void ClearModelData();
678 * @brief Helper to clear font-specific data (only).
680 void ClearFontData();
683 * @brief Private constructor.
685 Controller( ControlInterface& controlInterface );
688 Controller( const Controller& handle );
691 Controller& operator=( const Controller& handle );
701 } // namespace Toolkit
705 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__