dali-toolkit/internal/text/text-controller-impl.h

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