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/layouts/layout-engine.h>
27 #include <dali-toolkit/internal/text/logical-model-impl.h>
28 #include <dali-toolkit/internal/text/text-controller.h>
29 #include <dali-toolkit/internal/text/text-view.h>
30 #include <dali-toolkit/internal/text/visual-model-impl.h>
43 // Used to queue input events until DoRelayout()
51 LEFT_SELECTION_HANDLE_EVENT,
52 RIGHT_SELECTION_HANDLE_EVENT,
64 Event( Type eventType )
84 primaryCursorHeight( 0.f ),
85 secondaryCursorHeight( 0.f ),
86 isSecondaryCursor( false )
92 Vector2 primaryPosition; ///< The primary cursor's position.
93 Vector2 secondaryPosition; ///< The secondary cursor's position.
94 float lineHeight; ///< The height of the line where the cursor is placed.
95 float primaryCursorHeight; ///< The primary cursor's height.
96 float secondaryCursorHeight; ///< The secondary cursor's height.
97 bool isSecondaryCursor; ///< Whether the secondary cursor is valid.
110 EDITING_WITH_GRAB_HANDLE,
112 SELECTION_HANDLE_PANNING
115 EventData( DecoratorPtr decorator );
119 DecoratorPtr mDecorator; ///< Pointer to the decorator
120 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus
121 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive
122 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color
125 * This is used to delay handling events until after the model has been updated.
126 * The number of updates to the model is minimized to improve performance.
128 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
131 * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
132 * Typically this will have a negative value with scrolling occurs.
134 Vector2 mScrollPosition; ///< The text is offset by this position when scrolling.
136 State mState; ///< Selection mode, edit mode etc.
138 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
139 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
140 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
142 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
143 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
145 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
146 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
147 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
148 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
149 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
150 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
151 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
152 bool mHorizontalScrollingEnabled : 1; ///< True if horizontal scrolling is enabled.
153 bool mVerticalScrollingEnabled : 1; ///< True if vertical scrolling is enabled.
154 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
155 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
156 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
157 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
158 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
159 bool mAllTextSelected : 1; ///< True if the selection handles are selecting all the text
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(),
179 mDefaultPointSize(0.0f),
184 FontId GetFontId( TextAbstraction::FontClient& fontClient )
188 Dali::TextAbstraction::PointSize26Dot6 pointSize = mDefaultPointSize*64;
189 mFontId = fontClient.GetFontId( mFontDescription, pointSize );
195 TextAbstraction::FontDescription mFontDescription;
196 std::string mFontStyle;
197 float mDefaultPointSize;
201 struct Controller::Impl
203 Impl( ControlInterface& controlInterface )
204 : mControlInterface( controlInterface ),
207 mFontDefaults( NULL ),
215 mTextColor( Color::BLACK ),
217 mOperationsPending( NO_OPERATION ),
218 mMaximumNumberOfCharacters( 50 ),
219 mRecalculateNaturalSize( true ),
220 mUserDefinedFontFamily( false )
222 mLogicalModel = LogicalModel::New();
223 mVisualModel = VisualModel::New();
225 mFontClient = TextAbstraction::FontClient::Get();
226 mClipboard = Clipboard::Get();
228 mView.SetVisualModel( mVisualModel );
230 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
231 mMetrics = Metrics::New( mFontClient );
232 mLayoutEngine.SetMetrics( mMetrics );
234 // Set the text properties to default
235 mVisualModel->SetUnderlineEnabled( false );
236 mVisualModel->SetUnderlineHeight( 0.0f );
241 delete mFontDefaults;
246 * @brief Request a relayout using the ControlInterface.
248 void RequestRelayout();
251 * @brief Request a relayout using the ControlInterface.
253 void QueueModifyEvent( ModifyEvent::Type type )
255 if( ModifyEvent::TEXT_REPLACED == type)
257 // Cancel previously queued inserts etc.
258 mModifyEvents.clear();
263 mModifyEvents.push_back( event );
265 // The event will be processed during relayout
270 * @brief Helper to move the cursor, grab handle etc.
272 bool ProcessInputEvents();
275 * @brief Helper to check whether any place-holder text is available.
277 bool IsPlaceholderAvailable() const
279 return ( mEventData &&
280 ( !mEventData->mPlaceholderTextInactive.empty() ||
281 !mEventData->mPlaceholderTextActive.empty() )
285 bool IsShowingPlaceholderText() const
287 return ( mEventData && mEventData->mIsShowingPlaceholderText );
290 bool IsShowingRealText() const
292 return ( !IsShowingPlaceholderText() &&
293 0u != mLogicalModel->mText.Count() );
297 * @brief Called when placeholder-text is hidden
299 void PlaceholderCleared()
303 mEventData->mIsShowingPlaceholderText = false;
305 // Remove mPlaceholderTextColor
306 mVisualModel->SetTextColor( mTextColor );
310 void ClearPreEditFlag()
314 mEventData->mPreEditFlag = false;
315 mEventData->mPreEditStartPosition = 0;
316 mEventData->mPreEditLength = 0;
320 void ResetImfManager()
322 // Reset incase we are in a pre-edit state.
323 ImfManager imfManager = ImfManager::Get();
326 imfManager.Reset(); // Will trigger a commit message
332 bool IsClipboardEmpty()
334 bool result( mClipboard && mClipboard.NumberOfItems() );
335 return !result; // // If NumberOfItems greater than 0, return false
338 void UpdateModel( OperationsMask operationsRequired );
341 * @brief Retrieve the default fonts.
343 * @param[out] fonts The default font family, style and point sizes.
344 * @param[in] numberOfCharacters The number of characters in the logical model.
346 void GetDefaultFonts( Dali::Vector<FontRun>& fonts, Length numberOfCharacters );
349 * @brief Retrieve the line height of the default font.
351 float GetDefaultFontLineHeight();
353 void OnCursorKeyEvent( const Event& event );
355 void OnTapEvent( const Event& event );
357 void OnPanEvent( const Event& event );
359 void OnLongPressEvent( const Event& event );
361 void OnHandleEvent( const Event& event );
363 void OnSelectEvent( const Event& event );
365 void OnSelectAllEvent();
367 void RetrieveSelection( std::string& selectedText, bool deleteAfterRetreival );
369 void ShowClipboard();
371 void HideClipboard();
373 bool CopyStringToClipboard( std::string& source );
375 void SendSelectionToClipboard( bool deleteAfterSending );
377 void GetTextFromClipboard( unsigned int itemIndex, std::string& retreivedString );
379 void RepositionSelectionHandles( CharacterIndex selectionStart, CharacterIndex selectionEnd );
380 void RepositionSelectionHandles( float visualX, float visualY );
382 void SetPopupButtons();
384 void ChangeState( EventData::State newState );
385 LineIndex GetClosestLine( float y ) const;
387 void FindSelectionIndices( float visualX, float visualY, CharacterIndex& startIndex, CharacterIndex& endIndex );
390 * @brief Retrieves the cursor's logical position for a given touch point x,y
392 * @param[in] visualX The touch point x.
393 * @param[in] visualY The touch point y.
395 * @return 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.
397 CharacterIndex GetClosestCursorIndex( float visualX,
401 * @brief Calculates the cursor's position for a given character index in the logical order.
403 * It retrieves as well the line's height and the cursor's height and
404 * if there is a valid alternative cursor, its position and height.
406 * @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.
407 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
409 void GetCursorPosition( CharacterIndex logical,
410 CursorInfo& cursorInfo );
413 * @brief Calculates the new cursor index.
415 * It takes into account that in some scripts multiple characters can form a glyph and all of them
416 * need to be jumped with one key event.
418 * @param[in] index The initial new index.
420 * @return The new cursor index.
422 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
425 * @brief Updates the cursor position.
427 * Retrieves the x,y position of the cursor logical position and sets it into the decorator.
428 * It sets the position of the secondary cursor if it's a valid one.
429 * Sets which cursors are active.
431 void UpdateCursorPosition();
434 * @brief Updates the position of the given selection handle.
436 * @param[in] handleType One of the selection handles.
438 void UpdateSelectionHandle( HandleType handleType );
441 * @biref Clamps the horizontal scrolling to get the control always filled with text.
443 * @param[in] actualSize The size of the laid out text.
445 void ClampHorizontalScroll( const Vector2& actualSize );
448 * @biref Clamps the vertical scrolling to get the control always filled with text.
450 * @param[in] actualSize The size of the laid out text.
452 void ClampVerticalScroll( const Vector2& actualSize );
455 * @brief Scrolls the text to make a position visible.
457 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
459 * @param[in] position A position in decorator coords.
461 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
462 * or moving the selection handles.
464 void ScrollToMakePositionVisible( const Vector2& position );
467 * @brief Scrolls the text to make the cursor visible.
469 * This method is called after deleting text.
471 void ScrollTextToMatchCursor();
473 ControlInterface& mControlInterface; ///< Reference to the text controller.
474 LogicalModelPtr mLogicalModel; ///< Pointer to the logical model.
475 VisualModelPtr mVisualModel; ///< Pointer to the visual model.
476 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
477 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
478 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
479 Clipboard mClipboard; ///< Handle to the system clipboard
480 View mView; ///< The view interface to the rendering back-end.
481 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
482 LayoutEngine mLayoutEngine; ///< The layout engine.
483 std::vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
484 Vector4 mTextColor; ///< The regular text color
485 Vector2 mAlignmentOffset; ///< Vertical and horizontal offset of the whole text inside the control due to alignment.
486 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
487 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
489 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
490 bool mUserDefinedFontFamily:1; ///< Whether the Font family was set by the user instead of being left as sytem default.
495 } // namespace Toolkit
499 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__