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