1 #ifndef __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__
2 #define __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__
5 * Copyright (c) 2015 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-toolkit/public-api/controls/control-impl.h>
23 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
24 #include <dali-toolkit/internal/text/clipping/text-clipper.h>
25 #include <dali-toolkit/internal/text/decorator/text-decorator.h>
26 #include <dali-toolkit/internal/text/text-control-interface.h>
27 #include <dali-toolkit/internal/text/text-controller.h>
28 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
31 #include <dali/devel-api/adaptor-framework/clipboard-event-notifier.h>
43 * @brief A control which renders a short text string.
45 class TextField : public Control, public Text::ControlInterface
50 * @copydoc Dali::Toollkit::TextField::New()
52 static Toolkit::TextField New();
57 * @brief Called when a property of an object of this type is set.
59 * @param[in] object The object whose property is set.
60 * @param[in] index The property index.
61 * @param[in] value The new property value.
63 static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
66 * @brief Called to retrieve a property of an object of this type.
68 * @param[in] object The object whose property is to be retrieved.
69 * @param[in] index The property index.
70 * @return The current value of the property.
72 static Property::Value GetProperty( BaseObject* object, Property::Index index );
75 * Connects a callback function with the object's signals.
76 * @param[in] object The object providing the signal.
77 * @param[in] tracker Used to disconnect the signal.
78 * @param[in] signalName The signal to connect to.
79 * @param[in] functor A newly allocated FunctorDelegate.
80 * @return True if the signal was connected.
81 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
83 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
86 * @copydoc TextField::TextChangedSignal()
88 Toolkit::TextField::TextChangedSignalType& TextChangedSignal();
91 * @copydoc TextField::MaxLengthReachedSignal()
93 Toolkit::TextField::MaxLengthReachedSignalType& MaxLengthReachedSignal();
95 private: // From Control
98 * @copydoc Control::OnInitialize()
100 virtual void OnInitialize();
103 * @copydoc Control::OnStyleChange()
105 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
108 * @copydoc Control::GetNaturalSize()
110 virtual Vector3 GetNaturalSize();
113 * @copydoc Control::GetHeightForWidth()
115 virtual float GetHeightForWidth( float width );
118 * @copydoc Control::OnInitialize()
120 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
123 * @copydoc Control::OnKeyInputFocusGained()
125 virtual void OnKeyInputFocusGained();
128 * @copydoc Control::OnKeyInputFocusLost()
130 virtual void OnKeyInputFocusLost();
133 * @copydoc Control::OnTap()
135 virtual void OnTap( const TapGesture& tap );
138 * @copydoc Control::OnPan()
140 virtual void OnPan( const PanGesture& gesture );
143 * @copydoc Control::OnLongPress()
145 virtual void OnLongPress( const LongPressGesture& gesture );
148 * @copydoc Control::OnStageConnection()
150 virtual void OnStageConnection( int depth );
153 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
155 virtual bool OnKeyEvent(const KeyEvent& event);
157 // From ControlInterface
160 * @copydoc Text::ControlInterface::AddDecoration()
162 virtual void AddDecoration( Actor& actor, bool needsClipping );
165 * @copydoc Text::ControlInterface::RequestTextRelayout()
167 virtual void RequestTextRelayout();
170 * @copydoc Text::ControlInterface::TextChanged()
172 virtual void TextChanged();
175 * @copydoc Text::ControlInterface::MaxLengthReached()
177 virtual void MaxLengthReached();
179 private: // Implementation
182 * @copydoc Dali::Toolkit::Text::Controller::(ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent)
184 ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
187 * @brief Callback when Clipboard signals an item should be pasted
188 * @param[in] clipboard handle to Clipboard Event Notifier
190 void OnClipboardTextSelected( ClipboardEventNotifier& clipboard );
193 * @brief Get a Property Map for the image used for the required Handle Image
194 * @param[out] value the returned image property
195 * @param[in] handleType the type of handle
196 * @param[in] handleImageType the type of image for the given handleType
198 void GetHandleImagePropertyValue( Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType );
201 * @brief Enable or disable clipping.
203 * @param[in] clipping True if clipping should be enabled.
204 * @param[in] size The area to clip within.
206 void EnableClipping( bool clipping, const Vector2& size );
209 * @brief Callback when keyboard is shown/hidden.
211 * @param[in] keyboardShown True if keyboard is shown.
213 void KeyboardStatusChanged( bool keyboardShown );
216 * @brief Callback when TextField is touched
218 * @param[in] actor TextField touched
219 * @param[in] event TouchEvent information
221 bool OnTouched( Actor actor, const TouchEvent& event );
224 * Construct a new TextField.
229 * A reference counted object may only be deleted by calling Unreference()
231 virtual ~TextField();
233 // Undefined copy constructor and assignment operators
234 TextField(const TextField&);
235 TextField& operator=(const TextField& rhs);
238 * @brief Render view, create and attach actor(s) to this Text Field.
242 // Connection needed to re-render text, when a Text Field returns to the stage.
243 void OnStageConnect( Dali::Actor actor );
248 Toolkit::TextField::TextChangedSignalType mTextChangedSignal;
249 Toolkit::TextField::MaxLengthReachedSignalType mMaxLengthReachedSignal;
251 Text::ControllerPtr mController;
252 Text::RendererPtr mRenderer;
253 Text::DecoratorPtr mDecorator;
254 Text::ClipperPtr mClipper; ///< For EXCEED_POLICY_CLIP
255 std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
257 Actor mRenderableActor;
259 int mRenderingBackend;
261 bool mHasBeenStaged:1;
264 } // namespace Internal
266 // Helpers for public-api forwarding methods
268 inline Toolkit::Internal::TextField& GetImpl( Toolkit::TextField& textField )
270 DALI_ASSERT_ALWAYS(textField);
272 Dali::RefObject& handle = textField.GetImplementation();
274 return static_cast<Toolkit::Internal::TextField&>(handle);
277 inline const Toolkit::Internal::TextField& GetImpl( const Toolkit::TextField& textField )
279 DALI_ASSERT_ALWAYS(textField);
281 const Dali::RefObject& handle = textField.GetImplementation();
283 return static_cast<const Toolkit::Internal::TextField&>(handle);
286 } // namespace Toolkit
290 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_FIELD_H__