QT5的软键盘输入法实现

一、为什么要用输入法的方式实现

要实现点击一个编辑框就跳出来一个软键盘方法很多，为什么要用输入法的方式呢？输入法的方式可以用在任一个QT程序上，而应用程序本身不需要去关心如何去输入，交给输入法就可以了。输入法与程序是独立的，两个程序通过通信的方式进行对话。就比如我们在手机上写个程序，从来就没关心过软键盘怎么去实现，只需要做应用这部分就可以了。

二、QT5输入法插件的结构

    bool isValid() const Q_DECL_OVERRIDE;     void setFocusObject(QObject *object) Q_DECL_OVERRIDE;      void showInputPanel() Q_DECL_OVERRIDE;     void hideInputPanel() Q_DECL_OVERRIDE;     bool isInputPanelVisible() const Q_DECL_OVERRIDE;     bool filterEvent(const QEvent *event) Q_DECL_OVERRIDE;

这里就是面板的显示隐藏，设置焦点等函数，QT是如何知道这个插件的名字呢？就是根据json文件了，json文件的内容如下：

{     "Keys": [ "vkim" ] }

其中vkim就是输入法的名字。

三、具体实现

InputService::InputService(QObject *object) {     QDBusConnection connect = QDBusConnection::sessionBus();     if (!connect.registerService("com.mh.input")) {         qFatal("Unable to register at DBus");         return;     }     qDebug() << "register servece" << endl;      if (!connect.registerObject("/input/vkim", object,         QDBusConnection::ExportAllSignals | QDBusConnection::ExportAllSlots))     {         qFatal("Unable to register object at DBus");         return;     }      qDebug() << "register object" << endl; }  InputService::~InputService() {     QDBusConnection connect = QDBusConnection::sessionBus();     connect.unregisterObject("/input/vkim");     qDebug() << "unregister object" << endl;      connect.unregisterService("com.mh.input");     qDebug() << "unregister servece" << endl; }

主函数:

#include "inputservice.h" #include <QDBusConnection>  int main(int argc, char *argv[]) {     QApplication a(argc, argv);      Dialog keyboard;     InputService inputService(&keyboard);      return a.exec(); }

这里把dbus的注册放到类里面有一个好处就是可以自己析构，服务和对象就可以删掉了。其中keyboard就是键盘界面，这样就把键盘对象注册到了dbus上，其中 com.mh.input 是服务名, /input/vkim 是该服务下的路径，另外还会生成一个接口的名字叫 local.keyboard.Dialog ,其中keyboard是程序的名字，Dialog是注册对象的类型，用qt下面的qdbusviewer可以看到注册的对象，以及对象的槽，信号。如图所示：

其中接口的名字也可以自己定义，也就是把这句代码改成下面这样子：

connect.registerObject("/input/vkim", “com.mh.input.vkim", object,         QDBusConnection::ExportAllSignals | QDBusConnection::ExportAllSlots)

public slots:     void showKeyboard(QPoint pt, QRect focusWidget);     void hideKeyboard();     bool isVisible() const;  signals:     void commit(QString str);

dialog.cpp

void Dialog::showKeyboard(QPoint pt, QRect focusWidget) {     QWidget::show(); }  void Dialog::hideKeyboard() {     QWidget::hide(); }  bool Dialog::isVisible() const {     return QWidget::isVisible(); } 

#include <qpa/qplatforminputcontextplugin_p.h> #include "vkimplatforminputcontext.h"  class VkImPlatformInputContextPlugin : public QPlatformInputContextPlugin {     Q_OBJECT     Q_PLUGIN_METADATA(IID QPlatformInputContextFactoryInterface_iid FILE "vkim.json")  public:     virtual VkImPlatformInputContext *create(const QString &key, const QStringList &paramList); };

其中Q_PLUGIN_METADATA这些是必须要写的，这是插件的规范，可以在QT官网上找到，IID必须要写成 QPlatformInputContextFactoryInterface_iid 这个看也在父类 QPlatformInputContextPlugin 的头文件里看到定义，FILE定义的就是前面说过的json文件。

VkImPlatformInputContext* VkImPlatformInputContextPlugin::create(const QString &key, const QStringList &paramList) {     if (key == QLatin1String("vkim")) {         qDebug() << "vkim input context plugin created" << endl;         return new VkImPlatformInputContext;     }      return NULL; }

class VkImPlatformInputContext : public QPlatformInputContext {     Q_OBJECT public:     VkImPlatformInputContext();     ~VkImPlatformInputContext();  public:     bool isValid() const Q_DECL_OVERRIDE;     void setFocusObject(QObject *object) Q_DECL_OVERRIDE;      void showInputPanel() Q_DECL_OVERRIDE;     void hideInputPanel() Q_DECL_OVERRIDE;     bool isInputPanelVisible() const Q_DECL_OVERRIDE;     bool filterEvent(const QEvent *event) Q_DECL_OVERRIDE;  public slots:     void keyboardCommit(QString str);  private:     QObject *focusObject;     QDBusInterface *dbusInterface; };

vkimplatforminputcontext.cpp

VkImPlatformInputContext::VkImPlatformInputContext() :     focusObject(NULL) {     dbusInterface = new QDBusInterface("com.mh.input", "/input/vkim", "local.keyboard.Dialog", QDBusConnection::sessionBus(), this);      connect(dbusInterface, SIGNAL(commit(QString)), SLOT(keyboardCommit(QString))); }  void VkImPlatformInputContext::showInputPanel() {     if (dbusInterface != NULL)     {         QWidget *w = qobject_cast<QWidget*>(focusObject);         QPoint pt = w->pos();         QRect rect = w->rect();         pt = w->mapToGlobal(QPoint(0, 0));         int x = pt.x();         int y = pt.y();         dbusInterface->call("showKeyboard", pt, rect);     }     else     {         qDebug() << "interface is null" << endl;     } }  void VkImPlatformInputContext::hideInputPanel() {     if (dbusInterface != NULL)     {         dbusInterface->call("hideKeyboard");     } }

bool VkImPlatformInputContext::filterEvent(const QEvent *event) {     const QKeyEvent *keyEvent = (const QKeyEvent *)event;     int key = keyEvent->key();     // should pass only the key presses     if (keyEvent->type() != QEvent::KeyPress) {         return false;     }      if (key == Qt::Key_Left || key == Qt::Key_Right ||             key == Qt::Key_Up || key == Qt::Key_Down ||             key == Qt::Key_Tab)     {         return false;     }      if (!isInputPanelVisible())     {         showInputPanel();     }      if (dbusInterface != NULL)     {         dbusInterface->call("pressKey", keyEvent->key());     }      return true; }

其中pressKey是输入法界面导出的槽函数，这里插件把按键传给了输入法界面，当然这里看自己的需求了，我这里字符串不是直接发给焦点控件的，是需要再输入法界面确认之后再发给焦点控件的，如果要直接发送给焦点控件，就不需要处理键盘事件了。输入法界面点了确定按钮之后，会发出一个commit信号，插件响应这个信号，把最终提交的字符串发送给焦点控件，这里要用到QInputMethodEvent，代码如下：

void VkImPlatformInputContext::keyboardCommit(QString str) {     if (focusObject == NULL)     {         return;     }      QInputMethodEvent event;     event.setCommitString(str);      QGuiApplication::sendEvent(focusObject, &event); }

其中str是由输入法界面发送信号的时候传过来的。filterEvent又是什么时候调用的呢？QApplication在处理事件循环的时候，通知平台(xcb或者fb等)处理按键事件，平台优先把按键事件告诉输入法，输入法就调用filterEvent函数过滤掉一些事件，这些事件就不会再传给焦点控件了，比如上面的filterEvent函数，其中Qt::Key_Left这些方向键是没有过滤的，return false了，仍然会传递给焦点控件。

四、测试

1. export QT_IM_MODULE=vkim
2. ./keyboard &
3. ./Dialog

五、说明

1. 文章里的代码删掉了一部分，便于阅读，完整代码可以到这里下载 http://git.oschina.net/tracing/VkIm ，或者直接用git clone， https://git.oschina.net/tracing/VkIm.git
2. 参考的文章及代码 http://www.kdab.com/qt-input-method-depth/