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/text-abstraction/font-client.h>
  23 #include <dali/public-api/rendering/shader.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
  27 #include <dali-toolkit/internal/text/controller/text-controller.h>
  28 #include <dali-toolkit/internal/text/input-style.h>
  29 #include <dali-toolkit/internal/text/text-model.h>
  30 #include <dali-toolkit/internal/text/text-view.h>
  31 #include <dali-toolkit/public-api/styling/style-manager.h>
  32
  33 namespace Dali
  34 {
  35 namespace Toolkit
  36 {
  37 namespace Text
  38 {
  39 const float DEFAULT_TEXTFIT_MIN            = 10.f;
  40 const float DEFAULT_TEXTFIT_MAX            = 100.f;
  41 const float DEFAULT_TEXTFIT_STEP           = 1.f;
  42 const float DEFAULT_FONT_SIZE_SCALE        = 1.f;
  43 const float DEFAULT_DISABLED_COLOR_OPACITY = 0.3f;
  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     mLastHeightForWidth(0.0f, 0.0f),
 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 auto clearFocusOnEscapeValue = Toolkit::DevelStyleManager::GetConfigurations(styleManager).Find("clearFocusOnEscape", Property::Type::BOOLEAN);
 394
 395       // Default is true. If config don't have "clearFocusOnEscape" property, make it true.
 396       mShouldClearFocusOnEscape = (!clearFocusOnEscapeValue || clearFocusOnEscapeValue->Get<bool>());
 397     }
 398   }
 399
 400   ~Impl()
 401   {
 402     delete mHiddenInput;
 403     delete mFontDefaults;
 404     delete mUnderlineDefaults;
 405     delete mShadowDefaults;
 406     delete mEmbossDefaults;
 407     delete mOutlineDefaults;
 408     delete mEventData;
 409   }
 410
 411   // Text Controller Implementation.
 412
 413   /**
 414    * @copydoc Text::Controller::RequestRelayout()
 415    */
 416   void RequestRelayout();
 417
 418   /**
 419    * @brief Request a relayout using the ControlInterface.
 420    */
 421   void QueueModifyEvent(ModifyEvent::Type type)
 422   {
 423     if(ModifyEvent::TEXT_REPLACED == type)
 424     {
 425       // Cancel previously queued inserts etc.
 426       mModifyEvents.Clear();
 427     }
 428
 429     ModifyEvent event;
 430     event.type = type;
 431     mModifyEvents.PushBack(event);
 432
 433     // The event will be processed during relayout
 434     RequestRelayout();
 435   }
 436
 437   /**
 438    * @brief Helper to move the cursor, grab handle etc.
 439    */
 440   bool ProcessInputEvents();
 441
 442   /**
 443    * @brief Helper to check whether any place-holder text is available.
 444    */
 445   bool IsPlaceholderAvailable() const
 446   {
 447     return (mEventData &&
 448             (!mEventData->mPlaceholderTextInactive.empty() ||
 449              !mEventData->mPlaceholderTextActive.empty()));
 450   }
 451
 452   bool IsShowingPlaceholderText() const
 453   {
 454     return (mEventData && mEventData->mIsShowingPlaceholderText);
 455   }
 456
 457   /**
 458    * @brief Helper to check whether active place-holder text is available.
 459    */
 460   bool IsFocusedPlaceholderAvailable() const
 461   {
 462     return (mEventData && !mEventData->mPlaceholderTextActive.empty());
 463   }
 464
 465   bool IsShowingRealText() const
 466   {
 467     return (!IsShowingPlaceholderText() &&
 468             0u != mModel->mLogicalModel->mText.Count());
 469   }
 470
 471   /**
 472    * @brief Called when placeholder-text is hidden
 473    */
 474   void PlaceholderCleared()
 475   {
 476     if(mEventData)
 477     {
 478       mEventData->mIsShowingPlaceholderText = false;
 479
 480       // Remove mPlaceholderTextColor
 481       mModel->mVisualModel->SetTextColor(mTextColor);
 482     }
 483   }
 484
 485   void ClearPreEditFlag()
 486   {
 487     if(mEventData)
 488     {
 489       mEventData->mPreEditFlag          = false;
 490       mEventData->mPreEditStartPosition = 0;
 491       mEventData->mPreEditLength        = 0;
 492     }
 493   }
 494
 495   void ResetInputMethodContext()
 496   {
 497     if(mEventData)
 498     {
 499       // Reset incase we are in a pre-edit state.
 500       if(mEventData->mInputMethodContext)
 501       {
 502         mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding )
 503       }
 504
 505       ClearPreEditFlag();
 506     }
 507   }
 508
 509   float GetFontSizeScale()
 510   {
 511     return mFontSizeScaleEnabled ? mFontSizeScale : 1.0f;
 512   }
 513
 514   /**
 515    * @brief Helper to notify InputMethodContext with surrounding text & cursor changes.
 516    */
 517   void NotifyInputMethodContext();
 518
 519   /**
 520    * @brief Helper to notify InputMethodContext with multi line status.
 521    */
 522   void NotifyInputMethodContextMultiLineStatus();
 523
 524   /**
 525    * @brief Retrieve the current cursor position.
 526    *
 527    * @return The cursor position.
 528    */
 529   CharacterIndex GetLogicalCursorPosition() const;
 530
 531   /**
 532    * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
 533    *
 534    * @param[in] index The character index from where to count the number of consecutive white spaces.
 535    *
 536    * @return The number of consecutive white spaces.
 537    */
 538   Length GetNumberOfWhiteSpaces(CharacterIndex index) const;
 539
 540   /**
 541    * @brief Retrieve any text previously set.
 542    *
 543    * @param[out] text A string of UTF-8 characters.
 544    */
 545   void GetText(std::string& text) const;
 546
 547   /**
 548    * @brief Retrieve any text previously set starting from the given @p index.
 549    *
 550    * @param[in] index The character index from where to retrieve the text.
 551    * @param[out] text A string of UTF-8 characters.
 552    *
 553    * @see Dali::Toolkit::Text::Controller::GetText()
 554    */
 555   void GetText(CharacterIndex index, std::string& text) const;
 556
 557   /**
 558    * @brief Retrieves number of characters previously set.
 559    *
 560    * @return A length of UTF-32 characters.
 561    *
 562    * @see Dali::Toolkit::Text::Controller::GetNumberOfCharacters()
 563    */
 564   Length GetNumberOfCharacters() const;
 565
 566   bool EnsureClipboardCreated()
 567   {
 568     if(!mClipboard)
 569     {
 570       mClipboard = Clipboard::Get();
 571     }
 572
 573     return mClipboard != nullptr ? true : false;
 574   }
 575
 576   bool IsClipboardEmpty()
 577   {
 578     bool result(Clipboard::IsAvailable() && EnsureClipboardCreated() && mClipboard.NumberOfItems());
 579     return !result; // If NumberOfItems greater than 0, return false
 580   }
 581
 582   bool IsClipboardVisible()
 583   {
 584     bool result(Clipboard::IsAvailable() && EnsureClipboardCreated() && mClipboard.IsVisible());
 585     return result;
 586   }
 587
 588   /**
 589    * @copydoc Controller::GetLayoutDirection()
 590    */
 591   Dali::LayoutDirection::Type GetLayoutDirection(Dali::Actor& actor) const;
 592
 593   /**
 594    * @brief Checks text direction.
 595    * @return The text direction.
 596    */
 597   Toolkit::DevelText::TextDirection::Type GetTextDirection();
 598
 599   /**
 600    * @brief Calculates the start character index of the first paragraph to be updated and
 601    * the end character index of the last paragraph to be updated.
 602    *
 603    * @param[out] numberOfCharacters The number of characters to be updated.
 604    */
 605   void CalculateTextUpdateIndices(Length& numberOfCharacters);
 606
 607   /**
 608    * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
 609    *
 610    * @note It never clears the text stored in utf32.
 611    *
 612    * @param[in] startIndex Index to the first character to be cleared.
 613    * @param[in] endIndex Index to the last character to be cleared.
 614    * @param[in] operations The operations required.
 615    */
 616   void ClearModelData(CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations);
 617
 618   /**
 619    * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
 620    *
 621    * When text or style changes the model is set with some operations pending.
 622    * When i.e. the text's size or a relayout is required this method is called
 623    * with a given @p operationsRequired parameter. The operations required are
 624    * matched with the operations pending to perform the minimum number of operations.
 625    *
 626    * @param[in] operationsRequired The operations required.
 627    *
 628    * @return @e true if the model has been modified.
 629    */
 630   bool UpdateModel(OperationsMask operationsRequired);
 631
 632   /**
 633    * @brief Retreieves the default style.
 634    *
 635    * @param[out] inputStyle The default style.
 636    */
 637   void RetrieveDefaultInputStyle(InputStyle& inputStyle);
 638
 639   /**
 640    * @brief Retrieve the line height of the default font.
 641    */
 642   float GetDefaultFontLineHeight();
 643
 644   /**
 645    * @copydoc Controller::SetDefaultLineSpacing
 646    */
 647   bool SetDefaultLineSpacing(float lineSpacing);
 648
 649   /**
 650    * @copydoc Controller::SetDefaultLineSize
 651    */
 652   bool SetDefaultLineSize(float lineSize);
 653
 654   /**
 655    * @copydoc Controller::SetRelativeLineSize
 656    */
 657   bool SetRelativeLineSize(float relativeLineSize);
 658
 659   /**
 660    * @copydoc Controller::GetRelativeLineSize
 661    */
 662   float GetRelativeLineSize();
 663
 664   /**
 665    * @copydoc Text::Controller::GetPrimaryCursorPosition()
 666    */
 667   CharacterIndex GetPrimaryCursorPosition() const;
 668
 669   /**
 670    * @copydoc Text::Controller::SetPrimaryCursorPosition()
 671    */
 672   bool SetPrimaryCursorPosition(CharacterIndex index, bool focused);
 673
 674   /**
 675    * @copydoc Text::SelectableControlInterface::GetSelectedText()
 676    */
 677   string GetSelectedText();
 678
 679   /**
 680    * @copydoc Text::EditableControlInterface::CopyText()
 681    */
 682   string CopyText();
 683
 684   /**
 685    * @copydoc Text::EditableControlInterface::CutText()
 686    */
 687   string CutText();
 688
 689   /**
 690    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
 691    */
 692   void SetTextSelectionRange(const uint32_t* pStart, const uint32_t* pEndf);
 693
 694   /**
 695    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
 696    */
 697   Uint32Pair GetTextSelectionRange() const;
 698
 699   /**
 700    * @copydoc Text::EditableControlInterface::IsEditable()
 701    */
 702   bool IsEditable() const;
 703
 704   /**
 705    * @copydoc Text::EditableControlInterface::SetEditable()
 706    */
 707   void SetEditable(bool editable);
 708
 709   /**
 710    * @copydoc Controller::UpdateAfterFontChange
 711    */
 712   void UpdateAfterFontChange(const std::string& newDefaultFont);
 713
 714   /**
 715    * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
 716    *
 717    * @param[out] selectedText The selected text encoded in utf8.
 718    * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
 719    */
 720   void RetrieveSelection(std::string& selectedText, bool deleteAfterRetrieval);
 721
 722   void SetSelection(int start, int end);
 723
 724   std::pair<int, int> GetSelectionIndexes() const;
 725
 726   void ShowClipboard();
 727
 728   void HideClipboard();
 729
 730   void SetClipboardHideEnable(bool enable);
 731
 732   bool CopyStringToClipboard(const std::string& source);
 733
 734   void SendSelectionToClipboard(bool deleteAfterSending);
 735
 736   void RepositionSelectionHandles();
 737   void RepositionSelectionHandles(float visualX, float visualY, Controller::NoTextTap::Action action);
 738
 739   void SetPopupButtons();
 740
 741   void ChangeState(EventData::State newState);
 742
 743   /**
 744    * @brief Calculates the cursor's position for a given character index in the logical order.
 745    *
 746    * It retrieves as well the line's height and the cursor's height and
 747    * if there is a valid alternative cursor, its position and height.
 748    *
 749    * @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.
 750    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 751    */
 752   void GetCursorPosition(CharacterIndex logical,
 753                          CursorInfo&    cursorInfo);
 754
 755   /**
 756    * @brief Calculates the new cursor index.
 757    *
 758    * It takes into account that in some scripts multiple characters can form a glyph and all of them
 759    * need to be jumped with one key event.
 760    *
 761    * @param[in] index The initial new index.
 762    *
 763    * @return The new cursor index.
 764    */
 765   CharacterIndex CalculateNewCursorIndex(CharacterIndex index) const;
 766
 767   /**
 768    * @brief Updates the cursor position.
 769    *
 770    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
 771    * It sets the position of the secondary cursor if it's a valid one.
 772    * Sets which cursors are active.
 773    *
 774    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 775    *
 776    */
 777   void UpdateCursorPosition(const CursorInfo& cursorInfo);
 778
 779   /**
 780    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
 781    *
 782    * @param[in] handleType One of the selection handles.
 783    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 784    */
 785   void UpdateSelectionHandle(HandleType        handleType,
 786                              const CursorInfo& cursorInfo);
 787
 788   /**
 789    * @biref Clamps the horizontal scrolling to get the control always filled with text.
 790    *
 791    * @param[in] layoutSize The size of the laid out text.
 792    */
 793   void ClampHorizontalScroll(const Vector2& layoutSize);
 794
 795   /**
 796    * @biref Clamps the vertical scrolling to get the control always filled with text.
 797    *
 798    * @param[in] layoutSize The size of the laid out text.
 799    */
 800   void ClampVerticalScroll(const Vector2& layoutSize);
 801
 802   /**
 803    * @brief Scrolls the text to make a position visible.
 804    *
 805    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
 806    *
 807    * @param[in] position A position in text coords.
 808    * @param[in] lineHeight The line height for the given position.
 809    *
 810    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
 811    * or moving the selection handles.
 812    */
 813   void ScrollToMakePositionVisible(const Vector2& position, float lineHeight);
 814
 815   /**
 816    * @brief Scrolls the text to make the cursor visible.
 817    *
 818    * This method is called after deleting text.
 819    */
 820   void ScrollTextToMatchCursor(const CursorInfo& cursorInfo);
 821
 822   /**
 823    * @brief Scrolls the text to make primary cursor visible.
 824    */
 825   void ScrollTextToMatchCursor();
 826
 827   /**
 828    * @brief Create an actor that renders the text background color
 829    *
 830    * @return the created actor or an empty handle if no background color needs to be rendered.
 831    */
 832   Actor CreateBackgroundActor();
 833
 834   /**
 835    * @brief fill needed relayout parameters whenever a property is changed and a re-layout is needed for the entire text.
 836    */
 837   void RelayoutAllCharacters();
 838
 839   /**
 840    * @copydoc Controller::IsInputStyleChangedSignalsQueueEmpty
 841    */
 842   bool IsInputStyleChangedSignalsQueueEmpty();
 843
 844   /**
 845    * @copydoc Controller::ProcessInputStyleChangedSignals
 846    */
 847   void ProcessInputStyleChangedSignals();
 848
 849   /**
 850    * @copydoc Controller::ScrollBy()
 851    */
 852   void ScrollBy(Vector2 scroll);
 853
 854   /**
 855    * @copydoc Controller::IsScrollable()
 856    */
 857   bool IsScrollable(const Vector2& displacement);
 858
 859   /**
 860    * @copydoc Controller::GetHorizontalScrollPosition()
 861    */
 862   float GetHorizontalScrollPosition();
 863
 864   /**
 865    * @copydoc Controller::GetVerticalScrollPosition()
 866    */
 867   float GetVerticalScrollPosition();
 868
 869   /**
 870    * @copydoc Controller::SetAutoScrollEnabled()
 871    */
 872   void SetAutoScrollEnabled(bool enable);
 873
 874   /**
 875    * @copydoc Controller::SetEnableCursorBlink()
 876    */
 877   void SetEnableCursorBlink(bool enable);
 878
 879   /**
 880    * @copydoc Controller::SetMultiLineEnabled()
 881    */
 882   void SetMultiLineEnabled(bool enable);
 883
 884   /**
 885    * @copydoc Controller::SetHorizontalAlignment()
 886    */
 887   void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
 888
 889   /**
 890    * @copydoc Controller::SetVerticalAlignment()
 891    */
 892   void SetVerticalAlignment(VerticalAlignment::Type alignment);
 893
 894   /**
 895    * @copydoc Controller::SetLineWrapMode()
 896    */
 897   void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
 898
 899   /**
 900    * @copydoc Controller::SetDefaultColor()
 901    */
 902   void SetDefaultColor(const Vector4& color);
 903
 904   /**
 905    * @copydoc Controller::SetUserInteractionEnabled()
 906    */
 907   void SetUserInteractionEnabled(bool enabled);
 908
 909   /**
 910    * @brief Helper to clear font-specific data (only).
 911    */
 912   void ClearFontData();
 913
 914   /**
 915    * @brief Helper to clear text's style data.
 916    */
 917   void ClearStyleData();
 918
 919   /**
 920    * @brief Used to reset the scroll position after setting a new text.
 921    */
 922   void ResetScrollPosition();
 923
 924   /**
 925    * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
 926    *
 927    * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
 928    */
 929   void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
 930
 931   /**
 932    * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
 933    *
 934    * @param[in] characterOffset A position in text coords.
 935    *
 936    * @return the 0-based index in anchor vector (-1 if an anchor not found)
 937    */
 938   int32_t GetAnchorIndex(size_t characterOffset) const;
 939
 940   /**
 941    * @brief Return the geometrical position of an anchor relative to the parent origin point.
 942    *
 943    * @param[in] anchor An anchor.
 944    *
 945    * @return The x, y, z coordinates of an anchor.
 946    */
 947   Vector3 GetAnchorPosition(Anchor anchor) const;
 948
 949   /**
 950    * @brief Return the size of an anchor expresed as a vector containing anchor's width and height.
 951    *
 952    * @param[in] anchor An anchor.
 953    *
 954    * @return The width and height of an anchor.
 955    */
 956   Vector2 GetAnchorSize(Anchor anchor) const;
 957
 958   /**
 959    * @brief Return the actor representing an anchor.
 960    *
 961    * @param[in] anchor An anchor.
 962    *
 963    * @return The actor representing an anchor.
 964    */
 965   Toolkit::TextAnchor CreateAnchorActor(Anchor anchor);
 966
 967 public:
 968   /**
 969    * @brief Gets implementation from the controller handle.
 970    * @param controller The text controller
 971    * @return The implementation of the Controller
 972    */
 973   static Impl& GetImplementation(Text::Controller& controller)
 974   {
 975     return *controller.mImpl;
 976   }
 977
 978 private:
 979   // Declared private and left undefined to avoid copies.
 980   Impl(const Impl&);
 981   // Declared private and left undefined to avoid copies.
 982   Impl& operator=(const Impl&);
 983
 984   /**
 985    * @brief Copy Underlined-Character-Runs from Logical-Model to Underlined-Glyph-Runs in Visual-Model
 986    *
 987    * @param shouldClearPreUnderlineRuns Whether should clear the existing Underlined-Glyph-Runs in Visual-Model
 988    */
 989   void CopyUnderlinedFromLogicalToVisualModels(bool shouldClearPreUnderlineRuns);
 990
 991   /**
 992    * @brief Copy strikethrough-Character-Runs from Logical-Model to strikethrough-Glyph-Runs in Visual-Model
 993    *
 994    */
 995   void CopyStrikethroughFromLogicalToVisualModels();
 996
 997   /**
 998    * @brief Copy CharacterSpacing-Character-Runs from Logical-Model to CharacterSpacing-Glyph-Runs in Visual-Model
 999    *
1000    */
1001   void CopyCharacterSpacingFromLogicalToVisualModels();
1002
1003 public:
1004   ControlInterface*            mControlInterface;           ///< Reference to the text controller.
1005   EditableControlInterface*    mEditableControlInterface;   ///< Reference to the editable text controller.
1006   SelectableControlInterface*  mSelectableControlInterface; ///< Reference to the selectable text controller.
1007   AnchorControlInterface*      mAnchorControlInterface;     ///< Reference to the anchor controller.
1008   ModelPtr                     mModel;                      ///< Pointer to the text's model.
1009   FontDefaults*                mFontDefaults;               ///< Avoid allocating this when the user does not specify a font.
1010   UnderlineDefaults*           mUnderlineDefaults;          ///< Avoid allocating this when the user does not specify underline parameters.
1011   ShadowDefaults*              mShadowDefaults;             ///< Avoid allocating this when the user does not specify shadow parameters.
1012   EmbossDefaults*              mEmbossDefaults;             ///< Avoid allocating this when the user does not specify emboss parameters.
1013   OutlineDefaults*             mOutlineDefaults;            ///< Avoid allocating this when the user does not specify outline parameters.
1014   EventData*                   mEventData;                  ///< Avoid allocating everything for text input until EnableTextInput().
1015   TextAbstraction::FontClient  mFontClient;                 ///< Handle to the font client.
1016   Clipboard                    mClipboard;                  ///< Handle to the system clipboard
1017   View                         mView;                       ///< The view interface to the rendering back-end.
1018   MetricsPtr                   mMetrics;                    ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
1019   Layout::Engine               mLayoutEngine;               ///< The layout engine.
1020   Vector<ModifyEvent>          mModifyEvents;               ///< Temporary stores the text set until the next relayout.
1021   Vector4                      mTextColor;                  ///< The regular text color
1022   TextUpdateInfo               mTextUpdateInfo;             ///< Info of the characters updated.
1023   OperationsMask               mOperationsPending;          ///< Operations pending to be done to layout the text.
1024   Length                       mMaximumNumberOfCharacters;  ///< Maximum number of characters that can be inserted.
1025   HiddenText*                  mHiddenInput;                ///< Avoid allocating this when the user does not specify hidden input mode.
1026   std::unique_ptr<InputFilter> mInputFilter;                ///< Avoid allocating this when the user does not specify input filter mode.
1027   Vector2                      mTextFitContentSize;         ///< Size of Text fit content
1028   Vector2                      mLastHeightForWidth;         ///< Size of Text content from GetHeightForWidth
1029
1030   bool               mRecalculateNaturalSize : 1;         ///< Whether the natural size needs to be recalculated.
1031   bool               mMarkupProcessorEnabled : 1;         ///< Whether the mark-up procesor is enabled.
1032   bool               mClipboardHideEnabled : 1;           ///< Whether the ClipboardHide function work or not
1033   bool               mIsAutoScrollEnabled : 1;            ///< Whether auto text scrolling is enabled.
1034   bool               mIsAutoScrollMaxTextureExceeded : 1; ///< Whether auto text scrolling is exceed max texture size.
1035   bool               mUpdateTextDirection : 1;            ///< Whether the text direction needs to be updated.
1036   CharacterDirection mIsTextDirectionRTL : 1;             ///< Whether the text direction is right to left or not
1037
1038   bool                  mUnderlineSetByString : 1;     ///< Set when underline is set by string (legacy) instead of map
1039   bool                  mShadowSetByString : 1;        ///< Set when shadow is set by string (legacy) instead of map
1040   bool                  mOutlineSetByString : 1;       ///< Set when outline is set by string (legacy) instead of map
1041   bool                  mFontStyleSetByString : 1;     ///< Set when font style is set by string (legacy) instead of map
1042   bool                  mStrikethroughSetByString : 1; ///< Set when strikethrough is set by string (legacy) instead of map
1043   bool                  mShouldClearFocusOnEscape : 1; ///< Whether text control should clear key input focus
1044   LayoutDirection::Type mLayoutDirection;              ///< Current system language direction
1045
1046   Shader mShaderBackground; ///< The shader for text background.
1047
1048   float mTextFitMinSize;               ///< Minimum Font Size for text fit. Default 10
1049   float mTextFitMaxSize;               ///< Maximum Font Size for text fit. Default 100
1050   float mTextFitStepSize;              ///< Step Size for font intervalse. Default 1
1051   float mTextFitLineSize;              ///< This is the LineSize that is the standard when performing TextFit.
1052   float mFontSizeScale;                ///< Scale value for Font Size. Default 1.0
1053   float mDisabledColorOpacity;         ///< Color opacity when disabled.
1054   bool  mFontSizeScaleEnabled : 1;     ///< Whether the font size scale is enabled.
1055   bool  mTextFitEnabled : 1;           ///< Whether the text's fit is enabled.
1056   bool  mTextFitChanged : 1;           ///< Whether the text fit property has changed.
1057   bool  mIsLayoutDirectionChanged : 1; ///< Whether the layout has changed.
1058   bool  mIsUserInteractionEnabled : 1; ///< Whether the user interaction is enabled.
1059
1060 private:
1061   friend ControllerImplEventHandler;
1062   friend ControllerImplModelUpdater;
1063   friend SelectionHandleController;
1064 };
1065
1066 } // namespace Text
1067
1068 } // namespace Toolkit
1069
1070 } // namespace Dali
1071
1072 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H