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   Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
 120
 121   InputStyle         mInputStyle;              ///< The style to be set to the new inputed text.
 122
 123   State              mPreviousState;           ///< Stores the current state before it's updated with the new one.
 124   State              mState;                   ///< Selection mode, edit mode etc.
 125
 126   CharacterIndex     mPrimaryCursorPosition;   ///< Index into logical model for primary cursor.
 127   CharacterIndex     mLeftSelectionPosition;   ///< Index into logical model for left selection handle.
 128   CharacterIndex     mRightSelectionPosition;  ///< Index into logical model for right selection handle.
 129
 130   CharacterIndex     mPreEditStartPosition;    ///< Used to remove the pre-edit text if necessary.
 131   Length             mPreEditLength;           ///< Used to remove the pre-edit text if necessary.
 132
 133   float              mCursorHookPositionX;     ///< Used to move the cursor with the keys or when scrolling the text vertically with the handles.
 134
 135   bool mIsShowingPlaceholderText        : 1;   ///< True if the place-holder text is being displayed.
 136   bool mPreEditFlag                     : 1;   ///< True if the model contains text in pre-edit state.
 137   bool mDecoratorUpdated                : 1;   ///< True if the decorator was updated during event processing.
 138   bool mCursorBlinkEnabled              : 1;   ///< True if cursor should blink when active.
 139   bool mGrabHandleEnabled               : 1;   ///< True if grab handle is enabled.
 140   bool mGrabHandlePopupEnabled          : 1;   ///< True if the grab handle popu-up should be shown.
 141   bool mSelectionEnabled                : 1;   ///< True if selection handles, highlight etc. are enabled.
 142   bool mUpdateCursorHookPosition        : 1;   ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
 143   bool mUpdateCursorPosition            : 1;   ///< True if the visual position of the cursor must be recalculated.
 144   bool mUpdateGrabHandlePosition        : 1;   ///< True if the visual position of the grab handle must be recalculated.
 145   bool mUpdateLeftSelectionPosition     : 1;   ///< True if the visual position of the left selection handle must be recalculated.
 146   bool mUpdateRightSelectionPosition    : 1;   ///< True if the visual position of the right selection handle must be recalculated.
 147   bool mIsLeftHandleSelected            : 1;   ///< Whether is the left handle the one which is selected.
 148   bool mUpdateHighlightBox              : 1;   ///< True if the text selection high light box must be updated.
 149   bool mScrollAfterUpdatePosition       : 1;   ///< Whether to scroll after the cursor position is updated.
 150   bool mScrollAfterDelete               : 1;   ///< Whether to scroll after delete characters.
 151   bool mAllTextSelected                 : 1;   ///< True if the selection handles are selecting all the text.
 152   bool mUpdateInputStyle                : 1;   ///< Whether to update the input style after moving the cursor.
 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     mLogicalModel(),
 293     mVisualModel(),
 294     mFontDefaults( NULL ),
 295     mUnderlineDefaults( NULL ),
 296     mShadowDefaults( NULL ),
 297     mEmbossDefaults( NULL ),
 298     mOutlineDefaults( NULL ),
 299     mEventData( NULL ),
 300     mFontClient(),
 301     mClipboard(),
 302     mView(),
 303     mMetrics(),
 304     mLayoutEngine(),
 305     mModifyEvents(),
 306     mTextColor( Color::BLACK ),
 307     mScrollPosition(),
 308     mTextUpdateInfo(),
 309     mOperationsPending( NO_OPERATION ),
 310     mMaximumNumberOfCharacters( 50u ),
 311     mRecalculateNaturalSize( true ),
 312     mMarkupProcessorEnabled( false ),
 313     mClipboardHideEnabled( true ),
 314     mIsAutoScrollEnabled( false ),
 315     mAutoScrollDirectionRTL( false )
 316   {
 317     mLogicalModel = LogicalModel::New();
 318     mVisualModel  = VisualModel::New();
 319
 320     mFontClient = TextAbstraction::FontClient::Get();
 321     mClipboard = Clipboard::Get();
 322
 323     mView.SetVisualModel( mVisualModel );
 324
 325     // Use this to access FontClient i.e. to get down-scaled Emoji metrics.
 326     mMetrics = Metrics::New( mFontClient );
 327     mLayoutEngine.SetMetrics( mMetrics );
 328
 329     // Set the text properties to default
 330     mVisualModel->SetUnderlineEnabled( false );
 331     mVisualModel->SetUnderlineHeight( 0.0f );
 332   }
 333
 334   ~Impl()
 335   {
 336     delete mFontDefaults;
 337     delete mUnderlineDefaults;
 338     delete mShadowDefaults;
 339     delete mEmbossDefaults;
 340     delete mOutlineDefaults;
 341     delete mEventData;
 342   }
 343
 344   // Text Controller Implementation.
 345
 346   /**
 347    * @copydoc Text::Controller::RequestRelayout()
 348    */
 349   void RequestRelayout();
 350
 351   /**
 352    * @brief Request a relayout using the ControlInterface.
 353    */
 354   void QueueModifyEvent( ModifyEvent::Type type )
 355   {
 356     if( ModifyEvent::TEXT_REPLACED == type)
 357     {
 358       // Cancel previously queued inserts etc.
 359       mModifyEvents.Clear();
 360     }
 361
 362     ModifyEvent event;
 363     event.type = type;
 364     mModifyEvents.PushBack( event );
 365
 366     // The event will be processed during relayout
 367     RequestRelayout();
 368   }
 369
 370   /**
 371    * @brief Helper to move the cursor, grab handle etc.
 372    */
 373   bool ProcessInputEvents();
 374
 375   /**
 376    * @brief Helper to check whether any place-holder text is available.
 377    */
 378   bool IsPlaceholderAvailable() const
 379   {
 380     return ( mEventData &&
 381              ( !mEventData->mPlaceholderTextInactive.empty() ||
 382                !mEventData->mPlaceholderTextActive.empty() )
 383            );
 384   }
 385
 386   bool IsShowingPlaceholderText() const
 387   {
 388     return ( mEventData && mEventData->mIsShowingPlaceholderText );
 389   }
 390
 391   /**
 392    * @brief Helper to check whether active place-holder text is available.
 393    */
 394   bool IsFocusedPlaceholderAvailable() const
 395   {
 396     return ( mEventData && !mEventData->mPlaceholderTextActive.empty() );
 397   }
 398
 399   bool IsShowingRealText() const
 400   {
 401     return ( !IsShowingPlaceholderText() &&
 402              0u != mLogicalModel->mText.Count() );
 403   }
 404
 405   /**
 406    * @brief Called when placeholder-text is hidden
 407    */
 408   void PlaceholderCleared()
 409   {
 410     if( mEventData )
 411     {
 412       mEventData->mIsShowingPlaceholderText = false;
 413
 414       // Remove mPlaceholderTextColor
 415       mVisualModel->SetTextColor( mTextColor );
 416     }
 417   }
 418
 419   void ClearPreEditFlag()
 420   {
 421     if( mEventData )
 422     {
 423       mEventData->mPreEditFlag = false;
 424       mEventData->mPreEditStartPosition = 0;
 425       mEventData->mPreEditLength = 0;
 426     }
 427   }
 428
 429   void ResetImfManager()
 430   {
 431     if( mEventData )
 432     {
 433       // Reset incase we are in a pre-edit state.
 434       if( mEventData->mImfManager )
 435       {
 436         mEventData->mImfManager.Reset(); // Will trigger a message ( commit, get surrounding )
 437       }
 438
 439       ClearPreEditFlag();
 440     }
 441   }
 442
 443   /**
 444    * @brief Helper to notify IMF manager with surrounding text & cursor changes.
 445    */
 446   void NotifyImfManager();
 447
 448   /**
 449    * @brief Helper to notify IMF manager with multi line status.
 450    */
 451   void NotifyImfMultiLineStatus();
 452
 453   /**
 454    * @brief Retrieve the current cursor position.
 455    *
 456    * @return The cursor position.
 457    */
 458   CharacterIndex GetLogicalCursorPosition() const;
 459
 460   /**
 461    * @brief Retrieves the number of consecutive white spaces starting from the given @p index.
 462    *
 463    * @param[in] index The character index from where to count the number of consecutive white spaces.
 464    *
 465    * @return The number of consecutive white spaces.
 466    */
 467   Length GetNumberOfWhiteSpaces( CharacterIndex index ) const;
 468
 469   /**
 470    * @brief Retrieve any text previously set starting from the given @p index.
 471    *
 472    * @param[in] index The character index from where to retrieve the text.
 473    * @param[out] text A string of UTF-8 characters.
 474    *
 475    * @see Dali::Toolkit::Text::Controller::GetText()
 476    */
 477   void GetText( CharacterIndex index, std::string& text ) const;
 478
 479   bool IsClipboardEmpty()
 480   {
 481     bool result( mClipboard && mClipboard.NumberOfItems() );
 482     return !result; // If NumberOfItems greater than 0, return false
 483   }
 484
 485   bool IsClipboardVisible()
 486   {
 487     bool result( mClipboard && mClipboard.IsVisible() );
 488     return result;
 489   }
 490
 491   /**
 492    * @brief Calculates the start character index of the first paragraph to be updated and
 493    * the end character index of the last paragraph to be updated.
 494    *
 495    * @param[out] numberOfCharacters The number of characters to be updated.
 496    */
 497   void CalculateTextUpdateIndices( Length& numberOfCharacters );
 498
 499   /**
 500    * @brief Helper to clear completely the parts of the model specified by the given @p operations.
 501    *
 502    * @note It never clears the text stored in utf32.
 503    */
 504   void ClearFullModelData( OperationsMask operations );
 505
 506   /**
 507    * @brief Helper to clear completely the parts of the model related with the characters specified by the given @p operations.
 508    *
 509    * @note It never clears the text stored in utf32.
 510    *
 511    * @param[in] startIndex Index to the first character to be cleared.
 512    * @param[in] endIndex Index to the last character to be cleared.
 513    * @param[in] operations The operations required.
 514    */
 515   void ClearCharacterModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 516
 517   /**
 518    * @brief Helper to clear completely the parts of the model related with the glyphs specified by the given @p operations.
 519    *
 520    * @note It never clears the text stored in utf32.
 521    * @note Character indices are transformed to glyph indices.
 522    *
 523    * @param[in] startIndex Index to the first character to be cleared.
 524    * @param[in] endIndex Index to the last character to be cleared.
 525    * @param[in] operations The operations required.
 526    */
 527   void ClearGlyphModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 528
 529   /**
 530    * @brief Helper to clear the parts of the model specified by the given @p operations and from @p startIndex to @p endIndex.
 531    *
 532    * @note It never clears the text stored in utf32.
 533    *
 534    * @param[in] startIndex Index to the first character to be cleared.
 535    * @param[in] endIndex Index to the last character to be cleared.
 536    * @param[in] operations The operations required.
 537    */
 538   void ClearModelData( CharacterIndex startIndex, CharacterIndex endIndex, OperationsMask operations );
 539
 540   /**
 541    * @brief Updates the logical and visual models. Updates the style runs in the visual model when the text's styles changes.
 542    *
 543    * When text or style changes the model is set with some operations pending.
 544    * When i.e. the text's size or a relayout is required this method is called
 545    * with a given @p operationsRequired parameter. The operations required are
 546    * matched with the operations pending to perform the minimum number of operations.
 547    *
 548    * @param[in] operationsRequired The operations required.
 549    *
 550    * @return @e true if the model has been modified.
 551    */
 552   bool UpdateModel( OperationsMask operationsRequired );
 553
 554   /**
 555    * @brief Retreieves the default style.
 556    *
 557    * @param[out] inputStyle The default style.
 558    */
 559   void RetrieveDefaultInputStyle( InputStyle& inputStyle );
 560
 561   /**
 562    * @brief Retrieve the line height of the default font.
 563    */
 564   float GetDefaultFontLineHeight();
 565
 566   void OnCursorKeyEvent( const Event& event );
 567
 568   void OnTapEvent( const Event& event );
 569
 570   void OnPanEvent( const Event& event );
 571
 572   void OnLongPressEvent( const Event& event );
 573
 574   void OnHandleEvent( const Event& event );
 575
 576   void OnSelectEvent( const Event& event );
 577
 578   void OnSelectAllEvent();
 579
 580   /**
 581    * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
 582    *
 583    * @param[out] selectedText The selected text encoded in utf8.
 584    * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
 585    */
 586   void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
 587
 588   void ShowClipboard();
 589
 590   void HideClipboard();
 591
 592   void SetClipboardHideEnable(bool enable);
 593
 594   bool CopyStringToClipboard( std::string& source );
 595
 596   void SendSelectionToClipboard( bool deleteAfterSending );
 597
 598   void RequestGetTextFromClipboard();
 599
 600   void RepositionSelectionHandles();
 601   void RepositionSelectionHandles( float visualX, float visualY );
 602
 603   void SetPopupButtons();
 604
 605   void ChangeState( EventData::State newState );
 606
 607   /**
 608    * @brief Calculates the cursor's position for a given character index in the logical order.
 609    *
 610    * It retrieves as well the line's height and the cursor's height and
 611    * if there is a valid alternative cursor, its position and height.
 612    *
 613    * @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.
 614    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 615    */
 616   void GetCursorPosition( CharacterIndex logical,
 617                           CursorInfo& cursorInfo );
 618
 619   /**
 620    * @brief Calculates the new cursor index.
 621    *
 622    * It takes into account that in some scripts multiple characters can form a glyph and all of them
 623    * need to be jumped with one key event.
 624    *
 625    * @param[in] index The initial new index.
 626    *
 627    * @return The new cursor index.
 628    */
 629   CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
 630
 631   /**
 632    * @brief Updates the cursor position.
 633    *
 634    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
 635    * It sets the position of the secondary cursor if it's a valid one.
 636    * Sets which cursors are active.
 637    *
 638    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 639    *
 640    */
 641   void UpdateCursorPosition( const CursorInfo& cursorInfo );
 642
 643   /**
 644    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
 645    *
 646    * @param[in] handleType One of the selection handles.
 647    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 648    */
 649   void UpdateSelectionHandle( HandleType handleType,
 650                               const CursorInfo& cursorInfo );
 651
 652   /**
 653    * @biref Clamps the horizontal scrolling to get the control always filled with text.
 654    *
 655    * @param[in] layoutSize The size of the laid out text.
 656    */
 657   void ClampHorizontalScroll( const Vector2& layoutSize );
 658
 659   /**
 660    * @biref Clamps the vertical scrolling to get the control always filled with text.
 661    *
 662    * @param[in] layoutSize The size of the laid out text.
 663    */
 664   void ClampVerticalScroll( const Vector2& layoutSize );
 665
 666   /**
 667    * @brief Scrolls the text to make a position visible.
 668    *
 669    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
 670    *
 671    * @param[in] position A position in text coords.
 672    * @param[in] lineHeight The line height for the given position.
 673    *
 674    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
 675    * or moving the selection handles.
 676    */
 677   void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
 678
 679   /**
 680    * @brief Scrolls the text to make the cursor visible.
 681    *
 682    * This method is called after deleting text.
 683    */
 684   void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
 685
 686 private:
 687   // Declared private and left undefined to avoid copies.
 688   Impl( const Impl& );
 689   // Declared private and left undefined to avoid copies.
 690   Impl& operator=( const Impl& );
 691
 692 public:
 693
 694   ControlInterface* mControlInterface;     ///< Reference to the text controller.
 695   EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
 696   LogicalModelPtr mLogicalModel;           ///< Pointer to the logical model.
 697   VisualModelPtr  mVisualModel;            ///< Pointer to the visual model.
 698   FontDefaults* mFontDefaults;             ///< Avoid allocating this when the user does not specify a font.
 699   UnderlineDefaults* mUnderlineDefaults;   ///< Avoid allocating this when the user does not specify underline parameters.
 700   ShadowDefaults* mShadowDefaults;         ///< Avoid allocating this when the user does not specify shadow parameters.
 701   EmbossDefaults* mEmbossDefaults;         ///< Avoid allocating this when the user does not specify emboss parameters.
 702   OutlineDefaults* mOutlineDefaults;       ///< Avoid allocating this when the user does not specify outline parameters.
 703   EventData* mEventData;                   ///< Avoid allocating everything for text input until EnableTextInput().
 704   TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
 705   Clipboard mClipboard;                    ///< Handle to the system clipboard
 706   View mView;                              ///< The view interface to the rendering back-end.
 707   MetricsPtr mMetrics;                     ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
 708   LayoutEngine mLayoutEngine;              ///< The layout engine.
 709   Vector<ModifyEvent> mModifyEvents;       ///< Temporary stores the text set until the next relayout.
 710   Vector4 mTextColor;                      ///< The regular text color
 711   /**
 712    * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
 713    * Typically this will have a negative value with scrolling occurs.
 714    */
 715   Vector2 mScrollPosition;                 ///< The text is offset by this position when scrolling.
 716   TextUpdateInfo mTextUpdateInfo;          ///< Info of the characters updated.
 717   OperationsMask mOperationsPending;       ///< Operations pending to be done to layout the text.
 718   Length mMaximumNumberOfCharacters;       ///< Maximum number of characters that can be inserted.
 719
 720   bool mRecalculateNaturalSize:1;          ///< Whether the natural size needs to be recalculated.
 721   bool mMarkupProcessorEnabled:1;          ///< Whether the mark-up procesor is enabled.
 722   bool mClipboardHideEnabled:1;            ///< Whether the ClipboardHide function work or not
 723   bool mIsAutoScrollEnabled:1;             ///< Whether auto text scrolling is enabled.
 724   CharacterDirection mAutoScrollDirectionRTL:1;  ///< Direction of auto scrolling, true if rtl
 725
 726 };
 727
 728 } // namespace Text
 729
 730 } // namespace Toolkit
 731
 732 } // namespace Dali
 733
 734 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H