MessageDialog QML Type

A native message dialog. More...

• List of all members, including inherited members

Properties

• buttons : flags
• detailedText : string
• informativeText : string
• text : string

Signals

• abortClicked()
• applyClicked()
• cancelClicked()
• clicked(button)
• closeClicked()
• discardClicked()
• helpClicked()
• ignoreClicked()
• noClicked()
• noToAllClicked()
• okClicked()
• openClicked()
• resetClicked()
• restoreDefaultsClicked()
• retryClicked()
• saveAllClicked()
• saveClicked()
• yesClicked()
• yesToAllClicked()

Detailed Description

The MessageDialog type provides a QML API for native platform message dialogs.

A message dialog is used to inform the user, or ask the user a question. A message dialog displays a primary text to alert the user to a situation, an informative text to further explain the alert or to ask the user a question, and an optional detailed text to provide even more data if the user requests it. A message box can also display a configurable set of buttons for accepting a user response.

To show a message dialog, construct an instance of MessageDialog, set the desired properties, and call open().

 MessageDialog {
     buttons: MessageDialog.Ok
     text: "The document has been modified."
 }

The user must click the OK button to dismiss the message dialog. A modal message dialog blocks the rest of the GUI until the message is dismissed.

A more elaborate approach than just alerting the user to an event is to also ask the user what to do about it. Store the question in the informative text property, and specify the buttons property to the set of buttons you want as the set of user responses. The buttons are specified by combining values using the bitwise OR operator. The display order for the buttons is platform dependent.

 MessageDialog {
     text: "The document has been modified."
     informativeText: "Do you want to save your changes?"
     buttons: MessageDialog.Ok | MessageDialog.Cancel

     onAccepted: document.save()
 }

The clicked() signal passes the information of which button was clicked.

A native platform message dialog is currently available on the following platforms:

• Android
• iOS
• macOS

The Qt Labs Platform module uses Qt Widgets as a fallback on platforms that do not have a native implementation available. Therefore, applications that use types from the Qt Labs Platform module should link to QtWidgets and use QApplication instead of QGuiApplication.

To link against the QtWidgets library, add the following to your qmake project file:

 QT += widgets

Create an instance of QApplication in main():

 #include <QApplication>
 #include <QQmlApplicationEngine>

 int main(int argc, char *argv[])
 {
     QApplication app(argc, argv);
     QQmlApplicationEngine engine;
     engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
     return app.exec();
 }

Property Documentation

Signal Documentation