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
61 Event( Type eventType )
81 primaryCursorHeight( 0.f ),
82 secondaryCursorHeight( 0.f ),
83 isSecondaryCursor( false )
89 Vector2 primaryPosition; ///< The primary cursor's position.
90 Vector2 secondaryPosition; ///< The secondary cursor's position.
91 float lineHeight; ///< The height of the line where the cursor is placed.
92 float primaryCursorHeight; ///< The primary cursor's height.
93 float secondaryCursorHeight; ///< The secondary cursor's height.
94 bool isSecondaryCursor; ///< Whether the secondary cursor is valid.
107 SELECTION_HANDLE_PANNING
110 EventData( DecoratorPtr decorator );
114 DecoratorPtr mDecorator; ///< Pointer to the decorator
115 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus
116 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive
117 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color
120 * This is used to delay handling events until after the model has been updated.
121 * The number of updates to the model is minimized to improve performance.
123 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
126 * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
127 * Typically this will have a negative value with scrolling occurs.
129 Vector2 mScrollPosition; ///< The text is offset by this position when scrolling.
131 State mState; ///< Selection mode, edit mode etc.
133 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
134 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
135 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
137 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
138 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
140 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
141 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
142 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
143 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
144 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
145 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
146 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
147 bool mHorizontalScrollingEnabled : 1; ///< True if horizontal scrolling is enabled.
148 bool mVerticalScrollingEnabled : 1; ///< True if vertical scrolling is enabled.
149 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
150 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
151 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
152 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
153 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
160 TEXT_REPLACED, ///< The entire text was replaced
161 TEXT_INSERTED, ///< Insert characters at the current cursor position
162 TEXT_DELETED ///< Characters were deleted
171 : mDefaultPointSize(0.0f),
176 FontId GetFontId( TextAbstraction::FontClient& fontClient )
180 Dali::TextAbstraction::PointSize26Dot6 pointSize = mDefaultPointSize*64;
181 mFontId = fontClient.GetFontId( mDefaultFontFamily, mDefaultFontStyle, pointSize );
187 std::string mDefaultFontFamily;
188 std::string mDefaultFontStyle;
189 float mDefaultPointSize;
193 struct Controller::Impl
195 Impl( ControlInterface& controlInterface )
196 : mControlInterface( controlInterface ),
199 mFontDefaults( NULL ),
207 mTextColor( Color::BLACK ),
209 mOperationsPending( NO_OPERATION ),
210 mMaximumNumberOfCharacters( 50 ),
211 mRecalculateNaturalSize( true )
213 mLogicalModel = LogicalModel::New();
214 mVisualModel = VisualModel::New();
216 mFontClient = TextAbstraction::FontClient::Get();
217 mClipboard = Clipboard::Get();
219 mView.SetVisualModel( mVisualModel );
221 // Set the text properties to default
222 mVisualModel->SetUnderlineEnabled( false );
223 mVisualModel->SetUnderlineHeight( 0.0f );
232 * @brief Request a relayout using the ControlInterface.
234 void RequestRelayout();
237 * @brief Request a relayout using the ControlInterface.
239 void QueueModifyEvent( ModifyEvent::Type type )
241 if( ModifyEvent::TEXT_REPLACED == type)
243 // Cancel previously queued inserts etc.
244 mModifyEvents.clear();
249 mModifyEvents.push_back( event );
251 // The event will be processed during relayout
256 * @brief Helper to move the cursor, grab handle etc.
258 bool ProcessInputEvents();
261 * @brief Helper to check whether any place-holder text is available.
263 bool IsPlaceholderAvailable() const
265 return ( mEventData &&
266 ( !mEventData->mPlaceholderTextInactive.empty() ||
267 !mEventData->mPlaceholderTextActive.empty() )
271 bool IsShowingPlaceholderText() const
273 return ( mEventData && mEventData->mIsShowingPlaceholderText );
277 * @brief Called when placeholder-text is hidden
279 void PlaceholderCleared()
283 mEventData->mIsShowingPlaceholderText = false;
285 // Remove mPlaceholderTextColor
286 mVisualModel->SetTextColor( mTextColor );
290 void ClearPreEditFlag()
294 mEventData->mPreEditFlag = false;
295 mEventData->mPreEditStartPosition = 0;
296 mEventData->mPreEditLength = 0;
300 void ResetImfManager()
302 // Reset incase we are in a pre-edit state.
303 ImfManager imfManager = ImfManager::Get();
306 imfManager.Reset(); // Will trigger a commit message
312 bool IsClipboardEmpty()
314 bool result( mClipboard && mClipboard.NumberOfItems() );
315 return !result; // // If NumberOfItems greater than 0, return false
318 void UpdateModel( OperationsMask operationsRequired );
321 * @brief Retrieve the default fonts.
323 * @param[out] fonts The default font family, style and point sizes.
324 * @param[in] numberOfCharacters The number of characters in the logical model.
326 void GetDefaultFonts( Dali::Vector<FontRun>& fonts, Length numberOfCharacters );
328 void OnCursorKeyEvent( const Event& event );
330 void OnTapEvent( const Event& event );
332 void OnPanEvent( const Event& event );
334 void OnHandleEvent( const Event& event );
336 void RepositionSelectionHandles( CharacterIndex selectionStart, CharacterIndex selectionEnd );
337 void RepositionSelectionHandles( float visualX, float visualY );
339 void ChangeState( EventData::State newState );
341 LineIndex GetClosestLine( float y ) const;
343 void FindSelectionIndices( float visualX, float visualY, CharacterIndex& startIndex, CharacterIndex& endIndex );
346 * @brief Retrieves the cursor's logical position for a given touch point x,y
348 * @param[in] visualX The touch point x.
349 * @param[in] visualY The touch point y.
351 * @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.
353 CharacterIndex GetClosestCursorIndex( float visualX,
357 * @brief Calculates the cursor's position for a given character index in the logical order.
359 * It retrieves as well the line's height and the cursor's height and
360 * if there is a valid alternative cursor, its position and height.
362 * @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.
363 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
365 void GetCursorPosition( CharacterIndex logical,
366 CursorInfo& cursorInfo );
369 * @brief Calculates the new cursor index.
371 * It takes into account that in some scripts multiple characters can form a glyph and all of them
372 * need to be jumped with one key event.
374 * @param[in] index The initial new index.
376 * @return The new cursor index.
378 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
381 * @brief Updates the cursor position.
383 * Retrieves the x,y position of the cursor logical position and sets it into the decorator.
384 * It sets the position of the secondary cursor if it's a valid one.
385 * Sets which cursors are active.
387 void UpdateCursorPosition();
390 * @brief Updates the position of the given selection handle.
392 * @param[in] handleType One of the selection handles.
394 void UpdateSelectionHandle( HandleType handleType );
397 * @biref Clamps the horizontal scrolling to get the control always filled with text.
399 * @param[in] actualSize The size of the laid out text.
401 void ClampHorizontalScroll( const Vector2& actualSize );
404 * @biref Clamps the vertical scrolling to get the control always filled with text.
406 * @param[in] actualSize The size of the laid out text.
408 void ClampVerticalScroll( const Vector2& actualSize );
411 * @brief Scrolls the text to make a position visible.
413 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
415 * @param[in] position A position in decorator coords.
417 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
418 * or moving the selection handles.
420 void ScrollToMakePositionVisible( const Vector2& position );
423 * @brief Scrolls the text to make the cursor visible.
425 * This method is called after deleting text.
427 void ScrollTextToMatchCursor();
429 ControlInterface& mControlInterface; ///< Reference to the text controller.
430 LogicalModelPtr mLogicalModel; ///< Pointer to the logical model.
431 VisualModelPtr mVisualModel; ///< Pointer to the visual model.
432 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
433 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
434 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
435 Clipboard mClipboard; ///< Handle to the system clipboard
436 View mView; ///< The view interface to the rendering back-end.
437 LayoutEngine mLayoutEngine; ///< The layout engine.
438 std::vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
439 Size mControlSize; ///< The size of the control.
440 Vector4 mTextColor; ///< The regular text color
441 Vector2 mAlignmentOffset; ///< Vertical and horizontal offset of the whole text inside the control due to alignment.
442 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
443 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
444 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
449 } // namespace Toolkit
453 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__