Class: QgsMessageOutput

Interface for showing messages from QGIS in GUI independent way.

This class provides abstraction of a dialog for showing output to the user. By default QgsMessageConsoleOutput will be used if not overridden with other message output creator function.

QGIS application uses QgsMessageView class for displaying a dialog to the user.

Object deletes itself when it’s not needed anymore. Children should use signal destroyed() to notify the deletion

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: appendMessage(), setMessage(), setTitle(), showMessage()

Class Hierarchy

Subclasses

QgsMessageOutputConsole	Default implementation of message output interface.
QgsMessageViewer	A generic message view for displaying QGIS messages.

Abstract Methods

appendMessage	message to be appended to the current text
setMessage	Sets message, it won't be displayed until
setTitle	Sets title for the messages
showMessage	display the message to the user and deletes itself

Static Methods

createMessageOutput

function that returns new class derived from QgsMessageOutput (don't forget to delete it then if showMessage(bool) is not used

Attributes

MessageHtml
MessageText

class qgis.core.QgsMessageOutput

Bases: object

MessageHtml = 1

MessageText = 0

class MessageType

Bases: int

abstract appendMessage(self, message: str | None)

message to be appended to the current text

Parameters:

message (Optional[str])

static createMessageOutput() → QgsMessageOutput | None

function that returns new class derived from QgsMessageOutput (don’t forget to delete it then if showMessage(bool) is not used

Return type:

Optional[QgsMessageOutput]

static createMessageOutput(bool) deletes the instance)

abstract setMessage(self, message: str | None, msgType: QgsMessageOutput.MessageType)

Sets message, it won’t be displayed until

Parameters:

• message (Optional[str])

• msgType (QgsMessageOutput.MessageType)

abstract setTitle(self, title: str | None)

Sets title for the messages

Parameters:

title (Optional[str])

abstract showMessage(self, blocking: bool = True)

display the message to the user and deletes itself

Parameters:

blocking (bool = True)

abstract showMessage(title: str | None, message: str | None, msgType: QgsMessageOutput.MessageType)

Display the blocking message to the user.

Parameters:

• title (Optional[str])

• message (Optional[str])

• msgType (QgsMessageOutput.MessageType)