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 Set the default font style.
195 * @param[in] defaultFontStyle The default font style.
197 void SetDefaultFontStyle( const std::string& defaultFontStyle );
200 * @brief Retrieve the default font style.
202 * @return The default font style.
204 const std::string& GetDefaultFontStyle() const;
207 * @brief Set the default point size.
209 * @param[in] defaultFontStyle The default point size.
211 void SetDefaultPointSize( float pointSize );
214 * @brief Retrieve the default point size.
216 * @return The default point size.
218 float GetDefaultPointSize() const;
221 * @ brief Update the text after a font change
222 * @param[in] newDefaultFont The new font to change to
224 void UpdateAfterFontChange( std::string& newDefaultFont );
227 * @brief Set the text color
229 * @param textColor The text color
231 void SetTextColor( const Vector4& textColor );
234 * @brief Retrieve the text color
236 * @return The text color
238 const Vector4& GetTextColor() const;
241 * @brief Set the text color
243 * @param textColor The text color
245 void SetPlaceholderTextColor( const Vector4& textColor );
248 * @brief Retrieve the text color
250 * @return The text color
252 const Vector4& GetPlaceholderTextColor() const;
255 * @brief Set the shadow offset.
257 * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
259 void SetShadowOffset( const Vector2& shadowOffset );
262 * @brief Retrieve the shadow offset.
264 * @return The shadow offset.
266 const Vector2& GetShadowOffset() const;
269 * @brief Set the shadow color.
271 * @param[in] shadowColor The shadow color.
273 void SetShadowColor( const Vector4& shadowColor );
276 * @brief Retrieve the shadow color.
278 * @return The shadow color.
280 const Vector4& GetShadowColor() const;
283 * @brief Set the underline color.
285 * @param[in] color color of underline.
287 void SetUnderlineColor( const Vector4& color );
290 * @brief Retrieve the underline color.
292 * @return The underline color.
294 const Vector4& GetUnderlineColor() const;
297 * @brief Set the underline enabled flag.
299 * @param[in] enabled The underline enabled flag.
301 void SetUnderlineEnabled( bool enabled );
304 * @brief Returns whether the text is underlined or not.
306 * @return The underline state.
308 bool IsUnderlineEnabled() const;
311 * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
313 * @param[in] height The height in pixels of the underline
315 void SetUnderlineHeight( float height );
318 * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
320 * @return The height of the underline, or 0 if height is not overrided.
322 float GetUnderlineHeight() const;
325 * @brief Called to enable/disable cursor blink.
327 * @note Only editable controls should calls this.
328 * @param[in] enabled Whether the cursor should blink or not.
330 void SetEnableCursorBlink( bool enable );
333 * @brief Query whether cursor blink is enabled.
335 * @return Whether the cursor should blink or not.
337 bool GetEnableCursorBlink() const;
340 * @brief Query the current scroll position; the UI control is responsible for moving actors to this position.
342 * @return The scroll position.
344 const Vector2& GetScrollPosition() const;
347 * @brief Query the alignment offset.
349 * @return The alignmnet offset.
351 const Vector2& GetAlignmentOffset() const;
354 * @copydoc Control::GetNaturalSize()
356 Vector3 GetNaturalSize();
359 * @copydoc Control::GetHeightForWidth()
361 float GetHeightForWidth( float width );
364 * @brief Triggers a relayout which updates View (if necessary).
366 * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
367 * @param[in] size A the size of a bounding box to layout text within.
368 * @return True if the text model or decorations were updated.
370 bool Relayout( const Size& size );
373 * @brief Process queued events which modify the model.
375 void ProcessModifyEvents();
378 * @brief Used to remove placeholder text.
383 * @brief Used to reset the cursor position after setting a new text.
385 * @param[in] cursorIndex Where to place the cursor.
387 void ResetCursorPosition( CharacterIndex cursorIndex );
390 * @brief Used to reset the scroll position after setting a new text.
392 void ResetScrollPosition();
395 * @brief Used to process an event queued from SetText()
397 void TextReplacedEvent();
400 * @brief Used to process an event queued from key events etc.
402 void TextInsertedEvent();
405 * @brief Used to process an event queued from backspace key etc.
407 void TextDeletedEvent();
410 * @brief Lays-out the text.
412 * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
414 * @param[in] size A the size of a bounding box to layout text within.
415 * @param[in] operations The layout operations which need to be done.
416 * @param[out] layoutSize The size of the laid-out text.
418 bool DoRelayout( const Size& size,
419 OperationsMask operations,
423 * @brief Whether to enable the multi-line layout.
425 * @param[in] enable \e true enables the multi-line (by default)
427 void SetMultiLineEnabled( bool enable );
430 * @return Whether the multi-line layout is enabled.
432 bool IsMultiLineEnabled() const;
435 * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment()
437 void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment );
440 * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment()
442 LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const;
445 * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment()
447 void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment );
450 * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment()
452 LayoutEngine::VerticalAlignment GetVerticalAlignment() const;
455 * @brief Calulates the alignment of the whole text inside the bounding box.
457 * @param[in] size The size of the bounding box.
459 void CalculateTextAlignment( const Size& size );
462 * @brief Return the layout engine.
464 * @return A reference to the layout engine.
466 LayoutEngine& GetLayoutEngine();
469 * @brief Return a view of the text.
471 * @return A reference to the view.
475 // Text-input Event Queuing
478 * @brief Called by editable UI controls when keyboard focus is gained.
480 void KeyboardFocusGainEvent();
483 * @brief Called by editable UI controls when focus is lost.
485 void KeyboardFocusLostEvent();
488 * @brief Called by editable UI controls when key events are received.
490 * @param[in] event The key event.
491 * @param[in] type Used to distinguish between regular key events and IMF events.
493 bool KeyEvent( const Dali::KeyEvent& event );
496 * @brief Called by editable UI controls when key events are received.
498 * @param[in] text The text to insert.
499 * @param[in] type Used to distinguish between regular key events and IMF events.
501 void InsertText( const std::string& text, InsertType type );
504 * @brief Checks if text is selected and if so removes it.
505 * @return true if text was removed
507 bool RemoveSelectedText();
510 * @brief Called by editable UI controls when a tap gesture occurs.
511 * @param[in] tapCount The number of taps.
512 * @param[in] x The x position relative to the top-left of the parent control.
513 * @param[in] y The y position relative to the top-left of the parent control.
515 void TapEvent( unsigned int tapCount, float x, float y );
518 * @brief Called by editable UI controls when a pan gesture occurs.
520 * @param[in] state The state of the gesture.
521 * @param[in] displacement This distance panned since the last pan gesture.
523 void PanEvent( Gesture::State state, const Vector2& displacement );
526 * @brief Called by editable UI controls when a long press gesture occurs.
528 * @param[in] state The state of the gesture.
529 * @param[in] x The x position relative to the top-left of the parent control.
530 * @param[in] y The y position relative to the top-left of the parent control.
532 void LongPressEvent( Gesture::State state, float x, float y );
535 * @brief Creates a selection event.
537 * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
539 * @param[in] x The x position relative to the top-left of the parent control.
540 * @param[in] y The y position relative to the top-left of the parent control.
541 * @param[in] selectAll Whether the whole text is selected.
543 void SelectEvent( float x, float y, bool selectAll );
546 * @brief Event received from IMF manager
548 * @param[in] imfManager The IMF manager.
549 * @param[in] imfEvent The event received.
550 * @return A data struture indicating if update is needed, cursor position and current text.
552 ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
555 * @brief Paste given string into Text model
556 * @param[in] stringToPaste this string will be inserted into the text model
558 void PasteText( const std::string& stringToPaste );
561 * @brief Event from Clipboard notifying an Item has been selected for pasting
563 void PasteClipboardItemEvent();
566 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
568 virtual void GetTargetSize( Vector2& targetSize );
571 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
573 virtual void AddDecoration( Actor& actor, bool needsClipping );
576 * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
578 virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
581 * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
583 virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
588 * @brief A reference counted object may only be deleted by calling Unreference().
590 virtual ~Controller();
595 * @brief Helper to KeyEvent() to handle the backspace case.
597 * @return True if a character was deleted.
599 bool BackspaceKeyEvent();
602 * @brief Helper to clear font-specific data.
604 void ShowPlaceholderText();
607 * @brief Helper to clear all the model data except for LogicalModel::mText.
609 void ClearModelData();
612 * @brief Helper to clear font-specific data (only).
614 void ClearFontData();
617 * @brief Private constructor.
619 Controller( ControlInterface& controlInterface );
622 Controller( const Controller& handle );
625 Controller& operator=( const Controller& handle );
635 } // namespace Toolkit
639 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__