QGIS API Documentation 3.39.0-Master (699c004a5df)
|
A data item provider for file based data sources. More...
#include <qgsfilebaseddataitemprovider.h>
Public Member Functions | |
Qgis::DataItemProviderCapabilities | capabilities () const override |
Returns combination of flags from QgsDataProvider::DataCapabilities. | |
QgsDataItem * | createDataItem (const QString &path, QgsDataItem *parentItem) override |
Create a new instance of QgsDataItem (or nullptr ) for given path and parent item. | |
bool | handlesDirectoryPath (const QString &path) override |
Returns true if the provider will handle the directory at the specified path. | |
QString | name () override |
Human-readable name of the provider name. | |
Public Member Functions inherited from QgsDataItemProvider | |
virtual | ~QgsDataItemProvider ()=default |
virtual QVector< QgsDataItem * > | createDataItems (const QString &path, QgsDataItem *parentItem) |
Create a vector of instances of QgsDataItem (or nullptr ) for given path and parent item. | |
virtual QString | dataProviderKey () const |
Returns the data provider key (if the data item provider is associated with a data provider), the default implementation returns an empty string. | |
Static Public Member Functions | |
static QgsDataItem * | createLayerItemForPath (const QString &path, QgsDataItem *parentItem, const QStringList &providers, const QVariantMap &extraUriParts, Qgis::SublayerQueryFlags queryFlags) |
Static method to create a data item for sublayers corresponding to a file-like path. | |
A data item provider for file based data sources.
This is a generic data item provider, which creates data items for file based data sources from registered providers (using the QgsProviderRegistry::querySublayers() API).
Definition at line 206 of file qgsfilebaseddataitemprovider.h.
|
overridevirtual |
Returns combination of flags from QgsDataProvider::DataCapabilities.
Implements QgsDataItemProvider.
Definition at line 553 of file qgsfilebaseddataitemprovider.cpp.
|
overridevirtual |
Create a new instance of QgsDataItem (or nullptr
) for given path and parent item.
Caller takes responsibility of deleting created items.
Implements QgsDataItemProvider.
Definition at line 558 of file qgsfilebaseddataitemprovider.cpp.
|
static |
Static method to create a data item for sublayers corresponding to a file-like path.
path | file like path to create item for |
parentItem | parent data item |
providers | list of data providers to include when scanning for sublayers for the path. Must be populated. |
extraUriParts | map of optional extra components to append to URIs generated for the path. The provider-specific encodeUri methods will be used to handle these URI additions. |
queryFlags | flags controlling sublayer querying |
Definition at line 563 of file qgsfilebaseddataitemprovider.cpp.
|
overridevirtual |
Returns true
if the provider will handle the directory at the specified path.
If the provider indicates that it will handle the directory, the default creation and population of directory items for the path will be avoided and it is left to the provider to correctly populate relevant entries for the path.
The default implementation returns false
for all paths.
Reimplemented from QgsDataItemProvider.
Definition at line 681 of file qgsfilebaseddataitemprovider.cpp.
|
overridevirtual |
Human-readable name of the provider name.
Implements QgsDataItemProvider.
Definition at line 548 of file qgsfilebaseddataitemprovider.cpp.