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