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

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