1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_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/clipboard-event-notifier.h>
23 #include <dali/devel-api/adaptor-framework/input-method-context.h>
26 #include <dali-toolkit/devel-api/controls/control-devel.h>
27 #include <dali-toolkit/devel-api/controls/text-controls/text-field-devel.h>
28 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
29 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
30 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
31 #include <dali-toolkit/internal/text/text-anchor-control-interface.h>
32 #include <dali-toolkit/internal/text/text-control-interface.h>
33 #include <dali-toolkit/internal/text/text-controller.h>
34 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
35 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
36 #include <dali-toolkit/public-api/controls/control-impl.h>
37 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
46 * @brief A control which renders a short text string.
48 class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface, public Text::AnchorControlInterface
52 * @copydoc Dali::Toollkit::TextField::New()
54 static Toolkit::TextField New();
59 * @brief Called when a property of an object of this type is set.
61 * @param[in] object The object whose property is set.
62 * @param[in] index The property index.
63 * @param[in] value The new property value.
65 static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
68 * @brief Called to retrieve a property of an object of this type.
70 * @param[in] object The object whose property is to be retrieved.
71 * @param[in] index The property index.
72 * @return The current value of the property.
74 static Property::Value GetProperty(BaseObject* object, Property::Index index);
77 * @copydoc Dali::Toollkit::TextField::GetInputMethodContext()
79 InputMethodContext GetInputMethodContext();
82 * Connects a callback function with the object's signals.
83 * @param[in] object The object providing the signal.
84 * @param[in] tracker Used to disconnect the signal.
85 * @param[in] signalName The signal to connect to.
86 * @param[in] functor A newly allocated FunctorDelegate.
87 * @return True if the signal was connected.
88 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
90 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
93 * @brief Gets text controller
95 * @return The text controller
97 Text::ControllerPtr GetTextController();
100 * @copydoc TextField::TextChangedSignal()
102 Toolkit::TextField::TextChangedSignalType& TextChangedSignal();
105 * @copydoc TextField::MaxLengthReachedSignal()
107 Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal();
110 * @copydoc TextField::TextChangedSignal()
112 Toolkit::TextField::InputStyleChangedSignalType& InputStyleChangedSignal();
115 * @copydoc TextField::AnchorClickedSignal()
117 DevelTextField::AnchorClickedSignalType& AnchorClickedSignal();
120 * @copydoc TextField::CursorPositionChangedSignal()
122 DevelTextField::CursorPositionChangedSignalType& CursorPositionChangedSignal();
125 * @copydoc TextField::InputFilteredSignal()
127 DevelTextField::InputFilteredSignalType& InputFilteredSignal();
130 * @copydoc TextField::SelectionChangedSignal()
132 DevelTextField::SelectionChangedSignalType& SelectionChangedSignal();
134 private: // From Control
136 * @copydoc Control::OnInitialize()
138 void OnInitialize() override;
141 * @copydoc Control::OnStyleChange()
143 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
146 * @copydoc Control::GetNaturalSize()
148 Vector3 GetNaturalSize() override;
151 * @copydoc Control::GetHeightForWidth()
153 float GetHeightForWidth(float width) override;
156 * @copydoc Control::OnInitialize()
158 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
161 * @copydoc Control::OnKeyInputFocusGained()
163 void OnKeyInputFocusGained() override;
166 * @copydoc Control::OnKeyInputFocusLost()
168 void OnKeyInputFocusLost() override;
171 * @copydoc Control::OnAccessibilityActivated()
173 bool OnAccessibilityActivated() override;
176 * @copydoc Control::OnTap()
178 void OnTap(const TapGesture& tap) override;
181 * @copydoc Control::OnPan()
183 void OnPan(const PanGesture& gesture) override;
186 * @copydoc Control::OnLongPress()
188 void OnLongPress(const LongPressGesture& gesture) override;
191 * @copydoc Control::OnSceneConnection()
193 void OnSceneConnection(int depth) override;
196 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
198 bool OnKeyEvent(const KeyEvent& event) override;
200 // From ControlInterface
203 * @copydoc Text::ControlInterface::RequestTextRelayout()
205 void RequestTextRelayout() override;
207 // From EditableControlInterface
210 * @copydoc Text::EditableControlInterface::TextChanged()
212 void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
215 * @copydoc Text::EditableControlInterface::TextDeleted()
217 void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
220 * @copydoc Text::EditableControlInterface::CursorPositionChanged()
222 void CursorPositionChanged(unsigned int oldPosition, unsigned int newPosition) override;
225 * @copydoc Text::EditableControlInterface::TextChanged()
227 void TextChanged(bool immediate) override;
230 * @copydoc Text::EditableControlInterface::MaxLengthReached()
232 void MaxLengthReached() override;
235 * @copydoc Text::EditableControlInterface::InputStyleChanged()
237 void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
240 * @copydoc Text::SelectableControlInterface::SelectionChanged()
242 void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) override;
245 * @copydoc Text::EditableControlInterface::AddDecoration()
247 void AddDecoration(Actor& actor, bool needsClipping) override;
250 * @copydoc Text::EditableControlInterface::InputFiltered()
252 void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
255 * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
257 void GetControlBackgroundColor(Vector4& color) const override;
259 // From SelectableControlInterface
262 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
264 void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
267 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
269 Uint32Pair GetTextSelectionRange() const override;
272 * @copydoc Text::SelectableControlInterface::SelectWholeText()
274 void SelectWholeText() override;
277 * @copydoc Text::SelectableControlInterface::SelectNone()
279 void SelectNone() override;
282 * @copydoc Text::SelectableControlInterface::SelectText()
284 void SelectText(const uint32_t start, const uint32_t end) override;
287 * @copydoc Text::SelectableControlInterface::GetSelectedText()
289 string GetSelectedText() const override;
292 * @copydoc Text::EditableControlInterface::IsEditable()
294 bool IsEditable() const override;
297 * @copydoc Text::EditableControlInterface::SetEditable()
299 void SetEditable(bool editable) override;
302 * @copydoc Dali::EditableControlInterface::CopyText()
304 string CopyText() override;
307 * @copydoc Dali::EditableControlInterface::CutText()
309 string CutText() override;
312 * @copydoc Text::EditableControlInterface::PasteText()
314 void PasteText() override;
316 // From AnchorControlInterface
319 * @copydoc Text::AnchorControlInterface::AnchorClicked()
321 void AnchorClicked(const std::string& href) override;
323 private: // Implementation
325 * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
327 InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
330 * @brief Callback when Clipboard signals an item should be pasted
331 * @param[in] clipboard handle to Clipboard Event Notifier
333 void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
336 * @brief Get a Property Map for the image used for the required Handle Image
337 * @param[out] value the returned image property
338 * @param[in] handleType the type of handle
339 * @param[in] handleImageType the type of image for the given handleType
341 void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
344 * @brief Enable or disable clipping.
346 void EnableClipping();
349 * @brief Callback when keyboard is shown/hidden.
351 * @param[in] keyboardShown True if keyboard is shown.
353 void KeyboardStatusChanged(bool keyboardShown);
356 * @brief Callback when TextField is touched
358 * @param[in] actor TextField touched
359 * @param[in] touch Touch information
361 bool OnTouched(Actor actor, const TouchEvent& touch);
364 * @brief Callbacks called on idle.
366 * If there are notifications of change of input style on the queue, Toolkit::TextField::InputStyleChangedSignal() are emitted.
371 * @brief Emits TextChanged signal.
373 void EmitTextChangedSignal();
376 * @brief Emits CursorPositionChanged signal.
378 void EmitCursorPositionChangedSignal();
381 * @brief Emits SelectionChanged signal.
383 void EmitSelectionChangedSignal();
386 * @brief Callback function for when the layout is changed.
387 * @param[in] actor The actor whose layoutDirection is changed.
388 * @param[in] type The layoutDirection.
390 void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
393 * Construct a new TextField.
398 * A reference counted object may only be deleted by calling Unreference()
400 virtual ~TextField();
402 // Undefined copy constructor and assignment operators
403 TextField(const TextField&);
404 TextField& operator=(const TextField& rhs);
407 * @brief Resize actor to the given size.
409 * @param[in] actor The actor to be resized.
410 * @param[in] size Size to change.
412 void ResizeActor(Actor& actor, const Vector2& size);
415 * @brief Render view, create and attach actor(s) to this Text Field.
417 void RenderText(Text::Controller::UpdateTextType updateTextType);
419 // Connection needed to re-render text, when a Text Field returns to the scene.
420 void OnSceneConnect(Dali::Actor actor);
424 Toolkit::TextField::TextChangedSignalType mTextChangedSignal;
425 Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal;
426 Toolkit::TextField::InputStyleChangedSignalType mInputStyleChangedSignal;
427 Toolkit::DevelTextField::AnchorClickedSignalType mAnchorClickedSignal;
428 Toolkit::DevelTextField::InputFilteredSignalType mInputFilteredSignal;
429 Toolkit::DevelTextField::CursorPositionChangedSignalType mCursorPositionChangedSignal;
430 Toolkit::DevelTextField::SelectionChangedSignalType mSelectionChangedSignal;
432 InputMethodContext mInputMethodContext;
433 Text::ControllerPtr mController;
434 Text::RendererPtr mRenderer;
435 Text::DecoratorPtr mDecorator;
436 Toolkit::Control mStencil; ///< For EXCEED_POLICY_CLIP
437 std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
438 Dali::InputMethodOptions mInputMethodOptions;
440 Actor mRenderableActor;
442 Actor mBackgroundActor;
443 CallbackBase* mIdleCallback;
445 float mAlignmentOffset;
446 int mRenderingBackend;
448 bool mHasBeenStaged : 1;
449 bool mTextChanged : 1; ///< If true, emits TextChangedSignal in next OnRelayout().
450 bool mCursorPositionChanged : 1; ///< If true, emits CursorPositionChangedSignal at the end of OnRelayout().
451 bool mSelectionChanged : 1; ///< If true, emits SelectionChangedSignal at the end of OnRelayout().
453 //args for cursor position changed event
454 unsigned int mOldPosition;
456 //args for selection changed event
457 uint32_t mOldSelectionStart;
458 uint32_t mOldSelectionEnd;
462 * @brief This structure is to connect TextField with Accessible functions.
464 struct AccessibleImpl : public DevelControl::AccessibleImpl,
465 public virtual Dali::Accessibility::Text,
466 public virtual Dali::Accessibility::EditableText
468 using DevelControl::AccessibleImpl::AccessibleImpl;
471 * @copydoc Dali::Accessibility::Accessible::GetName()
473 std::string GetName() override;
476 * @copydoc Dali::Accessibility::Text::GetText()
478 std::string GetText(size_t startOffset, size_t endOffset) override;
481 * @copydoc Dali::Accessibility::Text::GetCharacterCount()
483 size_t GetCharacterCount() override;
486 * @copydoc Dali::Accessibility::Text::GetCursorOffset()
488 size_t GetCursorOffset() override;
491 * @copydoc Dali::Accessibility::Text::SetCursorOffset()
493 bool SetCursorOffset(size_t offset) override;
496 * @copydoc Dali::Accessibility::Text::GetTextAtOffset()
498 Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
501 * @copydoc Dali::Accessibility::Text::GetRangeOfSelection()
503 Accessibility::Range GetRangeOfSelection(size_t selectionIndex) override;
506 * @copydoc Dali::Accessibility::Text::RemoveSelection()
508 bool RemoveSelection(size_t selectionIndex) override;
511 * @copydoc Dali::Accessibility::Text::SetRangeOfSelection()
513 bool SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset) override;
516 * @copydoc Dali::Accessibility::EditableText::CopyText()
518 bool CopyText(size_t startPosition, size_t endPosition) override;
521 * @copydoc Dali::Accessibility::EditableText::CutText()
523 bool CutText(size_t startPosition, size_t endPosition) override;
526 * @copydoc Dali::Accessibility::Accessible::GetStates()
528 Accessibility::States CalculateStates() override;
531 * @copydoc Dali::Accessibility::EditableText::InsertText()
533 bool InsertText(size_t startPosition, std::string text) override;
536 * @copydoc Dali::Accessibility::EditableText::SetTextContents()
538 bool SetTextContents(std::string newContents) override;
541 * @copydoc Dali::Accessibility::EditableText::DeleteText()
543 bool DeleteText(size_t startPosition, size_t endPosition) override;
547 } // namespace Internal
549 // Helpers for public-api forwarding methods
551 inline Toolkit::Internal::TextField& GetImpl(Toolkit::TextField& textField)
553 DALI_ASSERT_ALWAYS(textField);
555 Dali::RefObject& handle = textField.GetImplementation();
557 return static_cast<Toolkit::Internal::TextField&>(handle);
560 inline const Toolkit::Internal::TextField& GetImpl(const Toolkit::TextField& textField)
562 DALI_ASSERT_ALWAYS(textField);
564 const Dali::RefObject& handle = textField.GetImplementation();
566 return static_cast<const Toolkit::Internal::TextField&>(handle);
569 } // namespace Toolkit
573 #endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H