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) 2015 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/text-abstraction/font-client.h>
  23 #include <dali/devel-api/adaptor-framework/imf-manager.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
  27 #include <dali-toolkit/internal/text/logical-model-impl.h>
  28 #include <dali-toolkit/internal/text/text-controller.h>
  29 #include <dali-toolkit/internal/text/visual-model-impl.h>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 namespace Text
  38 {
  39
  40 struct Event
  41 {
  42   // Used to queue input events until DoRelayout()
  43   enum Type
  44   {
  45     CURSOR_KEY_EVENT,
  46     TAP_EVENT,
  47     PAN_EVENT,
  48     GRAB_HANDLE_EVENT,
  49     LEFT_SELECTION_HANDLE_EVENT,
  50     RIGHT_SELECTION_HANDLE_EVENT
  51   };
  52
  53   union Param
  54   {
  55     int mInt;
  56     unsigned int mUint;
  57     float mFloat;
  58   };
  59
  60   Event( Type eventType )
  61   : type( eventType )
  62   {
  63     p1.mInt = 0;
  64     p2.mInt = 0;
  65     p3.mInt = 0;
  66   }
  67
  68   Type type;
  69   Param p1;
  70   Param p2;
  71   Param p3;
  72 };
  73
  74 struct CursorInfo
  75 {
  76   CursorInfo()
  77   : primaryPosition(),
  78     secondaryPosition(),
  79     lineHeight( 0.f ),
  80     primaryCursorHeight( 0.f ),
  81     secondaryCursorHeight( 0.f ),
  82     isSecondaryCursor( false )
  83   {}
  84
  85   ~CursorInfo()
  86   {}
  87
  88   Vector2 primaryPosition;       ///< The primary cursor's position.
  89   Vector2 secondaryPosition;     ///< The secondary cursor's position.
  90   float   lineHeight;            ///< The height of the line where the cursor is placed.
  91   float   primaryCursorHeight;   ///< The primary cursor's height.
  92   float   secondaryCursorHeight; ///< The secondary cursor's height.
  93   bool    isSecondaryCursor;     ///< Whether the secondary cursor is valid.
  94 };
  95
  96 struct EventData
  97 {
  98   enum State
  99   {
 100     INACTIVE,
 101     SELECTING,
 102     EDITING,
 103     EDITING_WITH_POPUP
 104   };
 105
 106   EventData( DecoratorPtr decorator );
 107
 108   ~EventData();
 109
 110   DecoratorPtr       mDecorator;               ///< Pointer to the decorator
 111   std::string        mPlaceholderTextActive;   ///< The text to display when the TextField is empty with key-input focus
 112   std::string        mPlaceholderTextInactive; ///< The text to display when the TextField is empty and inactive
 113   Vector4            mPlaceholderTextColor;    ///< The in/active placeholder text color
 114
 115   /**
 116    * This is used to delay handling events until after the model has been updated.
 117    * The number of updates to the model is minimized to improve performance.
 118    */
 119   std::vector<Event> mEventQueue;              ///< The queue of touch events etc.
 120
 121   /**
 122    * 0,0 means that the top-left corner of the layout matches the top-left corner of the UI control.
 123    * Typically this will have a negative value with scrolling occurs.
 124    */
 125   Vector2            mScrollPosition;          ///< The text is offset by this position when scrolling.
 126
 127   State              mState;                   ///< Selection mode, edit mode etc.
 128
 129   CharacterIndex     mPrimaryCursorPosition;   ///< Index into logical model for primary cursor.
 130   CharacterIndex     mLeftSelectionPosition;   ///< Index into logical model for left selection handle.
 131   CharacterIndex     mRightSelectionPosition;  ///< Index into logical model for right selection handle.
 132
 133   CharacterIndex     mPreEditStartPosition;    ///< Used to remove the pre-edit text if necessary.
 134   Length             mPreEditLength;           ///< Used to remove the pre-edit text if necessary.
 135
 136   bool mIsShowingPlaceholderText           : 1;   ///< True if the place-holder text is being displayed.
 137   bool mPreEditFlag                        : 1;   ///< True if the model contains text in pre-edit state.
 138   bool mDecoratorUpdated                   : 1;   ///< True if the decorator was updated during event processing.
 139   bool mCursorBlinkEnabled                 : 1;   ///< True if cursor should blink when active.
 140   bool mGrabHandleEnabled                  : 1;   ///< True if grab handle is enabled.
 141   bool mGrabHandlePopupEnabled             : 1;   ///< True if the grab handle popu-up should be shown.
 142   bool mSelectionEnabled                   : 1;   ///< True if selection handles, highlight etc. are enabled.
 143   bool mHorizontalScrollingEnabled         : 1;   ///< True if horizontal scrolling is enabled.
 144   bool mVerticalScrollingEnabled           : 1;   ///< True if vertical scrolling is enabled.
 145   bool mUpdateCursorPosition               : 1;   ///< True if the visual position of the cursor must be recalculated.
 146   bool mUpdateLeftSelectionPosition        : 1;   ///< True if the visual position of the left selection handle must be recalculated.
 147   bool mUpdateRightSelectionPosition       : 1;   ///< True if the visual position of the right selection handle must be recalculated.
 148   bool mScrollAfterUpdateCursorPosition    : 1;   ///< Whether to scroll after the cursor position is updated.
 149 };
 150
 151 struct ModifyEvent
 152 {
 153   enum Type
 154   {
 155     TEXT_REPLACED,    ///< The entire text was replaced
 156     TEXT_INSERTED,    ///< Insert characters at the current cursor position
 157     TEXT_DELETED      ///< Characters were deleted
 158   };
 159
 160   Type type;
 161 };
 162
 163 struct FontDefaults
 164 {
 165   FontDefaults()
 166   : mDefaultPointSize(0.0f),
 167     mFontId(0u)
 168   {
 169   }
 170
 171   FontId GetFontId( TextAbstraction::FontClient& fontClient )
 172   {
 173     if( !mFontId )
 174     {
 175       Dali::TextAbstraction::PointSize26Dot6 pointSize = mDefaultPointSize*64;
 176       mFontId = fontClient.GetFontId( mDefaultFontFamily, mDefaultFontStyle, pointSize );
 177     }
 178
 179     return mFontId;
 180   }
 181
 182   std::string mDefaultFontFamily;
 183   std::string mDefaultFontStyle;
 184   float mDefaultPointSize;
 185   FontId mFontId;
 186 };
 187
 188 struct Controller::Impl
 189 {
 190   Impl( ControlInterface& controlInterface )
 191   : mControlInterface( controlInterface ),
 192     mLogicalModel(),
 193     mVisualModel(),
 194     mFontDefaults( NULL ),
 195     mEventData( NULL ),
 196     mFontClient(),
 197     mView(),
 198     mLayoutEngine(),
 199     mModifyEvents(),
 200     mControlSize(),
 201     mTextColor( Color::BLACK ),
 202     mAlignmentOffset(),
 203     mOperationsPending( NO_OPERATION ),
 204     mMaximumNumberOfCharacters( 50 ),
 205     mRecalculateNaturalSize( true )
 206   {
 207     mLogicalModel = LogicalModel::New();
 208     mVisualModel  = VisualModel::New();
 209
 210     mFontClient = TextAbstraction::FontClient::Get();
 211
 212     mView.SetVisualModel( mVisualModel );
 213
 214     // Set the text properties to default
 215     mVisualModel->SetUnderlineEnabled( false );
 216     mVisualModel->SetUnderlineHeight( 0.0f );
 217   }
 218
 219   ~Impl()
 220   {
 221     delete mEventData;
 222   }
 223
 224   /**
 225    * @brief Request a relayout using the ControlInterface.
 226    */
 227   void RequestRelayout();
 228
 229   /**
 230    * @brief Request a relayout using the ControlInterface.
 231    */
 232   void QueueModifyEvent( ModifyEvent::Type type )
 233   {
 234     ModifyEvent event;
 235     event.type = type;
 236     mModifyEvents.push_back( event );
 237
 238     // The event will be processed during relayout
 239     RequestRelayout();
 240   }
 241
 242   /**
 243    * @brief Helper to move the cursor, grab handle etc.
 244    */
 245   bool ProcessInputEvents();
 246
 247   /**
 248    * @brief Helper to check whether any place-holder text is available.
 249    */
 250   bool IsPlaceholderAvailable() const
 251   {
 252     return ( mEventData &&
 253              ( !mEventData->mPlaceholderTextInactive.empty() ||
 254                !mEventData->mPlaceholderTextActive.empty() )
 255            );
 256   }
 257
 258   bool IsShowingPlaceholderText() const
 259   {
 260     return ( mEventData && mEventData->mIsShowingPlaceholderText );
 261   }
 262
 263   /**
 264    * @brief Called when placeholder-text is hidden
 265    */
 266   void PlaceholderCleared()
 267   {
 268     if( mEventData )
 269     {
 270       mEventData->mIsShowingPlaceholderText = false;
 271
 272       // Remove mPlaceholderTextColor
 273       mVisualModel->SetTextColor( mTextColor );
 274     }
 275   }
 276
 277   void ClearPreEditFlag()
 278   {
 279     if( mEventData )
 280     {
 281       mEventData->mPreEditFlag = false;
 282       mEventData->mPreEditStartPosition = 0;
 283       mEventData->mPreEditLength = 0;
 284     }
 285   }
 286
 287   void ResetImfManager()
 288   {
 289     // Reset incase we are in a pre-edit state.
 290     ImfManager imfManager = ImfManager::Get();
 291     if ( imfManager )
 292     {
 293       imfManager.Reset(); // Will trigger a commit message
 294     }
 295
 296     ClearPreEditFlag();
 297   }
 298
 299   void UpdateModel( OperationsMask operationsRequired );
 300
 301   /**
 302    * @brief Retrieve the default fonts.
 303    *
 304    * @param[out] fonts The default font family, style and point sizes.
 305    * @param[in] numberOfCharacters The number of characters in the logical model.
 306    */
 307   void GetDefaultFonts( Dali::Vector<FontRun>& fonts, Length numberOfCharacters );
 308
 309   void OnCursorKeyEvent( const Event& event );
 310
 311   void OnTapEvent( const Event& event );
 312
 313   void OnPanEvent( const Event& event );
 314
 315   void OnHandleEvent( const Event& event );
 316
 317   void RepositionSelectionHandles( float visualX, float visualY );
 318
 319   void ChangeState( EventData::State newState );
 320
 321   LineIndex GetClosestLine( float y ) const;
 322
 323   /**
 324    * @brief Retrieves the cursor's logical position for a given touch point x,y
 325    *
 326    * @param[in] visualX The touch point x.
 327    * @param[in] visualY The touch point y.
 328    *
 329    * @return 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.
 330    */
 331   CharacterIndex GetClosestCursorIndex( float visualX,
 332                                         float visualY );
 333
 334   /**
 335    * @brief Calculates the cursor's position for a given character index in the logical order.
 336    *
 337    * It retrieves as well the line's height and the cursor's height and
 338    * if there is a valid alternative cursor, its position and height.
 339    *
 340    * @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.
 341    * @param[out] cursorInfo The line's height, the cursor's height, the cursor's position and whether there is an alternative cursor.
 342    */
 343   void GetCursorPosition( CharacterIndex logical,
 344                           CursorInfo& cursorInfo );
 345
 346   /**
 347    * @brief Calculates the new cursor index.
 348    *
 349    * It takes into account that in some scripts multiple characters can form a glyph and all of them
 350    * need to be jumped with one key event.
 351    *
 352    * @param[in] index The initial new index.
 353    *
 354    * @return The new cursor index.
 355    */
 356   CharacterIndex CalculateNewCursorIndex( CharacterIndex index ) const;
 357
 358   /**
 359    * @brief Updates the cursor position.
 360    *
 361    * Retrieves the x,y position of the cursor logical position and sets it into the decorator.
 362    * It sets the position of the secondary cursor if it's a valid one.
 363    * Sets which cursors are active.
 364    */
 365   void UpdateCursorPosition();
 366
 367   /**
 368    * @brief Updates the position of the given selection handle.
 369    *
 370    * @param[in] handleType One of the selection handles.
 371    */
 372   void UpdateSelectionHandle( HandleType handleType );
 373
 374   /**
 375    * @biref Clamps the horizontal scrolling to get the control always filled with text.
 376    *
 377    * @param[in] actualSize The size of the laid out text.
 378    */
 379   void ClampHorizontalScroll( const Vector2& actualSize );
 380
 381   /**
 382    * @biref Clamps the vertical scrolling to get the control always filled with text.
 383    *
 384    * @param[in] actualSize The size of the laid out text.
 385    */
 386   void ClampVerticalScroll( const Vector2& actualSize );
 387
 388   /**
 389    * @brief Scrolls the text to make the cursor visible.
 390    *
 391    * This method is called after inserting, deleting or moving the cursor with the keypad.
 392    */
 393   void ScrollToMakeCursorVisible();
 394
 395   ControlInterface& mControlInterface;     ///< Reference to the text controller.
 396   LogicalModelPtr mLogicalModel;           ///< Pointer to the logical model.
 397   VisualModelPtr  mVisualModel;            ///< Pointer to the visual model.
 398   FontDefaults* mFontDefaults;             ///< Avoid allocating this when the user does not specify a font.
 399   EventData* mEventData;                   ///< Avoid allocating everything for text input until EnableTextInput().
 400   TextAbstraction::FontClient mFontClient; ///< Handle to the font client.
 401   View mView;                              ///< The view interface to the rendering back-end.
 402   LayoutEngine mLayoutEngine;              ///< The layout engine.
 403   std::vector<ModifyEvent> mModifyEvents;  ///< Temporary stores the text set until the next relayout.
 404   Size mControlSize;                       ///< The size of the control.
 405   Vector4 mTextColor;                      ///< The regular text color
 406   Vector2 mAlignmentOffset;                ///< Vertical and horizontal offset of the whole text inside the control due to alignment.
 407   OperationsMask mOperationsPending;       ///< Operations pending to be done to layout the text.
 408   Length mMaximumNumberOfCharacters;       ///< Maximum number of characters that can be inserted.
 409   bool mRecalculateNaturalSize:1;          ///< Whether the natural size needs to be recalculated.
 410 };
 411
 412 } // namespace Text
 413
 414 } // namespace Toolkit
 415
 416 } // namespace Dali
 417
 418 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__