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 mClipboard = Clipboard::Get();
375 mView.SetVisualModel(mModel->mVisualModel);
376 mView.SetLogicalModel(mModel->mLogicalModel);
378 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
379 mMetrics = Metrics::New(mFontClient);
380 mLayoutEngine.SetMetrics(mMetrics);
382 // Set the text properties to default
383 mModel->mVisualModel->SetUnderlineEnabled(false);
384 mModel->mVisualModel->SetUnderlineHeight(0.0f);
386 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
389 const Property::Map& config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
390 const auto clearFocusOnEscapeValue = config.Find("clearFocusOnEscape", Property::Type::BOOLEAN);
392 // Default is true. If config don't have "clearFocusOnEscape" property, make it true.
393 mShouldClearFocusOnEscape = (!clearFocusOnEscapeValue || clearFocusOnEscapeValue->Get<bool>());
400 delete mFontDefaults;
401 delete mUnderlineDefaults;
402 delete mShadowDefaults;
403 delete mEmbossDefaults;
404 delete mOutlineDefaults;
408 // Text Controller Implementation.
411 * @copydoc Text::Controller::RequestRelayout()
413 void RequestRelayout();
416 * @brief Request a relayout using the ControlInterface.
418 void QueueModifyEvent(ModifyEvent::Type type)
420 if(ModifyEvent::TEXT_REPLACED == type)
422 // Cancel previously queued inserts etc.
423 mModifyEvents.Clear();
428 mModifyEvents.PushBack(event);
430 // The event will be processed during relayout
435 * @brief Helper to move the cursor, grab handle etc.
437 bool ProcessInputEvents();
440 * @brief Helper to check whether any place-holder text is available.
442 bool IsPlaceholderAvailable() const
444 return (mEventData &&
445 (!mEventData->mPlaceholderTextInactive.empty() ||
446 !mEventData->mPlaceholderTextActive.empty()));
449 bool IsShowingPlaceholderText() const
451 return (mEventData && mEventData->mIsShowingPlaceholderText);
455 * @brief Helper to check whether active place-holder text is available.
457 bool IsFocusedPlaceholderAvailable() const
459 return (mEventData && !mEventData->mPlaceholderTextActive.empty());
462 bool IsShowingRealText() const
464 return (!IsShowingPlaceholderText() &&
465 0u != mModel->mLogicalModel->mText.Count());
469 * @brief Called when placeholder-text is hidden
471 void PlaceholderCleared()
475 mEventData->mIsShowingPlaceholderText = false;
477 // Remove mPlaceholderTextColor
478 mModel->mVisualModel->SetTextColor(mTextColor);
482 void ClearPreEditFlag()
486 mEventData->mPreEditFlag = false;
487 mEventData->mPreEditStartPosition = 0;
488 mEventData->mPreEditLength = 0;
492 void ResetInputMethodContext()
496 // Reset incase we are in a pre-edit state.
497 if(mEventData->mInputMethodContext)
499 mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding )
506 float GetFontSizeScale()
508 return mFontSizeScaleEnabled ? mFontSizeScale : 1.0f;
512 * @brief Helper to notify InputMethodContext with surrounding text & cursor changes.
514 void NotifyInputMethodContext();
517 * @brief Helper to notify InputMethodContext with multi line status.
519 void NotifyInputMethodContextMultiLineStatus();
522 * @brief Retrieve the current cursor position.
524 * @return The cursor position.
526 CharacterIndex GetLogicalCursorPosition() const;
529 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
531 * @param[in] index The character index from where to count the number of consecutive white spaces.
533 * @return The number of consecutive white spaces.
535 Length GetNumberOfWhiteSpaces(CharacterIndex index) const;
538 * @brief Retrieve any text previously set.
540 * @param[out] text A string of UTF-8 characters.
542 void GetText(std::string& text) const;
545 * @brief Retrieve any text previously set starting from the given @p index.
547 * @param[in] index The character index from where to retrieve the text.
548 * @param[out] text A string of UTF-8 characters.
550 * @see Dali::Toolkit::Text::Controller::GetText()
552 void GetText(CharacterIndex index, std::string& text) const;
554 bool IsClipboardEmpty()
556 bool result(mClipboard && mClipboard.NumberOfItems());
557 return !result; // If NumberOfItems greater than 0, return false
560 bool IsClipboardVisible()
562 bool result(mClipboard && mClipboard.IsVisible());
567 * @copydoc Controller::GetLayoutDirection()
569 Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
572 * @brief Checks text direction.
573 * @return The text direction.
575 Toolkit::DevelText::TextDirection::Type GetTextDirection();
578 * @brief Calculates the start character index of the first paragraph to be updated and
579 * the end character index of the last paragraph to be updated.
581 * @param[out] numberOfCharacters The number of characters to be updated.
583 void CalculateTextUpdateIndices(Length& numberOfCharacters);
586 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
588 * @note It never clears the text stored in utf32.
590 * @param[in] startIndex Index to the first character to be cleared.
591 * @param[in] endIndex Index to the last character to be cleared.
592 * @param[in] operations The operations required.
594 void ClearModelData(CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations);
597 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
599 * When text or style changes the model is set with some operations pending.
600 * When i.e. the text's size or a relayout is required this method is called
601 * with a given @p operationsRequired parameter. The operations required are
602 * matched with the operations pending to perform the minimum number of operations.
604 * @param[in] operationsRequired The operations required.
606 * @return @e true if the model has been modified.
608 bool UpdateModel(OperationsMask operationsRequired);
611 * @brief Retreieves the default style.
613 * @param[out] inputStyle The default style.
615 void RetrieveDefaultInputStyle(InputStyle& inputStyle);
618 * @brief Retrieve the line height of the default font.
620 float GetDefaultFontLineHeight();
623 * @copydoc Controller::SetDefaultLineSpacing
625 bool SetDefaultLineSpacing(float lineSpacing);
628 * @copydoc Controller::SetDefaultLineSize
630 bool SetDefaultLineSize(float lineSize);
633 * @copydoc Controller::SetRelativeLineSize
635 bool SetRelativeLineSize(float relativeLineSize);
638 * @copydoc Controller::GetRelativeLineSize
640 float GetRelativeLineSize();
643 * @copydoc Text::Controller::GetPrimaryCursorPosition()
645 CharacterIndex GetPrimaryCursorPosition() const;
648 * @copydoc Text::Controller::SetPrimaryCursorPosition()
650 bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
653 * @copydoc Text::SelectableControlInterface::GetSelectedText()
655 string GetSelectedText();
658 * @copydoc Text::EditableControlInterface::CopyText()
663 * @copydoc Text::EditableControlInterface::CutText()
668 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
670 void SetTextSelectionRange(const uint32_t* pStart, const uint32_t* pEndf);
673 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
675 Uint32Pair GetTextSelectionRange() const;
678 * @copydoc Text::EditableControlInterface::IsEditable()
680 bool IsEditable() const;
683 * @copydoc Text::EditableControlInterface::SetEditable()
685 void SetEditable(bool editable);
688 * @copydoc Controller::UpdateAfterFontChange
690 void UpdateAfterFontChange(const std::string& newDefaultFont);
693 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
695 * @param[out] selectedText The selected text encoded in utf8.
696 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
698 void RetrieveSelection(std::string& selectedText, bool deleteAfterRetrieval);
700 void SetSelection(int start, int end);
702 std::pair<int, int> GetSelectionIndexes() const;
704 void ShowClipboard();
706 void HideClipboard();
708 void SetClipboardHideEnable(bool enable);
710 bool CopyStringToClipboard(const std::string& source);
712 void SendSelectionToClipboard(bool deleteAfterSending);
714 void RequestGetTextFromClipboard();
716 void RepositionSelectionHandles();
717 void RepositionSelectionHandles(float visualX, float visualY, Controller::NoTextTap::Action action);
719 void SetPopupButtons();
721 void ChangeState(EventData::State newState);
724 * @brief Calculates the cursor's position for a given character index in the logical order.
726 * It retrieves as well the line's height and the cursor's height and
727 * if there is a valid alternative cursor, its position and height.
729 * @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.
730 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
732 void GetCursorPosition(CharacterIndex logical,
733 CursorInfo& cursorInfo);
736 * @brief Calculates the new cursor index.
738 * It takes into account that in some scripts multiple characters can form a glyph and all of them
739 * need to be jumped with one key event.
741 * @param[in] index The initial new index.
743 * @return The new cursor index.
745 CharacterIndex CalculateNewCursorIndex(CharacterIndex index) const;
748 * @brief Updates the cursor position.
750 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
751 * It sets the position of the secondary cursor if it's a valid one.
752 * Sets which cursors are active.
754 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
757 void UpdateCursorPosition(const CursorInfo& cursorInfo);
760 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
762 * @param[in] handleType One of the selection handles.
763 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
765 void UpdateSelectionHandle(HandleType handleType,
766 const CursorInfo& cursorInfo);
769 * @biref Clamps the horizontal scrolling to get the control always filled with text.
771 * @param[in] layoutSize The size of the laid out text.
773 void ClampHorizontalScroll(const Vector2& layoutSize);
776 * @biref Clamps the vertical scrolling to get the control always filled with text.
778 * @param[in] layoutSize The size of the laid out text.
780 void ClampVerticalScroll(const Vector2& layoutSize);
783 * @brief Scrolls the text to make a position visible.
785 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
787 * @param[in] position A position in text coords.
788 * @param[in] lineHeight The line height for the given position.
790 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
791 * or moving the selection handles.
793 void ScrollToMakePositionVisible(const Vector2& position, float lineHeight);
796 * @brief Scrolls the text to make the cursor visible.
798 * This method is called after deleting text.
800 void ScrollTextToMatchCursor(const CursorInfo& cursorInfo);
803 * @brief Scrolls the text to make primary cursor visible.
805 void ScrollTextToMatchCursor();
808 * @brief Create an actor that renders the text background color
810 * @return the created actor or an empty handle if no background color needs to be rendered.
812 Actor CreateBackgroundActor();
815 * @brief fill needed relayout parameters whenever a property is changed and a re-layout is needed for the entire text.
817 void RelayoutAllCharacters();
820 * @copydoc Controller::IsInputStyleChangedSignalsQueueEmpty
822 bool IsInputStyleChangedSignalsQueueEmpty();
825 * @copydoc Controller::ProcessInputStyleChangedSignals
827 void ProcessInputStyleChangedSignals();
830 * @copydoc Controller::ScrollBy()
832 void ScrollBy(Vector2 scroll);
835 * @copydoc Controller::IsScrollable()
837 bool IsScrollable(const Vector2& displacement);
840 * @copydoc Controller::GetHorizontalScrollPosition()
842 float GetHorizontalScrollPosition();
845 * @copydoc Controller::GetVerticalScrollPosition()
847 float GetVerticalScrollPosition();
850 * @copydoc Controller::SetAutoScrollEnabled()
852 void SetAutoScrollEnabled(bool enable);
855 * @copydoc Controller::SetEnableCursorBlink()
857 void SetEnableCursorBlink(bool enable);
860 * @copydoc Controller::SetMultiLineEnabled()
862 void SetMultiLineEnabled(bool enable);
865 * @copydoc Controller::SetHorizontalAlignment()
867 void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
870 * @copydoc Controller::SetVerticalAlignment()
872 void SetVerticalAlignment(VerticalAlignment::Type alignment);
875 * @copydoc Controller::SetLineWrapMode()
877 void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
880 * @copydoc Controller::SetDefaultColor()
882 void SetDefaultColor(const Vector4& color);
885 * @copydoc Controller::SetUserInteractionEnabled()
887 void SetUserInteractionEnabled(bool enabled);
890 * @brief Helper to clear font-specific data (only).
892 void ClearFontData();
895 * @brief Helper to clear text's style data.
897 void ClearStyleData();
900 * @brief Used to reset the scroll position after setting a new text.
902 void ResetScrollPosition();
905 * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
907 * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
909 void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
912 * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
914 * @param[in] characterOffset A position in text coords.
916 * @return the 0-based index in anchor vector (-1 if an anchor not found)
918 int32_t GetAnchorIndex(size_t characterOffset) const;
921 * @brief Return the geometrical position of an anchor relative to the parent origin point.
923 * @param[in] anchor An anchor.
925 * @return The x, y, z coordinates of an anchor.
927 Vector3 GetAnchorPosition(Anchor anchor) const;
930 * @brief Return the size of an anchor expresed as a vector containing anchor's width and height.
932 * @param[in] anchor An anchor.
934 * @return The width and height of an anchor.
936 Vector2 GetAnchorSize(Anchor anchor) const;
939 * @brief Return the actor representing an anchor.
941 * @param[in] anchor An anchor.
943 * @return The actor representing an anchor.
945 Toolkit::TextAnchor CreateAnchorActor(Anchor anchor);
949 * @brief Gets implementation from the controller handle.
950 * @param controller The text controller
951 * @return The implementation of the Controller
953 static Impl& GetImplementation(Text::Controller& controller)
955 return *controller.mImpl;
959 // Declared private and left undefined to avoid copies.
961 // Declared private and left undefined to avoid copies.
962 Impl& operator=(const Impl&);
965 * @brief Copy Underlined-Character-Runs from Logical-Model to Underlined-Glyph-Runs in Visual-Model
967 * @param shouldClearPreUnderlineRuns Whether should clear the existing Underlined-Glyph-Runs in Visual-Model
969 void CopyUnderlinedFromLogicalToVisualModels(bool shouldClearPreUnderlineRuns);
972 * @brief Copy strikethrough-Character-Runs from Logical-Model to strikethrough-Glyph-Runs in Visual-Model
975 void CopyStrikethroughFromLogicalToVisualModels();
978 * @brief Copy CharacterSpacing-Character-Runs from Logical-Model to CharacterSpacing-Glyph-Runs in Visual-Model
981 void CopyCharacterSpacingFromLogicalToVisualModels();
984 ControlInterface* mControlInterface; ///< Reference to the text controller.
985 EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
986 SelectableControlInterface* mSelectableControlInterface; ///< Reference to the selectable text controller.
987 AnchorControlInterface* mAnchorControlInterface; ///< Reference to the anchor controller.
988 ModelPtr mModel; ///< Pointer to the text's model.
989 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
990 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
991 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
992 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
993 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
994 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
995 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
996 Clipboard mClipboard; ///< Handle to the system clipboard
997 View mView; ///< The view interface to the rendering back-end.
998 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
999 Layout::Engine mLayoutEngine; ///< The layout engine.
1000 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
1001 Vector4 mTextColor; ///< The regular text color
1002 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
1003 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
1004 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
1005 HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode.
1006 std::unique_ptr<InputFilter> mInputFilter; ///< Avoid allocating this when the user does not specify input filter mode.
1007 Vector2 mTextFitContentSize; ///< Size of Text fit content
1009 bool mRecalculateNaturalSize : 1; ///< Whether the natural size needs to be recalculated.
1010 bool mMarkupProcessorEnabled : 1; ///< Whether the mark-up procesor is enabled.
1011 bool mClipboardHideEnabled : 1; ///< Whether the ClipboardHide function work or not
1012 bool mIsAutoScrollEnabled : 1; ///< Whether auto text scrolling is enabled.
1013 bool mIsAutoScrollMaxTextureExceeded : 1; ///< Whether auto text scrolling is exceed max texture size.
1014 bool mUpdateTextDirection : 1; ///< Whether the text direction needs to be updated.
1015 CharacterDirection mIsTextDirectionRTL : 1; ///< Whether the text direction is right to left or not
1017 bool mUnderlineSetByString : 1; ///< Set when underline is set by string (legacy) instead of map
1018 bool mShadowSetByString : 1; ///< Set when shadow is set by string (legacy) instead of map
1019 bool mOutlineSetByString : 1; ///< Set when outline is set by string (legacy) instead of map
1020 bool mFontStyleSetByString : 1; ///< Set when font style is set by string (legacy) instead of map
1021 bool mStrikethroughSetByString : 1; ///< Set when strikethrough is set by string (legacy) instead of map
1022 bool mShouldClearFocusOnEscape : 1; ///< Whether text control should clear key input focus
1023 LayoutDirection::Type mLayoutDirection; ///< Current system language direction
1025 Shader mShaderBackground; ///< The shader for text background.
1027 float mTextFitMinSize; ///< Minimum Font Size for text fit. Default 10
1028 float mTextFitMaxSize; ///< Maximum Font Size for text fit. Default 100
1029 float mTextFitStepSize; ///< Step Size for font intervalse. Default 1
1030 float mFontSizeScale; ///< Scale value for Font Size. Default 1.0
1031 float mDisabledColorOpacity; ///< Color opacity when disabled.
1032 bool mFontSizeScaleEnabled : 1; ///< Whether the font size scale is enabled.
1033 bool mTextFitEnabled : 1; ///< Whether the text's fit is enabled.
1034 bool mTextFitChanged : 1; ///< Whether the text fit property has changed.
1035 bool mIsLayoutDirectionChanged : 1; ///< Whether the layout has changed.
1036 bool mIsUserInteractionEnabled : 1; ///< Whether the user interaction is enabled.
1039 friend ControllerImplEventHandler;
1040 friend ControllerImplModelUpdater;
1041 friend SelectionHandleController;
1046 } // namespace Toolkit
1050 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H