qgsfilebaseddataitemprovider.h

Go to the documentation of this file.

/***************************************************************************
  qgsfilebaseddataitemprovider.h
  --------------------------------------
  Date                 : July 2021
  Copyright            : (C) 2021 by Nyall Dawson
  Email                : nyall dot dawson 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 QGSFILEBASEDDATAITEMPROVIDER_H
#define QGSFILEBASEDDATAITEMPROVIDER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractdatabaseproviderconnection.h"
#include "qgsdatacollectionitem.h"
#include "qgsdataitemprovider.h"
#include "qgslayeritem.h"
#include "qgsprovidersublayerdetails.h"
 
#include <QString>
#include <QVector>
 
#define SIP_NO_FILE
 
class QgsSettingsEntryString;
 
class QgsProviderSublayerDetails;
 
 
class QgsDataItem;

class CORE_EXPORT QgsProviderSublayerItem final : public QgsLayerItem
{
    Q_OBJECT
  public:
    QgsProviderSublayerItem( QgsDataItem *parent, const QString &name, const QgsProviderSublayerDetails &details, const QString &filePath );
    QString layerName() const override;
    QVector<QgsDataItem *> createChildren() override;
    QgsAbstractDatabaseProviderConnection *databaseConnection() const override;

    QgsProviderSublayerDetails sublayerDetails() const;
 
  private:
    static Qgis::BrowserLayerType layerTypeFromSublayer( const QgsProviderSublayerDetails &sublayer );
 
    QgsProviderSublayerDetails mDetails;
};
 

class CORE_EXPORT QgsFileDataCollectionGroupItem final : public QgsDataCollectionItem
{
    Q_OBJECT
  public:
    QgsFileDataCollectionGroupItem( QgsDataItem *parent, const QString &groupName, const QString &path );

    void appendSublayer( const QgsProviderSublayerDetails &sublayer );
 
    bool hasDragEnabled() const override;
    QgsMimeDataUtils::UriList mimeUris() const override;
 
  private:
    QList< QgsProviderSublayerDetails > mSublayers;
};

class CORE_EXPORT QgsFileDataCollectionItem final : public QgsDataCollectionItem
{
    Q_OBJECT
  public:
    QgsFileDataCollectionItem( QgsDataItem *parent, const QString &name, const QString &path, const QList< QgsProviderSublayerDetails> &sublayers, const QVariantMap &extraUriParts = QVariantMap() );
 
    QVector<QgsDataItem *> createChildren() override;
    bool hasDragEnabled() const override;

    bool canAddVectorLayers() const;
 
    QgsMimeDataUtils::UriList mimeUris() const override;
    QgsAbstractDatabaseProviderConnection *databaseConnection() const override;

    QgsAbstractDatabaseProviderConnection::Capabilities databaseConnectionCapabilities() const;

    Qgis::DatabaseProviderConnectionCapabilities2 databaseConnectionCapabilities2() const;

    QList<QgsProviderSublayerDetails> sublayers() const;
 
  private:
    QList< QgsProviderSublayerDetails> mSublayers;
    QVariantMap mExtraUriParts;
    mutable bool mHasCachedCapabilities = false;
    mutable QgsAbstractDatabaseProviderConnection::Capabilities mCachedCapabilities;
    mutable Qgis::DatabaseProviderConnectionCapabilities2 mCachedCapabilities2;
    mutable bool mHasCachedDropSupport = false;
    mutable bool mCachedSupportsDrop = false;
};
 

class CORE_EXPORT QgsFileBasedDataItemProvider : public QgsDataItemProvider
{
  public:
    QString name() override;
    Qgis::DataItemProviderCapabilities capabilities() const override;
    QgsDataItem *createDataItem( const QString &path, QgsDataItem *parentItem ) override SIP_FACTORY;

    static QgsDataItem *createLayerItemForPath( const QString &path, QgsDataItem *parentItem, const QStringList &providers, const QVariantMap &extraUriParts, Qgis::SublayerQueryFlags queryFlags );
 
    bool handlesDirectoryPath( const QString &path ) override;
 
    static const QgsSettingsEntryString *settingsScanItemsInBrowser;
 
  private:
    static QgsDataItem *createDataItemForPathPrivate(
      const QString &path, QgsDataItem *parentItem, const QStringList *allowedProviders, Qgis::SublayerQueryFlags queryFlags, const QVariantMap &extraUriParts
    );
};
 
#endif // QGSFILEBASEDDATAITEMPROVIDER_H