mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-28 00:04:04 -04:00
82 lines
3.2 KiB
C++
82 lines
3.2 KiB
C++
/***************************************************************************
|
|
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: QgsDataProider::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;
|
|
|
|
//! Return 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
|