Qt实现虚拟键盘
- 🌟项目分析
- 🌟实现方式
- 🌟开发流程
🌟项目分析
- 需求：为Linux环境下提供可便捷使用的虚拟键盘
- OS环境：Windows 7/11、CentOS 7
- 开发语言：Qt/C++
- IDE：QtCreator 、Qt5.14.2
- 功能：支持中/英文/数字键盘输入、支持中文拼音输入法、支持半/全角标点输入
🌟实现方式
-
方式一：调用第三方程序。windows下调用系统自带虚拟键盘。Linux下通过安装第三方虚拟键盘OnKeyboard，在程序中调用
-
方式二：使用Qt自带虚拟键盘。通过引入虚拟键盘模块，检测到程序内的输入控件焦点后，自动显示。
-
方式三：自定义虚拟键盘。设计虚拟键盘布局，实现键盘按键效果，接入谷歌中文拼音库。
本文接下来主要讲解方式三的实现。
🌟开发流程
- 谷歌中文拼音库编译：
- 点击此处下载项目源码。
- 打开QtCreator，导入该项目。在pinyinime.pro中添加下面命令
CONFIG += staticlib。选择qmake并构建，在构建目录中可以看到，生成两个库文件：pinyinime.dll和pinyinime.lib，这两个库文件即为使用谷歌拼音库所需。
- 点击此处下载项目源码。
- 新建虚拟键盘项目：
- 创建QWidget项目。
2.选择构建套件。
- 在项目路径下，创建文件夹lib、include、build、bin。拷贝生成的pinyinime.dll放入bin文件夹下，pinyinime.dll放入lib文件夹下。将pinyinime项目的src文件夹中所有文件拷贝到include文件夹中。
- 修改VirtualKeyboard.pro文件，设置项目构建配置、可执行文件生成路径、第三方依赖引用、头文件引用。
- 创建QWidget项目。
QT += core gui
greaterThan(QT_MAJOR_VERSION, 4): QT += widgets
CONFIG += c++17
CONFIG -= debug_and_release
# You can make your code fail to compile if it uses deprecated APIs.
# In order to do so, uncomment the following line.
#DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000 # disables all the APIs deprecated before Qt 6.0.0
DESTDIR += $$PWD/bin
INCLUDEPATH += $$PWD/include
SOURCES += \
main.cpp \
keyboard.cpp
HEADERS += \
keyboard.h
FORMS += \
keyboard.ui
# Default rules for deployment.
qnx: target.path = /tmp/$${TARGET}/bin
else: unix:!android: target.path = /opt/$${TARGET}/bin
!isEmpty(target.path): INSTALLS += target
win32:CONFIG(release, debug|release): LIBS += -L$$PWD/lib/ -lpinyinime
else:win32:CONFIG(debug, debug|release): LIBS += -L$$PWD/lib/ -lpinyinimed
INCLUDEPATH += $$PWD/include
DEPENDPATH += $$PWD/include
-
虚拟键盘UI设计：
- 利用StackedWidget分别存放中/英文、数字、符号所对应的界面。
- 留出一个布局控件，用于存放候选词显示控件。
- 候选词数量级较小，通过使用QListWidget横向展示即可实现需求。
- 自定义标题栏，为了方便后期更换样式，适应使用场景。下面展示三种方式的键盘布局。
-
候选词类设计：
- 继承QListWidget，重写接口和信号。
- 集成对于谷歌拼音库的调用。
-
下面是关键代码展示：
//调用谷歌拼音库搜索，获取候选词
QList<QString> CandidateWidget::search(const QString &pinyinPrefix)
{
QList<QString> candidateList;
// 1. 转换拼音前缀为小写
QString normalizedPrefix = pinyinPrefix.toLower();
// 重置搜索
im_reset_search();
// 4. 搜索拼音对应的汉字候选
QByteArray bytearray(normalizedPrefix.toUtf8());
char *pinyin(bytearray.data());
size_t cand_num = im_search(pinyin, bytearray.size());
// 5. 获取候选词
char16 *cand_buf = new char16[max_decoded_length];
for (size_t i = 0; i < cand_num; i++)
{
char16 *cand = im_get_candidate(i, cand_buf, max_decoded_length);
if (cand)
{
QString candidateStr = QString::fromUtf16(cand);
if (i == 0) candidateStr.remove(0, im_get_fixed_len()); // 去除固定拼音部分
candidateList.append(candidateStr); // 加入候选词列表
}
}
// 6. 释放资源
delete[] cand_buf;
// 7. 返回候选词列表
return candidateList;
}
- 项目主体类设计：
- 考虑到对于内存的管理以及场景的评估，这里将其封装成了单例工具类，方便在项目中使用。
- 实现候选词模块的嵌入。
- 实现UI中按键的响应函数，以及不同键盘布局之间的跳转。
- 处理焦点变化，实现实时检测焦点，可以动态更换交互控件。（需要在主应用中重写事件过滤器，检测焦点进入事件。并区分使用交互控件，发出全局焦点变化信号）
展示关键部分代码：
//单例类的实现方式：
//Keyboard.h
public:
// 获取单例实例
static Keyboard *getInstance(QWidget *parent = nullptr);
// 销毁单例实例
static void destroyInstance();
private:
//声明静态实例
static Keyboard* m_instance;
//存放候选词ListWidget
CandidateWidget *m_pChineseWidget;
//Keyboard.cpp
// 定义静态实例
Keyboard* Keyboard::m_instance = nullptr;
// 获取单例实例
Keyboard* Keyboard::getInstance(QWidget *parent)
{
if (m_instance == nullptr) {
m_instance = new Keyboard(parent);
}
return m_instance;
}
void Keyboard::destroyInstance()
{
if (m_instance != nullptr)
{
delete m_instance;
m_instance = nullptr;
}
}
void initWidget(){
....
m_pChineseWidget = new CandidateWidget;
m_pChineseWidget->setSizePolicy(QSizePolicy::Ignored, QSizePolicy::Ignored);
ui->horizontalLayout_Chinese->addWidget(m_pChineseWidget);//嵌入候选词显示列表
...
connect(GlobalSignalManager::getInstance(),&GlobalSignalManager::focusChanged,
this,&Keyboard::onFocusReceived,Qt::UniqueConnection);//绑定全局的焦点变化信号和焦点处理函数
}
void Keyboard::onFocusReceived(QWidget* newWidget,int type) {//我的主应用中有5中类型的交互控件，需要分别处理
if (newWidget && m_currentTarget!=newWidget ) {
if(m_currentTarget){
disconnect(this,nullptr,m_currentTarget,nullptr);
}
// 保存当前聚焦控件
LogDebug << "receive new WIDGET"<<newWidget->objectName();
m_currentTarget = newWidget;
switch (type) {
case 0:{
connect(this,&Keyboard::operateText,dynamic_cast<CustomLineEdit*>(m_currentTarget),&CustomLineEdit::operateTextSlot);
break;
}
case 1:{
connect(this,&Keyboard::operateText,dynamic_cast<CustomPlainTextEdit*>(m_currentTarget),&CustomPlainTextEdit::operateTextSlot);
break;
}
case 2:{
connect(this,&Keyboard::operateText,dynamic_cast<QLineEdit*>(m_currentTarget),[=](QString opt,QString text){
// static QElapsedTimer timer;
// if (timer.elapsed() < 100) {
// return; // 节流机制：忽略100毫秒内的多次输入
// }
// timer.restart();
if(opt == "insert"){
dynamic_cast<QLineEdit*>(m_currentTarget)->insert(text);
}else if(opt == "backspace"){
if(!dynamic_cast<QLineEdit*>(m_currentTarget)->text().isEmpty()){
dynamic_cast<QLineEdit*>(m_currentTarget)->backspace();
}
}
});
break;
}
case 3:{
connect(this,&Keyboard::operateText,dynamic_cast<QPlainTextEdit*>(m_currentTarget),[=](QString opt,QString text){
// static QElapsedTimer timer;
// if (timer.elapsed() < 100) {
// return; // 节流机制：忽略100毫秒内的多次输入
// }
// timer.restart();
if(opt == "insert"){
dynamic_cast<QPlainTextEdit*>(m_currentTarget)->insertPlainText(text);
}else if(opt == "backspace"){
if(!dynamic_cast<QPlainTextEdit*>(m_currentTarget)->toPlainText().isEmpty()){
dynamic_cast<QPlainTextEdit*>(m_currentTarget)->undo();
}
} else if(opt == "enter"){
dynamic_cast<QPlainTextEdit*>(m_currentTarget)->insertPlainText("\n");
}
});
break;
}
case 4:{
connect(this,&Keyboard::operateText,dynamic_cast<QTextEdit*>(m_currentTarget),[=](QString opt,QString text){
// static QElapsedTimer timer;
// if (timer.elapsed() < 100) {
// return; // 节流机制：忽略100毫秒内的多次输入
// }
// timer.restart();
if(opt == "insert"){
dynamic_cast<QTextEdit*>(m_currentTarget)->insertPlainText(text);
} else if(opt == "backspace"){
if(!dynamic_cast<QTextEdit*>(m_currentTarget)->toPlainText().isEmpty()){
dynamic_cast<QTextEdit*>(m_currentTarget)->undo();
}
} else if(opt == "enter"){
dynamic_cast<QTextEdit*>(m_currentTarget)->insertPlainText("\n");
}
});
break;
}
default:
break;
}
}
//MianWindow.cpp
//主程序的事件过滤
bool MainWindow::eventFilter(QObject *obj, QEvent *event)
{
if (event->type() == QEvent::FocusIn) {
if (dynamic_cast<CustomLineEdit*>(obj)) {
LogDebug << obj->objectName() << " gained focus.";
// 这里可以处理焦点事件
emit GlobalSignalManager::getInstance()->focusChanged(qobject_cast<QWidget*>(obj),0);
}else if(dynamic_cast<CustomPlainTextEdit*>(obj)){
LogDebug << obj->objectName() << " gained focus.";
emit GlobalSignalManager::getInstance()->focusChanged(qobject_cast<QWidget*>(obj),1);
}else if(dynamic_cast<QLineEdit*>(obj)){
LogDebug << obj->objectName() << " gained focus.";
emit GlobalSignalManager::getInstance()->focusChanged(qobject_cast<QWidget*>(obj),2);
}else if(dynamic_cast<QPlainTextEdit*>(obj)){
LogDebug << obj->objectName() << " gained focus.";
emit GlobalSignalManager::getInstance()->focusChanged(qobject_cast<QWidget*>(obj),3);
}else if(dynamic_cast<QTextEdit*>(obj)){
LogDebug << obj->objectName() << " gained focus.";
emit GlobalSignalManager::getInstance()->focusChanged(qobject_cast<QWidget*>(obj),4);
}
} else if (event->type() == QEvent::FocusOut) {
if (dynamic_cast<CustomLineEdit*>(obj)) {
// LogDebug << obj->objectName() << "lost focus.";
}
}
return QWidget::eventFilter(obj, event); // 确保事件传递给基类
}
}
🌟PinYinIMe接口描述
- 启动解码引擎
bool im_open_decoder(const char *fn_sys_dict, const char *fn_usr_dict);
- fn_sys_dict: 系统字典，可以直接使用谷歌自带的字典
dict_pinyin.dat - fn_usr_dict: 用户字典，用户自己定义的字典
成功启动引擎时接口返回true。
bool im_open_decoder_fd(int sys_fd, long start_offset, long length,
const char *fn_usr_dict);
上一个函数的变形。
- sys_fd: 系统字典的文件描述符
- start_offset: 系统字典文件描述符的偏移位置
- length: 系统字典文件读取的长度
- fn_usr_dict: 用户字典
- 关闭解码引擎
void im_close_decoder();
- 设置输入输出上限
void im_set_max_lens(size_t max_sps_len, size_t max_hzs_len);
如果本函数未被调用，则使用默认参数。举例说明该函数的作用，对于显示屏幕大小受限制，
显示部件可以只显示确定数量的输入字母来解码， 以及确定数量的中文来显示。
如果用户添加一个新字母之母， 输入的所有字母或输出的中文数量超过了设置的上限， 则引擎会不理踩
新添加的字母。
- max_sps_len: 输入拼音字母的最大长度
- max_hzs_len: 解码中文字符的最大长度
- 清除缓冲
void im_flush_cache();
因为引擎在运行时，为是达到最好的性能，一些数据有保存至内存中，所以有必要时需要清除掉。
- 搜索
size_t im_search(const char* sps_buf, size_t sps_len);
本函数用于搜索匹配字母的候选中文。当要搜索的字母的前缀与先前的搜索字母一样，引擎默认会在先前的
搜索结果中进行搜索。如果用户需要开启新的搜索，可以先调用im_reset_search()接口。
- sps_buf: 拼音字母
- sps_len: 字母长度
- 返回候选数
- 删除
size_t im_delsearch(size_t pos, bool is_pos_in_splid, bool clear_fixed_this_step);
对当前查找结果执行删除操作， 然后再重新查找。
- pos: 拼音字母的位置或者是搜索结果ID
- is_pos_in_splid: 申明pos参数是字母位置还是搜索结果ID
- clear_fixed_this_step:
- 返回候选数量
- 初始化查找结果
void im_reset_search();
- 获取输入的拼音字母
const char *im_get_sps_str(size_t *decoded_len);
- decoded_len: 保存返回拼音字母的长度arsed.
- 返回拼音字母
- 获取候选字符串
char16* im_get_candidate(size_t cand_id, char16* cand_str, size_t max_len);
- cand_id: 获取候选字符串的ID号，从0开始，通常ID为0是匹配度最高的
- cand_str: 用于保存选择字符串的缓冲区
- max_len: 缓冲区最大长度
- 成功返回缓冲区地址cand_str，失败返回NULL.
🌟项目展示
如果有兴趣，下载源码，并尝试优化 ：）
