mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
157 lines
4.9 KiB
Plaintext
157 lines
4.9 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsmessagelog.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsMessageLog : QObject
|
|
{
|
|
%Docstring(signature="appended")
|
|
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 :py:class:`QgsMessageLogOutput` will be used if not overridden with another
|
|
message log creator function.
|
|
|
|
QGIS application uses :py:class:`QgsMessageLog` class for logging messages in a dockable
|
|
window for the user.
|
|
|
|
:py:class:`QgsMessageLog` is not usually directly created, but rather accessed through
|
|
:py:func:`QgsApplication.messageLog()`.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmessagelog.h"
|
|
%End
|
|
public:
|
|
|
|
QgsMessageLog();
|
|
%Docstring
|
|
Constructor for QgsMessageLog.
|
|
%End
|
|
|
|
static void logMessage( const QString &message, const QString &tag = QString(), Qgis::MessageLevel level = Qgis::MessageLevel::Warning, bool notifyUser = true );
|
|
%Docstring
|
|
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.
|
|
%End
|
|
|
|
signals:
|
|
|
|
void messageReceived( const QString &message, const QString &tag, Qgis::MessageLevel level );
|
|
%Docstring
|
|
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.
|
|
%End
|
|
|
|
|
|
void messageReceived( bool received );
|
|
%Docstring
|
|
Emitted whenever the log receives a message which is not a :py:class:`Qgis`.MessageLevel.Info level message
|
|
and which has the ``notifyUser`` flag as ``True``.
|
|
|
|
If :py:class:`QgsMessageLogNotifyBlocker` objects have been created then this signal may be
|
|
temporarily suppressed.
|
|
|
|
.. seealso:: :py:class:`QgsMessageLogNotifyBlocker`
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsMessageLogNotifyBlocker
|
|
{
|
|
%Docstring(signature="appended")
|
|
Temporarily blocks the application QgsMessageLog (see :py:func:`QgsApplication.messageLog()`) from emitting the messageReceived( bool )
|
|
signal for the lifetime of the object.
|
|
|
|
Using this blocker allows messages to be logged without causing user interface hints flagging message log
|
|
errors to be created.
|
|
|
|
:py:class:`QgsMessageLogNotifyBlocker` supports "stacked" blocking, so two :py:class:`QgsMessageLogNotifyBlocker` created
|
|
will both need to be destroyed before the messageReceived( bool ) signal is emitted again.
|
|
|
|
.. versionadded:: 3.2
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmessagelog.h"
|
|
%End
|
|
public:
|
|
|
|
QgsMessageLogNotifyBlocker();
|
|
%Docstring
|
|
Constructor for QgsMessageLogNotifyBlocker.
|
|
|
|
This will block the log from emitting the messageReceived( bool ) signal for the lifetime of this object.
|
|
%End
|
|
|
|
|
|
|
|
~QgsMessageLogNotifyBlocker();
|
|
|
|
private:
|
|
QgsMessageLogNotifyBlocker( const QgsMessageLogNotifyBlocker &other );
|
|
};
|
|
|
|
class QgsMessageLogConsole : QObject
|
|
{
|
|
%Docstring(signature="appended")
|
|
Default implementation of message logging interface
|
|
|
|
This class outputs log messages to the standard error. Therefore it might
|
|
be the right choice for applications without GUI.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmessagelog.h"
|
|
%End
|
|
public:
|
|
|
|
QgsMessageLogConsole();
|
|
%Docstring
|
|
Constructor for QgsMessageLogConsole.
|
|
%End
|
|
|
|
protected:
|
|
|
|
QString formatLogMessage( const QString &message, const QString &tag, Qgis::MessageLevel level = Qgis::MessageLevel::Info ) const;
|
|
%Docstring
|
|
Formats a log message. Used by child classes.
|
|
|
|
:param message: the message to format
|
|
:param tag: the tag of the message
|
|
:param level: the log level of the message
|
|
|
|
.. versionadded:: 3.4
|
|
%End
|
|
|
|
public slots:
|
|
|
|
virtual void logMessage( const QString &message, const QString &tag, Qgis::MessageLevel level );
|
|
%Docstring
|
|
Logs a message to stderr.
|
|
|
|
:param message: the message to format
|
|
:param tag: the tag of the message
|
|
:param level: the log level of the message
|
|
%End
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsmessagelog.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|