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.
168 TEXT_REPLACED, ///< The entire text was replaced
169 TEXT_INSERTED, ///< Insert characters at the current cursor position
170 TEXT_DELETED ///< Characters were deleted
179 : mFontDescription(),
180 mDefaultPointSize( 0.f ),
182 familyDefined( false ),
183 weightDefined( false ),
184 widthDefined( false ),
185 slantDefined( false ),
188 // Initially use the default platform font
189 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
190 fontClient.GetDefaultPlatformFontDescription( mFontDescription );
193 FontId GetFontId( TextAbstraction::FontClient& fontClient )
197 const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( mDefaultPointSize * 64.f );
198 mFontId = fontClient.GetFontId( mFontDescription, pointSize );
204 TextAbstraction::FontDescription mFontDescription; ///< The default font's description.
205 float mDefaultPointSize; ///< The default font's point size.
206 FontId mFontId; ///< The font's id of the default font.
207 bool familyDefined:1; ///< Whether the default font's family name is defined.
208 bool weightDefined:1; ///< Whether the default font's weight is defined.
209 bool widthDefined:1; ///< Whether the default font's width is defined.
210 bool slantDefined:1; ///< Whether the default font's slant is defined.
211 bool sizeDefined:1; ///< Whether the default font's point size is defined.
215 * @brief Stores indices used to update the text.
216 * Stores the character index where the text is updated and the number of characters removed and added.
217 * Stores as well indices to the first and the last paragraphs to be updated.
219 struct TextUpdateInfo
222 : mCharacterIndex( 0u ),
223 mNumberOfCharactersToRemove( 0u ),
224 mNumberOfCharactersToAdd( 0u ),
225 mPreviousNumberOfCharacters( 0u ),
226 mParagraphCharacterIndex( 0u ),
227 mRequestedNumberOfCharacters( 0u ),
228 mStartGlyphIndex( 0u ),
229 mStartLineIndex( 0u ),
230 mEstimatedNumberOfLines( 0u ),
232 mFullRelayoutNeeded( true ),
233 mIsLastCharacterNewParagraph( false )
239 CharacterIndex mCharacterIndex; ///< Index to the first character to be updated.
240 Length mNumberOfCharactersToRemove; ///< The number of characters to be removed.
241 Length mNumberOfCharactersToAdd; ///< The number of characters to be added.
242 Length mPreviousNumberOfCharacters; ///< The number of characters before the text update.
244 CharacterIndex mParagraphCharacterIndex; ///< Index of the first character of the first paragraph to be updated.
245 Length mRequestedNumberOfCharacters; ///< The requested number of characters.
246 GlyphIndex mStartGlyphIndex;
247 LineIndex mStartLineIndex;
248 Length mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting.
250 bool mClearAll:1; ///< Whether the whole text is cleared. i.e. when the text is reset.
251 bool mFullRelayoutNeeded:1; ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
252 bool mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
256 // Clear all info except the mPreviousNumberOfCharacters member.
257 mCharacterIndex = static_cast<CharacterIndex>( -1 );
258 mNumberOfCharactersToRemove = 0u;
259 mNumberOfCharactersToAdd = 0u;
260 mParagraphCharacterIndex = 0u;
261 mRequestedNumberOfCharacters = 0u;
262 mStartGlyphIndex = 0u;
263 mStartLineIndex = 0u;
264 mEstimatedNumberOfLines = 0u;
266 mFullRelayoutNeeded = false;
267 mIsLastCharacterNewParagraph = false;
271 struct UnderlineDefaults
273 std::string properties;
274 // TODO: complete with underline parameters.
277 struct ShadowDefaults
279 std::string properties;
280 // TODO: complete with shadow parameters.
283 struct EmbossDefaults
285 std::string properties;
286 // TODO: complete with emboss parameters.
289 struct OutlineDefaults
291 std::string properties;
292 // TODO: complete with outline parameters.
295 struct Controller::Impl
297 Impl( ControlInterface* controlInterface,
298 EditableControlInterface* editableControlInterface )
299 : mControlInterface( controlInterface ),
300 mEditableControlInterface( editableControlInterface ),
302 mFontDefaults( NULL ),
303 mUnderlineDefaults( NULL ),
304 mShadowDefaults( NULL ),
305 mEmbossDefaults( NULL ),
306 mOutlineDefaults( NULL ),
313 mTextColor( Color::BLACK ),
315 mOperationsPending( NO_OPERATION ),
316 mMaximumNumberOfCharacters( 50u ),
317 mHiddenInput( NULL ),
318 mRecalculateNaturalSize( true ),
319 mMarkupProcessorEnabled( false ),
320 mClipboardHideEnabled( true ),
321 mIsAutoScrollEnabled( false ),
322 mAutoScrollDirectionRTL( false ),
323 mUnderlineSetByString( false ),
324 mShadowSetByString( false ),
325 mFontStyleSetByString( false )
327 mModel = Model::New();
329 mFontClient = TextAbstraction::FontClient::Get();
330 mClipboard = Clipboard::Get();
332 mView.SetVisualModel( mModel->mVisualModel );
334 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
335 mMetrics = Metrics::New( mFontClient );
336 mLayoutEngine.SetMetrics( mMetrics );
338 // Set the text properties to default
339 mModel->mVisualModel->SetUnderlineEnabled( false );
340 mModel->mVisualModel->SetUnderlineHeight( 0.0f );
342 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
345 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
346 mIsClearFocusOnEscape = config["clearFocusOnEscape"].Get<bool>();
355 delete mFontDefaults;
356 delete mUnderlineDefaults;
357 delete mShadowDefaults;
358 delete mEmbossDefaults;
359 delete mOutlineDefaults;
363 // Text Controller Implementation.
366 * @copydoc Text::Controller::RequestRelayout()
368 void RequestRelayout();
371 * @brief Request a relayout using the ControlInterface.
373 void QueueModifyEvent( ModifyEvent::Type type )
375 if( ModifyEvent::TEXT_REPLACED == type)
377 // Cancel previously queued inserts etc.
378 mModifyEvents.Clear();
383 mModifyEvents.PushBack( event );
385 // The event will be processed during relayout
390 * @brief Helper to move the cursor, grab handle etc.
392 bool ProcessInputEvents();
395 * @brief Helper to check whether any place-holder text is available.
397 bool IsPlaceholderAvailable() const
399 return ( mEventData &&
400 ( !mEventData->mPlaceholderTextInactive.empty() ||
401 !mEventData->mPlaceholderTextActive.empty() )
405 bool IsShowingPlaceholderText() const
407 return ( mEventData && mEventData->mIsShowingPlaceholderText );
411 * @brief Helper to check whether active place-holder text is available.
413 bool IsFocusedPlaceholderAvailable() const
415 return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
418 bool IsShowingRealText() const
420 return ( !IsShowingPlaceholderText() &&
421 0u != mModel->mLogicalModel->mText.Count() );
425 * @brief Called when placeholder-text is hidden
427 void PlaceholderCleared()
431 mEventData->mIsShowingPlaceholderText = false;
433 // Remove mPlaceholderTextColor
434 mModel->mVisualModel->SetTextColor( mTextColor );
438 void ClearPreEditFlag()
442 mEventData->mPreEditFlag = false;
443 mEventData->mPreEditStartPosition = 0;
444 mEventData->mPreEditLength = 0;
448 void ResetImfManager()
452 // Reset incase we are in a pre-edit state.
453 if( mEventData->mImfManager )
455 mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
463 * @brief Helper to notify IMF manager with surrounding text & cursor changes.
465 void NotifyImfManager();
468 * @brief Helper to notify IMF manager with multi line status.
470 void NotifyImfMultiLineStatus();
473 * @brief Retrieve the current cursor position.
475 * @return The cursor position.
477 CharacterIndex GetLogicalCursorPosition() const;
480 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
482 * @param[in] index The character index from where to count the number of consecutive white spaces.
484 * @return The number of consecutive white spaces.
486 Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
489 * @brief Retrieve any text previously set starting from the given @p index.
491 * @param[in] index The character index from where to retrieve the text.
492 * @param[out] text A string of UTF-8 characters.
494 * @see Dali::Toolkit::Text::Controller::GetText()
496 void GetText( CharacterIndex index, std::string& text ) const;
498 bool IsClipboardEmpty()
500 bool result( mClipboard && mClipboard.NumberOfItems() );
501 return !result; // If NumberOfItems greater than 0, return false
504 bool IsClipboardVisible()
506 bool result( mClipboard && mClipboard.IsVisible() );
511 * @brief Calculates the start character index of the first paragraph to be updated and
512 * the end character index of the last paragraph to be updated.
514 * @param[out] numberOfCharacters The number of characters to be updated.
516 void CalculateTextUpdateIndices( Length& numberOfCharacters );
519 * @brief Helper to clear completely the parts of the model specified by the given @p operations.
521 * @note It never clears the text stored in utf32.
523 void ClearFullModelData( OperationsMask operations );
526 * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
528 * @note It never clears the text stored in utf32.
530 * @param[in] startIndex Index to the first character to be cleared.
531 * @param[in] endIndex Index to the last character to be cleared.
532 * @param[in] operations The operations required.
534 void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
537 * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
539 * @note It never clears the text stored in utf32.
540 * @note Character indices are transformed to glyph indices.
542 * @param[in] startIndex Index to the first character to be cleared.
543 * @param[in] endIndex Index to the last character to be cleared.
544 * @param[in] operations The operations required.
546 void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
549 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
551 * @note It never clears the text stored in utf32.
553 * @param[in] startIndex Index to the first character to be cleared.
554 * @param[in] endIndex Index to the last character to be cleared.
555 * @param[in] operations The operations required.
557 void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
560 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
562 * When text or style changes the model is set with some operations pending.
563 * When i.e. the text's size or a relayout is required this method is called
564 * with a given @p operationsRequired parameter. The operations required are
565 * matched with the operations pending to perform the minimum number of operations.
567 * @param[in] operationsRequired The operations required.
569 * @return @e true if the model has been modified.
571 bool UpdateModel( OperationsMask operationsRequired );
574 * @brief Retreieves the default style.
576 * @param[out] inputStyle The default style.
578 void RetrieveDefaultInputStyle( InputStyle& inputStyle );
581 * @brief Retrieve the line height of the default font.
583 float GetDefaultFontLineHeight();
585 void OnCursorKeyEvent( const Event& event );
587 void OnTapEvent( const Event& event );
589 void OnPanEvent( const Event& event );
591 void OnLongPressEvent( const Event& event );
593 void OnHandleEvent( const Event& event );
595 void OnSelectEvent( const Event& event );
597 void OnSelectAllEvent();
600 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
602 * @param[out] selectedText The selected text encoded in utf8.
603 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
605 void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
607 void ShowClipboard();
609 void HideClipboard();
611 void SetClipboardHideEnable(bool enable);
613 bool CopyStringToClipboard( std::string& source );
615 void SendSelectionToClipboard( bool deleteAfterSending );
617 void RequestGetTextFromClipboard();
619 void RepositionSelectionHandles();
620 void RepositionSelectionHandles( float visualX, float visualY, Controller::NoTextTap::Action action );
622 void SetPopupButtons();
624 void ChangeState( EventData::State newState );
627 * @brief Calculates the cursor's position for a given character index in the logical order.
629 * It retrieves as well the line's height and the cursor's height and
630 * if there is a valid alternative cursor, its position and height.
632 * @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.
633 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
635 void GetCursorPosition( CharacterIndex logical,
636 CursorInfo& cursorInfo );
639 * @brief Calculates the new cursor index.
641 * It takes into account that in some scripts multiple characters can form a glyph and all of them
642 * need to be jumped with one key event.
644 * @param[in] index The initial new index.
646 * @return The new cursor index.
648 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
651 * @brief Updates the cursor position.
653 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
654 * It sets the position of the secondary cursor if it's a valid one.
655 * Sets which cursors are active.
657 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
660 void UpdateCursorPosition( const CursorInfo& cursorInfo );
663 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
665 * @param[in] handleType One of the selection handles.
666 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
668 void UpdateSelectionHandle( HandleType handleType,
669 const CursorInfo& cursorInfo );
672 * @biref Clamps the horizontal scrolling to get the control always filled with text.
674 * @param[in] layoutSize The size of the laid out text.
676 void ClampHorizontalScroll( const Vector2& layoutSize );
679 * @biref Clamps the vertical scrolling to get the control always filled with text.
681 * @param[in] layoutSize The size of the laid out text.
683 void ClampVerticalScroll( const Vector2& layoutSize );
686 * @brief Scrolls the text to make a position visible.
688 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
690 * @param[in] position A position in text coords.
691 * @param[in] lineHeight The line height for the given position.
693 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
694 * or moving the selection handles.
696 void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
699 * @brief Scrolls the text to make the cursor visible.
701 * This method is called after deleting text.
703 void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
706 // Declared private and left undefined to avoid copies.
708 // Declared private and left undefined to avoid copies.
709 Impl& operator=( const Impl& );
713 ControlInterface* mControlInterface; ///< Reference to the text controller.
714 EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
715 ModelPtr mModel; ///< Pointer to the text's model.
716 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
717 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
718 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
719 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
720 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
721 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
722 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
723 Clipboard mClipboard; ///< Handle to the system clipboard
724 View mView; ///< The view interface to the rendering back-end.
725 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
726 Layout::Engine mLayoutEngine; ///< The layout engine.
727 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
728 Vector4 mTextColor; ///< The regular text color
729 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
730 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
731 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
732 HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode.
734 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
735 bool mMarkupProcessorEnabled:1; ///< Whether the mark-up procesor is enabled.
736 bool mClipboardHideEnabled:1; ///< Whether the ClipboardHide function work or not
737 bool mIsAutoScrollEnabled:1; ///< Whether auto text scrolling is enabled.
738 CharacterDirection mAutoScrollDirectionRTL:1; ///< Direction of auto scrolling, true if rtl
740 bool mUnderlineSetByString:1; ///< Set when underline is set by string (legacy) instead of map
741 bool mShadowSetByString:1; ///< Set when shadow is set by string (legacy) instead of map
742 bool mFontStyleSetByString:1; ///< Set when font style is set by string (legacy) instead of map
743 bool mIsClearFocusOnEscape:1; ///< Whether text control clear key input focus or not
748 } // namespace Toolkit
752 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H