1 #ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H__
2 #define __DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H__
5 * Copyright (c) 2016 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/layouts/layout-engine.h>
28 #include <dali-toolkit/internal/text/logical-model-impl.h>
29 #include <dali-toolkit/internal/text/text-controller.h>
30 #include <dali-toolkit/internal/text/text-view.h>
31 #include <dali-toolkit/internal/text/visual-model-impl.h>
42 //Forward declarations
47 // Used to queue input events until DoRelayout()
55 LEFT_SELECTION_HANDLE_EVENT,
56 RIGHT_SELECTION_HANDLE_EVENT,
68 Event( Type eventType )
91 EDITING_WITH_GRAB_HANDLE,
92 EDITING_WITH_PASTE_POPUP,
94 SELECTION_HANDLE_PANNING,
98 EventData( DecoratorPtr decorator );
102 static bool IsEditingState( State stateToCheck )
104 return ( stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP );
107 DecoratorPtr mDecorator; ///< Pointer to the decorator.
108 ImfManager mImfManager; ///< The Input Method Framework Manager.
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 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
136 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
137 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
138 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
139 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
140 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
141 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
142 bool mUpdateCursorHookPosition : 1; ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
143 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
144 bool mUpdateGrabHandlePosition : 1; ///< True if the visual position of the grab handle must be recalculated.
145 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
146 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
147 bool mIsLeftHandleSelected : 1; ///< Whether is the left handle the one which is selected.
148 bool mUpdateHighlightBox : 1; ///< True if the text selection high light box must be updated.
149 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
150 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
151 bool mAllTextSelected : 1; ///< True if the selection handles are selecting all the text.
152 bool mUpdateInputStyle : 1; ///< Whether to update the input style after moving the cursor.
159 TEXT_REPLACED, ///< The entire text was replaced
160 TEXT_INSERTED, ///< Insert characters at the current cursor position
161 TEXT_DELETED ///< Characters were deleted
170 : mFontDescription(),
171 mDefaultPointSize( 0.f ),
173 familyDefined( false ),
174 weightDefined( false ),
175 widthDefined( false ),
176 slantDefined( false ),
179 // Initially use the default platform font
180 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
181 fontClient.GetDefaultPlatformFontDescription( mFontDescription );
184 FontId GetFontId( TextAbstraction::FontClient& fontClient )
188 const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( mDefaultPointSize * 64.f );
189 mFontId = fontClient.GetFontId( mFontDescription, pointSize );
195 TextAbstraction::FontDescription mFontDescription; ///< The default font's description.
196 float mDefaultPointSize; ///< The default font's point size.
197 FontId mFontId; ///< The font's id of the default font.
198 bool familyDefined:1; ///< Whether the default font's family name is defined.
199 bool weightDefined:1; ///< Whether the default font's weight is defined.
200 bool widthDefined:1; ///< Whether the default font's width is defined.
201 bool slantDefined:1; ///< Whether the default font's slant is defined.
202 bool sizeDefined:1; ///< Whether the default font's point size is defined.
206 * @brief Stores indices used to update the text.
207 * Stores the character index where the text is updated and the number of characters removed and added.
208 * Stores as well indices to the first and the last paragraphs to be updated.
210 struct TextUpdateInfo
213 : mCharacterIndex( 0u ),
214 mNumberOfCharactersToRemove( 0u ),
215 mNumberOfCharactersToAdd( 0u ),
216 mPreviousNumberOfCharacters( 0u ),
217 mParagraphCharacterIndex( 0u ),
218 mRequestedNumberOfCharacters( 0u ),
219 mStartGlyphIndex( 0u ),
220 mStartLineIndex( 0u ),
221 mEstimatedNumberOfLines( 0u ),
223 mFullRelayoutNeeded( true ),
224 mIsLastCharacterNewParagraph( false )
230 CharacterIndex mCharacterIndex; ///< Index to the first character to be updated.
231 Length mNumberOfCharactersToRemove; ///< The number of characters to be removed.
232 Length mNumberOfCharactersToAdd; ///< The number of characters to be added.
233 Length mPreviousNumberOfCharacters; ///< The number of characters before the text update.
235 CharacterIndex mParagraphCharacterIndex; ///< Index of the first character of the first paragraph to be updated.
236 Length mRequestedNumberOfCharacters; ///< The requested number of characters.
237 GlyphIndex mStartGlyphIndex;
238 LineIndex mStartLineIndex;
239 Length mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting.
241 bool mClearAll:1; ///< Whether the whole text is cleared. i.e. when the text is reset.
242 bool mFullRelayoutNeeded:1; ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
243 bool mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
247 // Clear all info except the mPreviousNumberOfCharacters member.
248 mCharacterIndex = static_cast<CharacterIndex>( -1 );
249 mNumberOfCharactersToRemove = 0u;
250 mNumberOfCharactersToAdd = 0u;
251 mParagraphCharacterIndex = 0u;
252 mRequestedNumberOfCharacters = 0u;
253 mStartGlyphIndex = 0u;
254 mStartLineIndex = 0u;
255 mEstimatedNumberOfLines = 0u;
257 mFullRelayoutNeeded = false;
258 mIsLastCharacterNewParagraph = false;
262 struct UnderlineDefaults
264 std::string properties;
265 // TODO: complete with underline parameters.
268 struct ShadowDefaults
270 std::string properties;
271 // TODO: complete with shadow parameters.
274 struct EmbossDefaults
276 std::string properties;
277 // TODO: complete with emboss parameters.
280 struct OutlineDefaults
282 std::string properties;
283 // TODO: complete with outline parameters.
286 struct Controller::Impl
288 Impl( ControlInterface& controlInterface )
289 : mControlInterface( controlInterface ),
292 mFontDefaults( NULL ),
293 mUnderlineDefaults( NULL ),
294 mShadowDefaults( NULL ),
295 mEmbossDefaults( NULL ),
296 mOutlineDefaults( NULL ),
304 mTextColor( Color::BLACK ),
306 mOperationsPending( NO_OPERATION ),
307 mMaximumNumberOfCharacters( 50u ),
308 mRecalculateNaturalSize( true ),
309 mMarkupProcessorEnabled( false ),
310 mClipboardHideEnabled( true ),
311 mAutoScrollEnabled( false ),
312 mAutoScrollDirectionRTL( false )
314 mLogicalModel = LogicalModel::New();
315 mVisualModel = VisualModel::New();
317 mFontClient = TextAbstraction::FontClient::Get();
318 mClipboard = Clipboard::Get();
320 mView.SetVisualModel( mVisualModel );
322 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
323 mMetrics = Metrics::New( mFontClient );
324 mLayoutEngine.SetMetrics( mMetrics );
326 // Set the text properties to default
327 mVisualModel->SetUnderlineEnabled( false );
328 mVisualModel->SetUnderlineHeight( 0.0f );
333 delete mFontDefaults;
334 delete mUnderlineDefaults;
335 delete mShadowDefaults;
336 delete mEmbossDefaults;
337 delete mOutlineDefaults;
342 * @brief Request a relayout using the ControlInterface.
344 void RequestRelayout();
347 * @brief Request a relayout using the ControlInterface.
349 void QueueModifyEvent( ModifyEvent::Type type )
351 if( ModifyEvent::TEXT_REPLACED == type)
353 // Cancel previously queued inserts etc.
354 mModifyEvents.Clear();
359 mModifyEvents.PushBack( event );
361 // The event will be processed during relayout
366 * @brief Helper to move the cursor, grab handle etc.
368 bool ProcessInputEvents();
371 * @brief Helper to check whether any place-holder text is available.
373 bool IsPlaceholderAvailable() const
375 return ( mEventData &&
376 ( !mEventData->mPlaceholderTextInactive.empty() ||
377 !mEventData->mPlaceholderTextActive.empty() )
381 bool IsShowingPlaceholderText() const
383 return ( mEventData && mEventData->mIsShowingPlaceholderText );
387 * @brief Helper to check whether active place-holder text is available.
389 bool IsFocusedPlaceholderAvailable() const
391 return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
394 bool IsShowingRealText() const
396 return ( !IsShowingPlaceholderText() &&
397 0u != mLogicalModel->mText.Count() );
401 * @brief Called when placeholder-text is hidden
403 void PlaceholderCleared()
407 mEventData->mIsShowingPlaceholderText = false;
409 // Remove mPlaceholderTextColor
410 mVisualModel->SetTextColor( mTextColor );
414 void ClearPreEditFlag()
418 mEventData->mPreEditFlag = false;
419 mEventData->mPreEditStartPosition = 0;
420 mEventData->mPreEditLength = 0;
424 void ResetImfManager()
428 // Reset incase we are in a pre-edit state.
429 if( mEventData->mImfManager )
431 mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
439 * @brief Helper to notify IMF manager with surrounding text & cursor changes.
441 void NotifyImfManager();
444 * @brief Helper to notify IMF manager with multi line status.
446 void NotifyImfMultiLineStatus();
449 * @brief Retrieve the current cursor position.
451 * @return The cursor position.
453 CharacterIndex GetLogicalCursorPosition() const;
456 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
458 * @param[in] index The character index from where to count the number of consecutive white spaces.
460 * @return The number of consecutive white spaces.
462 Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
465 * @brief Retrieve any text previously set starting from the given @p index.
467 * @param[in] index The character index from where to retrieve the text.
468 * @param[out] text A string of UTF-8 characters.
470 * @see Dali::Toolkit::Text::Controller::GetText()
472 void GetText( CharacterIndex index, std::string& text ) const;
474 bool IsClipboardEmpty()
476 bool result( mClipboard && mClipboard.NumberOfItems() );
477 return !result; // If NumberOfItems greater than 0, return false
480 bool IsClipboardVisible()
482 bool result( mClipboard && mClipboard.IsVisible() );
487 * @brief Calculates the start character index of the first paragraph to be updated and
488 * the end character index of the last paragraph to be updated.
490 * @param[out] numberOfCharacters The number of characters to be updated.
492 void CalculateTextUpdateIndices( Length& numberOfCharacters );
495 * @brief Helper to clear completely the parts of the model specified by the given @p operations.
497 * @note It never clears the text stored in utf32.
499 void ClearFullModelData( OperationsMask operations );
502 * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
504 * @note It never clears the text stored in utf32.
506 * @param[in] startIndex Index to the first character to be cleared.
507 * @param[in] endIndex Index to the last character to be cleared.
508 * @param[in] operations The operations required.
510 void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
513 * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
515 * @note It never clears the text stored in utf32.
516 * @note Character indices are transformed to glyph indices.
518 * @param[in] startIndex Index to the first character to be cleared.
519 * @param[in] endIndex Index to the last character to be cleared.
520 * @param[in] operations The operations required.
522 void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
525 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
527 * @note It never clears the text stored in utf32.
529 * @param[in] startIndex Index to the first character to be cleared.
530 * @param[in] endIndex Index to the last character to be cleared.
531 * @param[in] operations The operations required.
533 void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
536 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
538 * When text or style changes the model is set with some operations pending.
539 * When i.e. the text's size or a relayout is required this method is called
540 * with a given @p operationsRequired parameter. The operations required are
541 * matched with the operations pending to perform the minimum number of operations.
543 * @param[in] operationsRequired The operations required.
545 * @return @e true if the model has been modified.
547 bool UpdateModel( OperationsMask operationsRequired );
550 * @brief Retreieves the default style.
552 * @param[out] inputStyle The default style.
554 void RetrieveDefaultInputStyle( InputStyle& inputStyle );
557 * @brief Retrieve the line height of the default font.
559 float GetDefaultFontLineHeight();
561 void OnCursorKeyEvent( const Event& event );
563 void OnTapEvent( const Event& event );
565 void OnPanEvent( const Event& event );
567 void OnLongPressEvent( const Event& event );
569 void OnHandleEvent( const Event& event );
571 void OnSelectEvent( const Event& event );
573 void OnSelectAllEvent();
576 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
578 * @param[out] selectedText The selected text encoded in utf8.
579 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
581 void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
583 void ShowClipboard();
585 void HideClipboard();
587 void SetClipboardHideEnable(bool enable);
589 bool CopyStringToClipboard( std::string& source );
591 void SendSelectionToClipboard( bool deleteAfterSending );
593 void RequestGetTextFromClipboard();
595 void RepositionSelectionHandles();
596 void RepositionSelectionHandles( float visualX, float visualY );
598 void SetPopupButtons();
600 void ChangeState( EventData::State newState );
603 * @brief Calculates the cursor's position for a given character index in the logical order.
605 * It retrieves as well the line's height and the cursor's height and
606 * if there is a valid alternative cursor, its position and height.
608 * @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.
609 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
611 void GetCursorPosition( CharacterIndex logical,
612 CursorInfo& cursorInfo );
615 * @brief Calculates the new cursor index.
617 * It takes into account that in some scripts multiple characters can form a glyph and all of them
618 * need to be jumped with one key event.
620 * @param[in] index The initial new index.
622 * @return The new cursor index.
624 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
627 * @brief Updates the cursor position.
629 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
630 * It sets the position of the secondary cursor if it's a valid one.
631 * Sets which cursors are active.
633 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
636 void UpdateCursorPosition( const CursorInfo& cursorInfo );
639 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
641 * @param[in] handleType One of the selection handles.
642 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
644 void UpdateSelectionHandle( HandleType handleType,
645 const CursorInfo& cursorInfo );
648 * @biref Clamps the horizontal scrolling to get the control always filled with text.
650 * @param[in] layoutSize The size of the laid out text.
652 void ClampHorizontalScroll( const Vector2& layoutSize );
655 * @biref Clamps the vertical scrolling to get the control always filled with text.
657 * @param[in] layoutSize The size of the laid out text.
659 void ClampVerticalScroll( const Vector2& layoutSize );
662 * @brief Scrolls the text to make a position visible.
664 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
666 * @param[in] position A position in text coords.
667 * @param[in] lineHeight The line height for the given position.
669 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
670 * or moving the selection handles.
672 void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
675 * @brief Scrolls the text to make the cursor visible.
677 * This method is called after deleting text.
679 void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
682 // Declared private and left undefined to avoid copies.
684 // Declared private and left undefined to avoid copies.
685 Impl& operator=( const Impl& );
689 ControlInterface& mControlInterface; ///< Reference to the text controller.
690 LogicalModelPtr mLogicalModel; ///< Pointer to the logical model.
691 VisualModelPtr mVisualModel; ///< Pointer to the visual model.
692 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
693 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
694 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
695 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
696 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
697 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
698 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
699 Clipboard mClipboard; ///< Handle to the system clipboard
700 View mView; ///< The view interface to the rendering back-end.
701 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
702 LayoutEngine mLayoutEngine; ///< The layout engine.
703 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
704 Vector4 mTextColor; ///< The regular text color
706 * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
707 * Typically this will have a negative value with scrolling occurs.
709 Vector2 mScrollPosition; ///< The text is offset by this position when scrolling.
710 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
711 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
712 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
714 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
715 bool mMarkupProcessorEnabled:1; ///< Whether the mark-up procesor is enabled.
716 bool mClipboardHideEnabled:1; ///< Whether the ClipboardHide function work or not
717 bool mAutoScrollEnabled:1; ///< Whether auto text scrolling is enabled.
718 CharacterDirection mAutoScrollDirectionRTL:1; ///< Direction of auto scrolling, true if rtl
724 } // namespace Toolkit
728 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__