dali-toolkit/internal/controls/text-controls/text-editor-impl.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
   2 #define DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
   3
   4 /*
   5  * Copyright (c) 2022 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/accessibility.h>
  23 #include <dali/devel-api/adaptor-framework/clipboard-event-notifier.h>
  24 #include <dali/devel-api/adaptor-framework/input-method-context.h>
  25 #include <dali/devel-api/atspi-interfaces/editable-text.h>
  26 #include <dali/devel-api/atspi-interfaces/hypertext.h>
  27 #include <dali/devel-api/atspi-interfaces/text.h>
  28 #include <dali/public-api/animation/animation.h>
  29
  30 // INTERNAL INCLUDES
  31 #include <dali-toolkit/devel-api/controls/control-devel.h>
  32 #include <dali-toolkit/devel-api/controls/scroll-bar/scroll-bar.h>
  33 #include <dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h>
  34 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
  35 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
  36 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
  37 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
  38 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
  39 #include <dali-toolkit/internal/text/text-control-interface.h>
  40 #include <dali-toolkit/internal/text/text-controller.h>
  41 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
  42 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
  43 #include <dali-toolkit/internal/text/text-vertical-scroller.h>
  44 #include <dali-toolkit/public-api/controls/control-impl.h>
  45 #include <dali-toolkit/public-api/controls/text-controls/text-editor.h>
  46
  47 namespace Dali
  48 {
  49 namespace Toolkit
  50 {
  51 namespace Internal
  52 {
  53 /**
  54  * @brief A control which renders a long text string with styles.
  55  */
  56 class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface, public Text::AnchorControlInterface
  57 {
  58 public:
  59   /**
  60    * @copydoc Dali::Toollkit::TextEditor::New()
  61    */
  62   static Toolkit::TextEditor New();
  63
  64   // Properties
  65
  66   /**
  67    * @brief Called when a property of an object of this type is set.
  68    *
  69    * @param[in] object The object whose property is set.
  70    * @param[in] index The property index.
  71    * @param[in] value The new property value.
  72    */
  73   static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
  74
  75   /**
  76    * @brief Called to retrieve a property of an object of this type.
  77    *
  78    * @param[in] object The object whose property is to be retrieved.
  79    * @param[in] index The property index.
  80    * @return The current value of the property.
  81    */
  82   static Property::Value GetProperty(BaseObject* object, Property::Index index);
  83
  84   /**
  85    * @copydoc Dali::Toollkit::TextEditor::GetInputMethodContext()
  86    */
  87   InputMethodContext GetInputMethodContext();
  88
  89   /**
  90    * @copydoc Dali::Toollkit::TextEditor::MaxLengthReachedSignal()
  91    */
  92   DevelTextEditor::MaxLengthReachedSignalType& MaxLengthReachedSignal();
  93
  94   /**
  95    * @copydoc Dali::Toollkit::TextEditor::AnchorClickedSignal()
  96    */
  97   DevelTextEditor::AnchorClickedSignalType& AnchorClickedSignal();
  98
  99   /**
 100    * @copydoc Dali::Toollkit::TextEditor::CursorPositionChangedSignal()
 101    */
 102   DevelTextEditor::CursorPositionChangedSignalType& CursorPositionChangedSignal();
 103
 104   /**
 105    * @copydoc Dali::Toollkit::TextEditor::InputFilteredSignal()
 106    */
 107   DevelTextEditor::InputFilteredSignalType& InputFilteredSignal();
 108
 109   /**
 110    * @copydoc Dali::Toollkit::TextEditor::SelectionChangedSignal()
 111    */
 112   DevelTextEditor::SelectionChangedSignalType& SelectionChangedSignal();
 113
 114   /**
 115    * @copydoc Dali::Toollkit::TextEditor::SelectionClearedSignal()
 116    */
 117   DevelTextEditor::SelectionClearedSignalType& SelectionClearedSignal();
 118
 119   /**
 120    * @copydoc Dali::Toollkit::TextEditor::SelectionStartedSignal()
 121    */
 122   DevelTextEditor::SelectionStartedSignalType& SelectionStartedSignal();
 123
 124   /**
 125    * Connects a callback function with the object's signals.
 126    * @param[in] object The object providing the signal.
 127    * @param[in] tracker Used to disconnect the signal.
 128    * @param[in] signalName The signal to connect to.
 129    * @param[in] functor A newly allocated FunctorDelegate.
 130    * @return True if the signal was connected.
 131    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
 132    */
 133   static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
 134
 135   /**
 136    * @brief Gets text controller
 137    *
 138    * @return The text controller
 139    */
 140   Text::ControllerPtr GetTextController();
 141
 142   /**
 143    * @copydoc TextEditor::TextChangedSignal()
 144    */
 145   Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal();
 146
 147   /**
 148    * @copydoc TextEditor::TextChangedSignal()
 149    */
 150   Toolkit::TextEditor::InputStyleChangedSignalType& InputStyleChangedSignal();
 151
 152   /**
 153    * @copydoc TextEditor::ScrollStateChangedSignal()
 154    */
 155   Toolkit::TextEditor::ScrollStateChangedSignalType& ScrollStateChangedSignal();
 156
 157 private: // From Control
 158   /**
 159    * @copydoc Control::OnInitialize()
 160    */
 161   void OnInitialize() override;
 162
 163   /**
 164    * @copydoc Control::OnStyleChange()
 165    */
 166   void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
 167
 168   /**
 169    * @copydoc Control::GetNaturalSize()
 170    */
 171   Vector3 GetNaturalSize() override;
 172
 173   /**
 174    * @copydoc Control::GetHeightForWidth()
 175    */
 176   float GetHeightForWidth(float width) override;
 177
 178   /**
 179    * @copydoc Control::OnInitialize()
 180    */
 181   void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
 182
 183   /**
 184    * @copydoc Control::OnKeyInputFocusGained()
 185    */
 186   void OnKeyInputFocusGained() override;
 187
 188   /**
 189    * @copydoc Control::OnKeyInputFocusLost()
 190    */
 191   void OnKeyInputFocusLost() override;
 192
 193   /**
 194    * @copydoc Control::OnAccessibilityActivated()
 195    */
 196   bool OnAccessibilityActivated() override;
 197
 198   /**
 199    * @copydoc Control::OnTap()
 200    */
 201   void OnTap(const TapGesture& tap) override;
 202
 203   /**
 204    * @copydoc Control::OnPan()
 205    */
 206   void OnPan(const PanGesture& gesture) override;
 207
 208   /**
 209    * @copydoc Control::OnLongPress()
 210    */
 211   void OnLongPress(const LongPressGesture& gesture) override;
 212
 213   /**
 214    * @copydoc Control::OnSceneConnection()
 215    */
 216   void OnSceneConnection(int depth) override;
 217
 218   /**
 219    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
 220    */
 221   bool OnKeyEvent(const KeyEvent& event) override;
 222
 223   // From ControlInterface
 224
 225   /**
 226    * @copydoc Text::ControlInterface::RequestTextRelayout()
 227    */
 228   void RequestTextRelayout() override;
 229
 230   // From EditableControlInterface
 231
 232   /**
 233    * @copydoc Text::EditableControlInterface::TextChanged()
 234    */
 235   void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
 236
 237   /**
 238    * @copydoc Text::EditableControlInterface::TextDeleted()
 239    */
 240   void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
 241
 242   /**
 243    * @copydoc Text::EditableControlInterface::CursorPositionChanged()
 244    */
 245   void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
 246
 247   /**
 248    * @copydoc Text::EditableControlInterface::TextChanged()
 249    */
 250   void TextChanged(bool immediate) override;
 251
 252   /**
 253    * @copydoc Text::EditableControlInterface::MaxLengthReached()
 254    */
 255   void MaxLengthReached() override;
 256
 257   /**
 258    * @copydoc Text::EditableControlInterface::InputStyleChanged()
 259    */
 260   void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
 261
 262   /**
 263    * @copydoc Text::SelectableControlInterface::SelectionChanged()
 264    */
 265   void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
 266
 267   /**
 268    * @copydoc Text::EditableControlInterface::AddDecoration()
 269    */
 270   void AddDecoration(Actor& actor, Toolkit::Text::DecorationType type, bool needsClipping) override;
 271
 272   /**
 273    * @copydoc Text::EditableControlInterface::InputFiltered()
 274    */
 275   void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
 276
 277   /**
 278    * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
 279    */
 280   void GetControlBackgroundColor(Vector4& color) const override;
 281
 282   // From SelectableControlInterface
 283 public:
 284   /**
 285    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
 286    */
 287   void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
 288
 289   /**
 290    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
 291    */
 292   Uint32Pair GetTextSelectionRange() const override;
 293
 294   /**
 295    * @copydoc Text::SelectableControlInterface::SelectWholeText()
 296    */
 297   void SelectWholeText() override;
 298
 299   /**
 300    * @copydoc Text::SelectableControlInterface::SelectNone()
 301    */
 302   void SelectNone() override;
 303
 304   /**
 305    * @copydoc Text::SelectableControlInterface::SelectText()
 306    */
 307   void SelectText(const uint32_t start, const uint32_t end) override;
 308
 309   /**
 310    * @copydoc Dali::Toolkit::DevelTextEditor::ScrollBy()
 311    */
 312   void ScrollBy(Vector2 Scroll);
 313
 314   /**
 315    * @brief Get Horizontal scroll position of TextEditor.
 316    *
 317    * @return Horizontal scroll position (in pixels) of TextEditor.
 318    */
 319   float GetHorizontalScrollPosition();
 320
 321   /**
 322    * @brief Get Vertical scroll position of TextEditor.
 323    *
 324    * @return Vertical scroll position (in pixels) of TextEditor.
 325    */
 326   float GetVerticalScrollPosition();
 327
 328   /**
 329    * @brief Get the rendered size of a specific text range.
 330    * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
 331    * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
 332    *
 333    * @param[in] startIndex start index of the text requested to calculate size for.
 334    * @param[in] endIndex end index(included) of the text requested to calculate size for.
 335    * @return list of sizes of the reuested text.
 336    */
 337   Vector<Vector2> GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const;
 338
 339   /**
 340    * @brief Get the top/left rendered position of a specific text range.
 341    * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
 342    * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
 343    *
 344    * @param[in] startIndex start index of the text requested to get position to.
 345    * @param[in] endIndex end index(included) of the text requested to get position to.
 346    * @return list of positions of the requested text.
 347    */
 348   Vector<Vector2> GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const;
 349
 350   /**
 351    * @copydoc Text::SelectableControlInterface::GetSelectedText()
 352    */
 353   string GetSelectedText() const override;
 354
 355   /**
 356    * @copydoc Text::EditableControlInterface::IsEditable()
 357    */
 358   bool IsEditable() const override;
 359
 360   /**
 361    * @copydoc Text::EditableControlInterface::SetEditable()
 362    */
 363   void SetEditable(bool editable) override;
 364
 365   /**
 366    * @copydoc Text::EditableControlInterface::CopyText()
 367    */
 368   string CopyText() override;
 369
 370   /**
 371    * @copydoc Text::EditableControlInterface::CutText()
 372    */
 373   string CutText() override;
 374
 375   /**
 376    * @copydoc Text::EditableControlInterface::PasteText()
 377    */
 378   void PasteText() override;
 379
 380   // From AnchorControlInterface
 381
 382   /**
 383    * @copydoc Text::AnchorControlInterface::AnchorClicked()
 384    */
 385   void AnchorClicked(const std::string& href) override;
 386
 387 private: // Implementation
 388   /**
 389    * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
 390    */
 391   InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
 392
 393   /**
 394    * @brief Callback when Clipboard signals an item should be pasted
 395    * @param[in] clipboard handle to Clipboard Event Notifier
 396    */
 397   void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
 398
 399   /**
 400    * @brief Get a Property Map for the image used for the required Handle Image
 401    * @param[out] value the returned image property
 402    * @param[in] handleType the type of handle
 403    * @param[in] handleImageType the type of image for the given handleType
 404    */
 405   void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
 406
 407   /**
 408    * @brief Callback when keyboard is shown/hidden.
 409    *
 410    * @param[in] keyboardShown True if keyboard is shown.
 411    */
 412   void KeyboardStatusChanged(bool keyboardShown);
 413
 414   /**
 415    * @brief update scroll bar position
 416    *
 417    * If text scroll is occurred, create or update scroll bar position
 418    */
 419   void UpdateScrollBar();
 420
 421   /**
 422    * @brief Callback when TextEditor is touched
 423    *
 424    * @param[in] actor TextEditor touched
 425    * @param[in] touch Touch information
 426    */
 427   bool OnTouched(Actor actor, const TouchEvent& touch);
 428
 429   /**
 430    * @brief Callbacks called on idle.
 431    *
 432    * If there are notifications of change of input style on the queue, Toolkit::TextEditor::InputStyleChangedSignal() are emitted.
 433    */
 434   void OnIdleSignal();
 435
 436   /**
 437    * @brief Emits CursorPositionChanged signal.
 438    */
 439   void EmitCursorPositionChangedSignal();
 440
 441   /**
 442    * @brief Emits TextChanged signal.
 443    */
 444   void EmitTextChangedSignal();
 445
 446   /**
 447    * @brief Emits SelectionChanged signal.
 448    */
 449   void EmitSelectionChangedSignal();
 450
 451   /**
 452    * @brief Emits SelectionCleared signal.
 453    */
 454   void EmitSelectionClearedSignal();
 455
 456   /**
 457    * @brief Emits SelectionStarted signal.
 458    */
 459   void EmitSelectionStartedSignal();
 460
 461   /**
 462    * @brief set RenderActor's position with new scrollPosition
 463    *
 464    * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled
 465    */
 466   void ApplyScrollPosition();
 467
 468   /**
 469    * @brief Callback function for ScrollBar indicator animation finished signal
 470    *
 471    * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false
 472    */
 473   void OnScrollIndicatorAnimationFinished(Animation& animation);
 474
 475   /**
 476   * @brief Callback function for when the layout is changed.
 477   * @param[in] actor The actor whose layoutDirection is changed.
 478   * @param[in] type  The layoutDirection.
 479   */
 480   void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
 481
 482   /**
 483   * @brief Add a layer for active or cursor.
 484   * @param[in] layer The actor in which to store the layer.
 485   * @param[in] actor The new layer to add.
 486   */
 487   void AddLayer(Actor& layer, Actor& actor);
 488
 489   /**
 490    * Construct a new TextEditor.
 491    */
 492   TextEditor();
 493
 494   /**
 495    * A reference counted object may only be deleted by calling Unreference()
 496    */
 497   virtual ~TextEditor();
 498
 499   // Undefined copy constructor and assignment operators
 500   TextEditor(const TextEditor&);
 501   TextEditor& operator=(const TextEditor& rhs);
 502
 503   /**
 504    * @brief Resize actor to the given size.
 505    *
 506    * @param[in] actor The actor to be resized.
 507    * @param[in] size Size to change.
 508    */
 509   void ResizeActor(Actor& actor, const Vector2& size);
 510
 511   /**
 512    * @brief Render view, create and attach actor(s) to this text editor.
 513    */
 514   void RenderText(Text::Controller::UpdateTextType updateTextType);
 515
 516   // Connection needed to re-render text, when a text editor returns to the scene.
 517   void OnSceneConnect(Dali::Actor actor);
 518
 519   // Needed to synchronize TextAnchor actors with Anchor objects in text's logical model
 520   void OnAccessibilityStatusChanged();
 521
 522 private: // Data
 523   // Signals
 524   Toolkit::TextEditor::TextChangedSignalType                mTextChangedSignal;
 525   Toolkit::TextEditor::InputStyleChangedSignalType          mInputStyleChangedSignal;
 526   Toolkit::TextEditor::ScrollStateChangedSignalType         mScrollStateChangedSignal;
 527   Toolkit::DevelTextEditor::MaxLengthReachedSignalType      mMaxLengthReachedSignal;
 528   Toolkit::DevelTextEditor::AnchorClickedSignalType         mAnchorClickedSignal;
 529   Toolkit::DevelTextEditor::InputFilteredSignalType         mInputFilteredSignal;
 530   Toolkit::DevelTextEditor::CursorPositionChangedSignalType mCursorPositionChangedSignal;
 531   Toolkit::DevelTextEditor::SelectionChangedSignalType      mSelectionChangedSignal;
 532   Toolkit::DevelTextEditor::SelectionClearedSignalType      mSelectionClearedSignal;
 533   Toolkit::DevelTextEditor::SelectionStartedSignalType      mSelectionStartedSignal;
 534
 535   InputMethodContext               mInputMethodContext;
 536   Text::ControllerPtr              mController;
 537   Text::RendererPtr                mRenderer;
 538   Text::DecoratorPtr               mDecorator;
 539   Text::TextVerticalScrollerPtr    mTextVerticalScroller;
 540   Toolkit::Control                 mStencil;
 541   Toolkit::ScrollBar               mScrollBar;
 542   Dali::Animation                  mAnimation; ///< Scroll indicator Show/Hide Animation.
 543   Dali::TimePeriod                 mAnimationPeriod;
 544   std::vector<Actor>               mClippingDecorationActors; ///< Decoration actors which need clipping.
 545   std::vector<Toolkit::TextAnchor> mAnchorActors;
 546   Dali::InputMethodOptions         mInputMethodOptions;
 547
 548   Actor         mRenderableActor;
 549   Actor         mActiveLayer;
 550   Actor         mCursorLayer;
 551   Actor         mBackgroundActor;
 552   CallbackBase* mIdleCallback;
 553
 554   float mAlignmentOffset;
 555   float mScrollAnimationDuration;
 556   float mLineSpacing;
 557   int   mRenderingBackend;
 558   bool  mHasBeenStaged : 1;
 559   bool  mScrollAnimationEnabled : 1;
 560   bool  mScrollBarEnabled : 1;
 561   bool  mScrollStarted : 1;
 562   bool  mTextChanged : 1;           ///< If true, emits TextChangedSignal in next OnRelayout().
 563   bool  mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout().
 564   bool  mSelectionChanged : 1;      ///< If true, emits SelectionChangedSignal at the end of OnRelayout().
 565   bool  mSelectionCleared : 1;      ///< If true, emits SelectionClearedSignal at the end of OnRelayout().
 566
 567   //args for cursor PositionChanged event
 568   unsigned int mOldPosition;
 569
 570   //args for selection changed event
 571   uint32_t mOldSelectionStart;
 572   uint32_t mOldSelectionEnd;
 573
 574   bool mSelectionStarted : 1; ///< If true, emits SelectionStartedSignal at the end of OnRelayout().
 575
 576   struct PropertyHandler;
 577
 578   /**
 579    * @brief This structure is to connect TextEditor with Accessible functions.
 580    */
 581   class TextEditorAccessible : public EditableTextControlAccessible
 582   {
 583   public:
 584     using EditableTextControlAccessible::EditableTextControlAccessible;
 585
 586     /**
 587      * @copydoc Dali::Accessibility::Accessible::GetName()
 588      */
 589     std::string GetName() const override;
 590
 591   protected:
 592     /**
 593      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors()
 594      */
 595     const std::vector<Toolkit::TextAnchor>& GetTextAnchors() const override;
 596
 597     /**
 598      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController()
 599      */
 600     Toolkit::Text::ControllerPtr GetTextController() const override;
 601
 602     /**
 603      * @copydoc Dali::Toolkit::Internal::EditableTextControlAccessible::RequestTextRelayout()
 604      */
 605     void RequestTextRelayout() override;
 606   };
 607 };
 608
 609 } // namespace Internal
 610
 611 // Helpers for public-api forwarding methods
 612
 613 inline Toolkit::Internal::TextEditor& GetImpl(Toolkit::TextEditor& textEditor)
 614 {
 615   DALI_ASSERT_ALWAYS(textEditor);
 616
 617   Dali::RefObject& handle = textEditor.GetImplementation();
 618
 619   return static_cast<Toolkit::Internal::TextEditor&>(handle);
 620 }
 621
 622 inline const Toolkit::Internal::TextEditor& GetImpl(const Toolkit::TextEditor& textEditor)
 623 {
 624   DALI_ASSERT_ALWAYS(textEditor);
 625
 626   const Dali::RefObject& handle = textEditor.GetImplementation();
 627
 628   return static_cast<const Toolkit::Internal::TextEditor&>(handle);
 629 }
 630
 631 } // namespace Toolkit
 632
 633 } // namespace Dali
 634
 635 #endif // DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H