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),
182 // Initially use the default platform font
183 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
184 fontClient.GetDefaultPlatformFontDescription( mFontDescription );
187 FontId GetFontId( TextAbstraction::FontClient& fontClient )
191 Dali::TextAbstraction::PointSize26Dot6 pointSize = mDefaultPointSize*64;
192 mFontId = fontClient.GetFontId( mFontDescription, pointSize );
198 TextAbstraction::FontDescription mFontDescription;
199 std::string mFontStyle;
200 float mDefaultPointSize;
204 struct Controller::Impl
206 Impl( ControlInterface& controlInterface )
207 : mControlInterface( controlInterface ),
210 mFontDefaults( NULL ),
218 mTextColor( Color::BLACK ),
220 mOperationsPending( NO_OPERATION ),
221 mMaximumNumberOfCharacters( 50 ),
222 mRecalculateNaturalSize( true ),
223 mUserDefinedFontFamily( false )
225 mLogicalModel = LogicalModel::New();
226 mVisualModel = VisualModel::New();
228 mFontClient = TextAbstraction::FontClient::Get();
229 mClipboard = Clipboard::Get();
231 mView.SetVisualModel( mVisualModel );
233 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
234 mMetrics = Metrics::New( mFontClient );
235 mLayoutEngine.SetMetrics( mMetrics );
237 // Set the text properties to default
238 mVisualModel->SetUnderlineEnabled( false );
239 mVisualModel->SetUnderlineHeight( 0.0f );
244 delete mFontDefaults;
249 * @brief Request a relayout using the ControlInterface.
251 void RequestRelayout();
254 * @brief Request a relayout using the ControlInterface.
256 void QueueModifyEvent( ModifyEvent::Type type )
258 if( ModifyEvent::TEXT_REPLACED == type)
260 // Cancel previously queued inserts etc.
261 mModifyEvents.clear();
266 mModifyEvents.push_back( event );
268 // The event will be processed during relayout
273 * @brief Helper to move the cursor, grab handle etc.
275 bool ProcessInputEvents();
278 * @brief Helper to check whether any place-holder text is available.
280 bool IsPlaceholderAvailable() const
282 return ( mEventData &&
283 ( !mEventData->mPlaceholderTextInactive.empty() ||
284 !mEventData->mPlaceholderTextActive.empty() )
288 bool IsShowingPlaceholderText() const
290 return ( mEventData && mEventData->mIsShowingPlaceholderText );
294 * @brief Helper to check whether active place-holder text is available.
296 bool IsFocusedPlaceholderAvailable() const
298 return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
301 bool IsShowingRealText() const
303 return ( !IsShowingPlaceholderText() &&
304 0u != mLogicalModel->mText.Count() );
308 * @brief Called when placeholder-text is hidden
310 void PlaceholderCleared()
314 mEventData->mIsShowingPlaceholderText = false;
316 // Remove mPlaceholderTextColor
317 mVisualModel->SetTextColor( mTextColor );
321 void ClearPreEditFlag()
325 mEventData->mPreEditFlag = false;
326 mEventData->mPreEditStartPosition = 0;
327 mEventData->mPreEditLength = 0;
331 void ResetImfManager()
335 // Reset incase we are in a pre-edit state.
336 ImfManager imfManager = ImfManager::Get();
339 imfManager.Reset(); // Will trigger a commit message
346 bool IsClipboardEmpty()
348 bool result( mClipboard && mClipboard.NumberOfItems() );
349 return !result; // // If NumberOfItems greater than 0, return false
352 void UpdateModel( OperationsMask operationsRequired );
355 * @brief Retrieve the default fonts.
357 * @param[out] fonts The default font family, style and point sizes.
358 * @param[in] numberOfCharacters The number of characters in the logical model.
360 void GetDefaultFonts( Dali::Vector<FontRun>& fonts, Length numberOfCharacters );
363 * @brief Retrieve the line height of the default font.
365 float GetDefaultFontLineHeight();
367 void OnCursorKeyEvent( const Event& event );
369 void OnTapEvent( const Event& event );
371 void OnPanEvent( const Event& event );
373 void OnLongPressEvent( const Event& event );
375 void OnHandleEvent( const Event& event );
377 void OnSelectEvent( const Event& event );
379 void OnSelectAllEvent();
381 void RetrieveSelection( std::string& selectedText, bool deleteAfterRetreival );
383 void ShowClipboard();
385 void HideClipboard();
387 bool CopyStringToClipboard( std::string& source );
389 void SendSelectionToClipboard( bool deleteAfterSending );
391 void GetTextFromClipboard( unsigned int itemIndex, std::string& retreivedString );
393 void RepositionSelectionHandles( CharacterIndex selectionStart, CharacterIndex selectionEnd );
394 void RepositionSelectionHandles( float visualX, float visualY );
396 void SetPopupButtons();
398 void ChangeState( EventData::State newState );
399 LineIndex GetClosestLine( float y ) const;
401 void FindSelectionIndices( float visualX, float visualY, CharacterIndex& startIndex, CharacterIndex& endIndex );
404 * @brief Retrieves the cursor's logical position for a given touch point x,y
406 * @param[in] visualX The touch point x.
407 * @param[in] visualY The touch point y.
409 * @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.
411 CharacterIndex GetClosestCursorIndex( float visualX,
415 * @brief Calculates the cursor's position for a given character index in the logical order.
417 * It retrieves as well the line's height and the cursor's height and
418 * if there is a valid alternative cursor, its position and height.
420 * @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.
421 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
423 void GetCursorPosition( CharacterIndex logical,
424 CursorInfo& cursorInfo );
427 * @brief Calculates the new cursor index.
429 * It takes into account that in some scripts multiple characters can form a glyph and all of them
430 * need to be jumped with one key event.
432 * @param[in] index The initial new index.
434 * @return The new cursor index.
436 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
439 * @brief Updates the cursor position.
441 * Retrieves the x,y position of the cursor logical position and sets it into the decorator.
442 * It sets the position of the secondary cursor if it's a valid one.
443 * Sets which cursors are active.
445 void UpdateCursorPosition();
448 * @brief Updates the position of the given selection handle.
450 * @param[in] handleType One of the selection handles.
452 void UpdateSelectionHandle( HandleType handleType );
455 * @biref Clamps the horizontal scrolling to get the control always filled with text.
457 * @param[in] actualSize The size of the laid out text.
459 void ClampHorizontalScroll( const Vector2& actualSize );
462 * @biref Clamps the vertical scrolling to get the control always filled with text.
464 * @param[in] actualSize The size of the laid out text.
466 void ClampVerticalScroll( const Vector2& actualSize );
469 * @brief Scrolls the text to make a position visible.
471 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
473 * @param[in] position A position in decorator coords.
475 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
476 * or moving the selection handles.
478 void ScrollToMakePositionVisible( const Vector2& position );
481 * @brief Scrolls the text to make the cursor visible.
483 * This method is called after deleting text.
485 void ScrollTextToMatchCursor();
487 ControlInterface& mControlInterface; ///< Reference to the text controller.
488 LogicalModelPtr mLogicalModel; ///< Pointer to the logical model.
489 VisualModelPtr mVisualModel; ///< Pointer to the visual model.
490 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
491 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
492 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
493 Clipboard mClipboard; ///< Handle to the system clipboard
494 View mView; ///< The view interface to the rendering back-end.
495 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
496 LayoutEngine mLayoutEngine; ///< The layout engine.
497 std::vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
498 Vector4 mTextColor; ///< The regular text color
499 Vector2 mAlignmentOffset; ///< Vertical and horizontal offset of the whole text inside the control due to alignment.
500 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
501 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
503 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
504 bool mUserDefinedFontFamily:1; ///< Whether the Font family was set by the user instead of being left as sytem default.
509 } // namespace Toolkit
513 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__