一、概述

在应用程序开发中，为用户提供有效的在线帮助是提升用户体验的重要环节。Qt框架提供了多种方式来为应用程序添加帮助功能，从简单的工具提示到复杂的帮助文档系统。

二、工具提示、状态提示和"What’s This?"帮助

1、工具提示(Tool Tips)

添加工具提示到控件

在Qt中，工具提示可以通过setToolTip()方法为任何QWidget派生类控件设置。例如：

QPushButton *button = new QPushButton("Click Me");
button->setToolTip("This is a button tooltip");

富文本工具提示

工具提示支持HTML格式的富文本，可用于自定义样式或添加图片：

label->setToolTip("<b>Warning:</b> <font color='red'>Required field</font>");

全局工具提示设置

修改应用程序的全局工具提示样式可通过QToolTip类：

QToolTip::setFont(QFont("Arial", 10));
QToolTip::setPalette(QPalette(Qt::lightGray));

延迟显示控制

调整工具提示显示/隐藏的延迟时间（毫秒）：

QToolTip::showText(pos, text, nullptr, QRect(), 2000);  // 立即显示并持续2秒

自定义工具提示窗口

继承QWidget创建完全自定义的工具提示：

class CustomToolTip : public QWidget {// 实现paintEvent和sizeHint等
};
// 使用QHelpEvent或事件过滤器触发显示

禁用工具提示

临时禁用特定控件的工具提示：

widget->setAttribute(Qt::WA_AlwaysShowToolTips, false);

工具提示与状态栏联动

在QMainWindow中，工具提示可同步显示到状态栏：

connect(button, &QPushButton::hovered, [this](){statusBar()->showMessage(button->toolTip());
});

注意：工具提示默认在控件获得焦点时也会显示，可通过Qt::WA_AlwaysShowToolTips属性调整行为。

特点：

• 自动显示黄色背景黑色文字
• 主要用于工具栏按钮和菜单项
• 如果没有显式设置，QAction会使用动作文本作为工具提示

2、状态提示(Status Tips)

状态提示是比工具提示稍长的描述性文本，当鼠标悬停在控件上时显示在状态栏中。

newAction->setStatusTip(tr("Create a new document"));

3、"What’s This?"帮助

"What’s This?"帮助提供了更详细的上下文相关帮助，通常通过点击帮助按钮或按Shift+F1激活。
使用方法：

// 为控件设置"What's This?"帮助
findButton->setWhatsThis(tr("This button initiates a search for the ""text you entered in the search box."));

三、使用QTextBrowser实现简单帮助浏览器

对于更复杂的帮助系统，可以使用QTextBrowser作为简单的帮助浏览器：

// 创建简单的帮助浏览器
QTextBrowser *helpBrowser = new QTextBrowser;
helpBrowser->setSource(QUrl("help/contents.html"));
helpBrowser->show();

特点：

• 支持HTML格式的帮助文档
• 可以显示本地或网络上的帮助内容
• 支持导航历史记录

四、集成Qt Assistant

对于更专业的帮助系统，可以集成Qt Assistant：

// 启动Qt Assistant显示帮助文档
QProcess *assistant = new QProcess;
QStringList args;
args << "-collectionFile" << "myapp.qhc" << "-enableRemoteControl";
assistant->start("assistant", args);// 显示特定页面
QByteArray ba;
ba.append("setSource qthelp://myapp/doc/overview.html\n");
assistant->write(ba);

优势：

• 支持全文搜索
• 提供目录和索引
• 支持多文档集合
• 可定制的外观和行为

五、调用外部浏览器

也可以直接调用系统默认的浏览器显示HTML帮助文档：

// 使用QDesktopServices打开帮助文档
QDesktopServices::openUrl(QUrl("help/contents.html"));// 或者使用QProcess启动特定浏览器
QProcess::startDetached("firefox", QStringList() << "help/contents.html");