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/text-controller.h>
  28 #include <dali-toolkit/internal/text/text-model.h>
  29 #include <dali-toolkit/internal/text/text-view.h>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 namespace Text
  38 {
  39
  40 //Forward declarations
  41 struct CursorInfo;
  42
  43 struct Event
  44 {
  45   // Used to queue input events until DoRelayout()
  46   enum Type
  47   {
  48     CURSOR_KEY_EVENT,
  49     TAP_EVENT,
  50     PAN_EVENT,
  51     LONG_PRESS_EVENT,
  52     GRAB_HANDLE_EVENT,
  53     LEFT_SELECTION_HANDLE_EVENT,
  54     RIGHT_SELECTION_HANDLE_EVENT,
  55     SELECT,
  56     SELECT_ALL
  57   };
  58
  59   union Param
  60   {
  61     int mInt;
  62     unsigned int mUint;
  63     float mFloat;
  64   };
  65
  66   Event( Type eventType )
  67   : type( eventType )
  68   {
  69     p1.mInt = 0;
  70     p2.mInt = 0;
  71     p3.mInt = 0;
  72   }
  73
  74   Type type;
  75   Param p1;
  76   Param p2;
  77   Param p3;
  78 };
  79
  80 struct EventData
  81 {
  82   enum State
  83   {
  84     INACTIVE,
  85     INTERRUPTED,
  86     SELECTING,
  87     EDITING,
  88     EDITING_WITH_POPUP,
  89     EDITING_WITH_GRAB_HANDLE,
  90     EDITING_WITH_PASTE_POPUP,
  91     GRAB_HANDLE_PANNING,
  92     SELECTION_HANDLE_PANNING,
  93     TEXT_PANNING
  94   };
  95
  96   EventData( DecoratorPtr decorator );
  97
  98   ~EventData();
  99
 100   static bool IsEditingState( State stateToCheck )
 101   {
 102     return ( stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP );
 103   }
 104
 105   DecoratorPtr       mDecorator;               ///< Pointer to the decorator.
 106   ImfManager         mImfManager;              ///< The Input Method Framework Manager.
 107   std::string        mPlaceholderTextActive;   ///< The text to display when the TextField is empty with key-input focus.
 108   std::string        mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
 109   Vector4            mPlaceholderTextColor;    ///< The in/active placeholder text color.
 110
 111   /**
 112    * This is used to delay handling events until after the model has been updated.
 113    * The number of updates to the model is minimized to improve performance.
 114    */
 115   std::vector<Event> mEventQueue;              ///< The queue of touch events etc.
 116
 117   Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
 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   bool mPasswordInput                   : 1;   ///< True if password input is enabled.
 152   bool mCheckScrollAmount               : 1;   ///< Whether to check scrolled amount after updating the position
 153 };
 154
 155 struct ModifyEvent
 156 {
 157   enum Type
 158   {
 159     TEXT_REPLACED,    ///< The entire text was replaced
 160     TEXT_INSERTED,    ///< Insert characters at the current cursor position
 161     TEXT_DELETED      ///< Characters were deleted
 162   };
 163
 164   Type type;
 165 };
 166
 167 struct FontDefaults
 168 {
 169   FontDefaults()
 170   : mFontDescription(),
 171     mDefaultPointSize( 0.f ),
 172     mFontId( 0u ),
 173     familyDefined( false ),
 174     weightDefined( false ),
 175     widthDefined( false ),
 176     slantDefined( false ),
 177     sizeDefined( false )
 178   {
 179     // Initially use the default platform font
 180     TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
 181     fontClient.GetDefaultPlatformFontDescription( mFontDescription );
 182   }
 183
 184   FontId GetFontId( TextAbstraction::FontClient& fontClient )
 185   {
 186     if( !mFontId )
 187     {
 188       const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( mDefaultPointSize * 64.f );
 189       mFontId = fontClient.GetFontId( mFontDescription, pointSize );
 190     }
 191
 192     return mFontId;
 193   }
 194
 195   TextAbstraction::FontDescription mFontDescription;  ///< The default font's description.
 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         EditableControlInterface* editableControlInterface )
 290   : mControlInterface( controlInterface ),
 291     mEditableControlInterface( editableControlInterface ),
 292     mModel(),
 293     mFontDefaults( NULL ),
 294     mUnderlineDefaults( NULL ),
 295     mShadowDefaults( NULL ),
 296     mEmbossDefaults( NULL ),
 297     mOutlineDefaults( NULL ),
 298     mEventData( NULL ),
 299     mFontClient(),
 300     mClipboard(),
 301     mView(),
 302     mMetrics(),
 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     mIsAutoScrollEnabled( false ),
 312     mAutoScrollDirectionRTL( false )
 313   {
 314     mModel = Model::New();
 315
 316     mFontClient = TextAbstraction::FontClient::Get();
 317     mClipboard = Clipboard::Get();
 318
 319     mView.SetVisualModel( mModel->mVisualModel );
 320
 321     // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
 322     mMetrics = Metrics::New( mFontClient );
 323     mLayoutEngine.SetMetrics( mMetrics );
 324
 325     // Set the text properties to default
 326     mModel->mVisualModel->SetUnderlineEnabled( false );
 327     mModel->mVisualModel->SetUnderlineHeight( 0.0f );
 328   }
 329
 330   ~Impl()
 331   {
 332     delete mFontDefaults;
 333     delete mUnderlineDefaults;
 334     delete mShadowDefaults;
 335     delete mEmbossDefaults;
 336     delete mOutlineDefaults;
 337     delete mEventData;
 338   }
 339
 340   // Text Controller Implementation.
 341
 342   /**
 343    * @copydoc Text::Controller::RequestRelayout()
 344    */
 345   void RequestRelayout();
 346
 347   /**
 348    * @brief Request a relayout using the ControlInterface.
 349    */
 350   void QueueModifyEvent( ModifyEvent::Type type )
 351   {
 352     if( ModifyEvent::TEXT_REPLACED == type)
 353     {
 354       // Cancel previously queued inserts etc.
 355       mModifyEvents.Clear();
 356     }
 357
 358     ModifyEvent event;
 359     event.type = type;
 360     mModifyEvents.PushBack( event );
 361
 362     // The event will be processed during relayout
 363     RequestRelayout();
 364   }
 365
 366   /**
 367    * @brief Helper to move the cursor, grab handle etc.
 368    */
 369   bool ProcessInputEvents();
 370
 371   /**
 372    * @brief Helper to check whether any place-holder text is available.
 373    */
 374   bool IsPlaceholderAvailable() const
 375   {
 376     return ( mEventData &&
 377              ( !mEventData->mPlaceholderTextInactive.empty() ||
 378                !mEventData->mPlaceholderTextActive.empty() )
 379            );
 380   }
 381
 382   bool IsShowingPlaceholderText() const
 383   {
 384     return ( mEventData && mEventData->mIsShowingPlaceholderText );
 385   }
 386
 387   /**
 388    * @brief Helper to check whether active place-holder text is available.
 389    */
 390   bool IsFocusedPlaceholderAvailable() const
 391   {
 392     return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
 393   }
 394
 395   bool IsShowingRealText() const
 396   {
 397     return ( !IsShowingPlaceholderText() &&
 398              0u != mModel->mLogicalModel->mText.Count() );
 399   }
 400
 401   /**
 402    * @brief Called when placeholder-text is hidden
 403    */
 404   void PlaceholderCleared()
 405   {
 406     if( mEventData )
 407     {
 408       mEventData->mIsShowingPlaceholderText = false;
 409
 410       // Remove mPlaceholderTextColor
 411       mModel->mVisualModel->SetTextColor( mTextColor );
 412     }
 413   }
 414
 415   void ClearPreEditFlag()
 416   {
 417     if( mEventData )
 418     {
 419       mEventData->mPreEditFlag = false;
 420       mEventData->mPreEditStartPosition = 0;
 421       mEventData->mPreEditLength = 0;
 422     }
 423   }
 424
 425   void ResetImfManager()
 426   {
 427     if( mEventData )
 428     {
 429       // Reset incase we are in a pre-edit state.
 430       if( mEventData->mImfManager )
 431       {
 432         mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
 433       }
 434
 435       ClearPreEditFlag();
 436     }
 437   }
 438
 439   /**
 440    * @brief Helper to notify IMF manager with surrounding text & cursor changes.
 441    */
 442   void NotifyImfManager();
 443
 444   /**
 445    * @brief Helper to notify IMF manager with multi line status.
 446    */
 447   void NotifyImfMultiLineStatus();
 448
 449   /**
 450    * @brief Retrieve the current cursor position.
 451    *
 452    * @return The cursor position.
 453    */
 454   CharacterIndex GetLogicalCursorPosition() const;
 455
 456   /**
 457    * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
 458    *
 459    * @param[in] index The character index from where to count the number of consecutive white spaces.
 460    *
 461    * @return The number of consecutive white spaces.
 462    */
 463   Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
 464
 465   /**
 466    * @brief Retrieve any text previously set starting from the given @p index.
 467    *
 468    * @param[in] index The character index from where to retrieve the text.
 469    * @param[out] text A string of UTF-8 characters.
 470    *
 471    * @see Dali::Toolkit::Text::Controller::GetText()
 472    */
 473   void GetText( CharacterIndex index, std::string& text ) const;
 474
 475   bool IsClipboardEmpty()
 476   {
 477     bool result( mClipboard && mClipboard.NumberOfItems() );
 478     return !result; // If NumberOfItems greater than 0, return false
 479   }
 480
 481   bool IsClipboardVisible()
 482   {
 483     bool result( mClipboard && mClipboard.IsVisible() );
 484     return result;
 485   }
 486
 487   /**
 488    * @brief Calculates the start character index of the first paragraph to be updated and
 489    * the end character index of the last paragraph to be updated.
 490    *
 491    * @param[out] numberOfCharacters The number of characters to be updated.
 492    */
 493   void CalculateTextUpdateIndices( Length& numberOfCharacters );
 494
 495   /**
 496    * @brief Helper to clear completely the parts of the model specified by the given @p operations.
 497    *
 498    * @note It never clears the text stored in utf32.
 499    */
 500   void ClearFullModelData( OperationsMask operations );
 501
 502   /**
 503    * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
 504    *
 505    * @note It never clears the text stored in utf32.
 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 ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 512
 513   /**
 514    * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
 515    *
 516    * @note It never clears the text stored in utf32.
 517    * @note Character indices are transformed to glyph indices.
 518    *
 519    * @param[in] startIndex Index to the first character to be cleared.
 520    * @param[in] endIndex Index to the last character to be cleared.
 521    * @param[in] operations The operations required.
 522    */
 523   void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 524
 525   /**
 526    * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
 527    *
 528    * @note It never clears the text stored in utf32.
 529    *
 530    * @param[in] startIndex Index to the first character to be cleared.
 531    * @param[in] endIndex Index to the last character to be cleared.
 532    * @param[in] operations The operations required.
 533    */
 534   void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 535
 536   /**
 537    * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
 538    *
 539    * When text or style changes the model is set with some operations pending.
 540    * When i.e. the text's size or a relayout is required this method is called
 541    * with a given @p operationsRequired parameter. The operations required are
 542    * matched with the operations pending to perform the minimum number of operations.
 543    *
 544    * @param[in] operationsRequired The operations required.
 545    *
 546    * @return @e true if the model has been modified.
 547    */
 548   bool UpdateModel( OperationsMask operationsRequired );
 549
 550   /**
 551    * @brief Retreieves the default style.
 552    *
 553    * @param[out] inputStyle The default style.
 554    */
 555   void RetrieveDefaultInputStyle( InputStyle& inputStyle );
 556
 557   /**
 558    * @brief Retrieve the line height of the default font.
 559    */
 560   float GetDefaultFontLineHeight();
 561
 562   void OnCursorKeyEvent( const Event& event );
 563
 564   void OnTapEvent( const Event& event );
 565
 566   void OnPanEvent( const Event& event );
 567
 568   void OnLongPressEvent( const Event& event );
 569
 570   void OnHandleEvent( const Event& event );
 571
 572   void OnSelectEvent( const Event& event );
 573
 574   void OnSelectAllEvent();
 575
 576   /**
 577    * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
 578    *
 579    * @param[out] selectedText The selected text encoded in utf8.
 580    * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
 581    */
 582   void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
 583
 584   void ShowClipboard();
 585
 586   void HideClipboard();
 587
 588   void SetClipboardHideEnable(bool enable);
 589
 590   bool CopyStringToClipboard( std::string& source );
 591
 592   void SendSelectionToClipboard( bool deleteAfterSending );
 593
 594   void RequestGetTextFromClipboard();
 595
 596   void RepositionSelectionHandles();
 597   void RepositionSelectionHandles( float visualX, float visualY );
 598
 599   void SetPopupButtons();
 600
 601   void ChangeState( EventData::State newState );
 602
 603   /**
 604    * @brief Calculates the cursor's position for a given character index in the logical order.
 605    *
 606    * It retrieves as well the line's height and the cursor's height and
 607    * if there is a valid alternative cursor, its position and height.
 608    *
 609    * @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.
 610    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 611    */
 612   void GetCursorPosition( CharacterIndex logical,
 613                           CursorInfo& cursorInfo );
 614
 615   /**
 616    * @brief Calculates the new cursor index.
 617    *
 618    * It takes into account that in some scripts multiple characters can form a glyph and all of them
 619    * need to be jumped with one key event.
 620    *
 621    * @param[in] index The initial new index.
 622    *
 623    * @return The new cursor index.
 624    */
 625   CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
 626
 627   /**
 628    * @brief Updates the cursor position.
 629    *
 630    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
 631    * It sets the position of the secondary cursor if it's a valid one.
 632    * Sets which cursors are active.
 633    *
 634    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 635    *
 636    */
 637   void UpdateCursorPosition( const CursorInfo& cursorInfo );
 638
 639   /**
 640    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
 641    *
 642    * @param[in] handleType One of the selection handles.
 643    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 644    */
 645   void UpdateSelectionHandle( HandleType handleType,
 646                               const CursorInfo& cursorInfo );
 647
 648   /**
 649    * @biref Clamps the horizontal scrolling to get the control always filled with text.
 650    *
 651    * @param[in] layoutSize The size of the laid out text.
 652    */
 653   void ClampHorizontalScroll( const Vector2& layoutSize );
 654
 655   /**
 656    * @biref Clamps the vertical scrolling to get the control always filled with text.
 657    *
 658    * @param[in] layoutSize The size of the laid out text.
 659    */
 660   void ClampVerticalScroll( const Vector2& layoutSize );
 661
 662   /**
 663    * @brief Scrolls the text to make a position visible.
 664    *
 665    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
 666    *
 667    * @param[in] position A position in text coords.
 668    * @param[in] lineHeight The line height for the given position.
 669    *
 670    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
 671    * or moving the selection handles.
 672    */
 673   void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
 674
 675   /**
 676    * @brief Scrolls the text to make the cursor visible.
 677    *
 678    * This method is called after deleting text.
 679    */
 680   void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
 681
 682 private:
 683   // Declared private and left undefined to avoid copies.
 684   Impl( const Impl& );
 685   // Declared private and left undefined to avoid copies.
 686   Impl& operator=( const Impl& );
 687
 688 public:
 689
 690   ControlInterface* mControlInterface;     ///< Reference to the text controller.
 691   EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
 692   ModelPtr mModel;                         ///< Pointer to the text's model.
 693   FontDefaults* mFontDefaults;             ///< Avoid allocating this when the user does not specify a font.
 694   UnderlineDefaults* mUnderlineDefaults;   ///< Avoid allocating this when the user does not specify underline parameters.
 695   ShadowDefaults* mShadowDefaults;         ///< Avoid allocating this when the user does not specify shadow parameters.
 696   EmbossDefaults* mEmbossDefaults;         ///< Avoid allocating this when the user does not specify emboss parameters.
 697   OutlineDefaults* mOutlineDefaults;       ///< Avoid allocating this when the user does not specify outline parameters.
 698   EventData* mEventData;                   ///< Avoid allocating everything for text input until EnableTextInput().
 699   TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
 700   Clipboard mClipboard;                    ///< Handle to the system clipboard
 701   View mView;                              ///< The view interface to the rendering back-end.
 702   MetricsPtr mMetrics;                     ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
 703   Layout::Engine mLayoutEngine;            ///< The layout engine.
 704   Vector<ModifyEvent> mModifyEvents;       ///< Temporary stores the text set until the next relayout.
 705   Vector4 mTextColor;                      ///< The regular text color
 706   TextUpdateInfo mTextUpdateInfo;          ///< Info of the characters updated.
 707   OperationsMask mOperationsPending;       ///< Operations pending to be done to layout the text.
 708   Length mMaximumNumberOfCharacters;       ///< Maximum number of characters that can be inserted.
 709
 710   bool mRecalculateNaturalSize:1;          ///< Whether the natural size needs to be recalculated.
 711   bool mMarkupProcessorEnabled:1;          ///< Whether the mark-up procesor is enabled.
 712   bool mClipboardHideEnabled:1;            ///< Whether the ClipboardHide function work or not
 713   bool mIsAutoScrollEnabled:1;             ///< Whether auto text scrolling is enabled.
 714   CharacterDirection mAutoScrollDirectionRTL:1;  ///< Direction of auto scrolling, true if rtl
 715
 716 };
 717
 718 } // namespace Text
 719
 720 } // namespace Toolkit
 721
 722 } // namespace Dali
 723
 724 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H