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