Subgroup: Message
Class: QgsMessageLog¶
-
class
qgis.core.
QgsMessageLog
¶ Bases:
PyQt5.QtCore.QObject
Constructor for QgsMessageLog.
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 through
QgsApplication.messageLog()
Methods
childEvent
connectNotify
customEvent
disconnectNotify
isSignalConnected
logMessage
Adds a message
to the log instance (and creates it if necessary).receivers
sender
senderSignalIndex
timerEvent
Signals
messageReceived
Emitted whenever the log receives a message
.Attributes
-
childEvent
()¶
-
connectNotify
()¶
-
customEvent
()¶
-
disconnectNotify
()¶
-
isSignalConnected
()¶
-
logMessage
(message: str, tag: str = '', level: Qgis.MessageLevel = Qgis.Warning, notifyUser: bool = 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.
-
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] Emitted whenever the log receives a message which is not a Qgis.Info level message and which has thenotifyUser
flag as true.If QgsMessageLogNotifyBlocker objects have been created then this signal may be temporarily suppressed.
See also
QgsMessageLogNotifyBlocker
[signal]
-
receivers
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
timerEvent
()¶
-