QErrorMessage#

The QErrorMessage class provides an error message display dialog. More…

Inheritance diagram of PySide6.QtWidgets.QErrorMessage

Synopsis#

Slots#

Static functions#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

An error message widget consists of a text label and a checkbox. The checkbox lets the user control whether the same error message will be displayed again in the future, typically displaying the text, “Show this message again” translated into the appropriate local language.

For production applications, the class can be used to display messages which the user only needs to see once. To use QErrorMessage like this, you create the dialog in the usual way, and show it by calling the showMessage() slot or connecting signals to it.

The static qtHandler() function installs a message handler using qInstallMessageHandler() and creates a QErrorMessage that displays qDebug(), qWarning() and qFatal() messages. This is most useful in environments where no console is available to display warnings and error messages.

In both cases QErrorMessage will queue pending messages and display them in order, with each new message being shown as soon as the user has accepted the previous message. Once the user has specified that a message is not to be shown again it is automatically skipped, and the dialog will show the next appropriate message in the queue.

The Standard Dialogs example shows how to use QErrorMessage as well as other built-in Qt dialogs.

../../_images/qerrormessage.png

See also

QMessageBox showMessage() Standard Dialogs Example

class PySide6.QtWidgets.QErrorMessage([parent=None])#
Parameters:

parent – PySide6.QtWidgets.QWidget

Constructs and installs an error handler window with the given parent.

The default window modality of the dialog depends on the platform. The window modality can be overridden via setWindowModality() before calling showMessage() .

static PySide6.QtWidgets.QErrorMessage.qtHandler()#
Return type:

PySide6.QtWidgets.QErrorMessage

Returns a pointer to a QErrorMessage object that outputs the default Qt messages. This function creates such an object, if there isn’t one already.

The object will only output log messages of QLoggingCategory::defaultCategory().

The object will forward all messages to the original message handler.

See also

qInstallMessageHandler

PySide6.QtWidgets.QErrorMessage.showMessage(message)#
Parameters:

message – str

Shows the given message, message, and returns immediately. If the user has requested for the message not to be shown again, this function does nothing.

Normally, the message is displayed immediately. However, if there are pending messages, it will be queued to be displayed later.

PySide6.QtWidgets.QErrorMessage.showMessage(message, type)
Parameters:

  • message – str

  • type – str

This is an overloaded function.

Shows the given message, message, and returns immediately. If the user has requested for messages of type, type, not to be shown again, this function does nothing.

Normally, the message is displayed immediately. However, if there are pending messages, it will be queued to be displayed later.

See also

showMessage()