1 #ifndef DALI_INTERNAL_INPUT_METHOD_CONTEXT_IMPL_ECORE_WL_H
2 #define DALI_INTERNAL_INPUT_METHOD_CONTEXT_IMPL_ECORE_WL_H
5 * Copyright (c) 2019 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/internal/input/linux/dali-ecore-imf.h>
23 #include <dali/internal/system/linux/dali-ecore.h>
25 #include <dali/public-api/common/vector-wrapper.h>
26 #include <dali/public-api/object/base-object.h>
27 #include <dali/integration-api/events/key-event-integ.h>
30 #include <dali/internal/input/common/input-method-context-impl.h>
43 class InputMethodContextEcoreWl : public Dali::Internal::Adaptor::InputMethodContext, public Dali::ConnectionTracker
48 * @brief Creates a new InputMethodContext handle
50 * @param[in] actor The actor that uses the new InputMethodContext instance.
51 * @return InputMethodContext pointer
53 static InputMethodContextPtr New( Dali::Actor actor );
56 * @brief Initializes member data.
58 void Initialize() override;
63 * @copydoc Dali::InputMethodContext::Finalize()
65 void Finalize() override;
68 * Connect Callbacks required for InputMethodContext.
69 * If you don't connect InputMethodContext callbacks, you can't get the key events.
70 * The events are PreeditChanged, Commit, DeleteSurrounding and PrivateCommand.
72 void ConnectCallbacks() override;
75 * Disconnect Callbacks attached to input method context.
77 void DisconnectCallbacks() override;
80 * @copydoc Dali::InputMethodContext::Activate()
82 void Activate() override;
85 * @copydoc Dali::InputMethodContext::Deactivate()
87 void Deactivate() override;
90 * @copydoc Dali::InputMethodContext::Reset()
92 void Reset() override;
95 * @copydoc Dali::InputMethodContext::GetContext()
97 ImfContext* GetContext() override;
100 * @copydoc Dali::InputMethodContext::RestoreAfterFocusLost()
102 bool RestoreAfterFocusLost() const override;
105 * @copydoc Dali::InputMethodContext::SetRestoreAfterFocusLost()
107 void SetRestoreAfterFocusLost( bool toggle ) override;
110 * @copydoc Dali::InputMethodContext::PreEditChanged()
112 void PreEditChanged( void *data, ImfContext *imfContext, void *eventInfo ) override;
115 * @copydoc Dali::InputMethodContext::NotifyCursorPosition()
117 void CommitReceived( void *data, ImfContext *imfContext, void *eventInfo ) override;
120 * @copydoc Dali::InputMethodContext::NotifyCursorPosition()
122 bool RetrieveSurrounding( void *data, ImfContext *imfContext, char** text, int* cursorPosition ) override;
125 * @copydoc Dali::InputMethodContext::DeleteSurrounding()
127 void DeleteSurrounding( void *data, ImfContext *imfContext, void *eventInfo ) override;
130 * @copydoc Dali::InputMethodContext::SendPrivateCommand()
132 void SendPrivateCommand( void* data, ImfContext* imfContext, void* eventInfo ) override;
135 * @copydoc Dali::InputMethodContext::SendCommitContent()
137 void SendCommitContent( void* data, ImfContext* imfContext, void* eventInfo ) override;
141 * @copydoc Dali::InputMethodContext::NotifyCursorPosition()
143 void NotifyCursorPosition() override;
146 * @copydoc Dali::InputMethodContext::SetCursorPosition()
148 void SetCursorPosition( unsigned int cursorPosition ) override;
151 * @copydoc Dali::InputMethodContext::GetCursorPosition()
153 unsigned int GetCursorPosition() const override;
156 * @copydoc Dali::InputMethodContext::SetSurroundingText()
158 void SetSurroundingText( const std::string& text ) override;
161 * @copydoc Dali::InputMethodContext::GetSurroundingText()
163 const std::string& GetSurroundingText() const override;
166 * @copydoc Dali::InputMethodContext::NotifyTextInputMultiLine()
168 void NotifyTextInputMultiLine( bool multiLine ) override;
171 * @copydoc Dali::InputMethodContext::GetTextDirection()
173 Dali::InputMethodContext::TextDirection GetTextDirection() override;
176 * @copydoc Dali::InputMethodContext::GetInputMethodArea()
178 Dali::Rect<int> GetInputMethodArea() override;
181 * @copydoc Dali::InputMethodContext::ApplyOptions()
183 void ApplyOptions( const InputMethodOptions& options ) override;
186 * @copydoc Dali::InputMethodContext::SetInputPanelData()
188 void SetInputPanelData( const std::string& data ) override;
191 * @copydoc Dali::InputMethodContext::GetInputPanelData()
193 void GetInputPanelData( std::string& data ) override;
196 * @copydoc Dali::InputMethodContext::GetInputPanelState()
198 Dali::InputMethodContext::State GetInputPanelState() override;
201 * @copydoc Dali::InputMethodContext::SetReturnKeyState()
203 void SetReturnKeyState( bool visible ) override;
206 * @copydoc Dali::InputMethodContext::AutoEnableInputPanel()
208 void AutoEnableInputPanel( bool enabled ) override;
211 * @copydoc Dali::InputMethodContext::ShowInputPanel()
213 void ShowInputPanel() override;
216 * @copydoc Dali::InputMethodContext::HideInputPanel()
218 void HideInputPanel() override;
221 * @copydoc Dali::InputMethodContext::GetKeyboardType()
223 Dali::InputMethodContext::KeyboardType GetKeyboardType() override;
226 * @copydoc Dali::InputMethodContext::GetInputPanelLocale()
228 std::string GetInputPanelLocale() override;
231 * @copydoc Dali::InputMethodContext::SetContentMIMETypes()
233 void SetContentMIMETypes( const std::string& mimeTypes ) override;
236 * @copydoc Dali::InputMethodContext::FilterEventKey()
238 bool FilterEventKey( const Dali::KeyEvent& keyEvent ) override;
241 * @copydoc Dali::InputMethodContext::AllowTextPrediction()
243 void AllowTextPrediction( bool prediction ) override;
246 * @copydoc Dali::InputMethodContext::IsTextPredictionAllowed()
248 bool IsTextPredictionAllowed() const override;
251 * @copydoc Dali::InputMethodContext::SetInputPanelLanguage()
253 void SetInputPanelLanguage( Dali::InputMethodContext::InputPanelLanguage language ) override;
256 * @copydoc Dali::InputMethodContext::GetInputPanelLanguage()
258 Dali::InputMethodContext::InputPanelLanguage GetInputPanelLanguage() const override;
262 * Context created the first time and kept until deleted.
264 void CreateContext();
267 * @copydoc Dali::InputMethodContext::DeleteContext()
269 void DeleteContext();
274 * @brief Process event key down, whether filter a key to isf.
276 * @param[in] keyEvent The event key to be handled.
277 * @return Whether the event key is handled.
279 bool ProcessEventKeyDown( const KeyEvent& keyEvent );
282 * @brief Process event key up, whether filter a key to isf.
284 * @param[in] keyEvent The event key to be handled.
285 * @return Whether the event key is handled.
287 bool ProcessEventKeyUp( const KeyEvent& keyEvent );
290 * Ecore_Event_Modifier enums in Ecore_Input.h do not match Ecore_IMF_Keyboard_Modifiers in Ecore_IMF.h.
291 * This function converts from Ecore_Event_Modifier to Ecore_IMF_Keyboard_Modifiers enums.
292 * @param[in] ecoreModifier the Ecore_Event_Modifier input.
293 * @return the Ecore_IMF_Keyboard_Modifiers output.
295 Ecore_IMF_Keyboard_Modifiers EcoreInputModifierToEcoreIMFModifier( unsigned int ecoreModifier );
298 * EcoreInputModifierToEcoreIMFLock function converts from Ecore_Event_Modifier to Ecore_IMF_Keyboard_Locks enums.
299 * @param[in] modifier the Ecore_Event_Modifier input.
300 * @return the Ecore_IMF_Keyboard_Locks output.
302 Ecore_IMF_Keyboard_Locks EcoreInputModifierToEcoreIMFLock( unsigned int modifier );
305 * Called when the binded actor is added to a window.
307 void OnStaged( Dali::Actor actor );
311 * @brief Constructor.
313 explicit InputMethodContextEcoreWl( Dali::Actor actor );
319 virtual ~InputMethodContextEcoreWl() override;
322 // Undefined copy constructor
323 explicit InputMethodContextEcoreWl( const InputMethodContextEcoreWl& inputMethodContext) = delete;
325 // Undefined assignment operator
326 InputMethodContextEcoreWl& operator=( const InputMethodContextEcoreWl& inputMethodContext ) = delete;
329 Ecore_IMF_Context* mIMFContext;
330 int mIMFCursorPosition;
331 std::string mSurroundingText;
333 bool mRestoreAfterFocusLost:1; ///< Whether the keyboard needs to be restored (activated ) after focus regained.
334 bool mIdleCallbackConnected:1; ///< Whether the idle callback is already connected.
336 std::vector<Dali::Integration::KeyEvent> mKeyEvents; ///< Stores key events to be sent from idle call-back.
337 InputMethodOptions mOptions;
343 } // namespace Adaptor
345 } // namespace Internal
349 #endif // DALI_INTERNAL_INPUT_METHOD_CONTEXT_IMPL_ECORE_WL_H