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    */
 182   void SetDefaultFontFamily( const std::string& defaultFontFamily );
 183
 184   /**
 185    * @brief Retrieve the default font family.
 186    *
 187    * @return The default font family.
 188    */
 189   const std::string& GetDefaultFontFamily() const;
 190
 191   /**
 192    * @brief Set the default font style.
 193    *
 194    * @param[in] defaultFontStyle The default font style.
 195    */
 196   void SetDefaultFontStyle( const std::string& defaultFontStyle );
 197
 198   /**
 199    * @brief Retrieve the default font style.
 200    *
 201    * @return The default font style.
 202    */
 203   const std::string& GetDefaultFontStyle() const;
 204
 205   /**
 206    * @brief Set the default point size.
 207    *
 208    * @param[in] defaultFontStyle The default point size.
 209    */
 210   void SetDefaultPointSize( float pointSize );
 211
 212   /**
 213    * @brief Retrieve the default point size.
 214    *
 215    * @return The default point size.
 216    */
 217   float GetDefaultPointSize() const;
 218
 219   /**
 220    * @brief Set the text color
 221    *
 222    * @param textColor The text color
 223    */
 224   void SetTextColor( const Vector4& textColor );
 225
 226   /**
 227    * @brief Retrieve the text color
 228    *
 229    * @return The text color
 230    */
 231   const Vector4& GetTextColor() const;
 232
 233   /**
 234    * @brief Set the text color
 235    *
 236    * @param textColor The text color
 237    */
 238   void SetPlaceholderTextColor( const Vector4& textColor );
 239
 240   /**
 241    * @brief Retrieve the text color
 242    *
 243    * @return The text color
 244    */
 245   const Vector4& GetPlaceholderTextColor() const;
 246
 247   /**
 248    * @brief Set the shadow offset.
 249    *
 250    * @param[in] shadowOffset The shadow offset, 0,0 indicates no shadow.
 251    */
 252   void SetShadowOffset( const Vector2& shadowOffset );
 253
 254   /**
 255    * @brief Retrieve the shadow offset.
 256    *
 257    * @return The shadow offset.
 258    */
 259   const Vector2& GetShadowOffset() const;
 260
 261   /**
 262    * @brief Set the shadow color.
 263    *
 264    * @param[in] shadowColor The shadow color.
 265    */
 266   void SetShadowColor( const Vector4& shadowColor );
 267
 268   /**
 269    * @brief Retrieve the shadow color.
 270    *
 271    * @return The shadow color.
 272    */
 273   const Vector4& GetShadowColor() const;
 274
 275   /**
 276    * @brief Set the underline color.
 277    *
 278    * @param[in] color color of underline.
 279    */
 280   void SetUnderlineColor( const Vector4& color );
 281
 282   /**
 283    * @brief Retrieve the underline color.
 284    *
 285    * @return The underline color.
 286    */
 287   const Vector4& GetUnderlineColor() const;
 288
 289   /**
 290    * @brief Set the underline enabled flag.
 291    *
 292    * @param[in] enabled The underline enabled flag.
 293    */
 294   void SetUnderlineEnabled( bool enabled );
 295
 296   /**
 297    * @brief Returns whether the text is underlined or not.
 298    *
 299    * @return The underline state.
 300    */
 301   bool IsUnderlineEnabled() const;
 302
 303   /**
 304    * @brief Set the override used for underline height, 0 indicates height will be supplied by font metrics
 305    *
 306    * @param[in] height The height in pixels of the underline
 307    */
 308   void SetUnderlineHeight( float height );
 309
 310   /**
 311    * @brief Retrieves the override height of an underline, 0 indicates height is supplied by font metrics
 312    *
 313    * @return The height of the underline, or 0 if height is not overrided.
 314    */
 315   float GetUnderlineHeight() const;
 316
 317   /**
 318    * @brief Called to enable/disable cursor blink.
 319    *
 320    * @note Only editable controls should calls this.
 321    * @param[in] enabled Whether the cursor should blink or not.
 322    */
 323   void SetEnableCursorBlink( bool enable );
 324
 325   /**
 326    * @brief Query whether cursor blink is enabled.
 327    *
 328    * @return Whether the cursor should blink or not.
 329    */
 330   bool GetEnableCursorBlink() const;
 331
 332   /**
 333    * @brief Query the current scroll position; the UI control is responsible for moving actors to this position.
 334    *
 335    * @return The scroll position.
 336    */
 337   const Vector2& GetScrollPosition() const;
 338
 339   /**
 340    * @brief Query the alignment offset.
 341    *
 342    * @return The alignmnet offset.
 343    */
 344   const Vector2& GetAlignmentOffset() const;
 345
 346   /**
 347    * @copydoc Control::GetNaturalSize()
 348    */
 349   Vector3 GetNaturalSize();
 350
 351   /**
 352    * @copydoc Control::GetHeightForWidth()
 353    */
 354   float GetHeightForWidth( float width );
 355
 356   /**
 357    * @brief Triggers a relayout which updates View (if necessary).
 358    *
 359    * @note UI Controls are expected to minimize calls to this method e.g. call once after size negotiation.
 360    * @param[in] size A the size of a bounding box to layout text within.
 361    * @return True if the text model or decorations were updated.
 362    */
 363   bool Relayout( const Size& size );
 364
 365   /**
 366    * @brief Process queued events which modify the model.
 367    */
 368   void ProcessModifyEvents();
 369
 370   /**
 371    * @brief Used to remove placeholder text.
 372    */
 373   void ResetText();
 374
 375   /**
 376    * @brief Used to reset the cursor position after setting a new text.
 377    *
 378    * @param[in] cursorIndex Where to place the cursor.
 379    */
 380   void ResetCursorPosition( CharacterIndex cursorIndex );
 381
 382   /**
 383    * @brief Used to reset the scroll position after setting a new text.
 384    */
 385   void ResetScrollPosition();
 386
 387   /**
 388    * @brief Used to process an event queued from SetText()
 389    */
 390   void TextReplacedEvent();
 391
 392   /**
 393    * @brief Used to process an event queued from key events etc.
 394    */
 395   void TextInsertedEvent();
 396
 397   /**
 398    * @brief Used to process an event queued from backspace key etc.
 399    */
 400   void TextDeletedEvent();
 401
 402   /**
 403    * @brief Lays-out the text.
 404    *
 405    * GetNaturalSize(), GetHeightForWidth() and Relayout() calls this method.
 406    *
 407    * @param[in] size A the size of a bounding box to layout text within.
 408    * @param[in] operations The layout operations which need to be done.
 409    * @param[out] layoutSize The size of the laid-out text.
 410    */
 411   bool DoRelayout( const Size& size,
 412                    OperationsMask operations,
 413                    Size& layoutSize );
 414
 415   /**
 416    * @brief Whether to enable the multi-line layout.
 417    *
 418    * @param[in] enable \e true enables the multi-line (by default)
 419    */
 420   void SetMultiLineEnabled( bool enable );
 421
 422   /**
 423    * @return Whether the multi-line layout is enabled.
 424    */
 425   bool IsMultiLineEnabled() const;
 426
 427   /**
 428    * @copydoc Dali::Toolkit::Text::LayoutEngine::SetHorizontalAlignment()
 429    */
 430   void SetHorizontalAlignment( LayoutEngine::HorizontalAlignment alignment );
 431
 432   /**
 433    * @copydoc Dali::Toolkit::Text::LayoutEngine::GetHorizontalAlignment()
 434    */
 435   LayoutEngine::HorizontalAlignment GetHorizontalAlignment() const;
 436
 437   /**
 438    * @copydoc Dali::Toolkit::Text::LayoutEngine::SetVerticalAlignment()
 439    */
 440   void SetVerticalAlignment( LayoutEngine::VerticalAlignment alignment );
 441
 442   /**
 443    * @copydoc Dali::Toolkit::Text::LayoutEngine::GetVerticalAlignment()
 444    */
 445   LayoutEngine::VerticalAlignment GetVerticalAlignment() const;
 446
 447   /**
 448    * @brief Calulates the alignment of the whole text inside the bounding box.
 449    *
 450    * @param[in] size The size of the bounding box.
 451    */
 452   void CalculateTextAlignment( const Size& size );
 453
 454   /**
 455    * @brief Return the layout engine.
 456    *
 457    * @return A reference to the layout engine.
 458    */
 459   LayoutEngine& GetLayoutEngine();
 460
 461   /**
 462    * @brief Return a view of the text.
 463    *
 464    * @return A reference to the view.
 465    */
 466   View& GetView();
 467
 468   // Text-input Event Queuing
 469
 470   /**
 471    * @brief Called by editable UI controls when keyboard focus is gained.
 472    */
 473   void KeyboardFocusGainEvent();
 474
 475   /**
 476    * @brief Called by editable UI controls when focus is lost.
 477    */
 478   void KeyboardFocusLostEvent();
 479
 480   /**
 481    * @brief Called by editable UI controls when key events are received.
 482    *
 483    * @param[in] event The key event.
 484    * @param[in] type Used to distinguish between regular key events and IMF events.
 485    */
 486   bool KeyEvent( const Dali::KeyEvent& event );
 487
 488   /**
 489    * @brief Called by editable UI controls when key events are received.
 490    *
 491    * @param[in] text The text to insert.
 492    * @param[in] type Used to distinguish between regular key events and IMF events.
 493    */
 494   void InsertText( const std::string& text, InsertType type );
 495
 496   /**
 497    * @brief Checks if text is selected and if so removes it.
 498    * @return true if text was removed
 499    */
 500   bool RemoveSelectedText();
 501
 502   /**
 503    * @brief Called by editable UI controls when a tap gesture occurs.
 504    * @param[in] tapCount The number of taps.
 505    * @param[in] x The x position relative to the top-left of the parent control.
 506    * @param[in] y The y position relative to the top-left of the parent control.
 507    */
 508   void TapEvent( unsigned int tapCount, float x, float y );
 509
 510   /**
 511    * @brief Called by editable UI controls when a pan gesture occurs.
 512    *
 513    * @param[in] state The state of the gesture.
 514    * @param[in] displacement This distance panned since the last pan gesture.
 515    */
 516   void PanEvent( Gesture::State state, const Vector2& displacement );
 517
 518   /**
 519    * @brief Called by editable UI controls when a long press gesture occurs.
 520    *
 521    * @param[in] state The state of the gesture.
 522    * @param[in] x The x position relative to the top-left of the parent control.
 523    * @param[in] y The y position relative to the top-left of the parent control.
 524    */
 525   void LongPressEvent( Gesture::State state, float x, float y );
 526
 527   /**
 528    * @brief Creates a selection event.
 529    *
 530    * It could be called from the TapEvent (double tap) or when the text selection popup's sellect all button is pressed.
 531    *
 532    * @param[in] x The x position relative to the top-left of the parent control.
 533    * @param[in] y The y position relative to the top-left of the parent control.
 534    * @param[in] selectAll Whether the whole text is selected.
 535    */
 536   void SelectEvent( float x, float y, bool selectAll );
 537
 538   /**
 539    * @brief Event received from IMF manager
 540    *
 541    * @param[in] imfManager The IMF manager.
 542    * @param[in] imfEvent The event received.
 543    * @return A data struture indicating if update is needed, cursor position and current text.
 544    */
 545   ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
 546
 547   /**
 548    * @brief Paste given string into Text model
 549    * @param[in] stringToPaste this string will be inserted into the text model
 550    */
 551   void PasteText( const std::string& stringToPaste );
 552
 553   /**
 554    * @brief Event from Clipboard notifying an Item has been selected for pasting
 555    */
 556   void PasteClipboardItemEvent();
 557
 558   /**
 559    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::GetTargetSize()
 560    */
 561   virtual void GetTargetSize( Vector2& targetSize );
 562
 563   /**
 564    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::AddDecoration()
 565    */
 566   virtual void AddDecoration( Actor& actor, bool needsClipping );
 567
 568   /**
 569    * @copydoc Dali::Toolkit::Text::Decorator::ControllerInterface::DecorationEvent()
 570    */
 571   virtual void DecorationEvent( HandleType handle, HandleState state, float x, float y );
 572
 573   /**
 574    * @copydoc Dali::Toolkit::TextSelectionPopup::TextPopupButtonCallbackInterface::TextPopupButtonTouched()
 575    */
 576   virtual void TextPopupButtonTouched( Dali::Toolkit::TextSelectionPopup::Buttons button );
 577
 578 protected:
 579
 580   /**
 581    * @brief A reference counted object may only be deleted by calling Unreference().
 582    */
 583   virtual ~Controller();
 584
 585 private:
 586
 587   /**
 588    * @brief Helper to KeyEvent() to handle the backspace case.
 589    *
 590    * @return True if a character was deleted.
 591    */
 592   bool BackspaceKeyEvent();
 593
 594   /**
 595    * @brief Helper to clear font-specific data.
 596    */
 597   void ShowPlaceholderText();
 598
 599   /**
 600    * @brief Helper to clear all the model data except for LogicalModel::mText.
 601    */
 602   void ClearModelData();
 603
 604   /**
 605    * @brief Helper to clear font-specific data (only).
 606    */
 607   void ClearFontData();
 608
 609   /**
 610    * @brief Private constructor.
 611    */
 612   Controller( ControlInterface& controlInterface );
 613
 614   // Undefined
 615   Controller( const Controller& handle );
 616
 617   // Undefined
 618   Controller& operator=( const Controller& handle );
 619
 620 private:
 621
 622   struct Impl;
 623   Impl* mImpl;
 624 };
 625
 626 } // namespace Text
 627
 628 } // namespace Toolkit
 629
 630 } // namespace Dali
 631
 632 #endif // __DALI_TOOLKIT_TEXT_CONTROLLER_H__