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