1 #ifndef __DALI_TOOLKIT_TOOLKIT_IMF_MANAGER_H__
2 #define __DALI_TOOLKIT_TOOLKIT_IMF_MANAGER_H__
5 * Copyright (c) 2014 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_IMF_MANAGER_H__
23 #include <dali/public-api/object/base-handle.h>
24 #include <dali/public-api/signals/dali-signal.h>
25 #include <dali/devel-api/adaptor-framework/input-method-options.h>
27 namespace Dali DALI_IMPORT_API
30 namespace Internal DALI_INTERNAL
39 * @brief The ImfManager class
41 * Specifically manages the ecore input method framework which enables the virtual or hardware keyboards.
43 class ImfManager : public BaseHandle
48 * @brief Events that are generated by the IMF.
53 PREEDIT, ///< Pre-Edit changed
54 COMMIT, ///< Commit recieved
55 DELETESURROUNDING, ///< Event to delete a range of characters from the string
56 GETSURROUNDING, ///< Event to query string and cursor position
57 PRIVATECOMMAND ///< Private command sent from the input panel
61 * @brief This structure is used to pass on data from the IMF regarding predictive text.
66 * @brief Default Constructor.
79 * @param[in] aEventName The name of the event from the IMF.
80 * @param[in] aPredictiveString The pre-edit or commit string.
81 * @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
82 * @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
84 ImfEventData( ImfEvent aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
85 : predictiveString( aPredictiveString ),
86 eventName( aEventName ),
87 cursorOffset( aCursorOffset ),
88 numberOfChars( aNumberOfChars )
93 std::string predictiveString; ///< The pre-edit or commit string.
94 ImfEvent eventName; ///< The name of the event from the IMF.
95 int cursorOffset; ///< Start position from the current cursor position to start deleting characters.
96 int numberOfChars; ///< number of characters to delete from the cursorOffset.
100 * @brief Data required by IMF from the callback
102 struct ImfCallbackData
111 preeditResetRequired( false )
117 * @param[in] aUpdate True if cursor position needs to be updated
118 * @param[in] aCursorPosition new position of cursor
119 * @param[in] aCurrentText current text string
120 * @param[in] aPreeditResetRequired flag if preedit reset is required.
122 ImfCallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
123 : currentText( aCurrentText ),
124 cursorPosition( aCursorPosition ),
126 preeditResetRequired( aPreeditResetRequired )
130 std::string currentText; ///< current text string
131 int cursorPosition; ///< new position of cursor
132 bool update :1; ///< if cursor position needs to be updated
133 bool preeditResetRequired :1; ///< flag if preedit reset is required.
136 typedef Signal< void (ImfManager&) > ImfManagerSignalType; ///< Keyboard actived signal
137 typedef Signal< ImfCallbackData ( ImfManager&, const ImfEventData& ) > ImfEventSignalType; ///< keyboard events
138 typedef Signal< void () > VoidSignalType;
139 typedef Signal< void (bool) > StatusSignalType;
144 * @brief Retrieve a handle to the instance of ImfManager.
145 * @return A handle to the ImfManager.
147 static ImfManager Get();
150 * @brief Activate the IMF.
152 * It means that the text editing is started at somewhere.
153 * If the H/W keyboard isn't connected then it will show the virtual keyboard.
158 * @brief Deactivate the IMF.
160 * It means that the text editing is finished at somewhere.
165 * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
167 * If true then keyboard will be restored (activated) after focus is regained.
168 * @return restoration status.
170 bool RestoreAfterFocusLost() const;
173 * @brief Set status whether the IMF has to restore the keyboard after losing focus.
175 * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
177 void SetRestoreAfterFocusLost( bool toggle );
180 * @brief Send message reset the pred-edit state / imf module.
182 * Used to interupt pre-edit state maybe due to a touch input.
187 * @brief Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation.
189 void NotifyCursorPosition();
192 * @brief Sets cursor position stored in VirtualKeyboard, this is required by the IMF context.
194 * @param[in] cursorPosition position of cursor
196 void SetCursorPosition( unsigned int cursorPosition );
199 * @brief Gets cursor position stored in VirtualKeyboard, this is required by the IMF context.
201 * @return current position of cursor
203 unsigned int GetCursorPosition() const;
206 * @brief Method to store the string required by the IMF, this is used to provide predictive word suggestions.
208 * @param[in] text The text string surrounding the current cursor point.
210 void SetSurroundingText( const std::string& text );
213 * @brief Gets current text string set within the IMF manager, this is used to offer predictive suggestions.
215 * @return current position of cursor
217 const std::string& GetSurroundingText() const;
220 * @brief Notifies IMF context that text input is set to multi line or not
222 void NotifyTextInputMultiLine( bool multiLine );
225 * @brief Set one or more of the Input Method options
226 * @param[in] options The options to be applied
228 void ApplyOptions( const InputMethodOptions& options );
235 * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
237 * @return The IMF Activated signal.
239 ImfManagerSignalType& ActivatedSignal();
242 * @brief This is emitted when the IMF manager receives an event from the IMF.
244 * @return The Event signal containing the event data.
246 ImfEventSignalType& EventReceivedSignal();
249 * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
251 * @return The signal connect to status changed event.
253 StatusSignalType& StatusChangedSignal();
256 * @brief Connect to this signal to be notified when the virtual keyboard is resized.
258 * @return The signal to connect to resized event.
260 VoidSignalType& ResizedSignal();
263 * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
265 * @return The signal to connect to language changed event.
267 VoidSignalType& LanguageChangedSignal();
269 // Construction & Destruction
272 * @brief Constructor.
279 * This is non-virtual since derived Handle types must not contain data or virtual methods.
284 * @brief This constructor is used by ImfManager::Get().
286 * @param[in] imfManager A pointer to the imf Manager.
288 explicit ImfManager( Internal::Adaptor::ImfManager* imfManager );
293 #endif // __DALI_TOOLKIT_TOOLKIT_IMF_MANAGER_H__