1 #ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H__
2 #define __DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H__
5 * Copyright (c) 2015 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
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 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus.
109 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
110 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color.
113 * This is used to delay handling events until after the model has been updated.
114 * The number of updates to the model is minimized to improve performance.
116 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
118 InputStyle mInputStyle; ///< The style to be set to the new inputed text.
120 State mState; ///< Selection mode, edit mode etc.
122 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
123 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
124 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
126 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
127 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
129 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
130 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
131 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
132 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
133 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
134 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
135 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
136 bool mHorizontalScrollingEnabled : 1; ///< True if horizontal scrolling is enabled.
137 bool mVerticalScrollingEnabled : 1; ///< True if vertical scrolling is enabled.
138 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
139 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
140 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
141 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
142 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
143 bool mAllTextSelected : 1; ///< True if the selection handles are selecting all the text.
144 bool mUpdateInputStyle : 1; ///< Whether to update the input style after moving the cursor.
151 TEXT_REPLACED, ///< The entire text was replaced
152 TEXT_INSERTED, ///< Insert characters at the current cursor position
153 TEXT_DELETED ///< Characters were deleted
162 : mFontDescription(),
164 mDefaultPointSize( 0.f ),
166 familyDefined( false ),
167 weightDefined( false ),
168 widthDefined( false ),
169 slantDefined( false ),
172 // Initially use the default platform font
173 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
174 fontClient.GetDefaultPlatformFontDescription( mFontDescription );
177 FontId GetFontId( TextAbstraction::FontClient& fontClient )
181 const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( mDefaultPointSize * 64.f );
182 mFontId = fontClient.GetFontId( mFontDescription, pointSize );
188 TextAbstraction::FontDescription mFontDescription; ///< The default font's description.
189 std::string mFontStyle; ///< The font's style string set through the property system.
190 float mDefaultPointSize; ///< The default font's point size.
191 FontId mFontId; ///< The font's id of the default font.
192 bool familyDefined:1; ///< Whether the default font's family name is defined.
193 bool weightDefined:1; ///< Whether the default font's weight is defined.
194 bool widthDefined:1; ///< Whether the default font's width is defined.
195 bool slantDefined:1; ///< Whether the default font's slant is defined.
196 bool sizeDefined:1; ///< Whether the default font's point size is defined.
200 * @brief Stores indices used to update the text.
201 * Stores the character index where the text is updated and the number of characters removed and added.
202 * Stores as well indices to the first and the last paragraphs to be updated.
204 struct TextUpdateInfo
207 : mCharacterIndex( 0u ),
208 mNumberOfCharactersToRemove( 0u ),
209 mNumberOfCharactersToAdd( 0u ),
210 mPreviousNumberOfCharacters( 0u ),
211 mParagraphCharacterIndex( 0u ),
212 mRequestedNumberOfCharacters( 0u ),
213 mStartGlyphIndex( 0u ),
214 mStartLineIndex( 0u ),
215 mEstimatedNumberOfLines( 0u ),
217 mFullRelayoutNeeded( true ),
218 mIsLastCharacterNewParagraph( false )
224 CharacterIndex mCharacterIndex; ///< Index to the first character to be updated.
225 Length mNumberOfCharactersToRemove; ///< The number of characters to be removed.
226 Length mNumberOfCharactersToAdd; ///< The number of characters to be added.
227 Length mPreviousNumberOfCharacters; ///< The number of characters before the text update.
229 CharacterIndex mParagraphCharacterIndex; ///< Index of the first character of the first paragraph to be updated.
230 Length mRequestedNumberOfCharacters; ///< The requested number of characters.
231 GlyphIndex mStartGlyphIndex;
232 LineIndex mStartLineIndex;
233 Length mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting.
235 bool mClearAll:1; ///< Whether the whole text is cleared. i.e. when the text is reset.
236 bool mFullRelayoutNeeded:1; ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
237 bool mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
241 // Clear all info except the mPreviousNumberOfCharacters member.
242 mCharacterIndex = static_cast<CharacterIndex>( -1 );
243 mNumberOfCharactersToRemove = 0u;
244 mNumberOfCharactersToAdd = 0u;
245 mParagraphCharacterIndex = 0u;
246 mRequestedNumberOfCharacters = 0u;
247 mStartGlyphIndex = 0u;
248 mStartLineIndex = 0u;
249 mEstimatedNumberOfLines = 0u;
251 mFullRelayoutNeeded = false;
252 mIsLastCharacterNewParagraph = false;
256 struct UnderlineDefaults
258 std::string properties;
259 // TODO: complete with underline parameters.
262 struct ShadowDefaults
264 std::string properties;
265 // TODO: complete with shadow parameters.
268 struct EmbossDefaults
270 std::string properties;
271 // TODO: complete with emboss parameters.
274 struct OutlineDefaults
276 std::string properties;
277 // TODO: complete with outline parameters.
280 struct Controller::Impl
282 Impl( ControlInterface& controlInterface )
283 : mControlInterface( controlInterface ),
286 mFontDefaults( NULL ),
287 mUnderlineDefaults( NULL ),
288 mShadowDefaults( NULL ),
289 mEmbossDefaults( NULL ),
290 mOutlineDefaults( NULL ),
298 mTextColor( Color::BLACK ),
300 mOperationsPending( NO_OPERATION ),
301 mMaximumNumberOfCharacters( 50u ),
302 mRecalculateNaturalSize( true ),
303 mMarkupProcessorEnabled( false ),
304 mClipboardHideEnabled( true ),
305 mAutoScrollEnabled( false ),
306 mAutoScrollDirectionRTL( false )
308 mLogicalModel = LogicalModel::New();
309 mVisualModel = VisualModel::New();
311 mFontClient = TextAbstraction::FontClient::Get();
312 mClipboard = Clipboard::Get();
314 mView.SetVisualModel( mVisualModel );
316 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
317 mMetrics = Metrics::New( mFontClient );
318 mLayoutEngine.SetMetrics( mMetrics );
320 // Set the text properties to default
321 mVisualModel->SetUnderlineEnabled( false );
322 mVisualModel->SetUnderlineHeight( 0.0f );
327 delete mFontDefaults;
328 delete mUnderlineDefaults;
329 delete mShadowDefaults;
330 delete mEmbossDefaults;
331 delete mOutlineDefaults;
336 * @brief Request a relayout using the ControlInterface.
338 void RequestRelayout();
341 * @brief Request a relayout using the ControlInterface.
343 void QueueModifyEvent( ModifyEvent::Type type )
345 if( ModifyEvent::TEXT_REPLACED == type)
347 // Cancel previously queued inserts etc.
348 mModifyEvents.Clear();
353 mModifyEvents.PushBack( event );
355 // The event will be processed during relayout
360 * @brief Helper to move the cursor, grab handle etc.
362 bool ProcessInputEvents();
365 * @brief Helper to check whether any place-holder text is available.
367 bool IsPlaceholderAvailable() const
369 return ( mEventData &&
370 ( !mEventData->mPlaceholderTextInactive.empty() ||
371 !mEventData->mPlaceholderTextActive.empty() )
375 bool IsShowingPlaceholderText() const
377 return ( mEventData && mEventData->mIsShowingPlaceholderText );
381 * @brief Helper to check whether active place-holder text is available.
383 bool IsFocusedPlaceholderAvailable() const
385 return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
388 bool IsShowingRealText() const
390 return ( !IsShowingPlaceholderText() &&
391 0u != mLogicalModel->mText.Count() );
395 * @brief Called when placeholder-text is hidden
397 void PlaceholderCleared()
401 mEventData->mIsShowingPlaceholderText = false;
403 // Remove mPlaceholderTextColor
404 mVisualModel->SetTextColor( mTextColor );
408 void ClearPreEditFlag()
412 mEventData->mPreEditFlag = false;
413 mEventData->mPreEditStartPosition = 0;
414 mEventData->mPreEditLength = 0;
418 void ResetImfManager()
422 // Reset incase we are in a pre-edit state.
423 if( mEventData->mImfManager )
425 mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
433 * @brief Helper to notify IMF manager with surrounding text & cursor changes.
435 void NotifyImfManager();
438 * @brief Retrieve the current cursor position.
440 * @return The cursor position.
442 CharacterIndex GetLogicalCursorPosition() const;
445 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
447 * @param[in] index The character index from where to count the number of consecutive white spaces.
449 * @return The number of consecutive white spaces.
451 Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
454 * @brief Retrieve any text previously set starting from the given @p index.
456 * @param[in] index The character index from where to retrieve the text.
457 * @param[out] text A string of UTF-8 characters.
459 * @see Dali::Toolkit::Text::Controller::GetText()
461 void GetText( CharacterIndex index, std::string& text ) const;
463 bool IsClipboardEmpty()
465 bool result( mClipboard && mClipboard.NumberOfItems() );
466 return !result; // If NumberOfItems greater than 0, return false
470 * @brief Calculates the start character index of the first paragraph to be updated and
471 * the end character index of the last paragraph to be updated.
473 * @param[out] numberOfCharacters The number of characters to be updated.
475 void CalculateTextUpdateIndices( Length& numberOfCharacters );
478 * @brief Helper to clear completely the parts of the model specified by the given @p operations.
480 * @note It never clears the text stored in utf32.
482 void ClearFullModelData( OperationsMask operations );
485 * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
487 * @note It never clears the text stored in utf32.
489 * @param[in] startIndex Index to the first character to be cleared.
490 * @param[in] endIndex Index to the last character to be cleared.
491 * @param[in] operations The operations required.
493 void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
496 * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
498 * @note It never clears the text stored in utf32.
499 * @note Character indices are transformed to glyph indices.
501 * @param[in] startIndex Index to the first character to be cleared.
502 * @param[in] endIndex Index to the last character to be cleared.
503 * @param[in] operations The operations required.
505 void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
508 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
510 * @note It never clears the text stored in utf32.
512 * @param[in] startIndex Index to the first character to be cleared.
513 * @param[in] endIndex Index to the last character to be cleared.
514 * @param[in] operations The operations required.
516 void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
519 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
521 * When text or style changes the model is set with some operations pending.
522 * When i.e. the text's size or a relayout is required this method is called
523 * with a given @p operationsRequired parameter. The operations required are
524 * matched with the operations pending to perform the minimum number of operations.
526 * @param[in] operationsRequired The operations required.
528 * @return @e true if the model has been modified.
530 bool UpdateModel( OperationsMask operationsRequired );
533 * @brief Retreieves the default style.
535 * @param[out] inputStyle The default style.
537 void RetrieveDefaultInputStyle( InputStyle& inputStyle );
540 * @brief Retrieve the line height of the default font.
542 float GetDefaultFontLineHeight();
544 void OnCursorKeyEvent( const Event& event );
546 void OnTapEvent( const Event& event );
548 void OnPanEvent( const Event& event );
550 void OnLongPressEvent( const Event& event );
552 void OnHandleEvent( const Event& event );
554 void OnSelectEvent( const Event& event );
556 void OnSelectAllEvent();
559 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
561 * @param[out] selectedText The selected text encoded in utf8.
562 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
564 void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
566 void ShowClipboard();
568 void HideClipboard();
570 void SetClipboardHideEnable(bool enable);
572 bool CopyStringToClipboard( std::string& source );
574 void SendSelectionToClipboard( bool deleteAfterSending );
576 void GetTextFromClipboard( unsigned int itemIndex, std::string& retrievedString );
578 void RepositionSelectionHandles();
579 void RepositionSelectionHandles( float visualX, float visualY );
581 void SetPopupButtons();
583 void ChangeState( EventData::State newState );
586 * @brief Calculates the cursor's position for a given character index in the logical order.
588 * It retrieves as well the line's height and the cursor's height and
589 * if there is a valid alternative cursor, its position and height.
591 * @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.
592 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
594 void GetCursorPosition( CharacterIndex logical,
595 CursorInfo& cursorInfo );
598 * @brief Calculates the new cursor index.
600 * It takes into account that in some scripts multiple characters can form a glyph and all of them
601 * need to be jumped with one key event.
603 * @param[in] index The initial new index.
605 * @return The new cursor index.
607 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
610 * @brief Updates the cursor position.
612 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
613 * It sets the position of the secondary cursor if it's a valid one.
614 * Sets which cursors are active.
616 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
619 void UpdateCursorPosition( const CursorInfo& cursorInfo );
622 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
624 * @param[in] handleType One of the selection handles.
625 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
627 void UpdateSelectionHandle( HandleType handleType,
628 const CursorInfo& cursorInfo );
631 * @biref Clamps the horizontal scrolling to get the control always filled with text.
633 * @param[in] actualSize The size of the laid out text.
635 void ClampHorizontalScroll( const Vector2& actualSize );
638 * @biref Clamps the vertical scrolling to get the control always filled with text.
640 * @param[in] actualSize The size of the laid out text.
642 void ClampVerticalScroll( const Vector2& actualSize );
645 * @brief Scrolls the text to make a position visible.
647 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
649 * @param[in] position A position in text coords.
651 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
652 * or moving the selection handles.
654 void ScrollToMakePositionVisible( const Vector2& position );
657 * @brief Scrolls the text to make the cursor visible.
659 * This method is called after deleting text.
661 void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
664 // Declared private and left undefined to avoid copies.
666 // Declared private and left undefined to avoid copies.
667 Impl& operator=( const Impl& );
671 ControlInterface& mControlInterface; ///< Reference to the text controller.
672 LogicalModelPtr mLogicalModel; ///< Pointer to the logical model.
673 VisualModelPtr mVisualModel; ///< Pointer to the visual model.
674 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
675 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
676 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
677 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
678 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
679 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
680 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
681 Clipboard mClipboard; ///< Handle to the system clipboard
682 View mView; ///< The view interface to the rendering back-end.
683 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
684 LayoutEngine mLayoutEngine; ///< The layout engine.
685 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
686 Vector4 mTextColor; ///< The regular text color
688 * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
689 * Typically this will have a negative value with scrolling occurs.
691 Vector2 mScrollPosition; ///< The text is offset by this position when scrolling.
692 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
693 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
694 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
696 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
697 bool mMarkupProcessorEnabled:1; ///< Whether the mark-up procesor is enabled.
698 bool mClipboardHideEnabled:1; ///< Whether the ClipboardHide function work or not
699 bool mAutoScrollEnabled:1; ///< Whether auto text scrolling is enabled.
700 CharacterDirection mAutoScrollDirectionRTL:1; ///< Direction of auto scrolling, true if rtl
706 } // namespace Toolkit
710 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__