mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
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.
62 lines
1.9 KiB
Plaintext
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 *
|
|
************************************************************************/
|