QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | Protected Attributes | List of all members
QgsDataItemProviderFromPlugin Class Reference

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

Inheritance diagram for QgsDataItemProviderFromPlugin:
Inheritance graph
[legend]

Public Member Functions

 QgsDataItemProviderFromPlugin (const QString &name, dataCapabilities_t *capabilitiesFunc, dataItem_t *dataItemFunc)
 
virtual int capabilities () override
 Return combination of flags from QgsDataProvider::DataCapabilities. More...
 
virtual QgsDataItemcreateDataItem (const QString &path, QgsDataItem *parentItem) override
 Create a new instance of QgsDataItem (or null) for given path and parent item. More...
 
virtual QString name () override
 Human-readable name of the provider name. More...
 
- Public Member Functions inherited from QgsDataItemProvider
virtual ~QgsDataItemProvider ()
 

Protected Attributes

dataCapabilities_tmCapabilitiesFunc
 
dataItem_tmDataItemFunc
 
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 ( const QString name,
dataCapabilities_t capabilitiesFunc,
dataItem_t dataItemFunc 
)
inline

Definition at line 39 of file qgsdataitemproviderregistry.cpp.

Member Function Documentation

virtual int QgsDataItemProviderFromPlugin::capabilities ( )
inlineoverridevirtual

Return combination of flags from QgsDataProvider::DataCapabilities.

Implements QgsDataItemProvider.

Definition at line 48 of file qgsdataitemproviderregistry.cpp.

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

Create a new instance of QgsDataItem (or null) for given path and parent item.

Caller takes responsibility of deleting created items.

Implements QgsDataItemProvider.

Definition at line 50 of file qgsdataitemproviderregistry.cpp.

virtual QString QgsDataItemProviderFromPlugin::name ( )
inlineoverridevirtual

Human-readable name of the provider name.

Implements QgsDataItemProvider.

Definition at line 46 of file qgsdataitemproviderregistry.cpp.

Member Data Documentation

dataCapabilities_t* QgsDataItemProviderFromPlugin::mCapabilitiesFunc
protected

Definition at line 54 of file qgsdataitemproviderregistry.cpp.

dataItem_t* QgsDataItemProviderFromPlugin::mDataItemFunc
protected

Definition at line 55 of file qgsdataitemproviderregistry.cpp.

QString QgsDataItemProviderFromPlugin::mName
protected

Definition at line 53 of file qgsdataitemproviderregistry.cpp.


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