1 #ifndef DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
2 #define DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H
5 * Copyright (c) 2016 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>
25 #include <dali-toolkit/public-api/controls/control-impl.h>
26 #include <dali-toolkit/public-api/controls/text-controls/text-editor.h>
27 #include <dali-toolkit/internal/text/clipping/text-clipper.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-controller.h>
32 #include <dali-toolkit/internal/text/rendering/text-renderer.h>
44 * @brief A control which renders a long text string with styles.
46 class TextEditor : public Control, public Text::ControlInterface, public Text::EditableControlInterface
51 * @copydoc Dali::Toollkit::TextEditor::New()
53 static Toolkit::TextEditor 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 * Connects a callback function with the object's signals.
77 * @param[in] object The object providing the signal.
78 * @param[in] tracker Used to disconnect the signal.
79 * @param[in] signalName The signal to connect to.
80 * @param[in] functor A newly allocated FunctorDelegate.
81 * @return True if the signal was connected.
82 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
84 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
87 * @copydoc TextEditor::TextChangedSignal()
89 Toolkit::TextEditor::TextChangedSignalType& TextChangedSignal();
92 * @copydoc TextEditor::TextChangedSignal()
94 Toolkit::TextEditor::InputStyleChangedSignalType& InputStyleChangedSignal();
96 private: // From Control
99 * @copydoc Control::OnInitialize()
101 virtual void OnInitialize();
104 * @copydoc Control::OnStyleChange()
106 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
109 * @copydoc Control::GetNaturalSize()
111 virtual Vector3 GetNaturalSize();
114 * @copydoc Control::GetHeightForWidth()
116 virtual float GetHeightForWidth( float width );
119 * @copydoc Control::OnInitialize()
121 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
124 * @copydoc Control::OnKeyInputFocusGained()
126 virtual void OnKeyInputFocusGained();
129 * @copydoc Control::OnKeyInputFocusLost()
131 virtual void OnKeyInputFocusLost();
134 * @copydoc Control::OnTap()
136 virtual void OnTap( const TapGesture& tap );
139 * @copydoc Control::OnPan()
141 virtual void OnPan( const PanGesture& gesture );
144 * @copydoc Control::OnLongPress()
146 virtual void OnLongPress( const LongPressGesture& gesture );
149 * @copydoc Control::OnStageConnection()
151 virtual void OnStageConnection( int depth );
154 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
156 virtual bool OnKeyEvent(const KeyEvent& event);
158 // From ControlInterface
161 * @copydoc Text::ControlInterface::RequestTextRelayout()
163 virtual void RequestTextRelayout();
165 // From EditableControlInterface
168 * @copydoc Text::ControlInterface::TextChanged()
170 virtual void TextChanged();
173 * @copydoc Text::ControlInterface::MaxLengthReached()
175 virtual void MaxLengthReached();
178 * @copydoc Text::ControlInterface::InputStyleChanged()
180 virtual void InputStyleChanged( Text::InputStyle::Mask inputStyleMask );
183 * @copydoc Text::ControlInterface::AddDecoration()
185 virtual void AddDecoration( Actor& actor, bool needsClipping );
187 private: // Implementation
190 * @copydoc Dali::Toolkit::Text::Controller::(ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent)
192 ImfManager::ImfCallbackData OnImfEvent( ImfManager& imfManager, const ImfManager::ImfEventData& imfEvent );
195 * @brief Callback when Clipboard signals an item should be pasted
196 * @param[in] clipboard handle to Clipboard Event Notifier
198 void OnClipboardTextSelected( ClipboardEventNotifier& clipboard );
201 * @brief Get a Property Map for the image used for the required Handle Image
202 * @param[out] value the returned image property
203 * @param[in] handleType the type of handle
204 * @param[in] handleImageType the type of image for the given handleType
206 void GetHandleImagePropertyValue( Property::Value& value, Text::HandleType handleType, Text::HandleImageType handleImageType );
209 * @brief Enable or disable clipping.
211 * @param[in] size The area to clip within.
213 void EnableClipping( const Vector2& size );
216 * @brief Callback when keyboard is shown/hidden.
218 * @param[in] keyboardShown True if keyboard is shown.
220 void KeyboardStatusChanged( bool keyboardShown );
223 * @brief Callback when TextEditor is touched
225 * @param[in] actor TextEditor touched
226 * @param[in] touch Touch information
228 bool OnTouched( Actor actor, const TouchData& touch );
231 * @brief Callbacks called on idle.
233 * If there are notifications of change of input style on the queue, Toolkit::TextEditor::InputStyleChangedSignal() are emitted.
238 * Construct a new TextEditor.
243 * A reference counted object may only be deleted by calling Unreference()
245 virtual ~TextEditor();
247 // Undefined copy constructor and assignment operators
248 TextEditor(const TextEditor&);
249 TextEditor& operator=(const TextEditor& rhs);
252 * @brief Render view, create and attach actor(s) to this text editor.
254 void RenderText( Text::Controller::UpdateTextType updateTextType );
256 // Connection needed to re-render text, when a text editor returns to the stage.
257 void OnStageConnect( Dali::Actor actor );
262 Toolkit::TextEditor::TextChangedSignalType mTextChangedSignal;
263 Toolkit::TextEditor::InputStyleChangedSignalType mInputStyleChangedSignal;
265 Text::ControllerPtr mController;
266 Text::RendererPtr mRenderer;
267 Text::DecoratorPtr mDecorator;
268 Text::ClipperPtr mClipper;
269 std::vector<Actor> mClippingDecorationActors; ///< Decoration actors which need clipping.
271 Actor mRenderableActor;
272 CallbackBase* mIdleCallback;
274 int mRenderingBackend;
275 bool mHasBeenStaged:1;
278 } // namespace Internal
280 // Helpers for public-api forwarding methods
282 inline Toolkit::Internal::TextEditor& GetImpl( Toolkit::TextEditor& textEditor )
284 DALI_ASSERT_ALWAYS(textEditor);
286 Dali::RefObject& handle = textEditor.GetImplementation();
288 return static_cast<Toolkit::Internal::TextEditor&>(handle);
291 inline const Toolkit::Internal::TextEditor& GetImpl( const Toolkit::TextEditor& textEditor )
293 DALI_ASSERT_ALWAYS(textEditor);
295 const Dali::RefObject& handle = textEditor.GetImplementation();
297 return static_cast<const Toolkit::Internal::TextEditor&>(handle);
300 } // namespace Toolkit
304 #endif // DALI_TOOLKIT_INTERNAL_TEXT_EDITOR_H