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