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