1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H
5 * Copyright (c) 2017 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/public-api/common/stage.h>
27 #include <dali-toolkit/public-api/controls/control-impl.h>
28 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
29 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
30 #include <dali-toolkit/internal/text/text-control-interface.h>
31 #include <dali-toolkit/internal/text/text-editable-control-interface.h>
32 #include <dali-toolkit/internal/text/text-controller.h>
33 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
44 * @brief A control which renders a short text string.
46 class TextField : public Control, public Text::ControlInterface, public Text::EditableControlInterface
51 * @copydoc Dali::Toollkit::TextField::New()
53 static Toolkit::TextField New();
58 * @brief Called when a property of an object of this type is set.
60 * @param[in] object The object whose property is set.
61 * @param[in] index The property index.
62 * @param[in] value The new property value.
64 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
67 * @brief Called to retrieve a property of an object of this type.
69 * @param[in] object The object whose property is to be retrieved.
70 * @param[in] index The property index.
71 * @return The current value of the property.
73 static Property::Value GetProperty( BaseObject* object, Property::Index index );
76 * @copydoc Dali::Toollkit::TextField::GetInputMethodContext()
78 InputMethodContext GetInputMethodContext();
81 * Connects a callback function with the object's signals.
82 * @param[in] object The object providing the signal.
83 * @param[in] tracker Used to disconnect the signal.
84 * @param[in] signalName The signal to connect to.
85 * @param[in] functor A newly allocated FunctorDelegate.
86 * @return True if the signal was connected.
87 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
89 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
92 * @copydoc TextField::TextChangedSignal()
94 Toolkit::TextField::TextChangedSignalType& TextChangedSignal();
97 * @copydoc TextField::MaxLengthReachedSignal()
99 Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal();
102 * @copydoc TextField::TextChangedSignal()
104 Toolkit::TextField::InputStyleChangedSignalType& InputStyleChangedSignal();
106 private: // From Control
109 * @copydoc Control::OnInitialize()
111 virtual void OnInitialize();
114 * @copydoc Control::OnStyleChange()
116 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
119 * @copydoc Control::GetNaturalSize()
121 virtual Vector3 GetNaturalSize();
124 * @copydoc Control::GetHeightForWidth()
126 virtual float GetHeightForWidth( float width );
129 * @copydoc Control::OnInitialize()
131 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
134 * @copydoc Control::OnKeyInputFocusGained()
136 virtual void OnKeyInputFocusGained();
139 * @copydoc Control::OnKeyInputFocusLost()
141 virtual void OnKeyInputFocusLost();
144 * @copydoc Control::OnTap()
146 virtual void OnTap( const TapGesture& tap );
149 * @copydoc Control::OnPan()
151 virtual void OnPan( const PanGesture& gesture );
154 * @copydoc Control::OnLongPress()
156 virtual void OnLongPress( const LongPressGesture& gesture );
159 * @copydoc Control::OnStageConnection()
161 virtual void OnStageConnection( int depth );
164 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
166 virtual bool OnKeyEvent(const KeyEvent& event);
168 // From ControlInterface
171 * @copydoc Text::ControlInterface::RequestTextRelayout()
173 virtual void RequestTextRelayout();
175 // From EditableControlInterface
178 * @copydoc Text::ControlInterface::TextChanged()
180 virtual void TextChanged();
183 * @copydoc Text::ControlInterface::MaxLengthReached()
185 virtual void MaxLengthReached();
188 * @copydoc Text::ControlInterface::InputStyleChanged()
190 virtual void InputStyleChanged( Text::InputStyle::Mask inputStyleMask );
193 * @copydoc Text::ControlInterface::AddDecoration()
195 virtual void AddDecoration( Actor& actor, bool needsClipping );
197 private: // Implementation
200 * @copydoc Dali::Toolkit::Text::Controller::(InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent)
202 InputMethodContext::CallbackData OnInputMethodContextEvent( InputMethodContext& inputMethodContext, const InputMethodContext::EventData& inputMethodContextEvent );
205 * @brief Callback when Clipboard signals an item should be pasted
206 * @param[in] clipboard handle to Clipboard Event Notifier
208 void OnClipboardTextSelected( ClipboardEventNotifier& clipboard );
211 * @brief Get a Property Map for the image used for the required Handle Image
212 * @param[out] value the returned image property
213 * @param[in] handleType the type of handle
214 * @param[in] handleImageType the type of image for the given handleType
216 void GetHandleImagePropertyValue( Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType );
219 * @brief Enable or disable clipping.
221 void EnableClipping();
224 * @brief Callback when keyboard is shown/hidden.
226 * @param[in] keyboardShown True if keyboard is shown.
228 void KeyboardStatusChanged( bool keyboardShown );
231 * @brief Callback when TextField is touched
233 * @param[in] actor TextField touched
234 * @param[in] touch Touch information
236 bool OnTouched( Actor actor, const TouchData& touch );
239 * @brief Callbacks called on idle.
241 * If there are notifications of change of input style on the queue, Toolkit::TextField::InputStyleChangedSignal() are emitted.
246 * Construct a new TextField.
251 * A reference counted object may only be deleted by calling Unreference()
253 virtual ~TextField();
255 // Undefined copy constructor and assignment operators
256 TextField(const TextField&);
257 TextField& operator=(const TextField& rhs);
260 * @brief Render view, create and attach actor(s) to this Text Field.
262 void RenderText( Text::Controller::UpdateTextType updateTextType );
264 // Connection needed to re-render text, when a Text Field returns to the stage.
265 void OnStageConnect( Dali::Actor actor );
270 Toolkit::TextField::TextChangedSignalType mTextChangedSignal;
271 Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal;
272 Toolkit::TextField::InputStyleChangedSignalType mInputStyleChangedSignal;
274 InputMethodContext mInputMethodContext;
275 Text::ControllerPtr mController;
276 Text::RendererPtr mRenderer;
277 Text::DecoratorPtr mDecorator;
278 Toolkit::Control mStencil; ///< For EXCEED_POLICY_CLIP
279 std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
280 Dali::InputMethodOptions mInputMethodOptions;
282 Actor mRenderableActor;
284 CallbackBase* mIdleCallback;
286 float mAlignmentOffset;
287 int mRenderingBackend;
289 bool mHasBeenStaged:1;
292 } // namespace Internal
294 // Helpers for public-api forwarding methods
296 inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField )
298 DALI_ASSERT_ALWAYS(textField);
300 Dali::RefObject& handle = textField.GetImplementation();
302 return static_cast<Toolkit::Internal::TextField&>(handle);
305 inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textField )
307 DALI_ASSERT_ALWAYS(textField);
309 const Dali::RefObject& handle = textField.GetImplementation();
311 return static_cast<const Toolkit::Internal::TextField&>(handle);
314 } // namespace Toolkit
318 #endif // DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H