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