1 #ifndef __DALI_IMF_MANAGER_H__
2 #define __DALI_IMF_MANAGER_H__
5 * Copyright (c) 2015 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/object/base-handle.h>
23 #include <dali/public-api/signals/dali-signal.h>
24 #include "input-method-options.h"
29 namespace Internal DALI_INTERNAL
38 * @brief The ImfManager class
40 * Specifically manages the ecore input method framework which enables the virtual or hardware keyboards.
42 class DALI_IMPORT_API ImfManager : public BaseHandle
47 * @brief The direction of text.
56 * @brief Events that are generated by the IMF.
61 PREEDIT, ///< Pre-Edit changed
62 COMMIT, ///< Commit recieved
63 DELETESURROUNDING, ///< Event to delete a range of characters from the string
64 GETSURROUNDING ///< Event to query string and cursor position
68 * @brief This structure is used to pass on data from the IMF regarding predictive text.
73 * @brief Default Constructor.
86 * @param[in] aEventName The name of the event from the IMF.
87 * @param[in] aPredictiveString The pre-edit or commit string.
88 * @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
89 * @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
91 ImfEventData( ImfEvent aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
92 : predictiveString( aPredictiveString ),
93 eventName( aEventName ),
94 cursorOffset( aCursorOffset ),
95 numberOfChars( aNumberOfChars )
100 std::string predictiveString; ///< The pre-edit or commit string.
101 ImfEvent eventName; ///< The name of the event from the IMF.
102 int cursorOffset; ///< Start position from the current cursor position to start deleting characters.
103 int numberOfChars; ///< number of characters to delete from the cursorOffset.
107 * @brief Data required by IMF from the callback
109 struct ImfCallbackData
118 preeditResetRequired( false )
124 * @param[in] aUpdate True if cursor position needs to be updated
125 * @param[in] aCursorPosition new position of cursor
126 * @param[in] aCurrentText current text string
127 * @param[in] aPreeditResetRequired flag if preedit reset is required.
129 ImfCallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
130 : currentText( aCurrentText ),
131 cursorPosition( aCursorPosition ),
133 preeditResetRequired( aPreeditResetRequired )
137 std::string currentText; ///< current text string
138 int cursorPosition; ///< new position of cursor
139 bool update :1; ///< if cursor position needs to be updated
140 bool preeditResetRequired :1; ///< flag if preedit reset is required.
143 typedef Signal< void (ImfManager&) > ImfManagerSignalType; ///< Keyboard actived signal
144 typedef Signal< ImfCallbackData ( ImfManager&, const ImfEventData& ) > ImfEventSignalType; ///< keyboard events
145 typedef Signal< void () > VoidSignalType;
146 typedef Signal< void (bool) > StatusSignalType;
151 * @brief Retrieve a handle to the instance of ImfManager.
152 * @return A handle to the ImfManager.
154 static ImfManager Get();
157 * @brief Activate the IMF.
159 * It means that the text editing is started at somewhere.
160 * If the H/W keyboard isn't connected then it will show the virtual keyboard.
165 * @brief Deactivate the IMF.
167 * It means that the text editing is finished at somewhere.
172 * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
174 * If true then keyboard will be restored (activated) after focus is regained.
175 * @return restoration status.
177 bool RestoreAfterFocusLost() const;
180 * @brief Set status whether the IMF has to restore the keyboard after losing focus.
182 * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
184 void SetRestoreAfterFocusLost( bool toggle );
187 * @brief Send message reset the pred-edit state / imf module.
189 * Used to interupt pre-edit state maybe due to a touch input.
194 * @brief Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation.
196 void NotifyCursorPosition();
199 * @brief Sets cursor position stored in VirtualKeyboard, this is required by the IMF context.
201 * @param[in] cursorPosition position of cursor
203 void SetCursorPosition( unsigned int cursorPosition );
206 * @brief Gets cursor position stored in VirtualKeyboard, this is required by the IMF context.
208 * @return current position of cursor
210 unsigned int GetCursorPosition() const;
213 * @brief Method to store the string required by the IMF, this is used to provide predictive word suggestions.
215 * @param[in] text The text string surrounding the current cursor point.
217 void SetSurroundingText( const std::string& text );
220 * @brief Gets current text string set within the IMF manager, this is used to offer predictive suggestions.
222 * @return current position of cursor
224 const std::string& GetSurroundingText() const;
227 * @brief Notifies IMF context that text input is set to multi line or not
229 * @param[in] multiLine True if multiline text input is used
231 void NotifyTextInputMultiLine( bool multiLine );
234 * @brief Returns text direction of the keyboard's current input language.
235 * @return The direction of the text.
237 TextDirection GetTextDirection();
240 * @brief Provides size and position of keyboard.
242 * Position is relative to whether keyboard is visible or not.
243 * If keyboard is not visible then position will be off the screen.
244 * If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get
245 * the values then taken down. So ideally GetInputMethodArea() should be called after Show().
246 * @return rect which is keyboard panel x, y, width, height
248 Dali::Rect<int> GetInputMethodArea();
251 * @brief Set one or more of the Input Method options
252 * @param[in] options The options to be applied
254 void ApplyOptions( const InputMethodOptions& options );
262 * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
264 * @return The IMF Activated signal.
266 ImfManagerSignalType& ActivatedSignal();
269 * @brief This is emitted when the IMF manager receives an event from the IMF.
271 * @return The Event signal containing the event data.
273 ImfEventSignalType& EventReceivedSignal();
276 * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
278 * A callback of the following type may be connected:
280 * void YourCallbackName(bool keyboardShown);
282 * If the parameter keyboardShown is true, then the keyboard has just shown, if it is false, then it
283 * has just been hidden.
284 * @return The signal to connect to.
286 StatusSignalType& StatusChangedSignal();
289 * @brief Connect to this signal to be notified when the virtual keyboard is resized.
291 * A callback of the following type may be connected:
293 * void YourCallbackName();
295 * User can get changed size by using GetInputMethodArea() in the callback
296 * @return The signal to connect to.
298 VoidSignalType& ResizedSignal();
301 * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
303 * A callback of the following type may be connected:
305 * void YourCallbackName();
307 * User can get the text direction of the language by calling GetTextDirection() in the callback.
308 * @return The signal to connect to.
310 VoidSignalType& LanguageChangedSignal();
312 // Construction & Destruction
315 * @brief Constructor.
322 * This is non-virtual since derived Handle types must not contain data or virtual methods.
327 * @brief This constructor is used by ImfManager::Get().
329 * @param[in] imfManager A pointer to the imf Manager.
331 explicit DALI_INTERNAL ImfManager( Internal::Adaptor::ImfManager* imfManager );
336 #endif // __DALI_IMF_MANAGER_H__