qgslayeritem.h

Go to the documentation of this file.

/***************************************************************************
                             qgslayeritem.h
                             -------------------
    begin                : 2011-04-01
    copyright            : (C) 2011 Radim Blazek
    email                : radim dot blazek 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 QGSLAYERITEM_H
#define QGSLAYERITEM_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsdataitem.h"
#include "qgslayermetadata.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsLayerItem : public QgsDataItem
{
    Q_OBJECT
 
  public:
    QgsLayerItem( QgsDataItem *parent, const QString &name, const QString &path, const QString &uri, Qgis::BrowserLayerType layerType, const QString &providerKey );
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsLayerItem: \"%1\" %2>"_s.arg( sipCpp->name(), sipCpp->path() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
      // --- reimplemented from QgsDataItem ---
 
      bool equal( const QgsDataItem *other ) override;
 
    bool hasDragEnabled() const override { return true; }
 
    QgsMimeDataUtils::UriList mimeUris() const override;
 
    // --- New virtual methods for layer item derived classes ---
 
#ifndef SIP_RUN
    struct LayerUriWithDetails
    {
        QgsMimeDataUtils::Uri uri;
        QString userFriendlyDescription;
    };

    virtual QList< LayerUriWithDetails > layerUrisWithDetails() const;
#endif

    Qgis::LayerType mapLayerType() const;

    static Qgis::BrowserLayerType typeFromMapLayer( QgsMapLayer *layer );

    QString uri() const { return mUri; }

    QStringList supportedCrs() const { return mSupportedCRS; }

    QStringList supportedFormats() const { return mSupportFormats; }

    virtual QString comments() const { return QString(); }

    virtual Qgis::LayerItemCapabilities layerCapabilities() const { return Qgis::LayerItemCapability::AddComments; }

    static QString layerTypeAsString( Qgis::BrowserLayerType layerType );

    static QString iconName( Qgis::BrowserLayerType layerType );

    Q_DECL_DEPRECATED virtual bool deleteLayer() SIP_DEPRECATED;
 
  protected:
    QString mUri;
    Qgis::BrowserLayerType mLayerType;
    QStringList mSupportedCRS;
    QStringList mSupportFormats;
 
  public:
    static QIcon iconForWkbType( Qgis::WkbType type );
 
    static QIcon iconPoint();
    static QIcon iconLine();
    static QIcon iconPolygon();
    static QIcon iconTable();
    static QIcon iconRaster();
    static QIcon iconDefault();
    static QIcon iconMesh();
    static QIcon iconVectorTile();
    static QIcon iconPointCloud();
    virtual QString layerName() const { return name(); }
    QgsAbstractDatabaseProviderConnection *databaseConnection() const override;

    const QgsLayerMetadata &layerMetadata() const;

    void setLayerMetadata( const QgsLayerMetadata &metadata );
 
  private:
    QgsLayerMetadata mLayerMetadata;
};
 
#endif // QGSLAYERITEM_H