1 #ifndef DALI_INPUT_METHOD_CONTEXT_H
2 #define DALI_INPUT_METHOD_CONTEXT_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/public-api/events/key-event.h>
25 #include <dali/public-api/object/base-handle.h>
26 #include <dali/public-api/signals/dali-signal.h>
27 #include <dali/devel-api/adaptor-framework/input-method-options.h>
32 namespace Internal DALI_INTERNAL
36 class InputMethodContext;
41 * @brief The InputMethodContext class
43 * Specifically manages the ecore input method framework which enables the virtual or hardware keyboards.
45 class DALI_ADAPTOR_API InputMethodContext : public BaseHandle
50 * @brief The direction of text.
59 * @brief Events that are generated by the InputMethodContext.
64 PRE_EDIT, ///< Pre-Edit changed
65 COMMIT, ///< Commit recieved
66 DELETE_SURROUNDING, ///< Event to delete a range of characters from the string
67 GET_SURROUNDING, ///< Event to query string and cursor position
68 PRIVATE_COMMAND ///< Private command sent from the input panel
72 * @brief Enumeration for state of the input panel.
76 DEFAULT = 0, ///< Unknown state
77 SHOW, ///< Input panel is shown
78 HIDE, ///< Input panel is hidden
79 WILL_SHOW ///< Input panel in process of being shown
83 * @brief Enumeration for the type of Keyboard.
87 SOFTWARE_KEYBOARD, ///< Software keyboard (Virtual keyboard) is default
88 HARDWARE_KEYBOARD ///< Hardware keyboard
91 enum class InputPanelLanguage
93 AUTOMATIC, ///< IME Language automatically set depending on the system display
94 ALPHABET ///< Latin alphabet at all times
98 * @brief This structure is used to pass on data from the InputMethodContext regarding predictive text.
103 * @brief Default Constructor.
106 : predictiveString(),
116 * @param[in] aEventName The name of the event from the InputMethodContext.
117 * @param[in] aPredictiveString The pre-edit or commit string.
118 * @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
119 * @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
121 EventData( EventType aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
122 : predictiveString( aPredictiveString ),
123 eventName( aEventName ),
124 cursorOffset( aCursorOffset ),
125 numberOfChars( aNumberOfChars )
130 std::string predictiveString; ///< The pre-edit or commit string.
131 EventType eventName; ///< The name of the event from the InputMethodContext.
132 int cursorOffset; ///< Start position from the current cursor position to start deleting characters.
133 int numberOfChars; ///< number of characters to delete from the cursorOffset.
137 * @brief Data required by InputMethodContext from the callback
148 preeditResetRequired( false )
154 * @param[in] aUpdate True if cursor position needs to be updated
155 * @param[in] aCursorPosition new position of cursor
156 * @param[in] aCurrentText current text string
157 * @param[in] aPreeditResetRequired flag if preedit reset is required.
159 CallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
160 : currentText( aCurrentText ),
161 cursorPosition( aCursorPosition ),
163 preeditResetRequired( aPreeditResetRequired )
167 std::string currentText; ///< current text string
168 int cursorPosition; ///< new position of cursor
169 bool update :1; ///< if cursor position needs to be updated
170 bool preeditResetRequired :1; ///< flag if preedit reset is required.
173 typedef Signal< void (InputMethodContext&) > ActivatedSignalType; ///< Keyboard actived signal
174 typedef Signal< CallbackData ( InputMethodContext&, const EventData& ) > KeyboardEventSignalType; ///< keyboard events
175 typedef Signal< void () > VoidSignalType;
176 typedef Signal< void ( bool ) > StatusSignalType;
177 typedef Signal< void ( KeyboardType ) > KeyboardTypeSignalType; ///< keyboard type
178 typedef Signal< void ( int ) > KeyboardResizedSignalType; ///< Keyboard resized signal
179 typedef Signal< void ( int ) > LanguageChangedSignalType; ///< Language changed signal
184 * @brief Retrieve a handle to the instance of InputMethodContext.
185 * @return A handle to the InputMethodContext.
186 * @brief Constructor.
188 InputMethodContext();
193 * This is non-virtual since derived Handle types must not contain data or virtual methods.
195 ~InputMethodContext();
198 * @brief Create a new instance of an InputMethodContext.
200 static InputMethodContext New();
203 * @brief Copy constructor.
205 * @param[in] inputMethodContext InputMethodContext to copy. The copied inputMethodContext will point at the same implementation.
207 InputMethodContext( const InputMethodContext& inputMethodContext );
210 * @brief Assignment operator.
212 * @param[in] inputMethodContext The InputMethodContext to assign from.
213 * @return The updated InputMethodContext.
215 InputMethodContext& operator=( const InputMethodContext& inputMethodContext );
218 * @brief Downcast a handle to InputMethodContext handle.
220 * If handle points to an InputMethodContext the downcast produces valid
221 * handle. If not the returned handle is left uninitialized.
223 * @param[in] handle Handle to an object.
224 * @return Handle to an InputMethodContext or an uninitialized handle.
226 static InputMethodContext DownCast( BaseHandle handle );
231 * @brief Finalize the InputMethodContext.
233 * It means that the context will be deleted.
238 * @brief Activate the InputMethodContext.
240 * It means that the text editing is started at somewhere.
241 * If the H/W keyboard isn't connected then it will show the virtual keyboard.
246 * @brief Deactivate the InputMethodContext.
248 * It means that the text editing is finished at somewhere.
253 * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
255 * If true then keyboard will be restored (activated) after focus is regained.
256 * @return restoration status.
258 bool RestoreAfterFocusLost() const;
261 * @brief Set status whether the InputMethodContext has to restore the keyboard after losing focus.
263 * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
265 void SetRestoreAfterFocusLost( bool toggle );
268 * @brief Send message reset the pred-edit state / InputMethodContext module.
270 * Used to interupt pre-edit state maybe due to a touch input.
275 * @brief Notifies InputMethodContext that the cursor position has changed, required for features like auto-capitalisation.
277 void NotifyCursorPosition();
280 * @brief Sets cursor position stored in VirtualKeyboard, this is required by the InputMethodContext.
282 * @param[in] cursorPosition position of cursor
284 void SetCursorPosition( unsigned int cursorPosition );
287 * @brief Gets cursor position stored in VirtualKeyboard, this is required by the InputMethodContext.
289 * @return current position of cursor
291 unsigned int GetCursorPosition() const;
294 * @brief Method to store the string required by the InputMethodContext, this is used to provide predictive word suggestions.
296 * @param[in] text The text string surrounding the current cursor point.
298 void SetSurroundingText( const std::string& text );
301 * @brief Gets current text string set within the InputMethodContext manager, this is used to offer predictive suggestions.
303 * @return current position of cursor
305 const std::string& GetSurroundingText() const;
308 * @brief Notifies InputMethodContext that text input is set to multi line or not
310 * @param[in] multiLine True if multiline text input is used
312 void NotifyTextInputMultiLine( bool multiLine );
315 * @brief Returns text direction of the keyboard's current input language.
316 * @return The direction of the text.
318 TextDirection GetTextDirection();
321 * @brief Provides size and position of keyboard.
323 * Position is relative to whether keyboard is visible or not.
324 * If keyboard is not visible then position will be off the screen.
325 * If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get
326 * the values then taken down. So ideally GetInputMethodArea() should be called after Show().
327 * @return rect which is keyboard panel x, y, width, height
329 Dali::Rect<int> GetInputMethodArea();
332 * @brief Set one or more of the Input Method options
333 * @param[in] options The options to be applied
335 void ApplyOptions( const InputMethodOptions& options );
338 * @brief Sets up the input-panel specific data.
339 * @param[in] data The specific data to be set to the input panel
341 void SetInputPanelData( const std::string& data );
344 * @brief Gets the specific data of the current active input panel.
346 * Input Panel Data is not always the data which is set by SetInputPanelData().
347 * Data can be changed internally in the input panel.
348 * It is just used to get a specific data from the input panel to an application.
349 * @param[in] data The specific data to be got from the input panel
351 void GetInputPanelData( std::string& data );
354 * @brief Gets the state of the current active input panel.
355 * @return The state of the input panel.
357 State GetInputPanelState();
360 * @brief Sets the return key on the input panel to be visible or invisible.
362 * The default is true.
363 * @param[in] visible True if the return key is visible(enabled), false otherwise.
365 void SetReturnKeyState( bool visible );
368 * @brief Enable to show the input panel automatically when focused.
369 * @param[in] enabled If true, the input panel will be shown when focused
371 void AutoEnableInputPanel( bool enabled );
374 * @brief Shows the input panel.
376 void ShowInputPanel();
379 * @brief Hides the input panel.
381 void HideInputPanel();
384 * @brief Gets the keyboard type.
386 * The default keyboard type is SOFTWARE_KEYBOARD.
387 * @return The keyboard type
389 KeyboardType GetKeyboardType();
392 * @brief Gets the current language locale of the input panel.
394 * ex) en_US, en_GB, en_PH, fr_FR, ...
395 * @return The current language locale of the input panel
397 std::string GetInputPanelLocale();
400 * @brief Process event key down or up, whether filter a key to isf.
402 * @param[in] keyEvent The event key to be handled.
403 * @return Whether the event key is handled.
405 bool FilterEventKey( const Dali::KeyEvent& keyEvent );
408 * @brief Sets whether the IM context should allow to use the text prediction.
410 * @param[in] prediction Whether to allow text prediction or not.
412 void AllowTextPrediction( bool prediction );
415 * @brief Gets whether the IM context allow to use the text prediction.
417 * @return Whether the IM allow text prediction or not.
419 bool IsTextPredictionAllowed() const;
422 * @brief Sets the language of the input panel.
424 * This method can be used when you want to show the English keyboard.
425 * @param[in] language The language to be set to the input panel
427 void SetInputPanelLanguage( InputPanelLanguage language );
430 * @brief Gets the language of the input panel.
432 * @return The language of the input panel
434 InputPanelLanguage GetInputPanelLanguage() const;
441 * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
443 * @return The InputMethodContext Activated signal.
445 ActivatedSignalType& ActivatedSignal();
448 * @brief This is emitted when the InputMethodContext manager receives an event from the InputMethodContext.
450 * @return The Event signal containing the event data.
452 KeyboardEventSignalType& EventReceivedSignal();
455 * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
457 * A callback of the following type may be connected:
459 * void YourCallbackName(bool keyboardShown);
461 * If the parameter keyboardShown is true, then the keyboard has just shown, if it is false, then it
462 * has just been hidden.
463 * @return The signal to connect to.
465 StatusSignalType& StatusChangedSignal();
468 * @brief Connect to this signal to be notified when the virtual keyboard is resized.
470 * A callback of the following type may be connected:
472 * void YourCallbackName( int resolvedResize );
474 * The parameter sends the resolved resize defined by the InputMethodContext.
476 * User can get changed size by using GetInputMethodArea() in the callback
477 * @return The signal to connect to.
479 KeyboardResizedSignalType& ResizedSignal();
482 * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
484 * A callback of the following type may be connected:
486 * void YourCallbackName( int resolvedLanguage );
488 * The parameter sends the resolved language defined by the InputMethodContext.
490 * User can get the text direction of the language by calling GetTextDirection() in the callback.
491 * @return The signal to connect to.
493 LanguageChangedSignalType& LanguageChangedSignal();
496 * @brief Connect to this signal to be notified when the keyboard type is changed.
498 * A callback of the following type may be connected:
500 * void YourCallbackName( KeyboardType keyboard );
503 * @return The signal to connect to.
505 KeyboardTypeSignalType& KeyboardTypeChangedSignal();
510 * @brief This constructor is used by InputMethodContext::New().
512 * @param[in] inputMethodContext A pointer to the InputMethodContext.
514 explicit DALI_INTERNAL InputMethodContext( Internal::Adaptor::InputMethodContext* inputMethodContext );
522 #endif // DALI_INPUT_METHOD_CONTEXT_H