Extending Style - Adding Strikethrough
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / text-controller-impl.h
1 #ifndef DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H
2 #define DALI_TOOLKIT_TEXT_CONTROLLER_IMPL_H
3
4 /*
5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
6  *
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
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
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.
18  *
19  */
20
21 // EXTERNAL INCLUDES
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>
25
26 // INTERNAL INCLUDES
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>
33
34 namespace Dali
35 {
36 namespace Toolkit
37 {
38 namespace Text
39 {
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
45 //Forward declarations
46 struct CursorInfo;
47 struct FontDefaults;
48 struct ControllerImplEventHandler;
49 struct ControllerImplModelUpdater;
50 struct SelectionHandleController;
51
52 class SelectableControlInterface;
53 class AnchorControlInterface;
54
55 struct Event
56 {
57   // Used to queue input events until DoRelayout()
58   enum Type
59   {
60     CURSOR_KEY_EVENT,
61     TAP_EVENT,
62     PAN_EVENT,
63     LONG_PRESS_EVENT,
64     GRAB_HANDLE_EVENT,
65     LEFT_SELECTION_HANDLE_EVENT,
66     RIGHT_SELECTION_HANDLE_EVENT,
67     SELECT,
68     SELECT_ALL,
69     SELECT_NONE,
70     SELECT_RANGE,
71   };
72
73   union Param
74   {
75     int          mInt;
76     unsigned int mUint;
77     float        mFloat;
78     bool         mBool;
79   };
80
81   Event(Type eventType)
82   : type(eventType)
83   {
84     p1.mInt = 0;
85     p2.mInt = 0;
86     p3.mInt = 0;
87   }
88
89   Type  type;
90   Param p1;
91   Param p2;
92   Param p3;
93 };
94
95 struct EventData
96 {
97   enum State
98   {
99     INACTIVE,
100     INTERRUPTED,
101     SELECTING,
102     EDITING,
103     EDITING_WITH_POPUP,
104     EDITING_WITH_GRAB_HANDLE,
105     EDITING_WITH_PASTE_POPUP,
106     GRAB_HANDLE_PANNING,
107     SELECTION_HANDLE_PANNING,
108     TEXT_PANNING
109   };
110
111   EventData(DecoratorPtr decorator, InputMethodContext& inputMethodContext);
112
113   ~EventData() = default;
114
115   static bool IsEditingState(State stateToCheck)
116   {
117     return (stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP);
118   }
119
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.
126
127   /**
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.
130    */
131   std::vector<Event> mEventQueue; ///< The queue of touch events etc.
132
133   Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
134
135   InputStyle mInputStyle; ///< The style to be set to the new inputed text.
136
137   State mPreviousState; ///< Stores the current state before it's updated with the new one.
138   State mState;         ///< Selection mode, edit mode etc.
139
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.
143
144   CharacterIndex mPreEditStartPosition; ///< Used to remove the pre-edit text if necessary.
145   Length         mPreEditLength;        ///< Used to remove the pre-edit text if necessary.
146
147   float mCursorHookPositionX; ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles.
148
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'
151
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.
179 };
180
181 struct ModifyEvent
182 {
183   enum Type
184   {
185     TEXT_REPLACED, ///< The entire text was replaced
186     TEXT_INSERTED, ///< Insert characters at the current cursor position
187     TEXT_DELETED   ///< Characters were deleted
188   };
189
190   Type type;
191 };
192
193 struct FontDefaults
194 {
195   FontDefaults()
196   : mFontDescription(),
197     mDefaultPointSize(0.f),
198     mFitPointSize(0.f),
199     mFontId(0u),
200     familyDefined(false),
201     weightDefined(false),
202     widthDefined(false),
203     slantDefined(false),
204     sizeDefined(false)
205   {
206     // Initially use the default platform font
207     TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
208     fontClient.GetDefaultPlatformFontDescription(mFontDescription);
209   }
210
211   FontId GetFontId(TextAbstraction::FontClient& fontClient, float fontPointSize)
212   {
213     if(!mFontId)
214     {
215       const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>(fontPointSize * 64.f);
216       mFontId                         = fontClient.GetFontId(mFontDescription, pointSize);
217     }
218
219     return mFontId;
220   }
221
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.
231 };
232
233 /**
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.
237  */
238 struct TextUpdateInfo
239 {
240   TextUpdateInfo()
241   : mCharacterIndex(0u),
242     mNumberOfCharactersToRemove(0u),
243     mNumberOfCharactersToAdd(0u),
244     mPreviousNumberOfCharacters(0u),
245     mParagraphCharacterIndex(0u),
246     mRequestedNumberOfCharacters(0u),
247     mStartGlyphIndex(0u),
248     mStartLineIndex(0u),
249     mEstimatedNumberOfLines(0u),
250     mClearAll(true),
251     mFullRelayoutNeeded(true),
252     mIsLastCharacterNewParagraph(false)
253   {
254   }
255
256   ~TextUpdateInfo()
257   {
258   }
259
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.
264
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.
270
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.
274
275   void Clear()
276   {
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;
286     mClearAll                    = false;
287     mFullRelayoutNeeded          = false;
288     mIsLastCharacterNewParagraph = false;
289   }
290 };
291
292 struct UnderlineDefaults
293 {
294   std::string properties;
295   // TODO: complete with underline parameters.
296 };
297
298 struct ShadowDefaults
299 {
300   std::string properties;
301   // TODO: complete with shadow parameters.
302 };
303
304 struct EmbossDefaults
305 {
306   std::string properties;
307   // TODO: complete with emboss parameters.
308 };
309
310 struct OutlineDefaults
311 {
312   std::string properties;
313   // TODO: complete with outline parameters.
314 };
315
316 struct Controller::Impl
317 {
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),
326     mModel(),
327     mFontDefaults(NULL),
328     mUnderlineDefaults(NULL),
329     mShadowDefaults(NULL),
330     mEmbossDefaults(NULL),
331     mOutlineDefaults(NULL),
332     mEventData(NULL),
333     mFontClient(),
334     mClipboard(),
335     mView(),
336     mMetrics(),
337     mModifyEvents(),
338     mTextColor(Color::BLACK),
339     mTextUpdateInfo(),
340     mOperationsPending(NO_OPERATION),
341     mMaximumNumberOfCharacters(50u),
342     mHiddenInput(NULL),
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     mShouldClearFocusOnEscape(true),
355     mLayoutDirection(LayoutDirection::LEFT_TO_RIGHT),
356     mTextFitMinSize(DEFAULT_TEXTFIT_MIN),
357     mTextFitMaxSize(DEFAULT_TEXTFIT_MAX),
358     mTextFitStepSize(DEFAULT_TEXTFIT_STEP),
359     mFontSizeScale(DEFAULT_FONT_SIZE_SCALE),
360     mTextFitEnabled(false),
361     mTextFitChanged(false),
362     mIsLayoutDirectionChanged(false)
363   {
364     mModel = Model::New();
365
366     mFontClient = TextAbstraction::FontClient::Get();
367     mClipboard  = Clipboard::Get();
368
369     mView.SetVisualModel(mModel->mVisualModel);
370
371     // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
372     mMetrics = Metrics::New(mFontClient);
373     mLayoutEngine.SetMetrics(mMetrics);
374
375     // Set the text properties to default
376     mModel->mVisualModel->SetUnderlineEnabled(false);
377     mModel->mVisualModel->SetUnderlineHeight(0.0f);
378
379     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
380     if(styleManager)
381     {
382       bool          temp;
383       Property::Map config = Toolkit::DevelStyleManager::GetConfigurations(styleManager);
384       if(config["clearFocusOnEscape"].Get(temp))
385       {
386         mShouldClearFocusOnEscape = temp;
387       }
388     }
389   }
390
391   ~Impl()
392   {
393     delete mHiddenInput;
394     delete mFontDefaults;
395     delete mUnderlineDefaults;
396     delete mShadowDefaults;
397     delete mEmbossDefaults;
398     delete mOutlineDefaults;
399     delete mEventData;
400   }
401
402   // Text Controller Implementation.
403
404   /**
405    * @copydoc Text::Controller::RequestRelayout()
406    */
407   void RequestRelayout();
408
409   /**
410    * @brief Request a relayout using the ControlInterface.
411    */
412   void QueueModifyEvent(ModifyEvent::Type type)
413   {
414     if(ModifyEvent::TEXT_REPLACED == type)
415     {
416       // Cancel previously queued inserts etc.
417       mModifyEvents.Clear();
418     }
419
420     ModifyEvent event;
421     event.type = type;
422     mModifyEvents.PushBack(event);
423
424     // The event will be processed during relayout
425     RequestRelayout();
426   }
427
428   /**
429    * @brief Helper to move the cursor, grab handle etc.
430    */
431   bool ProcessInputEvents();
432
433   /**
434    * @brief Helper to check whether any place-holder text is available.
435    */
436   bool IsPlaceholderAvailable() const
437   {
438     return (mEventData &&
439             (!mEventData->mPlaceholderTextInactive.empty() ||
440              !mEventData->mPlaceholderTextActive.empty()));
441   }
442
443   bool IsShowingPlaceholderText() const
444   {
445     return (mEventData && mEventData->mIsShowingPlaceholderText);
446   }
447
448   /**
449    * @brief Helper to check whether active place-holder text is available.
450    */
451   bool IsFocusedPlaceholderAvailable() const
452   {
453     return (mEventData && !mEventData->mPlaceholderTextActive.empty());
454   }
455
456   bool IsShowingRealText() const
457   {
458     return (!IsShowingPlaceholderText() &&
459             0u != mModel->mLogicalModel->mText.Count());
460   }
461
462   /**
463    * @brief Called when placeholder-text is hidden
464    */
465   void PlaceholderCleared()
466   {
467     if(mEventData)
468     {
469       mEventData->mIsShowingPlaceholderText = false;
470
471       // Remove mPlaceholderTextColor
472       mModel->mVisualModel->SetTextColor(mTextColor);
473     }
474   }
475
476   void ClearPreEditFlag()
477   {
478     if(mEventData)
479     {
480       mEventData->mPreEditFlag          = false;
481       mEventData->mPreEditStartPosition = 0;
482       mEventData->mPreEditLength        = 0;
483     }
484   }
485
486   void ResetInputMethodContext()
487   {
488     if(mEventData)
489     {
490       // Reset incase we are in a pre-edit state.
491       if(mEventData->mInputMethodContext)
492       {
493         mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding )
494       }
495
496       ClearPreEditFlag();
497     }
498   }
499
500   /**
501    * @brief Helper to notify InputMethodContext with surrounding text & cursor changes.
502    */
503   void NotifyInputMethodContext();
504
505   /**
506    * @brief Helper to notify InputMethodContext with multi line status.
507    */
508   void NotifyInputMethodContextMultiLineStatus();
509
510   /**
511    * @brief Retrieve the current cursor position.
512    *
513    * @return The cursor position.
514    */
515   CharacterIndex GetLogicalCursorPosition() const;
516
517   /**
518    * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
519    *
520    * @param[in] index The character index from where to count the number of consecutive white spaces.
521    *
522    * @return The number of consecutive white spaces.
523    */
524   Length GetNumberOfWhiteSpaces(CharacterIndex index) const;
525
526   /**
527    * @brief Retrieve any text previously set.
528    *
529    * @param[out] text A string of UTF-8 characters.
530    */
531   void GetText(std::string& text) const;
532
533   /**
534    * @brief Retrieve any text previously set starting from the given @p index.
535    *
536    * @param[in] index The character index from where to retrieve the text.
537    * @param[out] text A string of UTF-8 characters.
538    *
539    * @see Dali::Toolkit::Text::Controller::GetText()
540    */
541   void GetText(CharacterIndex index, std::string& text) const;
542
543   bool IsClipboardEmpty()
544   {
545     bool result(mClipboard && mClipboard.NumberOfItems());
546     return !result; // If NumberOfItems greater than 0, return false
547   }
548
549   bool IsClipboardVisible()
550   {
551     bool result(mClipboard && mClipboard.IsVisible());
552     return result;
553   }
554
555   /**
556    * @copydoc Controller::GetLayoutDirection()
557    */
558   Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
559
560   /**
561    * @brief Checks text direction.
562    * @return The text direction.
563    */
564   Toolkit::DevelText::TextDirection::Type GetTextDirection();
565
566   /**
567    * @brief Calculates the start character index of the first paragraph to be updated and
568    * the end character index of the last paragraph to be updated.
569    *
570    * @param[out] numberOfCharacters The number of characters to be updated.
571    */
572   void CalculateTextUpdateIndices(Length& numberOfCharacters);
573
574   /**
575    * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
576    *
577    * @note It never clears the text stored in utf32.
578    *
579    * @param[in] startIndex Index to the first character to be cleared.
580    * @param[in] endIndex Index to the last character to be cleared.
581    * @param[in] operations The operations required.
582    */
583   void ClearModelData(CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations);
584
585   /**
586    * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
587    *
588    * When text or style changes the model is set with some operations pending.
589    * When i.e. the text's size or a relayout is required this method is called
590    * with a given @p operationsRequired parameter. The operations required are
591    * matched with the operations pending to perform the minimum number of operations.
592    *
593    * @param[in] operationsRequired The operations required.
594    *
595    * @return @e true if the model has been modified.
596    */
597   bool UpdateModel(OperationsMask operationsRequired);
598
599   /**
600    * @brief Retreieves the default style.
601    *
602    * @param[out] inputStyle The default style.
603    */
604   void RetrieveDefaultInputStyle(InputStyle& inputStyle);
605
606   /**
607    * @brief Retrieve the line height of the default font.
608    */
609   float GetDefaultFontLineHeight();
610
611   /**
612    * @copydoc Controller::SetDefaultLineSpacing
613    */
614   bool SetDefaultLineSpacing(float lineSpacing);
615
616   /**
617    * @copydoc Controller::SetDefaultLineSize
618    */
619   bool SetDefaultLineSize(float lineSize);
620
621   /**
622    * @copydoc Text::Controller::GetPrimaryCursorPosition()
623    */
624   CharacterIndex GetPrimaryCursorPosition() const;
625
626   /**
627    * @copydoc Text::Controller::SetPrimaryCursorPosition()
628    */
629   bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
630
631   /**
632    * @copydoc Text::SelectableControlInterface::GetSelectedText()
633    */
634   string GetSelectedText();
635
636   /**
637    * @copydoc Text::EditableControlInterface::CopyText()
638    */
639   string CopyText();
640
641   /**
642    * @copydoc Text::EditableControlInterface::CutText()
643    */
644   string CutText();
645
646   /**
647    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
648    */
649   void SetTextSelectionRange(const uint32_t* pStart, const uint32_t* pEndf);
650
651   /**
652    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
653    */
654   Uint32Pair GetTextSelectionRange() const;
655
656   /**
657    * @copydoc Text::EditableControlInterface::IsEditable()
658    */
659   bool IsEditable() const;
660
661   /**
662    * @copydoc Text::EditableControlInterface::SetEditable()
663    */
664   void SetEditable(bool editable);
665
666   /**
667    * @copydoc Controller::UpdateAfterFontChange
668    */
669   void UpdateAfterFontChange(const std::string& newDefaultFont);
670
671   /**
672    * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
673    *
674    * @param[out] selectedText The selected text encoded in utf8.
675    * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
676    */
677   void RetrieveSelection(std::string& selectedText, bool deleteAfterRetrieval);
678
679   void SetSelection(int start, int end);
680
681   std::pair<int, int> GetSelectionIndexes() const;
682
683   void ShowClipboard();
684
685   void HideClipboard();
686
687   void SetClipboardHideEnable(bool enable);
688
689   bool CopyStringToClipboard(const std::string& source);
690
691   void SendSelectionToClipboard(bool deleteAfterSending);
692
693   void RequestGetTextFromClipboard();
694
695   void RepositionSelectionHandles();
696   void RepositionSelectionHandles(float visualX, float visualY, Controller::NoTextTap::Action action);
697
698   void SetPopupButtons();
699
700   void ChangeState(EventData::State newState);
701
702   /**
703    * @brief Calculates the cursor's position for a given character index in the logical order.
704    *
705    * It retrieves as well the line's height and the cursor's height and
706    * if there is a valid alternative cursor, its position and height.
707    *
708    * @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.
709    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
710    */
711   void GetCursorPosition(CharacterIndex logical,
712                          CursorInfo&    cursorInfo);
713
714   /**
715    * @brief Calculates the new cursor index.
716    *
717    * It takes into account that in some scripts multiple characters can form a glyph and all of them
718    * need to be jumped with one key event.
719    *
720    * @param[in] index The initial new index.
721    *
722    * @return The new cursor index.
723    */
724   CharacterIndex CalculateNewCursorIndex(CharacterIndex index) const;
725
726   /**
727    * @brief Updates the cursor position.
728    *
729    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
730    * It sets the position of the secondary cursor if it's a valid one.
731    * Sets which cursors are active.
732    *
733    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
734    *
735    */
736   void UpdateCursorPosition(const CursorInfo& cursorInfo);
737
738   /**
739    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
740    *
741    * @param[in] handleType One of the selection handles.
742    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
743    */
744   void UpdateSelectionHandle(HandleType        handleType,
745                              const CursorInfo& cursorInfo);
746
747   /**
748    * @biref Clamps the horizontal scrolling to get the control always filled with text.
749    *
750    * @param[in] layoutSize The size of the laid out text.
751    */
752   void ClampHorizontalScroll(const Vector2& layoutSize);
753
754   /**
755    * @biref Clamps the vertical scrolling to get the control always filled with text.
756    *
757    * @param[in] layoutSize The size of the laid out text.
758    */
759   void ClampVerticalScroll(const Vector2& layoutSize);
760
761   /**
762    * @brief Scrolls the text to make a position visible.
763    *
764    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
765    *
766    * @param[in] position A position in text coords.
767    * @param[in] lineHeight The line height for the given position.
768    *
769    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
770    * or moving the selection handles.
771    */
772   void ScrollToMakePositionVisible(const Vector2& position, float lineHeight);
773
774   /**
775    * @brief Scrolls the text to make the cursor visible.
776    *
777    * This method is called after deleting text.
778    */
779   void ScrollTextToMatchCursor(const CursorInfo& cursorInfo);
780
781   /**
782    * @brief Scrolls the text to make primary cursor visible.
783    */
784   void ScrollTextToMatchCursor();
785
786   /**
787    * @brief fill needed relayout parameters when line size is changed & request relayout.
788    */
789   void RelayoutForNewLineSize();
790
791   /**
792    * @copydoc Controller::IsInputStyleChangedSignalsQueueEmpty
793    */
794   bool IsInputStyleChangedSignalsQueueEmpty();
795
796   /**
797    * @copydoc Controller::ProcessInputStyleChangedSignals
798    */
799   void ProcessInputStyleChangedSignals();
800
801   /**
802    * @copydoc Controller::ScrollBy()
803    */
804   void ScrollBy(Vector2 scroll);
805
806   /**
807    * @copydoc Controller::GetHorizontalScrollPosition()
808    */
809   float GetHorizontalScrollPosition();
810
811   /**
812    * @copydoc Controller::GetVerticalScrollPosition()
813    */
814   float GetVerticalScrollPosition();
815
816   /**
817    * @copydoc Controller::SetAutoScrollEnabled()
818    */
819   void SetAutoScrollEnabled(bool enable);
820
821   /**
822    * @copydoc Controller::SetEnableCursorBlink()
823    */
824   void SetEnableCursorBlink(bool enable);
825
826   /**
827    * @copydoc Controller::SetMultiLineEnabled()
828    */
829   void SetMultiLineEnabled(bool enable);
830
831   /**
832    * @copydoc Controller::SetHorizontalAlignment()
833    */
834   void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
835
836   /**
837    * @copydoc Controller::SetVerticalAlignment()
838    */
839   void SetVerticalAlignment(VerticalAlignment::Type alignment);
840
841   /**
842    * @copydoc Controller::SetLineWrapMode()
843    */
844   void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
845
846   /**
847    * @copydoc Controller::SetDefaultColor()
848    */
849   void SetDefaultColor(const Vector4& color);
850
851   /**
852    * @brief Helper to clear font-specific data (only).
853    */
854   void ClearFontData();
855
856   /**
857    * @brief Helper to clear text's style data.
858    */
859   void ClearStyleData();
860
861   /**
862    * @brief Used to reset the scroll position after setting a new text.
863    */
864   void ResetScrollPosition();
865
866   /**
867    * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
868    *
869    * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
870    */
871   void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
872
873   /**
874    * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
875    *
876    * @param[in] characterOffset A position in text coords.
877    *
878    * @return the 0-based index in anchor vector (-1 if an anchor not found)
879    */
880   int32_t GetAnchorIndex(size_t characterOffset) const;
881
882   /**
883    * @brief Return the geometrical position of an anchor relative to the parent origin point.
884    *
885    * @param[in] anchor An anchor.
886    *
887    * @return The x, y, z coordinates of an anchor.
888    */
889   Vector3 GetAnchorPosition(Anchor anchor) const;
890
891   /**
892    * @brief Return the size of an anchor expresed as a vector containing anchor's width and height.
893    *
894    * @param[in] anchor An anchor.
895    *
896    * @return The width and height of an anchor.
897    */
898   Vector2 GetAnchorSize(Anchor anchor) const;
899
900   /**
901    * @brief Return the actor representing an anchor.
902    *
903    * @param[in] anchor An anchor.
904    *
905    * @return The actor representing an anchor.
906    */
907   Toolkit::TextAnchor CreateAnchorActor(Anchor anchor);
908
909 public:
910   /**
911    * @brief Gets implementation from the controller handle.
912    * @param controller The text controller
913    * @return The implementation of the Controller
914    */
915   static Impl& GetImplementation(Text::Controller& controller)
916   {
917     return *controller.mImpl;
918   }
919
920 private:
921   // Declared private and left undefined to avoid copies.
922   Impl(const Impl&);
923   // Declared private and left undefined to avoid copies.
924   Impl& operator=(const Impl&);
925
926   /**
927    * @brief Copy Underlined-Character-Runs from Logical-Model to Underlined-Glyph-Runs in Visual-Model
928    *
929    * @param shouldClearPreUnderlineRuns Whether should clear the existing Underlined-Glyph-Runs in Visual-Model
930    */
931   void CopyUnderlinedFromLogicalToVisualModels(bool shouldClearPreUnderlineRuns);
932
933 public:
934   ControlInterface*            mControlInterface;           ///< Reference to the text controller.
935   EditableControlInterface*    mEditableControlInterface;   ///< Reference to the editable text controller.
936   SelectableControlInterface*  mSelectableControlInterface; ///< Reference to the selectable text controller.
937   AnchorControlInterface*      mAnchorControlInterface;     ///< Reference to the anchor controller.
938   ModelPtr                     mModel;                      ///< Pointer to the text's model.
939   FontDefaults*                mFontDefaults;               ///< Avoid allocating this when the user does not specify a font.
940   UnderlineDefaults*           mUnderlineDefaults;          ///< Avoid allocating this when the user does not specify underline parameters.
941   ShadowDefaults*              mShadowDefaults;             ///< Avoid allocating this when the user does not specify shadow parameters.
942   EmbossDefaults*              mEmbossDefaults;             ///< Avoid allocating this when the user does not specify emboss parameters.
943   OutlineDefaults*             mOutlineDefaults;            ///< Avoid allocating this when the user does not specify outline parameters.
944   EventData*                   mEventData;                  ///< Avoid allocating everything for text input until EnableTextInput().
945   TextAbstraction::FontClient  mFontClient;                 ///< Handle to the font client.
946   Clipboard                    mClipboard;                  ///< Handle to the system clipboard
947   View                         mView;                       ///< The view interface to the rendering back-end.
948   MetricsPtr                   mMetrics;                    ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
949   Layout::Engine               mLayoutEngine;               ///< The layout engine.
950   Vector<ModifyEvent>          mModifyEvents;               ///< Temporary stores the text set until the next relayout.
951   Vector4                      mTextColor;                  ///< The regular text color
952   TextUpdateInfo               mTextUpdateInfo;             ///< Info of the characters updated.
953   OperationsMask               mOperationsPending;          ///< Operations pending to be done to layout the text.
954   Length                       mMaximumNumberOfCharacters;  ///< Maximum number of characters that can be inserted.
955   HiddenText*                  mHiddenInput;                ///< Avoid allocating this when the user does not specify hidden input mode.
956   std::unique_ptr<InputFilter> mInputFilter;                ///< Avoid allocating this when the user does not specify input filter mode.
957   Vector2                      mTextFitContentSize;         ///< Size of Text fit content
958
959   bool               mRecalculateNaturalSize : 1; ///< Whether the natural size needs to be recalculated.
960   bool               mMarkupProcessorEnabled : 1; ///< Whether the mark-up procesor is enabled.
961   bool               mClipboardHideEnabled : 1;   ///< Whether the ClipboardHide function work or not
962   bool               mIsAutoScrollEnabled : 1;    ///< Whether auto text scrolling is enabled.
963   bool               mUpdateTextDirection : 1;    ///< Whether the text direction needs to be updated.
964   CharacterDirection mIsTextDirectionRTL : 1;     ///< Whether the text direction is right to left or not
965
966   bool                  mUnderlineSetByString : 1;     ///< Set when underline is set by string (legacy) instead of map
967   bool                  mShadowSetByString : 1;        ///< Set when shadow is set by string (legacy) instead of map
968   bool                  mOutlineSetByString : 1;       ///< Set when outline is set by string (legacy) instead of map
969   bool                  mFontStyleSetByString : 1;     ///< Set when font style is set by string (legacy) instead of map
970   bool                  mStrikethroughSetByString : 1; ///< Set when strikethrough is set by string (legacy) instead of map
971   bool                  mShouldClearFocusOnEscape : 1; ///< Whether text control should clear key input focus
972   LayoutDirection::Type mLayoutDirection;              ///< Current system language direction
973
974   Shader mShaderBackground; ///< The shader for text background.
975
976   float mTextFitMinSize;               ///< Minimum Font Size for text fit. Default 10
977   float mTextFitMaxSize;               ///< Maximum Font Size for text fit. Default 100
978   float mTextFitStepSize;              ///< Step Size for font intervalse. Default 1
979   float mFontSizeScale;                ///< Scale value for Font Size. Default 1.0
980   bool  mTextFitEnabled : 1;           ///< Whether the text's fit is enabled.
981   bool  mTextFitChanged : 1;           ///< Whether the text fit property has changed.
982   bool  mIsLayoutDirectionChanged : 1; ///< Whether the layout has changed.
983
984 private:
985   friend ControllerImplEventHandler;
986   friend ControllerImplModelUpdater;
987   friend SelectionHandleController;
988 };
989
990 } // namespace Text
991
992 } // namespace Toolkit
993
994 } // namespace Dali
995
996 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H