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 * Connects a callback function with the object's signals.
112 * @param[in] object The object providing the signal.
113 * @param[in] tracker Used to disconnect the signal.
114 * @param[in] signalName The signal to connect to.
115 * @param[in] functor A newly allocated FunctorDelegate.
116 * @return True if the signal was connected.
117 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
119 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
122 * @brief Gets text controller
124 * @return The text controller
126 Text::ControllerPtr GetTextController();
129 * @copydoc TextEditor::TextChangedSignal()
131 Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal();
134 * @copydoc TextEditor::TextChangedSignal()
136 Toolkit::TextEditor::InputStyleChangedSignalType& InputStyleChangedSignal();
139 * @copydoc TextEditor::ScrollStateChangedSignal()
141 Toolkit::TextEditor::ScrollStateChangedSignalType& ScrollStateChangedSignal();
143 private: // From Control
145 * @copydoc Control::OnInitialize()
147 void OnInitialize() override;
150 * @copydoc Control::OnStyleChange()
152 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
155 * @copydoc Control::GetNaturalSize()
157 Vector3 GetNaturalSize() override;
160 * @copydoc Control::GetHeightForWidth()
162 float GetHeightForWidth(float width) override;
165 * @copydoc Control::OnInitialize()
167 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
170 * @copydoc Control::OnKeyInputFocusGained()
172 void OnKeyInputFocusGained() override;
175 * @copydoc Control::OnKeyInputFocusLost()
177 void OnKeyInputFocusLost() override;
180 * @copydoc Control::OnAccessibilityActivated()
182 bool OnAccessibilityActivated() override;
185 * @copydoc Control::OnTap()
187 void OnTap(const TapGesture& tap) override;
190 * @copydoc Control::OnPan()
192 void OnPan(const PanGesture& gesture) override;
195 * @copydoc Control::OnLongPress()
197 void OnLongPress(const LongPressGesture& gesture) override;
200 * @copydoc Control::OnSceneConnection()
202 void OnSceneConnection(int depth) override;
205 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
207 bool OnKeyEvent(const KeyEvent& event) override;
209 // From ControlInterface
212 * @copydoc Text::ControlInterface::RequestTextRelayout()
214 void RequestTextRelayout() override;
216 // From EditableControlInterface
219 * @copydoc Text::EditableControlInterface::TextChanged()
221 void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
224 * @copydoc Text::EditableControlInterface::TextDeleted()
226 void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
229 * @copydoc Text::EditableControlInterface::CursorPositionChanged()
231 void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
234 * @copydoc Text::EditableControlInterface::TextChanged()
236 void TextChanged(bool immediate) override;
239 * @copydoc Text::EditableControlInterface::MaxLengthReached()
241 void MaxLengthReached() override;
244 * @copydoc Text::EditableControlInterface::InputStyleChanged()
246 void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
249 * @copydoc Text::SelectableControlInterface::SelectionChanged()
251 void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
254 * @copydoc Text::EditableControlInterface::AddDecoration()
256 void AddDecoration(Actor& actor, bool needsClipping) override;
259 * @copydoc Text::EditableControlInterface::InputFiltered()
261 void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
264 * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
266 void GetControlBackgroundColor(Vector4& color) const override;
268 // From SelectableControlInterface
271 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
273 void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
276 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
278 Uint32Pair GetTextSelectionRange() const override;
281 * @copydoc Text::SelectableControlInterface::SelectWholeText()
283 void SelectWholeText() override;
286 * @copydoc Text::SelectableControlInterface::SelectNone()
288 void SelectNone() override;
291 * @copydoc Text::SelectableControlInterface::SelectText()
293 void SelectText(const uint32_t start, const uint32_t end) override;
296 * @copydoc Dali::Toolkit::DevelTextEditor::ScrollBy()
298 void ScrollBy(Vector2 Scroll);
301 * @brief Get Horizontal scroll position of TextEditor.
303 * @return Horizontal scroll position (in pixels) of TextEditor.
305 float GetHorizontalScrollPosition();
308 * @brief Get Vertical scroll position of TextEditor.
310 * @return Vertical scroll position (in pixels) of TextEditor.
312 float GetVerticalScrollPosition();
315 * @copydoc Text::SelectableControlInterface::GetSelectedText()
317 string GetSelectedText() const override;
320 * @copydoc Text::EditableControlInterface::IsEditable()
322 bool IsEditable() const override;
325 * @copydoc Text::EditableControlInterface::SetEditable()
327 void SetEditable(bool editable) override;
329 // From AnchorControlInterface
332 * @copydoc Text::AnchorControlInterface::AnchorClicked()
334 void AnchorClicked(const std::string& href) override;
336 private: // Implementation
338 * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
340 InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
343 * @brief Callback when Clipboard signals an item should be pasted
344 * @param[in] clipboard handle to Clipboard Event Notifier
346 void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
349 * @brief Get a Property Map for the image used for the required Handle Image
350 * @param[out] value the returned image property
351 * @param[in] handleType the type of handle
352 * @param[in] handleImageType the type of image for the given handleType
354 void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
357 * @brief Callback when keyboard is shown/hidden.
359 * @param[in] keyboardShown True if keyboard is shown.
361 void KeyboardStatusChanged(bool keyboardShown);
364 * @brief update scroll bar position
366 * If text scroll is occurred, create or update scroll bar position
368 void UpdateScrollBar();
371 * @brief Callback when TextEditor is touched
373 * @param[in] actor TextEditor touched
374 * @param[in] touch Touch information
376 bool OnTouched(Actor actor, const TouchEvent& touch);
379 * @brief Callbacks called on idle.
381 * If there are notifications of change of input style on the queue, Toolkit::TextEditor::InputStyleChangedSignal() are emitted.
386 * @brief Emits CursorPositionChanged signal.
388 void EmitCursorPositionChangedSignal();
391 * @brief Emits TextChanged signal.
393 void EmitTextChangedSignal();
396 * @brief Emits SelectionChanged signal.
398 void EmitSelectionChangedSignal();
401 * @brief set RenderActor's position with new scrollPosition
403 * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled
405 void ApplyScrollPosition();
408 * @brief Callback function for ScrollBar indicator animation finished signal
410 * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false
412 void OnScrollIndicatorAnimationFinished(Animation& animation);
415 * @brief Callback function for when the layout is changed.
416 * @param[in] actor The actor whose layoutDirection is changed.
417 * @param[in] type The layoutDirection.
419 void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
422 * Construct a new TextEditor.
427 * A reference counted object may only be deleted by calling Unreference()
429 virtual ~TextEditor();
431 // Undefined copy constructor and assignment operators
432 TextEditor(const TextEditor&);
433 TextEditor& operator=(const TextEditor& rhs);
436 * @brief Resize actor to the given size.
438 * @param[in] actor The actor to be resized.
439 * @param[in] size Size to change.
441 void ResizeActor(Actor& actor, const Vector2& size);
444 * @brief Render view, create and attach actor(s) to this text editor.
446 void RenderText(Text::Controller::UpdateTextType updateTextType);
448 // Connection needed to re-render text, when a text editor returns to the scene.
449 void OnSceneConnect(Dali::Actor actor);
453 Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal;
454 Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal;
455 Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal;
456 Toolkit::DevelTextEditor::MaxLengthReachedSignalType mMaxLengthReachedSignal;
457 Toolkit::DevelTextEditor::AnchorClickedSignalType mAnchorClickedSignal;
458 Toolkit::DevelTextEditor::InputFilteredSignalType mInputFilteredSignal;
459 Toolkit::DevelTextEditor::CursorPositionChangedSignalType mCursorPositionChangedSignal;
460 Toolkit::DevelTextEditor::SelectionChangedSignalType mSelectionChangedSignal;
462 InputMethodContext mInputMethodContext;
463 Text::ControllerPtr mController;
464 Text::RendererPtr mRenderer;
465 Text::DecoratorPtr mDecorator;
466 Text::TextVerticalScrollerPtr mTextVerticalScroller;
467 Toolkit::Control mStencil;
468 Toolkit::ScrollBar mScrollBar;
469 Dali::Animation mAnimation; ///< Scroll indicator Show/Hide Animation.
470 Dali::TimePeriod mAnimationPeriod;
471 std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
472 Dali::InputMethodOptions mInputMethodOptions;
474 Actor mRenderableActor;
476 Actor mBackgroundActor;
477 CallbackBase* mIdleCallback;
479 float mAlignmentOffset;
480 float mScrollAnimationDuration;
482 int mRenderingBackend;
483 bool mHasBeenStaged : 1;
484 bool mScrollAnimationEnabled : 1;
485 bool mScrollBarEnabled : 1;
486 bool mScrollStarted : 1;
487 bool mTextChanged : 1; ///< If true, emits TextChangedSignal in next OnRelayout().
488 bool mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout().
489 bool mSelectionChanged : 1; ///< If true, emits SelectionChangedSignal at the end of OnRelayout().
491 //args for cursor PositionChanged event
492 unsigned int mOldPosition;
494 //args for selection changed event
495 uint32_t mOldSelectionStart;
496 uint32_t mOldSelectionEnd;
499 * @brief This structure is to connect TextEditor with Accessible functions.
501 struct AccessibleImpl : public DevelControl::AccessibleImpl,
502 public virtual Dali::Accessibility::Text,
503 public virtual Dali::Accessibility::EditableText
505 using DevelControl::AccessibleImpl::AccessibleImpl;
508 * @copydoc Dali::Accessibility::Accessible::GetName()
510 std::string GetName() override;
513 * @copydoc Dali::Accessibility::Text::GetText()
515 std::string GetText(size_t startOffset, size_t endOffset) override;
518 * @copydoc Dali::Accessibility::Text::GetCharacterCount()
520 size_t GetCharacterCount() override;
523 * @copydoc Dali::Accessibility::Text::GetCursorOffset()
525 size_t GetCursorOffset() override;
528 * @copydoc Dali::Accessibility::Text::SetCursorOffset()
530 bool SetCursorOffset(size_t offset) override;
533 * @copydoc Dali::Accessibility::Text::GetTextAtOffset()
535 Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
538 * @copydoc Dali::Accessibility::Text::GetRangeOfSelection()
540 Accessibility::Range GetRangeOfSelection(size_t selectionIndex) override;
543 * @copydoc Dali::Accessibility::Text::RemoveSelection()
545 bool RemoveSelection(size_t selectionIndex) override;
548 * @copydoc Dali::Accessibility::Text::SetRangeOfSelection()
550 bool SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset) override;
553 * @copydoc Dali::Accessibility::EditableText::CopyText()
555 bool CopyText(size_t startPosition, size_t endPosition) override;
558 * @copydoc Dali::Accessibility::EditableText::CutText()
560 bool CutText(size_t startPosition, size_t endPosition) override;
563 * @copydoc Dali::Accessibility::Accessible::GetStates()
565 Accessibility::States CalculateStates() override;
568 * @copydoc Dali::Accessibility::EditableText::InsertText()
570 bool InsertText(size_t startPosition, std::string text) override;
573 * @copydoc Dali::Accessibility::EditableText::SetTextContents()
575 bool SetTextContents(std::string newContents) override;
578 * @copydoc Dali::Accessibility::EditableText::DeleteText()
580 bool DeleteText(size_t startPosition, size_t endPosition) override;
584 } // namespace Internal
586 // Helpers for public-api forwarding methods
588 inline Toolkit::Internal::TextEditor& GetImpl(Toolkit::TextEditor& textEditor)
590 DALI_ASSERT_ALWAYS(textEditor);
592 Dali::RefObject& handle = textEditor.GetImplementation();
594 return static_cast<Toolkit::Internal::TextEditor&>(handle);
597 inline const Toolkit::Internal::TextEditor& GetImpl(const Toolkit::TextEditor& textEditor)
599 DALI_ASSERT_ALWAYS(textEditor);
601 const Dali::RefObject& handle = textEditor.GetImplementation();
603 return static_cast<const Toolkit::Internal::TextEditor&>(handle);
606 } // namespace Toolkit
610 #endif // DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H