File: qgsprocessingalgrunnertask.sip.in

package info (click to toggle)
qgis 3.40.13%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 1,185,160 kB
  • sloc: cpp: 1,615,781; python: 372,865; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,829; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 155
file content (73 lines) | stat: -rw-r--r-- 2,396 bytes parent folder | download | duplicates (16)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/processing/qgsprocessingalgrunnertask.h                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/





class QgsProcessingAlgRunnerTask : QgsTask
{
%Docstring(signature="appended")
:py:class:`QgsTask` task which runs a :py:class:`QgsProcessingAlgorithm`
in a background task.
%End

%TypeHeaderCode
#include "qgsprocessingalgrunnertask.h"
%End
  public:

    QgsProcessingAlgRunnerTask( const QgsProcessingAlgorithm *algorithm,
                                const QVariantMap &parameters,
                                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.py again   *
 ************************************************************************/