1 #ifndef DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H
2 #define DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H
5 * Copyright (c) 2024 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/public-api/rendering/shader.h>
26 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
27 #include <dali-toolkit/internal/text/controller/text-controller.h>
28 #include <dali-toolkit/internal/text/input-style.h>
29 #include <dali-toolkit/internal/text/multi-language-support.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),
340 mTextColor(Color::BLACK),
341 mAnchorColor(Color::MEDIUM_BLUE),
342 mAnchorClickedColor(Color::DARK_MAGENTA),
344 mOperationsPending(NO_OPERATION),
345 mMaximumNumberOfCharacters(50u),
347 mInputFilter(nullptr),
348 mTextFitContentSize(),
350 mRecalculateNaturalSize(true),
351 mMarkupProcessorEnabled(false),
352 mClipboardHideEnabled(true),
353 mIsAutoScrollEnabled(false),
354 mIsAutoScrollMaxTextureExceeded(false),
355 mUpdateTextDirection(true),
356 mIsTextDirectionRTL(false),
357 mUnderlineSetByString(false),
358 mShadowSetByString(false),
359 mOutlineSetByString(false),
360 mFontStyleSetByString(false),
361 mStrikethroughSetByString(false),
362 mShouldClearFocusOnEscape(true),
363 mLayoutDirection(LayoutDirection::LEFT_TO_RIGHT),
364 mCurrentLineSize(0.f),
365 mTextFitMinSize(DEFAULT_TEXTFIT_MIN),
366 mTextFitMaxSize(DEFAULT_TEXTFIT_MAX),
367 mTextFitStepSize(DEFAULT_TEXTFIT_STEP),
368 mTextFitLineSize(0.f),
369 mFontSizeScale(DEFAULT_FONT_SIZE_SCALE),
370 mDisabledColorOpacity(DEFAULT_DISABLED_COLOR_OPACITY),
371 mFontSizeScaleEnabled(true),
372 mTextFitEnabled(false),
373 mTextFitChanged(false),
374 mTextFitArrayEnabled(false),
375 mIsLayoutDirectionChanged(false),
376 mIsUserInteractionEnabled(true),
377 mProcessorRegistered(false)
379 mModel = Model::New();
381 mFontClient = TextAbstraction::FontClient::Get();
382 if(mEditableControlInterface != nullptr && Clipboard::IsAvailable())
384 mClipboard = Clipboard::Get();
387 mView.SetVisualModel(mModel->mVisualModel);
388 mView.SetLogicalModel(mModel->mLogicalModel);
390 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
391 mMetrics = Metrics::New(mFontClient);
392 mLayoutEngine.SetMetrics(mMetrics);
394 // Set the text properties to default
395 mModel->mVisualModel->SetUnderlineEnabled(false);
396 mModel->mVisualModel->SetUnderlineHeight(0.0f);
398 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
401 const auto clearFocusOnEscapeValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("clearFocusOnEscape", Property::Type::BOOLEAN);
403 // Default is true. If config don't have "clearFocusOnEscape" property, make it true.
404 mShouldClearFocusOnEscape = (!clearFocusOnEscapeValue || clearFocusOnEscapeValue->Get<bool>());
411 delete mFontDefaults;
412 delete mUnderlineDefaults;
413 delete mShadowDefaults;
414 delete mEmbossDefaults;
415 delete mOutlineDefaults;
419 // Text Controller Implementation.
422 * @copydoc Text::Controller::RequestRelayout()
424 void RequestRelayout();
427 * @brief Request a relayout using the ControlInterface.
429 void QueueModifyEvent(ModifyEvent::Type type)
431 if(ModifyEvent::TEXT_REPLACED == type)
433 // Cancel previously queued inserts etc.
434 mModifyEvents.Clear();
439 mModifyEvents.PushBack(event);
441 // The event will be processed during relayout
446 * @copydoc Text::Controller::ResetFontAndStyleData()
448 void ResetFontAndStyleData()
456 * @brief Helper to move the cursor, grab handle etc.
458 bool ProcessInputEvents();
461 * @brief Helper to check whether any place-holder text is available.
463 bool IsPlaceholderAvailable() const
465 return (mEventData &&
466 (!mEventData->mPlaceholderTextInactive.empty() ||
467 !mEventData->mPlaceholderTextActive.empty()));
470 bool IsShowingPlaceholderText() const
472 return (mEventData && mEventData->mIsShowingPlaceholderText);
476 * @brief Helper to check whether active place-holder text is available.
478 bool IsFocusedPlaceholderAvailable() const
480 return (mEventData && !mEventData->mPlaceholderTextActive.empty());
483 bool IsShowingRealText() const
485 return (!IsShowingPlaceholderText() &&
486 0u != mModel->mLogicalModel->mText.Count());
490 * @brief Called when placeholder-text is hidden
492 void PlaceholderCleared()
496 mEventData->mIsShowingPlaceholderText = false;
498 // Remove mPlaceholderTextColor
499 mModel->mVisualModel->SetTextColor(mTextColor);
503 void ClearPreEditFlag()
507 mEventData->mPreEditFlag = false;
508 mEventData->mPreEditStartPosition = 0;
509 mEventData->mPreEditLength = 0;
513 void ResetInputMethodContext()
517 // Reset incase we are in a pre-edit state.
518 if(mEventData->mInputMethodContext)
520 mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding )
527 float GetFontSizeScale()
529 return mFontSizeScaleEnabled ? mFontSizeScale : 1.0f;
533 * @copydoc Controller::SetAnchorColor()
535 void SetAnchorColor(const Vector4& color);
538 * @copydoc Controller::GetAnchorColor()
540 const Vector4& GetAnchorColor() const;
543 * @copydoc Controller::SetAnchorClickedColor()
545 void SetAnchorClickedColor(const Vector4& color);
548 * @copydoc Controller::GetAnchorClickedColor()
550 const Vector4& GetAnchorClickedColor() const;
553 * @brief Updates the color of anchors.
555 void UpdateAnchorColor();
558 * @brief Helper to notify InputMethodContext with surrounding text & cursor changes.
560 void NotifyInputMethodContext();
563 * @brief Helper to notify InputMethodContext with multi line status.
565 void NotifyInputMethodContextMultiLineStatus();
568 * @brief Retrieve the current cursor position.
570 * @return The cursor position.
572 CharacterIndex GetLogicalCursorPosition() const;
575 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
577 * @param[in] index The character index from where to count the number of consecutive white spaces.
579 * @return The number of consecutive white spaces.
581 Length GetNumberOfWhiteSpaces(CharacterIndex index) const;
584 * @brief Retrieve any text previously set.
586 * @param[out] text A string of UTF-8 characters.
588 void GetText(std::string& text) const;
591 * @brief Retrieve any text previously set starting from the given @p index.
593 * @param[in] index The character index from where to retrieve the text.
594 * @param[out] text A string of UTF-8 characters.
596 * @see Dali::Toolkit::Text::Controller::GetText()
598 void GetText(CharacterIndex index, std::string& text) const;
601 * @brief Retrieves number of characters previously set.
603 * @return A length of UTF-32 characters.
605 * @see Dali::Toolkit::Text::Controller::GetNumberOfCharacters()
607 Length GetNumberOfCharacters() const;
609 bool EnsureClipboardCreated()
613 mClipboard = Clipboard::Get();
616 return mClipboard != nullptr ? true : false;
619 bool IsClipboardEmpty()
621 bool result(Clipboard::IsAvailable() && EnsureClipboardCreated() && mClipboard.NumberOfItems());
622 return !result; // If NumberOfItems greater than 0, return false
625 bool IsClipboardVisible()
627 bool result(Clipboard::IsAvailable() && EnsureClipboardCreated() && mClipboard.IsVisible());
632 * @copydoc Controller::GetLayoutDirection()
634 Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
637 * @brief Checks text direction.
638 * @return The text direction.
640 Toolkit::DevelText::TextDirection::Type GetTextDirection();
643 * @brief Calculates the start character index of the first paragraph to be updated and
644 * the end character index of the last paragraph to be updated.
646 * @param[out] numberOfCharacters The number of characters to be updated.
648 void CalculateTextUpdateIndices(Length& numberOfCharacters);
651 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
653 * @note It never clears the text stored in utf32.
655 * @param[in] startIndex Index to the first character to be cleared.
656 * @param[in] endIndex Index to the last character to be cleared.
657 * @param[in] operations The operations required.
659 void ClearModelData(CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations);
662 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
664 * When text or style changes the model is set with some operations pending.
665 * When i.e. the text's size or a relayout is required this method is called
666 * with a given @p operationsRequired parameter. The operations required are
667 * matched with the operations pending to perform the minimum number of operations.
669 * @param[in] operationsRequired The operations required.
671 * @return @e true if the model has been modified.
673 bool UpdateModel(OperationsMask operationsRequired);
676 * @brief Retreieves the default style.
678 * @param[out] inputStyle The default style.
680 void RetrieveDefaultInputStyle(InputStyle& inputStyle);
683 * @brief Retrieve the line height of the default font.
685 float GetDefaultFontLineHeight();
688 * @copydoc Controller::SetDefaultLineSpacing
690 bool SetDefaultLineSpacing(float lineSpacing);
693 * @copydoc Controller::SetDefaultLineSize
695 bool SetDefaultLineSize(float lineSize);
698 * @copydoc Controller::SetRelativeLineSize
700 bool SetRelativeLineSize(float relativeLineSize);
703 * @copydoc Controller::GetRelativeLineSize
705 float GetRelativeLineSize();
708 * @copydoc Text::Controller::GetPrimaryCursorPosition()
710 CharacterIndex GetPrimaryCursorPosition() const;
713 * @copydoc Text::Controller::SetPrimaryCursorPosition()
715 bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
718 * @copydoc Text::SelectableControlInterface::GetSelectedText()
720 string GetSelectedText();
723 * @copydoc Text::EditableControlInterface::CopyText()
728 * @copydoc Text::EditableControlInterface::CutText()
733 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
735 void SetTextSelectionRange(const uint32_t* pStart, const uint32_t* pEndf);
738 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
740 Uint32Pair GetTextSelectionRange() const;
743 * @copydoc Text::EditableControlInterface::IsEditable()
745 bool IsEditable() const;
748 * @copydoc Text::EditableControlInterface::SetEditable()
750 void SetEditable(bool editable);
753 * @copydoc Controller::UpdateAfterFontChange
755 void UpdateAfterFontChange(const std::string& newDefaultFont);
758 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
760 * @param[out] selectedText The selected text encoded in utf8.
761 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
763 void RetrieveSelection(std::string& selectedText, bool deleteAfterRetrieval);
765 void SetSelection(int start, int end);
767 std::pair<int, int> GetSelectionIndexes() const;
769 void ShowClipboard();
771 void HideClipboard();
773 void SetClipboardHideEnable(bool enable);
775 bool CopyStringToClipboard(const std::string& source);
777 void SendSelectionToClipboard(bool deleteAfterSending);
779 void RepositionSelectionHandles();
780 void RepositionSelectionHandles(float visualX, float visualY, Controller::NoTextTap::Action action);
782 void SetPopupButtons();
784 void ChangeState(EventData::State newState);
787 * @brief Calculates the cursor's position for a given character index in the logical order.
789 * It retrieves as well the line's height and the cursor's height and
790 * if there is a valid alternative cursor, its position and height.
792 * @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.
793 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
795 void GetCursorPosition(CharacterIndex logical,
796 CursorInfo& cursorInfo);
799 * @brief Calculates the new cursor index.
801 * It takes into account that in some scripts multiple characters can form a glyph and all of them
802 * need to be jumped with one key event.
804 * @param[in] index The initial new index.
806 * @return The new cursor index.
808 CharacterIndex CalculateNewCursorIndex(CharacterIndex index) const;
811 * @brief Updates the cursor position.
813 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
814 * It sets the position of the secondary cursor if it's a valid one.
815 * Sets which cursors are active.
817 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
820 void UpdateCursorPosition(const CursorInfo& cursorInfo);
823 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
825 * @param[in] handleType One of the selection handles.
826 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
828 void UpdateSelectionHandle(HandleType handleType,
829 const CursorInfo& cursorInfo);
832 * @biref Clamps the horizontal scrolling to get the control always filled with text.
834 * @param[in] layoutSize The size of the laid out text.
836 void ClampHorizontalScroll(const Vector2& layoutSize);
839 * @biref Clamps the vertical scrolling to get the control always filled with text.
841 * @param[in] layoutSize The size of the laid out text.
843 void ClampVerticalScroll(const Vector2& layoutSize);
846 * @brief Scrolls the text to make a position visible.
848 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
850 * @param[in] position A position in text coords.
851 * @param[in] lineHeight The line height for the given position.
853 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
854 * or moving the selection handles.
856 void ScrollToMakePositionVisible(const Vector2& position, float lineHeight);
859 * @brief Scrolls the text to make the cursor visible.
861 * This method is called after deleting text.
863 void ScrollTextToMatchCursor(const CursorInfo& cursorInfo);
866 * @brief Scrolls the text to make primary cursor visible.
868 void ScrollTextToMatchCursor();
871 * @brief Create an actor that renders the text background color
873 * @return the created actor or an empty handle if no background color needs to be rendered.
875 Actor CreateBackgroundActor();
878 * @brief fill needed relayout parameters whenever a property is changed and a re-layout is needed for the entire text.
880 void RelayoutAllCharacters();
883 * @copydoc Controller::IsInputStyleChangedSignalsQueueEmpty
885 bool IsInputStyleChangedSignalsQueueEmpty();
888 * @copydoc Controller::ProcessInputStyleChangedSignals
890 void ProcessInputStyleChangedSignals();
893 * @copydoc Controller::ScrollBy()
895 void ScrollBy(Vector2 scroll);
898 * @copydoc Controller::IsScrollable()
900 bool IsScrollable(const Vector2& displacement);
903 * @copydoc Controller::GetHorizontalScrollPosition()
905 float GetHorizontalScrollPosition();
908 * @copydoc Controller::GetVerticalScrollPosition()
910 float GetVerticalScrollPosition();
913 * @copydoc Controller::SetAutoScrollEnabled()
915 void SetAutoScrollEnabled(bool enable);
918 * @copydoc Controller::SetEnableCursorBlink()
920 void SetEnableCursorBlink(bool enable);
923 * @copydoc Controller::SetMultiLineEnabled()
925 void SetMultiLineEnabled(bool enable);
928 * @copydoc Controller::SetHorizontalAlignment()
930 void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
933 * @copydoc Controller::SetVerticalAlignment()
935 void SetVerticalAlignment(VerticalAlignment::Type alignment);
938 * @copydoc Controller::SetLineWrapMode()
940 void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
943 * @copydoc Controller::SetDefaultColor()
945 void SetDefaultColor(const Vector4& color);
948 * @copydoc Controller::SetUserInteractionEnabled()
950 void SetUserInteractionEnabled(bool enabled);
953 * @brief Helper to clear font-specific data (only).
955 void ClearFontData();
958 * @brief Helper to clear text's style data.
960 void ClearStyleData();
963 * @brief Used to reset the scroll position after setting a new text.
965 void ResetScrollPosition();
968 * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
970 * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
972 void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
975 * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
977 * @param[in] characterOffset A position in text coords.
979 * @return the 0-based index in anchor vector (-1 if an anchor not found)
981 int32_t GetAnchorIndex(size_t characterOffset) const;
984 * @brief Return the geometrical position of an anchor relative to the parent origin point.
986 * @param[in] anchor An anchor.
988 * @return The x, y, z coordinates of an anchor.
990 Vector3 GetAnchorPosition(Anchor anchor) const;
993 * @brief Return the size of an anchor expresed as a vector containing anchor's width and height.
995 * @param[in] anchor An anchor.
997 * @return The width and height of an anchor.
999 Vector2 GetAnchorSize(Anchor anchor) const;
1002 * @brief Return the actor representing an anchor.
1004 * @param[in] anchor An anchor.
1006 * @return The actor representing an anchor.
1008 Toolkit::TextAnchor CreateAnchorActor(Anchor anchor);
1012 * @brief Gets implementation from the controller handle.
1013 * @param controller The text controller
1014 * @return The implementation of the Controller
1016 static Impl& GetImplementation(Text::Controller& controller)
1018 return *controller.mImpl;
1022 // Declared private and left undefined to avoid copies.
1024 // Declared private and left undefined to avoid copies.
1025 Impl& operator=(const Impl&);
1028 * @brief Copy Underlined-Character-Runs from Logical-Model to Underlined-Glyph-Runs in Visual-Model
1030 * @param shouldClearPreUnderlineRuns Whether should clear the existing Underlined-Glyph-Runs in Visual-Model
1032 void CopyUnderlinedFromLogicalToVisualModels(bool shouldClearPreUnderlineRuns);
1035 * @brief Copy strikethrough-Character-Runs from Logical-Model to strikethrough-Glyph-Runs in Visual-Model
1038 void CopyStrikethroughFromLogicalToVisualModels();
1041 * @brief Copy CharacterSpacing-Character-Runs from Logical-Model to CharacterSpacing-Glyph-Runs in Visual-Model
1044 void CopyCharacterSpacingFromLogicalToVisualModels();
1047 ControlInterface* mControlInterface; ///< Reference to the text controller.
1048 EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
1049 SelectableControlInterface* mSelectableControlInterface; ///< Reference to the selectable text controller.
1050 AnchorControlInterface* mAnchorControlInterface; ///< Reference to the anchor controller.
1051 ModelPtr mModel; ///< Pointer to the text's model.
1052 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
1053 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
1054 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
1055 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
1056 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
1057 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
1058 CallbackBase* mIdleCallback; ///< Callback what would be called at idler
1059 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
1060 Clipboard mClipboard; ///< Handle to the system clipboard
1061 View mView; ///< The view interface to the rendering back-end.
1062 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
1063 Layout::Engine mLayoutEngine; ///< The layout engine.
1064 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
1065 Vector4 mTextColor; ///< The regular text color
1066 Vector4 mAnchorColor; ///< The anchor color
1067 Vector4 mAnchorClickedColor; ///< The anchor clicked color
1068 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
1069 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
1070 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
1071 HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode.
1072 std::unique_ptr<InputFilter> mInputFilter; ///< Avoid allocating this when the user does not specify input filter mode.
1073 Vector2 mTextFitContentSize; ///< Size of Text fit content
1075 std::vector<Toolkit::DevelTextLabel::FitOption> mTextFitArray; ///< List of FitOption for TextFitArray operation.
1077 bool mRecalculateNaturalSize : 1; ///< Whether the natural size needs to be recalculated.
1078 bool mMarkupProcessorEnabled : 1; ///< Whether the mark-up procesor is enabled.
1079 bool mClipboardHideEnabled : 1; ///< Whether the ClipboardHide function work or not
1080 bool mIsAutoScrollEnabled : 1; ///< Whether auto text scrolling is enabled.
1081 bool mIsAutoScrollMaxTextureExceeded : 1; ///< Whether auto text scrolling is exceed max texture size.
1082 bool mUpdateTextDirection : 1; ///< Whether the text direction needs to be updated.
1083 CharacterDirection mIsTextDirectionRTL : 1; ///< Whether the text direction is right to left or not
1085 bool mUnderlineSetByString : 1; ///< Set when underline is set by string (legacy) instead of map
1086 bool mShadowSetByString : 1; ///< Set when shadow is set by string (legacy) instead of map
1087 bool mOutlineSetByString : 1; ///< Set when outline is set by string (legacy) instead of map
1088 bool mFontStyleSetByString : 1; ///< Set when font style is set by string (legacy) instead of map
1089 bool mStrikethroughSetByString : 1; ///< Set when strikethrough is set by string (legacy) instead of map
1090 bool mShouldClearFocusOnEscape : 1; ///< Whether text control should clear key input focus
1091 LayoutDirection::Type mLayoutDirection; ///< Current system language direction
1093 Shader mShaderBackground; ///< The shader for text background.
1095 float mCurrentLineSize; ///< Used to store the MinLineSize set by user when TextFitArray is enabled.
1096 float mTextFitMinSize; ///< Minimum Font Size for text fit. Default 10
1097 float mTextFitMaxSize; ///< Maximum Font Size for text fit. Default 100
1098 float mTextFitStepSize; ///< Step Size for font intervalse. Default 1
1099 float mTextFitLineSize; ///< This is the LineSize that is the standard when performing TextFit.
1100 float mFontSizeScale; ///< Scale value for Font Size. Default 1.0
1101 float mDisabledColorOpacity; ///< Color opacity when disabled.
1102 bool mFontSizeScaleEnabled : 1; ///< Whether the font size scale is enabled.
1103 bool mTextFitEnabled : 1; ///< Whether the text's fit is enabled.
1104 bool mTextFitChanged : 1; ///< Whether the text fit property has changed.
1105 bool mTextFitArrayEnabled : 1; ///< Whether the text's fit array is enabled.
1106 bool mIsLayoutDirectionChanged : 1; ///< Whether the layout has changed.
1107 bool mIsUserInteractionEnabled : 1; ///< Whether the user interaction is enabled.
1108 bool mProcessorRegistered : 1; ///< Whether the text controller registered into processor or not.
1111 friend ControllerImplEventHandler;
1112 friend ControllerImplModelUpdater;
1113 friend SelectionHandleController;
1118 } // namespace Toolkit
1122 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H