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