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

   1 #ifndef __DALI_TOOLKIT_TEXT_CONTROLLER_H__
   2 #define __DALI_TOOLKIT_TEXT_CONTROLLER_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/adaptor-framework/imf-manager.h>
  23 #include <dali/public-api/events/gesture.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/devel-api/controls/text-controls/text-selection-popup-callback-interface.h>
  27 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  28 #include <dali-toolkit/internal/text/layouts/layout-engine.h>
  29 #include <dali-toolkit/internal/text/text-control-interface.h>
  30
  31 namespace Dali
  32 {
  33
  34 namespace Toolkit
  35 {
  36
  37 namespace Text
  38 {
  39
  40 class Controller;
  41 class View;
  42
  43 typedef IntrusivePtr<Controller> ControllerPtr;
  44 typedef Dali::Toolkit::Text::ControlInterface ControlInterface;
  45
  46 /**
  47  * @brief Different placeholder-text can be shown when the control is active/inactive.
  48  */
  49 enum PlaceholderType
  50 {
  51   PLACEHOLDER_TYPE_ACTIVE,
  52   PLACEHOLDER_TYPE_INACTIVE,
  53 };
  54
  55 /**
  56  * @brief A Text Controller is used by UI Controls which display text.
  57  *
  58  * It manipulates the Logical & Visual text models on behalf of the UI Controls.
  59  * It provides a view of the text that can be used by rendering back-ends.
  60  *
  61  * For selectable/editable UI controls, the controller handles input events from the UI control
  62  * and decorations (grab handles etc) via the Decorator::ControllerInterface interface.
  63  *
  64  * The text selection popup button callbacks are as well handled via the TextSelectionPopupCallbackInterface interface.
  65  */
  66 class Controller : public RefObject, public Decorator::ControllerInterface, public TextSelectionPopupCallbackInterface
  67 {
  68 public:
  69
  70   /**
  71    * @brief Text related operations to be done in the relayout process.
  72    */
  73   enum OperationsMask
  74   {
  75     NO_OPERATION       = 0x0000,
  76     CONVERT_TO_UTF32   = 0x0001,
  77     GET_SCRIPTS        = 0x0002,
  78     VALIDATE_FONTS     = 0x0004,
  79     GET_LINE_BREAKS    = 0x0008,
  80     GET_WORD_BREAKS    = 0x0010,
  81     BIDI_INFO          = 0x0020,
  82     SHAPE_TEXT         = 0x0040,
  83     GET_GLYPH_METRICS  = 0x0080,
  84     LAYOUT             = 0x0100,
  85     UPDATE_ACTUAL_SIZE = 0x0200,
  86     REORDER            = 0x0400,
  87     ALIGN              = 0x0800,
  88     ALL_OPERATIONS     = 0xFFFF
  89   };
  90
  91   /**
  92    * @brief Used to distinguish between regular key events and IMF events
  93    */
  94   enum InsertType
  95   {
  96     COMMIT,
  97     PRE_EDIT
  98   };
  99
 100   /**
 101    * @brief Create a new instance of a Controller.
 102    *
 103    * @param[in] controlInterface An interface used to request a text relayout.
 104    * @return A pointer to a new Controller.
 105    */
 106   static ControllerPtr New( ControlInterface& controlInterface );
 107
 108   /**
 109    * @brief Called to enable text input.
 110    *
 111    * @note Selectable or editable controls should call this once after Controller::New().
 112    * @param[in] decorator Used to create cursor, selection handle decorations etc.
 113    */
 114   void EnableTextInput( DecoratorPtr decorator );
 115
 116   /**
 117    * @brief Replaces any text previously set.
 118    *
 119    * @note This will be converted into UTF-32 when stored in the text model.
 120    * @param[in] text A string of UTF-8 characters.
 121    */
 122   void SetText( const std::string& text );
 123
 124   /**
 125    * @brief Retrieve any text previously set.
 126    *
 127    * @return A string of UTF-8 characters.
 128    */
 129   void GetText( std::string& text ) const;
 130
 131   /**
 132    * @brief Remove a given number of characters
 133    *
 134    * @param[in] cursorOffset Start position from the current cursor position to start deleting characters.
 135    * @param[in] numberOfChars The number of characters to delete from the cursorOffset.
 136    * @return True if the remove was successful.
 137    */
 138   bool RemoveText( int cursorOffset, int numberOfChars );
 139
 140   /**
 141    * @brief Retrieve the current cursor position.
 142    *
 143    * @return The cursor position.
 144    */
 145   unsigned int GetLogicalCursorPosition() const;
 146
 147   /**
 148    * @brief Replaces any placeholder text previously set.
 149    *
 150    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
 151    * @param[in] text A string of UTF-8 characters.
 152    */
 153   void SetPlaceholderText( PlaceholderType type, const std::string& text );
 154
 155   /**
 156    * @brief Retrieve any placeholder text previously set.
 157    *
 158    * @param[in] type Different placeholder-text can be shown when the control is active/inactive.
 159    * @param[out] A string of UTF-8 characters.
 160    */
 161   void GetPlaceholderText( PlaceholderType type, std::string& text ) const;
 162
 163   /**
 164    * @brief Sets the maximum number of characters that can be inserted into the TextModel
 165    *
 166    * @param[in] maxCharacters maximum number of characters to be accepted
 167    */
 168   void SetMaximumNumberOfCharacters( int maxCharacters );
 169
 170   /**
 171    * @brief Sets the maximum number of characters that can be inserted into the TextModel
 172    *
 173    * @param[in] maxCharacters maximum number of characters to be accepted
 174    */
 175   int GetMaximumNumberOfCharacters();
 176
 177   /**
 178    * @brief Set the default font family.
 179    *
 180    * @param[in] defaultFontFamily The default font family.
 181    * @param[in] userDefined If set by the user
 182    */
 183   void SetDefaultFontFamily( const std::string& defaultFontFamily, bool userDefined );
 184
 185   /**
 186    * @brief Retrieve the default font family.
 187    *
 188    * @return The default font family.
 189    */
 190   const std::string& GetDefaultFontFamily() const;
 191
 192   /**
 193    * @brief Set the default font style.
 194    *
 195    * @param[in] defaultFontStyle The default font style.
 196    */
 197   void SetDefaultFontStyle( const std::string& defaultFontStyle );
 198
 199   /**
 200    * @brief Retrieve the default font style.
 201    *
 202    * @return The default font style.
 203    */
 204   const std::string& GetDefaultFontStyle() const;
 205
 206   /**
 207    * @brief Set the default point size.
 208    *
 209    * @param[in] defaultFontStyle The default point size.
 210    */
 211   void SetDefaultPointSize( float pointSize );
 212
 213   /**
 214    * @brief Retrieve the default point size.
 215    *
 216    * @return The default point size.
 217    */
 218   float GetDefaultPointSize() const;
 219
 220   /**
 221    * @ brief Update the text after a font change
 222    * @param[in] newDefaultFont The new font to change to
 223    */
 224   void UpdateAfterFontChange( std::string& newDefaultFont );
 225
 226   /**
 227    * @brief Set the text color
 228    *
 229    * @param textColor The text color
 230    */
 231   void SetTextColor( const Vector4& textColor );
 232
 233   /**
 234    * @brief Retrieve the text color
 235    *
 236    * @return The text color
 237    */
 238   const Vector4& GetTextColor() const;
 239
 240   /**
 241    * @brief Set the text color
 242    *
 243    * @param textColor The text color
 244    */
 245   void SetPlaceholderTextColor( const Vector4& textColor );
 246
 247   /**
 248    * @brief Retrieve the text color
 249    *
 250    * @return The text color
 251    */
 252   const Vector4& GetPlaceholderTextColor() const;
 253
 254   /**
 255    * @brief Set the shadow offset.
 256    *
 257    * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
 258    */
 259   void SetShadowOffset( const Vector2& shadowOffset );
 260
 261   /**
 262    * @brief Retrieve the shadow offset.
 263    *
 264    * @return The shadow offset.
 265    */
 266   const Vector2& GetShadowOffset() const;
 267
 268   /**
 269    * @brief Set the shadow color.
 270    *
 271    * @param[in] shadowColor The shadow color.
 272    */
 273   void SetShadowColor( const Vector4& shadowColor );
 274
 275   /**
 276    * @brief Retrieve the shadow color.
 277    *
 278    * @return The shadow color.
 279    */
 280   const Vector4& GetShadowColor() const;
 281
 282   /**
 283    * @brief Set the underline color.
 284    *
 285    * @param[in] color color of underline.
 286    */
 287   void SetUnderlineColor( const Vector4& color );
 288
 289   /**
 290    * @brief Retrieve the underline color.
 291    *
 292    * @return The underline color.
 293    */
 294   const Vector4& GetUnderlineColor() const;
 295
 296   /**
 297    * @brief Set the underline enabled flag.
 298    *
 299    * @param[in] enabled The underline enabled flag.
 300    */
 301   void SetUnderlineEnabled( bool enabled );
 302
 303   /**
 304    * @brief Returns whether the text is underlined or not.
 305    *
 306    * @return The underline state.
 307    */
 308   bool IsUnderlineEnabled() const;
 309
 310   /**
 311    * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
 312    *
 313    * @param[in] height The height in pixels of the underline
 314    */
 315   void SetUnderlineHeight( float height );
 316
 317   /**
 318    * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
 319    *
 320    * @return The height of the underline, or 0 if height is not overrided.
 321    */
 322   float GetUnderlineHeight() const;
 323
 324   /**
 325    * @brief Called to enable/disable cursor blink.
 326    *
 327    * @note Only editable controls should calls this.
 328    * @param[in] enabled Whether the cursor should blink or not.
 329    */
 330   void SetEnableCursorBlink( bool enable );
 331
 332   /**
 333    * @brief Query whether cursor blink is enabled.
 334    *
 335    * @return Whether the cursor should blink or not.
 336    */
 337   bool GetEnableCursorBlink() const;
 338
 339   /**
 340    * @brief Query the current scroll position; the UI control is responsible for moving actors to this position.
 341    *
 342    * @return The scroll position.
 343    */
 344   const Vector2& GetScrollPosition() const;
 345
 346   /**
 347    * @brief Query the alignment offset.
 348    *
 349    * @return The alignmnet offset.
 350    */
 351   const Vector2& GetAlignmentOffset() const;
 352
 353   /**
 354    * @copydoc Control::GetNaturalSize()
 355    */
 356   Vector3 GetNaturalSize();
 357
 358   /**
 359    * @copydoc Control::GetHeightForWidth()
 360    */
 361   float GetHeightForWidth( float width );
 362
 363   /**
 364    * @brief Triggers a relayout which updates View (if necessary).
 365    *
 366    * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
 367    * @param[in] size A the size of a bounding box to layout text within.
 368    * @return True if the text model or decorations were updated.
 369    */
 370   bool Relayout( const Size& size );
 371
 372   /**
 373    * @brief Process queued events which modify the model.
 374    */
 375   void ProcessModifyEvents();
 376
 377   /**
 378    * @brief Used to remove placeholder text.
 379    */
 380   void ResetText();
 381
 382   /**
 383    * @brief Used to reset the cursor position after setting a new text.
 384    *
 385    * @param[in] cursorIndex Where to place the cursor.
 386    */
 387   void ResetCursorPosition( CharacterIndex cursorIndex );
 388
 389   /**
 390    * @brief Used to reset the scroll position after setting a new text.
 391    */
 392   void ResetScrollPosition();
 393
 394   /**
 395    * @brief Used to process an event queued from SetText()
 396    */
 397   void TextReplacedEvent();
 398
 399   /**
 400    * @brief Used to process an event queued from key events etc.
 401    */
 402   void TextInsertedEvent();
 403
 404   /**
 405    * @brief Used to process an event queued from backspace key etc.
 406    */
 407   void TextDeletedEvent();
 408
 409   /**
 410    * @brief Lays-out the text.
 411    *
 412    * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
 413    *
 414    * @param[in] size A the size of a bounding box to layout text within.
 415    * @param[in] operations The layout operations which need to be done.
 416    * @param[out] layoutSize The size of the laid-out text.
 417    */
 418   bool DoRelayout( const Size& size,
 419                    OperationsMask operations,
 420                    Size& layoutSize );
 421
 422   /**
 423    * @brief Whether to enable the multi-line layout.
 424    *
 425    * @param[in] enable \e true enables the multi-line (by default)
 426    */
 427   void SetMultiLineEnabled( bool enable );
 428
 429   /**
 430    * @return Whether the multi-line layout is enabled.
 431    */
 432   bool IsMultiLineEnabled() const;
 433
 434   /**
 435    * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment()
 436    */
 437   void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment );
 438
 439   /**
 440    * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment()
 441    */
 442   LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const;
 443
 444   /**
 445    * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment()
 446    */
 447   void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment );
 448
 449   /**
 450    * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment()
 451    */
 452   LayoutEngine::VerticalAlignment GetVerticalAlignment() const;
 453
 454   /**
 455    * @brief Calulates the alignment of the whole text inside the bounding box.
 456    *
 457    * @param[in] size The size of the bounding box.
 458    */
 459   void CalculateTextAlignment( const Size& size );
 460
 461   /**
 462    * @brief Return the layout engine.
 463    *
 464    * @return A reference to the layout engine.
 465    */
 466   LayoutEngine& GetLayoutEngine();
 467
 468   /**
 469    * @brief Return a view of the text.
 470    *
 471    * @return A reference to the view.
 472    */
 473   View& GetView();
 474
 475   // Text-input Event Queuing
 476
 477   /**
 478    * @brief Called by editable UI controls when keyboard focus is gained.
 479    */
 480   void KeyboardFocusGainEvent();
 481
 482   /**
 483    * @brief Called by editable UI controls when focus is lost.
 484    */
 485   void KeyboardFocusLostEvent();
 486
 487   /**
 488    * @brief Called by editable UI controls when key events are received.
 489    *
 490    * @param[in] event The key event.
 491    * @param[in] type Used to distinguish between regular key events and IMF events.
 492    */
 493   bool KeyEvent( const Dali::KeyEvent& event );
 494
 495   /**
 496    * @brief Called by editable UI controls when key events are received.
 497    *
 498    * @param[in] text The text to insert.
 499    * @param[in] type Used to distinguish between regular key events and IMF events.
 500    */
 501   void InsertText( const std::string& text, InsertType type );
 502
 503   /**
 504    * @brief Checks if text is selected and if so removes it.
 505    * @return true if text was removed
 506    */
 507   bool RemoveSelectedText();
 508
 509   /**
 510    * @brief Called by editable UI controls when a tap gesture occurs.
 511    * @param[in] tapCount The number of taps.
 512    * @param[in] x The x position relative to the top-left of the parent control.
 513    * @param[in] y The y position relative to the top-left of the parent control.
 514    */
 515   void TapEvent( unsigned int tapCount, float x, float y );
 516
 517   /**
 518    * @brief Called by editable UI controls when a pan gesture occurs.
 519    *
 520    * @param[in] state The state of the gesture.
 521    * @param[in] displacement This distance panned since the last pan gesture.
 522    */
 523   void PanEvent( Gesture::State state, const Vector2& displacement );
 524
 525   /**
 526    * @brief Called by editable UI controls when a long press gesture occurs.
 527    *
 528    * @param[in] state The state of the gesture.
 529    * @param[in] x The x position relative to the top-left of the parent control.
 530    * @param[in] y The y position relative to the top-left of the parent control.
 531    */
 532   void LongPressEvent( Gesture::State state, float x, float y );
 533
 534   /**
 535    * @brief Creates a selection event.
 536    *
 537    * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
 538    *
 539    * @param[in] x The x position relative to the top-left of the parent control.
 540    * @param[in] y The y position relative to the top-left of the parent control.
 541    * @param[in] selectAll Whether the whole text is selected.
 542    */
 543   void SelectEvent( float x, float y, bool selectAll );
 544
 545   /**
 546    * @brief Event received from IMF manager
 547    *
 548    * @param[in] imfManager The IMF manager.
 549    * @param[in] imfEvent The event received.
 550    * @return A data struture indicating if update is needed, cursor position and current text.
 551    */
 552   ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
 553
 554   /**
 555    * @brief Paste given string into Text model
 556    * @param[in] stringToPaste this string will be inserted into the text model
 557    */
 558   void PasteText( const std::string& stringToPaste );
 559
 560   /**
 561    * @brief Event from Clipboard notifying an Item has been selected for pasting
 562    */
 563   void PasteClipboardItemEvent();
 564
 565   /**
 566    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
 567    */
 568   virtual void GetTargetSize( Vector2& targetSize );
 569
 570   /**
 571    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
 572    */
 573   virtual void AddDecoration( Actor& actor, bool needsClipping );
 574
 575   /**
 576    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
 577    */
 578   virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
 579
 580   /**
 581    * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
 582    */
 583   virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
 584
 585 protected:
 586
 587   /**
 588    * @brief A reference counted object may only be deleted by calling Unreference().
 589    */
 590   virtual ~Controller();
 591
 592 private:
 593
 594   /**
 595    * @brief Helper to KeyEvent() to handle the backspace case.
 596    *
 597    * @return True if a character was deleted.
 598    */
 599   bool BackspaceKeyEvent();
 600
 601   /**
 602    * @brief Helper to clear font-specific data.
 603    */
 604   void ShowPlaceholderText();
 605
 606   /**
 607    * @brief Helper to clear all the model data except for LogicalModel::mText.
 608    */
 609   void ClearModelData();
 610
 611   /**
 612    * @brief Helper to clear font-specific data (only).
 613    */
 614   void ClearFontData();
 615
 616   /**
 617    * @brief Private constructor.
 618    */
 619   Controller( ControlInterface& controlInterface );
 620
 621   // Undefined
 622   Controller( const Controller& handle );
 623
 624   // Undefined
 625   Controller& operator=( const Controller& handle );
 626
 627 private:
 628
 629   struct Impl;
 630   Impl* mImpl;
 631 };
 632
 633 } // namespace Text
 634
 635 } // namespace Toolkit
 636
 637 } // namespace Dali
 638
 639 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__