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/public-api/text-abstraction/font-client.h>
25 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
26 #include <dali-toolkit/internal/text/logical-model-impl.h>
27 #include <dali-toolkit/internal/text/text-controller.h>
28 #include <dali-toolkit/internal/text/visual-model-impl.h>
41 // Used to queue input events until DoRelayout()
44 KEYBOARD_FOCUS_GAIN_EVENT,
45 KEYBOARD_FOCUS_LOST_EVENT,
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 EventData( DecoratorPtr decorator );
111 DecoratorPtr mDecorator; ///< Pointer to the decorator
112 std::string mPlaceholderText; ///< The plaxe holder text
115 * This is used to delay handling events until after the model has been updated.
116 * The number of updates to the model is minimized to improve performance.
118 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
121 * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
122 * Typically this will have a negative value with scrolling occurs.
124 Vector2 mScrollPosition; ///< The text is offset by this position when scrolling.
126 State mState; ///< Selection mode, edit mode etc.
128 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
129 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
130 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
132 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
133 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
134 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
135 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
136 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
137 bool mHorizontalScrollingEnabled : 1; ///< True if horizontal scrolling is enabled.
138 bool mVerticalScrollingEnabled : 1; ///< True if vertical scrolling is enabled.
139 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
140 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
141 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
142 bool mScrollAfterUpdateCursorPosition : 1; ///< Whether to scroll after the cursor position is updated.
149 REPLACE_TEXT, ///< Replace the entire text
150 INSERT_TEXT, ///< Insert characters at the current cursor position
151 DELETE_TEXT ///< Delete a character at the current cursor position
161 : mDefaultPointSize(0.0f),
166 FontId GetFontId( TextAbstraction::FontClient& fontClient )
170 Dali::TextAbstraction::PointSize26Dot6 pointSize = mDefaultPointSize*64;
171 mFontId = fontClient.GetFontId( mDefaultFontFamily, mDefaultFontStyle, pointSize );
177 std::string mDefaultFontFamily;
178 std::string mDefaultFontStyle;
179 float mDefaultPointSize;
183 struct Controller::Impl
185 Impl( ControlInterface& controlInterface )
186 : mControlInterface( controlInterface ),
189 mFontDefaults( NULL ),
197 mOperationsPending( NO_OPERATION ),
198 mRecalculateNaturalSize( true )
200 mLogicalModel = LogicalModel::New();
201 mVisualModel = VisualModel::New();
203 mFontClient = TextAbstraction::FontClient::Get();
205 mView.SetVisualModel( mVisualModel );
207 // Set the text properties to default
208 mVisualModel->SetTextColor( Color::WHITE );
209 mVisualModel->SetShadowOffset( Vector2::ZERO );
210 mVisualModel->SetShadowColor( Color::BLACK );
211 mVisualModel->SetUnderlineEnabled( false );
212 mVisualModel->SetUnderlineHeight( 0.0f );
221 * @brief Request a relayout using the ControlInterface.
223 void RequestRelayout();
227 * @brief Helper to move the cursor, grab handle etc.
229 bool ProcessInputEvents();
231 void OnKeyboardFocus( bool hasFocus );
233 void OnCursorKeyEvent( const Event& event );
235 void HandleCursorKey( int keyCode );
237 void OnTapEvent( const Event& event );
239 void OnPanEvent( const Event& event );
241 void OnHandleEvent( const Event& event );
243 void RepositionSelectionHandles( float visualX, float visualY );
245 void ChangeState( EventData::State newState );
247 LineIndex GetClosestLine( float y ) const;
250 * @brief Retrieves the cursor's logical position for a given touch point x,y
252 * @param[in] visualX The touch point x.
253 * @param[in] visualY The touch point y.
255 * @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.
257 CharacterIndex GetClosestCursorIndex( float visualX,
261 * @brief Calculates the cursor's position for a given character index in the logical order.
263 * It retrieves as well the line's height and the cursor's height and
264 * if there is a valid alternative cursor, its position and height.
266 * @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.
267 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
269 void GetCursorPosition( CharacterIndex logical,
270 CursorInfo& cursorInfo );
273 * @brief Calculates the new cursor index.
275 * It takes into account that in some scripts multiple characters can form a glyph and all of them
276 * need to be jumped with one key event.
278 * @param[in] index The initial new index.
280 * @return The new cursor index.
282 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
285 * @brief Updates the cursor position.
287 * Retrieves the x,y position of the cursor logical position and sets it into the decorator.
288 * It sets the position of the secondary cursor if it's a valid one.
289 * Sets which cursors are active.
291 void UpdateCursorPosition();
294 * @brief Updates the position of the given selection handle.
296 * @param[in] handleType One of the selection handles.
298 void UpdateSelectionHandle( HandleType handleType );
301 * @biref Clamps the horizontal scrolling to get the control always filled with text.
303 * @param[in] actualSize The size of the laid out text.
305 void ClampHorizontalScroll( const Vector2& actualSize );
308 * @biref Clamps the vertical scrolling to get the control always filled with text.
310 * @param[in] actualSize The size of the laid out text.
312 void ClampVerticalScroll( const Vector2& actualSize );
315 * @brief Scrolls the text to make the cursor visible.
317 * This method is called after inserting, deleting or moving the cursor with the keypad.
319 void ScrollToMakeCursorVisible();
321 ControlInterface& mControlInterface; ///< Reference to the text controller.
322 LogicalModelPtr mLogicalModel; ///< Pointer to the logical model.
323 VisualModelPtr mVisualModel; ///< Pointer to the visual model.
324 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
325 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
326 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
327 View mView; ///< The view interface to the rendering back-end.
328 LayoutEngine mLayoutEngine; ///< The layout engine.
329 std::vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
330 Size mControlSize; ///< The size of the control.
331 Vector2 mAlignmentOffset; ///< Vertical and horizontal offset of the whole text inside the control due to alignment.
332 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
333 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
338 } // namespace Toolkit
342 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__