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/text-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 && TextClipboard::IsAvailable())
 375     {
 376       mClipboard = TextClipboard::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 = TextClipboard::Get();
 571     }
 572
 573     return mClipboard != nullptr ? true : false;
 574   }
 575
 576   bool IsClipboardEmpty()
 577   {
 578     bool result(TextClipboard::IsAvailable() && EnsureClipboardCreated() && mClipboard.NumberOfItems());
 579     return !result; // If NumberOfItems greater than 0, return false
 580   }
 581
 582   bool IsClipboardVisible()
 583   {
 584     bool result(TextClipboard::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 RequestGetTextFromClipboard();
 737
 738   void RepositionSelectionHandles();
 739   void RepositionSelectionHandles(float visualX, float visualY, Controller::NoTextTap::Action action);
 740
 741   void SetPopupButtons();
 742
 743   void ChangeState(EventData::State newState);
 744
 745   /**
 746    * @brief Calculates the cursor's position for a given character index in the logical order.
 747    *
 748    * It retrieves as well the line's height and the cursor's height and
 749    * if there is a valid alternative cursor, its position and height.
 750    *
 751    * @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.
 752    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 753    */
 754   void GetCursorPosition(CharacterIndex logical,
 755                          CursorInfo&    cursorInfo);
 756
 757   /**
 758    * @brief Calculates the new cursor index.
 759    *
 760    * It takes into account that in some scripts multiple characters can form a glyph and all of them
 761    * need to be jumped with one key event.
 762    *
 763    * @param[in] index The initial new index.
 764    *
 765    * @return The new cursor index.
 766    */
 767   CharacterIndex CalculateNewCursorIndex(CharacterIndex index) const;
 768
 769   /**
 770    * @brief Updates the cursor position.
 771    *
 772    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
 773    * It sets the position of the secondary cursor if it's a valid one.
 774    * Sets which cursors are active.
 775    *
 776    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 777    *
 778    */
 779   void UpdateCursorPosition(const CursorInfo& cursorInfo);
 780
 781   /**
 782    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
 783    *
 784    * @param[in] handleType One of the selection handles.
 785    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 786    */
 787   void UpdateSelectionHandle(HandleType        handleType,
 788                              const CursorInfo& cursorInfo);
 789
 790   /**
 791    * @biref Clamps the horizontal scrolling to get the control always filled with text.
 792    *
 793    * @param[in] layoutSize The size of the laid out text.
 794    */
 795   void ClampHorizontalScroll(const Vector2& layoutSize);
 796
 797   /**
 798    * @biref Clamps the vertical scrolling to get the control always filled with text.
 799    *
 800    * @param[in] layoutSize The size of the laid out text.
 801    */
 802   void ClampVerticalScroll(const Vector2& layoutSize);
 803
 804   /**
 805    * @brief Scrolls the text to make a position visible.
 806    *
 807    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
 808    *
 809    * @param[in] position A position in text coords.
 810    * @param[in] lineHeight The line height for the given position.
 811    *
 812    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
 813    * or moving the selection handles.
 814    */
 815   void ScrollToMakePositionVisible(const Vector2& position, float lineHeight);
 816
 817   /**
 818    * @brief Scrolls the text to make the cursor visible.
 819    *
 820    * This method is called after deleting text.
 821    */
 822   void ScrollTextToMatchCursor(const CursorInfo& cursorInfo);
 823
 824   /**
 825    * @brief Scrolls the text to make primary cursor visible.
 826    */
 827   void ScrollTextToMatchCursor();
 828
 829   /**
 830    * @brief Create an actor that renders the text background color
 831    *
 832    * @return the created actor or an empty handle if no background color needs to be rendered.
 833    */
 834   Actor CreateBackgroundActor();
 835
 836   /**
 837    * @brief fill needed relayout parameters whenever a property is changed and a re-layout is needed for the entire text.
 838    */
 839   void RelayoutAllCharacters();
 840
 841   /**
 842    * @copydoc Controller::IsInputStyleChangedSignalsQueueEmpty
 843    */
 844   bool IsInputStyleChangedSignalsQueueEmpty();
 845
 846   /**
 847    * @copydoc Controller::ProcessInputStyleChangedSignals
 848    */
 849   void ProcessInputStyleChangedSignals();
 850
 851   /**
 852    * @copydoc Controller::ScrollBy()
 853    */
 854   void ScrollBy(Vector2 scroll);
 855
 856   /**
 857    * @copydoc Controller::IsScrollable()
 858    */
 859   bool IsScrollable(const Vector2& displacement);
 860
 861   /**
 862    * @copydoc Controller::GetHorizontalScrollPosition()
 863    */
 864   float GetHorizontalScrollPosition();
 865
 866   /**
 867    * @copydoc Controller::GetVerticalScrollPosition()
 868    */
 869   float GetVerticalScrollPosition();
 870
 871   /**
 872    * @copydoc Controller::SetAutoScrollEnabled()
 873    */
 874   void SetAutoScrollEnabled(bool enable);
 875
 876   /**
 877    * @copydoc Controller::SetEnableCursorBlink()
 878    */
 879   void SetEnableCursorBlink(bool enable);
 880
 881   /**
 882    * @copydoc Controller::SetMultiLineEnabled()
 883    */
 884   void SetMultiLineEnabled(bool enable);
 885
 886   /**
 887    * @copydoc Controller::SetHorizontalAlignment()
 888    */
 889   void SetHorizontalAlignment(HorizontalAlignment::Type alignment);
 890
 891   /**
 892    * @copydoc Controller::SetVerticalAlignment()
 893    */
 894   void SetVerticalAlignment(VerticalAlignment::Type alignment);
 895
 896   /**
 897    * @copydoc Controller::SetLineWrapMode()
 898    */
 899   void SetLineWrapMode(Text::LineWrap::Mode textWarpMode);
 900
 901   /**
 902    * @copydoc Controller::SetDefaultColor()
 903    */
 904   void SetDefaultColor(const Vector4& color);
 905
 906   /**
 907    * @copydoc Controller::SetUserInteractionEnabled()
 908    */
 909   void SetUserInteractionEnabled(bool enabled);
 910
 911   /**
 912    * @brief Helper to clear font-specific data (only).
 913    */
 914   void ClearFontData();
 915
 916   /**
 917    * @brief Helper to clear text's style data.
 918    */
 919   void ClearStyleData();
 920
 921   /**
 922    * @brief Used to reset the scroll position after setting a new text.
 923    */
 924   void ResetScrollPosition();
 925
 926   /**
 927    * @brief Resets a provided vector with actors that marks the position of anchors in markup enabled text
 928    *
 929    * @param[out] anchorActors the vector of actor (empty collection if no anchors available).
 930    */
 931   void GetAnchorActors(std::vector<Toolkit::TextAnchor>& anchorActors);
 932
 933   /**
 934    * @brief Return an index of first anchor in the anchor vector whose boundaries includes given character offset
 935    *
 936    * @param[in] characterOffset A position in text coords.
 937    *
 938    * @return the 0-based index in anchor vector (-1 if an anchor not found)
 939    */
 940   int32_t GetAnchorIndex(size_t characterOffset) const;
 941
 942   /**
 943    * @brief Return the geometrical position of an anchor relative to the parent origin point.
 944    *
 945    * @param[in] anchor An anchor.
 946    *
 947    * @return The x, y, z coordinates of an anchor.
 948    */
 949   Vector3 GetAnchorPosition(Anchor anchor) const;
 950
 951   /**
 952    * @brief Return the size of an anchor expresed as a vector containing anchor's width and height.
 953    *
 954    * @param[in] anchor An anchor.
 955    *
 956    * @return The width and height of an anchor.
 957    */
 958   Vector2 GetAnchorSize(Anchor anchor) const;
 959
 960   /**
 961    * @brief Return the actor representing an anchor.
 962    *
 963    * @param[in] anchor An anchor.
 964    *
 965    * @return The actor representing an anchor.
 966    */
 967   Toolkit::TextAnchor CreateAnchorActor(Anchor anchor);
 968
 969 public:
 970   /**
 971    * @brief Gets implementation from the controller handle.
 972    * @param controller The text controller
 973    * @return The implementation of the Controller
 974    */
 975   static Impl& GetImplementation(Text::Controller& controller)
 976   {
 977     return *controller.mImpl;
 978   }
 979
 980 private:
 981   // Declared private and left undefined to avoid copies.
 982   Impl(const Impl&);
 983   // Declared private and left undefined to avoid copies.
 984   Impl& operator=(const Impl&);
 985
 986   /**
 987    * @brief Copy Underlined-Character-Runs from Logical-Model to Underlined-Glyph-Runs in Visual-Model
 988    *
 989    * @param shouldClearPreUnderlineRuns Whether should clear the existing Underlined-Glyph-Runs in Visual-Model
 990    */
 991   void CopyUnderlinedFromLogicalToVisualModels(bool shouldClearPreUnderlineRuns);
 992
 993   /**
 994    * @brief Copy strikethrough-Character-Runs from Logical-Model to strikethrough-Glyph-Runs in Visual-Model
 995    *
 996    */
 997   void CopyStrikethroughFromLogicalToVisualModels();
 998
 999   /**
1000    * @brief Copy CharacterSpacing-Character-Runs from Logical-Model to CharacterSpacing-Glyph-Runs in Visual-Model
1001    *
1002    */
1003   void CopyCharacterSpacingFromLogicalToVisualModels();
1004
1005 public:
1006   ControlInterface*            mControlInterface;           ///< Reference to the text controller.
1007   EditableControlInterface*    mEditableControlInterface;   ///< Reference to the editable text controller.
1008   SelectableControlInterface*  mSelectableControlInterface; ///< Reference to the selectable text controller.
1009   AnchorControlInterface*      mAnchorControlInterface;     ///< Reference to the anchor controller.
1010   ModelPtr                     mModel;                      ///< Pointer to the text's model.
1011   FontDefaults*                mFontDefaults;               ///< Avoid allocating this when the user does not specify a font.
1012   UnderlineDefaults*           mUnderlineDefaults;          ///< Avoid allocating this when the user does not specify underline parameters.
1013   ShadowDefaults*              mShadowDefaults;             ///< Avoid allocating this when the user does not specify shadow parameters.
1014   EmbossDefaults*              mEmbossDefaults;             ///< Avoid allocating this when the user does not specify emboss parameters.
1015   OutlineDefaults*             mOutlineDefaults;            ///< Avoid allocating this when the user does not specify outline parameters.
1016   EventData*                   mEventData;                  ///< Avoid allocating everything for text input until EnableTextInput().
1017   TextAbstraction::FontClient  mFontClient;                 ///< Handle to the font client.
1018   TextClipboard                mClipboard;                  ///< Handle to the system clipboard
1019   View                         mView;                       ///< The view interface to the rendering back-end.
1020   MetricsPtr                   mMetrics;                    ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
1021   Layout::Engine               mLayoutEngine;               ///< The layout engine.
1022   Vector<ModifyEvent>          mModifyEvents;               ///< Temporary stores the text set until the next relayout.
1023   Vector4                      mTextColor;                  ///< The regular text color
1024   TextUpdateInfo               mTextUpdateInfo;             ///< Info of the characters updated.
1025   OperationsMask               mOperationsPending;          ///< Operations pending to be done to layout the text.
1026   Length                       mMaximumNumberOfCharacters;  ///< Maximum number of characters that can be inserted.
1027   HiddenText*                  mHiddenInput;                ///< Avoid allocating this when the user does not specify hidden input mode.
1028   std::unique_ptr<InputFilter> mInputFilter;                ///< Avoid allocating this when the user does not specify input filter mode.
1029   Vector2                      mTextFitContentSize;         ///< Size of Text fit content
1030
1031   bool               mRecalculateNaturalSize : 1;         ///< Whether the natural size needs to be recalculated.
1032   bool               mMarkupProcessorEnabled : 1;         ///< Whether the mark-up procesor is enabled.
1033   bool               mClipboardHideEnabled : 1;           ///< Whether the ClipboardHide function work or not
1034   bool               mIsAutoScrollEnabled : 1;            ///< Whether auto text scrolling is enabled.
1035   bool               mIsAutoScrollMaxTextureExceeded : 1; ///< Whether auto text scrolling is exceed max texture size.
1036   bool               mUpdateTextDirection : 1;            ///< Whether the text direction needs to be updated.
1037   CharacterDirection mIsTextDirectionRTL : 1;             ///< Whether the text direction is right to left or not
1038
1039   bool                  mUnderlineSetByString : 1;     ///< Set when underline is set by string (legacy) instead of map
1040   bool                  mShadowSetByString : 1;        ///< Set when shadow is set by string (legacy) instead of map
1041   bool                  mOutlineSetByString : 1;       ///< Set when outline is set by string (legacy) instead of map
1042   bool                  mFontStyleSetByString : 1;     ///< Set when font style is set by string (legacy) instead of map
1043   bool                  mStrikethroughSetByString : 1; ///< Set when strikethrough is set by string (legacy) instead of map
1044   bool                  mShouldClearFocusOnEscape : 1; ///< Whether text control should clear key input focus
1045   LayoutDirection::Type mLayoutDirection;              ///< Current system language direction
1046
1047   Shader mShaderBackground; ///< The shader for text background.
1048
1049   float mTextFitMinSize;               ///< Minimum Font Size for text fit. Default 10
1050   float mTextFitMaxSize;               ///< Maximum Font Size for text fit. Default 100
1051   float mTextFitStepSize;              ///< Step Size for font intervalse. Default 1
1052   float mTextFitLineSize;              ///< This is the LineSize that is the standard when performing TextFit.
1053   float mFontSizeScale;                ///< Scale value for Font Size. Default 1.0
1054   float mDisabledColorOpacity;         ///< Color opacity when disabled.
1055   bool  mFontSizeScaleEnabled : 1;     ///< Whether the font size scale is enabled.
1056   bool  mTextFitEnabled : 1;           ///< Whether the text's fit is enabled.
1057   bool  mTextFitChanged : 1;           ///< Whether the text fit property has changed.
1058   bool  mIsLayoutDirectionChanged : 1; ///< Whether the layout has changed.
1059   bool  mIsUserInteractionEnabled : 1; ///< Whether the user interaction is enabled.
1060
1061 private:
1062   friend ControllerImplEventHandler;
1063   friend ControllerImplModelUpdater;
1064   friend SelectionHandleController;
1065 };
1066
1067 } // namespace Text
1068
1069 } // namespace Toolkit
1070
1071 } // namespace Dali
1072
1073 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H