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
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 Enumeration for the language mode of the input panel.
94 enum class InputPanelLanguage
96 AUTOMATIC, ///< IME Language automatically set depending on the system display
97 ALPHABET ///< Latin alphabet at all times
101 * @brief Enumeration for the preedit style types.
103 enum class PreeditStyle
105 NONE, ///< None style
106 UNDERLINE, ///< Underline substring style
107 REVERSE, ///< Reverse substring style
108 HIGHLIGHT, ///< Highlight substring style
109 CUSTOM_PLATFORM_STYLE_1, ///< Custom style for platform
110 CUSTOM_PLATFORM_STYLE_2, ///< Custom style for platform
111 CUSTOM_PLATFORM_STYLE_3, ///< Custom style for platform
112 CUSTOM_PLATFORM_STYLE_4 ///< Custom style for platform
116 * @brief This structure is for the preedit style types and indices.
118 struct PreeditAttributeData
120 PreeditAttributeData()
121 : preeditType( PreeditStyle::NONE ),
127 PreeditStyle preeditType; /// The preedit style type
128 unsigned int startIndex; /// The start index of preedit
129 unsigned int endIndex; /// The end index of preedit
133 * @brief This structure is used to pass on data from the InputMethodContext regarding predictive text.
138 * @brief Default Constructor.
141 : predictiveString(),
151 * @param[in] aEventName The name of the event from the input method context.
152 * @param[in] aPredictiveString The pre-edit or commit string.
153 * @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
154 * @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
156 EventData( EventType aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
157 : predictiveString( aPredictiveString ),
158 eventName( aEventName ),
159 cursorOffset( aCursorOffset ),
160 numberOfChars( aNumberOfChars )
165 std::string predictiveString; ///< The pre-edit or commit string.
166 EventType eventName; ///< The name of the event from the input method context.
167 int cursorOffset; ///< Start position from the current cursor position to start deleting characters.
168 int numberOfChars; ///< number of characters to delete from the cursorOffset.
172 * @brief Data required by input method context from the callback
183 preeditResetRequired( false )
189 * @param[in] aUpdate True if cursor position needs to be updated
190 * @param[in] aCursorPosition new position of cursor
191 * @param[in] aCurrentText current text string
192 * @param[in] aPreeditResetRequired flag if preedit reset is required.
194 CallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
195 : currentText( aCurrentText ),
196 cursorPosition( aCursorPosition ),
198 preeditResetRequired( aPreeditResetRequired )
202 std::string currentText; ///< current text string
203 int cursorPosition; ///< new position of cursor
204 bool update :1; ///< if cursor position needs to be updated
205 bool preeditResetRequired :1; ///< flag if preedit reset is required.
208 typedef Signal< void (InputMethodContext&) > ActivatedSignalType; ///< Keyboard actived signal
209 typedef Signal< CallbackData ( InputMethodContext&, const EventData& ) > KeyboardEventSignalType; ///< keyboard events
210 typedef Signal< void () > VoidSignalType;
211 typedef Signal< void (bool) > StatusSignalType;
213 using PreEditAttributeDataContainer = Vector< Dali::InputMethodContext::PreeditAttributeData >;
218 * @brief Create a handle to the instance of InputMethodContext.
219 * @return A handle to the InputMethodContext.
221 static InputMethodContext New();
224 * @brief Create a handle to the instance of InputMethodContext.
226 * @param[in] actor The actor that uses the new InputMethodContext instance.
227 * @return A handle to the InputMethodContext.
229 static InputMethodContext New( Actor actor );
232 * @brief Finalize the InputMethodContext.
234 * It means that the context will be deleted.
239 * @brief Activate the input method context.
241 * It means that the text editing is started at somewhere.
242 * If the H/W keyboard isn't connected then it will show the virtual keyboard.
247 * @brief Deactivate the input method context.
249 * It means that the text editing is finished at somewhere.
254 * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
256 * If true then keyboard will be restored (activated) after focus is regained.
257 * @return restoration status.
259 bool RestoreAfterFocusLost() const;
262 * @brief Set status whether the input method context has to restore the keyboard after losing focus.
264 * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
266 void SetRestoreAfterFocusLost( bool toggle );
269 * @brief Send message reset the pred-edit state / input method context module.
271 * Used to interupt pre-edit state maybe due to a touch input.
276 * @brief Notifies ImfContext that the cursor position has changed, required for features like auto-capitalisation.
278 void NotifyCursorPosition();
281 * @brief Sets cursor position stored in VirtualKeyboard, this is required by the ImfContext.
283 * @param[in] cursorPosition position of cursor
285 void SetCursorPosition( unsigned int cursorPosition );
288 * @brief Gets cursor position stored in VirtualKeyboard, this is required by the ImfContext.
290 * @return current position of cursor
292 unsigned int GetCursorPosition() const;
295 * @brief Method to store the string required by the input method context, this is used to provide predictive word suggestions.
297 * @param[in] text The text string surrounding the current cursor point.
299 void SetSurroundingText( const std::string& text );
302 * @brief Gets current text string set within the input method context, this is used to offer predictive suggestions.
304 * @return current position of cursor
306 const std::string& GetSurroundingText() const;
309 * @brief Notifies ImfContext that text input is set to multi line or not
311 void NotifyTextInputMultiLine( bool multiLine );
314 * @brief Set one or more of the Input Method options
315 * @param[in] options The options to be applied
317 void ApplyOptions( const InputMethodOptions& options );
320 * @brief Process event key down or up, whether filter a key to isf.
322 * @param[in] keyEvent The event key to be handled.
323 * @return Whether the event key is handled.
325 bool FilterEventKey( const Dali::KeyEvent& keyEvent );
328 * @brief Sets the preedit type.
330 * @param[in] type The preedit style type
332 void SetPreeditStyle( PreeditStyle type );
335 * @brief Gets the preedit attributes data.
337 * @param[out] attrs The preedit attributes data.
339 void GetPreeditStyle( Dali::InputMethodContext::PreEditAttributeDataContainer& attrs ) const;
346 * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
348 * @return The input method context Activated signal.
350 ActivatedSignalType& ActivatedSignal();
353 * @brief This is emitted when the input method context receives an event.
355 * @return The Event signal containing the event data.
357 KeyboardEventSignalType& EventReceivedSignal();
360 * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
362 * @return The signal connect to status changed event.
364 StatusSignalType& StatusChangedSignal();
367 * @brief Connect to this signal to be notified when the virtual keyboard is resized.
369 * @return The signal to connect to resized event.
371 VoidSignalType& ResizedSignal();
374 * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
376 * @return The signal to connect to language changed event.
378 VoidSignalType& LanguageChangedSignal();
380 // Construction & Destruction
383 * @brief Constructor.
385 InputMethodContext();
390 * This is non-virtual since derived Handle types must not contain data or virtual methods.
392 ~InputMethodContext();
395 * @brief This constructor is used by InputMethodContext::Get().
397 * @param[in] inputMethodContext A pointer to the input method context.
399 explicit InputMethodContext( Internal::Adaptor::InputMethodContext* inputMethodContext );
404 #endif // DALI_TOOLKIT_TOOLKIT_INPUT_METHOD_CONTEXT_H