QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
qgsdataitemprovider.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsdataitemprovider.h
3  --------------------------------------
4  Date : March 2015
5  Copyright : (C) 2015 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSDATAITEMPROVIDER_H
17 #define QGSDATAITEMPROVIDER_H
18 
19 #include "qgis_core.h"
20 #include "qgis_sip.h"
21 #include "qgsdataitem.h"
22 
23 class QgsDataItem;
24 
25 class QString;
26 
28 typedef bool handlesDirectoryPath_t( const QString &path ) SIP_SKIP;
29 
30 
45 class CORE_EXPORT QgsDataItemProvider
46 {
47  public:
48  virtual ~QgsDataItemProvider() = default;
49 
51  virtual QString name() = 0;
52 
59  virtual QString dataProviderKey() const { return QString(); };
60 
62  virtual int capabilities() const = 0;
63 
68  virtual QgsDataItem *createDataItem( const QString &path, QgsDataItem *parentItem ) = 0 SIP_FACTORY;
69 
74  virtual QVector<QgsDataItem *> createDataItems( const QString &path, QgsDataItem *parentItem );
75 
87  virtual bool handlesDirectoryPath( const QString &path );
88 };
89 
90 #endif // QGSDATAITEMPROVIDER_H
QgsDataItemProvider::capabilities
virtual int capabilities() const =0
Returns combination of flags from QgsDataProvider::DataCapabilities.
qgsdataitem.h
handlesDirectoryPath_t
bool handlesDirectoryPath_t(const QString &path)
handlesDirectoryPath function
Definition: qgsdataitemprovider.h:28
QgsDataItemProvider::createDataItem
virtual QgsDataItem * createDataItem(const QString &path, QgsDataItem *parentItem)=0
Create a new instance of QgsDataItem (or nullptr) for given path and parent item.
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsDataItemProvider::name
virtual QString name()=0
Human-readable name of the provider name.
SIP_SKIP
#define SIP_SKIP
Definition: qgis_sip.h:126
QgsDataItemProvider
This is the interface for those who want to add custom data items to the browser tree.
Definition: qgsdataitemprovider.h:46
qgis_sip.h
QgsDataItemProvider::~QgsDataItemProvider
virtual ~QgsDataItemProvider()=default
QgsDataItemProvider::dataProviderKey
virtual QString dataProviderKey() const
Returns the data provider key (if the data item provider is associated with a data provider),...
Definition: qgsdataitemprovider.h:59
QgsDataItem
Base class for all items in the model.
Definition: qgsdataitem.h:51