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