QGIS API Documentation
4.3.0-Master (52aa6503bed)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
browser
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.h
"
20
#include "qgis_core.h"
21
#include "
qgis_sip.h
"
22
23
#include <QString>
24
#include <QVector>
25
26
class
QgsDataItem
;
27
29
typedef
bool
handlesDirectoryPath_t
(
const
QString &
path
)
SIP_SKIP
;
30
31
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
Qgis::DataItemProviderCapabilities
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
86
virtual
bool
handlesDirectoryPath
(
const
QString &path );
87
};
88
89
#endif
// QGSDATAITEMPROVIDER_H
Qgis::DataItemProviderCapabilities
QFlags< DataItemProviderCapability > DataItemProviderCapabilities
Capabilities for data item providers.
Definition
qgis.h:1093
QgsDataItemProvider
Interface for providers that add custom data items to the browser tree.
Definition
qgsdataitemprovider.h:46
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
QgsDataItemProvider::~QgsDataItemProvider
virtual ~QgsDataItemProvider()=default
QgsDataItemProvider::createDataItems
virtual QVector< QgsDataItem * > createDataItems(const QString &path, QgsDataItem *parentItem)
Create a vector of instances of QgsDataItem (or nullptr) for given path and parent item.
Definition
qgsdataitemprovider.cpp:20
QgsDataItemProvider::name
virtual QString name()=0
Human-readable name of the provider name.
QgsDataItemProvider::handlesDirectoryPath
virtual bool handlesDirectoryPath(const QString &path)
Returns true if the provider will handle the directory at the specified path.
Definition
qgsdataitemprovider.cpp:27
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.
QgsDataItemProvider::capabilities
virtual Qgis::DataItemProviderCapabilities capabilities() const =0
Returns combination of flags from QgsDataProvider::DataCapabilities.
QgsDataItem
Base class for all items in the model.
Definition
qgsdataitem.h:50
QgsDataItem::path
QString path() const
Definition
qgsdataitem.h:415
qgis.h
qgis_sip.h
SIP_SKIP
#define SIP_SKIP
Definition
qgis_sip.h:138
SIP_FACTORY
#define SIP_FACTORY
Definition
qgis_sip.h:83
handlesDirectoryPath_t
bool handlesDirectoryPath_t(const QString &path)
handlesDirectoryPath function
Definition
qgsdataitemprovider.h:29
Generated on
for QGIS API Documentation by
1.17.0