qgsprovidersublayerdetails.h

Go to the documentation of this file.

/***************************************************************************
                             qgsprovidersublayerdetails.h
                             ----------------------------
    begin                : May 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 QGSPROVIDERSUBLAYERDETAILS_H
#define QGSPROVIDERSUBLAYERDETAILS_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgscoordinatetransformcontext.h"
#include "qgsmimedatautils.h"
#include "qgswkbtypes.h"
 
#include <QString>
#include <QStringList>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsProviderSublayerDetails
{
  public:
    QString providerKey() const { return mProviderKey; }

    void setProviderKey( const QString &key ) { mProviderKey = key; }

    Qgis::LayerType type() const { return mType; }

    void setType( Qgis::LayerType type ) { mType = type; }

    QString uri() const { return mUri; }

    void setUri( const QString &uri ) { mUri = uri; }

    struct LayerOptions
    {
        explicit LayerOptions( const QgsCoordinateTransformContext &transformContext )
          : transformContext( transformContext )
        {}

        QgsCoordinateTransformContext transformContext;

        bool loadDefaultStyle = true;

        bool loadAllStoredStyle = false;
    };

    QgsMapLayer *toLayer( const LayerOptions &options ) const SIP_FACTORY;

    QString name() const { return mName; }

    void setName( const QString &name ) { mName = name; }

    QString description() const { return mDescription; }

    void setDescription( const QString &description ) { mDescription = description; }

    Qgis::SublayerFlags flags() const { return mFlags; }

    void setFlags( Qgis::SublayerFlags newFlags ) { mFlags = newFlags; }

    QString driverName() const { return mDriverName; }

    void setDriverName( const QString &driver ) { mDriverName = driver; }

    QStringList path() const { return mPath; }

    void setPath( const QStringList &path ) { mPath = path; }

    long long featureCount() const { return mFeatureCount; }

    void setFeatureCount( long long count ) { mFeatureCount = count; }

    Qgis::WkbType wkbType() const { return mWkbType; }

    void setWkbType( Qgis::WkbType type ) { mWkbType = type; }

    QString geometryColumnName() const { return mGeometryColumnName; }

    void setGeometryColumnName( const QString &name ) { mGeometryColumnName = name; }
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsProviderSublayerDetails: %1 - %2>"_s.arg( sipCpp->providerKey(), sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

      int layerNumber() const
    {
      return mLayerNumber;
    }

    void setLayerNumber( int number ) { mLayerNumber = number; }

    void setSkippedContainerScan( bool skipped ) { mSkippedContainerScan = skipped; }

    bool skippedContainerScan() const { return mSkippedContainerScan; }

    QgsMimeDataUtils::Uri toMimeUri() const;
 
    // TODO c++20 - replace with = default
    bool operator==( const QgsProviderSublayerDetails &other ) const;
    bool operator!=( const QgsProviderSublayerDetails &other ) const;
 
  private:
    QString mProviderKey;
    Qgis::LayerType mType = Qgis::LayerType::Vector;
    QString mUri;
    int mLayerNumber = 0;
    QString mName;
    QString mDescription;
    long long mFeatureCount = static_cast< long >( Qgis::FeatureCountState::UnknownCount );
    QString mGeometryColumnName;
    QStringList mPath;
    Qgis::WkbType mWkbType = Qgis::WkbType::Unknown;
    QString mDriverName;
    bool mSkippedContainerScan = false;
    Qgis::SublayerFlags mFlags = Qgis::SublayerFlags();
};
 
#endif //QGSPROVIDERSUBLAYERDETAILS_H