21 #include "qgis_core.h"
64 #define QGSCLIPBOARD_MAPLAYER_MIME "application/qgis.maplayer"
76 Q_PROPERTY( QString name READ name WRITE setName NOTIFY nameChanged )
77 Q_PROPERTY(
int autoRefreshInterval READ autoRefreshInterval WRITE setAutoRefreshInterval NOTIFY autoRefreshIntervalChanged )
78 Q_PROPERTY(
QgsLayerMetadata metadata READ metadata WRITE setMetadata NOTIFY metadataChanged )
81 Q_PROPERTY(
bool isValid READ isValid NOTIFY isValidChanged )
82 Q_PROPERTY(
double opacity READ opacity WRITE setOpacity NOTIFY opacityChanged )
86 QgsMapLayer *layer = qobject_cast<QgsMapLayer *>( sipCpp );
92 switch ( layer->type() )
95 sipType = sipType_QgsVectorLayer;
98 sipType = sipType_QgsRasterLayer;
101 sipType = sipType_QgsPluginLayer;
104 sipType = sipType_QgsMeshLayer;
107 sipType = sipType_QgsVectorTileLayer;
110 sipType = sipType_QgsAnnotationLayer;
113 sipType = sipType_QgsPointCloudLayer;
116 sipType = sipType_QgsGroupLayer;
145 Identifiable = 1 << 0,
151 Q_DECLARE_FLAGS( LayerFlags, LayerFlag )
160 LayerConfiguration = 1 << 0,
162 Symbology3D = 1 << 2,
169 AttributeTable = 1 << 9,
171 CustomProperties = 1 << 11,
172 GeometryOptions = 1 << 12,
178 AllStyleCategories = LayerConfiguration | Symbology | Symbology3D | Labeling | Fields | Forms | Actions |
179 MapTips | Diagrams | AttributeTable | Rendering | CustomProperties | GeometryOptions | Relations | Temporal | Legend | Elevation | Notes,
181 Q_ENUM( StyleCategory )
182 Q_DECLARE_FLAGS( StyleCategories, StyleCategory )
183 Q_FLAG( StyleCategories )
223 QgsMapLayer::LayerFlags flags()
const;
235 void setFlags( QgsMapLayer::LayerFlags flags );
246 virtual Qgis::MapLayerProperties properties()
const;
253 static QString extensionPropertyType(
PropertyType type );
263 void setName(
const QString &name );
269 QString name()
const;
288 void setShortName( const QString &shortName ) { mShortName = shortName; }
295 QString shortName()
const;
302 void setTitle(
const QString &title ) { mTitle = title; }
310 QString
title()
const {
return mTitle; }
318 void setAbstract(
const QString &
abstract ) { mAbstract =
abstract; }
326 QString
abstract()
const {
return mAbstract; }
353 void setDataUrl(
const QString &dataUrl ) { mDataUrl = dataUrl; }
442 Q_DECL_DEPRECATED
void setMetadataUrl(
const QString &metaUrl )
SIP_DEPRECATED;
464 Q_DECL_DEPRECATED
void setMetadataUrlType( const QString &metaUrlType )
SIP_DEPRECATED;
485 Q_DECL_DEPRECATED
void setMetadataUrlFormat( const QString &metaUrlFormat )
SIP_DEPRECATED;
496 Q_DECL_DEPRECATED QString metadataUrlFormat() const
SIP_DEPRECATED;
503 void setBlendMode( QPainter::CompositionMode blendMode );
509 QPainter::CompositionMode blendMode() const;
519 virtual
void setOpacity(
double opacity );
529 virtual
double opacity() const;
532 bool readOnly()
const {
return isReadOnly(); }
556 QgsRectangle wgs84Extent(
bool forceRecalculate =
false )
const;
563 bool isValid()
const;
571 QString publicSource()
const;
578 QString source()
const;
584 virtual QStringList subLayers()
const;
590 virtual void setLayerOrder(
const QStringList &layers );
597 virtual void setSubLayerVisibility(
const QString &name,
bool visible );
605 virtual bool supportsEditing()
const;
608 virtual bool isEditable()
const;
615 virtual bool isModified()
const;
621 virtual bool isSpatial()
const;
632 virtual bool isTemporary()
const;
640 FlagDontResolveLayers = 1 << 0,
641 FlagTrustLayerMetadata = 1 << 1,
642 FlagReadExtentFromXml = 1 << 2,
644 Q_DECLARE_FLAGS( ReadFlags, ReadFlag )
663 bool readLayerXml(
const QDomElement &layerElement,
QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags = QgsMapLayer::ReadFlags() );
682 bool writeLayerXml( QDomElement &layerElement, QDomDocument &document,
const QgsReadWriteContext &context )
const;
688 virtual void resolveReferences(
QgsProject *project );
695 Q_INVOKABLE QStringList customPropertyKeys()
const;
702 Q_INVOKABLE
void setCustomProperty(
const QString &key,
const QVariant &value );
708 Q_INVOKABLE QVariant customProperty(
const QString &value,
const QVariant &defaultValue = QVariant() )
const;
738 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
739 Q_ASSERT( metaEnum.isValid() );
740 if ( !metaEnum.isValid() )
742 QgsDebugMsg( QStringLiteral(
"Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
748 if ( metaEnum.isValid() )
751 QByteArray ba = customProperty( key, metaEnum.valueToKey(
static_cast<int>( defaultValue ) ) ).toString().toUtf8();
752 const char *vs = ba.data();
753 v =
static_cast<T
>( metaEnum.keyToValue( vs, &ok ) );
761 v =
static_cast<T
>( customProperty( key,
static_cast<int>( defaultValue ) ).toInt( &ok ) );
762 if ( metaEnum.isValid() )
764 if ( !ok || !metaEnum.valueToKey(
static_cast<int>( v ) ) )
772 setCustomEnumProperty( key, v );
790 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
791 Q_ASSERT( metaEnum.isValid() );
792 if ( metaEnum.isValid() )
794 setCustomProperty( key, metaEnum.valueToKey(
static_cast<int>( value ) ) );
798 QgsDebugMsg( QStringLiteral(
"Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
816 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
817 Q_ASSERT( metaEnum.isValid() );
818 if ( !metaEnum.isValid() )
820 QgsDebugMsg( QStringLiteral(
"Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
826 if ( metaEnum.isValid() )
829 QByteArray ba = customProperty( key, metaEnum.valueToKeys( defaultValue ) ).toString().toUtf8();
830 const char *vs = ba.data();
831 v =
static_cast<T
>( metaEnum.keysToValue( vs, &ok ) );
836 const int intValue = customProperty( key,
static_cast<int>( defaultValue ) ).toInt( &ok );
837 if ( metaEnum.isValid() )
843 const QByteArray keys = metaEnum.valueToKeys( intValue );
844 const int intValueCheck = metaEnum.keysToValue( keys );
845 if ( intValue != intValueCheck )
856 setCustomFlagProperty( key, v );
880 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
881 Q_ASSERT( metaEnum.isValid() );
882 if ( metaEnum.isValid() )
884 setCustomProperty( key, metaEnum.valueToKeys( value ) );
888 QgsDebugMsg( QStringLiteral(
"Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
898 void removeCustomProperty(
const QString &key );
929 static QString formatLayerName(
const QString &name );
938 virtual QString metadataUri()
const;
946 void exportNamedMetadata( QDomDocument &doc, QString &errorMsg )
const;
957 virtual QString saveDefaultMetadata(
bool &resultFlag
SIP_OUT );
973 QString saveNamedMetadata(
const QString &uri,
bool &resultFlag );
989 virtual QString loadNamedMetadata(
const QString &uri,
bool &resultFlag
SIP_OUT );
1000 virtual QString loadDefaultMetadata(
bool &resultFlag );
1010 bool loadNamedMetadataFromDatabase(
const QString &db,
const QString &uri, QString &qmd );
1019 bool importNamedMetadata( QDomDocument &document, QString &errorMessage );
1028 virtual QString styleURI()
const;
1039 virtual QString loadDefaultStyle(
bool &resultFlag
SIP_OUT );
1065 virtual bool loadNamedStyleFromDatabase(
const QString &db,
const QString &uri, QString &qml
SIP_OUT );
1076 virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg
SIP_OUT,
1097 virtual void exportSldStyle( QDomDocument &doc, QString &errorMsg )
const;
1108 virtual QString saveDefaultStyle(
bool &resultFlag
SIP_OUT );
1125 virtual QString saveNamedStyle(
const QString &uri,
bool &resultFlag
SIP_OUT, StyleCategories categories = AllStyleCategories );
1135 virtual QString saveSldStyle(
const QString &uri,
bool &resultFlag )
const;
1145 virtual QString loadSldStyle(
const QString &uri,
bool &resultFlag );
1147 virtual bool readSld(
const QDomNode &node, QString &errorMessage )
1148 { Q_UNUSED( node ) errorMessage = QStringLiteral(
"Layer type %1 not supported" ).arg(
static_cast<int>( type() ) );
return false; }
1173 virtual bool readStyle(
const QDomNode &node, QString &errorMessage,
1187 StyleCategories categories = AllStyleCategories )
const = 0;
1201 virtual bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage,
const QgsReadWriteContext &context,
1202 StyleCategories categories = AllStyleCategories )
const;
1219 void setDataSource(
const QString &dataSource,
const QString &baseName,
const QString &provider,
bool loadDefaultStyleFlag =
false );
1234 void setDataSource(
const QString &dataSource,
const QString &baseName,
const QString &provider,
const QgsDataProvider::ProviderOptions &options,
bool loadDefaultStyleFlag =
false );
1250 void setDataSource(
const QString &dataSource,
const QString &baseName,
const QString &provider,
const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags );
1255 QString providerType()
const;
1258 QUndoStack *undoStack();
1264 QUndoStack *undoStackStyles();
1326 bool isInScaleRange(
double scale )
const;
1338 double minimumScale()
const;
1350 double maximumScale()
const;
1360 bool hasScaleBasedVisibility()
const;
1368 bool hasAutoRefreshEnabled()
const;
1377 int autoRefreshInterval()
const;
1390 void setAutoRefreshInterval(
int interval );
1398 void setAutoRefreshEnabled(
bool enabled );
1420 virtual QString htmlMetadata()
const;
1423 virtual QDateTime timestamp()
const;
1432 virtual QSet<QgsMapLayerDependency> dependencies()
const;
1456 QString originalXmlProperties()
const;
1465 void setOriginalXmlProperties(
const QString &originalXmlProperties );
1471 static QString generateId(
const QString &layerName );
1523 void setMinimumScale(
double scale );
1534 void setMaximumScale(
double scale );
1543 void setScaleBasedVisibility(
bool enabled );
1553 void triggerRepaint(
bool deferredUpdate =
false );
1561 void trigger3DUpdate();
1567 void emitStyleChanged();
1577 virtual bool setDependencies(
const QSet<QgsMapLayerDependency> &layers );
1584 void setRefreshOnNotifyEnabled(
bool enabled );
1603 SIP_PYOBJECT __repr__();
1605 QString
str = QStringLiteral(
"<QgsMapLayer: '%1' (%2)>" ).arg( sipCpp->name(), sipCpp->dataProvider() ? sipCpp->dataProvider()->name() : QStringLiteral(
"Invalid" ) );
1606 sipRes = PyUnicode_FromString(
str.toUtf8().constData() );
1798 void onNotified(
const QString &message );
1815 virtual void setDataSourcePrivate(
const QString &dataSource,
const QString &baseName,
const QString &provider,
const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags );
1830 void setValid(
bool valid );
1842 virtual bool writeXml( QDomNode &layer_node, QDomDocument &document,
const QgsReadWriteContext &context )
const;
1855 virtual QString encodedSource(
const QString &source,
const QgsReadWriteContext &context )
const;
1869 virtual QString decodedSource(
const QString &source,
const QString &dataProvider,
const QgsReadWriteContext &context )
const;
1876 void readCustomProperties(
const QDomNode &layerNode,
const QString &keyStartsWith = QString() );
1879 void writeCustomProperties( QDomNode &layerNode, QDomDocument &doc )
const;
1882 void readStyleManager(
const QDomNode &layerNode );
1884 void writeStyleManager( QDomNode &layerNode, QDomDocument &doc )
const;
1890 void writeCommonStyle( QDomElement &layerElement, QDomDocument &document,
1892 StyleCategories categories = AllStyleCategories )
const;
1898 void readCommonStyle(
const QDomElement &layerElement,
const QgsReadWriteContext &context,
1899 StyleCategories categories = AllStyleCategories );
1902 void setProviderType(
const QString &providerType );
1907 void connectNotify(
const char *signal )
override;
1922 void invalidateWgs84Extent();
1925 bool mValid =
false;
1965 bool mIsRefreshOnNofifyEnabled =
false;
1974 QgsMapLayer::ReadFlags mReadFlags = QgsMapLayer::ReadFlags();
1981 bool mShouldValidateCrs =
true;
1988 double mLayerOpacity = 1.0;
1995 int mBlockStyleChangedSignal = 0;
2007 QString crsHtmlMetadata()
const;
2020 QString generalHtmlMetadata()
const;
2027 bool &resultFlag, StyleCategories categories = AllStyleCategories );
2029 bool &resultFlag, StyleCategories categories = AllStyleCategories );
2030 bool loadNamedPropertyFromDatabase(
const QString &db,
const QString &uri, QString &xml,
QgsMapLayer::PropertyType type );
2039 virtual bool isReadOnly()
const;
2053 LayerFlags mFlags = LayerFlags( Identifiable | Removable | Searchable );
2056 QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;
2064 double mMinScale = 0;
2066 double mMaxScale = 100000000;
2068 bool mScaleBasedVisibility =
false;
2073 std::unique_ptr< QgsMapLayerServerProperties > mServerProperties;
2076 QUndoStack *mUndoStack =
nullptr;
2078 QUndoStack *mUndoStackStyles =
nullptr;
2090 QTimer *mRefreshTimer =
nullptr;
2108 QString mOriginalXmlProperties;
2111 bool mRepaintRequestedFired =
false;
2114 QString mLegendPlaceholderImage;
2117 friend class TestQgsMapLayer;
Base class for all renderers that may to participate in 3D view.
This class represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
Abstract base class for spatial data provider implementations.
QgsErrorMessage represents single error message.
QgsError is container for error messages (report).
Base class for storage of map layer elevation properties.
The QgsMapLayerLegend class is abstract interface for implementations of legends for one map layer.
Base class for utility classes that encapsulate information necessary for rendering of map layers.
Manages QGIS Server properties for a map layer.
Management of styles for use with one map layer.
Base class for storage of map layer temporal properties.
Base class for all map layer types.
virtual bool writeSymbology(QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories) const =0
Write the style for the layer into the document provided.
QString legendUrlFormat() const
Returns the format for a URL based layer legend.
void dependenciesChanged()
Emitted when dependencies are changed.
void setError(const QgsError &error)
Sets error message.
void legendChanged()
Signal emitted when legend of the layer has changed.
void setAbstract(const QString &abstract)
Sets the abstract of the layer used by QGIS Server in GetCapabilities request.
void editingStopped()
Emitted when edited changes have been successfully written to the data provider.
void recalculateExtents() const
This is used to send a request that any mapcanvas using this layer update its extents.
void metadataChanged()
Emitted when the layer's metadata is changed.
void setLegendUrl(const QString &legendUrl)
Sets the URL for the layer's legend.
void request3DUpdate()
Signal emitted when a layer requires an update in any 3D maps.
void configChanged()
Emitted whenever the configuration is changed.
void autoRefreshIntervalChanged(int interval)
Emitted when the auto refresh interval changes.
T customFlagProperty(const QString &key, const T &defaultValue)
Returns the property value for a property based on a flag.
Q_DECL_DEPRECATED bool hasDependencyCycle(const QSet< QgsMapLayerDependency > &) const
Checks whether a new set of dependencies will introduce a cycle this method is now deprecated and alw...
void editingStarted()
Emitted when editing on this layer has started.
void isValidChanged()
Emitted when the validity of this layer changed.
QString legendPlaceholderImage() const
Returns path to the placeholder image or an empty string if a generated legend is shown.
QString attribution() const
Returns the attribution of the layer used by QGIS Server in GetCapabilities request.
QString mRefreshOnNofifyMessage
QString mLegendUrl
WMS legend.
QString mLayerName
Name of the layer - used for display.
void setCustomFlagProperty(const QString &key, const T &value)
Set the value of a property based on a flag.
void setAttributionUrl(const QString &attribUrl)
Sets the attribution URL of the layer used by QGIS Server in GetCapabilities request.
const QgsMapLayerServerProperties * serverProperties() const
Returns QGIS Server Properties const for the map layer.
void renderer3DChanged()
Signal emitted when 3D renderer associated with the layer has changed.
QString dataUrlFormat() const
Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
QgsMapLayerServerProperties * serverProperties()
Returns QGIS Server Properties for the map layer.
void statusChanged(const QString &status)
Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar)
void setDataUrl(const QString &dataUrl)
Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.
QgsMapLayer(QgsMapLayer const &)=delete
QgsMapLayer cannot be copied.
void setKeywordList(const QString &keywords)
Sets the keyword list of the layer used by QGIS Server in GetCapabilities request.
void setAttribution(const QString &attrib)
Sets the attribution of the layer used by QGIS Server in GetCapabilities request.
bool isRefreshOnNotifyEnabled() const
Returns true if the refresh on provider nofification is enabled.
QSet< QgsMapLayerDependency > mDependencies
List of layers that may modify this layer on modification.
void setDataUrlFormat(const QString &dataUrlFormat)
Sets the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
virtual QgsMapLayerRenderer * createMapRenderer(QgsRenderContext &rendererContext)=0
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
QString mProviderKey
Data provider key (name of the data provider)
void styleChanged()
Signal emitted whenever a change affects the layer's style.
void rendererChanged()
Signal emitted when renderer is changed.
QString title() const
Returns the title of the layer used by QGIS Server in GetCapabilities request.
void crsChanged()
Emit a signal that layer's CRS has been reset.
void dataSourceChanged()
Emitted whenever the layer's data source has been changed.
QString dataUrl() const
Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.
virtual QgsMapLayer * clone() const =0
Returns a new instance equivalent to this one except for the id which is still unique.
void setRefreshOnNofifyMessage(const QString &message)
Set the notification message that triggers repaint If refresh on notification is enabled,...
void opacityChanged(double opacity)
Emitted when the layer's opacity is changed, where opacity is a value between 0 (transparent) and 1 (...
void styleLoaded(QgsMapLayer::StyleCategories categories)
Emitted when a style has been loaded.
void dataChanged()
Data of layer changed.
void willBeDeleted()
Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid...
void blendModeChanged(QPainter::CompositionMode blendMode)
Signal emitted when the blend mode is changed, through QgsMapLayer::setBlendMode()
virtual bool readSymbology(const QDomNode &node, QString &errorMessage, QgsReadWriteContext &context, StyleCategories categories=AllStyleCategories)=0
Read the symbology for the current layer from the DOM node supplied.
LayerFlag
Flags for the map layer.
void setLegendPlaceholderImage(const QString &imgPath)
Set placeholder image for legend.
void appendError(const QgsErrorMessage &error)
Add error message.
QgsMapLayer & operator=(QgsMapLayer const &)=delete
QgsMapLayer cannot be copied.
QString mDataSource
Data source description string, varies by layer type.
QString refreshOnNotifyMessage() const
Returns the message that should be notified by the provider to triggerRepaint.
virtual bool readSld(const QDomNode &node, QString &errorMessage)
ReadFlag
Flags which control project read behavior.
QString attributionUrl() const
Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request.
QString mAbstract
Description of the layer.
void customPropertyChanged(const QString &key)
Emitted when a custom property of the layer has been changed or removed.
QString legendUrl() const
Returns the URL for the layer's legend.
void flagsChanged()
Emitted when layer's flags have been modified.
void repaintRequested(bool deferredUpdate=false)
By emitting this signal the layer tells that either appearance or content have been changed and any v...
void setLegendUrlFormat(const QString &legendUrlFormat)
Sets the format for a URL based layer legend.
void beforeResolveReferences(QgsProject *project)
Emitted when all layers are loaded and references can be resolved, just before the references of this...
virtual void setTransformContext(const QgsCoordinateTransformContext &transformContext)=0
Sets the coordinate transform context to transformContext.
virtual QgsMapLayerElevationProperties * elevationProperties()
Returns the layer's elevation properties.
void nameChanged()
Emitted when the name has been changed.
QString mDataUrl
DataUrl of the layer.
T customEnumProperty(const QString &key, const T &defaultValue)
Returns the property value for a property based on an enum.
StyleCategory
Categories of style to distinguish appropriate sections for import/export.
void layerModified()
Emitted when modifications has been done on layer.
virtual Q_INVOKABLE void reload()
Synchronises with changes in the datasource.
virtual QgsMapLayerTemporalProperties * temporalProperties()
Returns the layer's temporal properties.
QString mAttribution
Attribution of the layer.
void setCustomEnumProperty(const QString &key, const T &value)
Set the value of a property based on an enum.
QString keywordList() const
Returns the keyword list of the layer used by QGIS Server in GetCapabilities request.
void setTitle(const QString &title)
Sets the title of the layer used by QGIS Server in GetCapabilities request.
PropertyType
Maplayer has a style and a metadata property.
Simple key-value store (keys = strings, values = variants) that supports loading/saving to/from XML i...
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
The class is used as a container of context for various read/write operations on other objects.
A rectangle specified with double values.
Contains information about the context of a rendering operation.
An interface for classes which can visit style entity (e.g.
Represents a vector layer which manages a vector based data sets.
QgsMapLayerType
Types of layers that can be added to a map.
@ PointCloudLayer
Point cloud layer. Added in QGIS 3.18.
@ MeshLayer
Mesh layer. Added in QGIS 3.2.
@ VectorLayer
Vector layer.
@ RasterLayer
Raster layer.
@ GroupLayer
Composite group layer. Added in QGIS 3.24.
@ VectorTileLayer
Vector tile layer. Added in QGIS 3.14.
@ AnnotationLayer
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ PluginLayer
Plugin based layer.
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsField::ConfigurationFlags) CORE_EXPORT QDataStream &operator<<(QDataStream &out
Writes the field to stream out. QGIS version compatibility is not guaranteed.
QPointer< QgsMapLayer > QgsWeakMapLayerPointer
Weak pointer for QgsMapLayer.
QList< QgsWeakMapLayerPointer > QgsWeakMapLayerPointerList
A list of weak pointers to QgsMapLayers.
Q_DECLARE_METATYPE(QgsMeshTimeSettings)
const QgsCoordinateReferenceSystem & crs
Setting options for creating vector data providers.