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,
59 Event( Type eventType )
78 primaryCursorHeight( 0.f ),
79 secondaryCursorHeight( 0.f ),
80 isSecondaryCursor( false )
86 Vector2 primaryPosition; ///< The primary cursor's position.
87 Vector2 secondaryPosition; ///< The secondary cursor's position.
88 float lineHeight; ///< The height of the line where the cursor is placed.
89 float primaryCursorHeight; ///< The primary cursor's height.
90 float secondaryCursorHeight; ///< The secondary cursor's height.
91 bool isSecondaryCursor; ///< Whether the secondary cursor is valid.
104 EventData( DecoratorPtr decorator );
108 DecoratorPtr mDecorator;
109 std::string mPlaceholderText;
112 * This is used to delay handling events until after the model has been updated.
113 * The number of updates to the model is minimized to improve performance.
115 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
118 * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
119 * Typically this will have a negative value with scrolling occurs.
121 Vector2 mScrollPosition; ///< The text is offset by this position when scrolling.
123 State mState; ///< Selection mode, edit mode etc.
125 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor
126 CharacterIndex mSecondaryCursorPosition; ///< Index into logical model for secondary cursor
128 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing
129 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active
130 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled
131 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown
132 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled
133 bool mHorizontalScrollingEnabled : 1; ///< True if horizontal scrolling is enabled
134 bool mVerticalScrollingEnabled : 1; ///< True if vertical scrolling is enabled
135 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated
142 REPLACE_TEXT, ///< Replace the entire text
143 INSERT_TEXT, ///< Insert characters at the current cursor position
144 DELETE_TEXT ///< Delete a character at the current cursor position
154 : mDefaultPointSize(0.0f),
159 FontId GetFontId( TextAbstraction::FontClient& fontClient )
163 Dali::TextAbstraction::PointSize26Dot6 pointSize = mDefaultPointSize*64;
164 mFontId = fontClient.GetFontId( mDefaultFontFamily, mDefaultFontStyle, pointSize );
170 std::string mDefaultFontFamily;
171 std::string mDefaultFontStyle;
172 float mDefaultPointSize;
176 struct Controller::Impl
178 Impl( ControlInterface& controlInterface )
179 : mControlInterface( controlInterface ),
182 mFontDefaults( NULL ),
190 mOperationsPending( NO_OPERATION ),
191 mRecalculateNaturalSize( true )
193 mLogicalModel = LogicalModel::New();
194 mVisualModel = VisualModel::New();
196 mFontClient = TextAbstraction::FontClient::Get();
198 mView.SetVisualModel( mVisualModel );
200 // Set the text properties to default
201 mVisualModel->SetTextColor( Color::WHITE );
202 mVisualModel->SetShadowOffset( Vector2::ZERO );
203 mVisualModel->SetShadowColor( Color::BLACK );
204 mVisualModel->SetUnderlineEnabled( false );
205 mVisualModel->SetUnderlineHeight( 0.0f );
214 * @brief Request a relayout using the ControlInterface.
216 void RequestRelayout();
220 * @brief Helper to move the cursor, grab handle etc.
222 bool ProcessInputEvents();
224 void OnKeyboardFocus( bool hasFocus );
226 void OnCursorKeyEvent( const Event& event );
228 void HandleCursorKey( int keyCode );
230 void OnTapEvent( const Event& event );
232 void OnPanEvent( const Event& event );
234 void OnGrabHandleEvent( const Event& event );
236 void RepositionSelectionHandles( float visualX, float visualY );
238 void ChangeState( EventData::State newState );
240 LineIndex GetClosestLine( float y ) const;
243 * @brief Retrieves the cursor's logical position for a given touch point x,y
245 * @param[in] visualX The touch point x.
246 * @param[in] visualY The touch point y.
248 * @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.
250 CharacterIndex GetClosestCursorIndex( float visualX,
254 * @brief Calculates the cursor's position for a given character index in the logical order.
256 * It retrieves as well the line's height and the cursor's height and
257 * if there is a valid alternative cursor, its position and height.
259 * @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.
260 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
262 void GetCursorPosition( CharacterIndex logical,
263 CursorInfo& cursorInfo );
266 * @brief Calculates the new cursor index.
268 * It takes into account that in some scripts multiple characters can form a glyph and all of them
269 * need to be jumped with one key event.
271 * @param[in] index The initial new index.
273 * @return The new cursor index.
275 CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
277 void UpdateCursorPosition();
279 ControlInterface& mControlInterface; ///< Reference to the text controller.
280 LogicalModelPtr mLogicalModel; ///< Pointer to the logical model.
281 VisualModelPtr mVisualModel; ///< Pointer to the visual model.
282 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
283 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
284 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
285 View mView; ///< The view interface to the rendering back-end.
286 LayoutEngine mLayoutEngine; ///< The layout engine.
287 std::vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
288 Size mControlSize; ///< The size of the control.
289 Vector2 mAlignmentOffset; ///< Vertical and horizontal offset of the whole text inside the control due to alignment.
290 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
291 bool mRecalculateNaturalSize:1; ///< Whether the natural size needs to be recalculated.
296 } // namespace Toolkit
300 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__