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;
142 Identifiable = 1 << 0,
148 Q_DECLARE_FLAGS( LayerFlags, LayerFlag )
157 LayerConfiguration = 1 << 0,
159 Symbology3D = 1 << 2,
166 AttributeTable = 1 << 9,
168 CustomProperties = 1 << 11,
169 GeometryOptions = 1 << 12,
175 AllStyleCategories = LayerConfiguration | Symbology | Symbology3D | Labeling | Fields | Forms | Actions |
176 MapTips | Diagrams | AttributeTable | Rendering | CustomProperties | GeometryOptions | Relations | Temporal | Legend | Elevation | Notes,
178 Q_ENUM( StyleCategory )
179 Q_DECLARE_FLAGS( StyleCategories, StyleCategory )
180 Q_FLAG( StyleCategories )
220 QgsMapLayer::LayerFlags flags()
const;
232 void setFlags( QgsMapLayer::LayerFlags flags );
243 virtual Qgis::MapLayerProperties properties()
const;
250 static QString extensionPropertyType(
PropertyType type );
260 void setName(
const QString &name );
266 QString name()
const;
285 void setShortName( const QString &shortName ) { mShortName = shortName; }
292 QString shortName()
const;
299 void setTitle(
const QString &title ) { mTitle = title; }
307 QString
title()
const {
return mTitle; }
315 void setAbstract(
const QString &
abstract ) { mAbstract =
abstract; }
323 QString
abstract()
const {
return mAbstract; }
350 void setDataUrl(
const QString &dataUrl ) { mDataUrl = dataUrl; }
439 Q_DECL_DEPRECATED
void setMetadataUrl(
const QString &metaUrl )
SIP_DEPRECATED;
461 Q_DECL_DEPRECATED
void setMetadataUrlType( const QString &metaUrlType )
SIP_DEPRECATED;
482 Q_DECL_DEPRECATED
void setMetadataUrlFormat( const QString &metaUrlFormat )
SIP_DEPRECATED;
493 Q_DECL_DEPRECATED QString metadataUrlFormat() const
SIP_DEPRECATED;
500 void setBlendMode( QPainter::CompositionMode blendMode );
506 QPainter::CompositionMode blendMode() const;
516 virtual
void setOpacity(
double opacity );
526 virtual
double opacity() const;
529 bool readOnly()
const {
return isReadOnly(); }
553 QgsRectangle wgs84Extent(
bool forceRecalculate =
false )
const;
560 bool isValid()
const;
568 QString publicSource()
const;
575 QString source()
const;
581 virtual QStringList subLayers()
const;
587 virtual void setLayerOrder(
const QStringList &layers );
594 virtual void setSubLayerVisibility(
const QString &name,
bool visible );
602 virtual bool supportsEditing()
const;
605 virtual bool isEditable()
const;
612 virtual bool isModified()
const;
618 virtual bool isSpatial()
const;
629 virtual bool isTemporary()
const;
637 FlagDontResolveLayers = 1 << 0,
638 FlagTrustLayerMetadata = 1 << 1,
639 FlagReadExtentFromXml = 1 << 2,
641 Q_DECLARE_FLAGS( ReadFlags, ReadFlag )
660 bool readLayerXml(
const QDomElement &layerElement,
QgsReadWriteContext &context, QgsMapLayer::ReadFlags flags = QgsMapLayer::ReadFlags() );
679 bool writeLayerXml( QDomElement &layerElement, QDomDocument &document,
const QgsReadWriteContext &context )
const;
685 virtual void resolveReferences(
QgsProject *project );
692 Q_INVOKABLE QStringList customPropertyKeys()
const;
699 Q_INVOKABLE
void setCustomProperty(
const QString &key,
const QVariant &value );
705 Q_INVOKABLE QVariant customProperty(
const QString &value,
const QVariant &defaultValue = QVariant() )
const;
735 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
736 Q_ASSERT( metaEnum.isValid() );
737 if ( !metaEnum.isValid() )
739 QgsDebugMsg( QStringLiteral(
"Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
745 if ( metaEnum.isValid() )
748 QByteArray ba = customProperty( key, metaEnum.valueToKey(
static_cast<int>( defaultValue ) ) ).toString().toUtf8();
749 const char *vs = ba.data();
750 v =
static_cast<T
>( metaEnum.keyToValue( vs, &ok ) );
758 v =
static_cast<T
>( customProperty( key,
static_cast<int>( defaultValue ) ).toInt( &ok ) );
759 if ( metaEnum.isValid() )
761 if ( !ok || !metaEnum.valueToKey(
static_cast<int>( v ) ) )
769 setCustomEnumProperty( key, v );
787 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
788 Q_ASSERT( metaEnum.isValid() );
789 if ( metaEnum.isValid() )
791 setCustomProperty( key, metaEnum.valueToKey(
static_cast<int>( value ) ) );
795 QgsDebugMsg( QStringLiteral(
"Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
813 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
814 Q_ASSERT( metaEnum.isValid() );
815 if ( !metaEnum.isValid() )
817 QgsDebugMsg( QStringLiteral(
"Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
823 if ( metaEnum.isValid() )
826 QByteArray ba = customProperty( key, metaEnum.valueToKeys( defaultValue ) ).toString().toUtf8();
827 const char *vs = ba.data();
828 v =
static_cast<T
>( metaEnum.keysToValue( vs, &ok ) );
833 const int intValue = customProperty( key,
static_cast<int>( defaultValue ) ).toInt( &ok );
834 if ( metaEnum.isValid() )
840 const QByteArray keys = metaEnum.valueToKeys( intValue );
841 const int intValueCheck = metaEnum.keysToValue( keys );
842 if ( intValue != intValueCheck )
853 setCustomFlagProperty( key, v );
877 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
878 Q_ASSERT( metaEnum.isValid() );
879 if ( metaEnum.isValid() )
881 setCustomProperty( key, metaEnum.valueToKeys( value ) );
885 QgsDebugMsg( QStringLiteral(
"Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
895 void removeCustomProperty(
const QString &key );
926 static QString formatLayerName(
const QString &name );
935 virtual QString metadataUri()
const;
943 void exportNamedMetadata( QDomDocument &doc, QString &errorMsg )
const;
954 virtual QString saveDefaultMetadata(
bool &resultFlag
SIP_OUT );
970 QString saveNamedMetadata(
const QString &uri,
bool &resultFlag );
986 virtual QString loadNamedMetadata(
const QString &uri,
bool &resultFlag
SIP_OUT );
997 virtual QString loadDefaultMetadata(
bool &resultFlag );
1007 bool loadNamedMetadataFromDatabase(
const QString &db,
const QString &uri, QString &qmd );
1016 bool importNamedMetadata( QDomDocument &document, QString &errorMessage );
1025 virtual QString styleURI()
const;
1036 virtual QString loadDefaultStyle(
bool &resultFlag
SIP_OUT );
1062 virtual bool loadNamedStyleFromDatabase(
const QString &db,
const QString &uri, QString &qml
SIP_OUT );
1073 virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg
SIP_OUT,
1094 virtual void exportSldStyle( QDomDocument &doc, QString &errorMsg )
const;
1105 virtual QString saveDefaultStyle(
bool &resultFlag
SIP_OUT );
1122 virtual QString saveNamedStyle(
const QString &uri,
bool &resultFlag
SIP_OUT, StyleCategories categories = AllStyleCategories );
1132 virtual QString saveSldStyle(
const QString &uri,
bool &resultFlag )
const;
1142 virtual QString loadSldStyle(
const QString &uri,
bool &resultFlag );
1144 virtual bool readSld(
const QDomNode &node, QString &errorMessage )
1145 { Q_UNUSED( node ) errorMessage = QStringLiteral(
"Layer type %1 not supported" ).arg(
static_cast<int>( type() ) );
return false; }
1170 virtual bool readStyle(
const QDomNode &node, QString &errorMessage,
1184 StyleCategories categories = AllStyleCategories )
const = 0;
1198 virtual bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage,
const QgsReadWriteContext &context,
1199 StyleCategories categories = AllStyleCategories )
const;
1216 void setDataSource(
const QString &dataSource,
const QString &baseName,
const QString &provider,
bool loadDefaultStyleFlag =
false );
1231 void setDataSource(
const QString &dataSource,
const QString &baseName,
const QString &provider,
const QgsDataProvider::ProviderOptions &options,
bool loadDefaultStyleFlag =
false );
1247 void setDataSource(
const QString &dataSource,
const QString &baseName,
const QString &provider,
const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags );
1252 QString providerType()
const;
1255 QUndoStack *undoStack();
1261 QUndoStack *undoStackStyles();
1323 bool isInScaleRange(
double scale )
const;
1335 double minimumScale()
const;
1347 double maximumScale()
const;
1357 bool hasScaleBasedVisibility()
const;
1365 bool hasAutoRefreshEnabled()
const;
1374 int autoRefreshInterval()
const;
1387 void setAutoRefreshInterval(
int interval );
1395 void setAutoRefreshEnabled(
bool enabled );
1417 virtual QString htmlMetadata()
const;
1420 virtual QDateTime timestamp()
const;
1429 virtual QSet<QgsMapLayerDependency> dependencies()
const;
1453 QString originalXmlProperties()
const;
1462 void setOriginalXmlProperties(
const QString &originalXmlProperties );
1468 static QString generateId(
const QString &layerName );
1520 void setMinimumScale(
double scale );
1531 void setMaximumScale(
double scale );
1540 void setScaleBasedVisibility(
bool enabled );
1550 void triggerRepaint(
bool deferredUpdate =
false );
1558 void trigger3DUpdate();
1564 void emitStyleChanged();
1574 virtual bool setDependencies(
const QSet<QgsMapLayerDependency> &layers );
1581 void setRefreshOnNotifyEnabled(
bool enabled );
1600 SIP_PYOBJECT __repr__();
1602 QString
str = QStringLiteral(
"<QgsMapLayer: '%1' (%2)>" ).arg( sipCpp->name(), sipCpp->dataProvider() ? sipCpp->dataProvider()->name() : QStringLiteral(
"Invalid" ) );
1603 sipRes = PyUnicode_FromString(
str.toUtf8().constData() );
1795 void onNotified(
const QString &message );
1812 virtual void setDataSourcePrivate(
const QString &dataSource,
const QString &baseName,
const QString &provider,
const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags );
1827 void setValid(
bool valid );
1839 virtual bool writeXml( QDomNode &layer_node, QDomDocument &document,
const QgsReadWriteContext &context )
const;
1852 virtual QString encodedSource(
const QString &source,
const QgsReadWriteContext &context )
const;
1866 virtual QString decodedSource(
const QString &source,
const QString &dataProvider,
const QgsReadWriteContext &context )
const;
1873 void readCustomProperties(
const QDomNode &layerNode,
const QString &keyStartsWith = QString() );
1876 void writeCustomProperties( QDomNode &layerNode, QDomDocument &doc )
const;
1879 void readStyleManager(
const QDomNode &layerNode );
1881 void writeStyleManager( QDomNode &layerNode, QDomDocument &doc )
const;
1887 void writeCommonStyle( QDomElement &layerElement, QDomDocument &document,
1889 StyleCategories categories = AllStyleCategories )
const;
1895 void readCommonStyle(
const QDomElement &layerElement,
const QgsReadWriteContext &context,
1896 StyleCategories categories = AllStyleCategories );
1899 void setProviderType(
const QString &providerType );
1904 void connectNotify(
const char *signal )
override;
1919 void invalidateWgs84Extent();
1922 bool mValid =
false;
1962 bool mIsRefreshOnNofifyEnabled =
false;
1971 QgsMapLayer::ReadFlags mReadFlags = QgsMapLayer::ReadFlags();
1978 bool mShouldValidateCrs =
true;
1985 double mLayerOpacity = 1.0;
1992 int mBlockStyleChangedSignal = 0;
2004 QString crsHtmlMetadata()
const;
2017 QString generalHtmlMetadata()
const;
2024 bool &resultFlag, StyleCategories categories = AllStyleCategories );
2026 bool &resultFlag, StyleCategories categories = AllStyleCategories );
2027 bool loadNamedPropertyFromDatabase(
const QString &db,
const QString &uri, QString &xml,
QgsMapLayer::PropertyType type );
2036 virtual bool isReadOnly()
const;
2050 LayerFlags mFlags = LayerFlags( Identifiable | Removable | Searchable );
2053 QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;
2061 double mMinScale = 0;
2063 double mMaxScale = 100000000;
2065 bool mScaleBasedVisibility =
false;
2070 std::unique_ptr< QgsMapLayerServerProperties > mServerProperties;
2073 QUndoStack *mUndoStack =
nullptr;
2075 QUndoStack *mUndoStackStyles =
nullptr;
2087 QTimer *mRefreshTimer =
nullptr;
2105 QString mOriginalXmlProperties;
2108 bool mRepaintRequestedFired =
false;
2111 QString mLegendPlaceholderImage;
2114 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
Added in 3.18.
@ VectorTileLayer
Added in 3.14.
@ AnnotationLayer
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
#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.