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