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/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 mUpdateTextDirection(true),
350 mIsTextDirectionRTL(false),
351 mUnderlineSetByString(false),
352 mShadowSetByString(false),
353 mOutlineSetByString(false),
354 mFontStyleSetByString(false),
355 mStrikethroughSetByString(false),
356 mShouldClearFocusOnEscape(true),
357 mLayoutDirection(LayoutDirection::LEFT_TO_RIGHT),
358 mTextFitMinSize(DEFAULT_TEXTFIT_MIN),
359 mTextFitMaxSize(DEFAULT_TEXTFIT_MAX),
360 mTextFitStepSize(DEFAULT_TEXTFIT_STEP),
361 mFontSizeScale(DEFAULT_FONT_SIZE_SCALE),
362 mDisabledColorOpacity(DEFAULT_DISABLED_COLOR_OPACITY),
363 mFontSizeScaleEnabled(true),
364 mTextFitEnabled(false),
365 mTextFitChanged(false),
366 mIsLayoutDirectionChanged(false),
367 mIsUserInteractionEnabled(true)
369 mModel = Model::New();
371 mFontClient = TextAbstraction::FontClient::Get();
372 mClipboard = Clipboard::Get();
374 mView.SetVisualModel(mModel->mVisualModel);
375 mView.SetLogicalModel(mModel->mLogicalModel);
377 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
378 mMetrics = Metrics::New(mFontClient);
379 mLayoutEngine.SetMetrics(mMetrics);
381 // Set the text properties to default
382 mModel->mVisualModel->SetUnderlineEnabled(false);
383 mModel->mVisualModel->SetUnderlineHeight(0.0f);
385 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
388 const Property::Map& config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
389 const auto clearFocusOnEscapeValue = config.Find("clearFocusOnEscape", Property::Type::BOOLEAN);
391 // Default is true. If config don't have "clearFocusOnEscape" property, make it true.
392 mShouldClearFocusOnEscape = (!clearFocusOnEscapeValue || clearFocusOnEscapeValue->Get<bool>());
399 delete mFontDefaults;
400 delete mUnderlineDefaults;
401 delete mShadowDefaults;
402 delete mEmbossDefaults;
403 delete mOutlineDefaults;
407 // Text Controller Implementation.
410 * @copydoc Text::Controller::RequestRelayout()
412 void RequestRelayout();
415 * @brief Request a relayout using the ControlInterface.
417 void QueueModifyEvent(ModifyEvent::Type type)
419 if(ModifyEvent::TEXT_REPLACED == type)
421 // Cancel previously queued inserts etc.
422 mModifyEvents.Clear();
427 mModifyEvents.PushBack(event);
429 // The event will be processed during relayout
434 * @brief Helper to move the cursor, grab handle etc.
436 bool ProcessInputEvents();
439 * @brief Helper to check whether any place-holder text is available.
441 bool IsPlaceholderAvailable() const
443 return (mEventData &&
444 (!mEventData->mPlaceholderTextInactive.empty() ||
445 !mEventData->mPlaceholderTextActive.empty()));
448 bool IsShowingPlaceholderText() const
450 return (mEventData && mEventData->mIsShowingPlaceholderText);
454 * @brief Helper to check whether active place-holder text is available.
456 bool IsFocusedPlaceholderAvailable() const
458 return (mEventData && !mEventData->mPlaceholderTextActive.empty());
461 bool IsShowingRealText() const
463 return (!IsShowingPlaceholderText() &&
464 0u != mModel->mLogicalModel->mText.Count());
468 * @brief Called when placeholder-text is hidden
470 void PlaceholderCleared()
474 mEventData->mIsShowingPlaceholderText = false;
476 // Remove mPlaceholderTextColor
477 mModel->mVisualModel->SetTextColor(mTextColor);
481 void ClearPreEditFlag()
485 mEventData->mPreEditFlag = false;
486 mEventData->mPreEditStartPosition = 0;
487 mEventData->mPreEditLength = 0;
491 void ResetInputMethodContext()
495 // Reset incase we are in a pre-edit state.
496 if(mEventData->mInputMethodContext)
498 mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding )
505 float GetFontSizeScale()
507 return mFontSizeScaleEnabled ? mFontSizeScale : 1.0f;
511 * @brief Helper to notify InputMethodContext with surrounding text & cursor changes.
513 void NotifyInputMethodContext();
516 * @brief Helper to notify InputMethodContext with multi line status.
518 void NotifyInputMethodContextMultiLineStatus();
521 * @brief Retrieve the current cursor position.
523 * @return The cursor position.
525 CharacterIndex GetLogicalCursorPosition() const;
528 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
530 * @param[in] index The character index from where to count the number of consecutive white spaces.
532 * @return The number of consecutive white spaces.
534 Length GetNumberOfWhiteSpaces(CharacterIndex index) const;
537 * @brief Retrieve any text previously set.
539 * @param[out] text A string of UTF-8 characters.
541 void GetText(std::string& text) const;
544 * @brief Retrieve any text previously set starting from the given @p index.
546 * @param[in] index The character index from where to retrieve the text.
547 * @param[out] text A string of UTF-8 characters.
549 * @see Dali::Toolkit::Text::Controller::GetText()
551 void GetText(CharacterIndex index, std::string& text) const;
553 bool IsClipboardEmpty()
555 bool result(mClipboard && mClipboard.NumberOfItems());
556 return !result; // If NumberOfItems greater than 0, return false
559 bool IsClipboardVisible()
561 bool result(mClipboard && mClipboard.IsVisible());
566 * @copydoc Controller::GetLayoutDirection()
568 Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
571 * @brief Checks text direction.
572 * @return The text direction.
574 Toolkit::DevelText::TextDirection::Type GetTextDirection();
577 * @brief Calculates the start character index of the first paragraph to be updated and
578 * the end character index of the last paragraph to be updated.
580 * @param[out] numberOfCharacters The number of characters to be updated.
582 void CalculateTextUpdateIndices(Length& numberOfCharacters);
585 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
587 * @note It never clears the text stored in utf32.
589 * @param[in] startIndex Index to the first character to be cleared.
590 * @param[in] endIndex Index to the last character to be cleared.
591 * @param[in] operations The operations required.
593 void ClearModelData(CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations);
596 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
598 * When text or style changes the model is set with some operations pending.
599 * When i.e. the text's size or a relayout is required this method is called
600 * with a given @p operationsRequired parameter. The operations required are
601 * matched with the operations pending to perform the minimum number of operations.
603 * @param[in] operationsRequired The operations required.
605 * @return @e true if the model has been modified.
607 bool UpdateModel(OperationsMask operationsRequired);
610 * @brief Retreieves the default style.
612 * @param[out] inputStyle The default style.
614 void RetrieveDefaultInputStyle(InputStyle& inputStyle);
617 * @brief Retrieve the line height of the default font.
619 float GetDefaultFontLineHeight();
622 * @copydoc Controller::SetDefaultLineSpacing
624 bool SetDefaultLineSpacing(float lineSpacing);
627 * @copydoc Controller::SetDefaultLineSize
629 bool SetDefaultLineSize(float lineSize);
632 * @copydoc Controller::SetRelativeLineSize
634 bool SetRelativeLineSize(float relativeLineSize);
637 * @copydoc Controller::GetRelativeLineSize
639 float GetRelativeLineSize();
642 * @copydoc Text::Controller::GetPrimaryCursorPosition()
644 CharacterIndex GetPrimaryCursorPosition() const;
647 * @copydoc Text::Controller::SetPrimaryCursorPosition()
649 bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
652 * @copydoc Text::SelectableControlInterface::GetSelectedText()
654 string GetSelectedText();
657 * @copydoc Text::EditableControlInterface::CopyText()
662 * @copydoc Text::EditableControlInterface::CutText()
667 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
669 void SetTextSelectionRange(const uint32_t* pStart, const uint32_t* pEndf);
672 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
674 Uint32Pair GetTextSelectionRange() const;
677 * @copydoc Text::EditableControlInterface::IsEditable()
679 bool IsEditable() const;
682 * @copydoc Text::EditableControlInterface::SetEditable()
684 void SetEditable(bool editable);
687 * @copydoc Controller::UpdateAfterFontChange
689 void UpdateAfterFontChange(const std::string& newDefaultFont);
692 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
694 * @param[out] selectedText The selected text encoded in utf8.
695 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
697 void RetrieveSelection(std::string& selectedText, bool deleteAfterRetrieval);
699 void SetSelection(int start, int end);
701 std::pair<int, int> GetSelectionIndexes() const;
703 void ShowClipboard();
705 void HideClipboard();
707 void SetClipboardHideEnable(bool enable);
709 bool CopyStringToClipboard(const std::string& source);
711 void SendSelectionToClipboard(bool deleteAfterSending);
713 void RequestGetTextFromClipboard();
715 void RepositionSelectionHandles();
716 void RepositionSelectionHandles(float visualX, float visualY, Controller::NoTextTap::Action action);
718 void SetPopupButtons();
720 void ChangeState(EventData::State newState);
723 * @brief Calculates the cursor's position for a given character index in the logical order.
725 * It retrieves as well the line's height and the cursor's height and
726 * if there is a valid alternative cursor, its position and height.
728 * @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.
729 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
731 void GetCursorPosition(CharacterIndex logical,
732 CursorInfo& cursorInfo);
735 * @brief Calculates the new cursor index.
737 * It takes into account that in some scripts multiple characters can form a glyph and all of them
738 * need to be jumped with one key event.
740 * @param[in] index The initial new index.
742 * @return The new cursor index.
744 CharacterIndex CalculateNewCursorIndex(CharacterIndex index) const;
747 * @brief Updates the cursor position.
749 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
750 * It sets the position of the secondary cursor if it's a valid one.
751 * Sets which cursors are active.
753 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
756 void UpdateCursorPosition(const CursorInfo& cursorInfo);
759 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
761 * @param[in] handleType One of the selection handles.
762 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
764 void UpdateSelectionHandle(HandleType handleType,
765 const CursorInfo& cursorInfo);
768 * @biref Clamps the horizontal scrolling to get the control always filled with text.
770 * @param[in] layoutSize The size of the laid out text.
772 void ClampHorizontalScroll(const Vector2& layoutSize);
775 * @biref Clamps the vertical scrolling to get the control always filled with text.
777 * @param[in] layoutSize The size of the laid out text.
779 void ClampVerticalScroll(const Vector2& layoutSize);
782 * @brief Scrolls the text to make a position visible.
784 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
786 * @param[in] position A position in text coords.
787 * @param[in] lineHeight The line height for the given position.
789 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
790 * or moving the selection handles.
792 void ScrollToMakePositionVisible(const Vector2& position, float lineHeight);
795 * @brief Scrolls the text to make the cursor visible.
797 * This method is called after deleting text.
799 void ScrollTextToMatchCursor(const CursorInfo& cursorInfo);
802 * @brief Scrolls the text to make primary cursor visible.
804 void ScrollTextToMatchCursor();
807 * @brief Create an actor that renders the text background color
809 * @return the created actor or an empty handle if no background color needs to be rendered.
811 Actor CreateBackgroundActor();
814 * @brief fill needed relayout parameters whenever a property is changed and a re-layout is needed for the entire text.
816 void RelayoutAllCharacters();
819 * @copydoc Controller::IsInputStyleChangedSignalsQueueEmpty
821 bool IsInputStyleChangedSignalsQueueEmpty();
824 * @copydoc Controller::ProcessInputStyleChangedSignals
826 void ProcessInputStyleChangedSignals();
829 * @copydoc Controller::ScrollBy()
831 void ScrollBy(Vector2 scroll);
834 * @copydoc Controller::GetHorizontalScrollPosition()
836 float GetHorizontalScrollPosition();
839 * @copydoc Controller::GetVerticalScrollPosition()
841 float GetVerticalScrollPosition();
844 * @copydoc Controller::SetAutoScrollEnabled()
846 void SetAutoScrollEnabled(bool enable);
849 * @copydoc Controller::SetEnableCursorBlink()
851 void SetEnableCursorBlink(bool enable);
854 * @copydoc Controller::SetMultiLineEnabled()
856 void SetMultiLineEnabled(bool enable);
859 * @copydoc Controller::SetHorizontalAlignment()
861 void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
864 * @copydoc Controller::SetVerticalAlignment()
866 void SetVerticalAlignment(VerticalAlignment::Type alignment);
869 * @copydoc Controller::SetLineWrapMode()
871 void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
874 * @copydoc Controller::SetDefaultColor()
876 void SetDefaultColor(const Vector4& color);
879 * @copydoc Controller::SetUserInteractionEnabled()
881 void SetUserInteractionEnabled(bool enabled);
884 * @brief Helper to clear font-specific data (only).
886 void ClearFontData();
889 * @brief Helper to clear text's style data.
891 void ClearStyleData();
894 * @brief Used to reset the scroll position after setting a new text.
896 void ResetScrollPosition();
899 * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
901 * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
903 void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
906 * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
908 * @param[in] characterOffset A position in text coords.
910 * @return the 0-based index in anchor vector (-1 if an anchor not found)
912 int32_t GetAnchorIndex(size_t characterOffset) const;
915 * @brief Return the geometrical position of an anchor relative to the parent origin point.
917 * @param[in] anchor An anchor.
919 * @return The x, y, z coordinates of an anchor.
921 Vector3 GetAnchorPosition(Anchor anchor) const;
924 * @brief Return the size of an anchor expresed as a vector containing anchor's width and height.
926 * @param[in] anchor An anchor.
928 * @return The width and height of an anchor.
930 Vector2 GetAnchorSize(Anchor anchor) const;
933 * @brief Return the actor representing an anchor.
935 * @param[in] anchor An anchor.
937 * @return The actor representing an anchor.
939 Toolkit::TextAnchor CreateAnchorActor(Anchor anchor);
943 * @brief Gets implementation from the controller handle.
944 * @param controller The text controller
945 * @return The implementation of the Controller
947 static Impl& GetImplementation(Text::Controller& controller)
949 return *controller.mImpl;
953 // Declared private and left undefined to avoid copies.
955 // Declared private and left undefined to avoid copies.
956 Impl& operator=(const Impl&);
959 * @brief Copy Underlined-Character-Runs from Logical-Model to Underlined-Glyph-Runs in Visual-Model
961 * @param shouldClearPreUnderlineRuns Whether should clear the existing Underlined-Glyph-Runs in Visual-Model
963 void CopyUnderlinedFromLogicalToVisualModels(bool shouldClearPreUnderlineRuns);
966 * @brief Copy strikethrough-Character-Runs from Logical-Model to strikethrough-Glyph-Runs in Visual-Model
969 void CopyStrikethroughFromLogicalToVisualModels();
972 * @brief Copy CharacterSpacing-Character-Runs from Logical-Model to CharacterSpacing-Glyph-Runs in Visual-Model
975 void CopyCharacterSpacingFromLogicalToVisualModels();
978 ControlInterface* mControlInterface; ///< Reference to the text controller.
979 EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
980 SelectableControlInterface* mSelectableControlInterface; ///< Reference to the selectable text controller.
981 AnchorControlInterface* mAnchorControlInterface; ///< Reference to the anchor controller.
982 ModelPtr mModel; ///< Pointer to the text's model.
983 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
984 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
985 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
986 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
987 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
988 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
989 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
990 Clipboard mClipboard; ///< Handle to the system clipboard
991 View mView; ///< The view interface to the rendering back-end.
992 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
993 Layout::Engine mLayoutEngine; ///< The layout engine.
994 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
995 Vector4 mTextColor; ///< The regular text color
996 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
997 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
998 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
999 HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode.
1000 std::unique_ptr<InputFilter> mInputFilter; ///< Avoid allocating this when the user does not specify input filter mode.
1001 Vector2 mTextFitContentSize; ///< Size of Text fit content
1003 bool mRecalculateNaturalSize : 1; ///< Whether the natural size needs to be recalculated.
1004 bool mMarkupProcessorEnabled : 1; ///< Whether the mark-up procesor is enabled.
1005 bool mClipboardHideEnabled : 1; ///< Whether the ClipboardHide function work or not
1006 bool mIsAutoScrollEnabled : 1; ///< Whether auto text scrolling is enabled.
1007 bool mUpdateTextDirection : 1; ///< Whether the text direction needs to be updated.
1008 CharacterDirection mIsTextDirectionRTL : 1; ///< Whether the text direction is right to left or not
1010 bool mUnderlineSetByString : 1; ///< Set when underline is set by string (legacy) instead of map
1011 bool mShadowSetByString : 1; ///< Set when shadow is set by string (legacy) instead of map
1012 bool mOutlineSetByString : 1; ///< Set when outline is set by string (legacy) instead of map
1013 bool mFontStyleSetByString : 1; ///< Set when font style is set by string (legacy) instead of map
1014 bool mStrikethroughSetByString : 1; ///< Set when strikethrough is set by string (legacy) instead of map
1015 bool mShouldClearFocusOnEscape : 1; ///< Whether text control should clear key input focus
1016 LayoutDirection::Type mLayoutDirection; ///< Current system language direction
1018 Shader mShaderBackground; ///< The shader for text background.
1020 float mTextFitMinSize; ///< Minimum Font Size for text fit. Default 10
1021 float mTextFitMaxSize; ///< Maximum Font Size for text fit. Default 100
1022 float mTextFitStepSize; ///< Step Size for font intervalse. Default 1
1023 float mFontSizeScale; ///< Scale value for Font Size. Default 1.0
1024 float mDisabledColorOpacity; ///< Color opacity when disabled.
1025 bool mFontSizeScaleEnabled : 1; ///< Whether the font size scale is enabled.
1026 bool mTextFitEnabled : 1; ///< Whether the text's fit is enabled.
1027 bool mTextFitChanged : 1; ///< Whether the text fit property has changed.
1028 bool mIsLayoutDirectionChanged : 1; ///< Whether the layout has changed.
1029 bool mIsUserInteractionEnabled : 1; ///< Whether the user interaction is enabled.
1032 friend ControllerImplEventHandler;
1033 friend ControllerImplModelUpdater;
1034 friend SelectionHandleController;
1039 } // namespace Toolkit
1043 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H