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,
70 Event( Type eventType )
93 EDITING_WITH_GRAB_HANDLE,
94 EDITING_WITH_PASTE_POPUP,
96 SELECTION_HANDLE_PANNING,
100 EventData( DecoratorPtr decorator );
104 static bool IsEditingState( State stateToCheck )
106 return ( stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP );
109 DecoratorPtr mDecorator; ///< Pointer to the decorator.
110 ImfManager mImfManager; ///< The Input Method Framework Manager.
111 FontDefaults* mPlaceholderFont; ///< The placeholder default font.
112 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus.
113 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
114 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color.
117 * This is used to delay handling events until after the model has been updated.
118 * The number of updates to the model is minimized to improve performance.
120 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
122 Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
124 InputStyle mInputStyle; ///< The style to be set to the new inputed text.
126 State mPreviousState; ///< Stores the current state before it's updated with the new one.
127 State mState; ///< Selection mode, edit mode etc.
129 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
130 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
131 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
133 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
134 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
136 float mCursorHookPositionX; ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles.
138 Controller::NoTextTap::Action mDoubleTapAction; ///< Action to be done when there is a double tap on top of 'no text'
139 Controller::NoTextTap::Action mLongPressAction; ///< Action to be done when there is a long press on top of 'no text'
141 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
142 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
143 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
144 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
145 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
146 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
147 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
148 bool mUpdateCursorHookPosition : 1; ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
149 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
150 bool mUpdateGrabHandlePosition : 1; ///< True if the visual position of the grab handle must be recalculated.
151 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
152 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
153 bool mIsLeftHandleSelected : 1; ///< Whether is the left handle the one which is selected.
154 bool mIsRightHandleSelected : 1; ///< Whether is the right handle the one which is selected.
155 bool mUpdateHighlightBox : 1; ///< True if the text selection high light box must be updated.
156 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
157 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
158 bool mAllTextSelected : 1; ///< True if the selection handles are selecting all the text.
159 bool mUpdateInputStyle : 1; ///< Whether to update the input style after moving the cursor.
160 bool mPasswordInput : 1; ///< True if password input is enabled.
161 bool mCheckScrollAmount : 1; ///< Whether to check scrolled amount after updating the position
162 bool mIsPlaceholderPixelSize : 1; ///< True if the placeholder font size is set as pixel size.
163 bool mIsPlaceholderElideEnabled : 1; ///< True if the placeholder text's elide is enabled.
164 bool mPlaceholderEllipsisFlag : 1; ///< True if the text controller sets the placeholder ellipsis.
165 bool mShiftSelectionFlag : 1; ///< True if the text selection using Shift key is enabled.
172 TEXT_REPLACED, ///< The entire text was replaced
173 TEXT_INSERTED, ///< Insert characters at the current cursor position
174 TEXT_DELETED ///< Characters were deleted
183 : mFontDescription(),
184 mDefaultPointSize( 0.f ),
186 familyDefined( false ),
187 weightDefined( false ),
188 widthDefined( false ),
189 slantDefined( false ),
192 // Initially use the default platform font
193 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
194 fontClient.GetDefaultPlatformFontDescription( mFontDescription );
197 FontId GetFontId( TextAbstraction::FontClient& fontClient )
201 const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( mDefaultPointSize * 64.f );
202 mFontId = fontClient.GetFontId( mFontDescription, pointSize );
208 TextAbstraction::FontDescription mFontDescription; ///< The default font's description.
209 float mDefaultPointSize; ///< The default font's point size.
210 FontId mFontId; ///< The font's id of the default font.
211 bool familyDefined:1; ///< Whether the default font's family name is defined.
212 bool weightDefined:1; ///< Whether the default font's weight is defined.
213 bool widthDefined:1; ///< Whether the default font's width is defined.
214 bool slantDefined:1; ///< Whether the default font's slant is defined.
215 bool sizeDefined:1; ///< Whether the default font's point size is defined.
219 * @brief Stores indices used to update the text.
220 * Stores the character index where the text is updated and the number of characters removed and added.
221 * Stores as well indices to the first and the last paragraphs to be updated.
223 struct TextUpdateInfo
226 : mCharacterIndex( 0u ),
227 mNumberOfCharactersToRemove( 0u ),
228 mNumberOfCharactersToAdd( 0u ),
229 mPreviousNumberOfCharacters( 0u ),
230 mParagraphCharacterIndex( 0u ),
231 mRequestedNumberOfCharacters( 0u ),
232 mStartGlyphIndex( 0u ),
233 mStartLineIndex( 0u ),
234 mEstimatedNumberOfLines( 0u ),
236 mFullRelayoutNeeded( true ),
237 mIsLastCharacterNewParagraph( false )
243 CharacterIndex mCharacterIndex; ///< Index to the first character to be updated.
244 Length mNumberOfCharactersToRemove; ///< The number of characters to be removed.
245 Length mNumberOfCharactersToAdd; ///< The number of characters to be added.
246 Length mPreviousNumberOfCharacters; ///< The number of characters before the text update.
248 CharacterIndex mParagraphCharacterIndex; ///< Index of the first character of the first paragraph to be updated.
249 Length mRequestedNumberOfCharacters; ///< The requested number of characters.
250 GlyphIndex mStartGlyphIndex;
251 LineIndex mStartLineIndex;
252 Length mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting.
254 bool mClearAll:1; ///< Whether the whole text is cleared. i.e. when the text is reset.
255 bool mFullRelayoutNeeded:1; ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
256 bool mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
260 // Clear all info except the mPreviousNumberOfCharacters member.
261 mCharacterIndex = static_cast<CharacterIndex>( -1 );
262 mNumberOfCharactersToRemove = 0u;
263 mNumberOfCharactersToAdd = 0u;
264 mParagraphCharacterIndex = 0u;
265 mRequestedNumberOfCharacters = 0u;
266 mStartGlyphIndex = 0u;
267 mStartLineIndex = 0u;
268 mEstimatedNumberOfLines = 0u;
270 mFullRelayoutNeeded = false;
271 mIsLastCharacterNewParagraph = false;
275 struct UnderlineDefaults
277 std::string properties;
278 // TODO: complete with underline parameters.
281 struct ShadowDefaults
283 std::string properties;
284 // TODO: complete with shadow parameters.
287 struct EmbossDefaults
289 std::string properties;
290 // TODO: complete with emboss parameters.
293 struct OutlineDefaults
295 std::string properties;
296 // TODO: complete with outline parameters.
299 struct Controller::Impl
301 Impl( ControlInterface* controlInterface,
302 EditableControlInterface* editableControlInterface )
303 : mControlInterface( controlInterface ),
304 mEditableControlInterface( editableControlInterface ),
306 mFontDefaults( NULL ),
307 mUnderlineDefaults( NULL ),
308 mShadowDefaults( NULL ),
309 mEmbossDefaults( NULL ),
310 mOutlineDefaults( NULL ),
317 mTextColor( Color::BLACK ),
319 mOperationsPending( NO_OPERATION ),
320 mMaximumNumberOfCharacters( 50u ),
321 mHiddenInput( NULL ),
322 mRecalculateNaturalSize( true ),
323 mMarkupProcessorEnabled( false ),
324 mClipboardHideEnabled( true ),
325 mIsAutoScrollEnabled( false ),
326 mAutoScrollDirectionRTL( false ),
327 mUnderlineSetByString( false ),
328 mShadowSetByString( false ),
329 mOutlineSetByString( false ),
330 mFontStyleSetByString( false ),
331 mShouldClearFocusOnEscape( true )
333 mModel = Model::New();
335 mFontClient = TextAbstraction::FontClient::Get();
336 mClipboard = Clipboard::Get();
338 mView.SetVisualModel( mModel->mVisualModel );
340 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
341 mMetrics = Metrics::New( mFontClient );
342 mLayoutEngine.SetMetrics( mMetrics );
344 // Set the text properties to default
345 mModel->mVisualModel->SetUnderlineEnabled( false );
346 mModel->mVisualModel->SetUnderlineHeight( 0.0f );
348 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
352 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
353 if( config["clearFocusOnEscape"].Get( temp ) )
355 mShouldClearFocusOnEscape = temp;
364 delete mFontDefaults;
365 delete mUnderlineDefaults;
366 delete mShadowDefaults;
367 delete mEmbossDefaults;
368 delete mOutlineDefaults;
372 // Text Controller Implementation.
375 * @copydoc Text::Controller::RequestRelayout()
377 void RequestRelayout();
380 * @brief Request a relayout using the ControlInterface.
382 void QueueModifyEvent( ModifyEvent::Type type )
384 if( ModifyEvent::TEXT_REPLACED == type)
386 // Cancel previously queued inserts etc.
387 mModifyEvents.Clear();
392 mModifyEvents.PushBack( event );
394 // The event will be processed during relayout
399 * @brief Helper to move the cursor, grab handle etc.
401 bool ProcessInputEvents();
404 * @brief Helper to check whether any place-holder text is available.
406 bool IsPlaceholderAvailable() const
408 return ( mEventData &&
409 ( !mEventData->mPlaceholderTextInactive.empty() ||
410 !mEventData->mPlaceholderTextActive.empty() )
414 bool IsShowingPlaceholderText() const
416 return ( mEventData && mEventData->mIsShowingPlaceholderText );
420 * @brief Helper to check whether active place-holder text is available.
422 bool IsFocusedPlaceholderAvailable() const
424 return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
427 bool IsShowingRealText() const
429 return ( !IsShowingPlaceholderText() &&
430 0u != mModel->mLogicalModel->mText.Count() );
434 * @brief Called when placeholder-text is hidden
436 void PlaceholderCleared()
440 mEventData->mIsShowingPlaceholderText = false;
442 // Remove mPlaceholderTextColor
443 mModel->mVisualModel->SetTextColor( mTextColor );
447 void ClearPreEditFlag()
451 mEventData->mPreEditFlag = false;
452 mEventData->mPreEditStartPosition = 0;
453 mEventData->mPreEditLength = 0;
457 void ResetImfManager()
461 // Reset incase we are in a pre-edit state.
462 if( mEventData->mImfManager )
464 mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
472 * @brief Helper to notify IMF manager with surrounding text & cursor changes.
474 void NotifyImfManager();
477 * @brief Helper to notify IMF manager with multi line status.
479 void NotifyImfMultiLineStatus();
482 * @brief Retrieve the current cursor position.
484 * @return The cursor position.
486 CharacterIndex GetLogicalCursorPosition() const;
489 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
491 * @param[in] index The character index from where to count the number of consecutive white spaces.
493 * @return The number of consecutive white spaces.
495 Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
498 * @brief Retrieve any text previously set starting from the given @p index.
500 * @param[in] index The character index from where to retrieve the text.
501 * @param[out] text A string of UTF-8 characters.
503 * @see Dali::Toolkit::Text::Controller::GetText()
505 void GetText( CharacterIndex index, std::string& text ) const;
507 bool IsClipboardEmpty()
509 bool result( mClipboard && mClipboard.NumberOfItems() );
510 return !result; // If NumberOfItems greater than 0, return false
513 bool IsClipboardVisible()
515 bool result( mClipboard && mClipboard.IsVisible() );
520 * @brief Calculates the start character index of the first paragraph to be updated and
521 * the end character index of the last paragraph to be updated.
523 * @param[out] numberOfCharacters The number of characters to be updated.
525 void CalculateTextUpdateIndices( Length& numberOfCharacters );
528 * @brief Helper to clear completely the parts of the model specified by the given @p operations.
530 * @note It never clears the text stored in utf32.
532 void ClearFullModelData( OperationsMask operations );
535 * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
537 * @note It never clears the text stored in utf32.
539 * @param[in] startIndex Index to the first character to be cleared.
540 * @param[in] endIndex Index to the last character to be cleared.
541 * @param[in] operations The operations required.
543 void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
546 * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
548 * @note It never clears the text stored in utf32.
549 * @note Character indices are transformed to glyph indices.
551 * @param[in] startIndex Index to the first character to be cleared.
552 * @param[in] endIndex Index to the last character to be cleared.
553 * @param[in] operations The operations required.
555 void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
558 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
560 * @note It never clears the text stored in utf32.
562 * @param[in] startIndex Index to the first character to be cleared.
563 * @param[in] endIndex Index to the last character to be cleared.
564 * @param[in] operations The operations required.
566 void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
569 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
571 * When text or style changes the model is set with some operations pending.
572 * When i.e. the text's size or a relayout is required this method is called
573 * with a given @p operationsRequired parameter. The operations required are
574 * matched with the operations pending to perform the minimum number of operations.
576 * @param[in] operationsRequired The operations required.
578 * @return @e true if the model has been modified.
580 bool UpdateModel( OperationsMask operationsRequired );
583 * @brief Retreieves the default style.
585 * @param[out] inputStyle The default style.
587 void RetrieveDefaultInputStyle( InputStyle& inputStyle );
590 * @brief Retrieve the line height of the default font.
592 float GetDefaultFontLineHeight();
594 void OnCursorKeyEvent( const Event& event );
596 void OnTapEvent( const Event& event );
598 void OnPanEvent( const Event& event );
600 void OnLongPressEvent( const Event& event );
602 void OnHandleEvent( const Event& event );
604 void OnSelectEvent( const Event& event );
606 void OnSelectAllEvent();
609 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
611 * @param[out] selectedText The selected text encoded in utf8.
612 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
614 void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
616 void ShowClipboard();
618 void HideClipboard();
620 void SetClipboardHideEnable(bool enable);
622 bool CopyStringToClipboard( std::string& source );
624 void SendSelectionToClipboard( bool deleteAfterSending );
626 void RequestGetTextFromClipboard();
628 void RepositionSelectionHandles();
629 void RepositionSelectionHandles( float visualX, float visualY, Controller::NoTextTap::Action action );
631 void SetPopupButtons();
633 void ChangeState( EventData::State newState );
636 * @brief Calculates the cursor's position for a given character index in the logical order.
638 * It retrieves as well the line's height and the cursor's height and
639 * if there is a valid alternative cursor, its position and height.
641 * @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.
642 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
644 void GetCursorPosition( CharacterIndex logical,
645 CursorInfo& cursorInfo );
648 * @brief Calculates the new cursor index.
650 * It takes into account that in some scripts multiple characters can form a glyph and all of them
651 * need to be jumped with one key event.
653 * @param[in] index The initial new index.
655 * @return The new cursor index.
657 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
660 * @brief Updates the cursor position.
662 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
663 * It sets the position of the secondary cursor if it's a valid one.
664 * Sets which cursors are active.
666 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
669 void UpdateCursorPosition( const CursorInfo& cursorInfo );
672 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
674 * @param[in] handleType One of the selection handles.
675 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
677 void UpdateSelectionHandle( HandleType handleType,
678 const CursorInfo& cursorInfo );
681 * @biref Clamps the horizontal scrolling to get the control always filled with text.
683 * @param[in] layoutSize The size of the laid out text.
685 void ClampHorizontalScroll( const Vector2& layoutSize );
688 * @biref Clamps the vertical scrolling to get the control always filled with text.
690 * @param[in] layoutSize The size of the laid out text.
692 void ClampVerticalScroll( const Vector2& layoutSize );
695 * @brief Scrolls the text to make a position visible.
697 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
699 * @param[in] position A position in text coords.
700 * @param[in] lineHeight The line height for the given position.
702 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
703 * or moving the selection handles.
705 void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
708 * @brief Scrolls the text to make the cursor visible.
710 * This method is called after deleting text.
712 void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
715 // Declared private and left undefined to avoid copies.
717 // Declared private and left undefined to avoid copies.
718 Impl& operator=( const Impl& );
722 ControlInterface* mControlInterface; ///< Reference to the text controller.
723 EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
724 ModelPtr mModel; ///< Pointer to the text's model.
725 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
726 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
727 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
728 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
729 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
730 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
731 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
732 Clipboard mClipboard; ///< Handle to the system clipboard
733 View mView; ///< The view interface to the rendering back-end.
734 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
735 Layout::Engine mLayoutEngine; ///< The layout engine.
736 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
737 Vector4 mTextColor; ///< The regular text color
738 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
739 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
740 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
741 HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode.
743 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
744 bool mMarkupProcessorEnabled:1; ///< Whether the mark-up procesor is enabled.
745 bool mClipboardHideEnabled:1; ///< Whether the ClipboardHide function work or not
746 bool mIsAutoScrollEnabled:1; ///< Whether auto text scrolling is enabled.
747 CharacterDirection mAutoScrollDirectionRTL:1; ///< Direction of auto scrolling, true if rtl
749 bool mUnderlineSetByString:1; ///< Set when underline is set by string (legacy) instead of map
750 bool mShadowSetByString:1; ///< Set when shadow is set by string (legacy) instead of map
751 bool mOutlineSetByString:1; ///< Set when outline is set by string (legacy) instead of map
752 bool mFontStyleSetByString:1; ///< Set when font style is set by string (legacy) instead of map
753 bool mShouldClearFocusOnEscape:1; ///< Whether text control should clear key input focus
758 } // namespace Toolkit
762 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H