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::InputFilteredSignal()
122 DevelTextField::InputFilteredSignalType& InputFilteredSignal();
124 private: // From Control
126 * @copydoc Control::OnInitialize()
128 void OnInitialize() override;
131 * @copydoc Control::OnStyleChange()
133 void OnStyleChange(Toolkit::StyleManager styleManager, StyleChange::Type change) override;
136 * @copydoc Control::GetNaturalSize()
138 Vector3 GetNaturalSize() override;
141 * @copydoc Control::GetHeightForWidth()
143 float GetHeightForWidth(float width) override;
146 * @copydoc Control::OnInitialize()
148 void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
151 * @copydoc Control::OnKeyInputFocusGained()
153 void OnKeyInputFocusGained() override;
156 * @copydoc Control::OnKeyInputFocusLost()
158 void OnKeyInputFocusLost() override;
161 * @copydoc Control::OnAccessibilityActivated()
163 bool OnAccessibilityActivated() override;
166 * @copydoc Control::OnTap()
168 void OnTap(const TapGesture& tap) override;
171 * @copydoc Control::OnPan()
173 void OnPan(const PanGesture& gesture) override;
176 * @copydoc Control::OnLongPress()
178 void OnLongPress(const LongPressGesture& gesture) override;
181 * @copydoc Control::OnSceneConnection()
183 void OnSceneConnection(int depth) override;
186 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
188 bool OnKeyEvent(const KeyEvent& event) override;
190 // From ControlInterface
193 * @copydoc Text::ControlInterface::RequestTextRelayout()
195 void RequestTextRelayout() override;
197 // From EditableControlInterface
200 * @copydoc Text::EditableControlInterface::TextChanged()
202 void TextInserted(unsigned int position, unsigned int length, const std::string& content) override;
205 * @copydoc Text::EditableControlInterface::TextDeleted()
207 void TextDeleted(unsigned int position, unsigned int length, const std::string& content) override;
210 * @copydoc Text::EditableControlInterface::CursorMoved()
212 void CursorMoved(unsigned int position) override;
215 * @copydoc Text::EditableControlInterface::TextChanged()
217 void TextChanged(bool immediate) override;
220 * @copydoc Text::EditableControlInterface::MaxLengthReached()
222 void MaxLengthReached() override;
225 * @copydoc Text::EditableControlInterface::InputStyleChanged()
227 void InputStyleChanged(Text::InputStyle::Mask inputStyleMask) override;
230 * @copydoc Text::EditableControlInterface::AddDecoration()
232 void AddDecoration(Actor& actor, bool needsClipping) override;
235 * @copydoc Text::EditableControlInterface::InputFiltered()
237 void InputFiltered(Toolkit::InputFilter::Property::Type type) override;
240 * @copydoc Text::EditableControlInterface::GetControlBackgroundColor()
242 void GetControlBackgroundColor(Vector4& color) const override;
244 // From SelectableControlInterface
247 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
249 void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) override;
252 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
254 Uint32Pair GetTextSelectionRange() const override;
257 * @copydoc Text::SelectableControlInterface::SelectWholeText()
259 void SelectWholeText() override;
262 * @copydoc Text::SelectableControlInterface::SelectNone()
264 void SelectNone() override;
267 * @copydoc Text::SelectableControlInterface::SelectText()
269 void SelectText(const uint32_t start, const uint32_t end) override;
272 * @copydoc Text::SelectableControlInterface::GetSelectedText()
274 string GetSelectedText() const override;
277 * @copydoc Text::EditableControlInterface::IsEditable()
279 bool IsEditable() const override;
282 * @copydoc Text::EditableControlInterface::SetEditable()
284 void SetEditable(bool editable) override;
286 // From AnchorControlInterface
289 * @copydoc Text::AnchorControlInterface::AnchorClicked()
291 void AnchorClicked(const std::string& href) override;
293 private: // Implementation
295 * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
297 InputMethodContext::CallbackData OnInputMethodContextEvent(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent);
300 * @brief Callback when Clipboard signals an item should be pasted
301 * @param[in] clipboard handle to Clipboard Event Notifier
303 void OnClipboardTextSelected(ClipboardEventNotifier& clipboard);
306 * @brief Get a Property Map for the image used for the required Handle Image
307 * @param[out] value the returned image property
308 * @param[in] handleType the type of handle
309 * @param[in] handleImageType the type of image for the given handleType
311 void GetHandleImagePropertyValue(Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType);
314 * @brief Enable or disable clipping.
316 void EnableClipping();
319 * @brief Callback when keyboard is shown/hidden.
321 * @param[in] keyboardShown True if keyboard is shown.
323 void KeyboardStatusChanged(bool keyboardShown);
326 * @brief Callback when TextField is touched
328 * @param[in] actor TextField touched
329 * @param[in] touch Touch information
331 bool OnTouched(Actor actor, const TouchEvent& touch);
334 * @brief Callbacks called on idle.
336 * If there are notifications of change of input style on the queue, Toolkit::TextField::InputStyleChangedSignal() are emitted.
341 * @brief Emits TextChanged signal.
343 void EmitTextChangedSignal();
346 * @brief Callback function for when the layout is changed.
347 * @param[in] actor The actor whose layoutDirection is changed.
348 * @param[in] type The layoutDirection.
350 void OnLayoutDirectionChanged(Actor actor, LayoutDirection::Type type);
353 * Construct a new TextField.
358 * A reference counted object may only be deleted by calling Unreference()
360 virtual ~TextField();
362 // Undefined copy constructor and assignment operators
363 TextField(const TextField&);
364 TextField& operator=(const TextField& rhs);
367 * @brief Resize actor to the given size.
369 * @param[in] actor The actor to be resized.
370 * @param[in] size Size to change.
372 void ResizeActor(Actor& actor, const Vector2& size);
375 * @brief Render view, create and attach actor(s) to this Text Field.
377 void RenderText(Text::Controller::UpdateTextType updateTextType);
379 // Connection needed to re-render text, when a Text Field returns to the scene.
380 void OnSceneConnect(Dali::Actor actor);
384 Toolkit::TextField::TextChangedSignalType mTextChangedSignal;
385 Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal;
386 Toolkit::TextField::InputStyleChangedSignalType mInputStyleChangedSignal;
387 Toolkit::DevelTextField::AnchorClickedSignalType mAnchorClickedSignal;
388 Toolkit::DevelTextField::InputFilteredSignalType mInputFilteredSignal;
390 InputMethodContext mInputMethodContext;
391 Text::ControllerPtr mController;
392 Text::RendererPtr mRenderer;
393 Text::DecoratorPtr mDecorator;
394 Toolkit::Control mStencil; ///< For EXCEED_POLICY_CLIP
395 std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
396 Dali::InputMethodOptions mInputMethodOptions;
398 Actor mRenderableActor;
400 Actor mBackgroundActor;
401 CallbackBase* mIdleCallback;
403 float mAlignmentOffset;
404 int mRenderingBackend;
406 bool mHasBeenStaged : 1;
407 bool mTextChanged : 1; ///< If true, emits TextChangedSignal in next OnRelayout().
411 * @brief This structure is to connect TextField with Accessible functions.
413 struct AccessibleImpl : public DevelControl::AccessibleImpl,
414 public virtual Dali::Accessibility::Text,
415 public virtual Dali::Accessibility::EditableText
417 using DevelControl::AccessibleImpl::AccessibleImpl;
420 * @copydoc Dali::Accessibility::Accessible::GetName()
422 std::string GetName() override;
425 * @copydoc Dali::Accessibility::Text::GetText()
427 std::string GetText(size_t startOffset, size_t endOffset) override;
430 * @copydoc Dali::Accessibility::Text::GetCharacterCount()
432 size_t GetCharacterCount() override;
435 * @copydoc Dali::Accessibility::Text::GetCursorOffset()
437 size_t GetCursorOffset() override;
440 * @copydoc Dali::Accessibility::Text::SetCursorOffset()
442 bool SetCursorOffset(size_t offset) override;
445 * @copydoc Dali::Accessibility::Text::GetTextAtOffset()
447 Accessibility::Range GetTextAtOffset(size_t offset, Accessibility::TextBoundary boundary) override;
450 * @copydoc Dali::Accessibility::Text::GetRangeOfSelection()
452 Accessibility::Range GetRangeOfSelection(size_t selectionIndex) override;
455 * @copydoc Dali::Accessibility::Text::RemoveSelection()
457 bool RemoveSelection(size_t selectionIndex) override;
460 * @copydoc Dali::Accessibility::Text::SetRangeOfSelection()
462 bool SetRangeOfSelection(size_t selectionIndex, size_t startOffset, size_t endOffset) override;
465 * @copydoc Dali::Accessibility::EditableText::CopyText()
467 bool CopyText(size_t startPosition, size_t endPosition) override;
470 * @copydoc Dali::Accessibility::EditableText::CutText()
472 bool CutText(size_t startPosition, size_t endPosition) override;
475 * @copydoc Dali::Accessibility::Accessible::GetStates()
477 Accessibility::States CalculateStates() override;
480 * @copydoc Dali::Accessibility::EditableText::InsertText()
482 bool InsertText(size_t startPosition, std::string text) override;
485 * @copydoc Dali::Accessibility::EditableText::SetTextContents()
487 bool SetTextContents(std::string newContents) override;
490 * @copydoc Dali::Accessibility::EditableText::DeleteText()
492 bool DeleteText(size_t startPosition, size_t endPosition) override;
496 } // namespace Internal
498 // Helpers for public-api forwarding methods
500 inline Toolkit::Internal::TextField& GetImpl(Toolkit::TextField& textField)
502 DALI_ASSERT_ALWAYS(textField);
504 Dali::RefObject& handle = textField.GetImplementation();
506 return static_cast<Toolkit::Internal::TextField&>(handle);
509 inline const Toolkit::Internal::TextField& GetImpl(const Toolkit::TextField& textField)
511 DALI_ASSERT_ALWAYS(textField);
513 const Dali::RefObject& handle = textField.GetImplementation();
515 return static_cast<const Toolkit::Internal::TextField&>(handle);
518 } // namespace Toolkit
522 #endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H