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) 2015 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
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/text/input-style.h>
  27 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
  28 #include <dali-toolkit/internal/text/logical-model-impl.h>
  29 #include <dali-toolkit/internal/text/text-controller.h>
  30 #include <dali-toolkit/internal/text/text-view.h>
  31 #include <dali-toolkit/internal/text/visual-model-impl.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Text
  40 {
  41
  42 //Forward declarations
  43 struct CursorInfo;
  44
  45 struct Event
  46 {
  47   // Used to queue input events until DoRelayout()
  48   enum Type
  49   {
  50     CURSOR_KEY_EVENT,
  51     TAP_EVENT,
  52     PAN_EVENT,
  53     LONG_PRESS_EVENT,
  54     GRAB_HANDLE_EVENT,
  55     LEFT_SELECTION_HANDLE_EVENT,
  56     RIGHT_SELECTION_HANDLE_EVENT,
  57     SELECT,
  58     SELECT_ALL
  59   };
  60
  61   union Param
  62   {
  63     int mInt;
  64     unsigned int mUint;
  65     float mFloat;
  66   };
  67
  68   Event( Type eventType )
  69   : type( eventType )
  70   {
  71     p1.mInt = 0;
  72     p2.mInt = 0;
  73     p3.mInt = 0;
  74   }
  75
  76   Type type;
  77   Param p1;
  78   Param p2;
  79   Param p3;
  80 };
  81
  82 struct EventData
  83 {
  84   enum State
  85   {
  86     INACTIVE,
  87     INTERRUPTED,
  88     SELECTING,
  89     EDITING,
  90     EDITING_WITH_POPUP,
  91     EDITING_WITH_GRAB_HANDLE,
  92     EDITING_WITH_PASTE_POPUP,
  93     GRAB_HANDLE_PANNING,
  94     SELECTION_HANDLE_PANNING,
  95     TEXT_PANNING
  96   };
  97
  98   EventData( DecoratorPtr decorator );
  99
 100   ~EventData();
 101
 102   static bool IsEditingState( State stateToCheck )
 103   {
 104     return ( stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP );
 105   }
 106
 107   DecoratorPtr       mDecorator;               ///< Pointer to the decorator.
 108   ImfManager         mImfManager;              ///< The Input Method Framework Manager.
 109   std::string        mPlaceholderTextActive;   ///< The text to display when the TextField is empty with key-input focus.
 110   std::string        mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
 111   Vector4            mPlaceholderTextColor;    ///< The in/active placeholder text color.
 112
 113   /**
 114    * This is used to delay handling events until after the model has been updated.
 115    * The number of updates to the model is minimized to improve performance.
 116    */
 117   std::vector<Event> mEventQueue;              ///< The queue of touch events etc.
 118
 119   InputStyle         mInputStyle;              ///< The style to be set to the new inputed text.
 120
 121   State              mPreviousState;           ///< Stores the current state before it's updated with the new one.
 122   State              mState;                   ///< Selection mode, edit mode etc.
 123
 124   CharacterIndex     mPrimaryCursorPosition;   ///< Index into logical model for primary cursor.
 125   CharacterIndex     mLeftSelectionPosition;   ///< Index into logical model for left selection handle.
 126   CharacterIndex     mRightSelectionPosition;  ///< Index into logical model for right selection handle.
 127
 128   CharacterIndex     mPreEditStartPosition;    ///< Used to remove the pre-edit text if necessary.
 129   Length             mPreEditLength;           ///< Used to remove the pre-edit text if necessary.
 130
 131   float              mCursorHookPositionX;     ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles.
 132
 133   bool mIsShowingPlaceholderText        : 1;   ///< True if the place-holder text is being displayed.
 134   bool mPreEditFlag                     : 1;   ///< True if the model contains text in pre-edit state.
 135   bool mDecoratorUpdated                : 1;   ///< True if the decorator was updated during event processing.
 136   bool mCursorBlinkEnabled              : 1;   ///< True if cursor should blink when active.
 137   bool mGrabHandleEnabled               : 1;   ///< True if grab handle is enabled.
 138   bool mGrabHandlePopupEnabled          : 1;   ///< True if the grab handle popu-up should be shown.
 139   bool mSelectionEnabled                : 1;   ///< True if selection handles, highlight etc. are enabled.
 140   bool mUpdateCursorHookPosition        : 1;   ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
 141   bool mUpdateCursorPosition            : 1;   ///< True if the visual position of the cursor must be recalculated.
 142   bool mUpdateGrabHandlePosition        : 1;   ///< True if the visual position of the grab handle must be recalculated.
 143   bool mUpdateLeftSelectionPosition     : 1;   ///< True if the visual position of the left selection handle must be recalculated.
 144   bool mUpdateRightSelectionPosition    : 1;   ///< True if the visual position of the right selection handle must be recalculated.
 145   bool mIsLeftHandleSelected            : 1;   ///< Whether is the left handle the one which is selected.
 146   bool mUpdateHighlightBox              : 1;   ///< True if the text selection high light box must be updated.
 147   bool mScrollAfterUpdatePosition       : 1;   ///< Whether to scroll after the cursor position is updated.
 148   bool mScrollAfterDelete               : 1;   ///< Whether to scroll after delete characters.
 149   bool mAllTextSelected                 : 1;   ///< True if the selection handles are selecting all the text.
 150   bool mUpdateInputStyle                : 1;   ///< Whether to update the input style after moving the cursor.
 151 };
 152
 153 struct ModifyEvent
 154 {
 155   enum Type
 156   {
 157     TEXT_REPLACED,    ///< The entire text was replaced
 158     TEXT_INSERTED,    ///< Insert characters at the current cursor position
 159     TEXT_DELETED      ///< Characters were deleted
 160   };
 161
 162   Type type;
 163 };
 164
 165 struct FontDefaults
 166 {
 167   FontDefaults()
 168   : mFontDescription(),
 169     mFontStyle(),
 170     mDefaultPointSize( 0.f ),
 171     mFontId( 0u ),
 172     familyDefined( false ),
 173     weightDefined( false ),
 174     widthDefined( false ),
 175     slantDefined( false ),
 176     sizeDefined( false )
 177   {
 178     // Initially use the default platform font
 179     TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
 180     fontClient.GetDefaultPlatformFontDescription( mFontDescription );
 181   }
 182
 183   FontId GetFontId( TextAbstraction::FontClient& fontClient )
 184   {
 185     if( !mFontId )
 186     {
 187       const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( mDefaultPointSize * 64.f );
 188       mFontId = fontClient.GetFontId( mFontDescription, pointSize );
 189     }
 190
 191     return mFontId;
 192   }
 193
 194   TextAbstraction::FontDescription mFontDescription;  ///< The default font's description.
 195   std::string                      mFontStyle;        ///< The font's style string set through the property system.
 196   float                            mDefaultPointSize; ///< The default font's point size.
 197   FontId                           mFontId;           ///< The font's id of the default font.
 198   bool familyDefined:1; ///< Whether the default font's family name is defined.
 199   bool weightDefined:1; ///< Whether the default font's weight is defined.
 200   bool  widthDefined:1; ///< Whether the default font's width is defined.
 201   bool  slantDefined:1; ///< Whether the default font's slant is defined.
 202   bool   sizeDefined:1; ///< Whether the default font's point size is defined.
 203 };
 204
 205 /**
 206  * @brief Stores indices used to update the text.
 207  * Stores the character index where the text is updated and the number of characters removed and added.
 208  * Stores as well indices to the first and the last paragraphs to be updated.
 209  */
 210 struct TextUpdateInfo
 211 {
 212   TextUpdateInfo()
 213   : mCharacterIndex( 0u ),
 214     mNumberOfCharactersToRemove( 0u ),
 215     mNumberOfCharactersToAdd( 0u ),
 216     mPreviousNumberOfCharacters( 0u ),
 217     mParagraphCharacterIndex( 0u ),
 218     mRequestedNumberOfCharacters( 0u ),
 219     mStartGlyphIndex( 0u ),
 220     mStartLineIndex( 0u ),
 221     mEstimatedNumberOfLines( 0u ),
 222     mClearAll( true ),
 223     mFullRelayoutNeeded( true ),
 224     mIsLastCharacterNewParagraph( false )
 225   {}
 226
 227   ~TextUpdateInfo()
 228   {}
 229
 230   CharacterIndex    mCharacterIndex;                ///< Index to the first character to be updated.
 231   Length            mNumberOfCharactersToRemove;    ///< The number of characters to be removed.
 232   Length            mNumberOfCharactersToAdd;       ///< The number of characters to be added.
 233   Length            mPreviousNumberOfCharacters;    ///< The number of characters before the text update.
 234
 235   CharacterIndex    mParagraphCharacterIndex;       ///< Index of the first character of the first paragraph to be updated.
 236   Length            mRequestedNumberOfCharacters;   ///< The requested number of characters.
 237   GlyphIndex        mStartGlyphIndex;
 238   LineIndex         mStartLineIndex;
 239   Length            mEstimatedNumberOfLines;         ///< The estimated number of lines. Used to avoid reallocations when layouting.
 240
 241   bool              mClearAll:1;                    ///< Whether the whole text is cleared. i.e. when the text is reset.
 242   bool              mFullRelayoutNeeded:1;          ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
 243   bool              mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
 244
 245   void Clear()
 246   {
 247     // Clear all info except the mPreviousNumberOfCharacters member.
 248     mCharacterIndex = static_cast<CharacterIndex>( -1 );
 249     mNumberOfCharactersToRemove = 0u;
 250     mNumberOfCharactersToAdd = 0u;
 251     mParagraphCharacterIndex = 0u;
 252     mRequestedNumberOfCharacters = 0u;
 253     mStartGlyphIndex = 0u;
 254     mStartLineIndex = 0u;
 255     mEstimatedNumberOfLines = 0u;
 256     mClearAll = false;
 257     mFullRelayoutNeeded = false;
 258     mIsLastCharacterNewParagraph = false;
 259   }
 260 };
 261
 262 struct UnderlineDefaults
 263 {
 264   std::string properties;
 265   // TODO: complete with underline parameters.
 266 };
 267
 268 struct ShadowDefaults
 269 {
 270   std::string properties;
 271   // TODO: complete with shadow parameters.
 272 };
 273
 274 struct EmbossDefaults
 275 {
 276   std::string properties;
 277   // TODO: complete with emboss parameters.
 278 };
 279
 280 struct OutlineDefaults
 281 {
 282   std::string properties;
 283   // TODO: complete with outline parameters.
 284 };
 285
 286 struct Controller::Impl
 287 {
 288   Impl( ControlInterface& controlInterface )
 289   : mControlInterface( controlInterface ),
 290     mLogicalModel(),
 291     mVisualModel(),
 292     mFontDefaults( NULL ),
 293     mUnderlineDefaults( NULL ),
 294     mShadowDefaults( NULL ),
 295     mEmbossDefaults( NULL ),
 296     mOutlineDefaults( NULL ),
 297     mEventData( NULL ),
 298     mFontClient(),
 299     mClipboard(),
 300     mView(),
 301     mMetrics(),
 302     mLayoutEngine(),
 303     mModifyEvents(),
 304     mTextColor( Color::BLACK ),
 305     mTextUpdateInfo(),
 306     mOperationsPending( NO_OPERATION ),
 307     mMaximumNumberOfCharacters( 50u ),
 308     mRecalculateNaturalSize( true ),
 309     mMarkupProcessorEnabled( false ),
 310     mClipboardHideEnabled( true ),
 311     mAutoScrollEnabled( false ),
 312     mAutoScrollDirectionRTL( false )
 313   {
 314     mLogicalModel = LogicalModel::New();
 315     mVisualModel  = VisualModel::New();
 316
 317     mFontClient = TextAbstraction::FontClient::Get();
 318     mClipboard = Clipboard::Get();
 319
 320     mView.SetVisualModel( mVisualModel );
 321
 322     // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
 323     mMetrics = Metrics::New( mFontClient );
 324     mLayoutEngine.SetMetrics( mMetrics );
 325
 326     // Set the text properties to default
 327     mVisualModel->SetUnderlineEnabled( false );
 328     mVisualModel->SetUnderlineHeight( 0.0f );
 329   }
 330
 331   ~Impl()
 332   {
 333     delete mFontDefaults;
 334     delete mUnderlineDefaults;
 335     delete mShadowDefaults;
 336     delete mEmbossDefaults;
 337     delete mOutlineDefaults;
 338     delete mEventData;
 339   }
 340
 341   /**
 342    * @brief Request a relayout using the ControlInterface.
 343    */
 344   void RequestRelayout();
 345
 346   /**
 347    * @brief Request a relayout using the ControlInterface.
 348    */
 349   void QueueModifyEvent( ModifyEvent::Type type )
 350   {
 351     if( ModifyEvent::TEXT_REPLACED == type)
 352     {
 353       // Cancel previously queued inserts etc.
 354       mModifyEvents.Clear();
 355     }
 356
 357     ModifyEvent event;
 358     event.type = type;
 359     mModifyEvents.PushBack( event );
 360
 361     // The event will be processed during relayout
 362     RequestRelayout();
 363   }
 364
 365   /**
 366    * @brief Helper to move the cursor, grab handle etc.
 367    */
 368   bool ProcessInputEvents();
 369
 370   /**
 371    * @brief Helper to check whether any place-holder text is available.
 372    */
 373   bool IsPlaceholderAvailable() const
 374   {
 375     return ( mEventData &&
 376              ( !mEventData->mPlaceholderTextInactive.empty() ||
 377                !mEventData->mPlaceholderTextActive.empty() )
 378            );
 379   }
 380
 381   bool IsShowingPlaceholderText() const
 382   {
 383     return ( mEventData && mEventData->mIsShowingPlaceholderText );
 384   }
 385
 386   /**
 387    * @brief Helper to check whether active place-holder text is available.
 388    */
 389   bool IsFocusedPlaceholderAvailable() const
 390   {
 391     return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
 392   }
 393
 394   bool IsShowingRealText() const
 395   {
 396     return ( !IsShowingPlaceholderText() &&
 397              0u != mLogicalModel->mText.Count() );
 398   }
 399
 400   /**
 401    * @brief Called when placeholder-text is hidden
 402    */
 403   void PlaceholderCleared()
 404   {
 405     if( mEventData )
 406     {
 407       mEventData->mIsShowingPlaceholderText = false;
 408
 409       // Remove mPlaceholderTextColor
 410       mVisualModel->SetTextColor( mTextColor );
 411     }
 412   }
 413
 414   void ClearPreEditFlag()
 415   {
 416     if( mEventData )
 417     {
 418       mEventData->mPreEditFlag = false;
 419       mEventData->mPreEditStartPosition = 0;
 420       mEventData->mPreEditLength = 0;
 421     }
 422   }
 423
 424   void ResetImfManager()
 425   {
 426     if( mEventData )
 427     {
 428       // Reset incase we are in a pre-edit state.
 429       if( mEventData->mImfManager )
 430       {
 431         mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
 432       }
 433
 434       ClearPreEditFlag();
 435     }
 436   }
 437
 438   /**
 439    * @brief Helper to notify IMF manager with surrounding text & cursor changes.
 440    */
 441   void NotifyImfManager();
 442
 443   /**
 444    * @brief Retrieve the current cursor position.
 445    *
 446    * @return The cursor position.
 447    */
 448   CharacterIndex GetLogicalCursorPosition() const;
 449
 450   /**
 451    * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
 452    *
 453    * @param[in] index The character index from where to count the number of consecutive white spaces.
 454    *
 455    * @return The number of consecutive white spaces.
 456    */
 457   Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
 458
 459   /**
 460    * @brief Retrieve any text previously set starting from the given @p index.
 461    *
 462    * @param[in] index The character index from where to retrieve the text.
 463    * @param[out] text A string of UTF-8 characters.
 464    *
 465    * @see Dali::Toolkit::Text::Controller::GetText()
 466    */
 467   void GetText( CharacterIndex index, std::string& text ) const;
 468
 469   bool IsClipboardEmpty()
 470   {
 471     bool result( mClipboard && mClipboard.NumberOfItems() );
 472     return !result; // If NumberOfItems greater than 0, return false
 473   }
 474
 475   /**
 476    * @brief Calculates the start character index of the first paragraph to be updated and
 477    * the end character index of the last paragraph to be updated.
 478    *
 479    * @param[out] numberOfCharacters The number of characters to be updated.
 480    */
 481   void CalculateTextUpdateIndices( Length& numberOfCharacters );
 482
 483   /**
 484    * @brief Helper to clear completely the parts of the model specified by the given @p operations.
 485    *
 486    * @note It never clears the text stored in utf32.
 487    */
 488   void ClearFullModelData( OperationsMask operations );
 489
 490   /**
 491    * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
 492    *
 493    * @note It never clears the text stored in utf32.
 494    *
 495    * @param[in] startIndex Index to the first character to be cleared.
 496    * @param[in] endIndex Index to the last character to be cleared.
 497    * @param[in] operations The operations required.
 498    */
 499   void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 500
 501   /**
 502    * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
 503    *
 504    * @note It never clears the text stored in utf32.
 505    * @note Character indices are transformed to glyph indices.
 506    *
 507    * @param[in] startIndex Index to the first character to be cleared.
 508    * @param[in] endIndex Index to the last character to be cleared.
 509    * @param[in] operations The operations required.
 510    */
 511   void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 512
 513   /**
 514    * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
 515    *
 516    * @note It never clears the text stored in utf32.
 517    *
 518    * @param[in] startIndex Index to the first character to be cleared.
 519    * @param[in] endIndex Index to the last character to be cleared.
 520    * @param[in] operations The operations required.
 521    */
 522   void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 523
 524   /**
 525    * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
 526    *
 527    * When text or style changes the model is set with some operations pending.
 528    * When i.e. the text's size or a relayout is required this method is called
 529    * with a given @p operationsRequired parameter. The operations required are
 530    * matched with the operations pending to perform the minimum number of operations.
 531    *
 532    * @param[in] operationsRequired The operations required.
 533    *
 534    * @return @e true if the model has been modified.
 535    */
 536   bool UpdateModel( OperationsMask operationsRequired );
 537
 538   /**
 539    * @brief Retreieves the default style.
 540    *
 541    * @param[out] inputStyle The default style.
 542    */
 543   void RetrieveDefaultInputStyle( InputStyle& inputStyle );
 544
 545   /**
 546    * @brief Retrieve the line height of the default font.
 547    */
 548   float GetDefaultFontLineHeight();
 549
 550   void OnCursorKeyEvent( const Event& event );
 551
 552   void OnTapEvent( const Event& event );
 553
 554   void OnPanEvent( const Event& event );
 555
 556   void OnLongPressEvent( const Event& event );
 557
 558   void OnHandleEvent( const Event& event );
 559
 560   void OnSelectEvent( const Event& event );
 561
 562   void OnSelectAllEvent();
 563
 564   /**
 565    * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
 566    *
 567    * @param[out] selectedText The selected text encoded in utf8.
 568    * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
 569    */
 570   void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
 571
 572   void ShowClipboard();
 573
 574   void HideClipboard();
 575
 576   void SetClipboardHideEnable(bool enable);
 577
 578   bool CopyStringToClipboard( std::string& source );
 579
 580   void SendSelectionToClipboard( bool deleteAfterSending );
 581
 582   void GetTextFromClipboard( unsigned int itemIndex, std::string& retrievedString );
 583
 584   void RepositionSelectionHandles();
 585   void RepositionSelectionHandles( float visualX, float visualY );
 586
 587   void SetPopupButtons();
 588
 589   void ChangeState( EventData::State newState );
 590
 591   /**
 592    * @brief Calculates the cursor's position for a given character index in the logical order.
 593    *
 594    * It retrieves as well the line's height and the cursor's height and
 595    * if there is a valid alternative cursor, its position and height.
 596    *
 597    * @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.
 598    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 599    */
 600   void GetCursorPosition( CharacterIndex logical,
 601                           CursorInfo& cursorInfo );
 602
 603   /**
 604    * @brief Calculates the new cursor index.
 605    *
 606    * It takes into account that in some scripts multiple characters can form a glyph and all of them
 607    * need to be jumped with one key event.
 608    *
 609    * @param[in] index The initial new index.
 610    *
 611    * @return The new cursor index.
 612    */
 613   CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
 614
 615   /**
 616    * @brief Updates the cursor position.
 617    *
 618    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
 619    * It sets the position of the secondary cursor if it's a valid one.
 620    * Sets which cursors are active.
 621    *
 622    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 623    *
 624    */
 625   void UpdateCursorPosition( const CursorInfo& cursorInfo );
 626
 627   /**
 628    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
 629    *
 630    * @param[in] handleType One of the selection handles.
 631    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 632    */
 633   void UpdateSelectionHandle( HandleType handleType,
 634                               const CursorInfo& cursorInfo );
 635
 636   /**
 637    * @biref Clamps the horizontal scrolling to get the control always filled with text.
 638    *
 639    * @param[in] layoutSize The size of the laid out text.
 640    */
 641   void ClampHorizontalScroll( const Vector2& layoutSize );
 642
 643   /**
 644    * @biref Clamps the vertical scrolling to get the control always filled with text.
 645    *
 646    * @param[in] layoutSize The size of the laid out text.
 647    */
 648   void ClampVerticalScroll( const Vector2& layoutSize );
 649
 650   /**
 651    * @brief Scrolls the text to make a position visible.
 652    *
 653    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
 654    *
 655    * @param[in] position A position in text coords.
 656    * @param[in] lineHeight The line height for the given position.
 657    *
 658    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
 659    * or moving the selection handles.
 660    */
 661   void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
 662
 663   /**
 664    * @brief Scrolls the text to make the cursor visible.
 665    *
 666    * This method is called after deleting text.
 667    */
 668   void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
 669
 670 private:
 671   // Declared private and left undefined to avoid copies.
 672   Impl( const Impl& );
 673   // Declared private and left undefined to avoid copies.
 674   Impl& operator=( const Impl& );
 675
 676 public:
 677
 678   ControlInterface& mControlInterface;     ///< Reference to the text controller.
 679   LogicalModelPtr mLogicalModel;           ///< Pointer to the logical model.
 680   VisualModelPtr  mVisualModel;            ///< Pointer to the visual model.
 681   FontDefaults* mFontDefaults;             ///< Avoid allocating this when the user does not specify a font.
 682   UnderlineDefaults* mUnderlineDefaults;   ///< Avoid allocating this when the user does not specify underline parameters.
 683   ShadowDefaults* mShadowDefaults;         ///< Avoid allocating this when the user does not specify shadow parameters.
 684   EmbossDefaults* mEmbossDefaults;         ///< Avoid allocating this when the user does not specify emboss parameters.
 685   OutlineDefaults* mOutlineDefaults;       ///< Avoid allocating this when the user does not specify outline parameters.
 686   EventData* mEventData;                   ///< Avoid allocating everything for text input until EnableTextInput().
 687   TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
 688   Clipboard mClipboard;                    ///< Handle to the system clipboard
 689   View mView;                              ///< The view interface to the rendering back-end.
 690   MetricsPtr mMetrics;                     ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
 691   LayoutEngine mLayoutEngine;              ///< The layout engine.
 692   Vector<ModifyEvent> mModifyEvents;       ///< Temporary stores the text set until the next relayout.
 693   Vector4 mTextColor;                      ///< The regular text color
 694   /**
 695    * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
 696    * Typically this will have a negative value with scrolling occurs.
 697    */
 698   Vector2 mScrollPosition;                 ///< The text is offset by this position when scrolling.
 699   TextUpdateInfo mTextUpdateInfo;          ///< Info of the characters updated.
 700   OperationsMask mOperationsPending;       ///< Operations pending to be done to layout the text.
 701   Length mMaximumNumberOfCharacters;       ///< Maximum number of characters that can be inserted.
 702
 703   bool mRecalculateNaturalSize:1;          ///< Whether the natural size needs to be recalculated.
 704   bool mMarkupProcessorEnabled:1;          ///< Whether the mark-up procesor is enabled.
 705   bool mClipboardHideEnabled:1;            ///< Whether the ClipboardHide function work or not
 706   bool mAutoScrollEnabled:1;               ///< Whether auto text scrolling is enabled.
 707   CharacterDirection mAutoScrollDirectionRTL:1;  ///< Direction of auto scrolling, true if rtl
 708
 709 };
 710
 711 } // namespace Text
 712
 713 } // namespace Toolkit
 714
 715 } // namespace Dali
 716
 717 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__