1 #ifndef DALI_TOOLKIT_TOOLKIT_INPUT_METHOD_CONTEXT_H
2 #define DALI_TOOLKIT_TOOLKIT_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 #define DALI_INPUT_METHOD_CONTEXT_H
23 #include <dali/public-api/actors/actor.h>
24 #include <dali/public-api/object/base-handle.h>
25 #include <dali/public-api/signals/dali-signal.h>
26 #include <dali/devel-api/adaptor-framework/input-method-options.h>
27 #include <dali/public-api/events/key-event.h>
29 namespace Dali DALI_IMPORT_API
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 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
69 SELECTION_SET ///< input method needs to set the selection
73 * @brief Enumeration for state of the input panel.
77 DEFAULT = 0, ///< Unknown state
78 SHOW, ///< Input panel is shown
79 HIDE, ///< Input panel is hidden
80 WILL_SHOW ///< Input panel in process of being shown
84 * @brief Enumeration for the type of Keyboard.
88 SOFTWARE_KEYBOARD, ///< Software keyboard (Virtual keyboard) is default
89 HARDWARE_KEYBOARD ///< Hardware keyboard
93 * @brief Enumeration for the language mode of the input panel.
95 enum class InputPanelLanguage
97 AUTOMATIC, ///< IME Language automatically set depending on the system display
98 ALPHABET ///< Latin alphabet at all times
102 * @brief Enumeration for the preedit style types.
104 enum class PreeditStyle
106 NONE, ///< None style
107 UNDERLINE, ///< Underline substring style
108 REVERSE, ///< Reverse substring style
109 HIGHLIGHT, ///< Highlight substring style
110 CUSTOM_PLATFORM_STYLE_1, ///< Custom style for platform
111 CUSTOM_PLATFORM_STYLE_2, ///< Custom style for platform
112 CUSTOM_PLATFORM_STYLE_3, ///< Custom style for platform
113 CUSTOM_PLATFORM_STYLE_4 ///< Custom style for platform
117 * @brief This structure is for the preedit style types and indices.
119 struct PreeditAttributeData
121 PreeditAttributeData()
122 : preeditType( PreeditStyle::NONE ),
128 PreeditStyle preeditType; /// The preedit style type
129 unsigned int startIndex; /// The start index of preedit
130 unsigned int endIndex; /// The end index of preedit
134 * @brief This structure is used to pass on data from the InputMethodContext regarding predictive text.
139 * @brief Default Constructor.
142 : predictiveString(),
154 * @param[in] aEventName The name of the event from the input method context.
155 * @param[in] aPredictiveString The pre-edit or commit string.
156 * @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
157 * @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
159 EventData( EventType aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
160 : predictiveString( aPredictiveString ),
161 eventName( aEventName ),
162 cursorOffset( aCursorOffset ),
163 numberOfChars( aNumberOfChars ),
172 * @param[in] aEventName The name of the event from the InputMethodContext.
173 * @param[in] aStartIndex The start index of selection.
174 * @param[in] aEndIndex The end index of selection.
176 EventData(EventType aEventName, int aStartIndex, int aEndIndex)
177 : predictiveString(),
178 eventName(aEventName),
181 startIndex(aStartIndex),
187 std::string predictiveString; ///< The pre-edit or commit string.
188 EventType eventName; ///< The name of the event from the input method context.
189 int cursorOffset; ///< Start position from the current cursor position to start deleting characters.
190 int numberOfChars; ///< number of characters to delete from the cursorOffset.
191 int startIndex; ///< The start index of selection.
192 int endIndex; ///< The end index of selection.
196 * @brief Data required by input method context from the callback
207 preeditResetRequired( false )
213 * @param[in] aUpdate True if cursor position needs to be updated
214 * @param[in] aCursorPosition new position of cursor
215 * @param[in] aCurrentText current text string
216 * @param[in] aPreeditResetRequired flag if preedit reset is required.
218 CallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
219 : currentText( aCurrentText ),
220 cursorPosition( aCursorPosition ),
222 preeditResetRequired( aPreeditResetRequired )
226 std::string currentText; ///< current text string
227 int cursorPosition; ///< new position of cursor
228 bool update :1; ///< if cursor position needs to be updated
229 bool preeditResetRequired :1; ///< flag if preedit reset is required.
232 typedef Signal< void (InputMethodContext&) > ActivatedSignalType; ///< Keyboard actived signal
233 typedef Signal< CallbackData ( InputMethodContext&, const EventData& ) > KeyboardEventSignalType; ///< keyboard events
234 typedef Signal< void () > VoidSignalType;
235 typedef Signal< void (bool) > StatusSignalType;
237 using PreEditAttributeDataContainer = Vector< Dali::InputMethodContext::PreeditAttributeData >;
242 * @brief Create a handle to the instance of InputMethodContext.
243 * @return A handle to the InputMethodContext.
245 static InputMethodContext New();
248 * @brief Create a handle to the instance of InputMethodContext.
250 * @param[in] actor The actor that uses the new InputMethodContext instance.
251 * @return A handle to the InputMethodContext.
253 static InputMethodContext New( Actor actor );
256 * @brief Finalize the InputMethodContext.
258 * It means that the context will be deleted.
263 * @brief Activate the input method context.
265 * It means that the text editing is started at somewhere.
266 * If the H/W keyboard isn't connected then it will show the virtual keyboard.
271 * @brief Deactivate the input method context.
273 * It means that the text editing is finished at somewhere.
278 * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
280 * If true then keyboard will be restored (activated) after focus is regained.
281 * @return restoration status.
283 bool RestoreAfterFocusLost() const;
286 * @brief Set status whether the input method context has to restore the keyboard after losing focus.
288 * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
290 void SetRestoreAfterFocusLost( bool toggle );
293 * @brief Send message reset the pred-edit state / input method context module.
295 * Used to interupt pre-edit state maybe due to a touch input.
300 * @brief Notifies ImfContext that the cursor position has changed, required for features like auto-capitalisation.
302 void NotifyCursorPosition();
305 * @brief Sets cursor position stored in VirtualKeyboard, this is required by the ImfContext.
307 * @param[in] cursorPosition position of cursor
309 void SetCursorPosition( unsigned int cursorPosition );
312 * @brief Gets cursor position stored in VirtualKeyboard, this is required by the ImfContext.
314 * @return current position of cursor
316 unsigned int GetCursorPosition() const;
319 * @brief Method to store the string required by the input method context, this is used to provide predictive word suggestions.
321 * @param[in] text The text string surrounding the current cursor point.
323 void SetSurroundingText( const std::string& text );
326 * @brief Gets current text string set within the input method context, this is used to offer predictive suggestions.
328 * @return current position of cursor
330 const std::string& GetSurroundingText() const;
333 * @brief Notifies ImfContext that text input is set to multi line or not
335 void NotifyTextInputMultiLine( bool multiLine );
338 * @brief Set one or more of the Input Method options
339 * @param[in] options The options to be applied
341 void ApplyOptions( const InputMethodOptions& options );
344 * @brief Process event key down or up, whether filter a key to isf.
346 * @param[in] keyEvent The event key to be handled.
347 * @return Whether the event key is handled.
349 bool FilterEventKey( const Dali::KeyEvent& keyEvent );
352 * @brief Sets the preedit type.
354 * @param[in] type The preedit style type
356 void SetPreeditStyle( PreeditStyle type );
359 * @brief Gets the preedit attributes data.
361 * @param[out] attrs The preedit attributes data.
363 void GetPreeditStyle( Dali::InputMethodContext::PreEditAttributeDataContainer& attrs ) const;
370 * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
372 * @return The input method context Activated signal.
374 ActivatedSignalType& ActivatedSignal();
377 * @brief This is emitted when the input method context receives an event.
379 * @return The Event signal containing the event data.
381 KeyboardEventSignalType& EventReceivedSignal();
384 * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
386 * @return The signal connect to status changed event.
388 StatusSignalType& StatusChangedSignal();
391 * @brief Connect to this signal to be notified when the virtual keyboard is resized.
393 * @return The signal to connect to resized event.
395 VoidSignalType& ResizedSignal();
398 * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
400 * @return The signal to connect to language changed event.
402 VoidSignalType& LanguageChangedSignal();
404 // Construction & Destruction
407 * @brief Constructor.
409 InputMethodContext();
414 * This is non-virtual since derived Handle types must not contain data or virtual methods.
416 ~InputMethodContext();
419 * @brief This constructor is used by InputMethodContext::Get().
421 * @param[in] inputMethodContext A pointer to the input method context.
423 explicit InputMethodContext( Internal::Adaptor::InputMethodContext* inputMethodContext );
428 #endif // DALI_TOOLKIT_TOOLKIT_INPUT_METHOD_CONTEXT_H