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