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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmessageoutput.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsMessageOutput
{
%Docstring(signature="appended")
Interface for showing messages from QGIS in GUI independent way.
This class provides abstraction of a dialog for showing output to the
user. By default :py:class:`QgsMessageConsoleOutput` will be used if not
overridden with other message output creator function.
QGIS application uses :py:class:`QgsMessageView` class for displaying a
dialog to the user.
Object deletes itself when it's not needed anymore. Children should use
signal :py:func:`~destroyed` to notify the deletion
%End
%TypeHeaderCode
#include "qgsmessageoutput.h"
%End
public:
enum MessageType /BaseType=IntEnum/ { MessageText, MessageHtml };
virtual ~QgsMessageOutput();
virtual void setMessage( const QString &message, MessageType msgType ) = 0;
%Docstring
Sets message, it won't be displayed until
%End
virtual void appendMessage( const QString &message ) = 0;
%Docstring
message to be appended to the current text
%End
virtual void setTitle( const QString &title ) = 0;
%Docstring
Sets title for the messages
%End
virtual void showMessage( bool blocking = true ) = 0;
%Docstring
display the message to the user and deletes itself
%End
static void showMessage( const QString &title, const QString &message, MessageType msgType );
%Docstring
Display the blocking message to the user.
%End
static QgsMessageOutput *createMessageOutput();
%Docstring
function that returns new class derived from QgsMessageOutput (don't
forget to delete it then if showMessage(bool) is not used
showMessage(bool) deletes the instance)
%End
};
class QgsMessageOutputConsole : QObject, QgsMessageOutput
{
%Docstring(signature="appended")
Default implementation of message output interface
This class outputs messages to the standard output. Therefore it might
be the right choice for apps without GUI.
%End
%TypeHeaderCode
#include "qgsmessageoutput.h"
%End
public:
QgsMessageOutputConsole();
virtual void setMessage( const QString &message, MessageType msgType );
virtual void appendMessage( const QString &message );
virtual void setTitle( const QString &title );
virtual void showMessage( bool blocking = true );
%Docstring
sends the message to the standard output
%End
signals:
void destroyed();
%Docstring
signals that object will be destroyed and shouldn't be used anymore
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmessageoutput.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
