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>
26 namespace Dali DALI_IMPORT_API
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 ImfManager : public BaseHandle
47 * @brief Events that are generated by the IMF.
52 PREEDIT, ///< Pre-Edit changed
53 COMMIT, ///< Commit recieved
54 DELETESURROUNDING, ///< Event to delete a range of characters from the string
55 GETSURROUNDING ///< Event to query string and cursor position
59 * @brief This structure is used to pass on data from the IMF regarding predictive text.
64 * @brief Default Constructor.
77 * @param[in] aEventName The name of the event from the IMF.
78 * @param[in] aPredictiveString The pre-edit or commit string.
79 * @param[in] aCursorOffset Start position from the current cursor position to start deleting characters.
80 * @param[in] aNumberOfChars The number of characters to delete from the cursorOffset.
82 ImfEventData( ImfEvent aEventName, const std::string& aPredictiveString, int aCursorOffset, int aNumberOfChars )
83 : predictiveString( aPredictiveString ),
84 eventName( aEventName ),
85 cursorOffset( aCursorOffset ),
86 numberOfChars( aNumberOfChars )
91 std::string predictiveString; ///< The pre-edit or commit string.
92 ImfEvent eventName; ///< The name of the event from the IMF.
93 int cursorOffset; ///< Start position from the current cursor position to start deleting characters.
94 int numberOfChars; ///< number of characters to delete from the cursorOffset.
98 * @brief Data required by IMF from the callback
100 struct ImfCallbackData
109 preeditResetRequired( false )
115 * @param[in] aUpdate True if cursor position needs to be updated
116 * @param[in] aCursorPosition new position of cursor
117 * @param[in] aCurrentText current text string
118 * @param[in] aPreeditResetRequired flag if preedit reset is required.
120 ImfCallbackData( bool aUpdate, int aCursorPosition, const std::string& aCurrentText, bool aPreeditResetRequired )
121 : currentText( aCurrentText ),
122 cursorPosition( aCursorPosition ),
124 preeditResetRequired( aPreeditResetRequired )
128 std::string currentText; ///< current text string
129 int cursorPosition; ///< new position of cursor
130 bool update :1; ///< if cursor position needs to be updated
131 bool preeditResetRequired :1; ///< flag if preedit reset is required.
134 typedef Signal< void (ImfManager&) > ImfManagerSignalType; ///< Keyboard actived signal
135 typedef Signal< ImfCallbackData ( ImfManager&, const ImfEventData& ) > ImfEventSignalType; ///< keyboard events
140 * @brief Retrieve a handle to the instance of ImfManager.
141 * @return A handle to the ImfManager.
143 static ImfManager Get();
146 * @brief Activate the IMF.
148 * It means that the text editing is started at somewhere.
149 * If the H/W keyboard isn't connected then it will show the virtual keyboard.
154 * @brief Deactivate the IMF.
156 * It means that the text editing is finished at somewhere.
161 * @brief Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
163 * If true then keyboard will be restored (activated) after focus is regained.
164 * @return restoration status.
166 bool RestoreAfterFocusLost() const;
169 * @brief Set status whether the IMF has to restore the keyboard after losing focus.
171 * @param[in] toggle True means that keyboard should be restored after focus lost and regained.
173 void SetRestoreAfterFocusLost( bool toggle );
176 * @brief Send message reset the pred-edit state / imf module.
178 * Used to interupt pre-edit state maybe due to a touch input.
183 * @brief Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation.
185 void NotifyCursorPosition();
188 * @brief Sets cursor position stored in VirtualKeyboard, this is required by the IMF context.
190 * @param[in] cursorPosition position of cursor
192 void SetCursorPosition( unsigned int cursorPosition );
195 * @brief Gets cursor position stored in VirtualKeyboard, this is required by the IMF context.
197 * @return current position of cursor
199 unsigned int GetCursorPosition() const;
202 * @brief Method to store the string required by the IMF, this is used to provide predictive word suggestions.
204 * @param[in] text The text string surrounding the current cursor point.
206 void SetSurroundingText( const std::string& text );
209 * @brief Gets current text string set within the IMF manager, this is used to offer predictive suggestions.
211 * @return current position of cursor
213 const std::string& GetSurroundingText() const;
216 * @brief Notifies IMF context that text input is set to multi line or not
218 void NotifyTextInputMultiLine( bool multiLine );
225 * @brief This is emitted when the virtual keyboard is connected to or the hardware keyboard is activated.
227 * @return The IMF Activated signal.
229 ImfManagerSignalType& ActivatedSignal();
232 * @brief This is emitted when the IMF manager receives an event from the IMF.
234 * @return The Event signal containing the event data.
236 ImfEventSignalType& EventReceivedSignal();
238 // Construction & Destruction
241 * @brief Constructor.
248 * This is non-virtual since derived Handle types must not contain data or virtual methods.
253 * @brief This constructor is used by ImfManager::Get().
255 * @param[in] imfManager A pointer to the imf Manager.
257 explicit ImfManager( Internal::Adaptor::ImfManager* imfManager );
262 #endif // __DALI_TOOLKIT_TOOLKIT_IMF_MANAGER_H__