1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
5 * Copyright (c) 2020 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/public-api/controls/control-impl.h>
27 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
28 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
29 #include <dali-toolkit/internal/text/text-control-interface.h>
30 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
31 #include <dali-toolkit/internal/text/text-selectable-control-interface.h>
32 #include <dali-toolkit/internal/text/text-controller.h>
33 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
34 #include <dali-toolkit/internal/controls/control/control-data-impl.h>
45 * @brief A control which renders a short text string.
47 class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface, public Text::SelectableControlInterface
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 * @copydoc TextField::TextChangedSignal()
95 Toolkit::TextField::TextChangedSignalType& TextChangedSignal();
98 * @copydoc TextField::MaxLengthReachedSignal()
100 Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal();
103 * @copydoc TextField::TextChangedSignal()
105 Toolkit::TextField::InputStyleChangedSignalType& InputStyleChangedSignal();
107 Text::ControllerPtr getController();
109 private: // From Control
112 * @copydoc Control::OnInitialize()
114 void OnInitialize() override;
117 * @copydoc Control::OnStyleChange()
119 void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change ) override;
122 * @copydoc Control::GetNaturalSize()
124 Vector3 GetNaturalSize() override;
127 * @copydoc Control::GetHeightForWidth()
129 float GetHeightForWidth( float width ) override;
132 * @copydoc Control::OnInitialize()
134 void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
137 * @copydoc Control::OnKeyInputFocusGained()
139 void OnKeyInputFocusGained() override;
142 * @copydoc Control::OnKeyInputFocusLost()
144 void OnKeyInputFocusLost() override;
147 * @copydoc Control::OnAccessibilityActivated()
149 bool OnAccessibilityActivated() override;
152 * @copydoc Control::OnTap()
154 void OnTap( const TapGesture& tap ) override;
157 * @copydoc Control::OnPan()
159 void OnPan( const PanGesture& gesture ) override;
162 * @copydoc Control::OnLongPress()
164 void OnLongPress( const LongPressGesture& gesture ) override;
167 * @copydoc Control::OnSceneConnection()
169 void OnSceneConnection( int depth ) override;
172 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
174 bool OnKeyEvent(const KeyEvent& event) override;
176 // From ControlInterface
179 * @copydoc Text::ControlInterface::RequestTextRelayout()
181 void RequestTextRelayout() override;
183 // From EditableControlInterface
186 * @copydoc Text::EditableControlInterface::TextChanged()
188 void TextInserted( unsigned int position, unsigned int length, const std::string &content ) override;
191 * @copydoc Text::EditableControlInterface::TextDeleted()
193 void TextDeleted( unsigned int position, unsigned int length, const std::string &content ) override;
196 * @copydoc Text::EditableControlInterface::CaretMoved()
198 void CaretMoved( unsigned int position ) override;
201 * @copydoc Text::EditableControlInterface::TextChanged()
203 void TextChanged() override;
206 * @copydoc Text::EditableControlInterface::MaxLengthReached()
208 void MaxLengthReached() override;
211 * @copydoc Text::EditableControlInterface::InputStyleChanged()
213 void InputStyleChanged( Text::InputStyle::Mask inputStyleMask ) override;
216 * @copydoc Text::EditableControlInterface::AddDecoration()
218 void AddDecoration( Actor& actor, bool needsClipping ) override;
220 // From SelectableControlInterface
223 * @copydoc Text::SelectableControlInterface::SetTextSelectionRange()
225 void SetTextSelectionRange(const uint32_t *start, const uint32_t *end) override;
228 * @copydoc Text::SelectableControlInterface::GetTextSelectionRange()
230 Uint32Pair GetTextSelectionRange() const override;
233 * @copydoc Text::SelectableControlInterface::SelectWholeText()
235 void SelectWholeText() override;
238 * @copydoc Text::SelectableControlInterface::SelectNone()
240 void SelectNone() override;
243 * @copydoc Text::SelectableControlInterface::GetSelectedText()
245 string GetSelectedText() const override;
248 * @copydoc Text::EditableControlInterface::IsEditable()
250 bool IsEditable() const override;
253 * @copydoc Text::EditableControlInterface::SetEditable()
255 void SetEditable( bool editable ) override;
257 private: // Implementation
260 * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
262 InputMethodContext::CallbackData OnInputMethodContextEvent( InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent );
265 * @brief Callback when Clipboard signals an item should be pasted
266 * @param[in] clipboard handle to Clipboard Event Notifier
268 void OnClipboardTextSelected( ClipboardEventNotifier& clipboard );
271 * @brief Get a Property Map for the image used for the required Handle Image
272 * @param[out] value the returned image property
273 * @param[in] handleType the type of handle
274 * @param[in] handleImageType the type of image for the given handleType
276 void GetHandleImagePropertyValue( Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType );
279 * @brief Enable or disable clipping.
281 void EnableClipping();
284 * @brief Callback when keyboard is shown/hidden.
286 * @param[in] keyboardShown True if keyboard is shown.
288 void KeyboardStatusChanged( bool keyboardShown );
291 * @brief Callback when TextField is touched
293 * @param[in] actor TextField touched
294 * @param[in] touch Touch information
296 bool OnTouched( Actor actor, const TouchEvent& touch );
299 * @brief Callbacks called on idle.
301 * If there are notifications of change of input style on the queue, Toolkit::TextField::InputStyleChangedSignal() are emitted.
306 * Construct a new TextField.
311 * A reference counted object may only be deleted by calling Unreference()
313 virtual ~TextField();
315 // Undefined copy constructor and assignment operators
316 TextField(const TextField&);
317 TextField& operator=(const TextField& rhs);
320 * @brief Render view, create and attach actor(s) to this Text Field.
322 void RenderText( Text::Controller::UpdateTextType updateTextType );
324 // Connection needed to re-render text, when a Text Field returns to the scene.
325 void OnSceneConnect( Dali::Actor actor );
327 public: // For UTC only
329 Text::ControllerPtr GetTextController() { return mController; }
334 Toolkit::TextField::TextChangedSignalType mTextChangedSignal;
335 Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal;
336 Toolkit::TextField::InputStyleChangedSignalType mInputStyleChangedSignal;
338 InputMethodContext mInputMethodContext;
339 Text::ControllerPtr mController;
340 Text::RendererPtr mRenderer;
341 Text::DecoratorPtr mDecorator;
342 Toolkit::Control mStencil; ///< For EXCEED_POLICY_CLIP
343 std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
344 Dali::InputMethodOptions mInputMethodOptions;
346 Actor mRenderableActor;
348 Actor mBackgroundActor;
349 CallbackBase* mIdleCallback;
351 float mAlignmentOffset;
352 int mRenderingBackend;
354 bool mHasBeenStaged:1;
357 struct AccessibleImpl : public Control::Impl::AccessibleImpl,
358 public virtual Dali::Accessibility::Text,
359 public virtual Dali::Accessibility::EditableText
361 using Control::Impl::AccessibleImpl::AccessibleImpl;
363 std::string GetName() override;
364 std::string GetText( size_t startOffset, size_t endOffset ) override;
365 size_t GetCharacterCount() override;
366 size_t GetCaretOffset() override;
367 bool SetCaretOffset(size_t offset) override;
368 Dali::Accessibility::Range
369 GetTextAtOffset( size_t offset,
370 Dali::Accessibility::TextBoundary boundary ) override;
371 Dali::Accessibility::Range GetSelection( size_t selectionNum ) override;
372 bool RemoveSelection( size_t selectionNum ) override;
373 bool SetSelection( size_t selectionNum, size_t startOffset,
374 size_t endOffset ) override;
375 bool CopyText( size_t startPosition, size_t endPosition ) override;
376 bool CutText( size_t startPosition, size_t endPosition ) override;
377 Dali::Accessibility::States CalculateStates() override;
381 } // namespace Internal
383 // Helpers for public-api forwarding methods
385 inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField )
387 DALI_ASSERT_ALWAYS(textField);
389 Dali::RefObject& handle = textField.GetImplementation();
391 return static_cast<Toolkit::Internal::TextField&>(handle);
394 inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textField )
396 DALI_ASSERT_ALWAYS(textField);
398 const Dali::RefObject& handle = textField.GetImplementation();
400 return static_cast<const Toolkit::Internal::TextField&>(handle);
403 } // namespace Toolkit
407 #endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H