1 #ifndef DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H
2 #define DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_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/clipboard.h>
23 #include <dali/devel-api/text-abstraction/font-client.h>
26 #include <dali-toolkit/internal/text/input-style.h>
27 #include <dali-toolkit/internal/text/text-controller.h>
28 #include <dali-toolkit/internal/text/text-model.h>
29 #include <dali-toolkit/internal/text/text-view.h>
30 #include <dali-toolkit/public-api/styling/style-manager.h>
31 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
42 //Forward declarations
48 // Used to queue input events until DoRelayout()
56 LEFT_SELECTION_HANDLE_EVENT,
57 RIGHT_SELECTION_HANDLE_EVENT,
69 Event( Type eventType )
92 EDITING_WITH_GRAB_HANDLE,
93 EDITING_WITH_PASTE_POPUP,
95 SELECTION_HANDLE_PANNING,
99 EventData( DecoratorPtr decorator );
103 static bool IsEditingState( State stateToCheck )
105 return ( stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP );
108 DecoratorPtr mDecorator; ///< Pointer to the decorator.
109 ImfManager mImfManager; ///< The Input Method Framework Manager.
110 FontDefaults* mPlaceholderFont; ///< The placeholder default font.
111 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus.
112 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
113 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color.
116 * This is used to delay handling events until after the model has been updated.
117 * The number of updates to the model is minimized to improve performance.
119 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
121 Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
123 InputStyle mInputStyle; ///< The style to be set to the new inputed text.
125 State mPreviousState; ///< Stores the current state before it's updated with the new one.
126 State mState; ///< Selection mode, edit mode etc.
128 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
129 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
130 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
132 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
133 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
135 float mCursorHookPositionX; ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles.
137 Controller::NoTextTap::Action mDoubleTapAction; ///< Action to be done when there is a double tap on top of 'no text'
138 Controller::NoTextTap::Action mLongPressAction; ///< Action to be done when there is a long press on top of 'no text'
140 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
141 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
142 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
143 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
144 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
145 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
146 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
147 bool mUpdateCursorHookPosition : 1; ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
148 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
149 bool mUpdateGrabHandlePosition : 1; ///< True if the visual position of the grab handle must be recalculated.
150 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
151 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
152 bool mIsLeftHandleSelected : 1; ///< Whether is the left handle the one which is selected.
153 bool mIsRightHandleSelected : 1; ///< Whether is the right handle the one which is selected.
154 bool mUpdateHighlightBox : 1; ///< True if the text selection high light box must be updated.
155 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
156 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
157 bool mAllTextSelected : 1; ///< True if the selection handles are selecting all the text.
158 bool mUpdateInputStyle : 1; ///< Whether to update the input style after moving the cursor.
159 bool mPasswordInput : 1; ///< True if password input is enabled.
160 bool mCheckScrollAmount : 1; ///< Whether to check scrolled amount after updating the position
161 bool mIsPlaceholderPixelSize : 1; ///< True if the placeholder font size is set as pixel size.
162 bool mIsPlaceholderElideEnabled : 1; ///< True if the placeholder text's elide is enabled.
163 bool mPlaceholderEllipsisFlag : 1; ///< True if the text controller sets the placeholder ellipsis.
170 TEXT_REPLACED, ///< The entire text was replaced
171 TEXT_INSERTED, ///< Insert characters at the current cursor position
172 TEXT_DELETED ///< Characters were deleted
181 : mFontDescription(),
182 mDefaultPointSize( 0.f ),
184 familyDefined( false ),
185 weightDefined( false ),
186 widthDefined( false ),
187 slantDefined( false ),
190 // Initially use the default platform font
191 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
192 fontClient.GetDefaultPlatformFontDescription( mFontDescription );
195 FontId GetFontId( TextAbstraction::FontClient& fontClient )
199 const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( mDefaultPointSize * 64.f );
200 mFontId = fontClient.GetFontId( mFontDescription, pointSize );
206 TextAbstraction::FontDescription mFontDescription; ///< The default font's description.
207 float mDefaultPointSize; ///< The default font's point size.
208 FontId mFontId; ///< The font's id of the default font.
209 bool familyDefined:1; ///< Whether the default font's family name is defined.
210 bool weightDefined:1; ///< Whether the default font's weight is defined.
211 bool widthDefined:1; ///< Whether the default font's width is defined.
212 bool slantDefined:1; ///< Whether the default font's slant is defined.
213 bool sizeDefined:1; ///< Whether the default font's point size is defined.
217 * @brief Stores indices used to update the text.
218 * Stores the character index where the text is updated and the number of characters removed and added.
219 * Stores as well indices to the first and the last paragraphs to be updated.
221 struct TextUpdateInfo
224 : mCharacterIndex( 0u ),
225 mNumberOfCharactersToRemove( 0u ),
226 mNumberOfCharactersToAdd( 0u ),
227 mPreviousNumberOfCharacters( 0u ),
228 mParagraphCharacterIndex( 0u ),
229 mRequestedNumberOfCharacters( 0u ),
230 mStartGlyphIndex( 0u ),
231 mStartLineIndex( 0u ),
232 mEstimatedNumberOfLines( 0u ),
234 mFullRelayoutNeeded( true ),
235 mIsLastCharacterNewParagraph( false )
241 CharacterIndex mCharacterIndex; ///< Index to the first character to be updated.
242 Length mNumberOfCharactersToRemove; ///< The number of characters to be removed.
243 Length mNumberOfCharactersToAdd; ///< The number of characters to be added.
244 Length mPreviousNumberOfCharacters; ///< The number of characters before the text update.
246 CharacterIndex mParagraphCharacterIndex; ///< Index of the first character of the first paragraph to be updated.
247 Length mRequestedNumberOfCharacters; ///< The requested number of characters.
248 GlyphIndex mStartGlyphIndex;
249 LineIndex mStartLineIndex;
250 Length mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting.
252 bool mClearAll:1; ///< Whether the whole text is cleared. i.e. when the text is reset.
253 bool mFullRelayoutNeeded:1; ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
254 bool mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
258 // Clear all info except the mPreviousNumberOfCharacters member.
259 mCharacterIndex = static_cast<CharacterIndex>( -1 );
260 mNumberOfCharactersToRemove = 0u;
261 mNumberOfCharactersToAdd = 0u;
262 mParagraphCharacterIndex = 0u;
263 mRequestedNumberOfCharacters = 0u;
264 mStartGlyphIndex = 0u;
265 mStartLineIndex = 0u;
266 mEstimatedNumberOfLines = 0u;
268 mFullRelayoutNeeded = false;
269 mIsLastCharacterNewParagraph = false;
273 struct UnderlineDefaults
275 std::string properties;
276 // TODO: complete with underline parameters.
279 struct ShadowDefaults
281 std::string properties;
282 // TODO: complete with shadow parameters.
285 struct EmbossDefaults
287 std::string properties;
288 // TODO: complete with emboss parameters.
291 struct OutlineDefaults
293 std::string properties;
294 // TODO: complete with outline parameters.
297 struct Controller::Impl
299 Impl( ControlInterface* controlInterface,
300 EditableControlInterface* editableControlInterface )
301 : mControlInterface( controlInterface ),
302 mEditableControlInterface( editableControlInterface ),
304 mFontDefaults( NULL ),
305 mUnderlineDefaults( NULL ),
306 mShadowDefaults( NULL ),
307 mEmbossDefaults( NULL ),
308 mOutlineDefaults( NULL ),
315 mTextColor( Color::BLACK ),
317 mOperationsPending( NO_OPERATION ),
318 mMaximumNumberOfCharacters( 50u ),
319 mHiddenInput( NULL ),
320 mRecalculateNaturalSize( true ),
321 mMarkupProcessorEnabled( false ),
322 mClipboardHideEnabled( true ),
323 mIsAutoScrollEnabled( false ),
324 mAutoScrollDirectionRTL( false ),
325 mUnderlineSetByString( false ),
326 mShadowSetByString( false ),
327 mFontStyleSetByString( false ),
328 mShouldClearFocusOnEscape( true )
330 mModel = Model::New();
332 mFontClient = TextAbstraction::FontClient::Get();
333 mClipboard = Clipboard::Get();
335 mView.SetVisualModel( mModel->mVisualModel );
337 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
338 mMetrics = Metrics::New( mFontClient );
339 mLayoutEngine.SetMetrics( mMetrics );
341 // Set the text properties to default
342 mModel->mVisualModel->SetUnderlineEnabled( false );
343 mModel->mVisualModel->SetUnderlineHeight( 0.0f );
345 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
349 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
350 if( config["clearFocusOnEscape"].Get( temp ) )
352 mShouldClearFocusOnEscape = temp;
361 delete mFontDefaults;
362 delete mUnderlineDefaults;
363 delete mShadowDefaults;
364 delete mEmbossDefaults;
365 delete mOutlineDefaults;
369 // Text Controller Implementation.
372 * @copydoc Text::Controller::RequestRelayout()
374 void RequestRelayout();
377 * @brief Request a relayout using the ControlInterface.
379 void QueueModifyEvent( ModifyEvent::Type type )
381 if( ModifyEvent::TEXT_REPLACED == type)
383 // Cancel previously queued inserts etc.
384 mModifyEvents.Clear();
389 mModifyEvents.PushBack( event );
391 // The event will be processed during relayout
396 * @brief Helper to move the cursor, grab handle etc.
398 bool ProcessInputEvents();
401 * @brief Helper to check whether any place-holder text is available.
403 bool IsPlaceholderAvailable() const
405 return ( mEventData &&
406 ( !mEventData->mPlaceholderTextInactive.empty() ||
407 !mEventData->mPlaceholderTextActive.empty() )
411 bool IsShowingPlaceholderText() const
413 return ( mEventData && mEventData->mIsShowingPlaceholderText );
417 * @brief Helper to check whether active place-holder text is available.
419 bool IsFocusedPlaceholderAvailable() const
421 return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
424 bool IsShowingRealText() const
426 return ( !IsShowingPlaceholderText() &&
427 0u != mModel->mLogicalModel->mText.Count() );
431 * @brief Called when placeholder-text is hidden
433 void PlaceholderCleared()
437 mEventData->mIsShowingPlaceholderText = false;
439 // Remove mPlaceholderTextColor
440 mModel->mVisualModel->SetTextColor( mTextColor );
444 void ClearPreEditFlag()
448 mEventData->mPreEditFlag = false;
449 mEventData->mPreEditStartPosition = 0;
450 mEventData->mPreEditLength = 0;
454 void ResetImfManager()
458 // Reset incase we are in a pre-edit state.
459 if( mEventData->mImfManager )
461 mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
469 * @brief Helper to notify IMF manager with surrounding text & cursor changes.
471 void NotifyImfManager();
474 * @brief Helper to notify IMF manager with multi line status.
476 void NotifyImfMultiLineStatus();
479 * @brief Retrieve the current cursor position.
481 * @return The cursor position.
483 CharacterIndex GetLogicalCursorPosition() const;
486 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
488 * @param[in] index The character index from where to count the number of consecutive white spaces.
490 * @return The number of consecutive white spaces.
492 Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
495 * @brief Retrieve any text previously set starting from the given @p index.
497 * @param[in] index The character index from where to retrieve the text.
498 * @param[out] text A string of UTF-8 characters.
500 * @see Dali::Toolkit::Text::Controller::GetText()
502 void GetText( CharacterIndex index, std::string& text ) const;
504 bool IsClipboardEmpty()
506 bool result( mClipboard && mClipboard.NumberOfItems() );
507 return !result; // If NumberOfItems greater than 0, return false
510 bool IsClipboardVisible()
512 bool result( mClipboard && mClipboard.IsVisible() );
517 * @brief Calculates the start character index of the first paragraph to be updated and
518 * the end character index of the last paragraph to be updated.
520 * @param[out] numberOfCharacters The number of characters to be updated.
522 void CalculateTextUpdateIndices( Length& numberOfCharacters );
525 * @brief Helper to clear completely the parts of the model specified by the given @p operations.
527 * @note It never clears the text stored in utf32.
529 void ClearFullModelData( OperationsMask operations );
532 * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
534 * @note It never clears the text stored in utf32.
536 * @param[in] startIndex Index to the first character to be cleared.
537 * @param[in] endIndex Index to the last character to be cleared.
538 * @param[in] operations The operations required.
540 void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
543 * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
545 * @note It never clears the text stored in utf32.
546 * @note Character indices are transformed to glyph indices.
548 * @param[in] startIndex Index to the first character to be cleared.
549 * @param[in] endIndex Index to the last character to be cleared.
550 * @param[in] operations The operations required.
552 void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
555 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
557 * @note It never clears the text stored in utf32.
559 * @param[in] startIndex Index to the first character to be cleared.
560 * @param[in] endIndex Index to the last character to be cleared.
561 * @param[in] operations The operations required.
563 void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
566 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
568 * When text or style changes the model is set with some operations pending.
569 * When i.e. the text's size or a relayout is required this method is called
570 * with a given @p operationsRequired parameter. The operations required are
571 * matched with the operations pending to perform the minimum number of operations.
573 * @param[in] operationsRequired The operations required.
575 * @return @e true if the model has been modified.
577 bool UpdateModel( OperationsMask operationsRequired );
580 * @brief Retreieves the default style.
582 * @param[out] inputStyle The default style.
584 void RetrieveDefaultInputStyle( InputStyle& inputStyle );
587 * @brief Retrieve the line height of the default font.
589 float GetDefaultFontLineHeight();
591 void OnCursorKeyEvent( const Event& event );
593 void OnTapEvent( const Event& event );
595 void OnPanEvent( const Event& event );
597 void OnLongPressEvent( const Event& event );
599 void OnHandleEvent( const Event& event );
601 void OnSelectEvent( const Event& event );
603 void OnSelectAllEvent();
606 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
608 * @param[out] selectedText The selected text encoded in utf8.
609 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
611 void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
613 void ShowClipboard();
615 void HideClipboard();
617 void SetClipboardHideEnable(bool enable);
619 bool CopyStringToClipboard( std::string& source );
621 void SendSelectionToClipboard( bool deleteAfterSending );
623 void RequestGetTextFromClipboard();
625 void RepositionSelectionHandles();
626 void RepositionSelectionHandles( float visualX, float visualY, Controller::NoTextTap::Action action );
628 void SetPopupButtons();
630 void ChangeState( EventData::State newState );
633 * @brief Calculates the cursor's position for a given character index in the logical order.
635 * It retrieves as well the line's height and the cursor's height and
636 * if there is a valid alternative cursor, its position and height.
638 * @param[in] logical The logical cursor position (in characters). 0 is just before the first character, a value equal to the number of characters is just after the last character.
639 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
641 void GetCursorPosition( CharacterIndex logical,
642 CursorInfo& cursorInfo );
645 * @brief Calculates the new cursor index.
647 * It takes into account that in some scripts multiple characters can form a glyph and all of them
648 * need to be jumped with one key event.
650 * @param[in] index The initial new index.
652 * @return The new cursor index.
654 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
657 * @brief Updates the cursor position.
659 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
660 * It sets the position of the secondary cursor if it's a valid one.
661 * Sets which cursors are active.
663 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
666 void UpdateCursorPosition( const CursorInfo& cursorInfo );
669 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
671 * @param[in] handleType One of the selection handles.
672 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
674 void UpdateSelectionHandle( HandleType handleType,
675 const CursorInfo& cursorInfo );
678 * @biref Clamps the horizontal scrolling to get the control always filled with text.
680 * @param[in] layoutSize The size of the laid out text.
682 void ClampHorizontalScroll( const Vector2& layoutSize );
685 * @biref Clamps the vertical scrolling to get the control always filled with text.
687 * @param[in] layoutSize The size of the laid out text.
689 void ClampVerticalScroll( const Vector2& layoutSize );
692 * @brief Scrolls the text to make a position visible.
694 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
696 * @param[in] position A position in text coords.
697 * @param[in] lineHeight The line height for the given position.
699 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
700 * or moving the selection handles.
702 void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
705 * @brief Scrolls the text to make the cursor visible.
707 * This method is called after deleting text.
709 void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
712 // Declared private and left undefined to avoid copies.
714 // Declared private and left undefined to avoid copies.
715 Impl& operator=( const Impl& );
719 ControlInterface* mControlInterface; ///< Reference to the text controller.
720 EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
721 ModelPtr mModel; ///< Pointer to the text's model.
722 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
723 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
724 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
725 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
726 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
727 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
728 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
729 Clipboard mClipboard; ///< Handle to the system clipboard
730 View mView; ///< The view interface to the rendering back-end.
731 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
732 Layout::Engine mLayoutEngine; ///< The layout engine.
733 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
734 Vector4 mTextColor; ///< The regular text color
735 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
736 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
737 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
738 HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode.
740 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
741 bool mMarkupProcessorEnabled:1; ///< Whether the mark-up procesor is enabled.
742 bool mClipboardHideEnabled:1; ///< Whether the ClipboardHide function work or not
743 bool mIsAutoScrollEnabled:1; ///< Whether auto text scrolling is enabled.
744 CharacterDirection mAutoScrollDirectionRTL:1; ///< Direction of auto scrolling, true if rtl
746 bool mUnderlineSetByString:1; ///< Set when underline is set by string (legacy) instead of map
747 bool mShadowSetByString:1; ///< Set when shadow is set by string (legacy) instead of map
748 bool mFontStyleSetByString:1; ///< Set when font style is set by string (legacy) instead of map
749 bool mShouldClearFocusOnEscape:1; ///< Whether text control should clear key input focus
754 } // namespace Toolkit
758 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H