QgsMessageLog class

Interface for logging messages from QGIS in GUI independent way.

Contents

This class provides abstraction of a tabbed window for showing messages to the user. By default QgsMessageLogOutput will be used if not overridden with another message log creator function.

QGIS application uses QgsMessageLog class for logging messages in a dockable window for the user.

QgsMessageLog is not usually directly created, but rather accessed through QgsApplication::messageLog().

Public static functions

static void logMessage(const QString& message, const QString& tag = QString(), Qgis::MessageLevel level = Qgis::Warning, bool notifyUser = true)
Adds a message to the log instance (and creates it if necessary).

Constructors, destructors, conversion operators

QgsMessageLog() defaulted
Constructor for QgsMessageLog.

Signals

void messageReceived(const QString& message, const QString& tag, Qgis::MessageLevel level)
Emitted whenever the log receives a message.
void messageReceived(bool received)
Emitted whenever the log receives a message which is not a Qgis::Info level message and which has the notifyUser flag as true.

Function documentation

static void QgsMessageLog::logMessage(const QString& message, const QString& tag = QString(), Qgis::MessageLevel level = Qgis::Warning, bool notifyUser = true)

Adds a message to the log instance (and creates it if necessary).

If notifyUser is true, then the message should be brought to the user's attention by various UI hints. If it is false, the message should appear in logs silently. Note that log viewer implementations may only respect notification hints for certain message levels.

void QgsMessageLog::messageReceived(const QString& message, const QString& tag, Qgis::MessageLevel level) signal

Emitted whenever the log receives a message.

This signal is emitted for all messages received by the log, regardless of the notifyUser flag's value for the message.

void QgsMessageLog::messageReceived(bool received) signal

Emitted whenever the log receives a message which is not a Qgis::Info level message and which has the notifyUser flag as true.

If QgsMessageLogNotifyBlocker objects have been created then this signal may be temporarily suppressed.