1 #ifndef DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H
2 #define DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H
5 * Copyright (c) 2022 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/text-abstraction/font-client.h>
24 #include <dali/public-api/rendering/shader.h>
27 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
28 #include <dali-toolkit/internal/text/input-style.h>
29 #include <dali-toolkit/internal/text/controller/text-controller.h>
30 #include <dali-toolkit/internal/text/text-model.h>
31 #include <dali-toolkit/internal/text/text-view.h>
32 #include <dali-toolkit/public-api/styling/style-manager.h>
40 const float DEFAULT_TEXTFIT_MIN = 10.f;
41 const float DEFAULT_TEXTFIT_MAX = 100.f;
42 const float DEFAULT_TEXTFIT_STEP = 1.f;
43 const float DEFAULT_FONT_SIZE_SCALE = 1.f;
44 const float DEFAULT_DISABLED_COLOR_OPACITY = 0.3f;
46 //Forward declarations
49 struct ControllerImplEventHandler;
50 struct ControllerImplModelUpdater;
51 struct SelectionHandleController;
53 class SelectableControlInterface;
54 class AnchorControlInterface;
58 // Used to queue input events until DoRelayout()
66 LEFT_SELECTION_HANDLE_EVENT,
67 RIGHT_SELECTION_HANDLE_EVENT,
105 EDITING_WITH_GRAB_HANDLE,
106 EDITING_WITH_PASTE_POPUP,
108 SELECTION_HANDLE_PANNING,
112 EventData(DecoratorPtr decorator, InputMethodContext& inputMethodContext);
114 ~EventData() = default;
116 static bool IsEditingState(State stateToCheck)
118 return (stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP);
121 DecoratorPtr mDecorator; ///< Pointer to the decorator.
122 InputMethodContext mInputMethodContext; ///< The Input Method Framework Manager.
123 std::unique_ptr<FontDefaults> mPlaceholderFont; ///< The placeholder default font.
124 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus.
125 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
126 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color.
129 * This is used to delay handling events until after the model has been updated.
130 * The number of updates to the model is minimized to improve performance.
132 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
134 Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
136 InputStyle mInputStyle; ///< The style to be set to the new inputed text.
138 State mPreviousState; ///< Stores the current state before it's updated with the new one.
139 State mState; ///< Selection mode, edit mode etc.
141 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
142 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
143 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
145 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
146 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
148 float mCursorHookPositionX; ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles.
150 Controller::NoTextTap::Action mDoubleTapAction; ///< Action to be done when there is a double tap on top of 'no text'
151 Controller::NoTextTap::Action mLongPressAction; ///< Action to be done when there is a long press on top of 'no text'
153 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
154 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
155 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
156 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
157 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
158 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
159 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
160 bool mUpdateCursorHookPosition : 1; ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
161 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
162 bool mUpdateGrabHandlePosition : 1; ///< True if the visual position of the grab handle must be recalculated.
163 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
164 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
165 bool mIsLeftHandleSelected : 1; ///< Whether is the left handle the one which is selected.
166 bool mIsRightHandleSelected : 1; ///< Whether is the right handle the one which is selected.
167 bool mUpdateHighlightBox : 1; ///< True if the text selection high light box must be updated.
168 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
169 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
170 bool mAllTextSelected : 1; ///< True if the selection handles are selecting all the text.
171 bool mUpdateInputStyle : 1; ///< Whether to update the input style after moving the cursor.
172 bool mPasswordInput : 1; ///< True if password input is enabled.
173 bool mCheckScrollAmount : 1; ///< Whether to check scrolled amount after updating the position
174 bool mIsPlaceholderPixelSize : 1; ///< True if the placeholder font size is set as pixel size.
175 bool mIsPlaceholderElideEnabled : 1; ///< True if the placeholder text's elide is enabled.
176 bool mPlaceholderEllipsisFlag : 1; ///< True if the text controller sets the placeholder ellipsis.
177 bool mShiftSelectionFlag : 1; ///< True if the text selection using Shift key is enabled.
178 bool mUpdateAlignment : 1; ///< True if the whole text needs to be full aligned..
179 bool mEditingEnabled : 1; ///< True if the editing is enabled, false otherwise.
186 TEXT_REPLACED, ///< The entire text was replaced
187 TEXT_INSERTED, ///< Insert characters at the current cursor position
188 TEXT_DELETED ///< Characters were deleted
197 : mFontDescription(),
198 mDefaultPointSize(0.f),
201 familyDefined(false),
202 weightDefined(false),
207 // Initially use the default platform font
208 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
209 fontClient.GetDefaultPlatformFontDescription(mFontDescription);
212 FontId GetFontId(TextAbstraction::FontClient& fontClient, float fontPointSize)
216 const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>(fontPointSize * 64.f);
217 mFontId = fontClient.GetFontId(mFontDescription, pointSize);
223 TextAbstraction::FontDescription mFontDescription; ///< The default font's description.
224 float mDefaultPointSize; ///< The default font's point size.
225 float mFitPointSize; ///< The fit font's point size.
226 FontId mFontId; ///< The font's id of the default font.
227 bool familyDefined : 1; ///< Whether the default font's family name is defined.
228 bool weightDefined : 1; ///< Whether the default font's weight is defined.
229 bool widthDefined : 1; ///< Whether the default font's width is defined.
230 bool slantDefined : 1; ///< Whether the default font's slant is defined.
231 bool sizeDefined : 1; ///< Whether the default font's point size is defined.
235 * @brief Stores indices used to update the text.
236 * Stores the character index where the text is updated and the number of characters removed and added.
237 * Stores as well indices to the first and the last paragraphs to be updated.
239 struct TextUpdateInfo
242 : mCharacterIndex(0u),
243 mNumberOfCharactersToRemove(0u),
244 mNumberOfCharactersToAdd(0u),
245 mPreviousNumberOfCharacters(0u),
246 mParagraphCharacterIndex(0u),
247 mRequestedNumberOfCharacters(0u),
248 mStartGlyphIndex(0u),
250 mEstimatedNumberOfLines(0u),
252 mFullRelayoutNeeded(true),
253 mIsLastCharacterNewParagraph(false)
261 CharacterIndex mCharacterIndex; ///< Index to the first character to be updated.
262 Length mNumberOfCharactersToRemove; ///< The number of characters to be removed.
263 Length mNumberOfCharactersToAdd; ///< The number of characters to be added.
264 Length mPreviousNumberOfCharacters; ///< The number of characters before the text update.
266 CharacterIndex mParagraphCharacterIndex; ///< Index of the first character of the first paragraph to be updated.
267 Length mRequestedNumberOfCharacters; ///< The requested number of characters.
268 GlyphIndex mStartGlyphIndex;
269 LineIndex mStartLineIndex;
270 Length mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting.
272 bool mClearAll : 1; ///< Whether the whole text is cleared. i.e. when the text is reset.
273 bool mFullRelayoutNeeded : 1; ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
274 bool mIsLastCharacterNewParagraph : 1; ///< Whether the last character is a new paragraph character.
278 // Clear all info except the mPreviousNumberOfCharacters member.
279 mCharacterIndex = static_cast<CharacterIndex>(-1);
280 mNumberOfCharactersToRemove = 0u;
281 mNumberOfCharactersToAdd = 0u;
282 mParagraphCharacterIndex = 0u;
283 mRequestedNumberOfCharacters = 0u;
284 mStartGlyphIndex = 0u;
285 mStartLineIndex = 0u;
286 mEstimatedNumberOfLines = 0u;
288 mFullRelayoutNeeded = false;
289 mIsLastCharacterNewParagraph = false;
293 struct UnderlineDefaults
295 std::string properties;
296 // TODO: complete with underline parameters.
299 struct ShadowDefaults
301 std::string properties;
302 // TODO: complete with shadow parameters.
305 struct EmbossDefaults
307 std::string properties;
308 // TODO: complete with emboss parameters.
311 struct OutlineDefaults
313 std::string properties;
314 // TODO: complete with outline parameters.
317 struct Controller::Impl
319 Impl(ControlInterface* controlInterface,
320 EditableControlInterface* editableControlInterface,
321 SelectableControlInterface* selectableControlInterface,
322 AnchorControlInterface* anchorControlInterface)
323 : mControlInterface(controlInterface),
324 mEditableControlInterface(editableControlInterface),
325 mSelectableControlInterface(selectableControlInterface),
326 mAnchorControlInterface(anchorControlInterface),
329 mUnderlineDefaults(NULL),
330 mShadowDefaults(NULL),
331 mEmbossDefaults(NULL),
332 mOutlineDefaults(NULL),
339 mTextColor(Color::BLACK),
341 mOperationsPending(NO_OPERATION),
342 mMaximumNumberOfCharacters(50u),
344 mInputFilter(nullptr),
345 mRecalculateNaturalSize(true),
346 mMarkupProcessorEnabled(false),
347 mClipboardHideEnabled(true),
348 mIsAutoScrollEnabled(false),
349 mIsAutoScrollMaxTextureExceeded(false),
350 mUpdateTextDirection(true),
351 mIsTextDirectionRTL(false),
352 mUnderlineSetByString(false),
353 mShadowSetByString(false),
354 mOutlineSetByString(false),
355 mFontStyleSetByString(false),
356 mStrikethroughSetByString(false),
357 mShouldClearFocusOnEscape(true),
358 mLayoutDirection(LayoutDirection::LEFT_TO_RIGHT),
359 mTextFitMinSize(DEFAULT_TEXTFIT_MIN),
360 mTextFitMaxSize(DEFAULT_TEXTFIT_MAX),
361 mTextFitStepSize(DEFAULT_TEXTFIT_STEP),
362 mFontSizeScale(DEFAULT_FONT_SIZE_SCALE),
363 mDisabledColorOpacity(DEFAULT_DISABLED_COLOR_OPACITY),
364 mFontSizeScaleEnabled(true),
365 mTextFitEnabled(false),
366 mTextFitChanged(false),
367 mIsLayoutDirectionChanged(false),
368 mIsUserInteractionEnabled(true)
370 mModel = Model::New();
372 mFontClient = TextAbstraction::FontClient::Get();
373 if(mEditableControlInterface != nullptr && Clipboard::IsAvailable())
375 mClipboard = Clipboard::Get();
378 mView.SetVisualModel(mModel->mVisualModel);
379 mView.SetLogicalModel(mModel->mLogicalModel);
381 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
382 mMetrics = Metrics::New(mFontClient);
383 mLayoutEngine.SetMetrics(mMetrics);
385 // Set the text properties to default
386 mModel->mVisualModel->SetUnderlineEnabled(false);
387 mModel->mVisualModel->SetUnderlineHeight(0.0f);
389 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
392 const Property::Map& config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
393 const auto clearFocusOnEscapeValue = config.Find("clearFocusOnEscape", Property::Type::BOOLEAN);
395 // Default is true. If config don't have "clearFocusOnEscape" property, make it true.
396 mShouldClearFocusOnEscape = (!clearFocusOnEscapeValue || clearFocusOnEscapeValue->Get<bool>());
403 delete mFontDefaults;
404 delete mUnderlineDefaults;
405 delete mShadowDefaults;
406 delete mEmbossDefaults;
407 delete mOutlineDefaults;
411 // Text Controller Implementation.
414 * @copydoc Text::Controller::RequestRelayout()
416 void RequestRelayout();
419 * @brief Request a relayout using the ControlInterface.
421 void QueueModifyEvent(ModifyEvent::Type type)
423 if(ModifyEvent::TEXT_REPLACED == type)
425 // Cancel previously queued inserts etc.
426 mModifyEvents.Clear();
431 mModifyEvents.PushBack(event);
433 // The event will be processed during relayout
438 * @brief Helper to move the cursor, grab handle etc.
440 bool ProcessInputEvents();
443 * @brief Helper to check whether any place-holder text is available.
445 bool IsPlaceholderAvailable() const
447 return (mEventData &&
448 (!mEventData->mPlaceholderTextInactive.empty() ||
449 !mEventData->mPlaceholderTextActive.empty()));
452 bool IsShowingPlaceholderText() const
454 return (mEventData && mEventData->mIsShowingPlaceholderText);
458 * @brief Helper to check whether active place-holder text is available.
460 bool IsFocusedPlaceholderAvailable() const
462 return (mEventData && !mEventData->mPlaceholderTextActive.empty());
465 bool IsShowingRealText() const
467 return (!IsShowingPlaceholderText() &&
468 0u != mModel->mLogicalModel->mText.Count());
472 * @brief Called when placeholder-text is hidden
474 void PlaceholderCleared()
478 mEventData->mIsShowingPlaceholderText = false;
480 // Remove mPlaceholderTextColor
481 mModel->mVisualModel->SetTextColor(mTextColor);
485 void ClearPreEditFlag()
489 mEventData->mPreEditFlag = false;
490 mEventData->mPreEditStartPosition = 0;
491 mEventData->mPreEditLength = 0;
495 void ResetInputMethodContext()
499 // Reset incase we are in a pre-edit state.
500 if(mEventData->mInputMethodContext)
502 mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding )
509 float GetFontSizeScale()
511 return mFontSizeScaleEnabled ? mFontSizeScale : 1.0f;
515 * @brief Helper to notify InputMethodContext with surrounding text & cursor changes.
517 void NotifyInputMethodContext();
520 * @brief Helper to notify InputMethodContext with multi line status.
522 void NotifyInputMethodContextMultiLineStatus();
525 * @brief Retrieve the current cursor position.
527 * @return The cursor position.
529 CharacterIndex GetLogicalCursorPosition() const;
532 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
534 * @param[in] index The character index from where to count the number of consecutive white spaces.
536 * @return The number of consecutive white spaces.
538 Length GetNumberOfWhiteSpaces(CharacterIndex index) const;
541 * @brief Retrieve any text previously set.
543 * @param[out] text A string of UTF-8 characters.
545 void GetText(std::string& text) const;
548 * @brief Retrieve any text previously set starting from the given @p index.
550 * @param[in] index The character index from where to retrieve the text.
551 * @param[out] text A string of UTF-8 characters.
553 * @see Dali::Toolkit::Text::Controller::GetText()
555 void GetText(CharacterIndex index, std::string& text) const;
557 bool EnsureClipboardCreated()
561 mClipboard = Clipboard::Get();
564 return mClipboard != nullptr ? true : false;
567 bool IsClipboardEmpty()
569 bool result(Clipboard::IsAvailable() && EnsureClipboardCreated() && mClipboard.NumberOfItems());
570 return !result; // If NumberOfItems greater than 0, return false
573 bool IsClipboardVisible()
575 bool result(Clipboard::IsAvailable() && EnsureClipboardCreated() && mClipboard.IsVisible());
580 * @copydoc Controller::GetLayoutDirection()
582 Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
585 * @brief Checks text direction.
586 * @return The text direction.
588 Toolkit::DevelText::TextDirection::Type GetTextDirection();
591 * @brief Calculates the start character index of the first paragraph to be updated and
592 * the end character index of the last paragraph to be updated.
594 * @param[out] numberOfCharacters The number of characters to be updated.
596 void CalculateTextUpdateIndices(Length& numberOfCharacters);
599 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
601 * @note It never clears the text stored in utf32.
603 * @param[in] startIndex Index to the first character to be cleared.
604 * @param[in] endIndex Index to the last character to be cleared.
605 * @param[in] operations The operations required.
607 void ClearModelData(CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations);
610 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
612 * When text or style changes the model is set with some operations pending.
613 * When i.e. the text's size or a relayout is required this method is called
614 * with a given @p operationsRequired parameter. The operations required are
615 * matched with the operations pending to perform the minimum number of operations.
617 * @param[in] operationsRequired The operations required.
619 * @return @e true if the model has been modified.
621 bool UpdateModel(OperationsMask operationsRequired);
624 * @brief Retreieves the default style.
626 * @param[out] inputStyle The default style.
628 void RetrieveDefaultInputStyle(InputStyle& inputStyle);
631 * @brief Retrieve the line height of the default font.
633 float GetDefaultFontLineHeight();
636 * @copydoc Controller::SetDefaultLineSpacing
638 bool SetDefaultLineSpacing(float lineSpacing);
641 * @copydoc Controller::SetDefaultLineSize
643 bool SetDefaultLineSize(float lineSize);
646 * @copydoc Controller::SetRelativeLineSize
648 bool SetRelativeLineSize(float relativeLineSize);
651 * @copydoc Controller::GetRelativeLineSize
653 float GetRelativeLineSize();
656 * @copydoc Text::Controller::GetPrimaryCursorPosition()
658 CharacterIndex GetPrimaryCursorPosition() const;
661 * @copydoc Text::Controller::SetPrimaryCursorPosition()
663 bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
666 * @copydoc Text::SelectableControlInterface::GetSelectedText()
668 string GetSelectedText();
671 * @copydoc Text::EditableControlInterface::CopyText()
676 * @copydoc Text::EditableControlInterface::CutText()
681 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
683 void SetTextSelectionRange(const uint32_t* pStart, const uint32_t* pEndf);
686 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
688 Uint32Pair GetTextSelectionRange() const;
691 * @copydoc Text::EditableControlInterface::IsEditable()
693 bool IsEditable() const;
696 * @copydoc Text::EditableControlInterface::SetEditable()
698 void SetEditable(bool editable);
701 * @copydoc Controller::UpdateAfterFontChange
703 void UpdateAfterFontChange(const std::string& newDefaultFont);
706 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
708 * @param[out] selectedText The selected text encoded in utf8.
709 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
711 void RetrieveSelection(std::string& selectedText, bool deleteAfterRetrieval);
713 void SetSelection(int start, int end);
715 std::pair<int, int> GetSelectionIndexes() const;
717 void ShowClipboard();
719 void HideClipboard();
721 void SetClipboardHideEnable(bool enable);
723 bool CopyStringToClipboard(const std::string& source);
725 void SendSelectionToClipboard(bool deleteAfterSending);
727 void RequestGetTextFromClipboard();
729 void RepositionSelectionHandles();
730 void RepositionSelectionHandles(float visualX, float visualY, Controller::NoTextTap::Action action);
732 void SetPopupButtons();
734 void ChangeState(EventData::State newState);
737 * @brief Calculates the cursor's position for a given character index in the logical order.
739 * It retrieves as well the line's height and the cursor's height and
740 * if there is a valid alternative cursor, its position and height.
742 * @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.
743 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
745 void GetCursorPosition(CharacterIndex logical,
746 CursorInfo& cursorInfo);
749 * @brief Calculates the new cursor index.
751 * It takes into account that in some scripts multiple characters can form a glyph and all of them
752 * need to be jumped with one key event.
754 * @param[in] index The initial new index.
756 * @return The new cursor index.
758 CharacterIndex CalculateNewCursorIndex(CharacterIndex index) const;
761 * @brief Updates the cursor position.
763 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
764 * It sets the position of the secondary cursor if it's a valid one.
765 * Sets which cursors are active.
767 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
770 void UpdateCursorPosition(const CursorInfo& cursorInfo);
773 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
775 * @param[in] handleType One of the selection handles.
776 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
778 void UpdateSelectionHandle(HandleType handleType,
779 const CursorInfo& cursorInfo);
782 * @biref Clamps the horizontal scrolling to get the control always filled with text.
784 * @param[in] layoutSize The size of the laid out text.
786 void ClampHorizontalScroll(const Vector2& layoutSize);
789 * @biref Clamps the vertical scrolling to get the control always filled with text.
791 * @param[in] layoutSize The size of the laid out text.
793 void ClampVerticalScroll(const Vector2& layoutSize);
796 * @brief Scrolls the text to make a position visible.
798 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
800 * @param[in] position A position in text coords.
801 * @param[in] lineHeight The line height for the given position.
803 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
804 * or moving the selection handles.
806 void ScrollToMakePositionVisible(const Vector2& position, float lineHeight);
809 * @brief Scrolls the text to make the cursor visible.
811 * This method is called after deleting text.
813 void ScrollTextToMatchCursor(const CursorInfo& cursorInfo);
816 * @brief Scrolls the text to make primary cursor visible.
818 void ScrollTextToMatchCursor();
821 * @brief Create an actor that renders the text background color
823 * @return the created actor or an empty handle if no background color needs to be rendered.
825 Actor CreateBackgroundActor();
828 * @brief fill needed relayout parameters whenever a property is changed and a re-layout is needed for the entire text.
830 void RelayoutAllCharacters();
833 * @copydoc Controller::IsInputStyleChangedSignalsQueueEmpty
835 bool IsInputStyleChangedSignalsQueueEmpty();
838 * @copydoc Controller::ProcessInputStyleChangedSignals
840 void ProcessInputStyleChangedSignals();
843 * @copydoc Controller::ScrollBy()
845 void ScrollBy(Vector2 scroll);
848 * @copydoc Controller::IsScrollable()
850 bool IsScrollable(const Vector2& displacement);
853 * @copydoc Controller::GetHorizontalScrollPosition()
855 float GetHorizontalScrollPosition();
858 * @copydoc Controller::GetVerticalScrollPosition()
860 float GetVerticalScrollPosition();
863 * @copydoc Controller::SetAutoScrollEnabled()
865 void SetAutoScrollEnabled(bool enable);
868 * @copydoc Controller::SetEnableCursorBlink()
870 void SetEnableCursorBlink(bool enable);
873 * @copydoc Controller::SetMultiLineEnabled()
875 void SetMultiLineEnabled(bool enable);
878 * @copydoc Controller::SetHorizontalAlignment()
880 void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
883 * @copydoc Controller::SetVerticalAlignment()
885 void SetVerticalAlignment(VerticalAlignment::Type alignment);
888 * @copydoc Controller::SetLineWrapMode()
890 void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
893 * @copydoc Controller::SetDefaultColor()
895 void SetDefaultColor(const Vector4& color);
898 * @copydoc Controller::SetUserInteractionEnabled()
900 void SetUserInteractionEnabled(bool enabled);
903 * @brief Helper to clear font-specific data (only).
905 void ClearFontData();
908 * @brief Helper to clear text's style data.
910 void ClearStyleData();
913 * @brief Used to reset the scroll position after setting a new text.
915 void ResetScrollPosition();
918 * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
920 * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
922 void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
925 * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
927 * @param[in] characterOffset A position in text coords.
929 * @return the 0-based index in anchor vector (-1 if an anchor not found)
931 int32_t GetAnchorIndex(size_t characterOffset) const;
934 * @brief Return the geometrical position of an anchor relative to the parent origin point.
936 * @param[in] anchor An anchor.
938 * @return The x, y, z coordinates of an anchor.
940 Vector3 GetAnchorPosition(Anchor anchor) const;
943 * @brief Return the size of an anchor expresed as a vector containing anchor's width and height.
945 * @param[in] anchor An anchor.
947 * @return The width and height of an anchor.
949 Vector2 GetAnchorSize(Anchor anchor) const;
952 * @brief Return the actor representing an anchor.
954 * @param[in] anchor An anchor.
956 * @return The actor representing an anchor.
958 Toolkit::TextAnchor CreateAnchorActor(Anchor anchor);
962 * @brief Gets implementation from the controller handle.
963 * @param controller The text controller
964 * @return The implementation of the Controller
966 static Impl& GetImplementation(Text::Controller& controller)
968 return *controller.mImpl;
972 // Declared private and left undefined to avoid copies.
974 // Declared private and left undefined to avoid copies.
975 Impl& operator=(const Impl&);
978 * @brief Copy Underlined-Character-Runs from Logical-Model to Underlined-Glyph-Runs in Visual-Model
980 * @param shouldClearPreUnderlineRuns Whether should clear the existing Underlined-Glyph-Runs in Visual-Model
982 void CopyUnderlinedFromLogicalToVisualModels(bool shouldClearPreUnderlineRuns);
985 * @brief Copy strikethrough-Character-Runs from Logical-Model to strikethrough-Glyph-Runs in Visual-Model
988 void CopyStrikethroughFromLogicalToVisualModels();
991 * @brief Copy CharacterSpacing-Character-Runs from Logical-Model to CharacterSpacing-Glyph-Runs in Visual-Model
994 void CopyCharacterSpacingFromLogicalToVisualModels();
997 ControlInterface* mControlInterface; ///< Reference to the text controller.
998 EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
999 SelectableControlInterface* mSelectableControlInterface; ///< Reference to the selectable text controller.
1000 AnchorControlInterface* mAnchorControlInterface; ///< Reference to the anchor controller.
1001 ModelPtr mModel; ///< Pointer to the text's model.
1002 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
1003 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
1004 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
1005 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
1006 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
1007 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
1008 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
1009 Clipboard mClipboard; ///< Handle to the system clipboard
1010 View mView; ///< The view interface to the rendering back-end.
1011 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
1012 Layout::Engine mLayoutEngine; ///< The layout engine.
1013 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
1014 Vector4 mTextColor; ///< The regular text color
1015 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
1016 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
1017 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
1018 HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode.
1019 std::unique_ptr<InputFilter> mInputFilter; ///< Avoid allocating this when the user does not specify input filter mode.
1020 Vector2 mTextFitContentSize; ///< Size of Text fit content
1022 bool mRecalculateNaturalSize : 1; ///< Whether the natural size needs to be recalculated.
1023 bool mMarkupProcessorEnabled : 1; ///< Whether the mark-up procesor is enabled.
1024 bool mClipboardHideEnabled : 1; ///< Whether the ClipboardHide function work or not
1025 bool mIsAutoScrollEnabled : 1; ///< Whether auto text scrolling is enabled.
1026 bool mIsAutoScrollMaxTextureExceeded : 1; ///< Whether auto text scrolling is exceed max texture size.
1027 bool mUpdateTextDirection : 1; ///< Whether the text direction needs to be updated.
1028 CharacterDirection mIsTextDirectionRTL : 1; ///< Whether the text direction is right to left or not
1030 bool mUnderlineSetByString : 1; ///< Set when underline is set by string (legacy) instead of map
1031 bool mShadowSetByString : 1; ///< Set when shadow is set by string (legacy) instead of map
1032 bool mOutlineSetByString : 1; ///< Set when outline is set by string (legacy) instead of map
1033 bool mFontStyleSetByString : 1; ///< Set when font style is set by string (legacy) instead of map
1034 bool mStrikethroughSetByString : 1; ///< Set when strikethrough is set by string (legacy) instead of map
1035 bool mShouldClearFocusOnEscape : 1; ///< Whether text control should clear key input focus
1036 LayoutDirection::Type mLayoutDirection; ///< Current system language direction
1038 Shader mShaderBackground; ///< The shader for text background.
1040 float mTextFitMinSize; ///< Minimum Font Size for text fit. Default 10
1041 float mTextFitMaxSize; ///< Maximum Font Size for text fit. Default 100
1042 float mTextFitStepSize; ///< Step Size for font intervalse. Default 1
1043 float mFontSizeScale; ///< Scale value for Font Size. Default 1.0
1044 float mDisabledColorOpacity; ///< Color opacity when disabled.
1045 bool mFontSizeScaleEnabled : 1; ///< Whether the font size scale is enabled.
1046 bool mTextFitEnabled : 1; ///< Whether the text's fit is enabled.
1047 bool mTextFitChanged : 1; ///< Whether the text fit property has changed.
1048 bool mIsLayoutDirectionChanged : 1; ///< Whether the layout has changed.
1049 bool mIsUserInteractionEnabled : 1; ///< Whether the user interaction is enabled.
1052 friend ControllerImplEventHandler;
1053 friend ControllerImplModelUpdater;
1054 friend SelectionHandleController;
1059 } // namespace Toolkit
1063 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H