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

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