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>
23 #include <dali/public-api/common/dali-vector.h>
26 #include <dali/public-api/object/base-handle.h>
27 #include <dali/public-api/signals/dali-signal.h>
28 #include <dali/devel-api/adaptor-framework/input-method-options.h>
33 namespace Internal DALI_INTERNAL
37 class InputMethodContext;
44 * @brief The InputMethodContext class
46 * Specifically manages the ecore input method framework which enables the virtual or hardware keyboards.
48 class DALI_ADAPTOR_API InputMethodContext : public BaseHandle
53 * @brief The direction of text.
62 * @brief Events that are generated by the InputMethodContext.
67 PRE_EDIT, ///< Pre-Edit changed
68 COMMIT, ///< Commit recieved
69 DELETE_SURROUNDING, ///< Event to delete a range of characters from the string
70 GET_SURROUNDING, ///< Event to query string and cursor position
71 PRIVATE_COMMAND ///< Private command sent from the input panel
75 * @brief Enumeration for state of the input panel.
79 DEFAULT = 0, ///< Unknown state
80 SHOW, ///< Input panel is shown
81 HIDE, ///< Input panel is hidden
82 WILL_SHOW ///< Input panel in process of being shown
86 * @brief Enumeration for the type of Keyboard.
90 SOFTWARE_KEYBOARD, ///< Software keyboard (Virtual keyboard) is default
91 HARDWARE_KEYBOARD ///< Hardware keyboard
95 * @brief Enumeration for the language mode of the input panel.
97 enum class InputPanelLanguage
99 AUTOMATIC, ///< IME Language automatically set depending on the system display
100 ALPHABET ///< Latin alphabet at all times
104 * @brief Enumeration for the preedit style types.
106 enum class PreeditStyle
108 NONE, ///< None style
109 UNDERLINE, ///< Underline substring style
110 REVERSE, ///< Reverse substring style
111 HIGHLIGHT, ///< Highlight substring style
112 CUSTOM_PLATFORM_STYLE_1, ///< Custom style for platform
113 CUSTOM_PLATFORM_STYLE_2, ///< Custom style for platform
114 CUSTOM_PLATFORM_STYLE_3, ///< Custom style for platform
115 CUSTOM_PLATFORM_STYLE_4 ///< Custom style for platform
119 * @brief This structure is for the preedit style types and indices.
121 struct PreeditAttributeData
123 PreeditStyle preeditType; /// The preedit style type
124 unsigned int startIndex; /// The start index of preedit
125 unsigned int endIndex; /// The end index of preedit
129 * @brief This structure is used to pass on data from the InputMethodContext regarding predictive text.
134 * @brief Default Constructor.
137 : predictiveString(),
147 * @param[in] aEventName The name of the event from the InputMethodContext.
148 * @param[in] aPredictiveString The pre-edit or commit string.
149 * @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
150 * @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
152 EventData( EventType aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
153 : predictiveString( aPredictiveString ),
154 eventName( aEventName ),
155 cursorOffset( aCursorOffset ),
156 numberOfChars( aNumberOfChars )
161 std::string predictiveString; ///< The pre-edit or commit string.
162 EventType eventName; ///< The name of the event from the InputMethodContext.
163 int cursorOffset; ///< Start position from the current cursor position to start deleting characters.
164 int numberOfChars; ///< number of characters to delete from the cursorOffset.
168 * @brief Data required by InputMethodContext from the callback
179 preeditResetRequired( false )
185 * @param[in] aUpdate True if cursor position needs to be updated
186 * @param[in] aCursorPosition new position of cursor
187 * @param[in] aCurrentText current text string
188 * @param[in] aPreeditResetRequired flag if preedit reset is required.
190 CallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
191 : currentText( aCurrentText ),
192 cursorPosition( aCursorPosition ),
194 preeditResetRequired( aPreeditResetRequired )
198 std::string currentText; ///< current text string
199 int cursorPosition; ///< new position of cursor
200 bool update :1; ///< if cursor position needs to be updated
201 bool preeditResetRequired :1; ///< flag if preedit reset is required.
204 typedef Signal< void (InputMethodContext&) > ActivatedSignalType; ///< Keyboard actived signal
205 typedef Signal< CallbackData ( InputMethodContext&, const EventData& ) > KeyboardEventSignalType; ///< keyboard events
206 typedef Signal< void () > VoidSignalType;
207 typedef Signal< void ( bool ) > StatusSignalType;
208 typedef Signal< void ( KeyboardType ) > KeyboardTypeSignalType; ///< keyboard type
209 typedef Signal< void ( int ) > KeyboardResizedSignalType; ///< Keyboard resized signal
210 typedef Signal< void ( int ) > LanguageChangedSignalType; ///< Language changed signal
211 typedef Signal< void ( const std::string&, const std::string&, const std::string& ) > ContentReceivedSignalType; ///< Content received signal
216 * @brief Retrieve a handle to the instance of InputMethodContext.
217 * @return A handle to the InputMethodContext.
218 * @brief Constructor.
220 InputMethodContext();
225 * This is non-virtual since derived Handle types must not contain data or virtual methods.
227 ~InputMethodContext();
230 * @brief Create a new instance of an InputMethodContext.
232 static InputMethodContext New();
235 * @brief Create a new instance of an InputMethodContext.
237 * @param[in] actor The actor that uses the new InputMethodContext instance.
239 static InputMethodContext New( Actor actor );
242 * @brief Copy constructor.
244 * @param[in] inputMethodContext InputMethodContext to copy. The copied inputMethodContext will point at the same implementation.
246 InputMethodContext( const InputMethodContext& inputMethodContext );
249 * @brief Assignment operator.
251 * @param[in] inputMethodContext The InputMethodContext to assign from.
252 * @return The updated InputMethodContext.
254 InputMethodContext& operator=( const InputMethodContext& inputMethodContext );
257 * @brief Downcast a handle to InputMethodContext handle.
259 * If handle points to an InputMethodContext the downcast produces valid
260 * handle. If not the returned handle is left uninitialized.
262 * @param[in] handle Handle to an object.
263 * @return Handle to an InputMethodContext or an uninitialized handle.
265 static InputMethodContext DownCast( BaseHandle handle );
270 * @brief Finalize the InputMethodContext.
272 * It means that the context will be deleted.
277 * @brief Activate the InputMethodContext.
279 * It means that the text editing is started at somewhere.
280 * If the H/W keyboard isn't connected then it will show the virtual keyboard.
285 * @brief Deactivate the InputMethodContext.
287 * It means that the text editing is finished at somewhere.
292 * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
294 * If true then keyboard will be restored (activated) after focus is regained.
295 * @return restoration status.
297 bool RestoreAfterFocusLost() const;
300 * @brief Set status whether the InputMethodContext has to restore the keyboard after losing focus.
302 * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
304 void SetRestoreAfterFocusLost( bool toggle );
307 * @brief Send message reset the pred-edit state / InputMethodContext module.
309 * Used to interupt pre-edit state maybe due to a touch input.
314 * @brief Notifies InputMethodContext that the cursor position has changed, required for features like auto-capitalisation.
316 void NotifyCursorPosition();
319 * @brief Sets cursor position stored in VirtualKeyboard, this is required by the InputMethodContext.
321 * @param[in] cursorPosition position of cursor
323 void SetCursorPosition( unsigned int cursorPosition );
326 * @brief Gets cursor position stored in VirtualKeyboard, this is required by the InputMethodContext.
328 * @return current position of cursor
330 unsigned int GetCursorPosition() const;
333 * @brief Method to store the string required by the InputMethodContext, this is used to provide predictive word suggestions.
335 * @param[in] text The text string surrounding the current cursor point.
337 void SetSurroundingText( const std::string& text );
340 * @brief Gets current text string set within the InputMethodContext manager, this is used to offer predictive suggestions.
342 * @return current position of cursor
344 const std::string& GetSurroundingText() const;
347 * @brief Notifies InputMethodContext that text input is set to multi line or not
349 * @param[in] multiLine True if multiline text input is used
351 void NotifyTextInputMultiLine( bool multiLine );
354 * @brief Returns text direction of the keyboard's current input language.
355 * @return The direction of the text.
357 TextDirection GetTextDirection();
360 * @brief Provides size and position of keyboard.
362 * Position is relative to whether keyboard is visible or not.
363 * If keyboard is not visible then position will be off the screen.
364 * If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get
365 * the values then taken down. So ideally GetInputMethodArea() should be called after Show().
366 * @return rect which is keyboard panel x, y, width, height
368 Dali::Rect<int> GetInputMethodArea();
371 * @brief Set one or more of the Input Method options
372 * @param[in] options The options to be applied
374 void ApplyOptions( const InputMethodOptions& options );
377 * @brief Sets up the input-panel specific data.
378 * @param[in] data The specific data to be set to the input panel
380 void SetInputPanelData( const std::string& data );
383 * @brief Gets the specific data of the current active input panel.
385 * Input Panel Data is not always the data which is set by SetInputPanelData().
386 * Data can be changed internally in the input panel.
387 * It is just used to get a specific data from the input panel to an application.
388 * @param[in] data The specific data to be got from the input panel
390 void GetInputPanelData( std::string& data );
393 * @brief Gets the state of the current active input panel.
394 * @return The state of the input panel.
396 State GetInputPanelState();
399 * @brief Sets the return key on the input panel to be visible or invisible.
401 * The default is true.
402 * @param[in] visible True if the return key is visible(enabled), false otherwise.
404 void SetReturnKeyState( bool visible );
407 * @brief Enable to show the input panel automatically when focused.
408 * @param[in] enabled If true, the input panel will be shown when focused
410 void AutoEnableInputPanel( bool enabled );
413 * @brief Shows the input panel.
415 void ShowInputPanel();
418 * @brief Hides the input panel.
420 void HideInputPanel();
423 * @brief Gets the keyboard type.
425 * The default keyboard type is SOFTWARE_KEYBOARD.
426 * @return The keyboard type
428 KeyboardType GetKeyboardType();
431 * @brief Gets the current language locale of the input panel.
433 * ex) en_US, en_GB, en_PH, fr_FR, ...
434 * @return The current language locale of the input panel
436 std::string GetInputPanelLocale();
439 * @brief Sets the allowed MIME Types to deliver to the input panel.
441 * ex) std::string mimeTypes = "text/plain,image/png,image/gif,application/pdf";
443 * You can receive a media content URI and its MIME type from ContentReceivedSignal(). @see ContentReceivedSignal
444 * @param[in] mimeTypes The allowed MIME types
446 void SetContentMIMETypes( const std::string& mimeTypes );
449 * @brief Process event key down or up, whether filter a key to isf.
451 * @param[in] keyEvent The event key to be handled.
452 * @return Whether the event key is handled.
454 bool FilterEventKey( const Dali::KeyEvent& keyEvent );
457 * @brief Sets whether the IM context should allow to use the text prediction.
459 * @param[in] prediction Whether to allow text prediction or not.
461 void AllowTextPrediction( bool prediction );
464 * @brief Gets whether the IM context allow to use the text prediction.
466 * @return Whether the IM allow text prediction or not.
468 bool IsTextPredictionAllowed() const;
471 * @brief Sets the language of the input panel.
473 * This method can be used when you want to show the English keyboard.
474 * @param[in] language The language to be set to the input panel
476 void SetInputPanelLanguage( InputPanelLanguage language );
479 * @brief Gets the language of the input panel.
481 * @return The language of the input panel
483 InputPanelLanguage GetInputPanelLanguage() const;
486 * @brief Sets the x,y coordinates of the input panel.
488 * @param[in] x The top-left x coordinate of the input panel
489 * @param[in] y The top-left y coordinate of the input panel
491 void SetInputPanelPosition( unsigned int x, unsigned int y );
494 * @brief Gets the preedit attrs data.
496 * @param[out] attrs The preedit attrs data.
498 void GetPreeditStyle( Vector<PreeditAttributeData>& attrs ) const;
505 * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
507 * @return The InputMethodContext Activated signal.
509 ActivatedSignalType& ActivatedSignal();
512 * @brief This is emitted when the InputMethodContext manager receives an event from the InputMethodContext.
514 * @return The Event signal containing the event data.
516 KeyboardEventSignalType& EventReceivedSignal();
519 * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
521 * A callback of the following type may be connected:
523 * void YourCallbackName(bool keyboardShown);
525 * If the parameter keyboardShown is true, then the keyboard has just shown, if it is false, then it
526 * has just been hidden.
527 * @return The signal to connect to.
529 StatusSignalType& StatusChangedSignal();
532 * @brief Connect to this signal to be notified when the virtual keyboard is resized.
534 * A callback of the following type may be connected:
536 * void YourCallbackName( int resolvedResize );
538 * The parameter sends the resolved resize defined by the InputMethodContext.
540 * User can get changed size by using GetInputMethodArea() in the callback
541 * @return The signal to connect to.
543 KeyboardResizedSignalType& ResizedSignal();
546 * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
548 * A callback of the following type may be connected:
550 * void YourCallbackName( int resolvedLanguage );
552 * The parameter sends the resolved language defined by the InputMethodContext.
554 * User can get the text direction of the language by calling GetTextDirection() in the callback.
555 * @return The signal to connect to.
557 LanguageChangedSignalType& LanguageChangedSignal();
560 * @brief Connect to this signal to be notified when the keyboard type is changed.
562 * A callback of the following type may be connected:
564 * void YourCallbackName( KeyboardType keyboard );
567 * @return The signal to connect to.
569 KeyboardTypeSignalType& KeyboardTypeChangedSignal();
572 * @brief Connect to this signal to be notified when the content, such as images, of input method is received.
574 * A callback of the following type may be connected:
576 * void YourCallbackName( const std::string& contentUri, const std::string& description, const std::string& contentMIMEType );
579 * @return The signal to connect to.
581 ContentReceivedSignalType& ContentReceivedSignal();
586 * @brief This constructor is used by InputMethodContext::New().
588 * @param[in] inputMethodContext A pointer to the InputMethodContext.
590 explicit DALI_INTERNAL InputMethodContext( Internal::Adaptor::InputMethodContext* inputMethodContext );
598 #endif // DALI_INPUT_METHOD_CONTEXT_H