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