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/adaptor-framework/imf-manager.h>
24 #include <dali/devel-api/text-abstraction/font-client.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/visual-model-impl.h>
43 // Used to queue input events until DoRelayout()
50 LEFT_SELECTION_HANDLE_EVENT,
51 RIGHT_SELECTION_HANDLE_EVENT,
63 Event( Type eventType )
83 primaryCursorHeight( 0.f ),
84 secondaryCursorHeight( 0.f ),
85 isSecondaryCursor( false )
91 Vector2 primaryPosition; ///< The primary cursor's position.
92 Vector2 secondaryPosition; ///< The secondary cursor's position.
93 float lineHeight; ///< The height of the line where the cursor is placed.
94 float primaryCursorHeight; ///< The primary cursor's height.
95 float secondaryCursorHeight; ///< The secondary cursor's height.
96 bool isSecondaryCursor; ///< Whether the secondary cursor is valid.
109 SELECTION_HANDLE_PANNING
112 EventData( DecoratorPtr decorator );
116 DecoratorPtr mDecorator; ///< Pointer to the decorator
117 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus
118 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive
119 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color
122 * This is used to delay handling events until after the model has been updated.
123 * The number of updates to the model is minimized to improve performance.
125 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
128 * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
129 * Typically this will have a negative value with scrolling occurs.
131 Vector2 mScrollPosition; ///< The text is offset by this position when scrolling.
133 State mState; ///< Selection mode, edit mode etc.
135 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
136 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
137 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
139 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
140 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
142 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
143 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
144 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
145 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
146 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
147 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
148 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
149 bool mHorizontalScrollingEnabled : 1; ///< True if horizontal scrolling is enabled.
150 bool mVerticalScrollingEnabled : 1; ///< True if vertical scrolling is enabled.
151 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
152 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
153 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
154 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
155 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
162 TEXT_REPLACED, ///< The entire text was replaced
163 TEXT_INSERTED, ///< Insert characters at the current cursor position
164 TEXT_DELETED ///< Characters were deleted
173 : mDefaultPointSize(0.0f),
178 FontId GetFontId( TextAbstraction::FontClient& fontClient )
182 Dali::TextAbstraction::PointSize26Dot6 pointSize = mDefaultPointSize*64;
183 mFontId = fontClient.GetFontId( mDefaultFontFamily, mDefaultFontStyle, pointSize );
189 std::string mDefaultFontFamily;
190 std::string mDefaultFontStyle;
191 float mDefaultPointSize;
195 struct Controller::Impl
197 Impl( ControlInterface& controlInterface )
198 : mControlInterface( controlInterface ),
201 mFontDefaults( NULL ),
209 mTextColor( Color::BLACK ),
211 mOperationsPending( NO_OPERATION ),
212 mMaximumNumberOfCharacters( 50 ),
213 mRecalculateNaturalSize( true )
215 mLogicalModel = LogicalModel::New();
216 mVisualModel = VisualModel::New();
218 mFontClient = TextAbstraction::FontClient::Get();
219 mClipboard = Clipboard::Get();
221 mView.SetVisualModel( mVisualModel );
223 // Set the text properties to default
224 mVisualModel->SetUnderlineEnabled( false );
225 mVisualModel->SetUnderlineHeight( 0.0f );
234 * @brief Request a relayout using the ControlInterface.
236 void RequestRelayout();
239 * @brief Request a relayout using the ControlInterface.
241 void QueueModifyEvent( ModifyEvent::Type type )
243 if( ModifyEvent::TEXT_REPLACED == type)
245 // Cancel previously queued inserts etc.
246 mModifyEvents.clear();
251 mModifyEvents.push_back( event );
253 // The event will be processed during relayout
258 * @brief Helper to move the cursor, grab handle etc.
260 bool ProcessInputEvents();
263 * @brief Helper to check whether any place-holder text is available.
265 bool IsPlaceholderAvailable() const
267 return ( mEventData &&
268 ( !mEventData->mPlaceholderTextInactive.empty() ||
269 !mEventData->mPlaceholderTextActive.empty() )
273 bool IsShowingPlaceholderText() const
275 return ( mEventData && mEventData->mIsShowingPlaceholderText );
279 * @brief Called when placeholder-text is hidden
281 void PlaceholderCleared()
285 mEventData->mIsShowingPlaceholderText = false;
287 // Remove mPlaceholderTextColor
288 mVisualModel->SetTextColor( mTextColor );
292 void ClearPreEditFlag()
296 mEventData->mPreEditFlag = false;
297 mEventData->mPreEditStartPosition = 0;
298 mEventData->mPreEditLength = 0;
302 void ResetImfManager()
304 // Reset incase we are in a pre-edit state.
305 ImfManager imfManager = ImfManager::Get();
308 imfManager.Reset(); // Will trigger a commit message
314 bool IsClipboardEmpty()
316 bool result( mClipboard && mClipboard.NumberOfItems() );
317 return !result; // // If NumberOfItems greater than 0, return false
320 void UpdateModel( OperationsMask operationsRequired );
323 * @brief Retrieve the default fonts.
325 * @param[out] fonts The default font family, style and point sizes.
326 * @param[in] numberOfCharacters The number of characters in the logical model.
328 void GetDefaultFonts( Dali::Vector<FontRun>& fonts, Length numberOfCharacters );
330 void OnCursorKeyEvent( const Event& event );
332 void OnTapEvent( const Event& event );
334 void OnPanEvent( const Event& event );
336 void OnHandleEvent( const Event& event );
338 void OnSelectEvent( const Event& event );
340 void OnSelectAllEvent();
342 void RetrieveSelection( std::string& selectedText, bool deleteAfterRetreival );
344 bool CopyStringToClipboard( std::string& source );
346 void SendSelectionToClipboard( bool deleteAfterSending );
348 void GetTextFromClipboard( unsigned int itemIndex, std::string& retreivedString );
350 void RepositionSelectionHandles( CharacterIndex selectionStart, CharacterIndex selectionEnd );
351 void RepositionSelectionHandles( float visualX, float visualY );
353 void ChangeState( EventData::State newState );
355 LineIndex GetClosestLine( float y ) const;
357 void FindSelectionIndices( float visualX, float visualY, CharacterIndex& startIndex, CharacterIndex& endIndex );
360 * @brief Retrieves the cursor's logical position for a given touch point x,y
362 * @param[in] visualX The touch point x.
363 * @param[in] visualY The touch point y.
365 * @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.
367 CharacterIndex GetClosestCursorIndex( float visualX,
371 * @brief Calculates the cursor's position for a given character index in the logical order.
373 * It retrieves as well the line's height and the cursor's height and
374 * if there is a valid alternative cursor, its position and height.
376 * @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.
377 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
379 void GetCursorPosition( CharacterIndex logical,
380 CursorInfo& cursorInfo );
383 * @brief Calculates the new cursor index.
385 * It takes into account that in some scripts multiple characters can form a glyph and all of them
386 * need to be jumped with one key event.
388 * @param[in] index The initial new index.
390 * @return The new cursor index.
392 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
395 * @brief Updates the cursor position.
397 * Retrieves the x,y position of the cursor logical position and sets it into the decorator.
398 * It sets the position of the secondary cursor if it's a valid one.
399 * Sets which cursors are active.
401 void UpdateCursorPosition();
404 * @brief Updates the position of the given selection handle.
406 * @param[in] handleType One of the selection handles.
408 void UpdateSelectionHandle( HandleType handleType );
411 * @biref Clamps the horizontal scrolling to get the control always filled with text.
413 * @param[in] actualSize The size of the laid out text.
415 void ClampHorizontalScroll( const Vector2& actualSize );
418 * @biref Clamps the vertical scrolling to get the control always filled with text.
420 * @param[in] actualSize The size of the laid out text.
422 void ClampVerticalScroll( const Vector2& actualSize );
425 * @brief Scrolls the text to make a position visible.
427 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
429 * @param[in] position A position in decorator coords.
431 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
432 * or moving the selection handles.
434 void ScrollToMakePositionVisible( const Vector2& position );
437 * @brief Scrolls the text to make the cursor visible.
439 * This method is called after deleting text.
441 void ScrollTextToMatchCursor();
443 ControlInterface& mControlInterface; ///< Reference to the text controller.
444 LogicalModelPtr mLogicalModel; ///< Pointer to the logical model.
445 VisualModelPtr mVisualModel; ///< Pointer to the visual model.
446 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
447 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
448 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
449 Clipboard mClipboard; ///< Handle to the system clipboard
450 View mView; ///< The view interface to the rendering back-end.
451 LayoutEngine mLayoutEngine; ///< The layout engine.
452 std::vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
453 Size mControlSize; ///< The size of the control.
454 Vector4 mTextColor; ///< The regular text color
455 Vector2 mAlignmentOffset; ///< Vertical and horizontal offset of the whole text inside the control due to alignment.
456 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
457 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
458 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
463 } // namespace Toolkit
467 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__