QGIS API Documentation  3.23.0-Master (eb871beae0)
Public Member Functions | List of all members
QgsFileBasedDataItemProvider Class Reference

A data item provider for file based data sources. More...

#include <qgsfilebaseddataitemprovider.h>

Inheritance diagram for QgsFileBasedDataItemProvider:
Inheritance graph
[legend]

Public Member Functions

int capabilities () const override
 Returns combination of flags from QgsDataProvider::DataCapabilities. More...
 
QgsDataItemcreateDataItem (const QString &path, QgsDataItem *parentItem) override
 Create a new instance of QgsDataItem (or nullptr) for given path and parent item. More...
 
bool handlesDirectoryPath (const QString &path) override
 Returns true if the provider will handle the directory at the specified path. More...
 
QString name () override
 Human-readable name of the provider name. More...
 
- 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. More...
 
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. More...
 

Detailed Description

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).

Since
QGIS 3.22

Definition at line 113 of file qgsfilebaseddataitemprovider.h.

Member Function Documentation

◆ capabilities()

int QgsFileBasedDataItemProvider::capabilities ( ) const
overridevirtual

Returns combination of flags from QgsDataProvider::DataCapabilities.

Implements QgsDataItemProvider.

Definition at line 236 of file qgsfilebaseddataitemprovider.cpp.

◆ createDataItem()

QgsDataItem * QgsFileBasedDataItemProvider::createDataItem ( const QString &  path,
QgsDataItem parentItem 
)
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 241 of file qgsfilebaseddataitemprovider.cpp.

◆ handlesDirectoryPath()

bool QgsFileBasedDataItemProvider::handlesDirectoryPath ( const QString &  path)
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.

Since
QGIS 3.0

Reimplemented from QgsDataItemProvider.

Definition at line 360 of file qgsfilebaseddataitemprovider.cpp.

◆ name()

QString QgsFileBasedDataItemProvider::name ( )
overridevirtual

Human-readable name of the provider name.

Implements QgsDataItemProvider.

Definition at line 231 of file qgsfilebaseddataitemprovider.cpp.


The documentation for this class was generated from the following files: