QMessageBox Class

成员函数文档

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

创建一个不包含文本和按钮的application modal 消息框。将parent 作为参数传递给QDialog 构造函数。

可以在调用show() 之前，通过setWindowModality() 重写窗口的模态性。

parent在 macOS 上，若希望消息框以“非模态对话框”（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)

创建一个application modal 消息框，其中包含给定的icon 、title 、text 以及标准的buttons 。可随时使用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 的顶级小部件中获取。
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 对话框以非模态窗口的形式弹出；在其他平台上，它目前是应用程序模态的。

另请参阅 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 控件前方，打开一个包含给定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

返回按下 Esc 键时被激活的按钮。

默认情况下，QMessageBox 会按以下方式尝试自动检测 Esc 键：

1. 如果只有一个按钮，则将其设为“Escape”按钮。
2. 如果存在一个Cancel 按钮，则将其设为Escape按钮。
3. 仅在 macOS 上，如果恰好有一个按钮具有“QMessageBox::RejectRole ”角色，则将其设为“escape”按钮。

当无法自动检测到退出按钮时，按下 `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 控件前方，打开一个包含给定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 控件前方，打开一个包含给定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 控件前方，打开一个包含给定title 和text 的警告消息框。

消息框中会自动包含标准buttons 。defaultButton 指定了按下Enter 时使用的按钮。defaultButton 必须指向在buttons 中指定的按钮。如果defaultButton 为QMessageBox::NoButton ，QMessageBox 会自动选择一个合适的默认值。

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

该消息框是一个application modal 对话框。

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