QGIS/python/core/auto_generated/qgsproxyprogresstask.sip.in
Nyall Dawson 21693bd4a4 Add a QgsTask subclass for proxying progress reports from a
blocking operation via task manager

Allows use of the task manager progress reporting system from
operations which are blocking (and cannot be made background
tasks!), e.g. layout exporting, project loading.
2018-08-16 06:22:16 +10:00

62 lines
1.9 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsproxyprogresstask.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProxyProgressTask : QgsTask
{
%Docstring
A 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 );
%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
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsproxyprogresstask.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/