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