QGIS API Documentation  3.2.0-Bonn (bc43194)
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.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 
44 class CORE_EXPORT QgsDataItemProvider
45 {
46  public:
47  virtual ~QgsDataItemProvider() = default;
48 
50  virtual QString name() = 0;
51 
53  virtual int capabilities() = 0;
54 
59  virtual QgsDataItem *createDataItem( const QString &path, QgsDataItem *parentItem ) = 0 SIP_FACTORY;
60 
65  virtual QVector<QgsDataItem *> createDataItems( const QString &path, QgsDataItem *parentItem ) { Q_UNUSED( path ); Q_UNUSED( parentItem ); return QVector<QgsDataItem *>(); }
66 
78  virtual bool handlesDirectoryPath( const QString &path );
79 };
80 
81 #endif // QGSDATAITEMPROVIDER_H
virtual QVector< QgsDataItem * > createDataItems(const QString &path, QgsDataItem *parentItem)
Create a vector of instances of QgsDataItem (or null) for given path and parent item.
bool handlesDirectoryPath_t(const QString &path)
handlesDirectoryPath function
#define SIP_SKIP
Definition: qgis_sip.h:119
#define SIP_FACTORY
Definition: qgis_sip.h:69
Base class for all items in the model.
Definition: qgsdataitem.h:49
This is the interface for those who want to add custom data items to the browser tree.