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::InputFilteredSignal()
98 DevelTextEditor::InputFilteredSignalType& InputFilteredSignal();
101 * Connects a callback function with the object's signals.
102 * @param[in] object The object providing the signal.
103 * @param[in] tracker Used to disconnect the signal.
104 * @param[in] signalName The signal to connect to.
105 * @param[in] functor A newly allocated FunctorDelegate.
106 * @return True if the signal was connected.
107 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
109 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
112 * @copydoc TextEditor::TextChangedSignal()
114 Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal();
117 * @copydoc TextEditor::TextChangedSignal()
119 Toolkit::TextEditor::InputStyleChangedSignalType& InputStyleChangedSignal();
122 * @copydoc TextEditor::ScrollStateChangedSignal()
124 Toolkit::TextEditor::ScrollStateChangedSignalType& ScrollStateChangedSignal();
126 private: // From Control
128 * @copydoc Control::OnInitialize()
130 void OnInitialize() override;
133 * @copydoc Control::OnStyleChange()
135 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
138 * @copydoc Control::GetNaturalSize()
140 Vector3 GetNaturalSize() override;
143 * @copydoc Control::GetHeightForWidth()
145 float GetHeightForWidth(float width) override;
148 * @copydoc Control::OnInitialize()
150 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
153 * @copydoc Control::OnKeyInputFocusGained()
155 void OnKeyInputFocusGained() override;
158 * @copydoc Control::OnKeyInputFocusLost()
160 void OnKeyInputFocusLost() override;
163 * @copydoc Control::OnAccessibilityActivated()
165 bool OnAccessibilityActivated() override;
168 * @copydoc Control::OnTap()
170 void OnTap(const TapGesture& tap) override;
173 * @copydoc Control::OnPan()
175 void OnPan(const PanGesture& gesture) override;
178 * @copydoc Control::OnLongPress()
180 void OnLongPress(const LongPressGesture& gesture) override;
183 * @copydoc Control::OnSceneConnection()
185 void OnSceneConnection(int depth) override;
188 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
190 bool OnKeyEvent(const KeyEvent& event) override;
192 // From ControlInterface
195 * @copydoc Text::ControlInterface::RequestTextRelayout()
197 void RequestTextRelayout() override;
199 // From EditableControlInterface
202 * @copydoc Text::EditableControlInterface::TextChanged()
204 void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
207 * @copydoc Text::EditableControlInterface::TextDeleted()
209 void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
212 * @copydoc Text::EditableControlInterface::CaretMoved()
214 void CaretMoved(unsigned int position) override;
217 * @copydoc Text::EditableControlInterface::TextChanged()
219 void TextChanged(bool immediate) override;
222 * @copydoc Text::EditableControlInterface::MaxLengthReached()
224 void MaxLengthReached() override;
227 * @copydoc Text::EditableControlInterface::InputStyleChanged()
229 void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
232 * @copydoc Text::EditableControlInterface::AddDecoration()
234 void AddDecoration(Actor& actor, bool needsClipping) override;
237 * @copydoc Text::EditableControlInterface::InputFiltered()
239 void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
242 * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
244 void GetControlBackgroundColor(Vector4& color) const override;
246 // From SelectableControlInterface
249 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
251 void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
254 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
256 Uint32Pair GetTextSelectionRange() const override;
259 * @copydoc Text::SelectableControlInterface::SelectWholeText()
261 void SelectWholeText() override;
264 * @copydoc Text::SelectableControlInterface::SelectNone()
266 void SelectNone() override;
269 * @copydoc Dali::Toolkit::DevelTextEditor::ScrollBy()
271 void ScrollBy(Vector2 Scroll);
274 * @brief Get Horizontal scroll position of TextEditor.
276 * @return Horizontal scroll position (in pixels) of TextEditor.
278 float GetHorizontalScrollPosition();
281 * @brief Get Vertical scroll position of TextEditor.
283 * @return Vertical scroll position (in pixels) of TextEditor.
285 float GetVerticalScrollPosition();
288 * @copydoc Text::SelectableControlInterface::GetSelectedText()
290 string GetSelectedText() const override;
293 * @copydoc Text::EditableControlInterface::IsEditable()
295 bool IsEditable() const override;
298 * @copydoc Text::EditableControlInterface::SetEditable()
300 void SetEditable(bool editable) override;
302 // From AnchorControlInterface
305 * @copydoc Text::AnchorControlInterface::AnchorClicked()
307 void AnchorClicked(const std::string& href) override;
309 Text::ControllerPtr getController();
311 private: // Implementation
313 * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
315 InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
318 * @brief Callback when Clipboard signals an item should be pasted
319 * @param[in] clipboard handle to Clipboard Event Notifier
321 void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
324 * @brief Get a Property Map for the image used for the required Handle Image
325 * @param[out] value the returned image property
326 * @param[in] handleType the type of handle
327 * @param[in] handleImageType the type of image for the given handleType
329 void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
332 * @brief Callback when keyboard is shown/hidden.
334 * @param[in] keyboardShown True if keyboard is shown.
336 void KeyboardStatusChanged(bool keyboardShown);
339 * @brief update scroll bar position
341 * If text scroll is occurred, create or update scroll bar position
343 void UpdateScrollBar();
346 * @brief Callback when TextEditor is touched
348 * @param[in] actor TextEditor touched
349 * @param[in] touch Touch information
351 bool OnTouched(Actor actor, const TouchEvent& touch);
354 * @brief Callbacks called on idle.
356 * If there are notifications of change of input style on the queue, Toolkit::TextEditor::InputStyleChangedSignal() are emitted.
361 * @brief Emits TextChanged signal.
363 void EmitTextChangedSignal();
366 * @brief set RenderActor's position with new scrollPosition
368 * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled
370 void ApplyScrollPosition();
373 * @brief Callback function for ScrollBar indicator animation finished signal
375 * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false
377 void OnScrollIndicatorAnimationFinished(Animation& animation);
380 * Construct a new TextEditor.
385 * A reference counted object may only be deleted by calling Unreference()
387 virtual ~TextEditor();
389 // Undefined copy constructor and assignment operators
390 TextEditor(const TextEditor&);
391 TextEditor& operator=(const TextEditor& rhs);
394 * @brief Resize actor to the given size.
396 * @param[in] actor The actor to be resized.
397 * @param[in] size Size to change.
399 void ResizeActor(Actor& actor, const Vector2& size);
402 * @brief Render view, create and attach actor(s) to this text editor.
404 void RenderText(Text::Controller::UpdateTextType updateTextType);
406 // Connection needed to re-render text, when a text editor returns to the scene.
407 void OnSceneConnect(Dali::Actor actor);
411 Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal;
412 Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal;
413 Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal;
414 Toolkit::DevelTextEditor::MaxLengthReachedSignalType mMaxLengthReachedSignal;
415 Toolkit::DevelTextEditor::AnchorClickedSignalType mAnchorClickedSignal;
416 Toolkit::DevelTextEditor::InputFilteredSignalType mInputFilteredSignal;
418 InputMethodContext mInputMethodContext;
419 Text::ControllerPtr mController;
420 Text::RendererPtr mRenderer;
421 Text::DecoratorPtr mDecorator;
422 Text::TextVerticalScrollerPtr mTextVerticalScroller;
423 Toolkit::Control mStencil;
424 Toolkit::ScrollBar mScrollBar;
425 Dali::Animation mAnimation; ///< Scroll indicator Show/Hide Animation.
426 Dali::TimePeriod mAnimationPeriod;
427 std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
428 Dali::InputMethodOptions mInputMethodOptions;
430 Actor mRenderableActor;
432 Actor mBackgroundActor;
433 CallbackBase* mIdleCallback;
435 float mAlignmentOffset;
436 float mScrollAnimationDuration;
438 int mRenderingBackend;
439 bool mHasBeenStaged : 1;
440 bool mScrollAnimationEnabled : 1;
441 bool mScrollBarEnabled : 1;
442 bool mScrollStarted : 1;
443 bool mTextChanged : 1; ///< If true, emits TextChangedSignal in next OnRelayout().
445 struct AccessibleImpl : public DevelControl::AccessibleImpl,
446 public virtual Dali::Accessibility::Text,
447 public virtual Dali::Accessibility::EditableText
449 using DevelControl::AccessibleImpl::AccessibleImpl;
451 std::string GetName() override;
452 std::string GetText(size_t startOffset, size_t endOffset) override;
453 size_t GetCharacterCount() override;
454 size_t GetCaretOffset() override;
455 bool SetCaretOffset(size_t offset) override;
456 Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
457 Accessibility::Range GetSelection(size_t selectionNum) override;
458 bool RemoveSelection(size_t selectionNum) override;
459 bool SetSelection(size_t selectionNum, size_t startOffset, size_t endOffset) override;
460 bool CopyText(size_t startPosition, size_t endPosition) override;
461 bool CutText(size_t startPosition, size_t endPosition) override;
462 Accessibility::States CalculateStates() override;
463 bool InsertText(size_t startPosition, std::string text) override;
464 bool SetTextContents(std::string newContents) override;
465 bool DeleteText(size_t startPosition, size_t endPosition) override;
469 } // namespace Internal
471 // Helpers for public-api forwarding methods
473 inline Toolkit::Internal::TextEditor& GetImpl(Toolkit::TextEditor& textEditor)
475 DALI_ASSERT_ALWAYS(textEditor);
477 Dali::RefObject& handle = textEditor.GetImplementation();
479 return static_cast<Toolkit::Internal::TextEditor&>(handle);
482 inline const Toolkit::Internal::TextEditor& GetImpl(const Toolkit::TextEditor& textEditor)
484 DALI_ASSERT_ALWAYS(textEditor);
486 const Dali::RefObject& handle = textEditor.GetImplementation();
488 return static_cast<const Toolkit::Internal::TextEditor&>(handle);
491 } // namespace Toolkit
495 #endif // DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H