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