Class: 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()
.
Class Hierarchy¶
Base classes¶
Static Methods
Adds a message to the log instance (and creates it if necessary). |
Signals
Emitted whenever the log receives a message which is not a |
- class qgis.core.QgsMessageLog[source]¶
Bases:
QObject
- static logMessage(message: str | None, tag: str | None = '', level: Qgis.MessageLevel = Qgis.MessageLevel.Warning, notifyUser: bool = True, file: str | None = __builtin_FILE(), function: str | None = __builtin_FUNCTION(), line: int = __builtin_LINE())[source]¶
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 (Optional[str])
tag (Optional[str] = '')
level (Qgis.MessageLevel = Qgis.MessageLevel.Warning)
notifyUser (bool = True)
file (Optional[str] = __builtin_FILE())
function (Optional[str] = __builtin_FUNCTION())
line (int = __builtin_LINE())
- signal messageReceived(received: bool)[source]¶
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
- Parameters:
received (bool)