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;
45 //Forward declarations
48 struct ControllerImplEventHandler;
49 struct ControllerImplModelUpdater;
50 struct SelectionHandleController;
52 class SelectableControlInterface;
53 class AnchorControlInterface;
57 // Used to queue input events until DoRelayout()
65 LEFT_SELECTION_HANDLE_EVENT,
66 RIGHT_SELECTION_HANDLE_EVENT,
104 EDITING_WITH_GRAB_HANDLE,
105 EDITING_WITH_PASTE_POPUP,
107 SELECTION_HANDLE_PANNING,
111 EventData(DecoratorPtr decorator, InputMethodContext& inputMethodContext);
113 ~EventData() = default;
115 static bool IsEditingState(State stateToCheck)
117 return (stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP);
120 DecoratorPtr mDecorator; ///< Pointer to the decorator.
121 InputMethodContext mInputMethodContext; ///< The Input Method Framework Manager.
122 std::unique_ptr<FontDefaults> mPlaceholderFont; ///< The placeholder default font.
123 std::string mPlaceholderTextActive; ///< The text to display when the TextField is empty with key-input focus.
124 std::string mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
125 Vector4 mPlaceholderTextColor; ///< The in/active placeholder text color.
128 * This is used to delay handling events until after the model has been updated.
129 * The number of updates to the model is minimized to improve performance.
131 std::vector<Event> mEventQueue; ///< The queue of touch events etc.
133 Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
135 InputStyle mInputStyle; ///< The style to be set to the new inputed text.
137 State mPreviousState; ///< Stores the current state before it's updated with the new one.
138 State mState; ///< Selection mode, edit mode etc.
140 CharacterIndex mPrimaryCursorPosition; ///< Index into logical model for primary cursor.
141 CharacterIndex mLeftSelectionPosition; ///< Index into logical model for left selection handle.
142 CharacterIndex mRightSelectionPosition; ///< Index into logical model for right selection handle.
144 CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
145 Length mPreEditLength; ///< Used to remove the pre-edit text if necessary.
147 float mCursorHookPositionX; ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles.
149 Controller::NoTextTap::Action mDoubleTapAction; ///< Action to be done when there is a double tap on top of 'no text'
150 Controller::NoTextTap::Action mLongPressAction; ///< Action to be done when there is a long press on top of 'no text'
152 bool mIsShowingPlaceholderText : 1; ///< True if the place-holder text is being displayed.
153 bool mPreEditFlag : 1; ///< True if the model contains text in pre-edit state.
154 bool mDecoratorUpdated : 1; ///< True if the decorator was updated during event processing.
155 bool mCursorBlinkEnabled : 1; ///< True if cursor should blink when active.
156 bool mGrabHandleEnabled : 1; ///< True if grab handle is enabled.
157 bool mGrabHandlePopupEnabled : 1; ///< True if the grab handle popu-up should be shown.
158 bool mSelectionEnabled : 1; ///< True if selection handles, highlight etc. are enabled.
159 bool mUpdateCursorHookPosition : 1; ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
160 bool mUpdateCursorPosition : 1; ///< True if the visual position of the cursor must be recalculated.
161 bool mUpdateGrabHandlePosition : 1; ///< True if the visual position of the grab handle must be recalculated.
162 bool mUpdateLeftSelectionPosition : 1; ///< True if the visual position of the left selection handle must be recalculated.
163 bool mUpdateRightSelectionPosition : 1; ///< True if the visual position of the right selection handle must be recalculated.
164 bool mIsLeftHandleSelected : 1; ///< Whether is the left handle the one which is selected.
165 bool mIsRightHandleSelected : 1; ///< Whether is the right handle the one which is selected.
166 bool mUpdateHighlightBox : 1; ///< True if the text selection high light box must be updated.
167 bool mScrollAfterUpdatePosition : 1; ///< Whether to scroll after the cursor position is updated.
168 bool mScrollAfterDelete : 1; ///< Whether to scroll after delete characters.
169 bool mAllTextSelected : 1; ///< True if the selection handles are selecting all the text.
170 bool mUpdateInputStyle : 1; ///< Whether to update the input style after moving the cursor.
171 bool mPasswordInput : 1; ///< True if password input is enabled.
172 bool mCheckScrollAmount : 1; ///< Whether to check scrolled amount after updating the position
173 bool mIsPlaceholderPixelSize : 1; ///< True if the placeholder font size is set as pixel size.
174 bool mIsPlaceholderElideEnabled : 1; ///< True if the placeholder text's elide is enabled.
175 bool mPlaceholderEllipsisFlag : 1; ///< True if the text controller sets the placeholder ellipsis.
176 bool mShiftSelectionFlag : 1; ///< True if the text selection using Shift key is enabled.
177 bool mUpdateAlignment : 1; ///< True if the whole text needs to be full aligned..
178 bool mEditingEnabled : 1; ///< True if the editing is enabled, false otherwise.
185 TEXT_REPLACED, ///< The entire text was replaced
186 TEXT_INSERTED, ///< Insert characters at the current cursor position
187 TEXT_DELETED ///< Characters were deleted
196 : mFontDescription(),
197 mDefaultPointSize(0.f),
200 familyDefined(false),
201 weightDefined(false),
206 // Initially use the default platform font
207 TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
208 fontClient.GetDefaultPlatformFontDescription(mFontDescription);
211 FontId GetFontId(TextAbstraction::FontClient& fontClient, float fontPointSize)
215 const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>(fontPointSize * 64.f);
216 mFontId = fontClient.GetFontId(mFontDescription, pointSize);
222 TextAbstraction::FontDescription mFontDescription; ///< The default font's description.
223 float mDefaultPointSize; ///< The default font's point size.
224 float mFitPointSize; ///< The fit font's point size.
225 FontId mFontId; ///< The font's id of the default font.
226 bool familyDefined : 1; ///< Whether the default font's family name is defined.
227 bool weightDefined : 1; ///< Whether the default font's weight is defined.
228 bool widthDefined : 1; ///< Whether the default font's width is defined.
229 bool slantDefined : 1; ///< Whether the default font's slant is defined.
230 bool sizeDefined : 1; ///< Whether the default font's point size is defined.
234 * @brief Stores indices used to update the text.
235 * Stores the character index where the text is updated and the number of characters removed and added.
236 * Stores as well indices to the first and the last paragraphs to be updated.
238 struct TextUpdateInfo
241 : mCharacterIndex(0u),
242 mNumberOfCharactersToRemove(0u),
243 mNumberOfCharactersToAdd(0u),
244 mPreviousNumberOfCharacters(0u),
245 mParagraphCharacterIndex(0u),
246 mRequestedNumberOfCharacters(0u),
247 mStartGlyphIndex(0u),
249 mEstimatedNumberOfLines(0u),
251 mFullRelayoutNeeded(true),
252 mIsLastCharacterNewParagraph(false)
260 CharacterIndex mCharacterIndex; ///< Index to the first character to be updated.
261 Length mNumberOfCharactersToRemove; ///< The number of characters to be removed.
262 Length mNumberOfCharactersToAdd; ///< The number of characters to be added.
263 Length mPreviousNumberOfCharacters; ///< The number of characters before the text update.
265 CharacterIndex mParagraphCharacterIndex; ///< Index of the first character of the first paragraph to be updated.
266 Length mRequestedNumberOfCharacters; ///< The requested number of characters.
267 GlyphIndex mStartGlyphIndex;
268 LineIndex mStartLineIndex;
269 Length mEstimatedNumberOfLines; ///< The estimated number of lines. Used to avoid reallocations when layouting.
271 bool mClearAll : 1; ///< Whether the whole text is cleared. i.e. when the text is reset.
272 bool mFullRelayoutNeeded : 1; ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
273 bool mIsLastCharacterNewParagraph : 1; ///< Whether the last character is a new paragraph character.
277 // Clear all info except the mPreviousNumberOfCharacters member.
278 mCharacterIndex = static_cast<CharacterIndex>(-1);
279 mNumberOfCharactersToRemove = 0u;
280 mNumberOfCharactersToAdd = 0u;
281 mParagraphCharacterIndex = 0u;
282 mRequestedNumberOfCharacters = 0u;
283 mStartGlyphIndex = 0u;
284 mStartLineIndex = 0u;
285 mEstimatedNumberOfLines = 0u;
287 mFullRelayoutNeeded = false;
288 mIsLastCharacterNewParagraph = false;
292 struct UnderlineDefaults
294 std::string properties;
295 // TODO: complete with underline parameters.
298 struct ShadowDefaults
300 std::string properties;
301 // TODO: complete with shadow parameters.
304 struct EmbossDefaults
306 std::string properties;
307 // TODO: complete with emboss parameters.
310 struct OutlineDefaults
312 std::string properties;
313 // TODO: complete with outline parameters.
316 struct Controller::Impl
318 Impl(ControlInterface* controlInterface,
319 EditableControlInterface* editableControlInterface,
320 SelectableControlInterface* selectableControlInterface,
321 AnchorControlInterface* anchorControlInterface)
322 : mControlInterface(controlInterface),
323 mEditableControlInterface(editableControlInterface),
324 mSelectableControlInterface(selectableControlInterface),
325 mAnchorControlInterface(anchorControlInterface),
328 mUnderlineDefaults(NULL),
329 mShadowDefaults(NULL),
330 mEmbossDefaults(NULL),
331 mOutlineDefaults(NULL),
338 mTextColor(Color::BLACK),
340 mOperationsPending(NO_OPERATION),
341 mMaximumNumberOfCharacters(50u),
343 mInputFilter(nullptr),
344 mRecalculateNaturalSize(true),
345 mMarkupProcessorEnabled(false),
346 mClipboardHideEnabled(true),
347 mIsAutoScrollEnabled(false),
348 mUpdateTextDirection(true),
349 mIsTextDirectionRTL(false),
350 mUnderlineSetByString(false),
351 mShadowSetByString(false),
352 mOutlineSetByString(false),
353 mFontStyleSetByString(false),
354 mStrikethroughSetByString(false),
355 mShouldClearFocusOnEscape(true),
356 mLayoutDirection(LayoutDirection::LEFT_TO_RIGHT),
357 mTextFitMinSize(DEFAULT_TEXTFIT_MIN),
358 mTextFitMaxSize(DEFAULT_TEXTFIT_MAX),
359 mTextFitStepSize(DEFAULT_TEXTFIT_STEP),
360 mFontSizeScale(DEFAULT_FONT_SIZE_SCALE),
361 mFontSizeScaleEnabled(true),
362 mTextFitEnabled(false),
363 mTextFitChanged(false),
364 mIsLayoutDirectionChanged(false)
366 mModel = Model::New();
368 mFontClient = TextAbstraction::FontClient::Get();
369 mClipboard = Clipboard::Get();
371 mView.SetVisualModel(mModel->mVisualModel);
372 mView.SetLogicalModel(mModel->mLogicalModel);
374 // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
375 mMetrics = Metrics::New(mFontClient);
376 mLayoutEngine.SetMetrics(mMetrics);
378 // Set the text properties to default
379 mModel->mVisualModel->SetUnderlineEnabled(false);
380 mModel->mVisualModel->SetUnderlineHeight(0.0f);
382 Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
386 Property::Map config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
387 if(config["clearFocusOnEscape"].Get(temp))
389 mShouldClearFocusOnEscape = temp;
397 delete mFontDefaults;
398 delete mUnderlineDefaults;
399 delete mShadowDefaults;
400 delete mEmbossDefaults;
401 delete mOutlineDefaults;
405 // Text Controller Implementation.
408 * @copydoc Text::Controller::RequestRelayout()
410 void RequestRelayout();
413 * @brief Request a relayout using the ControlInterface.
415 void QueueModifyEvent(ModifyEvent::Type type)
417 if(ModifyEvent::TEXT_REPLACED == type)
419 // Cancel previously queued inserts etc.
420 mModifyEvents.Clear();
425 mModifyEvents.PushBack(event);
427 // The event will be processed during relayout
432 * @brief Helper to move the cursor, grab handle etc.
434 bool ProcessInputEvents();
437 * @brief Helper to check whether any place-holder text is available.
439 bool IsPlaceholderAvailable() const
441 return (mEventData &&
442 (!mEventData->mPlaceholderTextInactive.empty() ||
443 !mEventData->mPlaceholderTextActive.empty()));
446 bool IsShowingPlaceholderText() const
448 return (mEventData && mEventData->mIsShowingPlaceholderText);
452 * @brief Helper to check whether active place-holder text is available.
454 bool IsFocusedPlaceholderAvailable() const
456 return (mEventData && !mEventData->mPlaceholderTextActive.empty());
459 bool IsShowingRealText() const
461 return (!IsShowingPlaceholderText() &&
462 0u != mModel->mLogicalModel->mText.Count());
466 * @brief Called when placeholder-text is hidden
468 void PlaceholderCleared()
472 mEventData->mIsShowingPlaceholderText = false;
474 // Remove mPlaceholderTextColor
475 mModel->mVisualModel->SetTextColor(mTextColor);
479 void ClearPreEditFlag()
483 mEventData->mPreEditFlag = false;
484 mEventData->mPreEditStartPosition = 0;
485 mEventData->mPreEditLength = 0;
489 void ResetInputMethodContext()
493 // Reset incase we are in a pre-edit state.
494 if(mEventData->mInputMethodContext)
496 mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding )
503 float GetFontSizeScale()
505 return mFontSizeScaleEnabled ? mFontSizeScale : 1.0f;
509 * @brief Helper to notify InputMethodContext with surrounding text & cursor changes.
511 void NotifyInputMethodContext();
514 * @brief Helper to notify InputMethodContext with multi line status.
516 void NotifyInputMethodContextMultiLineStatus();
519 * @brief Retrieve the current cursor position.
521 * @return The cursor position.
523 CharacterIndex GetLogicalCursorPosition() const;
526 * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
528 * @param[in] index The character index from where to count the number of consecutive white spaces.
530 * @return The number of consecutive white spaces.
532 Length GetNumberOfWhiteSpaces(CharacterIndex index) const;
535 * @brief Retrieve any text previously set.
537 * @param[out] text A string of UTF-8 characters.
539 void GetText(std::string& text) const;
542 * @brief Retrieve any text previously set starting from the given @p index.
544 * @param[in] index The character index from where to retrieve the text.
545 * @param[out] text A string of UTF-8 characters.
547 * @see Dali::Toolkit::Text::Controller::GetText()
549 void GetText(CharacterIndex index, std::string& text) const;
551 bool IsClipboardEmpty()
553 bool result(mClipboard && mClipboard.NumberOfItems());
554 return !result; // If NumberOfItems greater than 0, return false
557 bool IsClipboardVisible()
559 bool result(mClipboard && mClipboard.IsVisible());
564 * @copydoc Controller::GetLayoutDirection()
566 Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
569 * @brief Checks text direction.
570 * @return The text direction.
572 Toolkit::DevelText::TextDirection::Type GetTextDirection();
575 * @brief Calculates the start character index of the first paragraph to be updated and
576 * the end character index of the last paragraph to be updated.
578 * @param[out] numberOfCharacters The number of characters to be updated.
580 void CalculateTextUpdateIndices(Length& numberOfCharacters);
583 * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
585 * @note It never clears the text stored in utf32.
587 * @param[in] startIndex Index to the first character to be cleared.
588 * @param[in] endIndex Index to the last character to be cleared.
589 * @param[in] operations The operations required.
591 void ClearModelData(CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations);
594 * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
596 * When text or style changes the model is set with some operations pending.
597 * When i.e. the text's size or a relayout is required this method is called
598 * with a given @p operationsRequired parameter. The operations required are
599 * matched with the operations pending to perform the minimum number of operations.
601 * @param[in] operationsRequired The operations required.
603 * @return @e true if the model has been modified.
605 bool UpdateModel(OperationsMask operationsRequired);
608 * @brief Retreieves the default style.
610 * @param[out] inputStyle The default style.
612 void RetrieveDefaultInputStyle(InputStyle& inputStyle);
615 * @brief Retrieve the line height of the default font.
617 float GetDefaultFontLineHeight();
620 * @copydoc Controller::SetDefaultLineSpacing
622 bool SetDefaultLineSpacing(float lineSpacing);
625 * @copydoc Controller::SetDefaultLineSize
627 bool SetDefaultLineSize(float lineSize);
630 * @copydoc Controller::SetRelativeLineSize
632 bool SetRelativeLineSize(float relativeLineSize);
635 * @copydoc Controller::GetRelativeLineSize
637 float GetRelativeLineSize();
640 * @copydoc Text::Controller::GetPrimaryCursorPosition()
642 CharacterIndex GetPrimaryCursorPosition() const;
645 * @copydoc Text::Controller::SetPrimaryCursorPosition()
647 bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
650 * @copydoc Text::SelectableControlInterface::GetSelectedText()
652 string GetSelectedText();
655 * @copydoc Text::EditableControlInterface::CopyText()
660 * @copydoc Text::EditableControlInterface::CutText()
665 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
667 void SetTextSelectionRange(const uint32_t* pStart, const uint32_t* pEndf);
670 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
672 Uint32Pair GetTextSelectionRange() const;
675 * @copydoc Text::EditableControlInterface::IsEditable()
677 bool IsEditable() const;
680 * @copydoc Text::EditableControlInterface::SetEditable()
682 void SetEditable(bool editable);
685 * @copydoc Controller::UpdateAfterFontChange
687 void UpdateAfterFontChange(const std::string& newDefaultFont);
690 * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
692 * @param[out] selectedText The selected text encoded in utf8.
693 * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
695 void RetrieveSelection(std::string& selectedText, bool deleteAfterRetrieval);
697 void SetSelection(int start, int end);
699 std::pair<int, int> GetSelectionIndexes() const;
701 void ShowClipboard();
703 void HideClipboard();
705 void SetClipboardHideEnable(bool enable);
707 bool CopyStringToClipboard(const std::string& source);
709 void SendSelectionToClipboard(bool deleteAfterSending);
711 void RequestGetTextFromClipboard();
713 void RepositionSelectionHandles();
714 void RepositionSelectionHandles(float visualX, float visualY, Controller::NoTextTap::Action action);
716 void SetPopupButtons();
718 void ChangeState(EventData::State newState);
721 * @brief Calculates the cursor's position for a given character index in the logical order.
723 * It retrieves as well the line's height and the cursor's height and
724 * if there is a valid alternative cursor, its position and height.
726 * @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.
727 * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
729 void GetCursorPosition(CharacterIndex logical,
730 CursorInfo& cursorInfo);
733 * @brief Calculates the new cursor index.
735 * It takes into account that in some scripts multiple characters can form a glyph and all of them
736 * need to be jumped with one key event.
738 * @param[in] index The initial new index.
740 * @return The new cursor index.
742 CharacterIndex CalculateNewCursorIndex(CharacterIndex index) const;
745 * @brief Updates the cursor position.
747 * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
748 * It sets the position of the secondary cursor if it's a valid one.
749 * Sets which cursors are active.
751 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
754 void UpdateCursorPosition(const CursorInfo& cursorInfo);
757 * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
759 * @param[in] handleType One of the selection handles.
760 * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
762 void UpdateSelectionHandle(HandleType handleType,
763 const CursorInfo& cursorInfo);
766 * @biref Clamps the horizontal scrolling to get the control always filled with text.
768 * @param[in] layoutSize The size of the laid out text.
770 void ClampHorizontalScroll(const Vector2& layoutSize);
773 * @biref Clamps the vertical scrolling to get the control always filled with text.
775 * @param[in] layoutSize The size of the laid out text.
777 void ClampVerticalScroll(const Vector2& layoutSize);
780 * @brief Scrolls the text to make a position visible.
782 * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
784 * @param[in] position A position in text coords.
785 * @param[in] lineHeight The line height for the given position.
787 * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
788 * or moving the selection handles.
790 void ScrollToMakePositionVisible(const Vector2& position, float lineHeight);
793 * @brief Scrolls the text to make the cursor visible.
795 * This method is called after deleting text.
797 void ScrollTextToMatchCursor(const CursorInfo& cursorInfo);
800 * @brief Scrolls the text to make primary cursor visible.
802 void ScrollTextToMatchCursor();
805 * @brief Create an actor that renders the text background color
807 * @return the created actor or an empty handle if no background color needs to be rendered.
809 Actor CreateBackgroundActor();
812 * @brief fill needed relayout parameters whenever a property is changed and a re-layout is needed for the entire text.
814 void RelayoutAllCharacters();
817 * @copydoc Controller::IsInputStyleChangedSignalsQueueEmpty
819 bool IsInputStyleChangedSignalsQueueEmpty();
822 * @copydoc Controller::ProcessInputStyleChangedSignals
824 void ProcessInputStyleChangedSignals();
827 * @copydoc Controller::ScrollBy()
829 void ScrollBy(Vector2 scroll);
832 * @copydoc Controller::GetHorizontalScrollPosition()
834 float GetHorizontalScrollPosition();
837 * @copydoc Controller::GetVerticalScrollPosition()
839 float GetVerticalScrollPosition();
842 * @copydoc Controller::SetAutoScrollEnabled()
844 void SetAutoScrollEnabled(bool enable);
847 * @copydoc Controller::SetEnableCursorBlink()
849 void SetEnableCursorBlink(bool enable);
852 * @copydoc Controller::SetMultiLineEnabled()
854 void SetMultiLineEnabled(bool enable);
857 * @copydoc Controller::SetHorizontalAlignment()
859 void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
862 * @copydoc Controller::SetVerticalAlignment()
864 void SetVerticalAlignment(VerticalAlignment::Type alignment);
867 * @copydoc Controller::SetLineWrapMode()
869 void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
872 * @copydoc Controller::SetDefaultColor()
874 void SetDefaultColor(const Vector4& color);
877 * @brief Helper to clear font-specific data (only).
879 void ClearFontData();
882 * @brief Helper to clear text's style data.
884 void ClearStyleData();
887 * @brief Used to reset the scroll position after setting a new text.
889 void ResetScrollPosition();
892 * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
894 * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
896 void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
899 * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
901 * @param[in] characterOffset A position in text coords.
903 * @return the 0-based index in anchor vector (-1 if an anchor not found)
905 int32_t GetAnchorIndex(size_t characterOffset) const;
908 * @brief Return the geometrical position of an anchor relative to the parent origin point.
910 * @param[in] anchor An anchor.
912 * @return The x, y, z coordinates of an anchor.
914 Vector3 GetAnchorPosition(Anchor anchor) const;
917 * @brief Return the size of an anchor expresed as a vector containing anchor's width and height.
919 * @param[in] anchor An anchor.
921 * @return The width and height of an anchor.
923 Vector2 GetAnchorSize(Anchor anchor) const;
926 * @brief Return the actor representing an anchor.
928 * @param[in] anchor An anchor.
930 * @return The actor representing an anchor.
932 Toolkit::TextAnchor CreateAnchorActor(Anchor anchor);
936 * @brief Gets implementation from the controller handle.
937 * @param controller The text controller
938 * @return The implementation of the Controller
940 static Impl& GetImplementation(Text::Controller& controller)
942 return *controller.mImpl;
946 // Declared private and left undefined to avoid copies.
948 // Declared private and left undefined to avoid copies.
949 Impl& operator=(const Impl&);
952 * @brief Copy Underlined-Character-Runs from Logical-Model to Underlined-Glyph-Runs in Visual-Model
954 * @param shouldClearPreUnderlineRuns Whether should clear the existing Underlined-Glyph-Runs in Visual-Model
956 void CopyUnderlinedFromLogicalToVisualModels(bool shouldClearPreUnderlineRuns);
959 * @brief Copy strikethrough-Character-Runs from Logical-Model to strikethrough-Glyph-Runs in Visual-Model
962 void CopyStrikethroughFromLogicalToVisualModels();
965 ControlInterface* mControlInterface; ///< Reference to the text controller.
966 EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
967 SelectableControlInterface* mSelectableControlInterface; ///< Reference to the selectable text controller.
968 AnchorControlInterface* mAnchorControlInterface; ///< Reference to the anchor controller.
969 ModelPtr mModel; ///< Pointer to the text's model.
970 FontDefaults* mFontDefaults; ///< Avoid allocating this when the user does not specify a font.
971 UnderlineDefaults* mUnderlineDefaults; ///< Avoid allocating this when the user does not specify underline parameters.
972 ShadowDefaults* mShadowDefaults; ///< Avoid allocating this when the user does not specify shadow parameters.
973 EmbossDefaults* mEmbossDefaults; ///< Avoid allocating this when the user does not specify emboss parameters.
974 OutlineDefaults* mOutlineDefaults; ///< Avoid allocating this when the user does not specify outline parameters.
975 EventData* mEventData; ///< Avoid allocating everything for text input until EnableTextInput().
976 TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
977 Clipboard mClipboard; ///< Handle to the system clipboard
978 View mView; ///< The view interface to the rendering back-end.
979 MetricsPtr mMetrics; ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
980 Layout::Engine mLayoutEngine; ///< The layout engine.
981 Vector<ModifyEvent> mModifyEvents; ///< Temporary stores the text set until the next relayout.
982 Vector4 mTextColor; ///< The regular text color
983 TextUpdateInfo mTextUpdateInfo; ///< Info of the characters updated.
984 OperationsMask mOperationsPending; ///< Operations pending to be done to layout the text.
985 Length mMaximumNumberOfCharacters; ///< Maximum number of characters that can be inserted.
986 HiddenText* mHiddenInput; ///< Avoid allocating this when the user does not specify hidden input mode.
987 std::unique_ptr<InputFilter> mInputFilter; ///< Avoid allocating this when the user does not specify input filter mode.
988 Vector2 mTextFitContentSize; ///< Size of Text fit content
990 bool mRecalculateNaturalSize : 1; ///< Whether the natural size needs to be recalculated.
991 bool mMarkupProcessorEnabled : 1; ///< Whether the mark-up procesor is enabled.
992 bool mClipboardHideEnabled : 1; ///< Whether the ClipboardHide function work or not
993 bool mIsAutoScrollEnabled : 1; ///< Whether auto text scrolling is enabled.
994 bool mUpdateTextDirection : 1; ///< Whether the text direction needs to be updated.
995 CharacterDirection mIsTextDirectionRTL : 1; ///< Whether the text direction is right to left or not
997 bool mUnderlineSetByString : 1; ///< Set when underline is set by string (legacy) instead of map
998 bool mShadowSetByString : 1; ///< Set when shadow is set by string (legacy) instead of map
999 bool mOutlineSetByString : 1; ///< Set when outline is set by string (legacy) instead of map
1000 bool mFontStyleSetByString : 1; ///< Set when font style is set by string (legacy) instead of map
1001 bool mStrikethroughSetByString : 1; ///< Set when strikethrough is set by string (legacy) instead of map
1002 bool mShouldClearFocusOnEscape : 1; ///< Whether text control should clear key input focus
1003 LayoutDirection::Type mLayoutDirection; ///< Current system language direction
1005 Shader mShaderBackground; ///< The shader for text background.
1007 float mTextFitMinSize; ///< Minimum Font Size for text fit. Default 10
1008 float mTextFitMaxSize; ///< Maximum Font Size for text fit. Default 100
1009 float mTextFitStepSize; ///< Step Size for font intervalse. Default 1
1010 float mFontSizeScale; ///< Scale value for Font Size. Default 1.0
1011 bool mFontSizeScaleEnabled : 1; ///< Whether the font size scale is enabled.
1012 bool mTextFitEnabled : 1; ///< Whether the text's fit is enabled.
1013 bool mTextFitChanged : 1; ///< Whether the text fit property has changed.
1014 bool mIsLayoutDirectionChanged : 1; ///< Whether the layout has changed.
1017 friend ControllerImplEventHandler;
1018 friend ControllerImplModelUpdater;
1019 friend SelectionHandleController;
1024 } // namespace Toolkit
1028 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H