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 mPlaceholderText; ///< The text to display when the TextField is empty.
110 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus.
111 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
112 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color.
115 * This is used to delay handling events until after the model has been updated.
116 * The number of updates to the model is minimized to improve performance.
118 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
120 Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
122 InputStyle mInputStyle; ///< The style to be set to the new inputed text.
124 State mPreviousState; ///< Stores the current state before it's updated with the new one.
125 State mState; ///< Selection mode, edit mode etc.
127 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
128 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
129 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
131 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
132 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
134 float mCursorHookPositionX; ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles.
136 Controller::NoTextTap::Action mDoubleTapAction; ///< Action to be done when there is a double tap on top of 'no text'
137 Controller::NoTextTap::Action mLongPressAction; ///< Action to be done when there is a long press on top of 'no text'
139 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
140 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
141 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
142 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
143 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
144 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
145 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
146 bool mUpdateCursorHookPosition : 1; ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
147 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
148 bool mUpdateGrabHandlePosition : 1; ///< True if the visual position of the grab handle must be recalculated.
149 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
150 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
151 bool mIsLeftHandleSelected : 1; ///< Whether is the left handle the one which is selected.
152 bool mIsRightHandleSelected : 1; ///< Whether is the right handle the one which is selected.
153 bool mUpdateHighlightBox : 1; ///< True if the text selection high light box must be updated.
154 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
155 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
156 bool mAllTextSelected : 1; ///< True if the selection handles are selecting all the text.
157 bool mUpdateInputStyle : 1; ///< Whether to update the input style after moving the cursor.
158 bool mPasswordInput : 1; ///< True if password input is enabled.
159 bool mCheckScrollAmount : 1; ///< Whether to check scrolled amount after updating the position
160 bool mIsPlaceholderPixelSize : 1; ///< True if the placeholder font size is set as pixel size.
167 TEXT_REPLACED, ///< The entire text was replaced
168 TEXT_INSERTED, ///< Insert characters at the current cursor position
169 TEXT_DELETED ///< Characters were deleted
178 : mFontDescription(),
179 mDefaultPointSize( 0.f ),
181 familyDefined( false ),
182 weightDefined( false ),
183 widthDefined( false ),
184 slantDefined( false ),
187 // Initially use the default platform font
188 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
189 fontClient.GetDefaultPlatformFontDescription( mFontDescription );
192 FontId GetFontId( TextAbstraction::FontClient& fontClient )
196 const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( mDefaultPointSize * 64.f );
197 mFontId = fontClient.GetFontId( mFontDescription, pointSize );
203 TextAbstraction::FontDescription mFontDescription; ///< The default font's description.
204 float mDefaultPointSize; ///< The default font's point size.
205 FontId mFontId; ///< The font's id of the default font.
206 bool familyDefined:1; ///< Whether the default font's family name is defined.
207 bool weightDefined:1; ///< Whether the default font's weight is defined.
208 bool widthDefined:1; ///< Whether the default font's width is defined.
209 bool slantDefined:1; ///< Whether the default font's slant is defined.
210 bool sizeDefined:1; ///< Whether the default font's point size is defined.
214 * @brief Stores indices used to update the text.
215 * Stores the character index where the text is updated and the number of characters removed and added.
216 * Stores as well indices to the first and the last paragraphs to be updated.
218 struct TextUpdateInfo
221 : mCharacterIndex( 0u ),
222 mNumberOfCharactersToRemove( 0u ),
223 mNumberOfCharactersToAdd( 0u ),
224 mPreviousNumberOfCharacters( 0u ),
225 mParagraphCharacterIndex( 0u ),
226 mRequestedNumberOfCharacters( 0u ),
227 mStartGlyphIndex( 0u ),
228 mStartLineIndex( 0u ),
229 mEstimatedNumberOfLines( 0u ),
231 mFullRelayoutNeeded( true ),
232 mIsLastCharacterNewParagraph( false )
238 CharacterIndex mCharacterIndex; ///< Index to the first character to be updated.
239 Length mNumberOfCharactersToRemove; ///< The number of characters to be removed.
240 Length mNumberOfCharactersToAdd; ///< The number of characters to be added.
241 Length mPreviousNumberOfCharacters; ///< The number of characters before the text update.
243 CharacterIndex mParagraphCharacterIndex; ///< Index of the first character of the first paragraph to be updated.
244 Length mRequestedNumberOfCharacters; ///< The requested number of characters.
245 GlyphIndex mStartGlyphIndex;
246 LineIndex mStartLineIndex;
247 Length mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting.
249 bool mClearAll:1; ///< Whether the whole text is cleared. i.e. when the text is reset.
250 bool mFullRelayoutNeeded:1; ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
251 bool mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
255 // Clear all info except the mPreviousNumberOfCharacters member.
256 mCharacterIndex = static_cast<CharacterIndex>( -1 );
257 mNumberOfCharactersToRemove = 0u;
258 mNumberOfCharactersToAdd = 0u;
259 mParagraphCharacterIndex = 0u;
260 mRequestedNumberOfCharacters = 0u;
261 mStartGlyphIndex = 0u;
262 mStartLineIndex = 0u;
263 mEstimatedNumberOfLines = 0u;
265 mFullRelayoutNeeded = false;
266 mIsLastCharacterNewParagraph = false;
270 struct UnderlineDefaults
272 std::string properties;
273 // TODO: complete with underline parameters.
276 struct ShadowDefaults
278 std::string properties;
279 // TODO: complete with shadow parameters.
282 struct EmbossDefaults
284 std::string properties;
285 // TODO: complete with emboss parameters.
288 struct OutlineDefaults
290 std::string properties;
291 // TODO: complete with outline parameters.
294 struct Controller::Impl
296 Impl( ControlInterface* controlInterface,
297 EditableControlInterface* editableControlInterface )
298 : mControlInterface( controlInterface ),
299 mEditableControlInterface( editableControlInterface ),
301 mFontDefaults( NULL ),
302 mUnderlineDefaults( NULL ),
303 mShadowDefaults( NULL ),
304 mEmbossDefaults( NULL ),
305 mOutlineDefaults( NULL ),
312 mTextColor( Color::BLACK ),
314 mOperationsPending( NO_OPERATION ),
315 mMaximumNumberOfCharacters( 50u ),
316 mHiddenInput( NULL ),
317 mRecalculateNaturalSize( true ),
318 mMarkupProcessorEnabled( false ),
319 mClipboardHideEnabled( true ),
320 mIsAutoScrollEnabled( false ),
321 mAutoScrollDirectionRTL( false ),
322 mUnderlineSetByString( false ),
323 mShadowSetByString( false ),
324 mFontStyleSetByString( false )
326 mModel = Model::New();
328 mFontClient = TextAbstraction::FontClient::Get();
329 mClipboard = Clipboard::Get();
331 mView.SetVisualModel( mModel->mVisualModel );
333 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
334 mMetrics = Metrics::New( mFontClient );
335 mLayoutEngine.SetMetrics( mMetrics );
337 // Set the text properties to default
338 mModel->mVisualModel->SetUnderlineEnabled( false );
339 mModel->mVisualModel->SetUnderlineHeight( 0.0f );
346 delete mFontDefaults;
347 delete mUnderlineDefaults;
348 delete mShadowDefaults;
349 delete mEmbossDefaults;
350 delete mOutlineDefaults;
354 // Text Controller Implementation.
357 * @copydoc Text::Controller::RequestRelayout()
359 void RequestRelayout();
362 * @brief Request a relayout using the ControlInterface.
364 void QueueModifyEvent( ModifyEvent::Type type )
366 if( ModifyEvent::TEXT_REPLACED == type)
368 // Cancel previously queued inserts etc.
369 mModifyEvents.Clear();
374 mModifyEvents.PushBack( event );
376 // The event will be processed during relayout
381 * @brief Helper to move the cursor, grab handle etc.
383 bool ProcessInputEvents();
386 * @brief Helper to check whether any place-holder text is available.
388 bool IsPlaceholderAvailable() const
390 return ( mEventData && ( !mEventData->mPlaceholderText.empty() ||
391 !mEventData->mPlaceholderTextInactive.empty() ||
392 !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() ||
406 !mEventData->mPlaceholderText.empty() ) );
409 bool IsShowingRealText() const
411 return ( !IsShowingPlaceholderText() &&
412 0u != mModel->mLogicalModel->mText.Count() );
416 * @brief Called when placeholder-text is hidden
418 void PlaceholderCleared()
422 mEventData->mIsShowingPlaceholderText = false;
424 // Remove mPlaceholderTextColor
425 mModel->mVisualModel->SetTextColor( mTextColor );
429 void ClearPreEditFlag()
433 mEventData->mPreEditFlag = false;
434 mEventData->mPreEditStartPosition = 0;
435 mEventData->mPreEditLength = 0;
439 void ResetImfManager()
443 // Reset incase we are in a pre-edit state.
444 if( mEventData->mImfManager )
446 mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
454 * @brief Helper to notify IMF manager with surrounding text & cursor changes.
456 void NotifyImfManager();
459 * @brief Helper to notify IMF manager with multi line status.
461 void NotifyImfMultiLineStatus();
464 * @brief Retrieve the current cursor position.
466 * @return The cursor position.
468 CharacterIndex GetLogicalCursorPosition() const;
471 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
473 * @param[in] index The character index from where to count the number of consecutive white spaces.
475 * @return The number of consecutive white spaces.
477 Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
480 * @brief Retrieve any text previously set starting from the given @p index.
482 * @param[in] index The character index from where to retrieve the text.
483 * @param[out] text A string of UTF-8 characters.
485 * @see Dali::Toolkit::Text::Controller::GetText()
487 void GetText( CharacterIndex index, std::string& text ) const;
489 bool IsClipboardEmpty()
491 bool result( mClipboard && mClipboard.NumberOfItems() );
492 return !result; // If NumberOfItems greater than 0, return false
495 bool IsClipboardVisible()
497 bool result( mClipboard && mClipboard.IsVisible() );
502 * @brief Calculates the start character index of the first paragraph to be updated and
503 * the end character index of the last paragraph to be updated.
505 * @param[out] numberOfCharacters The number of characters to be updated.
507 void CalculateTextUpdateIndices( Length& numberOfCharacters );
510 * @brief Helper to clear completely the parts of the model specified by the given @p operations.
512 * @note It never clears the text stored in utf32.
514 void ClearFullModelData( OperationsMask operations );
517 * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
519 * @note It never clears the text stored in utf32.
521 * @param[in] startIndex Index to the first character to be cleared.
522 * @param[in] endIndex Index to the last character to be cleared.
523 * @param[in] operations The operations required.
525 void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
528 * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
530 * @note It never clears the text stored in utf32.
531 * @note Character indices are transformed to glyph indices.
533 * @param[in] startIndex Index to the first character to be cleared.
534 * @param[in] endIndex Index to the last character to be cleared.
535 * @param[in] operations The operations required.
537 void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
540 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
542 * @note It never clears the text stored in utf32.
544 * @param[in] startIndex Index to the first character to be cleared.
545 * @param[in] endIndex Index to the last character to be cleared.
546 * @param[in] operations The operations required.
548 void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
551 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
553 * When text or style changes the model is set with some operations pending.
554 * When i.e. the text's size or a relayout is required this method is called
555 * with a given @p operationsRequired parameter. The operations required are
556 * matched with the operations pending to perform the minimum number of operations.
558 * @param[in] operationsRequired The operations required.
560 * @return @e true if the model has been modified.
562 bool UpdateModel( OperationsMask operationsRequired );
565 * @brief Retreieves the default style.
567 * @param[out] inputStyle The default style.
569 void RetrieveDefaultInputStyle( InputStyle& inputStyle );
572 * @brief Retrieve the line height of the default font.
574 float GetDefaultFontLineHeight();
576 void OnCursorKeyEvent( const Event& event );
578 void OnTapEvent( const Event& event );
580 void OnPanEvent( const Event& event );
582 void OnLongPressEvent( const Event& event );
584 void OnHandleEvent( const Event& event );
586 void OnSelectEvent( const Event& event );
588 void OnSelectAllEvent();
591 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
593 * @param[out] selectedText The selected text encoded in utf8.
594 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
596 void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
598 void ShowClipboard();
600 void HideClipboard();
602 void SetClipboardHideEnable(bool enable);
604 bool CopyStringToClipboard( std::string& source );
606 void SendSelectionToClipboard( bool deleteAfterSending );
608 void RequestGetTextFromClipboard();
610 void RepositionSelectionHandles();
611 void RepositionSelectionHandles( float visualX, float visualY, Controller::NoTextTap::Action action );
613 void SetPopupButtons();
615 void ChangeState( EventData::State newState );
618 * @brief Calculates the cursor's position for a given character index in the logical order.
620 * It retrieves as well the line's height and the cursor's height and
621 * if there is a valid alternative cursor, its position and height.
623 * @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.
624 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
626 void GetCursorPosition( CharacterIndex logical,
627 CursorInfo& cursorInfo );
630 * @brief Calculates the new cursor index.
632 * It takes into account that in some scripts multiple characters can form a glyph and all of them
633 * need to be jumped with one key event.
635 * @param[in] index The initial new index.
637 * @return The new cursor index.
639 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
642 * @brief Updates the cursor position.
644 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
645 * It sets the position of the secondary cursor if it's a valid one.
646 * Sets which cursors are active.
648 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
651 void UpdateCursorPosition( const CursorInfo& cursorInfo );
654 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
656 * @param[in] handleType One of the selection handles.
657 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
659 void UpdateSelectionHandle( HandleType handleType,
660 const CursorInfo& cursorInfo );
663 * @biref Clamps the horizontal scrolling to get the control always filled with text.
665 * @param[in] layoutSize The size of the laid out text.
667 void ClampHorizontalScroll( const Vector2& layoutSize );
670 * @biref Clamps the vertical scrolling to get the control always filled with text.
672 * @param[in] layoutSize The size of the laid out text.
674 void ClampVerticalScroll( const Vector2& layoutSize );
677 * @brief Scrolls the text to make a position visible.
679 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
681 * @param[in] position A position in text coords.
682 * @param[in] lineHeight The line height for the given position.
684 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
685 * or moving the selection handles.
687 void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
690 * @brief Scrolls the text to make the cursor visible.
692 * This method is called after deleting text.
694 void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
697 // Declared private and left undefined to avoid copies.
699 // Declared private and left undefined to avoid copies.
700 Impl& operator=( const Impl& );
704 ControlInterface* mControlInterface; ///< Reference to the text controller.
705 EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
706 ModelPtr mModel; ///< Pointer to the text's model.
707 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
708 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
709 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
710 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
711 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
712 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
713 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
714 Clipboard mClipboard; ///< Handle to the system clipboard
715 View mView; ///< The view interface to the rendering back-end.
716 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
717 Layout::Engine mLayoutEngine; ///< The layout engine.
718 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
719 Vector4 mTextColor; ///< The regular text color
720 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
721 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
722 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
723 HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode.
725 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
726 bool mMarkupProcessorEnabled:1; ///< Whether the mark-up procesor is enabled.
727 bool mClipboardHideEnabled:1; ///< Whether the ClipboardHide function work or not
728 bool mIsAutoScrollEnabled:1; ///< Whether auto text scrolling is enabled.
729 CharacterDirection mAutoScrollDirectionRTL:1; ///< Direction of auto scrolling, true if rtl
731 bool mUnderlineSetByString:1; ///< Set when underline is set by string (legacy) instead of map
732 bool mShadowSetByString:1; ///< Set when shadow is set by string (legacy) instead of map
733 bool mFontStyleSetByString:1; ///< Set when font style is set by string (legacy) instead of map
738 } // namespace Toolkit
742 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H