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/text-abstraction/font-client.h>
23 #include <dali/devel-api/adaptor-framework/imf-manager.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/visual-model-impl.h>
42 // Used to queue input events until DoRelayout()
49 LEFT_SELECTION_HANDLE_EVENT,
50 RIGHT_SELECTION_HANDLE_EVENT
60 Event( Type eventType )
80 primaryCursorHeight( 0.f ),
81 secondaryCursorHeight( 0.f ),
82 isSecondaryCursor( false )
88 Vector2 primaryPosition; ///< The primary cursor's position.
89 Vector2 secondaryPosition; ///< The secondary cursor's position.
90 float lineHeight; ///< The height of the line where the cursor is placed.
91 float primaryCursorHeight; ///< The primary cursor's height.
92 float secondaryCursorHeight; ///< The secondary cursor's height.
93 bool isSecondaryCursor; ///< Whether the secondary cursor is valid.
106 SELECTION_HANDLE_PANNING
109 EventData( DecoratorPtr decorator );
113 DecoratorPtr mDecorator; ///< Pointer to the decorator
114 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus
115 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive
116 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color
119 * This is used to delay handling events until after the model has been updated.
120 * The number of updates to the model is minimized to improve performance.
122 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
125 * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
126 * Typically this will have a negative value with scrolling occurs.
128 Vector2 mScrollPosition; ///< The text is offset by this position when scrolling.
130 State mState; ///< Selection mode, edit mode etc.
132 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
133 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
134 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
136 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
137 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
139 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
140 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
141 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
142 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
143 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
144 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
145 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
146 bool mHorizontalScrollingEnabled : 1; ///< True if horizontal scrolling is enabled.
147 bool mVerticalScrollingEnabled : 1; ///< True if vertical scrolling is enabled.
148 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
149 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
150 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
151 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
152 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
159 TEXT_REPLACED, ///< The entire text was replaced
160 TEXT_INSERTED, ///< Insert characters at the current cursor position
161 TEXT_DELETED ///< Characters were deleted
170 : mDefaultPointSize(0.0f),
175 FontId GetFontId( TextAbstraction::FontClient& fontClient )
179 Dali::TextAbstraction::PointSize26Dot6 pointSize = mDefaultPointSize*64;
180 mFontId = fontClient.GetFontId( mDefaultFontFamily, mDefaultFontStyle, pointSize );
186 std::string mDefaultFontFamily;
187 std::string mDefaultFontStyle;
188 float mDefaultPointSize;
192 struct Controller::Impl
194 Impl( ControlInterface& controlInterface )
195 : mControlInterface( controlInterface ),
198 mFontDefaults( NULL ),
205 mTextColor( Color::BLACK ),
207 mOperationsPending( NO_OPERATION ),
208 mMaximumNumberOfCharacters( 50 ),
209 mRecalculateNaturalSize( true )
211 mLogicalModel = LogicalModel::New();
212 mVisualModel = VisualModel::New();
214 mFontClient = TextAbstraction::FontClient::Get();
216 mView.SetVisualModel( mVisualModel );
218 // Set the text properties to default
219 mVisualModel->SetUnderlineEnabled( false );
220 mVisualModel->SetUnderlineHeight( 0.0f );
229 * @brief Request a relayout using the ControlInterface.
231 void RequestRelayout();
234 * @brief Request a relayout using the ControlInterface.
236 void QueueModifyEvent( ModifyEvent::Type type )
238 if( ModifyEvent::TEXT_REPLACED == type)
240 // Cancel previously queued inserts etc.
241 mModifyEvents.clear();
246 mModifyEvents.push_back( event );
248 // The event will be processed during relayout
253 * @brief Helper to move the cursor, grab handle etc.
255 bool ProcessInputEvents();
258 * @brief Helper to check whether any place-holder text is available.
260 bool IsPlaceholderAvailable() const
262 return ( mEventData &&
263 ( !mEventData->mPlaceholderTextInactive.empty() ||
264 !mEventData->mPlaceholderTextActive.empty() )
268 bool IsShowingPlaceholderText() const
270 return ( mEventData && mEventData->mIsShowingPlaceholderText );
274 * @brief Called when placeholder-text is hidden
276 void PlaceholderCleared()
280 mEventData->mIsShowingPlaceholderText = false;
282 // Remove mPlaceholderTextColor
283 mVisualModel->SetTextColor( mTextColor );
287 void ClearPreEditFlag()
291 mEventData->mPreEditFlag = false;
292 mEventData->mPreEditStartPosition = 0;
293 mEventData->mPreEditLength = 0;
297 void ResetImfManager()
299 // Reset incase we are in a pre-edit state.
300 ImfManager imfManager = ImfManager::Get();
303 imfManager.Reset(); // Will trigger a commit message
309 void UpdateModel( OperationsMask operationsRequired );
312 * @brief Retrieve the default fonts.
314 * @param[out] fonts The default font family, style and point sizes.
315 * @param[in] numberOfCharacters The number of characters in the logical model.
317 void GetDefaultFonts( Dali::Vector<FontRun>& fonts, Length numberOfCharacters );
319 void OnCursorKeyEvent( const Event& event );
321 void OnTapEvent( const Event& event );
323 void OnPanEvent( const Event& event );
325 void OnHandleEvent( const Event& event );
327 void RepositionSelectionHandles( CharacterIndex selectionStart, CharacterIndex selectionEnd );
328 void RepositionSelectionHandles( float visualX, float visualY );
330 void ChangeState( EventData::State newState );
332 LineIndex GetClosestLine( float y ) const;
334 void FindSelectionIndices( float visualX, float visualY, CharacterIndex& startIndex, CharacterIndex& endIndex );
337 * @brief Retrieves the cursor's logical position for a given touch point x,y
339 * @param[in] visualX The touch point x.
340 * @param[in] visualY The touch point y.
342 * @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.
344 CharacterIndex GetClosestCursorIndex( float visualX,
348 * @brief Calculates the cursor's position for a given character index in the logical order.
350 * It retrieves as well the line's height and the cursor's height and
351 * if there is a valid alternative cursor, its position and height.
353 * @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.
354 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
356 void GetCursorPosition( CharacterIndex logical,
357 CursorInfo& cursorInfo );
360 * @brief Calculates the new cursor index.
362 * It takes into account that in some scripts multiple characters can form a glyph and all of them
363 * need to be jumped with one key event.
365 * @param[in] index The initial new index.
367 * @return The new cursor index.
369 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
372 * @brief Updates the cursor position.
374 * Retrieves the x,y position of the cursor logical position and sets it into the decorator.
375 * It sets the position of the secondary cursor if it's a valid one.
376 * Sets which cursors are active.
378 void UpdateCursorPosition();
381 * @brief Updates the position of the given selection handle.
383 * @param[in] handleType One of the selection handles.
385 void UpdateSelectionHandle( HandleType handleType );
388 * @biref Clamps the horizontal scrolling to get the control always filled with text.
390 * @param[in] actualSize The size of the laid out text.
392 void ClampHorizontalScroll( const Vector2& actualSize );
395 * @biref Clamps the vertical scrolling to get the control always filled with text.
397 * @param[in] actualSize The size of the laid out text.
399 void ClampVerticalScroll( const Vector2& actualSize );
402 * @brief Scrolls the text to make a position visible.
404 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
406 * @param[in] position A position in decorator coords.
408 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
409 * or moving the selection handles.
411 void ScrollToMakePositionVisible( const Vector2& position );
414 * @brief Scrolls the text to make the cursor visible.
416 * This method is called after deleting text.
418 void ScrollTextToMatchCursor();
420 ControlInterface& mControlInterface; ///< Reference to the text controller.
421 LogicalModelPtr mLogicalModel; ///< Pointer to the logical model.
422 VisualModelPtr mVisualModel; ///< Pointer to the visual model.
423 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
424 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
425 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
426 View mView; ///< The view interface to the rendering back-end.
427 LayoutEngine mLayoutEngine; ///< The layout engine.
428 std::vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
429 Size mControlSize; ///< The size of the control.
430 Vector4 mTextColor; ///< The regular text color
431 Vector2 mAlignmentOffset; ///< Vertical and horizontal offset of the whole text inside the control due to alignment.
432 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
433 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
434 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
439 } // namespace Toolkit
443 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__