Simple data item provider implementation that handles the support for provider plugins (which may contain dataCapabilities() and dataItem() functions). More...

Inheritance diagram for QgsDataItemProviderFromPlugin:

[legend]

Public Member Functions
	QgsDataItemProviderFromPlugin (const QString &name, dataCapabilities_t capabilitiesFunc, dataItem_t dataItemFunc, handlesDirectoryPath_t *handlesDirectoryPathFunc)
	QgsDataItemProviderFromPlugin constructor. More...

int	capabilities () override
	Returns combination of flags from QgsDataProvider::DataCapabilities. More...

QgsDataItem *	createDataItem (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...

Protected Attributes
dataCapabilities_t *	mCapabilitiesFunc = nullptr

dataItem_t *	mDataItemFunc = nullptr

handlesDirectoryPath_t *	mHandlesDirectoryPathFunc = nullptr

QString	mName

Detailed Description

Simple data item provider implementation that handles the support for provider plugins (which may contain dataCapabilities() and dataItem() functions).

Ideally the provider plugins should directly provide implementation of QgsDataItemProvider, for the time being this is a wrapper for the legacy interface.

Note: not available in Python bindings

Definition at line 36 of file qgsdataitemproviderregistry.cpp.

Constructor & Destructor Documentation

◆ QgsDataItemProviderFromPlugin()

QgsDataItemProviderFromPlugin::QgsDataItemProviderFromPlugin	(	const QString &	name,
		dataCapabilities_t *	capabilitiesFunc,
		dataItem_t *	dataItemFunc,
		handlesDirectoryPath_t *	handlesDirectoryPathFunc
	)

inline

QgsDataItemProviderFromPlugin constructor.

Parameters

name	plugin name
capabilitiesFunc	function pointer to the data capabilities
dataItemFunc	function pointer to the data items
handlesDirectoryPathFunc	function pointer to handlesDirectoryPath

Definition at line 47 of file qgsdataitemproviderregistry.cpp.

Member Function Documentation

◆ capabilities()

int QgsDataItemProviderFromPlugin::capabilities ( )

inlineoverridevirtual

Returns combination of flags from QgsDataProvider::DataCapabilities.

Implements QgsDataItemProvider.

Definition at line 57 of file qgsdataitemproviderregistry.cpp.

◆ createDataItem()

QgsDataItem* QgsDataItemProviderFromPlugin::createDataItem	(	const QString &	path,
		QgsDataItem *	parentItem
	)

inlineoverridevirtual

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 59 of file qgsdataitemproviderregistry.cpp.

◆ handlesDirectoryPath()

bool QgsDataItemProviderFromPlugin::handlesDirectoryPath ( const QString & path )

inlineoverridevirtual

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.