[SRUK] Initial copy from Tizen 2.2 version
[platform/core/uifw/dali-adaptor.git] / adaptors / tizen / internal / common / virtual-keyboard-impl.h
1 #ifndef __DALI_INTERNAL_VIRTUAL_KEYBOARD_H__
2 #define __DALI_INTERNAL_VIRTUAL_KEYBOARD_H__
3
4 //
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
6 //
7 // Licensed under the Flora License, Version 1.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
10 //
11 //     http://floralicense.org/license/
12 //
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.
18 //
19
20 // EXTERNAL INCLUDES
21 #include <Ecore_IMF.h>
22
23 // INTERNAL INCLUDES
24 #include <dali/public-api/adaptor-framework/common/virtual-keyboard.h>
25
26 namespace Dali
27 {
28
29 namespace Internal
30 {
31
32 namespace Adaptor
33 {
34
35 /**
36  * Implementation of the virtual keyboard namespace
37  */
38 namespace VirtualKeyboard
39 {
40
41 /**
42  * Connect the virtual keyboard callbacks.
43  * To get the virtual keyboard callbacks then you have to connect these callback.
44  * If you don't connect callbacks, you can't get virtual keyboard signals.
45  * The signals are StatusChangedSignal, ResizedSignal and LanguageChangedSignal.
46  */
47 void ConnectCallbacks( Ecore_IMF_Context *imfContext );
48
49 /**
50  * Disconnect the virtual keyboard callbacks.
51  * The signals are StatusChangedSignal, ResizedSignal and LanguageChangedSignal.
52  */
53 void DisconnectCallbacks( Ecore_IMF_Context *imfContext );
54
55 /**
56  * @copydoc Dali::VirtualKeyboard::Show()
57  */
58 void Show();
59
60 /**
61  * @copydoc Dali::VirtualKeyboard::Hide()
62  */
63 void Hide();
64
65 /**
66  * @copydoc Dali::VirtualKeyboard::IsVisible()
67  */
68 bool IsVisible();
69
70 /**
71  * @copydoc Dali::VirtualKeyboard::SetReturnKeyType()
72  */
73 void SetReturnKeyType( Dali::VirtualKeyboard::ReturnKeyType type );
74
75 /**
76  * @copydoc Dali::VirtualKeyboard::GetReturnKeyType()
77  */
78 Dali::VirtualKeyboard::ReturnKeyType GetReturnKeyType();
79
80 /**
81  * @copydoc Dali::VirtualKeyboard::EnablePrediction()
82  */
83 void EnablePrediction(const bool enable);
84
85 /**
86  * @copydoc Dali::VirtualKeyboard::IsPredictionEnabled()
87  */
88 bool IsPredictionEnabled();
89
90 /**
91  * @copydoc Dali::VirtualKeyboard::GetSizeAndPosition()
92  */
93 Rect<int> GetSizeAndPosition();
94
95 /**
96  * @copydoc Dali::VirtualKeyboard::RotateKeyboard()
97  */
98 void RotateTo(int angle);
99
100 /**
101  * @copydox Dali::VirtualKeyboard::StatusChangedSignal()
102  */
103 Dali::VirtualKeyboard::StatusSignalV2& StatusChangedSignal();
104
105 /**
106  * @copydox Dali::VirtualKeyboard::ResizedSignal()
107  */
108 Dali::VirtualKeyboard::VoidSignalV2& ResizedSignal();
109
110 /**
111  * @copydox Dali::VirtualKeyboard::LanguageChangedSignal()
112  */
113 Dali::VirtualKeyboard::VoidSignalV2& LanguageChangedSignal();
114
115 /**
116  * @copydoc Dali::VirtualKeyboard::GetTextDirection
117  */
118 Dali::VirtualKeyboard::TextDirection GetTextDirection();
119
120 } // namespace VirtualKeyboard
121
122 } // namespace Adaptor
123
124 } // namespace Internal
125
126 } // namespace Dali
127
128 #endif // __DALI_INTERNAL_VIRTUAL_KEYBOARD_H__