-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgserror.sip
141 lines (118 loc) · 3.49 KB
/
qgserror.sip
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
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgserror.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsErrorMessage
{
%Docstring
QgsErrorMessage represents single error message.
%End
%TypeHeaderCode
#include "qgserror.h"
%End
public:
enum Format
{
Text,
Html
};
QgsErrorMessage();
QgsErrorMessage( const QString &message, const QString &tag = QString(), const QString &file = QString(), const QString &function = QString(), int line = 0 );
%Docstring
Constructor.
\param message error message string
\param tag error label, for example GDAL, GDAL Provider, Raster layer
\param file the file where error was created
\param function the function where error was created
\param line the line where error was created
%End
QString message() const;
%Docstring
:rtype: str
%End
QString tag() const;
%Docstring
:rtype: str
%End
QString file() const;
%Docstring
:rtype: str
%End
QString function() const;
%Docstring
:rtype: str
%End
int line() const;
%Docstring
:rtype: int
%End
};
class QgsError
{
%Docstring
QgsError is container for error messages (report). It may contain chain
(sort of traceback) of error messages (e.g. GDAL - provider - layer).
Higher level messages are appended at the end.
%End
%TypeHeaderCode
#include "qgserror.h"
%End
public:
QgsError();
QgsError( const QString &message, const QString &tag );
%Docstring
Constructor with single message.
\param message error message
\param tag short description, e.g. GDAL, Provider, Layer
%End
void append( const QString &message, const QString &tag );
%Docstring
Append new error message.
\param message error message string
\param tag error label, for example GDAL, GDAL Provider, Raster layer
%End
void append( const QgsErrorMessage &message );
%Docstring
Append new error message.
\param message error message
%End
bool isEmpty() const;
%Docstring
Test if any error is set.
:return: true if contains error
:rtype: bool
%End
QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const;
%Docstring
Full error messages description
\param format output format
:return: error report
:rtype: str
%End
QString summary() const;
%Docstring
Short error description, usually the first error in chain, the real error.
:return: error description
:rtype: str
%End
void clear();
%Docstring
Clear error messages
%End
const QList<QgsErrorMessage> messageList();
%Docstring
messageList return the list of current error messages
:return: current list of error messages
:rtype: list of QgsErrorMessage
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgserror.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/