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