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