adaptors/common/virtual-keyboard-impl.cpp

   1 /*
   2  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include "virtual-keyboard-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <algorithm>
  23
  24 #include <dali/public-api/common/vector-wrapper.h>
  25 #include <dali/integration-api/debug.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <adaptor.h>
  29 #include <locale-utils.h>
  30 #include <imf-manager-impl.h>
  31
  32 namespace Dali
  33 {
  34
  35 namespace Internal
  36 {
  37
  38 namespace Adaptor
  39 {
  40
  41 namespace VirtualKeyboard
  42 {
  43
  44 namespace
  45 {
  46 #if defined(DEBUG_ENABLED)
  47 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_VIRTUAL_KEYBOARD");
  48 #endif
  49
  50 #define TOKEN_STRING(x) #x
  51
  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 );
  55
  56 // Signals
  57 Dali::VirtualKeyboard::StatusSignalType gKeyboardStatusSignal;
  58 Dali::VirtualKeyboard::VoidSignalType   gKeyboardResizeSignal;
  59 Dali::VirtualKeyboard::VoidSignalType   gKeyboardLanguageChangedSignal;
  60
  61 void InputPanelStateChangeCallback( void* data, Ecore_IMF_Context* context, int value )
  62 {
  63   switch (value)
  64   {
  65     case ECORE_IMF_INPUT_PANEL_STATE_SHOW:
  66     {
  67       DALI_LOG_INFO( gLogFilter, Debug::General, "VKB ECORE_IMF_INPUT_PANEL_STATE_SHOW\n" );
  68
  69       gKeyboardStatusSignal.Emit( true );
  70
  71       break;
  72     }
  73
  74     case ECORE_IMF_INPUT_PANEL_STATE_HIDE:
  75     {
  76       DALI_LOG_INFO( gLogFilter, Debug::General, "VKB ECORE_IMF_INPUT_PANEL_STATE_HIDE\n" );
  77
  78       gKeyboardStatusSignal.Emit( false );
  79
  80       break;
  81     }
  82
  83     case ECORE_IMF_INPUT_PANEL_STATE_WILL_SHOW:
  84     default:
  85     {
  86       // Do nothing
  87       break;
  88     }
  89   }
  90 }
  91
  92 void InputPanelLanguageChangeCallback( void* data, Ecore_IMF_Context* context, int value )
  93 {
  94   DALI_LOG_INFO( gLogFilter, Debug::General, "VKB InputPanelLanguageChangeCallback" );
  95
  96   // Emit the signal that the language has changed
  97   gKeyboardLanguageChangedSignal.Emit();
  98 }
  99
 100 void InputPanelGeometryChangedCallback ( void *data, Ecore_IMF_Context *context, int value )
 101 {
 102   DALI_LOG_INFO( gLogFilter, Debug::General, "VKB InputPanelGeometryChangedCallback\n" );
 103
 104   // Emit signal that the keyboard is resized
 105   gKeyboardResizeSignal.Emit();
 106 }
 107
 108 } // unnamed namespace
 109
 110 void ConnectCallbacks( Ecore_IMF_Context *imfContext )
 111 {
 112   if( imfContext )
 113   {
 114     DALI_LOG_INFO( gLogFilter, Debug::General, "VKB ConnectPanelCallbacks\n" );
 115
 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 );
 119   }
 120 }
 121
 122 void DisconnectCallbacks( Ecore_IMF_Context *imfContext )
 123 {
 124   if( imfContext )
 125   {
 126     DALI_LOG_INFO( gLogFilter, Debug::General, "VKB DisconnectPanelCallbacks\n" );
 127
 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 );
 131   }
 132 }
 133
 134 void Show()
 135 {
 136   Dali::ImfManager imfManager = ImfManager::Get(); // Create ImfManager instance (if required) to show the keyboard
 137   Ecore_IMF_Context* imfContext = NULL;
 138
 139   if( imfManager )
 140   {
 141     imfContext = reinterpret_cast<Ecore_IMF_Context*>( imfManager.GetContext() );
 142
 143     if( imfContext )
 144     {
 145       ecore_imf_context_input_panel_show( imfContext );
 146     }
 147   }
 148 }
 149
 150 void Hide()
 151 {
 152   if( ImfManager::IsAvailable() /* We do not want to create an ImfManager instance*/ )
 153   {
 154     Dali::ImfManager imfManager = ImfManager::Get();
 155     Ecore_IMF_Context* imfContext = reinterpret_cast<Ecore_IMF_Context*>( imfManager.GetContext() );
 156
 157     if( imfContext )
 158     {
 159       ecore_imf_context_input_panel_hide( imfContext );
 160     }
 161   }
 162 }
 163
 164 bool IsVisible()
 165 {
 166   if( ImfManager::IsAvailable() /* We do not want to create an ImfManager instance */ )
 167   {
 168     DALI_LOG_INFO( gLogFilter, Debug::General, "IMF IsVisible\n" );
 169
 170     Dali::ImfManager imfManager = ImfManager::Get();
 171     Ecore_IMF_Context* imfContext = reinterpret_cast<Ecore_IMF_Context*>( imfManager.GetContext() );
 172
 173     if ( imfContext )
 174     {
 175       if (ecore_imf_context_input_panel_state_get(imfContext) == ECORE_IMF_INPUT_PANEL_STATE_SHOW ||
 176           ecore_imf_context_input_panel_state_get(imfContext) == ECORE_IMF_INPUT_PANEL_STATE_WILL_SHOW)
 177       {
 178         return true;
 179       }
 180     }
 181   }
 182
 183   return false;
 184 }
 185
 186 void ApplySettings( const Property::Map& settingsMap )
 187 {
 188   using namespace InputMethod; // Allows exclusion of namespace in TOKEN_STRING.
 189
 190   for ( unsigned int i = 0, count = settingsMap.Count(); i < count; ++i )
 191   {
 192     std::string key = settingsMap.GetKey( i );
 193     Property::Value item = settingsMap.GetValue(i);
 194
 195     if ( key == TOKEN_STRING( ACTION_BUTTON ) )
 196     {
 197       if ( item.GetType() == Property::INTEGER )
 198       {
 199         int value = item.Get< int >();
 200         VirtualKeyboard::SetReturnKeyType( static_cast<InputMethod::ActionButton>(value) );
 201       }
 202     }
 203     else
 204     {
 205       DALI_LOG_INFO( gLogFilter, Debug::General, "Provided Settings Key not supported\n" );
 206     }
 207    }
 208 }
 209
 210 void EnablePrediction(const bool enable)
 211 {
 212   Dali::ImfManager imfManager = ImfManager::Get(); // Create ImfManager instance (if required) when enabling prediction
 213   Ecore_IMF_Context* imfContext = NULL;
 214
 215   if( imfManager )
 216   {
 217     imfContext = reinterpret_cast<Ecore_IMF_Context*>( imfManager.GetContext() );
 218
 219     if ( imfContext )
 220     {
 221       ecore_imf_context_prediction_allow_set( imfContext, (enable)? EINA_TRUE : EINA_FALSE);
 222     }
 223   }
 224 }
 225
 226 bool IsPredictionEnabled()
 227 {
 228   if ( ImfManager::IsAvailable() /* We do not want to create an instance of ImfManger */ )
 229   {
 230     Dali::ImfManager imfManager = ImfManager::Get();
 231     Ecore_IMF_Context* imfContext = reinterpret_cast<Ecore_IMF_Context*>( imfManager.GetContext() );
 232
 233     if ( imfContext )
 234     {
 235       // predictive text is enabled.
 236       if ( ecore_imf_context_input_panel_enabled_get( imfContext ) == EINA_TRUE )
 237       {
 238         return true;
 239       }
 240     }
 241   }
 242
 243   return false;
 244 }
 245
 246 Rect<int> GetSizeAndPosition()
 247 {
 248   int xPos, yPos, width, height;
 249
 250   width = height = xPos = yPos = 0;
 251   Dali::ImfManager imfManager = ImfManager::Get(); // Create ImfManager instance (if required) as we may need to do some size related setup in the application
 252   Ecore_IMF_Context* imfContext = NULL;
 253
 254   if( imfManager )
 255   {
 256     imfContext = reinterpret_cast<Ecore_IMF_Context*>( imfManager.GetContext() );
 257
 258     if( imfContext )
 259     {
 260       ecore_imf_context_input_panel_geometry_get(imfContext, &xPos, &yPos, &width, &height);
 261     }
 262     else
 263     {
 264       DALI_LOG_WARNING("VKB Unable to get IMF Context so GetSize unavailable\n");
 265     // return 0 as real size unknown.
 266     }
 267   }
 268
 269   return Rect<int>(xPos,yPos,width,height);
 270 }
 271
 272 Dali::VirtualKeyboard::StatusSignalType& StatusChangedSignal()
 273 {
 274   return gKeyboardStatusSignal;
 275 }
 276
 277 Dali::VirtualKeyboard::VoidSignalType& ResizedSignal()
 278 {
 279   return gKeyboardResizeSignal;
 280 }
 281
 282 Dali::VirtualKeyboard::VoidSignalType& LanguageChangedSignal()
 283 {
 284   return gKeyboardLanguageChangedSignal;
 285 }
 286
 287 Dali::VirtualKeyboard::TextDirection GetTextDirection()
 288 {
 289   Dali::VirtualKeyboard::TextDirection direction ( Dali::VirtualKeyboard::LeftToRight );
 290
 291   if ( ImfManager::IsAvailable() /* We do not want to create an instance of ImfManager */ )
 292   {
 293     Dali::ImfManager imfManager = ImfManager::Get();
 294
 295     if ( imfManager )
 296     {
 297       Ecore_IMF_Context* imfContext = reinterpret_cast<Ecore_IMF_Context*>( imfManager.GetContext() );
 298
 299       if ( imfContext )
 300       {
 301         char* locale( NULL );
 302         ecore_imf_context_input_panel_language_locale_get( imfContext, &locale );
 303
 304         if ( locale )
 305         {
 306           direction = Locale::GetTextDirection( std::string( locale ) );
 307           free( locale );
 308         }
 309       }
 310     }
 311   }
 312   return direction;
 313 }
 314
 315 } // namespace VirtualKeyboard
 316
 317 } // namespace Adaptor
 318
 319 } // namespace Internal
 320
 321 } // namespace Dali