QGIS/python/core/qgsmaprenderertask.sip

77 lines
2.2 KiB
Plaintext
Raw Normal View History

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmaprenderertask.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsMapRendererTask : QgsTask
{
%Docstring
QgsTask task which draws a map to an image file or a painter as a background
task. This can be used to draw maps without blocking the QGIS interface.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsmaprenderertask.h"
%End
public:
enum ErrorType
{
ImageAllocationFail,
ImageSaveFail
};
QgsMapRendererTask( const QgsMapSettings &ms,
const QString &fileName,
const QString &fileFormat = QString( "PNG" ) );
%Docstring
Constructor for QgsMapRendererTask to render a map to an image file.
%End
QgsMapRendererTask( const QgsMapSettings &ms,
QPainter *p );
%Docstring
Constructor for QgsMapRendererTask to render a map to a painter object.
%End
void addAnnotations( QList< QgsAnnotation * > annotations );
%Docstring
Adds ``annotations`` to be rendered on the map.
%End
signals:
void renderingComplete();
%Docstring
Emitted when the map rendering is successfully completed.
%End
void errorOccurred( int error );
%Docstring
Emitted when map rendering failed.
%End
protected:
virtual bool run();
virtual void finished( bool result );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmaprenderertask.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/