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/scroll-bar/scroll-bar.h>
29 #include <dali-toolkit/devel-api/controls/text-controls/text-editor-devel.h>
30 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
31 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
32 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
33 #include <dali-toolkit/internal/text/text-control-interface.h>
34 #include <dali-toolkit/internal/text/text-controller.h>
35 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
36 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
37 #include <dali-toolkit/internal/text/text-vertical-scroller.h>
38 #include <dali-toolkit/public-api/controls/control-impl.h>
39 #include <dali-toolkit/public-api/controls/text-controls/text-editor.h>
48 * @brief A control which renders a long text string with styles.
50 class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface
54 * @copydoc Dali::Toollkit::TextEditor::New()
56 static Toolkit::TextEditor New();
61 * @brief Called when a property of an object of this type is set.
63 * @param[in] object The object whose property is set.
64 * @param[in] index The property index.
65 * @param[in] value The new property value.
67 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
70 * @brief Called to retrieve a property of an object of this type.
72 * @param[in] object The object whose property is to be retrieved.
73 * @param[in] index The property index.
74 * @return The current value of the property.
76 static Property::Value GetProperty(BaseObject* object, Property::Index index);
79 * @copydoc Dali::Toollkit::TextEditor::GetInputMethodContext()
81 InputMethodContext GetInputMethodContext();
84 * @copydoc Dali::Toollkit::TextEditor::MaxLengthReachedSignal()
86 DevelTextEditor::MaxLengthReachedSignalType& MaxLengthReachedSignal();
89 * Connects a callback function with the object's signals.
90 * @param[in] object The object providing the signal.
91 * @param[in] tracker Used to disconnect the signal.
92 * @param[in] signalName The signal to connect to.
93 * @param[in] functor A newly allocated FunctorDelegate.
94 * @return True if the signal was connected.
95 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
97 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
100 * @copydoc TextEditor::TextChangedSignal()
102 Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal();
105 * @copydoc TextEditor::TextChangedSignal()
107 Toolkit::TextEditor::InputStyleChangedSignalType& InputStyleChangedSignal();
110 * @copydoc TextEditor::ScrollStateChangedSignal()
112 Toolkit::TextEditor::ScrollStateChangedSignalType& ScrollStateChangedSignal();
114 private: // From Control
116 * @copydoc Control::OnInitialize()
118 void OnInitialize() override;
121 * @copydoc Control::OnStyleChange()
123 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
126 * @copydoc Control::GetNaturalSize()
128 Vector3 GetNaturalSize() override;
131 * @copydoc Control::GetHeightForWidth()
133 float GetHeightForWidth(float width) override;
136 * @copydoc Control::OnInitialize()
138 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
141 * @copydoc Control::OnKeyInputFocusGained()
143 void OnKeyInputFocusGained() override;
146 * @copydoc Control::OnKeyInputFocusLost()
148 void OnKeyInputFocusLost() override;
151 * @copydoc Control::OnAccessibilityActivated()
153 bool OnAccessibilityActivated() override;
156 * @copydoc Control::OnTap()
158 void OnTap(const TapGesture& tap) override;
161 * @copydoc Control::OnPan()
163 void OnPan(const PanGesture& gesture) override;
166 * @copydoc Control::OnLongPress()
168 void OnLongPress(const LongPressGesture& gesture) override;
171 * @copydoc Control::OnSceneConnection()
173 void OnSceneConnection(int depth) override;
176 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
178 bool OnKeyEvent(const KeyEvent& event) override;
180 // From ControlInterface
183 * @copydoc Text::ControlInterface::RequestTextRelayout()
185 void RequestTextRelayout() override;
187 // From EditableControlInterface
190 * @copydoc Text::EditableControlInterface::TextChanged()
192 void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
195 * @copydoc Text::EditableControlInterface::TextDeleted()
197 void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
200 * @copydoc Text::EditableControlInterface::CaretMoved()
202 void CaretMoved(unsigned int position) override;
205 * @copydoc Text::EditableControlInterface::TextChanged()
207 void TextChanged() override;
210 * @copydoc Text::EditableControlInterface::MaxLengthReached()
212 void MaxLengthReached() override;
215 * @copydoc Text::EditableControlInterface::InputStyleChanged()
217 void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
220 * @copydoc Text::EditableControlInterface::AddDecoration()
222 void AddDecoration(Actor& actor, bool needsClipping) override;
224 // From SelectableControlInterface
227 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
229 void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
232 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
234 Uint32Pair GetTextSelectionRange() const override;
237 * @copydoc Text::SelectableControlInterface::SelectWholeText()
239 void SelectWholeText() override;
242 * @copydoc Text::SelectableControlInterface::SelectNone()
244 void SelectNone() override;
247 * @copydoc Dali::Toolkit::DevelTextEditor::ScrollBy()
249 void ScrollBy(Vector2 Scroll);
252 * @brief Get Horizontal scroll position of TextEditor.
254 * @return Horizontal scroll position (in pixels) of TextEditor.
256 float GetHorizontalScrollPosition();
259 * @brief Get Vertical scroll position of TextEditor.
261 * @return Vertical scroll position (in pixels) of TextEditor.
263 float GetVerticalScrollPosition();
266 * @copydoc Text::SelectableControlInterface::GetSelectedText()
268 string GetSelectedText() const override;
271 * @copydoc Text::EditableControlInterface::IsEditable()
273 bool IsEditable() const override;
276 * @copydoc Text::EditableControlInterface::SetEditable()
278 void SetEditable(bool editable) override;
279 Text::ControllerPtr getController();
281 private: // Implementation
283 * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
285 InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
288 * @brief Callback when Clipboard signals an item should be pasted
289 * @param[in] clipboard handle to Clipboard Event Notifier
291 void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
294 * @brief Get a Property Map for the image used for the required Handle Image
295 * @param[out] value the returned image property
296 * @param[in] handleType the type of handle
297 * @param[in] handleImageType the type of image for the given handleType
299 void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
302 * @brief Callback when keyboard is shown/hidden.
304 * @param[in] keyboardShown True if keyboard is shown.
306 void KeyboardStatusChanged(bool keyboardShown);
309 * @brief update scroll bar position
311 * If text scroll is occurred, create or update scroll bar position
313 void UpdateScrollBar();
316 * @brief Callback when TextEditor is touched
318 * @param[in] actor TextEditor touched
319 * @param[in] touch Touch information
321 bool OnTouched(Actor actor, const TouchEvent& touch);
324 * @brief Callbacks called on idle.
326 * If there are notifications of change of input style on the queue, Toolkit::TextEditor::InputStyleChangedSignal() are emitted.
331 * @brief set RenderActor's position with new scrollPosition
333 * Apply updated scroll position or start scroll animation if VerticalScrollAnimation is enabled
335 void ApplyScrollPosition();
338 * @brief Callback function for ScrollBar indicator animation finished signal
340 * Emit ScrollBarStateChanged Signal and toggle mScrollStarted flag to false
342 void OnScrollIndicatorAnimationFinished(Animation& animation);
345 * Construct a new TextEditor.
350 * A reference counted object may only be deleted by calling Unreference()
352 virtual ~TextEditor();
354 // Undefined copy constructor and assignment operators
355 TextEditor(const TextEditor&);
356 TextEditor& operator=(const TextEditor& rhs);
359 * @brief Resize actor to the given size.
361 * @param[in] actor The actor to be resized.
362 * @param[in] size Size to change.
364 void ResizeActor( Actor& actor, const Vector2& size );
367 * @brief Render view, create and attach actor(s) to this text editor.
369 void RenderText(Text::Controller::UpdateTextType updateTextType);
371 // Connection needed to re-render text, when a text editor returns to the scene.
372 void OnSceneConnect(Dali::Actor actor);
376 Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal;
377 Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal;
378 Toolkit::TextEditor::ScrollStateChangedSignalType mScrollStateChangedSignal;
379 Toolkit::DevelTextEditor::MaxLengthReachedSignalType mMaxLengthReachedSignal;
381 InputMethodContext mInputMethodContext;
382 Text::ControllerPtr mController;
383 Text::RendererPtr mRenderer;
384 Text::DecoratorPtr mDecorator;
385 Text::TextVerticalScrollerPtr mTextVerticalScroller;
386 Toolkit::Control mStencil;
387 Toolkit::ScrollBar mScrollBar;
388 Dali::Animation mAnimation; ///< Scroll indicator Show/Hide Animation.
389 Dali::TimePeriod mAnimationPeriod;
390 std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
392 Actor mRenderableActor;
394 CallbackBase* mIdleCallback;
396 float mAlignmentOffset;
397 float mScrollAnimationDuration;
399 int mRenderingBackend;
400 bool mHasBeenStaged : 1;
401 bool mScrollAnimationEnabled : 1;
402 bool mScrollBarEnabled : 1;
403 bool mScrollStarted : 1;
405 struct AccessibleImpl : public Control::Impl::AccessibleImpl,
406 public virtual Dali::Accessibility::Text,
407 public virtual Dali::Accessibility::EditableText
409 using Control::Impl::AccessibleImpl::AccessibleImpl;
411 std::string GetName() override;
412 std::string GetText(size_t startOffset, size_t endOffset) override;
413 size_t GetCharacterCount() override;
414 size_t GetCaretOffset() override;
415 bool SetCaretOffset(size_t offset) override;
416 Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
417 Accessibility::Range GetSelection(size_t selectionNum) override;
418 bool RemoveSelection(size_t selectionNum) override;
419 bool SetSelection(size_t selectionNum, size_t startOffset, size_t endOffset) override;
420 bool CopyText(size_t startPosition, size_t endPosition) override;
421 bool CutText(size_t startPosition, size_t endPosition) override;
422 Accessibility::States CalculateStates() override;
426 } // namespace Internal
428 // Helpers for public-api forwarding methods
430 inline Toolkit::Internal::TextEditor& GetImpl(Toolkit::TextEditor& textEditor)
432 DALI_ASSERT_ALWAYS(textEditor);
434 Dali::RefObject& handle = textEditor.GetImplementation();
436 return static_cast<Toolkit::Internal::TextEditor&>(handle);
439 inline const Toolkit::Internal::TextEditor& GetImpl(const Toolkit::TextEditor& textEditor)
441 DALI_ASSERT_ALWAYS(textEditor);
443 const Dali::RefObject& handle = textEditor.GetImplementation();
445 return static_cast<const Toolkit::Internal::TextEditor&>(handle);
448 } // namespace Toolkit
452 #endif // DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H