1 #ifndef __DALI_INPUT_METHOD_CONTEXT_H__
2 #define __DALI_INPUT_METHOD_CONTEXT_H__
5 * Copyright (c) 2018 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
92 * @brief This structure is used to pass on data from the InputMethodContext regarding predictive text.
97 * @brief Default Constructor.
100 : predictiveString(),
110 * @param[in] aEventName The name of the event from the InputMethodContext.
111 * @param[in] aPredictiveString The pre-edit or commit string.
112 * @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
113 * @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
115 EventData( EventType aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
116 : predictiveString( aPredictiveString ),
117 eventName( aEventName ),
118 cursorOffset( aCursorOffset ),
119 numberOfChars( aNumberOfChars )
124 std::string predictiveString; ///< The pre-edit or commit string.
125 EventType eventName; ///< The name of the event from the InputMethodContext.
126 int cursorOffset; ///< Start position from the current cursor position to start deleting characters.
127 int numberOfChars; ///< number of characters to delete from the cursorOffset.
131 * @brief Data required by InputMethodContext from the callback
142 preeditResetRequired( false )
148 * @param[in] aUpdate True if cursor position needs to be updated
149 * @param[in] aCursorPosition new position of cursor
150 * @param[in] aCurrentText current text string
151 * @param[in] aPreeditResetRequired flag if preedit reset is required.
153 CallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
154 : currentText( aCurrentText ),
155 cursorPosition( aCursorPosition ),
157 preeditResetRequired( aPreeditResetRequired )
161 std::string currentText; ///< current text string
162 int cursorPosition; ///< new position of cursor
163 bool update :1; ///< if cursor position needs to be updated
164 bool preeditResetRequired :1; ///< flag if preedit reset is required.
167 typedef Signal< void (InputMethodContext&) > ActivatedSignalType; ///< Keyboard actived signal
168 typedef Signal< CallbackData ( InputMethodContext&, const EventData& ) > KeyboardEventSignalType; ///< keyboard events
169 typedef Signal< void () > VoidSignalType;
170 typedef Signal< void ( bool ) > StatusSignalType;
171 typedef Signal< void ( KeyboardType ) > KeyboardTypeSignalType; ///< keyboard type
172 typedef Signal< void ( int ) > KeyboardResizedSignalType; ///< Keyboard resized signal
173 typedef Signal< void ( int ) > LanguageChangedSignalType; ///< Language changed signal
178 * @brief Retrieve a handle to the instance of InputMethodContext.
179 * @return A handle to the InputMethodContext.
180 * @brief Constructor.
182 InputMethodContext();
187 * This is non-virtual since derived Handle types must not contain data or virtual methods.
189 ~InputMethodContext();
192 * @brief Create a new instance of an InputMethodContext.
194 static InputMethodContext New();
197 * @brief Copy constructor.
199 * @param[in] inputMethodContext InputMethodContext to copy. The copied inputMethodContext will point at the same implementation.
201 InputMethodContext( const InputMethodContext& inputMethodContext );
204 * @brief Assignment operator.
206 * @param[in] inputMethodContext The InputMethodContext to assign from.
207 * @return The updated InputMethodContext.
209 InputMethodContext& operator=( const InputMethodContext& inputMethodContext );
212 * @brief Downcast a handle to InputMethodContext handle.
214 * If handle points to an InputMethodContext the downcast produces valid
215 * handle. If not the returned handle is left uninitialized.
217 * @param[in] handle Handle to an object.
218 * @return Handle to an InputMethodContext or an uninitialized handle.
220 static InputMethodContext DownCast( BaseHandle handle );
225 * @brief Finalize the InputMethodContext.
227 * It means that the context will be deleted.
232 * @brief Activate the InputMethodContext.
234 * It means that the text editing is started at somewhere.
235 * If the H/W keyboard isn't connected then it will show the virtual keyboard.
240 * @brief Deactivate the InputMethodContext.
242 * It means that the text editing is finished at somewhere.
247 * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
249 * If true then keyboard will be restored (activated) after focus is regained.
250 * @return restoration status.
252 bool RestoreAfterFocusLost() const;
255 * @brief Set status whether the InputMethodContext has to restore the keyboard after losing focus.
257 * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
259 void SetRestoreAfterFocusLost( bool toggle );
262 * @brief Send message reset the pred-edit state / InputMethodContext module.
264 * Used to interupt pre-edit state maybe due to a touch input.
269 * @brief Notifies InputMethodContext that the cursor position has changed, required for features like auto-capitalisation.
271 void NotifyCursorPosition();
274 * @brief Sets cursor position stored in VirtualKeyboard, this is required by the InputMethodContext.
276 * @param[in] cursorPosition position of cursor
278 void SetCursorPosition( unsigned int cursorPosition );
281 * @brief Gets cursor position stored in VirtualKeyboard, this is required by the InputMethodContext.
283 * @return current position of cursor
285 unsigned int GetCursorPosition() const;
288 * @brief Method to store the string required by the InputMethodContext, this is used to provide predictive word suggestions.
290 * @param[in] text The text string surrounding the current cursor point.
292 void SetSurroundingText( const std::string& text );
295 * @brief Gets current text string set within the InputMethodContext manager, this is used to offer predictive suggestions.
297 * @return current position of cursor
299 const std::string& GetSurroundingText() const;
302 * @brief Notifies InputMethodContext that text input is set to multi line or not
304 * @param[in] multiLine True if multiline text input is used
306 void NotifyTextInputMultiLine( bool multiLine );
309 * @brief Returns text direction of the keyboard's current input language.
310 * @return The direction of the text.
312 TextDirection GetTextDirection();
315 * @brief Provides size and position of keyboard.
317 * Position is relative to whether keyboard is visible or not.
318 * If keyboard is not visible then position will be off the screen.
319 * If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get
320 * the values then taken down. So ideally GetInputMethodArea() should be called after Show().
321 * @return rect which is keyboard panel x, y, width, height
323 Dali::Rect<int> GetInputMethodArea();
326 * @brief Set one or more of the Input Method options
327 * @param[in] options The options to be applied
329 void ApplyOptions( const InputMethodOptions& options );
332 * @brief Sets up the input-panel specific data.
333 * @param[in] data The specific data to be set to the input panel
335 void SetInputPanelData( const std::string& data );
338 * @brief Gets the specific data of the current active input panel.
340 * Input Panel Data is not always the data which is set by SetInputPanelData().
341 * Data can be changed internally in the input panel.
342 * It is just used to get a specific data from the input panel to an application.
343 * @param[in] data The specific data to be got from the input panel
345 void GetInputPanelData( std::string& data );
348 * @brief Gets the state of the current active input panel.
349 * @return The state of the input panel.
351 State GetInputPanelState();
354 * @brief Sets the return key on the input panel to be visible or invisible.
356 * The default is true.
357 * @param[in] visible True if the return key is visible(enabled), false otherwise.
359 void SetReturnKeyState( bool visible );
362 * @brief Enable to show the input panel automatically when focused.
363 * @param[in] enabled If true, the input panel will be shown when focused
365 void AutoEnableInputPanel( bool enabled );
368 * @brief Shows the input panel.
370 void ShowInputPanel();
373 * @brief Hides the input panel.
375 void HideInputPanel();
378 * @brief Gets the keyboard type.
380 * The default keyboard type is SOFTWARE_KEYBOARD.
381 * @return The keyboard type
383 KeyboardType GetKeyboardType();
386 * @brief Gets the current language locale of the input panel.
388 * ex) en_US, en_GB, en_PH, fr_FR, ...
389 * @return The current language locale of the input panel
391 std::string GetInputPanelLocale();
394 * @brief Process event key down or up, whether filter a key to isf.
396 * @param[in] keyEvent The event key to be handled.
397 * @return Whether the event key is handled.
399 bool FilterEventKey( const Dali::KeyEvent& keyEvent );
402 * @brief Sets whether the IM context should allow to use the text prediction.
404 * @param[in] prediction Whether to allow text prediction or not.
406 void AllowTextPrediction( bool prediction );
409 * @brief Gets whether the IM context allow to use the text prediction.
411 * @return Whether the IM allow text prediction or not.
413 bool IsTextPredictionAllowed() const;
419 * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
421 * @return The InputMethodContext Activated signal.
423 ActivatedSignalType& ActivatedSignal();
426 * @brief This is emitted when the InputMethodContext manager receives an event from the InputMethodContext.
428 * @return The Event signal containing the event data.
430 KeyboardEventSignalType& EventReceivedSignal();
433 * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
435 * A callback of the following type may be connected:
437 * void YourCallbackName(bool keyboardShown);
439 * If the parameter keyboardShown is true, then the keyboard has just shown, if it is false, then it
440 * has just been hidden.
441 * @return The signal to connect to.
443 StatusSignalType& StatusChangedSignal();
446 * @brief Connect to this signal to be notified when the virtual keyboard is resized.
448 * A callback of the following type may be connected:
450 * void YourCallbackName( int resolvedResize );
452 * The parameter sends the resolved resize defined by the InputMethodContext.
454 * User can get changed size by using GetInputMethodArea() in the callback
455 * @return The signal to connect to.
457 KeyboardResizedSignalType& ResizedSignal();
460 * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
462 * A callback of the following type may be connected:
464 * void YourCallbackName( int resolvedLanguage );
466 * The parameter sends the resolved language defined by the InputMethodContext.
468 * User can get the text direction of the language by calling GetTextDirection() in the callback.
469 * @return The signal to connect to.
471 LanguageChangedSignalType& LanguageChangedSignal();
474 * @brief Connect to this signal to be notified when the keyboard type is changed.
476 * A callback of the following type may be connected:
478 * void YourCallbackName( KeyboardType keyboard );
481 * @return The signal to connect to.
483 KeyboardTypeSignalType& KeyboardTypeChangedSignal();
488 * @brief This constructor is used by InputMethodContext::New().
490 * @param[in] inputMethodContext A pointer to the InputMethodContext.
492 explicit DALI_INTERNAL InputMethodContext( Internal::Adaptor::InputMethodContext* inputMethodContext );
500 #endif // __DALI_INPUT_METHOD_CONTEXT_H__