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