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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsrasterfilewritertask.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsRasterFileWriterTask : QgsTask
{
%Docstring(signature="appended")
:py:class:`QgsTask` task which performs a
:py:class:`QgsRasterFileWriter` layer saving operation as a background
task. This can be used to save a raster layer out to a file without
blocking the QGIS interface.
.. seealso:: :py:class:`QgsVectorFileWriterTask`
.. seealso:: :py:class:`QgsVectorFileExporterTask`
%End
%TypeHeaderCode
#include "qgsrasterfilewritertask.h"
%End
public:
QgsRasterFileWriterTask( const QgsRasterFileWriter &writer, QgsRasterPipe *pipe /Transfer/,
int columns, int rows,
const QgsRectangle &outputExtent,
const QgsCoordinateReferenceSystem &crs ) /Deprecated/;
%Docstring
Constructor for QgsRasterFileWriterTask. Takes a source ``writer``,
``columns``, ``rows``, ``outputExtent`` and destination ``crs``.
Ownership of the ``pipe`` is transferred to the writer task, and will be
deleted when the task completes.
.. deprecated:: 3.8
Use version with transformContext instead.
%End
QgsRasterFileWriterTask( const QgsRasterFileWriter &writer, QgsRasterPipe *pipe /Transfer/,
int columns, int rows,
const QgsRectangle &outputExtent,
const QgsCoordinateReferenceSystem &crs,
const QgsCoordinateTransformContext &transformContext
);
%Docstring
Constructor for QgsRasterFileWriterTask. Takes a source ``writer``,
``columns``, ``rows``, ``outputExtent``, destination ``crs`` and
coordinate ``transformContext`` . Ownership of the ``pipe`` is
transferred to the writer task, and will be deleted when the task
completes.
%End
~QgsRasterFileWriterTask();
virtual void cancel();
signals:
void writeComplete( const QString &outputUrl );
%Docstring
Emitted when writing the layer is successfully completed. The
``outputUrl`` parameter indicates the file path for the written file(s).
%End
void errorOccurred( int error );
%Docstring
Emitted when an error occurs which prevented the file being written (or
if the task is canceled). The writing ``error`` will be reported.
.. deprecated:: 3.10
Use errorOccurred(int, const QString&).
%End
void errorOccurred( int error, const QString &errorMessage );
%Docstring
Emitted when an error occurs which prevented the file being written (or
if the task is canceled). The writing ``error`` will be reported and a
``errorMessage`` will be potentially set.
.. versionadded:: 3.10
%End
protected:
virtual bool run();
virtual void finished( bool result );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsrasterfilewritertask.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
