QMessageBox Class

成员函数文档

[explicit] QMessageBox::QMessageBox(QWidget *parent = nullptr)

构造一个无文本、无按钮的application modal 消息框。parent 传递给QDialog 构造函数。

窗口模式可在调用show() 之前通过setWindowModality() 重写。

在 macOS 上，如果希望消息框显示为其parent 的Qt::Sheet ，请将消息框的window modality 设置为Qt::WindowModal 或使用open() 。否则，消息框将是一个标准对话框。

另请参阅 setWindowTitle()、setText()、setIcon()、setStandardButtons() 和setWindowModality()。

QMessageBox::QMessageBox(QMessageBox::Icon icon, const QString &title, const QString &text, QMessageBox::StandardButtons buttons = NoButton, QWidget *parent = nullptr, Qt::WindowFlags f = Qt::Dialog | Qt::MSWindowsFixedSizeDialogHint)

使用给定的icon,title,text 和标准buttons 构建application modal 消息框。可随时使用addButton() 添加标准或自定义按钮。parent 和f 参数传递给QDialog 构造函数。

窗口模式可在调用show() 之前通过setWindowModality() 进行重写。

在 macOS 上，如果parent 不是nullptr ，且您希望消息框显示为该父对象的Qt::Sheet ，请将消息框的window modality 设置为Qt::WindowModal （默认）。否则，消息框将是一个标准对话框。

另请参阅 setWindowTitle(),setText(),setIcon(),setStandardButtons() 和setWindowModality().

[virtual noexcept] QMessageBox::~QMessageBox()

销毁消息框。

[static] void QMessageBox::about(QWidget *parent, const QString &title, const QString &text)

显示一个简单的关于框，标题为title ，文本为text 。关于框的父级是parent 。

about() 会在四个位置查找合适的图标：

1. 如果存在，它会首选parent->icon() 。
2. 如果不存在，它会尝试包含parent 的顶层 widget。
3. 如果失败，它会尝试active window.
4. 最后，它会使用 "信息 "图标。

关于框有一个标有 "确定 "的按钮。

在 macOS 上，"关于 "框以无模式窗口的形式弹出；而在其他平台上，它目前是应用程序模式。

另请参阅 QWidget::windowIcon() 和QApplication::activeWindow()。

[static] void QMessageBox::aboutQt(QWidget *parent, const QString &title = QString())

显示一个有关 Qt 的简单消息框，内容为给定的title ，并以parent 为中心（如果parent 不是nullptr ）。信息包括应用程序使用的 Qt 版本号。

如菜单示例所示，这对于将其纳入应用程序的Help 菜单非常有用。

QApplication 在 MacOS 上，aboutQt 作为槽提供了这一功能。

在 macOS 上，aboutQt 框以无模式窗口的形式弹出；而在其他平台上，它目前是应用程序模式。

另请参见 QApplication::aboutQt()。

void QMessageBox::addButton(QAbstractButton *button, QMessageBox::ButtonRole role)

将给定的button 与指定的role 一起添加到消息框中。

另请参阅 removeButton()、button() 和setStandardButtons()。

QPushButton *QMessageBox::addButton(QMessageBox::StandardButton button)

这是一个重载函数。

如果有效，则在消息框中添加标准button ，并返回按钮。

另请参阅 setStandardButtons() 。

QPushButton *QMessageBox::addButton(const QString &text, QMessageBox::ButtonRole role)

这是一个重载函数。

使用给定的text 创建一个按钮，并将其添加到指定role 的消息框中，然后返回。

QAbstractButton *QMessageBox::button(QMessageBox::StandardButton which) const

返回与标准按钮which 相对应的指针，如果此消息框中不存在标准按钮，则返回nullptr 。

另请参阅 standardButtons 和standardButton()。

[signal] void QMessageBox::buttonClicked(QAbstractButton *button)

每当QMessageBox 中的按钮被点击时，就会发出该信号。被点击的按钮会在button 中返回。

QMessageBox::ButtonRole QMessageBox::buttonRole(QAbstractButton *button) const

返回指定button 的按钮角色。如果button 是nullptr 或尚未添加到消息框，则此函数返回InvalidRole 。

另请参阅 buttons() 和addButton()。

QList<QAbstractButton *> QMessageBox::buttons() const

返回已添加到消息框中的所有按钮的列表。

另请参阅 buttonRole()、addButton() 和removeButton()。

[override virtual protected] void QMessageBox::changeEvent(QEvent *ev)

重实现：QWidget::changeEvent(QEvent *event).

QCheckBox *QMessageBox::checkBox() const

返回对话框上显示的复选框。如果未设置复选框，则返回nullptr 。

另请参阅 setCheckBox()。

QAbstractButton *QMessageBox::clickedButton() const

返回用户点击的按钮，如果用户点击了Esc 键且未设置escape button ，则返回nullptr 。

如果exec() 尚未被调用，则返回 nullptr。

示例

QMessageBox messageBox(this);
QAbstractButton *disconnectButton =
      messageBox.addButton(tr("Disconnect"), QMessageBox::ActionRole);
...
messageBox.exec();
if (messageBox.clickedButton() == disconnectButton) {
    ...
}

另请参阅 standardButton() 和button()。

[override virtual protected] void QMessageBox::closeEvent(QCloseEvent *e)

重实现：QDialog::closeEvent(QCloseEvent *e)。

[static] QMessageBox::StandardButton QMessageBox::critical(QWidget *parent, const QString &title, const QString &text, QMessageBox::StandardButtons buttons = Ok, QMessageBox::StandardButton defaultButton = NoButton)

在指定的parent widget 前面用给定的title 和text 打开一个关键消息框。

buttons defaultButton 指定按下 时使用的按钮。 必须是 中给定的按钮。如果 是 ， 会自动选择一个合适的默认按钮。Enter defaultButton buttons defaultButton QMessageBox::NoButton QMessageBox

返回被点击的标准按钮的标识。如果Esc 被按下，则返回escape button 。

消息框是application modal 对话框。

另请参阅 question()、warning() 和information()。

QPushButton *QMessageBox::defaultButton() const

返回信息框default button 的按钮。如果未设置默认按钮，则返回 nullptr。

另请参阅 setDefaultButton()、addButton() 和QPushButton::setDefault()。

QAbstractButton *QMessageBox::escapeButton() const

返回按下 Escape 键时激活的按钮。

默认情况下，QMessageBox 会按以下方式自动检测逃逸按钮：

1. 如果只有一个按钮，则将其作为逃逸按钮。
2. 如果有一个Cancel 按钮，则将其作为 Escape 按钮。
3. 仅在 macOS 上，如果正好有一个角色为QMessageBox::RejectRole 的按钮，则将其作为转义按钮。

如果无法自动检测到逃逸按钮，则按Esc 没有任何作用。

另请参阅 setEscapeButton() 和addButton()。

[override virtual protected] bool QMessageBox::event(QEvent *e)

重实现：QWidget::event(QEvent *event).

[override virtual slot] int QMessageBox::exec()

重新实现：QDialog::exec().

将消息框显示为modal dialog ，阻塞直到用户关闭。

当QMessageBox 与标准按钮一起使用时，该函数会返回一个StandardButton 值，指示被点击的标准按钮。当QMessageBox 与自定义按钮一起使用时，该函数将返回一个不透明值；请使用clickedButton() 来确定哪个按钮被点击。

在点击按钮或使用窗口系统提供的机制关闭对话框之前，用户无法与同一应用程序中的任何其他窗口交互。

另请参阅 show() 和result()。

[static] QMessageBox::StandardButton QMessageBox::information(QWidget *parent, const QString &title, const QString &text, QMessageBox::StandardButtons buttons = Ok, QMessageBox::StandardButton defaultButton = NoButton)

在指定的parent widget 前面用给定的title 和text 打开一个信息消息框。

buttons defaultButton 指定按下 时使用的按钮。 必须是 中给定的按钮。如果 是 ， 会自动选择一个合适的默认按钮。Enter defaultButton buttons defaultButton QMessageBox::NoButton QMessageBox

返回被点击的标准按钮的标识。如果Esc 被按下，则返回escape button 。

消息框是application modal 对话框。

另请参阅 question()、warning() 和critical()。

[override virtual protected] void QMessageBox::keyPressEvent(QKeyEvent *e)

重实现：QDialog::keyPressEvent(QKeyEvent *e)。

void QMessageBox::open(QObject *receiver, const char *member)

打开对话框，并将其finished() 或buttonClicked() 信号连接到receiver 和member 指定的槽。如果member 中的槽的第一个参数是指针，则连接到buttonClicked()，否则连接到finished()。

关闭对话框时，信号将从插槽中断开。

[static] QMessageBox::StandardButton QMessageBox::question(QWidget *parent, const QString &title, const QString &text, QMessageBox::StandardButtons buttons = StandardButtons(Yes | No), QMessageBox::StandardButton defaultButton = NoButton)

在指定的parent widget 前面用给定的title 和text 打开一个问题消息框。

buttons defaultButton 指定按下 时使用的按钮。 必须是 中给定的按钮。如果 是 ， 会自动选择一个合适的默认按钮。Enter defaultButton buttons defaultButton QMessageBox::NoButton QMessageBox

返回被点击的标准按钮的标识。如果Esc 被按下，则返回escape button 。

消息框是application modal 对话框。

另请参阅 information()、warning() 和critical()。

void QMessageBox::removeButton(QAbstractButton *button)

从按钮框中删除button ，但不删除它。

另请参阅 addButton() 和setStandardButtons()。

[override virtual protected] void QMessageBox::resizeEvent(QResizeEvent *event)

重实现：QDialog::resizeEvent(QResizeEvent *)。

void QMessageBox::setCheckBox(QCheckBox *cb)

设置消息对话框cb 中的复选框。消息框拥有复选框的所有权。参数cb 可用于nullptr 从消息框中删除现有复选框。

另请参阅 checkBox()。

void QMessageBox::setDefaultButton(QMessageBox::StandardButton button)

将消息框的default button 设置为button 。

另请参阅 defaultButton()、addButton() 和QPushButton::setDefault()。

void QMessageBox::setDefaultButton(QPushButton *button)

将消息框的default button 设置为button 。

另请参阅 addButton() 和QPushButton::setDefault()。

void QMessageBox::setEscapeButton(QAbstractButton *button)

将Escape 键按下时激活的按钮设置为button 。

另请参阅 escapeButton()、addButton() 和clickedButton()。

void QMessageBox::setEscapeButton(QMessageBox::StandardButton button)

将按Escape 键时激活的按钮设置为button 。

另请参阅 addButton() 和clickedButton()。

[since 6.6] void QMessageBox::setOption(QMessageBox::Option option, bool on = true)

如果on 为 true，则设置option 为启用状态；否则，清除给定的option 。

应在显示对话框之前设置选项（尤其是Option::DontUseNativeDialog 选项）。

在对话框可见时设置选项并不能保证立即对对话框产生影响。

在更改其他属性后设置选项可能会导致这些值无效。

此函数在 Qt 6.6 中引入。

另请参阅 options 和testOption()。

void QMessageBox::setWindowModality(Qt::WindowModality windowModality)

该函数阴影QWidget::setWindowModality().

将消息框的模式设置为windowModality 。

在 macOS 上，如果模式设置为Qt::WindowModal 且消息框有父对象，则消息框将是Qt::Sheet ，否则消息框将是标准对话框。

void QMessageBox::setWindowTitle(const QString &title)

该函数阴影QWidget::setWindowTitle().

将消息框的标题设置为title 。在 macOS 上，窗口标题将被忽略（根据 macOS 指南的要求）。

[override virtual protected] void QMessageBox::showEvent(QShowEvent *e)

重实现：QDialog::showEvent(QShowEvent *event).

QMessageBox::StandardButton QMessageBox::standardButton(QAbstractButton *button) const

返回与给定的button 对应的标准按钮枚举值，如果给定的button 不是标准按钮，则返回NoButton 。

另请参阅 button() 和standardButtons()。

[since 6.6] bool QMessageBox::testOption(QMessageBox::Option option) const

如果给定的option 已启用，则返回true ；否则返回 false。

此函数在 Qt 6.6 中引入。

另请参阅 options 和setOption()。

[static] QMessageBox::StandardButton QMessageBox::warning(QWidget *parent, const QString &title, const QString &text, QMessageBox::StandardButtons buttons = Ok, QMessageBox::StandardButton defaultButton = NoButton)

在指定的parent widget 前面用给定的title 和text 打开一个警告消息框。

标准buttons 会添加到消息框中。defaultButton 指定Enter 被按下时使用的按钮。defaultButton 必须是buttons 中给定的按钮。如果defaultButton 是QMessageBox::NoButton ，QMessageBox 会自动选择一个合适的默认按钮。

返回被点击的标准按钮的标识。如果Esc 被按下，则返回escape button 。

消息框是application modal 对话框。

另请参阅 question()、information() 和critical()。