mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-06 00:07:29 -04:00
112 lines
3.0 KiB
Plaintext
112 lines
3.0 KiB
Plaintext
/************************************************************************
|
|
* 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")
|
|
A :py:class:`QgsProxyProgressTask` with automatic lifetime.
|
|
|
|
:py:class:`QgsScopedProxyProgressTask` implements a
|
|
:py:class:`QgsProxyProgressTask` 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 *
|
|
************************************************************************/
|