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