qgsmaplayer.h

Go to the documentation of this file.

/***************************************************************************
                          qgsmaplayer.h  -  description
                             -------------------
    begin                : Fri Jun 28 2002
    copyright            : (C) 2002 by Gary E.Sherman
    email                : sherman at mrcc.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 QGSMAPLAYER_H
#define QGSMAPLAYER_H
 
#include "qgis_core.h"
#include <QDateTime>
#include <QDomNode>
#include <QImage>
#include <QObject>
#include <QPainter>
#include <QUndoStack>
#include <QVariant>
#include <QIcon>
 
#include "qgis_sip.h"
#include "qgserror.h"
#include "qgsobjectcustomproperties.h"
#include "qgsrectangle.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsrendercontext.h"
#include "qgsmaplayerdependency.h"
#include "qgslayermetadata.h"
#include "qgsmaplayerstyle.h"
#include "qgsreadwritecontext.h"
#include "qgsdataprovider.h"
 
class QgsAbstract3DRenderer;
class QgsDataProvider;
class QgsMapLayerLegend;
class QgsMapLayerRenderer;
class QgsMapLayerStyleManager;
class QgsProject;
class QgsStyleEntityVisitorInterface;
class QgsMapLayerTemporalProperties;
 
class QDomDocument;
class QKeyEvent;
class QPainter;
 
/*
 * Constants used to describe copy-paste MIME types
 */
#define QGSCLIPBOARD_MAPLAYER_MIME "application/qgis.maplayer"
 
 
enum class QgsMapLayerType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsMapLayer, LayerType ) : int
  {
  VectorLayer,
  RasterLayer,
  PluginLayer,
  MeshLayer,      
  VectorTileLayer 
};
 
class CORE_EXPORT QgsMapLayer : public QObject
{
    Q_OBJECT
 
    Q_PROPERTY( QString name READ name WRITE setName NOTIFY nameChanged )
    Q_PROPERTY( int autoRefreshInterval READ autoRefreshInterval WRITE setAutoRefreshInterval NOTIFY autoRefreshIntervalChanged )
    Q_PROPERTY( QgsLayerMetadata metadata READ metadata WRITE setMetadata NOTIFY metadataChanged )
    Q_PROPERTY( QgsCoordinateReferenceSystem crs READ crs WRITE setCrs NOTIFY crsChanged )
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    QgsMapLayer * layer = qobject_cast<QgsMapLayer *>( sipCpp );
 
    sipType = 0;
 
    if ( layer )
    {
      switch ( layer->type() )
      {
        case QgsMapLayerType::VectorLayer:
          sipType = sipType_QgsVectorLayer;
          break;
        case QgsMapLayerType::RasterLayer:
          sipType = sipType_QgsRasterLayer;
          break;
        case QgsMapLayerType::PluginLayer:
          sipType = sipType_QgsPluginLayer;
          break;
        case QgsMapLayerType::MeshLayer:
          sipType = sipType_QgsMeshLayer;
          break;
        case QgsMapLayerType::VectorTileLayer:
          sipType = sipType_QgsVectorTileLayer;
          break;
        default:
          sipType = nullptr;
          break;
      }
    }
    SIP_END
#endif
 
  public:
 
    enum PropertyType
    {
      Style = 0,
      Metadata,
    };
 
    enum LayerFlag
    {
      Identifiable = 1 << 0, 
      Removable = 1 << 1,    
      Searchable = 1 << 2,   
    };
    Q_ENUM( LayerFlag )
    Q_DECLARE_FLAGS( LayerFlags, LayerFlag )
    Q_FLAG( LayerFlags )
 
    
    enum StyleCategory
    {
      LayerConfiguration = 1 << 0,  
      Symbology          = 1 << 1,  
      Symbology3D        = 1 << 2,  
      Labeling           = 1 << 3,  
      Fields             = 1 << 4,  
      Forms              = 1 << 5,  
      Actions            = 1 << 6,  
      MapTips            = 1 << 7,  
      Diagrams           = 1 << 8,  
      AttributeTable     = 1 << 9,  
      Rendering          = 1 << 10, 
      CustomProperties   = 1 << 11, 
      GeometryOptions    = 1 << 12, 
      Relations          = 1 << 13, 
      Temporal           = 1 << 14, 
      AllStyleCategories = LayerConfiguration | Symbology | Symbology3D | Labeling | Fields | Forms | Actions |
                           MapTips | Diagrams | AttributeTable | Rendering | CustomProperties | GeometryOptions | Relations | Temporal,
    };
    Q_ENUM( StyleCategory )
    Q_DECLARE_FLAGS( StyleCategories, StyleCategory )
    Q_FLAG( StyleCategories )
 
    
    QgsMapLayer( QgsMapLayerType type = QgsMapLayerType::VectorLayer, const QString &name = QString(), const QString &source = QString() );
 
    ~QgsMapLayer() override;
 
    QgsMapLayer( QgsMapLayer const & ) = delete;
    QgsMapLayer &operator=( QgsMapLayer const & ) = delete;
 
    virtual QgsMapLayer *clone() const = 0;
 
    QgsMapLayerType type() const;
 
    QgsMapLayer::LayerFlags flags() const;
 
    void setFlags( QgsMapLayer::LayerFlags flags );
 
    static QString extensionPropertyType( PropertyType type );
 
    QString id() const;
 
    void setName( const QString &name );
 
    QString name() const;
 
    virtual QgsDataProvider *dataProvider();
 
    virtual const QgsDataProvider *dataProvider() const SIP_SKIP;
 
    void setShortName( const QString &shortName ) { mShortName = shortName; }
 
    QString shortName() const;
 
    void setTitle( const QString &title ) { mTitle = title; }
 
    QString title() const { return mTitle; }
 
    void setAbstract( const QString &abstract ) { mAbstract = abstract; }
 
    QString abstract() const { return mAbstract; }
 
    void setKeywordList( const QString &keywords ) { mKeywordList = keywords; }
 
    QString keywordList() const { return mKeywordList; }
 
    /* Layer dataUrl information */
 
    void setDataUrl( const QString &dataUrl ) { mDataUrl = dataUrl; }
 
    QString dataUrl() const { return mDataUrl; }
 
    void setDataUrlFormat( const QString &dataUrlFormat ) { mDataUrlFormat = dataUrlFormat; }
 
    QString dataUrlFormat() const { return mDataUrlFormat; }
 
    /* Layer attribution information */
 
    void setAttribution( const QString &attrib ) { mAttribution = attrib; }
 
    QString attribution() const { return mAttribution; }
 
    void setAttributionUrl( const QString &attribUrl ) { mAttributionUrl = attribUrl; }
 
    QString attributionUrl() const { return mAttributionUrl; }
 
    /* Layer metadataUrl information */
 
    void setMetadataUrl( const QString &metaUrl ) { mMetadataUrl = metaUrl; }
 
    QString metadataUrl() const { return mMetadataUrl; }
 
    void setMetadataUrlType( const QString &metaUrlType ) { mMetadataUrlType = metaUrlType; }
 
    QString metadataUrlType() const { return mMetadataUrlType; }
 
    void setMetadataUrlFormat( const QString &metaUrlFormat ) { mMetadataUrlFormat = metaUrlFormat; }
 
    QString metadataUrlFormat() const { return mMetadataUrlFormat; }
 
    void setBlendMode( QPainter::CompositionMode blendMode );
 
    QPainter::CompositionMode blendMode() const;
 
    bool readOnly() const { return isReadOnly(); }
 
    virtual void reload() {}
 
    virtual QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) = 0 SIP_FACTORY;
 
    virtual QgsRectangle extent() const;
 
    bool isValid() const;
 
    QString publicSource() const;
 
    QString source() const;
 
    virtual QStringList subLayers() const;
 
    virtual void setLayerOrder( const QStringList &layers );
 
    virtual void setSubLayerVisibility( const QString &name, bool visible );
 
    virtual bool isEditable() const;
 
    virtual bool isSpatial() const;
 
    virtual bool isTemporary() const;
 
    enum ReadFlag
    {
      FlagDontResolveLayers = 1 << 0, 
    };
    Q_DECLARE_FLAGS( ReadFlags, ReadFlag )
 
    
    bool readLayerXml( const QDomElement &layerElement, QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags = QgsMapLayer::ReadFlags() );
 
    bool writeLayerXml( QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context ) const;
 
    virtual void resolveReferences( QgsProject *project );
 
    Q_INVOKABLE QStringList customPropertyKeys() const;
 
    Q_INVOKABLE void setCustomProperty( const QString &key, const QVariant &value );
 
    Q_INVOKABLE QVariant customProperty( const QString &value, const QVariant &defaultValue = QVariant() ) const;
 
    void setCustomProperties( const QgsObjectCustomProperties &properties );
 
    const QgsObjectCustomProperties &customProperties() const;
 
    void removeCustomProperty( const QString &key );
 
    virtual QgsError error() const;
 
    QgsCoordinateReferenceSystem crs() const;
 
    void setCrs( const QgsCoordinateReferenceSystem &srs, bool emitSignal = true );
 
    QgsCoordinateTransformContext transformContext( ) const;
 
 
    static QString formatLayerName( const QString &name );
 
    virtual QString metadataUri() const;
 
    void exportNamedMetadata( QDomDocument &doc, QString &errorMsg ) const;
 
    virtual QString saveDefaultMetadata( bool &resultFlag SIP_OUT );
 
    QString saveNamedMetadata( const QString &uri, bool &resultFlag );
 
    virtual QString loadNamedMetadata( const QString &uri, bool &resultFlag SIP_OUT );
 
    QString loadDefaultMetadata( bool &resultFlag );
 
    bool loadNamedMetadataFromDatabase( const QString &db, const QString &uri, QString &qmd );
 
    bool importNamedMetadata( QDomDocument &document, QString &errorMessage );
 
    virtual QString styleURI() const;
 
    virtual QString loadDefaultStyle( bool &resultFlag SIP_OUT );
 
    virtual QString loadNamedStyle( const QString &uri, bool &resultFlag SIP_OUT, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories );
 
    virtual bool loadNamedStyleFromDatabase( const QString &db, const QString &uri, QString &qml SIP_OUT );
 
    virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg SIP_OUT,
                                   QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories );
 
    virtual void exportNamedStyle( QDomDocument &doc, QString &errorMsg SIP_OUT, const QgsReadWriteContext &context = QgsReadWriteContext(),
                                   QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories ) const;
 
 
    virtual void exportSldStyle( QDomDocument &doc, QString &errorMsg ) const;
 
    virtual QString saveDefaultStyle( bool &resultFlag SIP_OUT );
 
    virtual QString saveNamedStyle( const QString &uri, bool &resultFlag SIP_OUT, StyleCategories categories = AllStyleCategories );
 
    virtual QString saveSldStyle( const QString &uri, bool &resultFlag ) const;
 
    virtual QString loadSldStyle( const QString &uri, bool &resultFlag );
 
    virtual bool readSld( const QDomNode &node, QString &errorMessage )
    { Q_UNUSED( node ) errorMessage = QStringLiteral( "Layer type %1 not supported" ).arg( static_cast<int>( type() ) ); return false; }
 
 
 
    virtual bool readSymbology( const QDomNode &node, QString &errorMessage,
                                QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) = 0;
 
    virtual bool readStyle( const QDomNode &node, QString &errorMessage,
                            QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories );
 
    virtual bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context,
                                 StyleCategories categories = AllStyleCategories ) const = 0;
 
    virtual bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context,
                             StyleCategories categories = AllStyleCategories ) const;
 
 
    virtual void setDataSource( const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, bool loadDefaultStyleFlag = false );
 
    QString providerType() const;
 
    QUndoStack *undoStack();
 
    QUndoStack *undoStackStyles();
 
    void setLegendUrl( const QString &legendUrl ) { mLegendUrl = legendUrl; }
 
    QString legendUrl() const { return mLegendUrl; }
 
    void setLegendUrlFormat( const QString &legendUrlFormat ) { mLegendUrlFormat = legendUrlFormat; }
 
    QString legendUrlFormat() const { return mLegendUrlFormat; }
 
    void setLegend( QgsMapLayerLegend *legend SIP_TRANSFER );
 
    QgsMapLayerLegend *legend() const;
 
    QgsMapLayerStyleManager *styleManager() const;
 
    void setRenderer3D( QgsAbstract3DRenderer *renderer SIP_TRANSFER );
 
    QgsAbstract3DRenderer *renderer3D() const;
 
    bool isInScaleRange( double scale ) const;
 
    double minimumScale() const;
 
    double maximumScale() const;
 
    bool hasScaleBasedVisibility() const;
 
    bool hasAutoRefreshEnabled() const;
 
    int autoRefreshInterval() const;
 
    void setAutoRefreshInterval( int interval );
 
    void setAutoRefreshEnabled( bool enabled );
 
    virtual const QgsLayerMetadata &metadata() const;
 
    virtual void setMetadata( const QgsLayerMetadata &metadata );
 
    virtual QString htmlMetadata() const;
 
    virtual QDateTime timestamp() const;
 
    virtual QSet<QgsMapLayerDependency> dependencies() const;
 
    QString refreshOnNotifyMessage() const { return mRefreshOnNofifyMessage; }
 
    bool isRefreshOnNotifyEnabled() const { return mIsRefreshOnNofifyEnabled; }
 
    QString originalXmlProperties() const;
 
    void setOriginalXmlProperties( const QString &originalXmlProperties );
 
    static QString generateId( const QString &layerName );
 
    virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
 
    virtual QgsMapLayerTemporalProperties *temporalProperties() { return nullptr; }
 
  public slots:
 
    void setMinimumScale( double scale );
 
    void setMaximumScale( double scale );
 
    void setScaleBasedVisibility( bool enabled );
 
    void triggerRepaint( bool deferredUpdate = false );
 
    void emitStyleChanged();
 
    virtual bool setDependencies( const QSet<QgsMapLayerDependency> &layers );
 
    void setRefreshOnNotifyEnabled( bool enabled );
 
    void setRefreshOnNofifyMessage( const QString &message ) { mRefreshOnNofifyMessage = message; }
 
    virtual void setTransformContext( const QgsCoordinateTransformContext &transformContext ) = 0;
 
#ifdef SIP_RUN
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = QStringLiteral( "<QgsMapLayer: '%1' (%2)>" ).arg( sipCpp->name(), sipCpp->dataProvider() ? sipCpp->dataProvider()->name() : QStringLiteral( "Invalid" ) );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
#endif
 
  signals:
 
    void beforeResolveReferences( QgsProject *project );
 
    void statusChanged( const QString &status );
 
    void nameChanged();
 
    void crsChanged();
 
    void repaintRequested( bool deferredUpdate = false );
 
    void recalculateExtents() const;
 
    void dataChanged();
 
    void blendModeChanged( QPainter::CompositionMode blendMode );
 
    void rendererChanged();
 
    void styleChanged();
 
    void legendChanged();
 
    void renderer3DChanged();
 
    void configChanged();
 
    void dependenciesChanged();
 
    void willBeDeleted();
 
    void autoRefreshIntervalChanged( int interval );
 
    void metadataChanged();
 
    void flagsChanged();
 
    void dataSourceChanged();
 
    void styleLoaded( QgsMapLayer::StyleCategories categories );
 
 
  private slots:
 
    void onNotifiedTriggerRepaint( const QString &message );
 
  protected:
 
    void clone( QgsMapLayer *layer ) const;
 
    virtual void setExtent( const QgsRectangle &rect );
 
    void setValid( bool valid );
 
    virtual bool readXml( const QDomNode &layer_node, QgsReadWriteContext &context );
 
    virtual bool writeXml( QDomNode &layer_node, QDomDocument &document, const QgsReadWriteContext &context ) const;
 
    virtual QString encodedSource( const QString &source, const QgsReadWriteContext &context ) const;
 
    virtual QString decodedSource( const QString &source, const QString &dataProvider, const QgsReadWriteContext &context ) const;
 
    void readCustomProperties( const QDomNode &layerNode, const QString &keyStartsWith = QString() );
 
    void writeCustomProperties( QDomNode &layerNode, QDomDocument &doc ) const;
 
    void readStyleManager( const QDomNode &layerNode );
    void writeStyleManager( QDomNode &layerNode, QDomDocument &doc ) const;
 
    void writeCommonStyle( QDomElement &layerElement, QDomDocument &document,
                           const QgsReadWriteContext &context,
                           StyleCategories categories = AllStyleCategories ) const;
 
    void readCommonStyle( const QDomElement &layerElement, const QgsReadWriteContext &context,
                          StyleCategories categories = AllStyleCategories );
 
    void setProviderType( const QString &providerType );
 
#ifndef SIP_RUN
#if 0
    void connectNotify( const char *signal ) override;
#endif
#endif
 
    void appendError( const QgsErrorMessage &error ) { mError.append( error );}
    void setError( const QgsError &error ) { mError = error;}
 
    mutable QgsRectangle mExtent;
 
    bool mValid = false;
 
    QString mDataSource;
 
    QString mLayerName;
 
    QString mShortName;
    QString mTitle;
 
    QString mAbstract;
    QString mKeywordList;
 
    QString mDataUrl;
    QString mDataUrlFormat;
 
    QString mAttribution;
    QString mAttributionUrl;
 
    QString mMetadataUrl;
    QString mMetadataUrlType;
    QString mMetadataUrlFormat;
 
    QString mLegendUrl;
    QString mLegendUrlFormat;
 
    QgsError mError;
 
    QSet<QgsMapLayerDependency> mDependencies;
 
    Q_DECL_DEPRECATED bool hasDependencyCycle( const QSet<QgsMapLayerDependency> & ) const {return false;}
 
    bool mIsRefreshOnNofifyEnabled = false;
    QString mRefreshOnNofifyMessage;
 
    QString mProviderKey;
 
    //TODO QGIS 4 - move to readXml as a new argument (breaks API)
 
    QgsMapLayer::ReadFlags mReadFlags = QgsMapLayer::ReadFlags();
 
    bool mShouldValidateCrs = true;
 
  private:
 
    virtual QString baseURI( PropertyType type ) const;
    QString saveNamedProperty( const QString &uri, QgsMapLayer::PropertyType type,
                               bool &resultFlag, StyleCategories categories = AllStyleCategories );
    QString loadNamedProperty( const QString &uri, QgsMapLayer::PropertyType type,
                               bool &resultFlag, StyleCategories categories = AllStyleCategories );
    bool loadNamedPropertyFromDatabase( const QString &db, const QString &uri, QString &xml, QgsMapLayer::PropertyType type );
 
    virtual bool isReadOnly() const;
 
    QgsCoordinateReferenceSystem mCRS;
 
    QString mID;
 
    QgsMapLayerType mLayerType;
 
    LayerFlags mFlags = LayerFlags( Identifiable | Removable | Searchable );
 
    QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;
 
    QString mTag;
 
    //set some generous  defaults for scale based visibility
 
    double mMinScale = 0;
    double mMaxScale = 100000000;
    bool mScaleBasedVisibility = false;
 
    QUndoStack *mUndoStack = nullptr;
 
    QUndoStack *mUndoStackStyles = nullptr;
 
    QgsObjectCustomProperties mCustomProperties;
 
    QgsMapLayerLegend *mLegend = nullptr;
 
    QgsMapLayerStyleManager *mStyleManager = nullptr;
 
    QTimer *mRefreshTimer = nullptr;
 
    QgsLayerMetadata mMetadata;
 
    QgsAbstract3DRenderer *m3DRenderer = nullptr;
 
    QString mOriginalXmlProperties;
 
    bool mRepaintRequestedFired = false;
};
 
Q_DECLARE_METATYPE( QgsMapLayer * )
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapLayer::LayerFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapLayer::StyleCategories )
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapLayer::ReadFlags )
 
 
#ifndef SIP_RUN
 
typedef QPointer< QgsMapLayer > QgsWeakMapLayerPointer;
 
typedef QList< QgsWeakMapLayerPointer > QgsWeakMapLayerPointerList;
#endif
 
#endif