1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmessagelog.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py 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();
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 :py:class:`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.py again *
************************************************************************/
|
