QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
providers
qgsprovidersublayertask.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsprovidersublayertask.h
3
----------------------
4
begin : June 2021
5
copyright : (C) 2021 by Nyall Dawson
6
email : nyall dot dawson at gmail dot com
7
***************************************************************************/
8
9
/***************************************************************************
10
* *
11
* This program is free software; you can redistribute it and/or modify *
12
* it under the terms of the GNU General Public License as published by *
13
* the Free Software Foundation; either version 2 of the License, or *
14
* (at your option) any later version. *
15
* *
16
***************************************************************************/
17
18
#ifndef QGSPROVIDERSUBLAYERTASKTASK_H
19
#define QGSPROVIDERSUBLAYERTASKTASK_H
20
21
#include <memory>
22
23
#include "
qgstaskmanager.h
"
24
25
#include <QReadWriteLock>
26
27
class
QgsFeedback
;
28
class
QgsProviderSublayerDetails
;
29
48
class
CORE_EXPORT
QgsProviderSublayerTask
:
public
QgsTask
49
{
50
Q_OBJECT
51
52
public
:
57
QgsProviderSublayerTask
(
const
QString &uri,
bool
includeSystemTables =
false
);
58
65
QgsProviderSublayerTask
(
const
QString &uri,
const
QString &providerKey,
bool
includeSystemTables =
false
);
66
67
~QgsProviderSublayerTask
()
override
;
68
72
QList<QgsProviderSublayerDetails>
results
()
const
;
73
74
void
cancel
()
override
;
75
76
protected
:
77
bool
run
()
override
;
78
79
private
:
80
QString mUri;
81
82
QString mProviderKey;
83
84
bool
mIncludeSystemTables =
false
;
85
86
std::unique_ptr< QgsFeedback > mFeedback;
87
88
QList<QgsProviderSublayerDetails> mResults;
89
90
mutable
QReadWriteLock mLock;
91
};
92
93
#endif
// QGSPROVIDERSUBLAYERTASKTASK_H
QgsFeedback
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition
qgsfeedback.h:44
QgsProviderSublayerDetails
Contains details about a sub layer available from a dataset.
Definition
qgsprovidersublayerdetails.h:48
QgsProviderSublayerTask::results
QList< QgsProviderSublayerDetails > results() const
Returns the sublayer details as calculated by the task.
Definition
qgsprovidersublayertask.cpp:41
QgsProviderSublayerTask::QgsProviderSublayerTask
QgsProviderSublayerTask(const QString &uri, bool includeSystemTables=false)
Constructor for QgsProviderSublayerTask, which retrieves sublayer details for the specified uri.
Definition
qgsprovidersublayertask.cpp:28
QgsProviderSublayerTask::~QgsProviderSublayerTask
~QgsProviderSublayerTask() override
QgsTask::run
virtual bool run()=0
Performs the task's operation.
QgsTask::cancel
virtual void cancel()
Notifies the task that it should terminate.
Definition
qgstaskmanager.cpp:98
QgsTask::QgsTask
QgsTask(const QString &description=QString(), QgsTask::Flags flags=AllFlags)
Constructor for QgsTask.
Definition
qgstaskmanager.cpp:36
qgstaskmanager.h
Generated on
for QGIS API Documentation by
1.17.0