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