mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-31 00:06:02 -04:00
108 lines
3.6 KiB
Plaintext
108 lines
3.6 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/raster/qgsrasterfilewritertask.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl 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`
|
|
|
|
.. versionadded:: 3.0
|
|
%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:: QGIS 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:: QGIS 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.pl again *
|
|
************************************************************************/
|