File: qgserror.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (140 lines) | stat: -rw-r--r-- 3,614 bytes parent folder | download | duplicates (6)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgserror.h                                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsErrorMessage
{
%Docstring(signature="appended")
:py:class:`QgsErrorMessage` represents single error message.
%End

%TypeHeaderCode
#include "qgserror.h"
%End
  public:
    enum Format /BaseType=IntEnum/
    {
      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;
    QString tag() const;
    QString file() const;
    QString function() const;
    int line() const;

};

class QgsError
{
%Docstring(signature="appended")
A container for error messages.

It may contain a chain (e.g. a 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 no error is set.

:return: ``False`` if contains error
%End

    QString message( QgsErrorMessage::Format format = QgsErrorMessage::Html ) const;
%Docstring
Full error messages description

:param format: output format

:return: error report
%End

    QString summary() const;
%Docstring
Short error description, usually the first error in chain, the real
error.

:return: error description
%End

    void clear();
%Docstring
Clear error messages
%End

    QList<QgsErrorMessage> messageList() const;
%Docstring
messageList return the list of current error messages

:return: current list of error messages
%End


    SIP_PYOBJECT __repr__();
%MethodCode
    QString str = QStringLiteral( "<QgsError: %1>" ).arg( sipCpp->message( QgsErrorMessage::Text ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgserror.h                                                  *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/