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 const float DEFAULT_FONT_SIZE_SCALE = 1.f;
  47
  48 //Forward declarations
  49 struct CursorInfo;
  50 struct FontDefaults;
  51 struct ControllerImplEventHandler;
  52
  53 class SelectableControlInterface;
  54
  55 struct Event
  56 {
  57   // Used to queue input events until DoRelayout()
  58   enum Type
  59   {
  60     CURSOR_KEY_EVENT,
  61     TAP_EVENT,
  62     PAN_EVENT,
  63     LONG_PRESS_EVENT,
  64     GRAB_HANDLE_EVENT,
  65     LEFT_SELECTION_HANDLE_EVENT,
  66     RIGHT_SELECTION_HANDLE_EVENT,
  67     SELECT,
  68     SELECT_ALL,
  69     SELECT_NONE,
  70   };
  71
  72   union Param
  73   {
  74     int mInt;
  75     unsigned int mUint;
  76     float mFloat;
  77     bool mBool;
  78   };
  79
  80   Event( Type eventType )
  81   : type( eventType )
  82   {
  83     p1.mInt = 0;
  84     p2.mInt = 0;
  85     p3.mInt = 0;
  86   }
  87
  88   Type type;
  89   Param p1;
  90   Param p2;
  91   Param p3;
  92 };
  93
  94 struct EventData
  95 {
  96   enum State
  97   {
  98     INACTIVE,
  99     INTERRUPTED,
 100     SELECTING,
 101     EDITING,
 102     EDITING_WITH_POPUP,
 103     EDITING_WITH_GRAB_HANDLE,
 104     EDITING_WITH_PASTE_POPUP,
 105     GRAB_HANDLE_PANNING,
 106     SELECTION_HANDLE_PANNING,
 107     TEXT_PANNING
 108   };
 109
 110   EventData( DecoratorPtr decorator, InputMethodContext& inputMethodContext );
 111
 112   ~EventData();
 113
 114   static bool IsEditingState( State stateToCheck )
 115   {
 116     return ( stateToCheck == EDITING || stateToCheck == EDITING_WITH_POPUP || stateToCheck == EDITING_WITH_GRAB_HANDLE || stateToCheck == EDITING_WITH_PASTE_POPUP );
 117   }
 118
 119   DecoratorPtr       mDecorator;               ///< Pointer to the decorator.
 120   InputMethodContext mInputMethodContext;      ///< The Input Method Framework Manager.
 121   FontDefaults*      mPlaceholderFont;         ///< The placeholder default font.
 122   std::string        mPlaceholderTextActive;   ///< The text to display when the TextField is empty with key-input focus.
 123   std::string        mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive.
 124   Vector4            mPlaceholderTextColor;    ///< The in/active placeholder text color.
 125
 126   /**
 127    * This is used to delay handling events until after the model has been updated.
 128    * The number of updates to the model is minimized to improve performance.
 129    */
 130   std::vector<Event> mEventQueue;              ///< The queue of touch events etc.
 131
 132   Vector<InputStyle::Mask> mInputStyleChangedQueue; ///< Queue of changes in the input style. Used to emit the signal in the iddle callback.
 133
 134   InputStyle         mInputStyle;              ///< The style to be set to the new inputed text.
 135
 136   State              mPreviousState;           ///< Stores the current state before it's updated with the new one.
 137   State              mState;                   ///< Selection mode, edit mode etc.
 138
 139   CharacterIndex     mPrimaryCursorPosition;   ///< Index into logical model for primary cursor.
 140   CharacterIndex     mLeftSelectionPosition;   ///< Index into logical model for left selection handle.
 141   CharacterIndex     mRightSelectionPosition;  ///< Index into logical model for right selection handle.
 142
 143   CharacterIndex     mPreEditStartPosition;    ///< Used to remove the pre-edit text if necessary.
 144   Length             mPreEditLength;           ///< Used to remove 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 mDecoratorUpdated                : 1;   ///< True if the decorator was updated during event processing.
 154   bool mCursorBlinkEnabled              : 1;   ///< True if cursor should blink when active.
 155   bool mGrabHandleEnabled               : 1;   ///< True if grab handle is enabled.
 156   bool mGrabHandlePopupEnabled          : 1;   ///< True if the grab handle popu-up should be shown.
 157   bool mSelectionEnabled                : 1;   ///< True if selection handles, highlight etc. are enabled.
 158   bool mUpdateCursorHookPosition        : 1;   ///< True if the cursor hook position must be updated. Used to move the cursor with the keys 'up' and 'down'.
 159   bool mUpdateCursorPosition            : 1;   ///< True if the visual position of the cursor must be recalculated.
 160   bool mUpdateGrabHandlePosition        : 1;   ///< True if the visual position of the grab handle must be recalculated.
 161   bool mUpdateLeftSelectionPosition     : 1;   ///< True if the visual position of the left selection handle must be recalculated.
 162   bool mUpdateRightSelectionPosition    : 1;   ///< True if the visual position of the right selection handle must be recalculated.
 163   bool mIsLeftHandleSelected            : 1;   ///< Whether is the left handle the one which is selected.
 164   bool mIsRightHandleSelected           : 1;   ///< Whether is the right handle the one which is selected.
 165   bool mUpdateHighlightBox              : 1;   ///< True if the text selection high light box must be updated.
 166   bool mScrollAfterUpdatePosition       : 1;   ///< Whether to scroll after the cursor position is updated.
 167   bool mScrollAfterDelete               : 1;   ///< Whether to scroll after delete characters.
 168   bool mAllTextSelected                 : 1;   ///< True if the selection handles are selecting all the text.
 169   bool mUpdateInputStyle                : 1;   ///< Whether to update the input style after moving the cursor.
 170   bool mPasswordInput                   : 1;   ///< True if password input is enabled.
 171   bool mCheckScrollAmount               : 1;   ///< Whether to check scrolled amount after updating the position
 172   bool mIsPlaceholderPixelSize          : 1;   ///< True if the placeholder font size is set as pixel size.
 173   bool mIsPlaceholderElideEnabled       : 1;   ///< True if the placeholder text's elide is enabled.
 174   bool mPlaceholderEllipsisFlag         : 1;   ///< True if the text controller sets the placeholder ellipsis.
 175   bool mShiftSelectionFlag              : 1;   ///< True if the text selection using Shift key is enabled.
 176   bool mUpdateAlignment                 : 1;   ///< True if the whole text needs to be full aligned..
 177   bool mEditingEnabled                   : 1;   ///< True if the editing is enabled, false otherwise.
 178 };
 179
 180 struct ModifyEvent
 181 {
 182   enum Type
 183   {
 184     TEXT_REPLACED,    ///< The entire text was replaced
 185     TEXT_INSERTED,    ///< Insert characters at the current cursor position
 186     TEXT_DELETED      ///< Characters were deleted
 187   };
 188
 189   Type type;
 190 };
 191
 192 struct FontDefaults
 193 {
 194   FontDefaults()
 195   : mFontDescription(),
 196     mDefaultPointSize( 0.f ),
 197     mFitPointSize( 0.f ),
 198     mFontId( 0u ),
 199     familyDefined( false ),
 200     weightDefined( false ),
 201     widthDefined( false ),
 202     slantDefined( false ),
 203     sizeDefined( false )
 204   {
 205     // Initially use the default platform font
 206     TextAbstraction::FontClient fontClient = TextAbstraction::FontClient::Get();
 207     fontClient.GetDefaultPlatformFontDescription( mFontDescription );
 208   }
 209
 210   FontId GetFontId( TextAbstraction::FontClient& fontClient, float fontPointSize )
 211   {
 212     if( !mFontId )
 213     {
 214       const PointSize26Dot6 pointSize = static_cast<PointSize26Dot6>( fontPointSize * 64.f );
 215       mFontId = fontClient.GetFontId( mFontDescription, pointSize );
 216     }
 217
 218     return mFontId;
 219   }
 220
 221   TextAbstraction::FontDescription mFontDescription;  ///< The default font's description.
 222   float                            mDefaultPointSize; ///< The default font's point size.
 223   float                            mFitPointSize; ///< The fit font's point size.
 224   FontId                           mFontId;           ///< The font's id of the default font.
 225   bool familyDefined:1; ///< Whether the default font's family name is defined.
 226   bool weightDefined:1; ///< Whether the default font's weight is defined.
 227   bool  widthDefined:1; ///< Whether the default font's width is defined.
 228   bool  slantDefined:1; ///< Whether the default font's slant is defined.
 229   bool   sizeDefined:1; ///< Whether the default font's point size is defined.
 230 };
 231
 232 /**
 233  * @brief Stores indices used to update the text.
 234  * Stores the character index where the text is updated and the number of characters removed and added.
 235  * Stores as well indices to the first and the last paragraphs to be updated.
 236  */
 237 struct TextUpdateInfo
 238 {
 239   TextUpdateInfo()
 240   : mCharacterIndex( 0u ),
 241     mNumberOfCharactersToRemove( 0u ),
 242     mNumberOfCharactersToAdd( 0u ),
 243     mPreviousNumberOfCharacters( 0u ),
 244     mParagraphCharacterIndex( 0u ),
 245     mRequestedNumberOfCharacters( 0u ),
 246     mStartGlyphIndex( 0u ),
 247     mStartLineIndex( 0u ),
 248     mEstimatedNumberOfLines( 0u ),
 249     mClearAll( true ),
 250     mFullRelayoutNeeded( true ),
 251     mIsLastCharacterNewParagraph( false )
 252   {}
 253
 254   ~TextUpdateInfo()
 255   {}
 256
 257   CharacterIndex    mCharacterIndex;                ///< Index to the first character to be updated.
 258   Length            mNumberOfCharactersToRemove;    ///< The number of characters to be removed.
 259   Length            mNumberOfCharactersToAdd;       ///< The number of characters to be added.
 260   Length            mPreviousNumberOfCharacters;    ///< The number of characters before the text update.
 261
 262   CharacterIndex    mParagraphCharacterIndex;       ///< Index of the first character of the first paragraph to be updated.
 263   Length            mRequestedNumberOfCharacters;   ///< The requested number of characters.
 264   GlyphIndex        mStartGlyphIndex;
 265   LineIndex         mStartLineIndex;
 266   Length            mEstimatedNumberOfLines;         ///< The estimated number of lines. Used to avoid reallocations when layouting.
 267
 268   bool              mClearAll:1;                    ///< Whether the whole text is cleared. i.e. when the text is reset.
 269   bool              mFullRelayoutNeeded:1;          ///< Whether a full re-layout is needed. i.e. when a new size is set to the text control.
 270   bool              mIsLastCharacterNewParagraph:1; ///< Whether the last character is a new paragraph character.
 271
 272   void Clear()
 273   {
 274     // Clear all info except the mPreviousNumberOfCharacters member.
 275     mCharacterIndex = static_cast<CharacterIndex>( -1 );
 276     mNumberOfCharactersToRemove = 0u;
 277     mNumberOfCharactersToAdd = 0u;
 278     mParagraphCharacterIndex = 0u;
 279     mRequestedNumberOfCharacters = 0u;
 280     mStartGlyphIndex = 0u;
 281     mStartLineIndex = 0u;
 282     mEstimatedNumberOfLines = 0u;
 283     mClearAll = false;
 284     mFullRelayoutNeeded = false;
 285     mIsLastCharacterNewParagraph = false;
 286   }
 287 };
 288
 289 struct UnderlineDefaults
 290 {
 291   std::string properties;
 292   // TODO: complete with underline parameters.
 293 };
 294
 295 struct ShadowDefaults
 296 {
 297   std::string properties;
 298   // TODO: complete with shadow parameters.
 299 };
 300
 301 struct EmbossDefaults
 302 {
 303   std::string properties;
 304   // TODO: complete with emboss parameters.
 305 };
 306
 307 struct OutlineDefaults
 308 {
 309   std::string properties;
 310   // TODO: complete with outline parameters.
 311 };
 312
 313 struct Controller::Impl
 314 {
 315   Impl( ControlInterface* controlInterface,
 316         EditableControlInterface* editableControlInterface,
 317         SelectableControlInterface* selectableControlInterface )
 318   : mControlInterface( controlInterface ),
 319     mEditableControlInterface( editableControlInterface ),
 320     mSelectableControlInterface( selectableControlInterface ),
 321     mModel(),
 322     mFontDefaults( NULL ),
 323     mUnderlineDefaults( NULL ),
 324     mShadowDefaults( NULL ),
 325     mEmbossDefaults( NULL ),
 326     mOutlineDefaults( NULL ),
 327     mEventData( NULL ),
 328     mFontClient(),
 329     mClipboard(),
 330     mView(),
 331     mMetrics(),
 332     mModifyEvents(),
 333     mTextColor( Color::BLACK ),
 334     mTextUpdateInfo(),
 335     mOperationsPending( NO_OPERATION ),
 336     mMaximumNumberOfCharacters( 50u ),
 337     mHiddenInput( NULL ),
 338     mRecalculateNaturalSize( true ),
 339     mMarkupProcessorEnabled( false ),
 340     mClipboardHideEnabled( true ),
 341     mIsAutoScrollEnabled( false ),
 342     mUpdateTextDirection( true ),
 343     mIsTextDirectionRTL( false ),
 344     mUnderlineSetByString( false ),
 345     mShadowSetByString( false ),
 346     mOutlineSetByString( false ),
 347     mFontStyleSetByString( false ),
 348     mShouldClearFocusOnEscape( true ),
 349     mLayoutDirection( LayoutDirection::LEFT_TO_RIGHT ),
 350     mTextFitMinSize( DEFAULT_TEXTFIT_MIN ),
 351     mTextFitMaxSize( DEFAULT_TEXTFIT_MAX ),
 352     mTextFitStepSize( DEFAULT_TEXTFIT_STEP ),
 353     mTextFitEnabled( false ),
 354     mFontSizeScale( DEFAULT_FONT_SIZE_SCALE )
 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::Controller::GetPrimaryCursorPosition()
 635    */
 636   CharacterIndex GetPrimaryCursorPosition() const;
 637
 638   /**
 639    * @copydoc Text::Controller::SetPrimaryCursorPosition()
 640    */
 641   bool SetPrimaryCursorPosition( CharacterIndex index );
 642
 643   /**
 644    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
 645    */
 646   void SetTextSelectionRange(const uint32_t *pStart, const uint32_t *pEndf);
 647
 648   /**
 649    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
 650    */
 651   Uint32Pair GetTextSelectionRange() const;
 652
 653   /**
 654    * @copydoc Text::EditableControlInterface::IsEditable()
 655    */
 656   bool IsEditable() const;
 657
 658   /**
 659    * @copydoc Text::EditableControlInterface::SetEditable()
 660    */
 661   void SetEditable( bool editable );
 662
 663   /**
 664    * @brief Retrieves the selected text. It removes the text if the @p deleteAfterRetrieval parameter is @e true.
 665    *
 666    * @param[out] selectedText The selected text encoded in utf8.
 667    * @param[in] deleteAfterRetrieval Whether the text should be deleted after retrieval.
 668    */
 669   void RetrieveSelection( std::string& selectedText, bool deleteAfterRetrieval );
 670
 671   void SetSelection( int start, int end );
 672
 673   std::pair< int, int > GetSelectionIndexes() const;
 674
 675   void ShowClipboard();
 676
 677   void HideClipboard();
 678
 679   void SetClipboardHideEnable(bool enable);
 680
 681   bool CopyStringToClipboard( const std::string& source );
 682
 683   void SendSelectionToClipboard( bool deleteAfterSending );
 684
 685   void RequestGetTextFromClipboard();
 686
 687   void RepositionSelectionHandles();
 688   void RepositionSelectionHandles( float visualX, float visualY, Controller::NoTextTap::Action action );
 689
 690   void SetPopupButtons();
 691
 692   void ChangeState( EventData::State newState );
 693
 694   /**
 695    * @brief Calculates the cursor's position for a given character index in the logical order.
 696    *
 697    * It retrieves as well the line's height and the cursor's height and
 698    * if there is a valid alternative cursor, its position and height.
 699    *
 700    * @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.
 701    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 702    */
 703   void GetCursorPosition( CharacterIndex logical,
 704                           CursorInfo& cursorInfo );
 705
 706   /**
 707    * @brief Calculates the new cursor index.
 708    *
 709    * It takes into account that in some scripts multiple characters can form a glyph and all of them
 710    * need to be jumped with one key event.
 711    *
 712    * @param[in] index The initial new index.
 713    *
 714    * @return The new cursor index.
 715    */
 716   CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
 717
 718   /**
 719    * @brief Updates the cursor position.
 720    *
 721    * Sets the cursor's position into the decorator. It transforms the cursor's position into decorator's coords.
 722    * It sets the position of the secondary cursor if it's a valid one.
 723    * Sets which cursors are active.
 724    *
 725    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 726    *
 727    */
 728   void UpdateCursorPosition( const CursorInfo& cursorInfo );
 729
 730   /**
 731    * @brief Updates the position of the given selection handle. It transforms the handle's position into decorator's coords.
 732    *
 733    * @param[in] handleType One of the selection handles.
 734    * @param[in] cursorInfo Contains the selection handle position in Actor's coords.
 735    */
 736   void UpdateSelectionHandle( HandleType handleType,
 737                               const CursorInfo& cursorInfo );
 738
 739   /**
 740    * @biref Clamps the horizontal scrolling to get the control always filled with text.
 741    *
 742    * @param[in] layoutSize The size of the laid out text.
 743    */
 744   void ClampHorizontalScroll( const Vector2& layoutSize );
 745
 746   /**
 747    * @biref Clamps the vertical scrolling to get the control always filled with text.
 748    *
 749    * @param[in] layoutSize The size of the laid out text.
 750    */
 751   void ClampVerticalScroll( const Vector2& layoutSize );
 752
 753   /**
 754    * @brief Scrolls the text to make a position visible.
 755    *
 756    * @pre mEventData must not be NULL. (there is a text-input or selection capabilities).
 757    *
 758    * @param[in] position A position in text coords.
 759    * @param[in] lineHeight The line height for the given position.
 760    *
 761    * This method is called after inserting text, moving the cursor with the grab handle or the keypad,
 762    * or moving the selection handles.
 763    */
 764   void ScrollToMakePositionVisible( const Vector2& position, float lineHeight );
 765
 766   /**
 767    * @brief Scrolls the text to make the cursor visible.
 768    *
 769    * This method is called after deleting text.
 770    */
 771   void ScrollTextToMatchCursor( const CursorInfo& cursorInfo );
 772
 773   /**
 774    * @brief Scrolls the text to make primary cursor visible.
 775    */
 776   void ScrollTextToMatchCursor( );
 777
 778   /**
 779    * @brief Create an actor that renders the text background color
 780    *
 781    * @return the created actor or an empty handle if no background color needs to be rendered.
 782    */
 783   Actor CreateBackgroundActor();
 784
 785 public:
 786
 787   /**
 788    * @brief Gets implementation from the controller handle.
 789    * @param controller The text controller
 790    * @return The implementation of the Controller
 791    */
 792   static Impl& GetImplementation( Text::Controller& controller )
 793   {
 794     return *controller.mImpl;
 795   }
 796
 797 private:
 798   // Declared private and left undefined to avoid copies.
 799   Impl( const Impl& );
 800   // Declared private and left undefined to avoid copies.
 801   Impl& operator=( const Impl& );
 802
 803 public:
 804
 805   ControlInterface* mControlInterface;     ///< Reference to the text controller.
 806   EditableControlInterface* mEditableControlInterface; ///< Reference to the editable text controller.
 807   SelectableControlInterface* mSelectableControlInterface; ///< Reference to the selectable text controller.
 808   ModelPtr mModel;                         ///< Pointer to the text's model.
 809   FontDefaults* mFontDefaults;             ///< Avoid allocating this when the user does not specify a font.
 810   UnderlineDefaults* mUnderlineDefaults;   ///< Avoid allocating this when the user does not specify underline parameters.
 811   ShadowDefaults* mShadowDefaults;         ///< Avoid allocating this when the user does not specify shadow parameters.
 812   EmbossDefaults* mEmbossDefaults;         ///< Avoid allocating this when the user does not specify emboss parameters.
 813   OutlineDefaults* mOutlineDefaults;       ///< Avoid allocating this when the user does not specify outline parameters.
 814   EventData* mEventData;                   ///< Avoid allocating everything for text input until EnableTextInput().
 815   TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
 816   Clipboard mClipboard;                    ///< Handle to the system clipboard
 817   View mView;                              ///< The view interface to the rendering back-end.
 818   MetricsPtr mMetrics;                     ///< A wrapper around FontClient used to get metrics & potentially down-scaled Emoji metrics.
 819   Layout::Engine mLayoutEngine;            ///< The layout engine.
 820   Vector<ModifyEvent> mModifyEvents;       ///< Temporary stores the text set until the next relayout.
 821   Vector4 mTextColor;                      ///< The regular text color
 822   TextUpdateInfo mTextUpdateInfo;          ///< Info of the characters updated.
 823   OperationsMask mOperationsPending;       ///< Operations pending to be done to layout the text.
 824   Length mMaximumNumberOfCharacters;       ///< Maximum number of characters that can be inserted.
 825   HiddenText* mHiddenInput;                ///< Avoid allocating this when the user does not specify hidden input mode.
 826   Vector2 mTextFitContentSize;             ///< Size of Text fit content
 827
 828   bool mRecalculateNaturalSize:1;          ///< Whether the natural size needs to be recalculated.
 829   bool mMarkupProcessorEnabled:1;          ///< Whether the mark-up procesor is enabled.
 830   bool mClipboardHideEnabled:1;            ///< Whether the ClipboardHide function work or not
 831   bool mIsAutoScrollEnabled:1;             ///< Whether auto text scrolling is enabled.
 832   bool mUpdateTextDirection:1;             ///< Whether the text direction needs to be updated.
 833   CharacterDirection mIsTextDirectionRTL:1;  ///< Whether the text direction is right to left or not
 834
 835   bool mUnderlineSetByString:1;            ///< Set when underline is set by string (legacy) instead of map
 836   bool mShadowSetByString:1;               ///< Set when shadow is set by string (legacy) instead of map
 837   bool mOutlineSetByString:1;              ///< Set when outline is set by string (legacy) instead of map
 838   bool mFontStyleSetByString:1;            ///< Set when font style is set by string (legacy) instead of map
 839   bool mShouldClearFocusOnEscape:1;        ///< Whether text control should clear key input focus
 840   LayoutDirection::Type mLayoutDirection;  ///< Current system language direction
 841
 842   Shader mShaderBackground;                ///< The shader for text background.
 843
 844   float mTextFitMinSize;                   ///< Minimum Font Size for text fit. Default 10
 845   float mTextFitMaxSize;                   ///< Maximum Font Size for text fit. Default 100
 846   float mTextFitStepSize;                  ///< Step Size for font intervalse. Default 1
 847   bool  mTextFitEnabled : 1;               ///< Whether the text's fit is enabled.
 848   float mFontSizeScale;                    ///< Scale value for Font Size. Default 1.0
 849
 850 private:
 851   friend ControllerImplEventHandler;
 852 };
 853
 854 } // namespace Text
 855
 856 } // namespace Toolkit
 857
 858 } // namespace Dali
 859
 860 #endif // DALI_TOOLKIT_TEXT_CONTROLLER_H