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 Replaces any text previously set.
119 * @note This will be converted into UTF-32 when stored in the text model.
120 * @param[in] text A string of UTF-8 characters.
122 void SetText( const std::string& text );
125 * @brief Retrieve any text previously set.
127 * @return A string of UTF-8 characters.
129 void GetText( std::string& text ) const;
132 * @brief Remove a given number of characters
134 * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
135 * @param[in] numberOfChars The number of characters to delete from the cursorOffset.
136 * @return True if the remove was successful.
138 bool RemoveText( int cursorOffset, int numberOfChars );
141 * @brief Retrieve the current cursor position.
143 * @return The cursor position.
145 unsigned int GetLogicalCursorPosition() const;
148 * @brief Replaces any placeholder text previously set.
150 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
151 * @param[in] text A string of UTF-8 characters.
153 void SetPlaceholderText( PlaceholderType type, const std::string& text );
156 * @brief Retrieve any placeholder text previously set.
158 * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
159 * @param[out] A string of UTF-8 characters.
161 void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
164 * @brief Sets the maximum number of characters that can be inserted into the TextModel
166 * @param[in] maxCharacters maximum number of characters to be accepted
168 void SetMaximumNumberOfCharacters( int maxCharacters );
171 * @brief Sets the maximum number of characters that can be inserted into the TextModel
173 * @param[in] maxCharacters maximum number of characters to be accepted
175 int GetMaximumNumberOfCharacters();
178 * @brief Set the default font family.
180 * @param[in] defaultFontFamily The default font family.
181 * @param[in] userDefined If set by the user
183 void SetDefaultFontFamily( const std::string& defaultFontFamily, bool userDefined );
186 * @brief Retrieve the default font family.
188 * @return The default font family.
190 const std::string& GetDefaultFontFamily() const;
193 * @brief Sets the font's style string.
195 * @note The style set may be changed by the underlying font system. The string is stored to be recovered.
197 * @param[in] style The font's style string.
199 void SetDefaultFontStyle( const std::string& style );
202 * @brief Retrieves the font's style.
204 * @return The font's style.
206 const std::string& GetDefaultFontStyle() const;
209 * @brief Sets the default font width.
211 * @param[in] width The font width.
213 void SetDefaultFontWidth( FontWidth width );
216 * @brief Retrieves the default font width.
218 * @return The default font width.
220 FontWidth GetDefaultFontWidth() const;
223 * @brief Sets the default font weight.
225 * @param[in] weight The font weight.
227 void SetDefaultFontWeight( FontWeight weight );
230 * @brief Retrieves the default font weight.
232 * @return The default font weight.
234 FontWeight GetDefaultFontWeight() const;
237 * @brief Sets the default font slant.
239 * @param[in] slant The font slant.
241 void SetDefaultFontSlant( FontSlant slant );
244 * @brief Retrieves the default font slant.
246 * @return The default font slant.
248 FontSlant GetDefaultFontSlant() const;
251 * @brief Set the default point size.
253 * @param[in] pointSize The default point size.
255 void SetDefaultPointSize( float pointSize );
258 * @brief Retrieve the default point size.
260 * @return The default point size.
262 float GetDefaultPointSize() const;
265 * @ brief Update the text after a font change
266 * @param[in] newDefaultFont The new font to change to
268 void UpdateAfterFontChange( std::string& newDefaultFont );
271 * @brief Set the text color
273 * @param textColor The text color
275 void SetTextColor( const Vector4& textColor );
278 * @brief Retrieve the text color
280 * @return The text color
282 const Vector4& GetTextColor() const;
285 * @brief Set the text color
287 * @param textColor The text color
289 void SetPlaceholderTextColor( const Vector4& textColor );
292 * @brief Retrieve the text color
294 * @return The text color
296 const Vector4& GetPlaceholderTextColor() const;
299 * @brief Set the shadow offset.
301 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
303 void SetShadowOffset( const Vector2& shadowOffset );
306 * @brief Retrieve the shadow offset.
308 * @return The shadow offset.
310 const Vector2& GetShadowOffset() const;
313 * @brief Set the shadow color.
315 * @param[in] shadowColor The shadow color.
317 void SetShadowColor( const Vector4& shadowColor );
320 * @brief Retrieve the shadow color.
322 * @return The shadow color.
324 const Vector4& GetShadowColor() const;
327 * @brief Set the underline color.
329 * @param[in] color color of underline.
331 void SetUnderlineColor( const Vector4& color );
334 * @brief Retrieve the underline color.
336 * @return The underline color.
338 const Vector4& GetUnderlineColor() const;
341 * @brief Set the underline enabled flag.
343 * @param[in] enabled The underline enabled flag.
345 void SetUnderlineEnabled( bool enabled );
348 * @brief Returns whether the text is underlined or not.
350 * @return The underline state.
352 bool IsUnderlineEnabled() const;
355 * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
357 * @param[in] height The height in pixels of the underline
359 void SetUnderlineHeight( float height );
362 * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
364 * @return The height of the underline, or 0 if height is not overrided.
366 float GetUnderlineHeight() const;
369 * @brief Called to enable/disable cursor blink.
371 * @note Only editable controls should calls this.
372 * @param[in] enabled Whether the cursor should blink or not.
374 void SetEnableCursorBlink( bool enable );
377 * @brief Query whether cursor blink is enabled.
379 * @return Whether the cursor should blink or not.
381 bool GetEnableCursorBlink() const;
384 * @brief Query the current scroll position; the UI control is responsible for moving actors to this position.
386 * @return The scroll position.
388 const Vector2& GetScrollPosition() const;
391 * @brief Query the alignment offset.
393 * @return The alignmnet offset.
395 const Vector2& GetAlignmentOffset() const;
398 * @copydoc Control::GetNaturalSize()
400 Vector3 GetNaturalSize();
403 * @copydoc Control::GetHeightForWidth()
405 float GetHeightForWidth( float width );
408 * @brief Triggers a relayout which updates View (if necessary).
410 * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
411 * @param[in] size A the size of a bounding box to layout text within.
412 * @return True if the text model or decorations were updated.
414 bool Relayout( const Size& size );
417 * @brief Process queued events which modify the model.
419 void ProcessModifyEvents();
422 * @brief Used to remove placeholder text.
427 * @brief Used to reset the cursor position after setting a new text.
429 * @param[in] cursorIndex Where to place the cursor.
431 void ResetCursorPosition( CharacterIndex cursorIndex );
434 * @brief Used to reset the scroll position after setting a new text.
436 void ResetScrollPosition();
439 * @brief Used to process an event queued from SetText()
441 void TextReplacedEvent();
444 * @brief Used to process an event queued from key events etc.
446 void TextInsertedEvent();
449 * @brief Used to process an event queued from backspace key etc.
451 void TextDeletedEvent();
454 * @brief Lays-out the text.
456 * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
458 * @param[in] size A the size of a bounding box to layout text within.
459 * @param[in] operations The layout operations which need to be done.
460 * @param[out] layoutSize The size of the laid-out text.
462 bool DoRelayout( const Size& size,
463 OperationsMask operations,
467 * @brief Whether to enable the multi-line layout.
469 * @param[in] enable \e true enables the multi-line (by default)
471 void SetMultiLineEnabled( bool enable );
474 * @return Whether the multi-line layout is enabled.
476 bool IsMultiLineEnabled() const;
479 * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment()
481 void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment );
484 * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment()
486 LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const;
489 * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment()
491 void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment );
494 * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment()
496 LayoutEngine::VerticalAlignment GetVerticalAlignment() const;
499 * @brief Calulates the alignment of the whole text inside the bounding box.
501 * @param[in] size The size of the bounding box.
503 void CalculateTextAlignment( const Size& size );
506 * @brief Return the layout engine.
508 * @return A reference to the layout engine.
510 LayoutEngine& GetLayoutEngine();
513 * @brief Return a view of the text.
515 * @return A reference to the view.
519 // Text-input Event Queuing
522 * @brief Called by editable UI controls when keyboard focus is gained.
524 void KeyboardFocusGainEvent();
527 * @brief Called by editable UI controls when focus is lost.
529 void KeyboardFocusLostEvent();
532 * @brief Called by editable UI controls when key events are received.
534 * @param[in] event The key event.
535 * @param[in] type Used to distinguish between regular key events and IMF events.
537 bool KeyEvent( const Dali::KeyEvent& event );
540 * @brief Called by editable UI controls when key events are received.
542 * @param[in] text The text to insert.
543 * @param[in] type Used to distinguish between regular key events and IMF events.
545 void InsertText( const std::string& text, InsertType type );
548 * @brief Checks if text is selected and if so removes it.
549 * @return true if text was removed
551 bool RemoveSelectedText();
554 * @brief Called by editable UI controls when a tap gesture occurs.
555 * @param[in] tapCount The number of taps.
556 * @param[in] x The x position relative to the top-left of the parent control.
557 * @param[in] y The y position relative to the top-left of the parent control.
559 void TapEvent( unsigned int tapCount, float x, float y );
562 * @brief Called by editable UI controls when a pan gesture occurs.
564 * @param[in] state The state of the gesture.
565 * @param[in] displacement This distance panned since the last pan gesture.
567 void PanEvent( Gesture::State state, const Vector2& displacement );
570 * @brief Called by editable UI controls when a long press gesture occurs.
572 * @param[in] state The state of the gesture.
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 LongPressEvent( Gesture::State state, float x, float y );
579 * @brief Creates a selection event.
581 * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
583 * @param[in] x The x position relative to the top-left of the parent control.
584 * @param[in] y The y position relative to the top-left of the parent control.
585 * @param[in] selectAll Whether the whole text is selected.
587 void SelectEvent( float x, float y, bool selectAll );
590 * @brief Event received from IMF manager
592 * @param[in] imfManager The IMF manager.
593 * @param[in] imfEvent The event received.
594 * @return A data struture indicating if update is needed, cursor position and current text.
596 ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
599 * @brief Paste given string into Text model
600 * @param[in] stringToPaste this string will be inserted into the text model
602 void PasteText( const std::string& stringToPaste );
605 * @brief Event from Clipboard notifying an Item has been selected for pasting
607 void PasteClipboardItemEvent();
610 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
612 virtual void GetTargetSize( Vector2& targetSize );
615 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
617 virtual void AddDecoration( Actor& actor, bool needsClipping );
620 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
622 virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
625 * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
627 virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
632 * @brief A reference counted object may only be deleted by calling Unreference().
634 virtual ~Controller();
639 * @brief Helper to KeyEvent() to handle the backspace case.
641 * @return True if a character was deleted.
643 bool BackspaceKeyEvent();
646 * @brief Helper to notify IMF manager with surrounding text & cursor changes.
648 void NotifyImfManager();
651 * @brief Helper to clear font-specific data.
653 void ShowPlaceholderText();
656 * @brief Helper to clear all the model data except for LogicalModel::mText.
658 void ClearModelData();
661 * @brief Helper to clear font-specific data (only).
663 void ClearFontData();
666 * @brief Private constructor.
668 Controller( ControlInterface& controlInterface );
671 Controller( const Controller& handle );
674 Controller& operator=( const Controller& handle );
684 } // namespace Toolkit
688 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__