1 #ifndef __DALI_VIRTUAL_KEYBOARD_H__
2 #define __DALI_VIRTUAL_KEYBOARD_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/signals/dali-signal.h>
23 #include <dali/public-api/object/property-map.h>
24 #include <dali/public-api/math/rect.h>
27 #ifdef DALI_ADAPTOR_COMPILATION // full path doesn't exist until adaptor is installed so we have to use relative
28 // @todo Make dali-adaptor code folder structure mirror the folder structure installed to dali-env
29 #include "input-method.h"
31 #include <dali/public-api/adaptor-framework/input-method.h>
38 * @brief This namespace is provided for application developers to be able to show and hide the on-screen keyboard.
40 * Key events are sent to the actor in focus. Focus is set through the actor Public API.
42 namespace VirtualKeyboard
47 typedef Signal< void () > VoidSignalType;
48 typedef Signal< void (bool) > StatusSignalType;
53 * @brief The direction of text.
62 * @brief The meaning of the return key.
79 * @brief Show the virtual keyboard.
81 DALI_IMPORT_API void Show();
84 * @brief Hide the virtual keyboard.
86 DALI_IMPORT_API void Hide();
89 * @brief Returns whether the virtual keyboard is visible or not.
90 * @return true if visible, false otherwise.
92 DALI_IMPORT_API bool IsVisible();
95 * @brief Set one or more of the Input Method Settings
96 * @param[in] settingsMap Map of Settings to be applied.
98 DALI_IMPORT_API void ApplySettings( const Property::Map& settingsMap );
101 * @brief Set the specific return key into the virtual keyboard.
102 * @param[in] type the kind of return key types.
104 DALI_IMPORT_API void SetReturnKeyType( const InputMethod::ActionButton type );
107 * @brief Retrieve the current return key type.
108 * @return the type of retun key.
110 DALI_IMPORT_API InputMethod::ActionButton GetReturnKeyType();
113 * @brief Enable/disable prediction (predictive text).
115 * By default prediction text is enabled.
116 * @param[in] enable true or false to enable or disable
117 * Prediction can not be changed while the keyboard is visible. It must be set in advance of showing keyboard.
119 DALI_IMPORT_API void EnablePrediction(const bool enable);
122 * @brief Returns whether prediction is enabled in the virtual keyboard
123 * @return true if predictive text enabled, false otherwise.
125 DALI_IMPORT_API bool IsPredictionEnabled();
128 * @brief Provides size and position of keyboard.
130 * Position is relative to whether keyboard is visible or not.
131 * If keyboard is not visible then position will be off the screen.
132 * If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get
133 * the values then taken down. So ideally GetSizeAndPosition() should be called after Show().
134 * @return rect which is keyboard panel x, y, width, height
136 DALI_IMPORT_API Dali::Rect<int> GetSizeAndPosition();
139 * @brief Rotates the keyboard orientation to the given angle.
141 * A value of 0 indicates the portrait orientation.
142 * Other valid values are 90, 180, 270.
143 * @param angle the angle is in degrees.
145 DALI_IMPORT_API void RotateTo(int angle);
148 * @brief Returns text direction of the keyboard's current input language.
149 * @return The direction of the text.
151 DALI_IMPORT_API TextDirection GetTextDirection();
154 * @brief Connect to this signal to be notified when the virtual keyboard is shown or hidden.
156 * A callback of the following type may be connected:
158 * void YourCallbackName(bool keyboardShown);
160 * If the parameter keyboardShown is true, then the keyboard has just shown, if it is false, then it
161 * has just been hidden.
162 * @return The signal to connect to.
164 DALI_IMPORT_API StatusSignalType& StatusChangedSignal();
167 * @brief Connect to this signal to be notified when the virtual keyboard is resized.
169 * A callback of the following type may be connected:
171 * void YourCallbackName();
173 * User can get changed size by using GetSizeAndPosition() in the callback
174 * @return The signal to connect to.
176 DALI_IMPORT_API VoidSignalType& ResizedSignal();
179 * @brief Connect to this signal to be notified when the virtual keyboard's language is changed.
181 * A callback of the following type may be connected:
183 * void YourCallbackName();
185 * User can get the text direction of the language by calling GetTextDirection() in the callback.
186 * @return The signal to connect to.
188 DALI_IMPORT_API VoidSignalType& LanguageChangedSignal();
190 } // namespace VirtualKeyboard
194 #endif // __DALI_VIRTUAL_KEYBOARD_H__