Class: QgsMessageLog¶
- class qgis.core.QgsMessageLog¶
Bases:
PyQt5.QtCore.QObject
Interface for logging messages from QGIS in GUI independent way.
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 throughQgsApplication.messageLog()
.QgsMessageLog() Constructor for QgsMessageLog.
Methods
Adds a
message
to the log instance (and creates it if necessary).Signals
Emitted whenever the log receives a
message
.- childEvent(self, QChildEvent)¶
- connectNotify(self, QMetaMethod)¶
- customEvent(self, QEvent)¶
- disconnectNotify(self, QMetaMethod)¶
- isSignalConnected(self, QMetaMethod) bool ¶
- logMessage(message: str, tag: str = '', level: Qgis.MessageLevel = Qgis.MessageLevel.Warning, notifyUser: bool = True)¶
Adds a
message
to the log instance (and creates it if necessary).If
notifyUser
isTrue
, then the message should be brought to the user’s attention by various UI hints. If it isFalse
, the message should appear in logs silently. Note that log viewer implementations may only respect notification hints for certain message levels.- Parameters
message (str) –
tag (str = '') –
level (Qgis.MessageLevel = Qgis.MessageLevel.Warning) –
notifyUser (bool = True) –
- messageReceived¶
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. [signal] messageReceived(self, received: bool) Emitted whenever the log receives a message which is not a Qgis.MessageLevel.Info level message and which has thenotifyUser
flag asTrue
.If
QgsMessageLogNotifyBlocker
objects have been created then this signal may be temporarily suppressed.See also
QgsMessageLogNotifyBlocker
[signal]- Parameters
message (str) –
tag (str) –
level (Qgis.MessageLevel) –
- receivers(self, PYQT_SIGNAL) int ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- timerEvent(self, QTimerEvent)¶