mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
75 lines
2.4 KiB
Plaintext
75 lines
2.4 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/processing/qgsprocessingalgrunnertask.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsProcessingAlgRunnerTask : QgsTask
|
|
{
|
|
%Docstring(signature="appended")
|
|
:py:class:`QgsTask` task which runs a :py:class:`QgsProcessingAlgorithm` in a background task.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsprocessingalgrunnertask.h"
|
|
%End
|
|
public:
|
|
|
|
QgsProcessingAlgRunnerTask( const QgsProcessingAlgorithm *algorithm,
|
|
const QVariantMap ¶meters,
|
|
QgsProcessingContext &context,
|
|
QgsProcessingFeedback *feedback = 0,
|
|
QgsTask::Flags flags = QgsTask::CanCancel );
|
|
%Docstring
|
|
Constructor for QgsProcessingAlgRunnerTask. Takes an ``algorithm``, algorithm ``parameters``
|
|
and processing ``context``.
|
|
|
|
Since QGIS 3.26, the ``flags`` argument allows control over task flags.
|
|
%End
|
|
|
|
virtual void cancel();
|
|
|
|
|
|
bool algorithmCanceled();
|
|
%Docstring
|
|
Returns ``True`` if the algorithm was canceled.
|
|
|
|
.. versionadded:: 3.26
|
|
%End
|
|
|
|
signals:
|
|
|
|
void executed( bool successful, const QVariantMap &results );
|
|
%Docstring
|
|
Emitted when the algorithm has finished execution. If the algorithm completed
|
|
execution without errors then ``successful`` will be ``True``. The ``results`` argument
|
|
contains the results reported by the algorithm.
|
|
%End
|
|
|
|
protected:
|
|
|
|
virtual bool run();
|
|
|
|
virtual void finished( bool result );
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/processing/qgsprocessingalgrunnertask.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|