DALi Version 2.2.11
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / controls / text-controls / text-field-impl.h
1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_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/clipboard-event-notifier.h>
23 #include <dali/devel-api/adaptor-framework/input-method-context.h>
24 #include <dali/devel-api/atspi-interfaces/editable-text.h>
25 #include <dali/devel-api/atspi-interfaces/hypertext.h>
26 #include <dali/devel-api/atspi-interfaces/text.h>
27
28 // INTERNAL INCLUDES
29 #include <dali-toolkit/devel-api/controls/control-devel.h>
30 #include <dali-toolkit/devel-api/controls/text-controls/text-field-devel.h>
31 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
32 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
33 #include <dali-toolkit/internal/text/controller/text-controller.h>
34 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
35 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
36 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
37 #include <dali-toolkit/internal/text/text-control-interface.h>
38 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
39 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
40 #include <dali-toolkit/public-api/controls/control-impl.h>
41 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
42
43 namespace Dali
44 {
45 namespace Toolkit
46 {
47 namespace Internal
48 {
49 /**
50  * @brief A control which renders a short text string.
51  */
52 class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface, public Text::AnchorControlInterface
53 {
54 public:
55   /**
56    * @copydoc Dali::Toollkit::TextField::New()
57    * @param[in] additionalBehaviour custom behavior flags for this TextField. Default is CONTROL_BEHAVIOUR_DEFAULT
58    */
59   static Toolkit::TextField New(ControlBehaviour additionalBehaviour = ControlBehaviour::CONTROL_BEHAVIOUR_DEFAULT);
60
61   // Properties
62
63   /**
64    * @brief Called when a property of an object of this type is set.
65    *
66    * @param[in] object The object whose property is set.
67    * @param[in] index The property index.
68    * @param[in] value The new property value.
69    */
70   static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
71
72   /**
73    * @brief Called to retrieve a property of an object of this type.
74    *
75    * @param[in] object The object whose property is to be retrieved.
76    * @param[in] index The property index.
77    * @return The current value of the property.
78    */
79   static Property::Value GetProperty(BaseObject* object, Property::Index index);
80
81   /**
82    * @copydoc Dali::Toollkit::TextField::GetInputMethodContext()
83    */
84   InputMethodContext GetInputMethodContext();
85
86   /**
87    * Connects a callback function with the object's signals.
88    * @param[in] object The object providing the signal.
89    * @param[in] tracker Used to disconnect the signal.
90    * @param[in] signalName The signal to connect to.
91    * @param[in] functor A newly allocated FunctorDelegate.
92    * @return True if the signal was connected.
93    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
94    */
95   static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
96
97   /**
98    * @brief Gets text controller
99    *
100    * @return The text controller
101    */
102   Text::ControllerPtr GetTextController();
103
104   /**
105    * @copydoc TextField::TextChangedSignal()
106    */
107   Toolkit::TextField::TextChangedSignalType& TextChangedSignal();
108
109   /**
110    * @copydoc TextField::MaxLengthReachedSignal()
111    */
112   Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal();
113
114   /**
115    * @copydoc TextField::TextChangedSignal()
116    */
117   Toolkit::TextField::InputStyleChangedSignalType& InputStyleChangedSignal();
118
119   /**
120    * @copydoc TextField::AnchorClickedSignal()
121    */
122   DevelTextField::AnchorClickedSignalType& AnchorClickedSignal();
123
124   /**
125    * @copydoc TextField::CursorPositionChangedSignal()
126    */
127   DevelTextField::CursorPositionChangedSignalType& CursorPositionChangedSignal();
128
129   /**
130    * @copydoc TextField::InputFilteredSignal()
131    */
132   DevelTextField::InputFilteredSignalType& InputFilteredSignal();
133
134   /**
135    * @copydoc TextField::SelectionChangedSignal()
136    */
137   DevelTextField::SelectionChangedSignalType& SelectionChangedSignal();
138
139   /**
140    * @copydoc TextField::SelectionClearedSignal()
141    */
142   DevelTextField::SelectionClearedSignalType& SelectionClearedSignal();
143
144   /**
145    * @copydoc TextField::SelectionStartedSignal()
146    */
147   DevelTextField::SelectionStartedSignalType& SelectionStartedSignal();
148
149 private: // From Control
150   /**
151    * @copydoc Control::OnInitialize()
152    */
153   void OnInitialize() override;
154
155   /**
156    * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
157    */
158   DevelControl::ControlAccessible* CreateAccessibleObject() override;
159
160   /**
161    * @copydoc Control::OnStyleChange()
162    */
163   void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
164
165   /**
166    * @copydoc Control::GetNaturalSize()
167    */
168   Vector3 GetNaturalSize() override;
169
170   /**
171    * @copydoc Control::GetHeightForWidth()
172    */
173   float GetHeightForWidth(float width) override;
174
175   /**
176    * @copydoc Control::OnInitialize()
177    */
178   void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
179
180   /**
181    * @copydoc Control::OnKeyInputFocusGained()
182    */
183   void OnKeyInputFocusGained() override;
184
185   /**
186    * @copydoc Control::OnKeyInputFocusLost()
187    */
188   void OnKeyInputFocusLost() override;
189
190   /**
191    * @copydoc Control::OnAccessibilityActivated()
192    */
193   bool OnAccessibilityActivated() override;
194
195   /**
196    * @copydoc Control::OnTap()
197    */
198   void OnTap(const TapGesture& tap) override;
199
200   /**
201    * @copydoc Control::OnPan()
202    */
203   void OnPan(const PanGesture& gesture) override;
204
205   /**
206    * @copydoc Control::OnLongPress()
207    */
208   void OnLongPress(const LongPressGesture& gesture) override;
209
210   /**
211    * @copydoc Control::OnSceneConnection()
212    */
213   void OnSceneConnection(int depth) override;
214
215   /**
216    * @copydoc Control::OnPropertySet()
217    */
218   void OnPropertySet(Property::Index index, const Property::Value& propertyValue) override;
219
220   /**
221    * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
222    */
223   bool OnKeyEvent(const KeyEvent& event) override;
224
225   // From ControlInterface
226
227   /**
228    * @copydoc Text::ControlInterface::RequestTextRelayout()
229    */
230   void RequestTextRelayout() override;
231
232   // From EditableControlInterface
233
234   /**
235    * @copydoc Text::EditableControlInterface::TextChanged()
236    */
237   void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
238
239   /**
240    * @copydoc Text::EditableControlInterface::TextDeleted()
241    */
242   void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
243
244   /**
245    * @copydoc Text::EditableControlInterface::CursorPositionChanged()
246    */
247   void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
248
249   /**
250    * @copydoc Text::EditableControlInterface::TextChanged()
251    */
252   void TextChanged(bool immediate) override;
253
254   /**
255    * @copydoc Text::EditableControlInterface::MaxLengthReached()
256    */
257   void MaxLengthReached() override;
258
259   /**
260    * @copydoc Text::EditableControlInterface::InputStyleChanged()
261    */
262   void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
263
264   /**
265    * @copydoc Text::SelectableControlInterface::SelectionChanged()
266    */
267   void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
268
269   /**
270    * @copydoc Text::EditableControlInterface::AddDecoration()
271    */
272   void AddDecoration(Actor& actor, Toolkit::Text::DecorationType type, bool needsClipping) override;
273
274   /**
275    * @copydoc Text::EditableControlInterface::InputFiltered()
276    */
277   void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
278
279   /**
280    * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
281    */
282   void GetControlBackgroundColor(Vector4& color) const override;
283
284   // From SelectableControlInterface
285 public:
286   /**
287    * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
288    */
289   void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
290
291   /**
292    * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
293    */
294   Uint32Pair GetTextSelectionRange() const override;
295
296   /**
297    * @copydoc Text::SelectableControlInterface::SelectWholeText()
298    */
299   void SelectWholeText() override;
300
301   /**
302    * @copydoc Text::SelectableControlInterface::SelectNone()
303    */
304   void SelectNone() override;
305
306   /**
307    * @copydoc Text::SelectableControlInterface::SelectText()
308    */
309   void SelectText(const uint32_t start, const uint32_t end) override;
310
311   /**
312    * @copydoc Text::SelectableControlInterface::GetSelectedText()
313    */
314   string GetSelectedText() const override;
315
316   /**
317    * @copydoc Text::EditableControlInterface::IsEditable()
318    */
319   bool IsEditable() const override;
320
321   /**
322    * @copydoc Text::EditableControlInterface::SetEditable()
323    */
324   void SetEditable(bool editable) override;
325
326   /**
327    * @copydoc Dali::EditableControlInterface::CopyText()
328    */
329   string CopyText() override;
330
331   /**
332    * @copydoc Dali::EditableControlInterface::CutText()
333    */
334   string CutText() override;
335
336   /**
337    * @copydoc Text::EditableControlInterface::PasteText()
338    */
339   void PasteText() override;
340
341   // From AnchorControlInterface
342
343   /**
344    * @copydoc Text::AnchorControlInterface::AnchorClicked()
345    */
346   void AnchorClicked(const std::string& href) override;
347
348   /**
349    * @brief Get the rendered size of a specific text range.
350    * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
351    * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
352    *
353    * @param[in] startIndex start index of the text requested to calculate size for.
354    * @param[in] endIndex end index(included) of the text requested to calculate size for.
355    * @return list of sizes of the reuested text.
356    */
357   Vector<Vector2> GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const;
358
359   /**
360    * @brief Get the top/left rendered position of a specific text range.
361    * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
362    * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
363    *
364    * @param[in] startIndex start index of the text requested to get position to.
365    * @param[in] endIndex end index(included) of the text requested to get position to.
366    * @return list of positions of the requested text.
367    */
368   Vector<Vector2> GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const;
369
370   /**
371    * @brief Get the line bounding rectangle.
372    * if the requested index is out of range or the line is not yet rendered, a rect of {0, 0, 0, 0} is returned.
373    *
374    * @param[in] lineIndex line index to which we want to calculate the geometry for.
375    * @return bounding rectangle.
376    */
377   Rect<float> GetLineBoundingRectangle(const uint32_t lineIndex) const;
378
379   /**
380    * @brief Get the character bounding rectangle.
381    * If the text is not yet rendered or the index > text.Count(); a rect of {0, 0, 0, 0} is returned.
382    *
383    * @param[in] charIndex character index to which we want to calculate the geometry for.
384    * @return bounding rectangle.
385    */
386   Rect<float> GetCharacterBoundingRectangle(const uint32_t charIndex) const;
387
388   /**
389    * @brief Get the character index.
390    * If the text is not yet rendered or the text is empty, -1 is returned.
391    *
392    * @param[in] visualX visual x position.
393    * @param[in] visualY visual y position.
394    * @return character index.
395    */
396   int GetCharacterIndexAtPosition(float visualX, float visualY) const;
397
398   /**
399    * @brief Gets the bounding box of a specific text range.
400    *
401    * @param[in] startIndex start index of the text requested to get bounding box to.
402    * @param[in] endIndex end index(included) of the text requested to get bounding box to.
403    * @return bounding box of the requested text.
404    */
405   Rect<> GetTextBoundingRectangle(uint32_t startIndex, uint32_t endIndex) const;
406
407   /**
408    * @brief Set the @p spannedText into current textField
409    * the spanned text contains content (text) and  format (spans with ranges)
410    * the text is copied into text-controller and the spans are applied on ranges
411    *
412    * @param[in] spannedText the text with spans.
413    */
414   void SetSpannedText(const Text::Spanned& spannedText);
415
416 private: // Implementation
417   /**
418    * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
419    */
420   InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
421
422   /**
423    * @brief Callback when Clipboard signals an item should be pasted
424    * @param[in] clipboard handle to Clipboard Event Notifier
425    */
426   void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
427
428   /**
429    * @brief Get a Property Map for the image used for the required Handle Image
430    * @param[out] value the returned image property
431    * @param[in] handleType the type of handle
432    * @param[in] handleImageType the type of image for the given handleType
433    */
434   void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
435
436   /**
437    * @brief Enable or disable clipping.
438    */
439   void EnableClipping();
440
441   /**
442    * @brief Callback when keyboard is shown/hidden.
443    *
444    * @param[in] keyboardShown True if keyboard is shown.
445    */
446   void KeyboardStatusChanged(bool keyboardShown);
447
448   /**
449    * @brief Callback when TextField is touched
450    *
451    * @param[in] actor TextField touched
452    * @param[in] touch Touch information
453    */
454   bool OnTouched(Actor actor, const TouchEvent& touch);
455
456   /**
457    * @brief Callbacks called on idle.
458    *
459    * If there are notifications of change of input style on the queue, Toolkit::TextField::InputStyleChangedSignal() are emitted.
460    */
461   void OnIdleSignal();
462
463   /**
464    * @brief Emits TextChanged signal.
465    */
466   void EmitTextChangedSignal();
467
468   /**
469    * @brief Emits CursorPositionChanged signal.
470    */
471   void EmitCursorPositionChangedSignal();
472
473   /**
474    * @brief Emits SelectionChanged signal.
475    */
476   void EmitSelectionChangedSignal();
477
478   /**
479    * @brief Emits SelectionCleared signal.
480    */
481   void EmitSelectionClearedSignal();
482
483   /**
484    * @brief Emits SelectionStarted signal.
485    */
486   void EmitSelectionStartedSignal();
487
488   /**
489    * @brief Callback function for when the layout is changed.
490    * @param[in] actor The actor whose layoutDirection is changed.
491    * @param[in] type  The layoutDirection.
492    */
493   void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
494
495   /**
496   * @brief Add a layer for active or cursor.
497   * @param[in] layer The actor in which to store the layer.
498   * @param[in] actor The new layer to add.
499   */
500   void AddLayer(Actor& layer, Actor& actor);
501
502   /**
503    * Construct a new TextField.
504    *
505    * @param[in] additionalBehaviour additional behaviour flags for this TextField
506    */
507   TextField(ControlBehaviour additionalBehaviour);
508
509   /**
510    * A reference counted object may only be deleted by calling Unreference()
511    */
512   virtual ~TextField();
513
514   // Undefined copy constructor and assignment operators
515   TextField(const TextField&);
516   TextField& operator=(const TextField& rhs);
517
518   /**
519    * @brief Resize actor to the given size.
520    *
521    * @param[in] actor The actor to be resized.
522    * @param[in] size Size to change.
523    */
524   void ResizeActor(Actor& actor, const Vector2& size);
525
526   /**
527    * @brief Render view, create and attach actor(s) to this Text Field.
528    */
529   void RenderText(Text::Controller::UpdateTextType updateTextType);
530
531   // Connection needed to re-render text, when a Text Field returns to the scene.
532   void OnSceneConnect(Dali::Actor actor);
533
534   // Needed to synchronize TextAnchor actors with Anchor objects in text's logical model
535   void OnAccessibilityStatusChanged();
536
537 private: // Data
538   // Signals
539   Toolkit::TextField::TextChangedSignalType                mTextChangedSignal;
540   Toolkit::TextField::MaxLengthReachedSignalType           mMaxLengthReachedSignal;
541   Toolkit::TextField::InputStyleChangedSignalType          mInputStyleChangedSignal;
542   Toolkit::DevelTextField::AnchorClickedSignalType         mAnchorClickedSignal;
543   Toolkit::DevelTextField::InputFilteredSignalType         mInputFilteredSignal;
544   Toolkit::DevelTextField::CursorPositionChangedSignalType mCursorPositionChangedSignal;
545   Toolkit::DevelTextField::SelectionChangedSignalType      mSelectionChangedSignal;
546   Toolkit::DevelTextField::SelectionClearedSignalType      mSelectionClearedSignal;
547   Toolkit::DevelTextField::SelectionStartedSignalType      mSelectionStartedSignal;
548
549   InputMethodContext               mInputMethodContext;
550   Text::ControllerPtr              mController;
551   Text::RendererPtr                mRenderer;
552   Text::DecoratorPtr               mDecorator;
553   Toolkit::Control                 mStencil;                  ///< For EXCEED_POLICY_CLIP
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   int   mRenderingBackend;
566   int   mExceedPolicy;
567   bool  mHasBeenStaged : 1;
568   bool  mTextChanged : 1;           ///< If true, emits TextChangedSignal in next OnRelayout().
569   bool  mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout().
570   bool  mSelectionChanged : 1;      ///< If true, emits SelectionChangedSignal at the end of OnRelayout().
571   bool  mSelectionCleared : 1;      ///< If true, emits SelectionClearedSignal at the end of OnRelayout().
572
573   //args for cursor position changed event
574   unsigned int mOldPosition;
575
576   //args for selection changed event
577   uint32_t mOldSelectionStart;
578   uint32_t mOldSelectionEnd;
579
580   bool mSelectionStarted : 1; ///< If true, emits SelectionStartedSignal at the end of OnRelayout().
581
582 protected:
583   struct PropertyHandler;
584
585   /**
586    * @brief This structure is to connect TextField with Accessible functions.
587    */
588   class TextFieldAccessible : public EditableTextControlAccessible
589   {
590   public:
591     using EditableTextControlAccessible::EditableTextControlAccessible;
592
593     /**
594      * @copydoc Dali::Accessibility::Accessible::GetName()
595      */
596     std::string GetName() const override;
597
598   protected:
599     /**
600      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors()
601      */
602     const std::vector<Toolkit::TextAnchor>& GetTextAnchors() const override;
603
604     /**
605      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController()
606      */
607     Toolkit::Text::ControllerPtr GetTextController() const override;
608
609     /**
610      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetSubstituteCharacter()
611      */
612     std::uint32_t GetSubstituteCharacter() const override;
613
614     /**
615      * @copydoc Dali::Toolkit::Internal::TextControlAccessible::IsHiddenInput()
616      */
617     bool IsHiddenInput() const override;
618
619     /**
620      * @copydoc Dali::Toolkit::Internal::EditableTextControlAccessible::RequestTextRelayout()
621      */
622     void RequestTextRelayout() override;
623   };
624 };
625
626 } // namespace Internal
627
628 // Helpers for public-api forwarding methods
629
630 inline Toolkit::Internal::TextField& GetImpl(Toolkit::TextField& textField)
631 {
632   DALI_ASSERT_ALWAYS(textField);
633
634   Dali::RefObject& handle = textField.GetImplementation();
635
636   return static_cast<Toolkit::Internal::TextField&>(handle);
637 }
638
639 inline const Toolkit::Internal::TextField& GetImpl(const Toolkit::TextField& textField)
640 {
641   DALI_ASSERT_ALWAYS(textField);
642
643   const Dali::RefObject& handle = textField.GetImplementation();
644
645   return static_cast<const Toolkit::Internal::TextField&>(handle);
646 }
647
648 } // namespace Toolkit
649
650 } // namespace Dali
651
652 #endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H