1 #ifndef DALI_INTERNAL_INPUT_METHOD_CONTEXT_IMPL_WIN_H
\r
2 #define DALI_INTERNAL_INPUT_METHOD_CONTEXT_IMPL_WIN_H
\r
5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
\r
7 * Licensed under the Apache License, Version 2.0 (the "License");
\r
8 * you may not use this file except in compliance with the License.
\r
9 * You may obtain a copy of the License at
\r
11 * http://www.apache.org/licenses/LICENSE-2.0
\r
13 * Unless required by applicable law or agreed to in writing, software
\r
14 * distributed under the License is distributed on an "AS IS" BASIS,
\r
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
\r
16 * See the License for the specific language governing permissions and
\r
17 * limitations under the License.
\r
21 // EXTERNAL INCLUDES
\r
22 #include <dali/public-api/object/base-object.h>
\r
24 // INTERNAL INCLUDES
\r
25 #include <dali/devel-api/adaptor-framework/input-method-context.h>
\r
26 #include <dali/internal/input/common/input-method-context-impl.h>
\r
27 #include <dali/internal/window-system/windows/platform-implement-win.h>
\r
32 class RenderSurface;
\r
40 class InputMethodContextWin : public Dali::Internal::Adaptor::InputMethodContext, public Dali::ConnectionTracker
\r
44 * @brief Creates a new InputMethodContext handle
\r
46 * @param[in] actor The actor that uses the new InputMethodContext instance.
\r
47 * @return InputMethodContext pointer
\r
49 static InputMethodContextPtr New( Dali::Actor actor );
\r
53 * @param[in] win32Window, The window is created by application.
\r
55 explicit InputMethodContextWin( Dali::Actor actor );
\r
60 * @brief Initializes member data.
\r
62 void Initialize() override;
\r
65 * Connect Callbacks required for InputMethodContext.
\r
66 * If you don't connect InputMethodContext callbacks, you can't get the key events.
\r
67 * The events are PreeditChanged, Commit and DeleteSurrounding.
\r
69 void ConnectCallbacks() override;
\r
72 * Disconnect Callbacks attached to input method context.
\r
74 void DisconnectCallbacks() override;
\r
77 * @copydoc Dali::InputMethodContext::Finalize()
\r
79 void Finalize() override;
\r
82 * @copydoc Dali::InputMethodContext::Activate()
\r
84 void Activate() override;
\r
87 * @copydoc Dali::InputMethodContext::Deactivate()
\r
89 void Deactivate() override;
\r
92 * @copydoc Dali::InputMethodContext::Reset()
\r
94 void Reset() override;
\r
97 * @copydoc Dali::InputMethodContext::GetContext()
\r
99 ImfContext* GetContext() override;
\r
102 * @copydoc Dali::InputMethodContext::RestoreAfterFocusLost()
\r
104 bool RestoreAfterFocusLost() const override;
\r
107 * @copydoc Dali::InputMethodContext::SetRestoreAfterFocusLost()
\r
109 void SetRestoreAfterFocusLost( bool toggle ) override;
\r
112 * @copydoc Dali::InputMethodContext::PreEditChanged()
\r
114 void PreEditChanged( void* data, ImfContext* imfContext, void* eventInfo ) override;
\r
117 * @copydoc Dali::InputMethodContext::NotifyCursorPosition()
\r
119 void CommitReceived( void* data, ImfContext* imfContext, void* eventInfo ) override;
\r
122 * @copydoc Dali::InputMethodContext::NotifyCursorPosition()
\r
124 bool RetrieveSurrounding( void* data, ImfContext* imfContext, char** text, int* cursorPosition ) override;
\r
127 * @copydoc Dali::InputMethodContext::DeleteSurrounding()
\r
129 void DeleteSurrounding( void* data, ImfContext* imfContext, void* eventInfo ) override;
\r
132 * @copydoc Dali::InputMethodContext::SendPrivateCommand()
\r
134 void SendPrivateCommand( void* data, ImfContext* imfContext, void* eventInfo ) override
\r
138 * @copydoc Dali::InputMethodContext::SendCommitContent()
\r
140 void SendCommitContent( void* data, ImfContext* imfContext, void* eventInfo ) override
\r
145 * @copydoc Dali::InputMethodContext::NotifyCursorPosition()
\r
147 void NotifyCursorPosition() override;
\r
150 * @copydoc Dali::InputMethodContext::SetCursorPosition()
\r
152 void SetCursorPosition( unsigned int cursorPosition ) override;
\r
155 * @copydoc Dali::InputMethodContext::GetCursorPosition()
\r
157 unsigned int GetCursorPosition() const override;
\r
160 * @copydoc Dali::InputMethodContext::SetSurroundingText()
\r
162 void SetSurroundingText( const std::string& text ) override;
\r
165 * @copydoc Dali::InputMethodContext::GetSurroundingText()
\r
167 const std::string& GetSurroundingText() const override;
\r
170 * @copydoc Dali::InputMethodContext::NotifyTextInputMultiLine()
\r
172 void NotifyTextInputMultiLine( bool multiLine ) override;
\r
175 * @copydoc Dali::InputMethodContext::GetTextDirection()
\r
177 Dali::InputMethodContext::TextDirection GetTextDirection() override;
\r
180 * @copydoc Dali::InputMethodContext::GetInputMethodArea()
\r
182 Dali::Rect<int> GetInputMethodArea() override;
\r
185 * @copydoc Dali::InputMethodContext::ApplyOptions()
\r
187 void ApplyOptions( const InputMethodOptions& options ) override;
\r
190 * @copydoc Dali::InputMethodContext::SetInputPanelData()
\r
192 void SetInputPanelData( const std::string& data ) override;
\r
195 * @copydoc Dali::InputMethodContext::GetInputPanelData()
\r
197 void GetInputPanelData( std::string& data ) override;
\r
200 * @copydoc Dali::InputMethodContext::GetInputPanelState()
\r
202 Dali::InputMethodContext::State GetInputPanelState() override;
\r
205 * @copydoc Dali::InputMethodContext::SetReturnKeyState()
\r
207 void SetReturnKeyState( bool visible ) override;
\r
210 * @copydoc Dali::InputMethodContext::AutoEnableInputPanel()
\r
212 void AutoEnableInputPanel( bool enabled ) override;
\r
215 * @copydoc Dali::InputMethodContext::ShowInputPanel()
\r
217 void ShowInputPanel() override;
\r
220 * @copydoc Dali::InputMethodContext::HideInputPanel()
\r
222 void HideInputPanel() override;
\r
225 * @copydoc Dali::InputMethodContext::GetKeyboardType()
\r
227 Dali::InputMethodContext::KeyboardType GetKeyboardType() override;
\r
230 * @copydoc Dali::InputMethodContext::GetInputPanelLocale()
\r
232 std::string GetInputPanelLocale() override;
\r
235 * @copydoc Dali::InputMethodContext::SetContentMIMETypes()
\r
237 void SetContentMIMETypes( const std::string& mimeTypes ) override;
\r
240 * @copydoc Dali::InputMethodContext::FilterEventKey()
\r
242 bool FilterEventKey( const Dali::KeyEvent& keyEvent ) override;
\r
245 * @copydoc Dali::InputMethodContext::SetInputPanelLanguage()
\r
247 void SetInputPanelLanguage( Dali::InputMethodContext::InputPanelLanguage language ) override;
\r
250 * @copydoc Dali::InputMethodContext::GetInputPanelLanguage()
\r
252 Dali::InputMethodContext::InputPanelLanguage GetInputPanelLanguage() const override;
\r
255 * @copydoc Dali::InputMethodContext::SetInputPanelPosition()
\r
257 void SetInputPanelPosition( unsigned int x, unsigned int y ) override;
\r
260 * @copydoc Dali::InputMethodContext::GetPreeditStyle()
\r
262 void GetPreeditStyle( Dali::InputMethodContext::PreEditAttributeDataContainer& attrs ) const override;
\r
266 * Context created the first time and kept until deleted.
\r
267 * @param[in] win32Window, The window is created by application.
\r
269 void CreateContext( WinWindowHandle win32Window );
\r
272 * @copydoc Dali::InputMethodContext::DeleteContext()
\r
274 void DeleteContext();
\r
279 * @brief Process event key down, whether filter a key to isf.
\r
281 * @param[in] keyEvent The event key to be handled.
\r
282 * @return Whether the event key is handled.
\r
284 bool ProcessEventKeyDown( const KeyEvent& keyEvent );
\r
287 * @brief Process event key up, whether filter a key to isf.
\r
289 * @param[in] keyEvent The event key to be handled.
\r
290 * @return Whether the event key is handled.
\r
292 bool ProcessEventKeyUp( const KeyEvent& keyEvent );
\r
295 * Called when the binded actor is added to a window.
\r
297 void OnStaged( Dali::Actor actor );
\r
304 virtual ~InputMethodContextWin();
\r
308 // Undefined copy constructor
\r
309 InputMethodContextWin( const InputMethodContextWin& inputMethodContext) = delete;
\r
311 // Undefined assignment operator
\r
312 InputMethodContextWin& operator=( const InputMethodContextWin& inputMethodContext ) = delete;
\r
315 WinWindowHandle mWin32Window;
\r
316 int mIMFCursorPosition;
\r
317 std::string mSurroundingText;
\r
319 bool mRestoreAfterFocusLost:1; ///< Whether the keyboard needs to be restored (activated ) after focus regained.
\r
320 bool mIdleCallbackConnected:1; ///< Whether the idle callback is already connected.
\r
321 InputMethodOptions mOptions;
\r
322 Dali::InputMethodContext::PreEditAttributeDataContainer mPreeditAttrs; ///< Stores preedit attribute data
\r
325 } // namespace Adaptor
\r
327 } // namespace Internal
\r
329 } // namespace Dali
\r
331 #endif // DALI_INTERNAL_INPUT_METHOD_CONTEXT_IMPL_WIN_H
\r