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