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>
40 //Forward declarations
46 // Used to queue input events until DoRelayout()
54 LEFT_SELECTION_HANDLE_EVENT,
55 RIGHT_SELECTION_HANDLE_EVENT,
67 Event( Type eventType )
90 EDITING_WITH_GRAB_HANDLE,
91 EDITING_WITH_PASTE_POPUP,
93 SELECTION_HANDLE_PANNING,
97 EventData( DecoratorPtr decorator );
101 static bool IsEditingState( State stateToCheck )
103 return ( stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP );
106 DecoratorPtr mDecorator; ///< Pointer to the decorator.
107 ImfManager mImfManager; ///< The Input Method Framework Manager.
108 FontDefaults* mPlaceholderFont; ///< The placeholder default font.
109 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus.
110 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
111 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color.
114 * This is used to delay handling events until after the model has been updated.
115 * The number of updates to the model is minimized to improve performance.
117 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
119 Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
121 InputStyle mInputStyle; ///< The style to be set to the new inputed text.
123 State mPreviousState; ///< Stores the current state before it's updated with the new one.
124 State mState; ///< Selection mode, edit mode etc.
126 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
127 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
128 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
130 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
131 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
133 float mCursorHookPositionX; ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles.
135 Controller::NoTextTap::Action mDoubleTapAction; ///< Action to be done when there is a double tap on top of 'no text'
136 Controller::NoTextTap::Action mLongPressAction; ///< Action to be done when there is a long press on top of 'no text'
138 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
139 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
140 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
141 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
142 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
143 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
144 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
145 bool mUpdateCursorHookPosition : 1; ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
146 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
147 bool mUpdateGrabHandlePosition : 1; ///< True if the visual position of the grab handle must be recalculated.
148 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
149 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
150 bool mIsLeftHandleSelected : 1; ///< Whether is the left handle the one which is selected.
151 bool mIsRightHandleSelected : 1; ///< Whether is the right handle the one which is selected.
152 bool mUpdateHighlightBox : 1; ///< True if the text selection high light box must be updated.
153 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
154 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
155 bool mAllTextSelected : 1; ///< True if the selection handles are selecting all the text.
156 bool mUpdateInputStyle : 1; ///< Whether to update the input style after moving the cursor.
157 bool mPasswordInput : 1; ///< True if password input is enabled.
158 bool mCheckScrollAmount : 1; ///< Whether to check scrolled amount after updating the position
159 bool mIsPlaceholderPixelSize : 1; ///< True if the placeholder font size is set as pixel size.
166 TEXT_REPLACED, ///< The entire text was replaced
167 TEXT_INSERTED, ///< Insert characters at the current cursor position
168 TEXT_DELETED ///< Characters were deleted
177 : mFontDescription(),
178 mDefaultPointSize( 0.f ),
180 familyDefined( false ),
181 weightDefined( false ),
182 widthDefined( false ),
183 slantDefined( false ),
186 // Initially use the default platform font
187 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
188 fontClient.GetDefaultPlatformFontDescription( mFontDescription );
191 FontId GetFontId( TextAbstraction::FontClient& fontClient )
195 const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( mDefaultPointSize * 64.f );
196 mFontId = fontClient.GetFontId( mFontDescription, pointSize );
202 TextAbstraction::FontDescription mFontDescription; ///< The default font's description.
203 float mDefaultPointSize; ///< The default font's point size.
204 FontId mFontId; ///< The font's id of the default font.
205 bool familyDefined:1; ///< Whether the default font's family name is defined.
206 bool weightDefined:1; ///< Whether the default font's weight is defined.
207 bool widthDefined:1; ///< Whether the default font's width is defined.
208 bool slantDefined:1; ///< Whether the default font's slant is defined.
209 bool sizeDefined:1; ///< Whether the default font's point size is defined.
213 * @brief Stores indices used to update the text.
214 * Stores the character index where the text is updated and the number of characters removed and added.
215 * Stores as well indices to the first and the last paragraphs to be updated.
217 struct TextUpdateInfo
220 : mCharacterIndex( 0u ),
221 mNumberOfCharactersToRemove( 0u ),
222 mNumberOfCharactersToAdd( 0u ),
223 mPreviousNumberOfCharacters( 0u ),
224 mParagraphCharacterIndex( 0u ),
225 mRequestedNumberOfCharacters( 0u ),
226 mStartGlyphIndex( 0u ),
227 mStartLineIndex( 0u ),
228 mEstimatedNumberOfLines( 0u ),
230 mFullRelayoutNeeded( true ),
231 mIsLastCharacterNewParagraph( false )
237 CharacterIndex mCharacterIndex; ///< Index to the first character to be updated.
238 Length mNumberOfCharactersToRemove; ///< The number of characters to be removed.
239 Length mNumberOfCharactersToAdd; ///< The number of characters to be added.
240 Length mPreviousNumberOfCharacters; ///< The number of characters before the text update.
242 CharacterIndex mParagraphCharacterIndex; ///< Index of the first character of the first paragraph to be updated.
243 Length mRequestedNumberOfCharacters; ///< The requested number of characters.
244 GlyphIndex mStartGlyphIndex;
245 LineIndex mStartLineIndex;
246 Length mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting.
248 bool mClearAll:1; ///< Whether the whole text is cleared. i.e. when the text is reset.
249 bool mFullRelayoutNeeded:1; ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
250 bool mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
254 // Clear all info except the mPreviousNumberOfCharacters member.
255 mCharacterIndex = static_cast<CharacterIndex>( -1 );
256 mNumberOfCharactersToRemove = 0u;
257 mNumberOfCharactersToAdd = 0u;
258 mParagraphCharacterIndex = 0u;
259 mRequestedNumberOfCharacters = 0u;
260 mStartGlyphIndex = 0u;
261 mStartLineIndex = 0u;
262 mEstimatedNumberOfLines = 0u;
264 mFullRelayoutNeeded = false;
265 mIsLastCharacterNewParagraph = false;
269 struct UnderlineDefaults
271 std::string properties;
272 // TODO: complete with underline parameters.
275 struct ShadowDefaults
277 std::string properties;
278 // TODO: complete with shadow parameters.
281 struct EmbossDefaults
283 std::string properties;
284 // TODO: complete with emboss parameters.
287 struct OutlineDefaults
289 std::string properties;
290 // TODO: complete with outline parameters.
293 struct Controller::Impl
295 Impl( ControlInterface* controlInterface,
296 EditableControlInterface* editableControlInterface )
297 : mControlInterface( controlInterface ),
298 mEditableControlInterface( editableControlInterface ),
300 mFontDefaults( NULL ),
301 mUnderlineDefaults( NULL ),
302 mShadowDefaults( NULL ),
303 mEmbossDefaults( NULL ),
304 mOutlineDefaults( NULL ),
311 mTextColor( Color::BLACK ),
313 mOperationsPending( NO_OPERATION ),
314 mMaximumNumberOfCharacters( 50u ),
315 mHiddenInput( NULL ),
316 mRecalculateNaturalSize( true ),
317 mMarkupProcessorEnabled( false ),
318 mClipboardHideEnabled( true ),
319 mIsAutoScrollEnabled( false ),
320 mAutoScrollDirectionRTL( false ),
321 mUnderlineSetByString( false ),
322 mShadowSetByString( false ),
323 mFontStyleSetByString( false )
325 mModel = Model::New();
327 mFontClient = TextAbstraction::FontClient::Get();
328 mClipboard = Clipboard::Get();
330 mView.SetVisualModel( mModel->mVisualModel );
332 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
333 mMetrics = Metrics::New( mFontClient );
334 mLayoutEngine.SetMetrics( mMetrics );
336 // Set the text properties to default
337 mModel->mVisualModel->SetUnderlineEnabled( false );
338 mModel->mVisualModel->SetUnderlineHeight( 0.0f );
345 delete mFontDefaults;
346 delete mUnderlineDefaults;
347 delete mShadowDefaults;
348 delete mEmbossDefaults;
349 delete mOutlineDefaults;
353 // Text Controller Implementation.
356 * @copydoc Text::Controller::RequestRelayout()
358 void RequestRelayout();
361 * @brief Request a relayout using the ControlInterface.
363 void QueueModifyEvent( ModifyEvent::Type type )
365 if( ModifyEvent::TEXT_REPLACED == type)
367 // Cancel previously queued inserts etc.
368 mModifyEvents.Clear();
373 mModifyEvents.PushBack( event );
375 // The event will be processed during relayout
380 * @brief Helper to move the cursor, grab handle etc.
382 bool ProcessInputEvents();
385 * @brief Helper to check whether any place-holder text is available.
387 bool IsPlaceholderAvailable() const
389 return ( mEventData &&
390 ( !mEventData->mPlaceholderTextInactive.empty() ||
391 !mEventData->mPlaceholderTextActive.empty() )
395 bool IsShowingPlaceholderText() const
397 return ( mEventData && mEventData->mIsShowingPlaceholderText );
401 * @brief Helper to check whether active place-holder text is available.
403 bool IsFocusedPlaceholderAvailable() const
405 return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
408 bool IsShowingRealText() const
410 return ( !IsShowingPlaceholderText() &&
411 0u != mModel->mLogicalModel->mText.Count() );
415 * @brief Called when placeholder-text is hidden
417 void PlaceholderCleared()
421 mEventData->mIsShowingPlaceholderText = false;
423 // Remove mPlaceholderTextColor
424 mModel->mVisualModel->SetTextColor( mTextColor );
428 void ClearPreEditFlag()
432 mEventData->mPreEditFlag = false;
433 mEventData->mPreEditStartPosition = 0;
434 mEventData->mPreEditLength = 0;
438 void ResetImfManager()
442 // Reset incase we are in a pre-edit state.
443 if( mEventData->mImfManager )
445 mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
453 * @brief Helper to notify IMF manager with surrounding text & cursor changes.
455 void NotifyImfManager();
458 * @brief Helper to notify IMF manager with multi line status.
460 void NotifyImfMultiLineStatus();
463 * @brief Retrieve the current cursor position.
465 * @return The cursor position.
467 CharacterIndex GetLogicalCursorPosition() const;
470 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
472 * @param[in] index The character index from where to count the number of consecutive white spaces.
474 * @return The number of consecutive white spaces.
476 Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
479 * @brief Retrieve any text previously set starting from the given @p index.
481 * @param[in] index The character index from where to retrieve the text.
482 * @param[out] text A string of UTF-8 characters.
484 * @see Dali::Toolkit::Text::Controller::GetText()
486 void GetText( CharacterIndex index, std::string& text ) const;
488 bool IsClipboardEmpty()
490 bool result( mClipboard && mClipboard.NumberOfItems() );
491 return !result; // If NumberOfItems greater than 0, return false
494 bool IsClipboardVisible()
496 bool result( mClipboard && mClipboard.IsVisible() );
501 * @brief Calculates the start character index of the first paragraph to be updated and
502 * the end character index of the last paragraph to be updated.
504 * @param[out] numberOfCharacters The number of characters to be updated.
506 void CalculateTextUpdateIndices( Length& numberOfCharacters );
509 * @brief Helper to clear completely the parts of the model specified by the given @p operations.
511 * @note It never clears the text stored in utf32.
513 void ClearFullModelData( OperationsMask operations );
516 * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
518 * @note It never clears the text stored in utf32.
520 * @param[in] startIndex Index to the first character to be cleared.
521 * @param[in] endIndex Index to the last character to be cleared.
522 * @param[in] operations The operations required.
524 void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
527 * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
529 * @note It never clears the text stored in utf32.
530 * @note Character indices are transformed to glyph indices.
532 * @param[in] startIndex Index to the first character to be cleared.
533 * @param[in] endIndex Index to the last character to be cleared.
534 * @param[in] operations The operations required.
536 void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
539 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
541 * @note It never clears the text stored in utf32.
543 * @param[in] startIndex Index to the first character to be cleared.
544 * @param[in] endIndex Index to the last character to be cleared.
545 * @param[in] operations The operations required.
547 void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
550 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
552 * When text or style changes the model is set with some operations pending.
553 * When i.e. the text's size or a relayout is required this method is called
554 * with a given @p operationsRequired parameter. The operations required are
555 * matched with the operations pending to perform the minimum number of operations.
557 * @param[in] operationsRequired The operations required.
559 * @return @e true if the model has been modified.
561 bool UpdateModel( OperationsMask operationsRequired );
564 * @brief Retreieves the default style.
566 * @param[out] inputStyle The default style.
568 void RetrieveDefaultInputStyle( InputStyle& inputStyle );
571 * @brief Retrieve the line height of the default font.
573 float GetDefaultFontLineHeight();
575 void OnCursorKeyEvent( const Event& event );
577 void OnTapEvent( const Event& event );
579 void OnPanEvent( const Event& event );
581 void OnLongPressEvent( const Event& event );
583 void OnHandleEvent( const Event& event );
585 void OnSelectEvent( const Event& event );
587 void OnSelectAllEvent();
590 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
592 * @param[out] selectedText The selected text encoded in utf8.
593 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
595 void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
597 void ShowClipboard();
599 void HideClipboard();
601 void SetClipboardHideEnable(bool enable);
603 bool CopyStringToClipboard( std::string& source );
605 void SendSelectionToClipboard( bool deleteAfterSending );
607 void RequestGetTextFromClipboard();
609 void RepositionSelectionHandles();
610 void RepositionSelectionHandles( float visualX, float visualY, Controller::NoTextTap::Action action );
612 void SetPopupButtons();
614 void ChangeState( EventData::State newState );
617 * @brief Calculates the cursor's position for a given character index in the logical order.
619 * It retrieves as well the line's height and the cursor's height and
620 * if there is a valid alternative cursor, its position and height.
622 * @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.
623 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
625 void GetCursorPosition( CharacterIndex logical,
626 CursorInfo& cursorInfo );
629 * @brief Calculates the new cursor index.
631 * It takes into account that in some scripts multiple characters can form a glyph and all of them
632 * need to be jumped with one key event.
634 * @param[in] index The initial new index.
636 * @return The new cursor index.
638 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
641 * @brief Updates the cursor position.
643 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
644 * It sets the position of the secondary cursor if it's a valid one.
645 * Sets which cursors are active.
647 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
650 void UpdateCursorPosition( const CursorInfo& cursorInfo );
653 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
655 * @param[in] handleType One of the selection handles.
656 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
658 void UpdateSelectionHandle( HandleType handleType,
659 const CursorInfo& cursorInfo );
662 * @biref Clamps the horizontal scrolling to get the control always filled with text.
664 * @param[in] layoutSize The size of the laid out text.
666 void ClampHorizontalScroll( const Vector2& layoutSize );
669 * @biref Clamps the vertical scrolling to get the control always filled with text.
671 * @param[in] layoutSize The size of the laid out text.
673 void ClampVerticalScroll( const Vector2& layoutSize );
676 * @brief Scrolls the text to make a position visible.
678 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
680 * @param[in] position A position in text coords.
681 * @param[in] lineHeight The line height for the given position.
683 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
684 * or moving the selection handles.
686 void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
689 * @brief Scrolls the text to make the cursor visible.
691 * This method is called after deleting text.
693 void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
696 // Declared private and left undefined to avoid copies.
698 // Declared private and left undefined to avoid copies.
699 Impl& operator=( const Impl& );
703 ControlInterface* mControlInterface; ///< Reference to the text controller.
704 EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
705 ModelPtr mModel; ///< Pointer to the text's model.
706 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
707 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
708 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
709 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
710 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
711 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
712 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
713 Clipboard mClipboard; ///< Handle to the system clipboard
714 View mView; ///< The view interface to the rendering back-end.
715 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
716 Layout::Engine mLayoutEngine; ///< The layout engine.
717 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
718 Vector4 mTextColor; ///< The regular text color
719 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
720 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
721 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
722 HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode.
724 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
725 bool mMarkupProcessorEnabled:1; ///< Whether the mark-up procesor is enabled.
726 bool mClipboardHideEnabled:1; ///< Whether the ClipboardHide function work or not
727 bool mIsAutoScrollEnabled:1; ///< Whether auto text scrolling is enabled.
728 CharacterDirection mAutoScrollDirectionRTL:1; ///< Direction of auto scrolling, true if rtl
730 bool mUnderlineSetByString:1; ///< Set when underline is set by string (legacy) instead of map
731 bool mShadowSetByString:1; ///< Set when shadow is set by string (legacy) instead of map
732 bool mFontStyleSetByString:1; ///< Set when font style is set by string (legacy) instead of map
737 } // namespace Toolkit
741 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H