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