2 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include "virtual-keyboard-impl.h"
24 #include <dali/integration-api/debug.h>
27 #include "ecore-virtual-keyboard.h"
29 #include <locale-utils.h>
30 #include <imf-manager-impl.h>
41 namespace VirtualKeyboard
46 #if defined(DEBUG_ENABLED)
47 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_VIRTUAL_KEYBOARD");
50 #define TOKEN_STRING(x) #x
52 //forward declarations
53 void InputPanelGeometryChangedCallback ( void *data, Ecore_IMF_Context *context, int value );
54 void InputPanelLanguageChangeCallback( void* data, Ecore_IMF_Context* context, int value );
57 Dali::VirtualKeyboard::StatusSignalType gKeyboardStatusSignal;
58 Dali::VirtualKeyboard::VoidSignalType gKeyboardResizeSignal;
59 Dali::VirtualKeyboard::VoidSignalType gKeyboardLanguageChangedSignal;
61 void InputPanelStateChangeCallback( void* data, Ecore_IMF_Context* context, int value )
65 case ECORE_IMF_INPUT_PANEL_STATE_SHOW:
67 DALI_LOG_INFO( gLogFilter, Debug::General, "VKB ECORE_IMF_INPUT_PANEL_STATE_SHOW\n" );
69 gKeyboardStatusSignal.Emit( true );
74 case ECORE_IMF_INPUT_PANEL_STATE_HIDE:
76 DALI_LOG_INFO( gLogFilter, Debug::General, "VKB ECORE_IMF_INPUT_PANEL_STATE_HIDE\n" );
78 gKeyboardStatusSignal.Emit( false );
83 case ECORE_IMF_INPUT_PANEL_STATE_WILL_SHOW:
92 void InputPanelLanguageChangeCallback( void* data, Ecore_IMF_Context* context, int value )
94 DALI_LOG_INFO( gLogFilter, Debug::General, "VKB InputPanelLanguageChangeCallback\n" );
96 // Emit the signal that the language has changed
97 gKeyboardLanguageChangedSignal.Emit();
100 void InputPanelGeometryChangedCallback ( void *data, Ecore_IMF_Context *context, int value )
102 DALI_LOG_INFO( gLogFilter, Debug::General, "VKB InputPanelGeometryChangedCallback\n" );
104 // Emit signal that the keyboard is resized
105 gKeyboardResizeSignal.Emit();
108 } // unnamed namespace
110 void ConnectCallbacks( Ecore_IMF_Context *imfContext )
114 DALI_LOG_INFO( gLogFilter, Debug::General, "VKB ConnectPanelCallbacks\n" );
116 ecore_imf_context_input_panel_event_callback_add( imfContext, ECORE_IMF_INPUT_PANEL_STATE_EVENT, InputPanelStateChangeCallback, NULL );
117 ecore_imf_context_input_panel_event_callback_add( imfContext, ECORE_IMF_INPUT_PANEL_LANGUAGE_EVENT, InputPanelLanguageChangeCallback, NULL );
118 ecore_imf_context_input_panel_event_callback_add( imfContext, ECORE_IMF_INPUT_PANEL_GEOMETRY_EVENT, InputPanelGeometryChangedCallback, NULL );
122 void DisconnectCallbacks( Ecore_IMF_Context *imfContext )
126 DALI_LOG_INFO( gLogFilter, Debug::General, "VKB DisconnectPanelCallbacks\n" );
128 ecore_imf_context_input_panel_event_callback_del( imfContext, ECORE_IMF_INPUT_PANEL_STATE_EVENT, InputPanelStateChangeCallback );
129 ecore_imf_context_input_panel_event_callback_del( imfContext, ECORE_IMF_INPUT_PANEL_LANGUAGE_EVENT, InputPanelLanguageChangeCallback );
130 ecore_imf_context_input_panel_event_callback_del( imfContext, ECORE_IMF_INPUT_PANEL_GEOMETRY_EVENT, InputPanelGeometryChangedCallback );
136 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: Show() is deprecated and will be removed from next release. Use ImfManager.Activate() instead.\n" );
138 Dali::ImfManager imfManager = ImfManager::Get(); // Create ImfManager instance (if required) to show the keyboard
142 Ecore_IMF_Context* imfContext = ImfManager::GetImplementation( imfManager ).GetContext();
146 ecore_imf_context_input_panel_show( imfContext );
153 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: Hide() is deprecated and will be removed from next release. Use ImfManager.Deactivate() instead.\n" );
155 if( ImfManager::IsAvailable() /* We do not want to create an ImfManager instance*/ )
157 Dali::ImfManager imfManager = ImfManager::Get();
158 Ecore_IMF_Context* imfContext = ImfManager::GetImplementation( imfManager ).GetContext();
162 ecore_imf_context_input_panel_hide( imfContext );
169 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: IsVisible() is deprecated and will be removed from next release.\n" );
171 if( ImfManager::IsAvailable() /* We do not want to create an ImfManager instance */ )
173 DALI_LOG_INFO( gLogFilter, Debug::General, "IMF IsVisible\n" );
175 Dali::ImfManager imfManager = ImfManager::Get();
176 Ecore_IMF_Context* imfContext = ImfManager::GetImplementation( imfManager ).GetContext();
180 if (ecore_imf_context_input_panel_state_get(imfContext) == ECORE_IMF_INPUT_PANEL_STATE_SHOW ||
181 ecore_imf_context_input_panel_state_get(imfContext) == ECORE_IMF_INPUT_PANEL_STATE_WILL_SHOW)
191 void ApplySettings( const Property::Map& settingsMap )
193 using namespace InputMethod; // Allows exclusion of namespace in TOKEN_STRING.
195 for ( unsigned int i = 0, count = settingsMap.Count(); i < count; ++i )
197 Property::Key key = settingsMap.GetKeyAt( i );
198 if( key.type == Property::Key::INDEX )
203 Property::Value item = settingsMap.GetValue(i);
205 if ( key == TOKEN_STRING( ACTION_BUTTON ) )
207 if ( item.GetType() == Property::INTEGER )
209 int value = item.Get< int >();
210 VirtualKeyboard::SetReturnKeyType( static_cast<InputMethod::ActionButton>(value) );
215 DALI_LOG_INFO( gLogFilter, Debug::General, "Provided Settings Key not supported\n" );
220 void EnablePrediction(const bool enable)
222 Dali::ImfManager imfManager = ImfManager::Get(); // Create ImfManager instance (if required) when enabling prediction
226 Ecore_IMF_Context* imfContext = ImfManager::GetImplementation( imfManager ).GetContext();
230 ecore_imf_context_prediction_allow_set( imfContext, (enable)? EINA_TRUE : EINA_FALSE);
235 bool IsPredictionEnabled()
237 if ( ImfManager::IsAvailable() /* We do not want to create an instance of ImfManger */ )
239 Dali::ImfManager imfManager = ImfManager::Get();
240 Ecore_IMF_Context* imfContext = ImfManager::GetImplementation( imfManager ).GetContext();
244 // predictive text is enabled.
245 if ( ecore_imf_context_input_panel_enabled_get( imfContext ) == EINA_TRUE )
255 Rect<int> GetSizeAndPosition()
257 int xPos, yPos, width, height;
259 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: GetSizeAndPosition() is deprecated and will be removed from next release. Use ImfManager.GetInputMethodArea() instead.\n" );
261 width = height = xPos = yPos = 0;
262 Dali::ImfManager imfManager = ImfManager::Get(); // Create ImfManager instance (if required) as we may need to do some size related setup in the application
266 Ecore_IMF_Context* imfContext = ImfManager::GetImplementation( imfManager ).GetContext();
270 ecore_imf_context_input_panel_geometry_get(imfContext, &xPos, &yPos, &width, &height);
274 DALI_LOG_WARNING("VKB Unable to get IMF Context so GetSize unavailable\n");
275 // return 0 as real size unknown.
279 return Rect<int>(xPos,yPos,width,height);
282 Dali::VirtualKeyboard::StatusSignalType& StatusChangedSignal()
284 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: StatusChangedSignal() is deprecated and will be removed from next release. Use ImfManager.StatusChangedSignal() instead.\n" );
286 Dali::ImfManager imfManager = ImfManager::Get();
287 return imfManager.StatusChangedSignal();
290 Dali::VirtualKeyboard::VoidSignalType& ResizedSignal()
292 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: ResizedSignal() is deprecated and will be removed from next release. Use ImfManager.ResizedSignal() instead.\n" );
294 Dali::ImfManager imfManager = ImfManager::Get();
295 return imfManager.ResizedSignal();
298 Dali::VirtualKeyboard::VoidSignalType& LanguageChangedSignal()
300 DALI_LOG_WARNING_NOFN("DEPRECATION WARNING: LanguageChangedSignal() is deprecated and will be removed from next release. Use ImfManager.LanguageChangedSignal() instead.\n" );
302 Dali::ImfManager imfManager = ImfManager::Get();
303 return imfManager.LanguageChangedSignal();
306 Dali::VirtualKeyboard::TextDirection GetTextDirection()
308 Dali::VirtualKeyboard::TextDirection direction ( Dali::VirtualKeyboard::LeftToRight );
310 if ( ImfManager::IsAvailable() /* We do not want to create an instance of ImfManager */ )
312 Dali::ImfManager imfManager = ImfManager::Get();
316 Ecore_IMF_Context* imfContext = ImfManager::GetImplementation( imfManager ).GetContext();
320 char* locale( NULL );
321 ecore_imf_context_input_panel_language_locale_get( imfContext, &locale );
325 direction = (Dali::VirtualKeyboard::TextDirection)Locale::GetTextDirection( std::string( locale ) );
334 } // namespace VirtualKeyboard
336 } // namespace Adaptor
338 } // namespace Internal