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/qgsproxyprogresstask.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsProxyProgressTask : QgsTask
{
%Docstring(signature="appended")
A :py:class:`QgsTask` shell which proxies progress reports.
Simple task shell which runs until finalized and reports progress only.
This is usually used to expose a blocking operation's progress via task
manager.
.. versionadded:: 3.4
%End
%TypeHeaderCode
#include "qgsproxyprogresstask.h"
%End
public:
QgsProxyProgressTask( const QString &description, bool canCancel = false );
%Docstring
Constructor for QgsProxyProgressTask, with the specified
``description``.
%End
void finalize( bool result );
%Docstring
Finalizes the task, with the specified ``result``.
This should be called when the operation being proxied has completed, to
remove this proxy task from the task manager.
%End
virtual bool run();
void setProxyProgress( double progress );
%Docstring
Sets the ``progress`` (from 0 to 100) for the proxied operation.
This method is safe to call from the main thread.
%End
virtual void cancel();
signals:
void canceled();
%Docstring
Emitted when the task is canceled.
.. versionadded:: 3.26
%End
};
class QgsScopedProxyProgressTask
{
%Docstring(signature="appended")
Scoped :py:class:`QgsScopedProxyProgressTask`, which automatically adds
the proxy task to the application task manager on construction and
finalizes the task when it goes out of scope.
.. versionadded:: 3.4
%End
%TypeHeaderCode
#include "qgsproxyprogresstask.h"
%End
public:
QgsScopedProxyProgressTask( const QString &description );
%Docstring
Constructor for QgsScopedProxyProgressTask, with the specified
``description``.
%End
~QgsScopedProxyProgressTask();
void setProgress( double progress );
%Docstring
Sets the ``progress`` (from 0 to 100) for the proxied operation.
%End
private:
QgsScopedProxyProgressTask( const QgsScopedProxyProgressTask &other );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsproxyprogresstask.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
