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
|
/** \ingroup core
* 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 QgsMessageConsoleOutput will be used if not overridden with other
* message output creator function.
* QGIS application uses QgsMessageView class for displaying a dialog to the user.
* Object deletes itself when it's not needed anymore. Children should use
* signal destroyed() to notify the deletion
*/
class QgsMessageOutput
{
%TypeHeaderCode
#include <qgsmessageoutput.h>
%End
public:
//! message can be in plain text or in html format
enum MessageType { MessageText, MessageHtml };
//! virtual destructor
virtual ~QgsMessageOutput();
//! set message, it won't be displayed until
virtual void setMessage( const QString& message, MessageType msgType ) = 0;
//! message to be appended to the current text
virtual void appendMessage( const QString& message ) = 0;
//! set title for the messages
virtual void setTitle( const QString& title ) = 0;
//! display the message to the user
virtual void showMessage( bool blocking = true ) = 0;
/** Display the blocking message to the user.
* @note added in 2.10
*/
static void showMessage( const QString& title, const QString& message, MessageType msgType );
//! sets function that will be used to create message output
//! @note not available in python bindings
// TODO: implementation where python class could be passed
// static void setMessageOutputCreator(MESSAGE_OUTPUT_CREATOR f);
//! 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)
static QgsMessageOutput* createMessageOutput();
};
/**
\brief 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.
*/
class QgsMessageOutputConsole : QObject, QgsMessageOutput
{
%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 );
//! sends the message to the standard output
virtual void showMessage( bool blocking = true );
signals:
//! signals that object will be destroyed and shouldn't be used anymore
void destroyed();
};
|
