Merge "fix linespacing calculation in TextLabel" into devel/master
[platform/core/uifw/dali-toolkit.git] / 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 Toolkit::Internal::Control::CreateAccessibleObject()
165    */
166   DevelControl::ControlAccessible* CreateAccessibleObject() override;
167
168   /**
169    * @copydoc Control::OnStyleChange()
170    */
171   void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
172
173   /**
174    * @copydoc Control::GetNaturalSize()
175    */
176   Vector3 GetNaturalSize() override;
177
178   /**
179    * @copydoc Control::GetHeightForWidth()
180    */
181   float GetHeightForWidth(float width) override;
182
183   /**
184    * @copydoc Control::OnInitialize()
185    */
186   void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
187
188   /**
189    * @copydoc Control::OnKeyInputFocusGained()
190    */
191   void OnKeyInputFocusGained() override;
192
193   /**
194    * @copydoc Control::OnKeyInputFocusLost()
195    */
196   void OnKeyInputFocusLost() override;
197
198   /**
199    * @copydoc Control::OnAccessibilityActivated()
200    */
201   bool OnAccessibilityActivated() override;
202
203   /**
204    * @copydoc Control::OnTap()
205    */
206   void OnTap(const TapGesture& tap) override;
207
208   /**
209    * @copydoc Control::OnPan()
210    */
211   void OnPan(const PanGesture& gesture) override;
212
213   /**
214    * @copydoc Control::OnLongPress()
215    */
216   void OnLongPress(const LongPressGesture& gesture) override;
217
218   /**
219    * @copydoc Control::OnSceneConnection()
220    */
221   void OnSceneConnection(int depth) override;
222
223   /**
224    * @copydoc Control::OnPropertySet()
225    */
226   void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
227
228   /**
229    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
230    */
231   bool OnKeyEvent(const KeyEvent& event) override;
232
233   // From ControlInterface
234
235   /**
236    * @copydoc Text::ControlInterface::RequestTextRelayout()
237    */
238   void RequestTextRelayout() override;
239
240   // From EditableControlInterface
241
242   /**
243    * @copydoc Text::EditableControlInterface::TextChanged()
244    */
245   void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
246
247   /**
248    * @copydoc Text::EditableControlInterface::TextDeleted()
249    */
250   void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
251
252   /**
253    * @copydoc Text::EditableControlInterface::CursorPositionChanged()
254    */
255   void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
256
257   /**
258    * @copydoc Text::EditableControlInterface::TextChanged()
259    */
260   void TextChanged(bool immediate) override;
261
262   /**
263    * @copydoc Text::EditableControlInterface::MaxLengthReached()
264    */
265   void MaxLengthReached() override;
266
267   /**
268    * @copydoc Text::EditableControlInterface::InputStyleChanged()
269    */
270   void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
271
272   /**
273    * @copydoc Text::SelectableControlInterface::SelectionChanged()
274    */
275   void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
276
277   /**
278    * @copydoc Text::EditableControlInterface::AddDecoration()
279    */
280   void AddDecoration(Actor& actor, Toolkit::Text::DecorationType type, bool needsClipping) override;
281
282   /**
283    * @copydoc Text::EditableControlInterface::InputFiltered()
284    */
285   void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
286
287   /**
288    * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
289    */
290   void GetControlBackgroundColor(Vector4& color) const override;
291
292   // From SelectableControlInterface
293 public:
294   /**
295    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
296    */
297   void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
298
299   /**
300    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
301    */
302   Uint32Pair GetTextSelectionRange() const override;
303
304   /**
305    * @copydoc Text::SelectableControlInterface::SelectWholeText()
306    */
307   void SelectWholeText() override;
308
309   /**
310    * @copydoc Text::SelectableControlInterface::SelectNone()
311    */
312   void SelectNone() override;
313
314   /**
315    * @copydoc Text::SelectableControlInterface::SelectText()
316    */
317   void SelectText(const uint32_t start, const uint32_t end) override;
318
319   /**
320    * @copydoc Dali::Toolkit::DevelTextEditor::ScrollBy()
321    */
322   void ScrollBy(Vector2 Scroll);
323
324   /**
325    * @brief Get Horizontal scroll position of TextEditor.
326    *
327    * @return Horizontal scroll position (in pixels) of TextEditor.
328    */
329   float GetHorizontalScrollPosition();
330
331   /**
332    * @brief Get Vertical scroll position of TextEditor.
333    *
334    * @return Vertical scroll position (in pixels) of TextEditor.
335    */
336   float GetVerticalScrollPosition();
337
338   /**
339    * @brief Get the rendered size of a specific text range.
340    * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
341    * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
342    *
343    * @param[in] startIndex start index of the text requested to calculate size for.
344    * @param[in] endIndex end index(included) of the text requested to calculate size for.
345    * @return list of sizes of the reuested text.
346    */
347   Vector<Vector2> GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const;
348
349   /**
350    * @brief Get the top/left rendered position of a specific text range.
351    * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
352    * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
353    *
354    * @param[in] startIndex start index of the text requested to get position to.
355    * @param[in] endIndex end index(included) of the text requested to get position to.
356    * @return list of positions of the requested text.
357    */
358   Vector<Vector2> GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const;
359
360   /**
361    * @copydoc Text::SelectableControlInterface::GetSelectedText()
362    */
363   string GetSelectedText() const override;
364
365   /**
366    * @copydoc Text::EditableControlInterface::IsEditable()
367    */
368   bool IsEditable() const override;
369
370   /**
371    * @copydoc Text::EditableControlInterface::SetEditable()
372    */
373   void SetEditable(bool editable) override;
374
375   /**
376    * @copydoc Text::EditableControlInterface::CopyText()
377    */
378   string CopyText() override;
379
380   /**
381    * @copydoc Text::EditableControlInterface::CutText()
382    */
383   string CutText() override;
384
385   /**
386    * @copydoc Text::EditableControlInterface::PasteText()
387    */
388   void PasteText() override;
389
390   // From AnchorControlInterface
391
392   /**
393    * @copydoc Text::AnchorControlInterface::AnchorClicked()
394    */
395   void AnchorClicked(const std::string& href) override;
396
397 private: // Implementation
398   /**
399    * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
400    */
401   InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
402
403   /**
404    * @brief Callback when Clipboard signals an item should be pasted
405    * @param[in] clipboard handle to Clipboard Event Notifier
406    */
407   void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
408
409   /**
410    * @brief Get a Property Map for the image used for the required Handle Image
411    * @param[out] value the returned image property
412    * @param[in] handleType the type of handle
413    * @param[in] handleImageType the type of image for the given handleType
414    */
415   void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
416
417   /**
418    * @brief Callback when keyboard is shown/hidden.
419    *
420    * @param[in] keyboardShown True if keyboard is shown.
421    */
422   void KeyboardStatusChanged(bool keyboardShown);
423
424   /**
425    * @brief update scroll bar position
426    *
427    * If text scroll is occurred, create or update scroll bar position
428    */
429   void UpdateScrollBar();
430
431   /**
432    * @brief Callback when TextEditor is touched
433    *
434    * @param[in] actor TextEditor touched
435    * @param[in] touch Touch information
436    */
437   bool OnTouched(Actor actor, const TouchEvent& touch);
438
439   /**
440    * @brief Callbacks called on idle.
441    *
442    * If there are notifications of change of input style on the queue, Toolkit::TextEditor::InputStyleChangedSignal() are emitted.
443    */
444   void OnIdleSignal();
445
446   /**
447    * @brief Emits CursorPositionChanged signal.
448    */
449   void EmitCursorPositionChangedSignal();
450
451   /**
452    * @brief Emits TextChanged signal.
453    */
454   void EmitTextChangedSignal();
455
456   /**
457    * @brief Emits SelectionChanged signal.
458    */
459   void EmitSelectionChangedSignal();
460
461   /**
462    * @brief Emits SelectionCleared signal.
463    */
464   void EmitSelectionClearedSignal();
465
466   /**
467    * @brief Emits SelectionStarted signal.
468    */
469   void EmitSelectionStartedSignal();
470
471   /**
472    * @brief set RenderActor's position with new scrollPosition
473    *
474    * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled
475    */
476   void ApplyScrollPosition();
477
478   /**
479    * @brief Callback function for ScrollBar indicator animation finished signal
480    *
481    * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false
482    */
483   void OnScrollIndicatorAnimationFinished(Animation& animation);
484
485   /**
486   * @brief Callback function for when the layout is changed.
487   * @param[in] actor The actor whose layoutDirection is changed.
488   * @param[in] type  The layoutDirection.
489   */
490   void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
491
492   /**
493   * @brief Add a layer for active or cursor.
494   * @param[in] layer The actor in which to store the layer.
495   * @param[in] actor The new layer to add.
496   */
497   void AddLayer(Actor& layer, Actor& actor);
498
499   /**
500    * Construct a new TextEditor.
501    */
502   TextEditor();
503
504   /**
505    * A reference counted object may only be deleted by calling Unreference()
506    */
507   virtual ~TextEditor();
508
509   // Undefined copy constructor and assignment operators
510   TextEditor(const TextEditor&);
511   TextEditor& operator=(const TextEditor& rhs);
512
513   /**
514    * @brief Resize actor to the given size.
515    *
516    * @param[in] actor The actor to be resized.
517    * @param[in] size Size to change.
518    */
519   void ResizeActor(Actor& actor, const Vector2& size);
520
521   /**
522    * @brief Render view, create and attach actor(s) to this text editor.
523    */
524   void RenderText(Text::Controller::UpdateTextType updateTextType);
525
526   // Connection needed to re-render text, when a text editor returns to the scene.
527   void OnSceneConnect(Dali::Actor actor);
528
529   // Needed to synchronize TextAnchor actors with Anchor objects in text's logical model
530   void OnAccessibilityStatusChanged();
531
532 private: // Data
533   // Signals
534   Toolkit::TextEditor::TextChangedSignalType                mTextChangedSignal;
535   Toolkit::TextEditor::InputStyleChangedSignalType          mInputStyleChangedSignal;
536   Toolkit::TextEditor::ScrollStateChangedSignalType         mScrollStateChangedSignal;
537   Toolkit::DevelTextEditor::MaxLengthReachedSignalType      mMaxLengthReachedSignal;
538   Toolkit::DevelTextEditor::AnchorClickedSignalType         mAnchorClickedSignal;
539   Toolkit::DevelTextEditor::InputFilteredSignalType         mInputFilteredSignal;
540   Toolkit::DevelTextEditor::CursorPositionChangedSignalType mCursorPositionChangedSignal;
541   Toolkit::DevelTextEditor::SelectionChangedSignalType      mSelectionChangedSignal;
542   Toolkit::DevelTextEditor::SelectionClearedSignalType      mSelectionClearedSignal;
543   Toolkit::DevelTextEditor::SelectionStartedSignalType      mSelectionStartedSignal;
544
545   InputMethodContext               mInputMethodContext;
546   Text::ControllerPtr              mController;
547   Text::RendererPtr                mRenderer;
548   Text::DecoratorPtr               mDecorator;
549   Text::TextVerticalScrollerPtr    mTextVerticalScroller;
550   Toolkit::Control                 mStencil;
551   Toolkit::ScrollBar               mScrollBar;
552   Dali::Animation                  mAnimation; ///< Scroll indicator Show/Hide Animation.
553   Dali::TimePeriod                 mAnimationPeriod;
554   std::vector<Actor>               mClippingDecorationActors; ///< Decoration actors which need clipping.
555   std::vector<Toolkit::TextAnchor> mAnchorActors;
556   Dali::InputMethodOptions         mInputMethodOptions;
557
558   Actor         mRenderableActor;
559   Actor         mActiveLayer;
560   Actor         mCursorLayer;
561   Actor         mBackgroundActor;
562   CallbackBase* mIdleCallback;
563
564   float mAlignmentOffset;
565   float mScrollAnimationDuration;
566   float mLineSpacing;
567   int   mRenderingBackend;
568   bool  mHasBeenStaged : 1;
569   bool  mScrollAnimationEnabled : 1;
570   bool  mScrollBarEnabled : 1;
571   bool  mScrollStarted : 1;
572   bool  mTextChanged : 1;           ///< If true, emits TextChangedSignal in next OnRelayout().
573   bool  mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout().
574   bool  mSelectionChanged : 1;      ///< If true, emits SelectionChangedSignal at the end of OnRelayout().
575   bool  mSelectionCleared : 1;      ///< If true, emits SelectionClearedSignal at the end of OnRelayout().
576
577   //args for cursor PositionChanged event
578   unsigned int mOldPosition;
579
580   //args for selection changed event
581   uint32_t mOldSelectionStart;
582   uint32_t mOldSelectionEnd;
583
584   bool mSelectionStarted : 1; ///< If true, emits SelectionStartedSignal at the end of OnRelayout().
585
586   struct PropertyHandler;
587
588   /**
589    * @brief This structure is to connect TextEditor with Accessible functions.
590    */
591   class TextEditorAccessible : public EditableTextControlAccessible
592   {
593   public:
594     using EditableTextControlAccessible::EditableTextControlAccessible;
595
596     /**
597      * @copydoc Dali::Accessibility::Accessible::GetName()
598      */
599     std::string GetName() const override;
600
601   protected:
602     /**
603      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors()
604      */
605     const std::vector<Toolkit::TextAnchor>& GetTextAnchors() const override;
606
607     /**
608      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController()
609      */
610     Toolkit::Text::ControllerPtr GetTextController() const override;
611
612     /**
613      * @copydoc Dali::Toolkit::Internal::EditableTextControlAccessible::RequestTextRelayout()
614      */
615     void RequestTextRelayout() override;
616   };
617 };
618
619 } // namespace Internal
620
621 // Helpers for public-api forwarding methods
622
623 inline Toolkit::Internal::TextEditor& GetImpl(Toolkit::TextEditor& textEditor)
624 {
625   DALI_ASSERT_ALWAYS(textEditor);
626
627   Dali::RefObject& handle = textEditor.GetImplementation();
628
629   return static_cast<Toolkit::Internal::TextEditor&>(handle);
630 }
631
632 inline const Toolkit::Internal::TextEditor& GetImpl(const Toolkit::TextEditor& textEditor)
633 {
634   DALI_ASSERT_ALWAYS(textEditor);
635
636   const Dali::RefObject& handle = textEditor.GetImplementation();
637
638   return static_cast<const Toolkit::Internal::TextEditor&>(handle);
639 }
640
641 } // namespace Toolkit
642
643 } // namespace Dali
644
645 #endif // DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H