-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsdataitemprovider.h
81 lines (68 loc) · 3.19 KB
/
qgsdataitemprovider.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/***************************************************************************
qgsdataitemprovider.h
--------------------------------------
Date : March 2015
Copyright : (C) 2015 by Martin Dobias
Email : wonder dot sk at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef QGSDATAITEMPROVIDER_H
#define QGSDATAITEMPROVIDER_H
#include "qgis_core.h"
#include "qgis.h"
#include "qgsdataitem.h"
class QgsDataItem;
class QString;
//! handlesDirectoryPath function
typedef bool handlesDirectoryPath_t( const QString &path ) SIP_SKIP;
/**
* \ingroup core
* This is the interface for those who want to add custom data items to the browser tree.
*
* The method createDataItem() is ever called only if capabilities() return non-zero value.
* There are two occasions when createDataItem() is called:
* 1. to create root items (passed path is empty, parent item is null).
* 2. to create items in directory structure. For this capabilities have to return at least
* of the following: QgsDataProvider::Dir or QgsDataProvider::File. Passed path is the file
* or directory being inspected, parent item is a valid QgsDirectoryItem
*
* \since QGIS 2.10
*/
class CORE_EXPORT QgsDataItemProvider
{
public:
virtual ~QgsDataItemProvider() = default;
//! Human-readable name of the provider name
virtual QString name() = 0;
//! Returns combination of flags from QgsDataProvider::DataCapabilities
virtual int capabilities() = 0;
/**
* Create a new instance of QgsDataItem (or null) for given path and parent item.
* Caller takes responsibility of deleting created items.
*/
virtual QgsDataItem *createDataItem( const QString &path, QgsDataItem *parentItem ) = 0 SIP_FACTORY;
/**
* Create a vector of instances of QgsDataItem (or null) for given path and parent item.
* Caller takes responsibility of deleting created items.
*/
virtual QVector<QgsDataItem *> createDataItems( const QString &path, QgsDataItem *parentItem ) { Q_UNUSED( path ); Q_UNUSED( parentItem ); return QVector<QgsDataItem *>(); }
/**
* Returns true if the provider will handle the directory at the specified \a 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.
*
* \since QGIS 3.0
*/
virtual bool handlesDirectoryPath( const QString &path );
};
#endif // QGSDATAITEMPROVIDER_H