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) 2020 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/internal/text/input-style.h>
  28 #include <dali-toolkit/internal/text/text-controller.h>
  29 #include <dali-toolkit/internal/text/text-model.h>
  30 #include <dali-toolkit/internal/text/text-view.h>
  31 #include <dali-toolkit/public-api/styling/style-manager.h>
  32 #include <dali-toolkit/devel-api/styling/style-manager-devel.h>
  33
  34 namespace Dali
  35 {
  36
  37 namespace Toolkit
  38 {
  39
  40 namespace Text
  41 {
  42
  43 const float DEFAULT_TEXTFIT_MIN = 10.f;
  44 const float DEFAULT_TEXTFIT_MAX = 100.f;
  45 const float DEFAULT_TEXTFIT_STEP = 1.f;
  46 const float DEFAULT_FONT_SIZE_SCALE = 1.f;
  47
  48 //Forward declarations
  49 struct CursorInfo;
  50 struct FontDefaults;
  51 struct ControllerImplEventHandler;
  52 struct SelectionHandleController;
  53
  54 class SelectableControlInterface;
  55
  56 struct Event
  57 {
  58   // Used to queue input events until DoRelayout()
  59   enum Type
  60   {
  61     CURSOR_KEY_EVENT,
  62     TAP_EVENT,
  63     PAN_EVENT,
  64     LONG_PRESS_EVENT,
  65     GRAB_HANDLE_EVENT,
  66     LEFT_SELECTION_HANDLE_EVENT,
  67     RIGHT_SELECTION_HANDLE_EVENT,
  68     SELECT,
  69     SELECT_ALL,
  70     SELECT_NONE,
  71   };
  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   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   ~TextUpdateInfo()
 256   {}
 257
 258   CharacterIndex    mCharacterIndex;                ///< Index to the first character to be updated.
 259   Length            mNumberOfCharactersToRemove;    ///< The number of characters to be removed.
 260   Length            mNumberOfCharactersToAdd;       ///< The number of characters to be added.
 261   Length            mPreviousNumberOfCharacters;    ///< The number of characters before the text update.
 262
 263   CharacterIndex    mParagraphCharacterIndex;       ///< Index of the first character of the first paragraph to be updated.
 264   Length            mRequestedNumberOfCharacters;   ///< The requested number of characters.
 265   GlyphIndex        mStartGlyphIndex;
 266   LineIndex         mStartLineIndex;
 267   Length            mEstimatedNumberOfLines;         ///< The estimated number of lines. Used to avoid reallocations when layouting.
 268
 269   bool              mClearAll:1;                    ///< Whether the whole text is cleared. i.e. when the text is reset.
 270   bool              mFullRelayoutNeeded:1;          ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
 271   bool              mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
 272
 273   void Clear()
 274   {
 275     // Clear all info except the mPreviousNumberOfCharacters member.
 276     mCharacterIndex = static_cast<CharacterIndex>( -1 );
 277     mNumberOfCharactersToRemove = 0u;
 278     mNumberOfCharactersToAdd = 0u;
 279     mParagraphCharacterIndex = 0u;
 280     mRequestedNumberOfCharacters = 0u;
 281     mStartGlyphIndex = 0u;
 282     mStartLineIndex = 0u;
 283     mEstimatedNumberOfLines = 0u;
 284     mClearAll = false;
 285     mFullRelayoutNeeded = false;
 286     mIsLastCharacterNewParagraph = false;
 287   }
 288 };
 289
 290 struct UnderlineDefaults
 291 {
 292   std::string properties;
 293   // TODO: complete with underline parameters.
 294 };
 295
 296 struct ShadowDefaults
 297 {
 298   std::string properties;
 299   // TODO: complete with shadow parameters.
 300 };
 301
 302 struct EmbossDefaults
 303 {
 304   std::string properties;
 305   // TODO: complete with emboss parameters.
 306 };
 307
 308 struct OutlineDefaults
 309 {
 310   std::string properties;
 311   // TODO: complete with outline parameters.
 312 };
 313
 314 struct Controller::Impl
 315 {
 316   Impl( ControlInterface* controlInterface,
 317         EditableControlInterface* editableControlInterface,
 318         SelectableControlInterface* selectableControlInterface )
 319   : mControlInterface( controlInterface ),
 320     mEditableControlInterface( editableControlInterface ),
 321     mSelectableControlInterface( selectableControlInterface ),
 322     mModel(),
 323     mFontDefaults( NULL ),
 324     mUnderlineDefaults( NULL ),
 325     mShadowDefaults( NULL ),
 326     mEmbossDefaults( NULL ),
 327     mOutlineDefaults( NULL ),
 328     mEventData( NULL ),
 329     mFontClient(),
 330     mClipboard(),
 331     mView(),
 332     mMetrics(),
 333     mModifyEvents(),
 334     mTextColor( Color::BLACK ),
 335     mTextUpdateInfo(),
 336     mOperationsPending( NO_OPERATION ),
 337     mMaximumNumberOfCharacters( 50u ),
 338     mHiddenInput( NULL ),
 339     mRecalculateNaturalSize( true ),
 340     mMarkupProcessorEnabled( false ),
 341     mClipboardHideEnabled( true ),
 342     mIsAutoScrollEnabled( false ),
 343     mUpdateTextDirection( true ),
 344     mIsTextDirectionRTL( false ),
 345     mUnderlineSetByString( false ),
 346     mShadowSetByString( false ),
 347     mOutlineSetByString( false ),
 348     mFontStyleSetByString( false ),
 349     mShouldClearFocusOnEscape( true ),
 350     mLayoutDirection( LayoutDirection::LEFT_TO_RIGHT ),
 351     mTextFitMinSize( DEFAULT_TEXTFIT_MIN ),
 352     mTextFitMaxSize( DEFAULT_TEXTFIT_MAX ),
 353     mTextFitStepSize( DEFAULT_TEXTFIT_STEP ),
 354     mTextFitEnabled( false ),
 355     mFontSizeScale( DEFAULT_FONT_SIZE_SCALE )
 356   {
 357     mModel = Model::New();
 358
 359     mFontClient = TextAbstraction::FontClient::Get();
 360     mClipboard = Clipboard::Get();
 361
 362     mView.SetVisualModel( mModel->mVisualModel );
 363
 364     // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
 365     mMetrics = Metrics::New( mFontClient );
 366     mLayoutEngine.SetMetrics( mMetrics );
 367
 368     // Set the text properties to default
 369     mModel->mVisualModel->SetUnderlineEnabled( false );
 370     mModel->mVisualModel->SetUnderlineHeight( 0.0f );
 371
 372     Toolkit::StyleManager styleManager = Toolkit::StyleManager::Get();
 373     if( styleManager )
 374     {
 375       bool temp;
 376       Property::Map config = Toolkit::DevelStyleManager::GetConfigurations( styleManager );
 377       if( config["clearFocusOnEscape"].Get( temp ) )
 378       {
 379         mShouldClearFocusOnEscape = temp;
 380       }
 381     }
 382   }
 383
 384   ~Impl()
 385   {
 386     delete mHiddenInput;
 387
 388     delete mFontDefaults;
 389     delete mUnderlineDefaults;
 390     delete mShadowDefaults;
 391     delete mEmbossDefaults;
 392     delete mOutlineDefaults;
 393     delete mEventData;
 394   }
 395
 396   // Text Controller Implementation.
 397
 398   /**
 399    * @copydoc Text::Controller::RequestRelayout()
 400    */
 401   void RequestRelayout();
 402
 403   /**
 404    * @brief Request a relayout using the ControlInterface.
 405    */
 406   void QueueModifyEvent( ModifyEvent::Type type )
 407   {
 408     if( ModifyEvent::TEXT_REPLACED == type)
 409     {
 410       // Cancel previously queued inserts etc.
 411       mModifyEvents.Clear();
 412     }
 413
 414     ModifyEvent event;
 415     event.type = type;
 416     mModifyEvents.PushBack( event );
 417
 418     // The event will be processed during relayout
 419     RequestRelayout();
 420   }
 421
 422   /**
 423    * @brief Helper to move the cursor, grab handle etc.
 424    */
 425   bool ProcessInputEvents();
 426
 427   /**
 428    * @brief Helper to check whether any place-holder text is available.
 429    */
 430   bool IsPlaceholderAvailable() const
 431   {
 432     return ( mEventData &&
 433              ( !mEventData->mPlaceholderTextInactive.empty() ||
 434                !mEventData->mPlaceholderTextActive.empty() )
 435            );
 436   }
 437
 438   bool IsShowingPlaceholderText() const
 439   {
 440     return ( mEventData && mEventData->mIsShowingPlaceholderText );
 441   }
 442
 443   /**
 444    * @brief Helper to check whether active place-holder text is available.
 445    */
 446   bool IsFocusedPlaceholderAvailable() const
 447   {
 448     return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
 449   }
 450
 451   bool IsShowingRealText() const
 452   {
 453     return ( !IsShowingPlaceholderText() &&
 454              0u != mModel->mLogicalModel->mText.Count() );
 455   }
 456
 457   /**
 458    * @brief Called when placeholder-text is hidden
 459    */
 460   void PlaceholderCleared()
 461   {
 462     if( mEventData )
 463     {
 464       mEventData->mIsShowingPlaceholderText = false;
 465
 466       // Remove mPlaceholderTextColor
 467       mModel->mVisualModel->SetTextColor( mTextColor );
 468     }
 469   }
 470
 471   void ClearPreEditFlag()
 472   {
 473     if( mEventData )
 474     {
 475       mEventData->mPreEditFlag = false;
 476       mEventData->mPreEditStartPosition = 0;
 477       mEventData->mPreEditLength = 0;
 478     }
 479   }
 480
 481   void ResetInputMethodContext()
 482   {
 483     if( mEventData )
 484     {
 485       // Reset incase we are in a pre-edit state.
 486       if( mEventData->mInputMethodContext )
 487       {
 488         mEventData->mInputMethodContext.Reset(); // Will trigger a message ( commit, get surrounding )
 489       }
 490
 491       ClearPreEditFlag();
 492     }
 493   }
 494
 495   /**
 496    * @brief Helper to notify InputMethodContext with surrounding text & cursor changes.
 497    */
 498   void NotifyInputMethodContext();
 499
 500   /**
 501    * @brief Helper to notify InputMethodContext with multi line status.
 502    */
 503   void NotifyInputMethodContextMultiLineStatus();
 504
 505   /**
 506    * @brief Retrieve the current cursor position.
 507    *
 508    * @return The cursor position.
 509    */
 510   CharacterIndex GetLogicalCursorPosition() const;
 511
 512   /**
 513    * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
 514    *
 515    * @param[in] index The character index from where to count the number of consecutive white spaces.
 516    *
 517    * @return The number of consecutive white spaces.
 518    */
 519   Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
 520
 521   /**
 522    * @brief Retrieve any text previously set starting from the given @p index.
 523    *
 524    * @param[in] index The character index from where to retrieve the text.
 525    * @param[out] text A string of UTF-8 characters.
 526    *
 527    * @see Dali::Toolkit::Text::Controller::GetText()
 528    */
 529   void GetText( CharacterIndex index, std::string& text ) const;
 530
 531   bool IsClipboardEmpty()
 532   {
 533     bool result( mClipboard && mClipboard.NumberOfItems() );
 534     return !result; // If NumberOfItems greater than 0, return false
 535   }
 536
 537   bool IsClipboardVisible()
 538   {
 539     bool result( mClipboard && mClipboard.IsVisible() );
 540     return result;
 541   }
 542
 543   /**
 544    * @brief Calculates the start character index of the first paragraph to be updated and
 545    * the end character index of the last paragraph to be updated.
 546    *
 547    * @param[out] numberOfCharacters The number of characters to be updated.
 548    */
 549   void CalculateTextUpdateIndices( Length& numberOfCharacters );
 550
 551   /**
 552    * @brief Helper to clear completely the parts of the model specified by the given @p operations.
 553    *
 554    * @note It never clears the text stored in utf32.
 555    */
 556   void ClearFullModelData( OperationsMask operations );
 557
 558   /**
 559    * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
 560    *
 561    * @note It never clears the text stored in utf32.
 562    *
 563    * @param[in] startIndex Index to the first character to be cleared.
 564    * @param[in] endIndex Index to the last character to be cleared.
 565    * @param[in] operations The operations required.
 566    */
 567   void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 568
 569   /**
 570    * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
 571    *
 572    * @note It never clears the text stored in utf32.
 573    * @note Character indices are transformed to glyph indices.
 574    *
 575    * @param[in] startIndex Index to the first character to be cleared.
 576    * @param[in] endIndex Index to the last character to be cleared.
 577    * @param[in] operations The operations required.
 578    */
 579   void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 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 Text::Controller::GetPrimaryCursorPosition()
 620    */
 621   CharacterIndex GetPrimaryCursorPosition() const;
 622
 623   /**
 624    * @copydoc Text::Controller::SetPrimaryCursorPosition()
 625    */
 626   bool SetPrimaryCursorPosition( CharacterIndex index );
 627
 628   /**
 629    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
 630    */
 631   void SetTextSelectionRange(const uint32_t *pStart, const uint32_t *pEndf);
 632
 633   /**
 634    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
 635    */
 636   Uint32Pair GetTextSelectionRange() const;
 637
 638   /**
 639    * @copydoc Text::EditableControlInterface::IsEditable()
 640    */
 641   bool IsEditable() const;
 642
 643   /**
 644    * @copydoc Text::EditableControlInterface::SetEditable()
 645    */
 646   void SetEditable( bool editable );
 647
 648   /**
 649    * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
 650    *
 651    * @param[out] selectedText The selected text encoded in utf8.
 652    * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
 653    */
 654   void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
 655
 656   void SetSelection( int start, int end );
 657
 658   std::pair< int, int > GetSelectionIndexes() const;
 659
 660   void ShowClipboard();
 661
 662   void HideClipboard();
 663
 664   void SetClipboardHideEnable(bool enable);
 665
 666   bool CopyStringToClipboard( const std::string& source );
 667
 668   void SendSelectionToClipboard( bool deleteAfterSending );
 669
 670   void RequestGetTextFromClipboard();
 671
 672   void RepositionSelectionHandles();
 673   void RepositionSelectionHandles( float visualX, float visualY, Controller::NoTextTap::Action action );
 674
 675   void SetPopupButtons();
 676
 677   void ChangeState( EventData::State newState );
 678
 679   /**
 680    * @brief Calculates the cursor's position for a given character index in the logical order.
 681    *
 682    * It retrieves as well the line's height and the cursor's height and
 683    * if there is a valid alternative cursor, its position and height.
 684    *
 685    * @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.
 686    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 687    */
 688   void GetCursorPosition( CharacterIndex logical,
 689                           CursorInfo& cursorInfo );
 690
 691   /**
 692    * @brief Calculates the new cursor index.
 693    *
 694    * It takes into account that in some scripts multiple characters can form a glyph and all of them
 695    * need to be jumped with one key event.
 696    *
 697    * @param[in] index The initial new index.
 698    *
 699    * @return The new cursor index.
 700    */
 701   CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
 702
 703   /**
 704    * @brief Updates the cursor position.
 705    *
 706    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
 707    * It sets the position of the secondary cursor if it's a valid one.
 708    * Sets which cursors are active.
 709    *
 710    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 711    *
 712    */
 713   void UpdateCursorPosition( const CursorInfo& cursorInfo );
 714
 715   /**
 716    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
 717    *
 718    * @param[in] handleType One of the selection handles.
 719    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 720    */
 721   void UpdateSelectionHandle( HandleType handleType,
 722                               const CursorInfo& cursorInfo );
 723
 724   /**
 725    * @biref Clamps the horizontal scrolling to get the control always filled with text.
 726    *
 727    * @param[in] layoutSize The size of the laid out text.
 728    */
 729   void ClampHorizontalScroll( const Vector2& layoutSize );
 730
 731   /**
 732    * @biref Clamps the vertical scrolling to get the control always filled with text.
 733    *
 734    * @param[in] layoutSize The size of the laid out text.
 735    */
 736   void ClampVerticalScroll( const Vector2& layoutSize );
 737
 738   /**
 739    * @brief Scrolls the text to make a position visible.
 740    *
 741    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
 742    *
 743    * @param[in] position A position in text coords.
 744    * @param[in] lineHeight The line height for the given position.
 745    *
 746    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
 747    * or moving the selection handles.
 748    */
 749   void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
 750
 751   /**
 752    * @brief Scrolls the text to make the cursor visible.
 753    *
 754    * This method is called after deleting text.
 755    */
 756   void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
 757
 758   /**
 759    * @brief Scrolls the text to make primary cursor visible.
 760    */
 761   void ScrollTextToMatchCursor( );
 762
 763   /**
 764    * @brief Create an actor that renders the text background color
 765    *
 766    * @return the created actor or an empty handle if no background color needs to be rendered.
 767    */
 768   Actor CreateBackgroundActor();
 769
 770 public:
 771
 772   /**
 773    * @brief Gets implementation from the controller handle.
 774    * @param controller The text controller
 775    * @return The implementation of the Controller
 776    */
 777   static Impl& GetImplementation( Text::Controller& controller )
 778   {
 779     return *controller.mImpl;
 780   }
 781
 782 private:
 783   // Declared private and left undefined to avoid copies.
 784   Impl( const Impl& );
 785   // Declared private and left undefined to avoid copies.
 786   Impl& operator=( const Impl& );
 787
 788 public:
 789
 790   ControlInterface* mControlInterface;     ///< Reference to the text controller.
 791   EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
 792   SelectableControlInterface* mSelectableControlInterface; ///< Reference to the selectable text controller.
 793   ModelPtr mModel;                         ///< Pointer to the text's model.
 794   FontDefaults* mFontDefaults;             ///< Avoid allocating this when the user does not specify a font.
 795   UnderlineDefaults* mUnderlineDefaults;   ///< Avoid allocating this when the user does not specify underline parameters.
 796   ShadowDefaults* mShadowDefaults;         ///< Avoid allocating this when the user does not specify shadow parameters.
 797   EmbossDefaults* mEmbossDefaults;         ///< Avoid allocating this when the user does not specify emboss parameters.
 798   OutlineDefaults* mOutlineDefaults;       ///< Avoid allocating this when the user does not specify outline parameters.
 799   EventData* mEventData;                   ///< Avoid allocating everything for text input until EnableTextInput().
 800   TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
 801   Clipboard mClipboard;                    ///< Handle to the system clipboard
 802   View mView;                              ///< The view interface to the rendering back-end.
 803   MetricsPtr mMetrics;                     ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
 804   Layout::Engine mLayoutEngine;            ///< The layout engine.
 805   Vector<ModifyEvent> mModifyEvents;       ///< Temporary stores the text set until the next relayout.
 806   Vector4 mTextColor;                      ///< The regular text color
 807   TextUpdateInfo mTextUpdateInfo;          ///< Info of the characters updated.
 808   OperationsMask mOperationsPending;       ///< Operations pending to be done to layout the text.
 809   Length mMaximumNumberOfCharacters;       ///< Maximum number of characters that can be inserted.
 810   HiddenText* mHiddenInput;                ///< Avoid allocating this when the user does not specify hidden input mode.
 811   Vector2 mTextFitContentSize;             ///< Size of Text fit content
 812
 813   bool mRecalculateNaturalSize:1;          ///< Whether the natural size needs to be recalculated.
 814   bool mMarkupProcessorEnabled:1;          ///< Whether the mark-up procesor is enabled.
 815   bool mClipboardHideEnabled:1;            ///< Whether the ClipboardHide function work or not
 816   bool mIsAutoScrollEnabled:1;             ///< Whether auto text scrolling is enabled.
 817   bool mUpdateTextDirection:1;             ///< Whether the text direction needs to be updated.
 818   CharacterDirection mIsTextDirectionRTL:1;  ///< Whether the text direction is right to left or not
 819
 820   bool mUnderlineSetByString:1;            ///< Set when underline is set by string (legacy) instead of map
 821   bool mShadowSetByString:1;               ///< Set when shadow is set by string (legacy) instead of map
 822   bool mOutlineSetByString:1;              ///< Set when outline is set by string (legacy) instead of map
 823   bool mFontStyleSetByString:1;            ///< Set when font style is set by string (legacy) instead of map
 824   bool mShouldClearFocusOnEscape:1;        ///< Whether text control should clear key input focus
 825   LayoutDirection::Type mLayoutDirection;  ///< Current system language direction
 826
 827   Shader mShaderBackground;                ///< The shader for text background.
 828
 829   float mTextFitMinSize;                   ///< Minimum Font Size for text fit. Default 10
 830   float mTextFitMaxSize;                   ///< Maximum Font Size for text fit. Default 100
 831   float mTextFitStepSize;                  ///< Step Size for font intervalse. Default 1
 832   bool  mTextFitEnabled : 1;               ///< Whether the text's fit is enabled.
 833   float mFontSizeScale;                    ///< Scale value for Font Size. Default 1.0
 834
 835 private:
 836   friend ControllerImplEventHandler;
 837   friend SelectionHandleController;
 838 };
 839
 840 } // namespace Text
 841
 842 } // namespace Toolkit
 843
 844 } // namespace Dali
 845
 846 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H