-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create QgsProviderSublayerTask for retrieving sublayer details in a t…
…hread This can sometimes take a looooong time, so it's worth doing in the background
- Loading branch information
1 parent
0404dca
commit 7c6afc0
Showing
5 changed files
with
172 additions
and
0 deletions.
There are no files selected for viewing
53 changes: 53 additions & 0 deletions
53
python/core/auto_generated/providers/qgsprovidersublayertask.sip.in
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
/************************************************************************ | ||
* This file has been generated automatically from * | ||
* * | ||
* src/core/providers/qgsprovidersublayertask.h * | ||
* * | ||
* Do not edit manually ! Edit header and run scripts/sipify.pl again * | ||
************************************************************************/ | ||
|
||
|
||
|
||
|
||
|
||
class QgsProviderSublayerTask : QgsTask | ||
{ | ||
%Docstring(signature="appended") | ||
|
||
A :py:class:`QgsTask` which retrieves sublayer details for a URI. | ||
|
||
.. versionadded:: 3.22 | ||
%End | ||
|
||
%TypeHeaderCode | ||
#include "qgsprovidersublayertask.h" | ||
%End | ||
public: | ||
|
||
QgsProviderSublayerTask( const QString &uri ); | ||
%Docstring | ||
Constructor for QgsProviderSublayerTask, which retrieves sublayer details for the | ||
specified ``uri``. | ||
%End | ||
|
||
~QgsProviderSublayerTask(); | ||
|
||
QList<QgsProviderSublayerDetails> results() const; | ||
%Docstring | ||
Return the sublayer details as calculated by the task. | ||
%End | ||
|
||
virtual bool run(); | ||
|
||
virtual void cancel(); | ||
|
||
|
||
}; | ||
|
||
/************************************************************************ | ||
* This file has been generated automatically from * | ||
* * | ||
* src/core/providers/qgsprovidersublayertask.h * | ||
* * | ||
* Do not edit manually ! Edit header and run scripts/sipify.pl again * | ||
************************************************************************/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/*************************************************************************** | ||
qgsprovidersublayertask.cpp | ||
---------------------- | ||
begin : June 2021 | ||
copyright : (C) 2021 by Nyall Dawson | ||
email : nyall dot dawson at gmail dot com | ||
***************************************************************************/ | ||
|
||
/*************************************************************************** | ||
* * | ||
* This program is free software; you can redistribute it and/or modify * | ||
* it under the terms of the GNU General Public License as published by * | ||
* the Free Software Foundation; either version 2 of the License, or * | ||
* (at your option) any later version. * | ||
* * | ||
***************************************************************************/ | ||
|
||
#include "qgsprovidersublayertask.h" | ||
#include "qgsfeedback.h" | ||
#include "qgsproviderregistry.h" | ||
#include "qgsprovidersublayerdetails.h" | ||
|
||
QgsProviderSublayerTask::QgsProviderSublayerTask( const QString &uri ) | ||
: QgsTask( tr( "Retrieving layers" ), QgsTask::CanCancel | QgsTask::CancelWithoutPrompt ) | ||
, mUri( uri ) | ||
{ | ||
} | ||
|
||
QList<QgsProviderSublayerDetails> QgsProviderSublayerTask::results() const | ||
{ | ||
return mResults; | ||
} | ||
|
||
QgsProviderSublayerTask::~QgsProviderSublayerTask() = default; | ||
|
||
bool QgsProviderSublayerTask::run() | ||
{ | ||
mFeedback = std::make_unique< QgsFeedback >(); | ||
|
||
mResults = QgsProviderRegistry::instance()->querySublayers( mUri, Qgis::SublayerQueryFlag::ResolveGeometryType | Qgis::SublayerQueryFlag::CountFeatures, mFeedback.get() ); | ||
return true; | ||
} | ||
|
||
void QgsProviderSublayerTask::cancel() | ||
{ | ||
if ( mFeedback ) | ||
mFeedback->cancel(); | ||
|
||
QgsTask::cancel(); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
/*************************************************************************** | ||
qgsprovidersublayertask.h | ||
---------------------- | ||
begin : June 2021 | ||
copyright : (C) 2021 by Nyall Dawson | ||
email : nyall dot dawson at gmail dot com | ||
***************************************************************************/ | ||
|
||
/*************************************************************************** | ||
* * | ||
* This program is free software; you can redistribute it and/or modify * | ||
* it under the terms of the GNU General Public License as published by * | ||
* the Free Software Foundation; either version 2 of the License, or * | ||
* (at your option) any later version. * | ||
* * | ||
***************************************************************************/ | ||
|
||
#ifndef QGSPROVIDERSUBLAYERTASKTASK_H | ||
#define QGSPROVIDERSUBLAYERTASKTASK_H | ||
|
||
#include "qgstaskmanager.h" | ||
#include <memory> | ||
|
||
class QgsFeedback; | ||
class QgsProviderSublayerDetails; | ||
|
||
/** | ||
* \ingroup core | ||
* | ||
* \brief A QgsTask which retrieves sublayer details for a URI. | ||
* | ||
* \since QGIS 3.22 | ||
*/ | ||
class CORE_EXPORT QgsProviderSublayerTask : public QgsTask | ||
{ | ||
Q_OBJECT | ||
|
||
public: | ||
|
||
/** | ||
* Constructor for QgsProviderSublayerTask, which retrieves sublayer details for the | ||
* specified \a uri. | ||
*/ | ||
QgsProviderSublayerTask( const QString &uri ); | ||
|
||
~QgsProviderSublayerTask() override; | ||
|
||
/** | ||
* Return the sublayer details as calculated by the task. | ||
*/ | ||
QList<QgsProviderSublayerDetails> results() const; | ||
|
||
bool run() override; | ||
void cancel() override; | ||
|
||
private: | ||
|
||
QString mUri; | ||
|
||
std::unique_ptr< QgsFeedback > mFeedback; | ||
|
||
QList<QgsProviderSublayerDetails> mResults; | ||
|
||
}; | ||
|
||
#endif // QGSPROVIDERSUBLAYERTASKTASK_H |