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