Description for QgsNetworkContentFetcherTask can be customised

This commit is contained in:
Nyall Dawson 2022-06-16 11:23:42 +10:00
parent 4f2705e435
commit 0f4f5cd2cc
3 changed files with 20 additions and 8 deletions

View File

@ -34,20 +34,26 @@ without danger of the task being first removed by the :py:class:`QgsTaskManager`
%End
public:
QgsNetworkContentFetcherTask( const QUrl &url, const QString &authcfg = QString(), QgsTask::Flags flags = QgsTask::CanCancel );
QgsNetworkContentFetcherTask( const QUrl &url, const QString &authcfg = QString(), QgsTask::Flags flags = QgsTask::CanCancel,
const QString &description = QString() );
%Docstring
Constructor for a QgsNetworkContentFetcherTask which fetches
the specified ``url``.
Optionally, authentication configuration can be set via the ``authcfg`` argument.
Since QGIS 3.28 the optional ``description`` can be explicitly set. If not specified, a default task description will be generated.
%End
QgsNetworkContentFetcherTask( const QNetworkRequest &request, const QString &authcfg = QString(), QgsTask::Flags flags = QgsTask::CanCancel );
QgsNetworkContentFetcherTask( const QNetworkRequest &request, const QString &authcfg = QString(), QgsTask::Flags flags = QgsTask::CanCancel,
const QString &description = QString() );
%Docstring
Constructor for a QgsNetworkContentFetcherTask which fetches
the specified network ``request``.
Optionally, authentication configuration can be set via the ``authcfg`` argument.
Since QGIS 3.28 the optional ``description`` can be explicitly set. If not specified, a default task description will be generated.
%End
~QgsNetworkContentFetcherTask();

View File

@ -20,13 +20,13 @@
#include "qgsnetworkcontentfetcher.h"
#include <QEventLoop>
QgsNetworkContentFetcherTask::QgsNetworkContentFetcherTask( const QUrl &url, const QString &authcfg, QgsTask::Flags flags )
: QgsNetworkContentFetcherTask( QNetworkRequest( url ), authcfg, flags )
QgsNetworkContentFetcherTask::QgsNetworkContentFetcherTask( const QUrl &url, const QString &authcfg, QgsTask::Flags flags, const QString &description )
: QgsNetworkContentFetcherTask( QNetworkRequest( url ), authcfg, flags, description )
{
}
QgsNetworkContentFetcherTask::QgsNetworkContentFetcherTask( const QNetworkRequest &request, const QString &authcfg, QgsTask::Flags flags )
: QgsTask( tr( "Fetching %1" ).arg( request.url().toString() ), flags )
QgsNetworkContentFetcherTask::QgsNetworkContentFetcherTask( const QNetworkRequest &request, const QString &authcfg, QgsTask::Flags flags, const QString &description )
: QgsTask( description.isEmpty() ? tr( "Fetching %1" ).arg( request.url().toString() ) : description, flags )
, mRequest( request )
, mAuthcfg( authcfg )
{

View File

@ -55,16 +55,22 @@ class CORE_EXPORT QgsNetworkContentFetcherTask : public QgsTask
* the specified \a url.
*
* Optionally, authentication configuration can be set via the \a authcfg argument.
*
* Since QGIS 3.28 the optional \a description can be explicitly set. If not specified, a default task description will be generated.
*/
QgsNetworkContentFetcherTask( const QUrl &url, const QString &authcfg = QString(), QgsTask::Flags flags = QgsTask::CanCancel );
QgsNetworkContentFetcherTask( const QUrl &url, const QString &authcfg = QString(), QgsTask::Flags flags = QgsTask::CanCancel,
const QString &description = QString() );
/**
* Constructor for a QgsNetworkContentFetcherTask which fetches
* the specified network \a request.
*
* Optionally, authentication configuration can be set via the \a authcfg argument.
*
* Since QGIS 3.28 the optional \a description can be explicitly set. If not specified, a default task description will be generated.
*/
QgsNetworkContentFetcherTask( const QNetworkRequest &request, const QString &authcfg = QString(), QgsTask::Flags flags = QgsTask::CanCancel );
QgsNetworkContentFetcherTask( const QNetworkRequest &request, const QString &authcfg = QString(), QgsTask::Flags flags = QgsTask::CanCancel,
const QString &description = QString() );
~QgsNetworkContentFetcherTask() override;