dali-toolkit/internal/text/text-controller-impl.h

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