1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
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>
50 * @brief A control which renders a long text string with styles.
52 class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface, public Text::AnchorControlInterface
56 * @copydoc Dali::Toollkit::TextEditor::New()
58 static Toolkit::TextEditor New();
63 * @brief Called when a property of an object of this type is set.
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.
69 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
72 * @brief Called to retrieve a property of an object of this type.
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.
78 static Property::Value GetProperty(BaseObject* object, Property::Index index);
81 * @copydoc Dali::Toollkit::TextEditor::GetInputMethodContext()
83 InputMethodContext GetInputMethodContext();
86 * @copydoc Dali::Toollkit::TextEditor::MaxLengthReachedSignal()
88 DevelTextEditor::MaxLengthReachedSignalType& MaxLengthReachedSignal();
91 * @copydoc Dali::Toollkit::TextEditor::AnchorClickedSignal()
93 DevelTextEditor::AnchorClickedSignalType& AnchorClickedSignal();
96 * @copydoc Dali::Toollkit::TextEditor::CursorPositionChangedSignal()
98 DevelTextEditor::CursorPositionChangedSignalType& CursorPositionChangedSignal();
101 * @copydoc Dali::Toollkit::TextEditor::InputFilteredSignal()
103 DevelTextEditor::InputFilteredSignalType& InputFilteredSignal();
106 * @copydoc Dali::Toollkit::TextEditor::SelectionChangedSignal()
108 DevelTextEditor::SelectionChangedSignalType& SelectionChangedSignal();
111 * @copydoc Dali::Toollkit::TextEditor::SelectionClearedSignal()
113 DevelTextEditor::SelectionClearedSignalType& SelectionClearedSignal();
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.
124 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
127 * @brief Gets text controller
129 * @return The text controller
131 Text::ControllerPtr GetTextController();
134 * @copydoc TextEditor::TextChangedSignal()
136 Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal();
139 * @copydoc TextEditor::TextChangedSignal()
141 Toolkit::TextEditor::InputStyleChangedSignalType& InputStyleChangedSignal();
144 * @copydoc TextEditor::ScrollStateChangedSignal()
146 Toolkit::TextEditor::ScrollStateChangedSignalType& ScrollStateChangedSignal();
148 private: // From Control
150 * @copydoc Control::OnInitialize()
152 void OnInitialize() override;
155 * @copydoc Control::OnStyleChange()
157 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
160 * @copydoc Control::GetNaturalSize()
162 Vector3 GetNaturalSize() override;
165 * @copydoc Control::GetHeightForWidth()
167 float GetHeightForWidth(float width) override;
170 * @copydoc Control::OnInitialize()
172 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
175 * @copydoc Control::OnKeyInputFocusGained()
177 void OnKeyInputFocusGained() override;
180 * @copydoc Control::OnKeyInputFocusLost()
182 void OnKeyInputFocusLost() override;
185 * @copydoc Control::OnAccessibilityActivated()
187 bool OnAccessibilityActivated() override;
190 * @copydoc Control::OnTap()
192 void OnTap(const TapGesture& tap) override;
195 * @copydoc Control::OnPan()
197 void OnPan(const PanGesture& gesture) override;
200 * @copydoc Control::OnLongPress()
202 void OnLongPress(const LongPressGesture& gesture) override;
205 * @copydoc Control::OnSceneConnection()
207 void OnSceneConnection(int depth) override;
210 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
212 bool OnKeyEvent(const KeyEvent& event) override;
214 // From ControlInterface
217 * @copydoc Text::ControlInterface::RequestTextRelayout()
219 void RequestTextRelayout() override;
221 // From EditableControlInterface
224 * @copydoc Text::EditableControlInterface::TextChanged()
226 void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
229 * @copydoc Text::EditableControlInterface::TextDeleted()
231 void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
234 * @copydoc Text::EditableControlInterface::CursorPositionChanged()
236 void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
239 * @copydoc Text::EditableControlInterface::TextChanged()
241 void TextChanged(bool immediate) override;
244 * @copydoc Text::EditableControlInterface::MaxLengthReached()
246 void MaxLengthReached() override;
249 * @copydoc Text::EditableControlInterface::InputStyleChanged()
251 void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
254 * @copydoc Text::SelectableControlInterface::SelectionChanged()
256 void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
259 * @copydoc Text::EditableControlInterface::AddDecoration()
261 void AddDecoration(Actor& actor, bool needsClipping) override;
264 * @copydoc Text::EditableControlInterface::InputFiltered()
266 void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
269 * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
271 void GetControlBackgroundColor(Vector4& color) const override;
273 // From SelectableControlInterface
276 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
278 void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
281 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
283 Uint32Pair GetTextSelectionRange() const override;
286 * @copydoc Text::SelectableControlInterface::SelectWholeText()
288 void SelectWholeText() override;
291 * @copydoc Text::SelectableControlInterface::SelectNone()
293 void SelectNone() override;
296 * @copydoc Text::SelectableControlInterface::SelectText()
298 void SelectText(const uint32_t start, const uint32_t end) override;
301 * @copydoc Dali::Toolkit::DevelTextEditor::ScrollBy()
303 void ScrollBy(Vector2 Scroll);
306 * @brief Get Horizontal scroll position of TextEditor.
308 * @return Horizontal scroll position (in pixels) of TextEditor.
310 float GetHorizontalScrollPosition();
313 * @brief Get Vertical scroll position of TextEditor.
315 * @return Vertical scroll position (in pixels) of TextEditor.
317 float GetVerticalScrollPosition();
320 * @copydoc Text::SelectableControlInterface::GetSelectedText()
322 string GetSelectedText() const override;
325 * @copydoc Text::EditableControlInterface::IsEditable()
327 bool IsEditable() const override;
330 * @copydoc Text::EditableControlInterface::SetEditable()
332 void SetEditable(bool editable) override;
335 * @copydoc Text::EditableControlInterface::CopyText()
337 string CopyText() override;
340 * @copydoc Text::EditableControlInterface::CutText()
342 string CutText() override;
345 * @copydoc Text::EditableControlInterface::PasteText()
347 void PasteText() override;
349 // From AnchorControlInterface
352 * @copydoc Text::AnchorControlInterface::AnchorClicked()
354 void AnchorClicked(const std::string& href) override;
356 private: // Implementation
358 * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
360 InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
363 * @brief Callback when Clipboard signals an item should be pasted
364 * @param[in] clipboard handle to Clipboard Event Notifier
366 void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
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
374 void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
377 * @brief Callback when keyboard is shown/hidden.
379 * @param[in] keyboardShown True if keyboard is shown.
381 void KeyboardStatusChanged(bool keyboardShown);
384 * @brief update scroll bar position
386 * If text scroll is occurred, create or update scroll bar position
388 void UpdateScrollBar();
391 * @brief Callback when TextEditor is touched
393 * @param[in] actor TextEditor touched
394 * @param[in] touch Touch information
396 bool OnTouched(Actor actor, const TouchEvent& touch);
399 * @brief Callbacks called on idle.
401 * If there are notifications of change of input style on the queue, Toolkit::TextEditor::InputStyleChangedSignal() are emitted.
406 * @brief Emits CursorPositionChanged signal.
408 void EmitCursorPositionChangedSignal();
411 * @brief Emits TextChanged signal.
413 void EmitTextChangedSignal();
416 * @brief Emits SelectionChanged signal.
418 void EmitSelectionChangedSignal();
421 * @brief Emits SelectionCleared signal.
423 void EmitSelectionClearedSignal();
426 * @brief set RenderActor's position with new scrollPosition
428 * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled
430 void ApplyScrollPosition();
433 * @brief Callback function for ScrollBar indicator animation finished signal
435 * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false
437 void OnScrollIndicatorAnimationFinished(Animation& animation);
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.
444 void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
447 * Construct a new TextEditor.
452 * A reference counted object may only be deleted by calling Unreference()
454 virtual ~TextEditor();
456 // Undefined copy constructor and assignment operators
457 TextEditor(const TextEditor&);
458 TextEditor& operator=(const TextEditor& rhs);
461 * @brief Resize actor to the given size.
463 * @param[in] actor The actor to be resized.
464 * @param[in] size Size to change.
466 void ResizeActor(Actor& actor, const Vector2& size);
469 * @brief Render view, create and attach actor(s) to this text editor.
471 void RenderText(Text::Controller::UpdateTextType updateTextType);
473 // Connection needed to re-render text, when a text editor returns to the scene.
474 void OnSceneConnect(Dali::Actor actor);
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;
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;
500 Actor mRenderableActor;
502 Actor mBackgroundActor;
503 CallbackBase* mIdleCallback;
505 float mAlignmentOffset;
506 float mScrollAnimationDuration;
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().
518 //args for cursor PositionChanged event
519 unsigned int mOldPosition;
521 //args for selection changed event
522 uint32_t mOldSelectionStart;
523 uint32_t mOldSelectionEnd;
526 * @brief This structure is to connect TextEditor with Accessible functions.
528 struct AccessibleImpl : public DevelControl::AccessibleImpl,
529 public virtual Dali::Accessibility::Text,
530 public virtual Dali::Accessibility::EditableText
532 using DevelControl::AccessibleImpl::AccessibleImpl;
535 * @copydoc Dali::Accessibility::Accessible::GetName()
537 std::string GetName() override;
540 * @copydoc Dali::Accessibility::Text::GetText()
542 std::string GetText(size_t startOffset, size_t endOffset) override;
545 * @copydoc Dali::Accessibility::Text::GetCharacterCount()
547 size_t GetCharacterCount() override;
550 * @copydoc Dali::Accessibility::Text::GetCursorOffset()
552 size_t GetCursorOffset() override;
555 * @copydoc Dali::Accessibility::Text::SetCursorOffset()
557 bool SetCursorOffset(size_t offset) override;
560 * @copydoc Dali::Accessibility::Text::GetTextAtOffset()
562 Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
565 * @copydoc Dali::Accessibility::Text::GetRangeOfSelection()
567 Accessibility::Range GetRangeOfSelection(size_t selectionIndex) override;
570 * @copydoc Dali::Accessibility::Text::RemoveSelection()
572 bool RemoveSelection(size_t selectionIndex) override;
575 * @copydoc Dali::Accessibility::Text::SetRangeOfSelection()
577 bool SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset) override;
580 * @copydoc Dali::Accessibility::EditableText::CopyText()
582 bool CopyText(size_t startPosition, size_t endPosition) override;
585 * @copydoc Dali::Accessibility::EditableText::CutText()
587 bool CutText(size_t startPosition, size_t endPosition) override;
590 * @copydoc Dali::Accessibility::Accessible::GetStates()
592 Accessibility::States CalculateStates() override;
595 * @copydoc Dali::Accessibility::EditableText::InsertText()
597 bool InsertText(size_t startPosition, std::string text) override;
600 * @copydoc Dali::Accessibility::EditableText::SetTextContents()
602 bool SetTextContents(std::string newContents) override;
605 * @copydoc Dali::Accessibility::EditableText::DeleteText()
607 bool DeleteText(size_t startPosition, size_t endPosition) override;
611 } // namespace Internal
613 // Helpers for public-api forwarding methods
615 inline Toolkit::Internal::TextEditor& GetImpl(Toolkit::TextEditor& textEditor)
617 DALI_ASSERT_ALWAYS(textEditor);
619 Dali::RefObject& handle = textEditor.GetImplementation();
621 return static_cast<Toolkit::Internal::TextEditor&>(handle);
624 inline const Toolkit::Internal::TextEditor& GetImpl(const Toolkit::TextEditor& textEditor)
626 DALI_ASSERT_ALWAYS(textEditor);
628 const Dali::RefObject& handle = textEditor.GetImplementation();
630 return static_cast<const Toolkit::Internal::TextEditor&>(handle);
633 } // namespace Toolkit
637 #endif // DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H