AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update QMessageBox window modality documentation

Browse Source 
Unlike a regular QWidget or QDialog, a QMessageBox is initialized
to be application modal by default. Make sure we document this quirk
for both of the QMessageBox constructors, and tell the user that it's
possible to override this default.

Add a note about open() and exec() coming with their own set of
semantics when it comes to window modality.

Change-Id: I37a429633cefec94f790d3b0b30d0a8995ef60ae
Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
This commit is contained in:
Tor Arne Vestbø 2022-11-14 18:42:48 +01:00
parent bd7fa4a537
commit 91170aba0f
1 changed files with 16 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/widgets/dialogs/qmessagebox.cpp
View File

@ -780,14 +780,21 @@ void QMessageBoxPrivate::_q_clicked(QPlatformDialogHelper::StandardButton button
*/
/*!
Constructs a message box with no text and no buttons. \a parent is
passed to the QDialog constructor.
Constructs an \l{Qt::ApplicationModal} {application modal} message box with no text and no buttons.
\a parent is passed to the QDialog constructor.
The window modality can be overridden via setWindowModality() before calling show().
\note Using open() or exec() to show the message box affects the window modality.
Please see the detailed documentation for each function for more information.
On \macos, if you want your message box to appear
as a Qt::Sheet of its \a parent, set the message box's
\l{setWindowModality()} {window modality} to Qt::WindowModal or use open().
Otherwise, the message box will be a standard dialog.
\sa setWindowTitle(), setText(), setIcon(), setStandardButtons(), setWindowModality()
*/
QMessageBox::QMessageBox(QWidget *parent)
: QDialog(*new QMessageBoxPrivate, parent, Qt::MSWindowsFixedSizeDialogHint | Qt::WindowTitleHint | Qt::WindowSystemMenuHint | Qt::WindowCloseButtonHint)
@ -797,20 +804,22 @@ QMessageBox::QMessageBox(QWidget *parent)
}
/*!
Constructs a message box with the given \a icon, \a title, \a
text, and standard \a buttons. Standard or custom buttons can be
Constructs an \l{Qt::ApplicationModal} {application modal} message box with the given \a icon,
\a title, \a text, and standard \a buttons. Standard or custom buttons can be
added at any time using addButton(). The \a parent and \a f
arguments are passed to the QDialog constructor.
The message box is an \l{Qt::ApplicationModal} {application modal}
dialog box.
The window modality can be overridden via setWindowModality() before calling show().
\note Using open() or exec() to show the message box affects the window modality.
Please see the detailed documentation for each function for more information.
On \macos, if \a parent is not \nullptr and you want your message box
to appear as a Qt::Sheet of that parent, set the message box's
\l{setWindowModality()} {window modality} to Qt::WindowModal
(default). Otherwise, the message box will be a standard dialog.
\sa setWindowTitle(), setText(), setIcon(), setStandardButtons()
\sa setWindowTitle(), setText(), setIcon(), setStandardButtons(), setWindowModality()
*/
QMessageBox::QMessageBox(Icon icon, const QString &title, const QString &text,
StandardButtons buttons, QWidget *parent,