Qt5기반 독립 프로세스(out-of-process)로 동작하는 가상키보드(virtual keyboard)

 

키보드 프로그램은 처음 QDBus API를 통해 DBus 세션버스에 서비스 및 인스턴스를 등록한다.

#include <QApplication>
#include <QDBusConnection>

#include "keyboard.h"

int main(int argc, char **argv)
{
    QApplication app(argc, argv);

    if (!QDBusConnection::sessionBus().registerService("com.kdab.inputmethod")) {
        qFatal("Unable to register at DBus");
        return 1;
    }

    Keyboard keyboard;

    if (!QDBusConnection::sessionBus().registerObject("/VirtualKeyboard", &keyboard, QDBusConnection::ExportAllSignals | QDBusConnection::ExportAllSlots)) {
        qFatal("Unable to register object at DBus");
        return 1;
    }

    return app.exec();
}

 

키보드 클래스는 윈도우에 키보드 배열을 그리기 위해 QWidget을 상속받고 있으며 기본적인 메서드와 키입력 시그널을 제공한다.

#ifndef KEYBOARD_H
#define KEYBOARD_H

#include <QWidget>

class Keyboard : public QWidget
{
    Q_OBJECT

public:
    explicit Keyboard(QWidget *parent = Q_NULLPTR);

public slots:
    void showKeyboard(int globalX, int globalY);
    void hideKeyboard();
    bool keyboardVisible() const;

signals:
    void specialKeyClicked(int key);
    void keyClicked(const QString &text);

private slots:
    void buttonClicked(int key);
};

#endif

 

키보드 생성자에서는 키배열 레이아웃을 만들며 모든 버튼클릭은 중앙에서 처리되어야 하므로 QPushButton 중 하나를 클릭 할 때마다 QSignalMapper를 사용하여 private buttonClicked(int key) 슬롯과 연결한다.

Keyboard::Keyboard(QWidget *parent)
    : QWidget(parent)
{
    setWindowFlags(Qt::WindowDoesNotAcceptFocus | Qt::Tool | Qt::FramelessWindowHint | Qt::WindowStaysOnTopHint | Qt::BypassWindowManagerHint);

    QGridLayout *gridLayout = new QGridLayout(this);

    QSignalMapper *mapper = new QSignalMapper(this);
    connect(mapper, SIGNAL(mapped(int)), SLOT(buttonClicked(int)));

    int row = 0;
    int column = 0;

    for (int i = 0; i < layoutSize; ++i) {
        if (keyboardLayout[i].key == NEXT_ROW_MARKER) {
            row++;
            column = 0;
            continue;
        }

        QPushButton *button = new QPushButton;
        button->setFixedWidth(40);
        button->setText(QString::fromLatin1(keyboardLayout[i].label));

        mapper->setMapping(button, keyboardLayout[i].key);
        connect(button, SIGNAL(clicked()), mapper, SLOT(map()));

        gridLayout->addWidget(button, row, column);
        column++;
    }
}

 

이제 사용자가 QPushButton 중 하나를 클릭하면 buttonClicked() 슬롯이 호출된다.

void Keyboard::buttonClicked(int key)
{
    if ((key == Qt::Key_Enter) || (key == Qt::Key_Backspace))
        emit specialKeyClicked(key);
    else
        emit keyClicked(keyToCharacter(key));
}

 

누른 키가 Backspace 또는 Enter이면 specialKeyClicked() 신호가 내보내지며, 그렇지 않으면 키 코드가 문자에 매핑되고 keyClicked() 신호가 해당 문자와 함께 매개 변수로 생성된다.

static QString keyToCharacter(int key)
{
    for (int i = 0; i < layoutSize; ++i) {
        if (keyboardLayout[i].key == key)
            return QString::fromLatin1(keyboardLayout[i].label);
    }

    return QString();
}

 

 

Input Method 시스템은 공용 프론트 엔드 클래스 QInputMethod와 개인용 백엔드 클래스 QPlatformInputContext를 통해 수행된다.

 

1. QPlatformInputContext를 상속받는 서브 클래스 구현

2. QPlatformInputContextPlugin을 상속받는 서브 클래스 구현

 

먼저 QPlatformInputContextPlugin을 상속받은 새로운 클래스 QVkImPlatformInputContextPlugin을 선언하고 가상 메소드 create()를 다시 구현한다.

class QVkImPlatformInputContextPlugin : public QPlatformInputContextPlugin
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID QPlatformInputContextFactoryInterface_iid FILE "vkim.json")

public:
    QVkImPlatformInputContext *create(const QString&, const QStringList&) Q_DECL_OVERRIDE;
};

QVkImPlatformInputContext *QVkImPlatformInputContextPlugin::create(const QString& system, const QStringList& paramList)
{
    Q_UNUSED(paramList);

    if (system == QLatin1String("vkim")) {
        return new QVkImPlatformInputContext;
    }

    return 0;
}

 

플러그인 메타 데이터는 외부 파일 'vkim.json'에 저장되며 다음 줄만 포함된다.

{
    "Keys": [ "vkim" ]
}

'vkim'이라는 용어는 'virtual keyboard Input method'의 약자로, 입력 메소드 플러그인의 식별자로 사용된다. 나중에 필요한 곳에서 다시 보게 될 것이다.

 

QVkImPlatformInputContextPlugin::create() 구현 시 요청한 객체가 해당 식별자를 가지고 있는지 확인하고 이 경우 사용자 정의 클래스인 QVkImPlatformInputContext의 새 인스턴스를 반환한다.

 

QPlatformInputContext의 다섯 가지 가상 메서드를 다시 구현한다.

 

isValid()는 QPlatformInputContextFactory (플러그인을로드하고 create() 메소드를 호출하는 클래스)에 의해 호출되어 입력 메소드가 사용할 준비가되었는지 확인.

setFocusObject()는 QGuiApplication에 의해 호출되어 QPlatformInputContext에 현재 입력 포커스가있는 객체를 알린다.

showInputPanel()은 텍스트 입력 필드에 포커스되면 QInputMethod::show()에 의해 호출되어 키보드를 호출한다.

hideInputPanel()은 QInputMethod::hide()에 의해 호출되어 현재 텍스트 입력 필드가 포커스를 잃으면 키보드를 숨긴다.

isInputPanelVisible()은 QInputMethod::isVisible()에 의해 호출되어 키보드의 visible 상태를 응용 프로그램에 알린다.

 

플러그인은 결과적으로 키보드가 필요한 응용프로그램이 사용하며 키보드프로그램으로부터 이벤트를 받을 수 있도록 dbus 연결을 만든다.

QVkImPlatformInputContext::QVkImPlatformInputContext()
    : m_focusObject(0)
{
    m_keyboardInterface = new QDBusInterface("com.kdab.inputmethod", "/VirtualKeyboard", "local.server.Keyboard", QDBusConnection::sessionBus(), this);

    connect(m_keyboardInterface, SIGNAL(keyClicked(QString)), SLOT(keyboardKeyClicked(QString)));
    connect(m_keyboardInterface, SIGNAL(specialKeyClicked(int)), SLOT(keyboardSpecialKeyClicked(int)));
}

 

현재 포커스된 텍스트 입력 위젯이 있는 경우 입력 된 문자를 이벤트의 커밋 문자열로 설정하여 객체로 보낸다.

void QVkImPlatformInputContext::keyboardKeyClicked(const QString &characters)
{
    if (!m_focusObject)
        return;

    QInputMethodEvent event;
    event.setCommitString(characters);

    QGuiApplication::sendEvent(m_focusObject, &event);
}

 

프로젝트를 빌드하면 플러그인(libvkimplatforminputcontextplugin.so)과 키보드 프로그램(server)이 만들어 진다. libvkimplatforminputcontextplugin.so은 Qt가 설치된 곳의 plugins/platforminputcontexts 디렉토리에 deploy되어야 한다. 

 

그 다음 sever를 실행하면 dbus 세션버스에 다음과 같이 인터페이스가 노출된다.

 

이제 입력 필드를 가진 간단한 응용프로그램을 만든다.

 

기본적으로 사용되는 QPA 플러그인은 시스템에 대한 입력 메서드를 사용하므로 우리가 만든 입력 메소드를 사용하려면 QT_IM_MODULE 환경변수를 입력 메소드의 식별자로 설정하여 명시적으로 Qt에 알려야 한다. 이전에 'vkim'이라는 식별자를 기억 할 것이다. 아래처럼 환경변수를 설정해준다.