1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
5 * Copyright (c) 2022 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/clipboard-event-notifier.h>
23 #include <dali/devel-api/adaptor-framework/input-method-context.h>
24 #include <dali/devel-api/atspi-interfaces/editable-text.h>
25 #include <dali/devel-api/atspi-interfaces/hypertext.h>
26 #include <dali/devel-api/atspi-interfaces/text.h>
29 #include <dali-toolkit/devel-api/controls/control-devel.h>
30 #include <dali-toolkit/devel-api/controls/text-controls/text-field-devel.h>
31 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
32 #include <dali-toolkit/internal/controls/text-controls/common-text-utils.h>
33 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
34 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
35 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
36 #include <dali-toolkit/internal/text/text-control-interface.h>
37 #include <dali-toolkit/internal/text/text-controller.h>
38 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
39 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
40 #include <dali-toolkit/public-api/controls/control-impl.h>
41 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
50 * @brief A control which renders a short text string.
52 class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface, public Text::AnchorControlInterface
56 * @copydoc Dali::Toollkit::TextField::New()
58 static Toolkit::TextField 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::TextField::GetInputMethodContext()
83 InputMethodContext GetInputMethodContext();
86 * Connects a callback function with the object's signals.
87 * @param[in] object The object providing the signal.
88 * @param[in] tracker Used to disconnect the signal.
89 * @param[in] signalName The signal to connect to.
90 * @param[in] functor A newly allocated FunctorDelegate.
91 * @return True if the signal was connected.
92 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
94 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
97 * @brief Gets text controller
99 * @return The text controller
101 Text::ControllerPtr GetTextController();
104 * @copydoc TextField::TextChangedSignal()
106 Toolkit::TextField::TextChangedSignalType& TextChangedSignal();
109 * @copydoc TextField::MaxLengthReachedSignal()
111 Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal();
114 * @copydoc TextField::TextChangedSignal()
116 Toolkit::TextField::InputStyleChangedSignalType& InputStyleChangedSignal();
119 * @copydoc TextField::AnchorClickedSignal()
121 DevelTextField::AnchorClickedSignalType& AnchorClickedSignal();
124 * @copydoc TextField::CursorPositionChangedSignal()
126 DevelTextField::CursorPositionChangedSignalType& CursorPositionChangedSignal();
129 * @copydoc TextField::InputFilteredSignal()
131 DevelTextField::InputFilteredSignalType& InputFilteredSignal();
134 * @copydoc TextField::SelectionChangedSignal()
136 DevelTextField::SelectionChangedSignalType& SelectionChangedSignal();
139 * @copydoc TextField::SelectionClearedSignal()
141 DevelTextField::SelectionClearedSignalType& SelectionClearedSignal();
144 * @copydoc TextField::SelectionStartedSignal()
146 DevelTextField::SelectionStartedSignalType& SelectionStartedSignal();
148 private: // From Control
150 * @copydoc Control::OnInitialize()
152 void OnInitialize() override;
155 * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
157 DevelControl::ControlAccessible* CreateAccessibleObject() override;
160 * @copydoc Control::OnStyleChange()
162 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
165 * @copydoc Control::GetNaturalSize()
167 Vector3 GetNaturalSize() override;
170 * @copydoc Control::GetHeightForWidth()
172 float GetHeightForWidth(float width) override;
175 * @copydoc Control::OnInitialize()
177 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
180 * @copydoc Control::OnKeyInputFocusGained()
182 void OnKeyInputFocusGained() override;
185 * @copydoc Control::OnKeyInputFocusLost()
187 void OnKeyInputFocusLost() override;
190 * @copydoc Control::OnAccessibilityActivated()
192 bool OnAccessibilityActivated() override;
195 * @copydoc Control::OnTap()
197 void OnTap(const TapGesture& tap) override;
200 * @copydoc Control::OnPan()
202 void OnPan(const PanGesture& gesture) override;
205 * @copydoc Control::OnLongPress()
207 void OnLongPress(const LongPressGesture& gesture) override;
210 * @copydoc Control::OnSceneConnection()
212 void OnSceneConnection(int depth) override;
215 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
217 bool OnKeyEvent(const KeyEvent& event) override;
219 // From ControlInterface
222 * @copydoc Text::ControlInterface::RequestTextRelayout()
224 void RequestTextRelayout() override;
226 // From EditableControlInterface
229 * @copydoc Text::EditableControlInterface::TextChanged()
231 void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
234 * @copydoc Text::EditableControlInterface::TextDeleted()
236 void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
239 * @copydoc Text::EditableControlInterface::CursorPositionChanged()
241 void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
244 * @copydoc Text::EditableControlInterface::TextChanged()
246 void TextChanged(bool immediate) override;
249 * @copydoc Text::EditableControlInterface::MaxLengthReached()
251 void MaxLengthReached() override;
254 * @copydoc Text::EditableControlInterface::InputStyleChanged()
256 void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
259 * @copydoc Text::SelectableControlInterface::SelectionChanged()
261 void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
264 * @copydoc Text::EditableControlInterface::AddDecoration()
266 void AddDecoration(Actor& actor, Toolkit::Text::DecorationType type, bool needsClipping) override;
269 * @copydoc Text::EditableControlInterface::InputFiltered()
271 void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
274 * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
276 void GetControlBackgroundColor(Vector4& color) const override;
278 // From SelectableControlInterface
282 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
284 void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
287 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
289 Uint32Pair GetTextSelectionRange() const override;
292 * @copydoc Text::SelectableControlInterface::SelectWholeText()
294 void SelectWholeText() override;
297 * @copydoc Text::SelectableControlInterface::SelectNone()
299 void SelectNone() override;
302 * @copydoc Text::SelectableControlInterface::SelectText()
304 void SelectText(const uint32_t start, const uint32_t end) override;
307 * @copydoc Text::SelectableControlInterface::GetSelectedText()
309 string GetSelectedText() const override;
312 * @copydoc Text::EditableControlInterface::IsEditable()
314 bool IsEditable() const override;
317 * @copydoc Text::EditableControlInterface::SetEditable()
319 void SetEditable(bool editable) override;
322 * @copydoc Dali::EditableControlInterface::CopyText()
324 string CopyText() override;
327 * @copydoc Dali::EditableControlInterface::CutText()
329 string CutText() override;
332 * @copydoc Text::EditableControlInterface::PasteText()
334 void PasteText() override;
336 // From AnchorControlInterface
339 * @copydoc Text::AnchorControlInterface::AnchorClicked()
341 void AnchorClicked(const std::string& href) override;
344 * @brief Get the rendered size of a specific text range.
345 * if the requested text is at multilines, multiple sizes will be returned for each text located in a separate line.
346 * if a line contains characters with different directions, multiple sizes will be returned for each block of contiguous characters with the same direction.
348 * @param[in] startIndex start index of the text requested to calculate size for.
349 * @param[in] endIndex end index(included) of the text requested to calculate size for.
350 * @return list of sizes of the reuested text.
352 Vector<Vector2> GetTextSize(const uint32_t startIndex, const uint32_t endIndex) const;
355 * @brief Get the top/left rendered position of a specific text range.
356 * if the requested text is at multilines, multiple positions will be returned for each text located in a separate line.
357 * if a line contains characters with different directions, multiple positions will be returned for each block of contiguous characters with the same direction.
359 * @param[in] startIndex start index of the text requested to get position to.
360 * @param[in] endIndex end index(included) of the text requested to get position to.
361 * @return list of positions of the requested text.
363 Vector<Vector2> GetTextPosition(const uint32_t startIndex, const uint32_t endIndex) const;
365 private: // Implementation
367 * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
369 InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
372 * @brief Callback when Clipboard signals an item should be pasted
373 * @param[in] clipboard handle to Clipboard Event Notifier
375 void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
378 * @brief Get a Property Map for the image used for the required Handle Image
379 * @param[out] value the returned image property
380 * @param[in] handleType the type of handle
381 * @param[in] handleImageType the type of image for the given handleType
383 void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
386 * @brief Enable or disable clipping.
388 void EnableClipping();
391 * @brief Callback when keyboard is shown/hidden.
393 * @param[in] keyboardShown True if keyboard is shown.
395 void KeyboardStatusChanged(bool keyboardShown);
398 * @brief Callback when TextField is touched
400 * @param[in] actor TextField touched
401 * @param[in] touch Touch information
403 bool OnTouched(Actor actor, const TouchEvent& touch);
406 * @brief Callbacks called on idle.
408 * If there are notifications of change of input style on the queue, Toolkit::TextField::InputStyleChangedSignal() are emitted.
413 * @brief Emits TextChanged signal.
415 void EmitTextChangedSignal();
418 * @brief Emits CursorPositionChanged signal.
420 void EmitCursorPositionChangedSignal();
423 * @brief Emits SelectionChanged signal.
425 void EmitSelectionChangedSignal();
428 * @brief Emits SelectionCleared signal.
430 void EmitSelectionClearedSignal();
433 * @brief Emits SelectionStarted signal.
435 void EmitSelectionStartedSignal();
438 * @brief Callback function for when the layout is changed.
439 * @param[in] actor The actor whose layoutDirection is changed.
440 * @param[in] type The layoutDirection.
442 void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
445 * @brief Add a layer for active or cursor.
446 * @param[in] layer The actor in which to store the layer.
447 * @param[in] actor The new layer to add.
449 void AddLayer(Actor& layer, Actor& actor);
452 * Construct a new TextField.
457 * A reference counted object may only be deleted by calling Unreference()
459 virtual ~TextField();
461 // Undefined copy constructor and assignment operators
462 TextField(const TextField&);
463 TextField& operator=(const TextField& rhs);
466 * @brief Resize actor to the given size.
468 * @param[in] actor The actor to be resized.
469 * @param[in] size Size to change.
471 void ResizeActor(Actor& actor, const Vector2& size);
474 * @brief Render view, create and attach actor(s) to this Text Field.
476 void RenderText(Text::Controller::UpdateTextType updateTextType);
478 // Connection needed to re-render text, when a Text Field returns to the scene.
479 void OnSceneConnect(Dali::Actor actor);
481 // Needed to synchronize TextAnchor actors with Anchor objects in text's logical model
482 void OnAccessibilityStatusChanged();
486 Toolkit::TextField::TextChangedSignalType mTextChangedSignal;
487 Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal;
488 Toolkit::TextField::InputStyleChangedSignalType mInputStyleChangedSignal;
489 Toolkit::DevelTextField::AnchorClickedSignalType mAnchorClickedSignal;
490 Toolkit::DevelTextField::InputFilteredSignalType mInputFilteredSignal;
491 Toolkit::DevelTextField::CursorPositionChangedSignalType mCursorPositionChangedSignal;
492 Toolkit::DevelTextField::SelectionChangedSignalType mSelectionChangedSignal;
493 Toolkit::DevelTextField::SelectionClearedSignalType mSelectionClearedSignal;
494 Toolkit::DevelTextField::SelectionStartedSignalType mSelectionStartedSignal;
496 InputMethodContext mInputMethodContext;
497 Text::ControllerPtr mController;
498 Text::RendererPtr mRenderer;
499 Text::DecoratorPtr mDecorator;
500 Toolkit::Control mStencil; ///< For EXCEED_POLICY_CLIP
501 std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
502 std::vector<Toolkit::TextAnchor> mAnchorActors;
503 Dali::InputMethodOptions mInputMethodOptions;
505 Actor mRenderableActor;
508 Actor mBackgroundActor;
509 CallbackBase* mIdleCallback;
511 float mAlignmentOffset;
512 int mRenderingBackend;
514 bool mHasBeenStaged : 1;
515 bool mTextChanged : 1; ///< If true, emits TextChangedSignal in next OnRelayout().
516 bool mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout().
517 bool mSelectionChanged : 1; ///< If true, emits SelectionChangedSignal at the end of OnRelayout().
518 bool mSelectionCleared : 1; ///< If true, emits SelectionClearedSignal at the end of OnRelayout().
520 //args for cursor position changed event
521 unsigned int mOldPosition;
523 //args for selection changed event
524 uint32_t mOldSelectionStart;
525 uint32_t mOldSelectionEnd;
527 bool mSelectionStarted : 1; ///< If true, emits SelectionStartedSignal at the end of OnRelayout().
530 struct PropertyHandler;
533 * @brief This structure is to connect TextField with Accessible functions.
535 class TextFieldAccessible : public EditableTextControlAccessible
538 using EditableTextControlAccessible::EditableTextControlAccessible;
541 * @copydoc Dali::Accessibility::Accessible::GetName()
543 std::string GetName() const override;
547 * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextAnchors()
549 const std::vector<Toolkit::TextAnchor>& GetTextAnchors() const override;
552 * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetTextController()
554 Toolkit::Text::ControllerPtr GetTextController() const override;
557 * @copydoc Dali::Toolkit::Internal::TextControlAccessible::GetSubstituteCharacter()
559 std::uint32_t GetSubstituteCharacter() const override;
562 * @copydoc Dali::Toolkit::Internal::TextControlAccessible::IsHiddenInput()
564 bool IsHiddenInput() const override;
567 * @copydoc Dali::Toolkit::Internal::EditableTextControlAccessible::RequestTextRelayout()
569 void RequestTextRelayout() override;
573 } // namespace Internal
575 // Helpers for public-api forwarding methods
577 inline Toolkit::Internal::TextField& GetImpl(Toolkit::TextField& textField)
579 DALI_ASSERT_ALWAYS(textField);
581 Dali::RefObject& handle = textField.GetImplementation();
583 return static_cast<Toolkit::Internal::TextField&>(handle);
586 inline const Toolkit::Internal::TextField& GetImpl(const Toolkit::TextField& textField)
588 DALI_ASSERT_ALWAYS(textField);
590 const Dali::RefObject& handle = textField.GetImplementation();
592 return static_cast<const Toolkit::Internal::TextField&>(handle);
595 } // namespace Toolkit
599 #endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H