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