QGIS API Documentation 3.41.0-Master (092dc69654e)
Loading...
Searching...
No Matches
qgsmaplayer.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmaplayer.h - description
3 -------------------
4 begin : Fri Jun 28 2002
5 copyright : (C) 2002 by Gary E.Sherman
6 email : sherman at mrcc.com
7***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSMAPLAYER_H
19#define QGSMAPLAYER_H
20
21#include "qgis_core.h"
22#include <QDateTime>
23#include <QDomNode>
24#include <QImage>
25#include <QObject>
26#include <QPainter>
27#include <QUndoStack>
28#include <QVariant>
29#include <QIcon>
30#include <QSet>
31
32#include "qgis_sip.h"
33#include "qgserror.h"
35#include "qgsrectangle.h"
38#include "qgslayermetadata.h"
40#include "qgsreadwritecontext.h"
41#include "qgsdataprovider.h"
42#include "qgis.h"
43#include "qgslogger.h"
44
46class QgsDataProvider;
50class QgsProject;
57
58class QDomDocument;
59class QKeyEvent;
60class QPainter;
62class QgsBox3D;
63
64/*
65 * Constants used to describe copy-paste MIME types
66 */
67#define QGSCLIPBOARD_MAPLAYER_MIME "application/qgis.maplayer"
68
69
75class CORE_EXPORT QgsMapLayer : public QObject
76{
77 Q_OBJECT
78
79 Q_PROPERTY( QString id READ id WRITE setId NOTIFY idChanged )
80 Q_PROPERTY( QString name READ name WRITE setName NOTIFY nameChanged )
81 Q_PROPERTY( int autoRefreshInterval READ autoRefreshInterval WRITE setAutoRefreshInterval NOTIFY autoRefreshIntervalChanged )
82 Q_PROPERTY( QgsLayerMetadata metadata READ metadata WRITE setMetadata NOTIFY metadataChanged )
83 Q_PROPERTY( QgsCoordinateReferenceSystem crs READ crs WRITE setCrs NOTIFY crsChanged )
84 Q_PROPERTY( QgsCoordinateReferenceSystem verticalCrs READ verticalCrs WRITE setVerticalCrs NOTIFY verticalCrsChanged )
85 Q_PROPERTY( QgsCoordinateReferenceSystem crs3D READ crs3D NOTIFY crs3DChanged )
86 Q_PROPERTY( Qgis::LayerType type READ type CONSTANT )
87 Q_PROPERTY( bool isValid READ isValid NOTIFY isValidChanged )
88 Q_PROPERTY( double opacity READ opacity WRITE setOpacity NOTIFY opacityChanged )
89 Q_PROPERTY( QString mapTipTemplate READ mapTipTemplate WRITE setMapTipTemplate NOTIFY mapTipTemplateChanged )
90 Q_PROPERTY( bool mapTipsEnabled READ mapTipsEnabled WRITE setMapTipsEnabled NOTIFY mapTipsEnabledChanged )
91
92#ifdef SIP_RUN
94 QgsMapLayer *layer = qobject_cast<QgsMapLayer *>( sipCpp );
95
96 sipType = 0;
97
98 if ( layer )
99 {
100 switch ( layer->type() )
101 {
103 sipType = sipType_QgsVectorLayer;
104 break;
106 sipType = sipType_QgsRasterLayer;
107 break;
109 sipType = sipType_QgsPluginLayer;
110 break;
112 sipType = sipType_QgsMeshLayer;
113 break;
115 sipType = sipType_QgsVectorTileLayer;
116 break;
118 sipType = sipType_QgsAnnotationLayer;
119 break;
121 sipType = sipType_QgsPointCloudLayer;
122 break;
124 sipType = sipType_QgsGroupLayer;
125 break;
127 sipType = sipType_QgsTiledSceneLayer;
128 break;
129 default:
130 sipType = nullptr;
131 break;
132 }
133 }
134 SIP_END
135#endif
136
137 public:
138
143 {
144 Style = 0,
146 };
147
154 {
155 Identifiable = 1 << 0,
156 Removable = 1 << 1,
157 Searchable = 1 << 2,
158 Private = 1 << 3,
159 };
160 Q_ENUM( LayerFlag )
161 Q_DECLARE_FLAGS( LayerFlags, LayerFlag )
162 Q_FLAG( LayerFlags )
163
169 {
170 LayerConfiguration = 1 << 0,
171 Symbology = 1 << 1,
172 Symbology3D = 1 << 2,
173 Labeling = 1 << 3,
174 Fields = 1 << 4,
175 Forms = 1 << 5,
176 Actions = 1 << 6,
177 MapTips = 1 << 7,
178 Diagrams = 1 << 8,
179 AttributeTable = 1 << 9,
180 Rendering = 1 << 10,
181 CustomProperties = 1 << 11,
182 GeometryOptions = 1 << 12,
183 Relations = 1 << 13,
184 Temporal = 1 << 14,
185 Legend = 1 << 15,
186 Elevation = 1 << 16,
187 Notes = 1 << 17,
188 AllStyleCategories = LayerConfiguration | Symbology | Symbology3D | Labeling | Fields | Forms | Actions |
189 MapTips | Diagrams | AttributeTable | Rendering | CustomProperties | GeometryOptions | Relations | Temporal | Legend | Elevation | Notes,
190 };
191 Q_ENUM( StyleCategory )
192 Q_DECLARE_FLAGS( StyleCategories, StyleCategory )
193 Q_FLAG( StyleCategories )
194
201 QgsMapLayer( Qgis::LayerType type = Qgis::LayerType::Vector, const QString &name = QString(), const QString &source = QString() );
202
203 ~QgsMapLayer() override;
204
205 QgsMapLayer( const QgsMapLayer & ) = delete;
206 QgsMapLayer &operator=( const QgsMapLayer & ) = delete;
207
213 virtual QgsMapLayer *clone() const = 0;
214
218 Qgis::LayerType type() const;
219
230 QgsMapLayer::LayerFlags flags() const;
231
242 void setFlags( QgsMapLayer::LayerFlags flags );
243
253 virtual Qgis::MapLayerProperties properties() const;
254
259 static QString extensionPropertyType( PropertyType type );
260
267 QString id() const;
268
284 bool setId( const QString &id );
285
290 void setName( const QString &name );
291
296 QString name() const;
297
301 Q_INVOKABLE virtual QgsDataProvider *dataProvider();
302
307 virtual const QgsDataProvider *dataProvider() const SIP_SKIP;
308
313 QgsProviderMetadata *providerMetadata() const;
314
320 Q_DECL_DEPRECATED void setShortName( const QString &shortName ) SIP_DEPRECATED;
321
327 Q_DECL_DEPRECATED QString shortName() const SIP_DEPRECATED;
328
334 Q_DECL_DEPRECATED void setTitle( const QString &title ) SIP_DEPRECATED;
335
341 Q_DECL_DEPRECATED QString title() const SIP_DEPRECATED;
342
348 Q_DECL_DEPRECATED void setAbstract( const QString &abstract ) SIP_DEPRECATED;
349
355 Q_DECL_DEPRECATED QString abstract() const SIP_DEPRECATED;
356
362 Q_DECL_DEPRECATED void setKeywordList( const QString &keywords ) SIP_DEPRECATED;
363
369 Q_DECL_DEPRECATED QString keywordList() const SIP_DEPRECATED;
370
376 Q_DECL_DEPRECATED void setDataUrl( const QString &dataUrl ) SIP_DEPRECATED;
377
383 Q_DECL_DEPRECATED QString dataUrl() const SIP_DEPRECATED;
384
390 Q_DECL_DEPRECATED void setDataUrlFormat( const QString &dataUrlFormat ) SIP_DEPRECATED;
391
397 Q_DECL_DEPRECATED QString dataUrlFormat() const SIP_DEPRECATED;
398
404 Q_DECL_DEPRECATED void setAttribution( const QString &attrib ) SIP_DEPRECATED;
405
411 Q_DECL_DEPRECATED QString attribution() const SIP_DEPRECATED;
412
418 Q_DECL_DEPRECATED void setAttributionUrl( const QString &attribUrl ) SIP_DEPRECATED;
419
425 Q_DECL_DEPRECATED QString attributionUrl() const SIP_DEPRECATED;
426
427 /* Layer metadataUrl information */
428
433 QgsMapLayerServerProperties *serverProperties() { return mServerProperties.get(); };
434
439 const QgsMapLayerServerProperties *serverProperties() const { return mServerProperties.get(); } SIP_SKIP;
440
449 Q_DECL_DEPRECATED void setMetadataUrl( const QString &metaUrl ) SIP_DEPRECATED;
450
460 Q_DECL_DEPRECATED QString metadataUrl() const SIP_DEPRECATED;
461
470 Q_DECL_DEPRECATED void setMetadataUrlType( const QString &metaUrlType ) SIP_DEPRECATED;
471
481 Q_DECL_DEPRECATED QString metadataUrlType() const SIP_DEPRECATED;
482
491 Q_DECL_DEPRECATED void setMetadataUrlFormat( const QString &metaUrlFormat ) SIP_DEPRECATED;
492
502 Q_DECL_DEPRECATED QString metadataUrlFormat() const SIP_DEPRECATED;
503
509 void setBlendMode( QPainter::CompositionMode blendMode );
510
515 QPainter::CompositionMode blendMode() const;
516
525 virtual void setOpacity( double opacity );
526
535 virtual double opacity() const;
536
538 bool readOnly() const { return isReadOnly(); }
539
543 Q_INVOKABLE virtual void reload() {}
544
549
551 virtual QgsRectangle extent() const;
552
557 virtual QgsBox3D extent3D() const;
558
567 QgsRectangle wgs84Extent( bool forceRecalculate = false ) const;
568
574 bool isValid() const;
575
583 QString publicSource( bool hidePassword = false ) const;
584
590 QString source() const;
591
596 virtual QStringList subLayers() const;
597
602 virtual void setLayerOrder( const QStringList &layers );
603
609 virtual void setSubLayerVisibility( const QString &name, bool visible );
610
617 virtual bool supportsEditing() const;
618
620 virtual bool isEditable() const;
621
627 virtual bool isModified() const;
628
632 virtual bool isSpatial() const;
633
643 virtual bool isTemporary() const;
644
650 {
651 FlagDontResolveLayers = 1 << 0,
652 FlagTrustLayerMetadata = 1 << 1,
653 FlagReadExtentFromXml = 1 << 2,
654 FlagForceReadOnly = 1 << 3,
655 };
656 Q_DECLARE_FLAGS( ReadFlags, ReadFlag )
657
658
675 bool readLayerXml( const QDomElement &layerElement, QgsReadWriteContext &context,
676 QgsMapLayer::ReadFlags flags = QgsMapLayer::ReadFlags(), QgsDataProvider *preloadedProvider SIP_TRANSFER = nullptr );
677
693 bool writeLayerXml( QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context ) const;
694
698 virtual void resolveReferences( QgsProject *project );
699
704 Q_INVOKABLE QStringList customPropertyKeys() const;
705
711 Q_INVOKABLE void setCustomProperty( const QString &key, const QVariant &value );
712
717 Q_INVOKABLE QVariant customProperty( const QString &value, const QVariant &defaultValue = QVariant() ) const;
718
722 void setCustomProperties( const QgsObjectCustomProperties &properties );
723
729 const QgsObjectCustomProperties &customProperties() const;
730
740 virtual int listStylesInDatabase( QStringList &ids SIP_OUT, QStringList &names SIP_OUT,
741 QStringList &descriptions SIP_OUT, QString &msgError SIP_OUT );
742
746 virtual QString getStyleFromDatabase( const QString &styleId, QString &msgError SIP_OUT );
747
754 virtual bool deleteStyleFromDatabase( const QString &styleId, QString &msgError SIP_OUT );
755
772 virtual void saveStyleToDatabase( const QString &name, const QString &description,
773 bool useAsDefault, const QString &uiFileContent,
774 QString &msgError SIP_OUT,
776
777
778 // TODO QGIS 4.0 -- fix this. We incorrectly have a single boolean flag which in which false is used inconsistently for "a style WAS found but an error occurred loading it" vs "no style was found".
779 // The first (style found, error occurred loading it) should trigger a user-facing warning, whereas the second (no style found) isn't reflective of an error at all.
780
791 virtual QString loadNamedStyle( const QString &theURI, bool &resultFlag SIP_OUT, bool loadFromLocalDb,
794
795#ifndef SIP_RUN
796
807 template <class T>
808 T customEnumProperty( const QString &key, const T &defaultValue )
809 {
810 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
811 Q_ASSERT( metaEnum.isValid() );
812 if ( !metaEnum.isValid() )
813 {
814 QgsDebugError( QStringLiteral( "Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
815 }
816
817 T v;
818 bool ok = false;
819
820 if ( metaEnum.isValid() )
821 {
822 // read as string
823 QByteArray ba = customProperty( key, metaEnum.valueToKey( static_cast<int>( defaultValue ) ) ).toString().toUtf8();
824 const char *vs = ba.data();
825 v = static_cast<T>( metaEnum.keyToValue( vs, &ok ) );
826 if ( ok )
827 return v;
828 }
829
830 // if failed, try to read as int (old behavior)
831 // this code shall be removed later
832 // then the method could be marked as const
833 v = static_cast<T>( customProperty( key, static_cast<int>( defaultValue ) ).toInt( &ok ) );
834 if ( metaEnum.isValid() )
835 {
836 if ( !ok || !metaEnum.valueToKey( static_cast<int>( v ) ) )
837 {
838 v = defaultValue;
839 }
840 else
841 {
842 // found property as an integer
843 // convert the property to the new form (string)
844 setCustomEnumProperty( key, v );
845 }
846 }
847
848 return v;
849 }
850
859 template <class T>
860 void setCustomEnumProperty( const QString &key, const T &value )
861 {
862 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
863 Q_ASSERT( metaEnum.isValid() );
864 if ( metaEnum.isValid() )
865 {
866 setCustomProperty( key, metaEnum.valueToKey( static_cast<int>( value ) ) );
867 }
868 else
869 {
870 QgsDebugError( QStringLiteral( "Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
871 }
872 }
873
885 template <class T>
886 T customFlagProperty( const QString &key, const T &defaultValue )
887 {
888 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
889 Q_ASSERT( metaEnum.isValid() );
890 if ( !metaEnum.isValid() )
891 {
892 QgsDebugError( QStringLiteral( "Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
893 }
894
895 T v = defaultValue;
896 bool ok = false;
897
898 if ( metaEnum.isValid() )
899 {
900 // read as string
901 QByteArray ba = customProperty( key, metaEnum.valueToKeys( defaultValue ) ).toString().toUtf8();
902 const char *vs = ba.data();
903 v = static_cast<T>( metaEnum.keysToValue( vs, &ok ) );
904 }
905 if ( !ok )
906 {
907 // if failed, try to read as int
908 const int intValue = customProperty( key, static_cast<int>( defaultValue ) ).toInt( &ok );
909 if ( metaEnum.isValid() )
910 {
911 if ( ok )
912 {
913 // check that the int value does correspond to a flag
914 // see https://stackoverflow.com/a/68495949/1548052
915 const QByteArray keys = metaEnum.valueToKeys( intValue );
916 const int intValueCheck = metaEnum.keysToValue( keys );
917 if ( intValue != intValueCheck )
918 {
919 v = defaultValue;
920 }
921 else
922 {
923 // found property as an integer
924 v = T( intValue );
925 // convert the property to the new form (string)
926 // this code could be removed
927 // then the method could be marked as const
928 setCustomFlagProperty( key, v );
929 }
930 }
931 else
932 {
933 v = defaultValue;
934 }
935 }
936 }
937
938 return v;
939 }
940
949 template <class T>
950 void setCustomFlagProperty( const QString &key, const T &value )
951 {
952 const QMetaEnum metaEnum = QMetaEnum::fromType<T>();
953 Q_ASSERT( metaEnum.isValid() );
954 if ( metaEnum.isValid() )
955 {
956 setCustomProperty( key, metaEnum.valueToKeys( value ) );
957 }
958 else
959 {
960 QgsDebugError( QStringLiteral( "Invalid metaenum. Enum probably misses Q_ENUM or Q_FLAG declaration." ) );
961 }
962 }
963#endif
964
965
970 void removeCustomProperty( const QString &key );
971
977 virtual QgsError error() const;
978
991
1010 QgsCoordinateReferenceSystem verticalCrs() const;
1011
1030 QgsCoordinateReferenceSystem crs3D() const;
1031
1042 void setCrs( const QgsCoordinateReferenceSystem &srs, bool emitSignal = true );
1043
1063 bool setVerticalCrs( const QgsCoordinateReferenceSystem &crs, QString *errorMessage SIP_OUT = nullptr );
1064
1070 QgsCoordinateTransformContext transformContext( ) const;
1071
1072
1077 static QString formatLayerName( const QString &name );
1078
1085 virtual QString metadataUri() const;
1086
1092 void exportNamedMetadata( QDomDocument &doc, QString &errorMsg ) const;
1093
1102 virtual QString saveDefaultMetadata( bool &resultFlag SIP_OUT );
1103
1117 QString saveNamedMetadata( const QString &uri, bool &resultFlag );
1118
1119 // TODO QGIS 4.0 -- fix this. We incorrectly have a single boolean flag which in which false is used inconsistently for "metadata WAS found but an error occurred loading it" vs "no metadata was found".
1120 // The first (metadata found, error occurred loading it) should trigger a user-facing warning, whereas the second (no metadata found) isn't reflective of an error at all.
1121
1135 virtual QString loadNamedMetadata( const QString &uri, bool &resultFlag SIP_OUT );
1136
1137 // TODO QGIS 4.0 -- fix this. We incorrectly have a single boolean flag which in which false is used inconsistently for "metadata WAS found but an error occurred loading it" vs "no metadata was found".
1138 // The first (metadata found, error occurred loading it) should trigger a user-facing warning, whereas the second (no metadata found) isn't reflective of an error at all.
1139
1148 virtual QString loadDefaultMetadata( bool &resultFlag );
1149
1157 bool loadNamedMetadataFromDatabase( const QString &db, const QString &uri, QString &qmd );
1158
1165 bool importNamedMetadata( QDomDocument &document, QString &errorMessage );
1166
1175 virtual QString styleURI() const;
1176
1177 // TODO QGIS 4.0 -- fix this. We incorrectly have a single boolean flag which in which false is used inconsistently for "a style WAS found but an error occurred loading it" vs "no style was found".
1178 // The first (style found, error occurred loading it) should trigger a user-facing warning, whereas the second (no style found) isn't reflective of an error at all.
1179
1189 virtual QString loadDefaultStyle( bool &resultFlag SIP_OUT );
1190
1191 // TODO QGIS 4.0 -- fix this. We incorrectly have a single boolean flag which in which false is used inconsistently for "a style WAS found but an error occurred loading it" vs "no style was found".
1192 // The first (style found, error occurred loading it) should trigger a user-facing warning, whereas the second (no style found) isn't reflective of an error at all.
1193
1210 virtual QString loadNamedStyle( const QString &uri, bool &resultFlag SIP_OUT, QgsMapLayer::StyleCategories categories = QgsMapLayer::AllStyleCategories, Qgis::LoadStyleFlags flags = Qgis::LoadStyleFlags() );
1211
1219 virtual bool loadNamedStyleFromDatabase( const QString &db, const QString &uri, QString &qml SIP_OUT );
1220
1229 virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg SIP_OUT,
1231
1240 virtual void exportNamedStyle( QDomDocument &doc, QString &errorMsg SIP_OUT, const QgsReadWriteContext &context = QgsReadWriteContext(),
1242
1243
1251 virtual void exportSldStyle( QDomDocument &doc, QString &errorMsg ) const;
1252
1261 virtual void exportSldStyleV2( QDomDocument &doc, QString &errorMsg, const QgsSldExportContext &exportContext ) const;
1262
1274 virtual QString saveDefaultStyle( bool &resultFlag SIP_OUT, StyleCategories categories );
1275
1287 Q_DECL_DEPRECATED virtual QString saveDefaultStyle( bool &resultFlag SIP_OUT ) SIP_DEPRECATED;
1288
1304 virtual QString saveNamedStyle( const QString &uri, bool &resultFlag SIP_OUT, StyleCategories categories = AllStyleCategories );
1305
1315 virtual QString saveSldStyle( const QString &uri, bool &resultFlag ) const;
1316
1327 virtual QString saveSldStyleV2( bool &resultFlag SIP_OUT, const QgsSldExportContext &exportContext ) const;
1328
1337 virtual QString loadSldStyle( const QString &uri, bool &resultFlag );
1338
1339 virtual bool readSld( const QDomNode &node, QString &errorMessage )
1340 { Q_UNUSED( node ) errorMessage = QStringLiteral( "Layer type %1 not supported" ).arg( static_cast<int>( type() ) ); return false; }
1341
1342
1343
1352 virtual bool readSymbology( const QDomNode &node, QString &errorMessage,
1353 QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories ) = 0;
1354
1364 virtual bool readStyle( const QDomNode &node, QString &errorMessage,
1365 QgsReadWriteContext &context, StyleCategories categories = AllStyleCategories );
1366
1377 virtual bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context,
1378 StyleCategories categories = AllStyleCategories ) const = 0;
1379
1391 virtual bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context,
1392 StyleCategories categories = AllStyleCategories ) const;
1393
1394
1425 void setDataSource( const QString &dataSource, const QString &baseName = QString(), const QString &provider = QString(), bool loadDefaultStyleFlag = false );
1426
1456 void setDataSource( const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, bool loadDefaultStyleFlag = false );
1457
1487 void setDataSource( const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags );
1488
1492 QString providerType() const;
1493
1495 QUndoStack *undoStack();
1496
1500 QUndoStack *undoStackStyles();
1501
1505 void setLegendUrl( const QString &legendUrl ) { mLegendUrl = legendUrl; }
1506
1510 QString legendUrl() const { return mLegendUrl; }
1511
1515 void setLegendUrlFormat( const QString &legendUrlFormat ) { mLegendUrlFormat = legendUrlFormat; }
1516
1520 QString legendUrlFormat() const { return mLegendUrlFormat; }
1521
1526 void setLegend( QgsMapLayerLegend *legend SIP_TRANSFER );
1527
1531 QgsMapLayerLegend *legend() const;
1532
1536 QgsMapLayerStyleManager *styleManager() const;
1537
1541 void setRenderer3D( QgsAbstract3DRenderer *renderer SIP_TRANSFER );
1542
1546 QgsAbstract3DRenderer *renderer3D() const;
1547
1556 bool isInScaleRange( double scale ) const;
1557
1568 double minimumScale() const;
1569
1580 double maximumScale() const;
1581
1590 bool hasScaleBasedVisibility() const;
1591
1598 Q_DECL_DEPRECATED bool hasAutoRefreshEnabled() const SIP_DEPRECATED;
1599
1606 Qgis::AutoRefreshMode autoRefreshMode() const;
1607
1614 int autoRefreshInterval() const;
1615
1626 void setAutoRefreshInterval( int interval );
1627
1634 Q_DECL_DEPRECATED void setAutoRefreshEnabled( bool enabled ) SIP_DEPRECATED;
1635
1642 void setAutoRefreshMode( Qgis::AutoRefreshMode mode );
1643
1649 virtual const QgsLayerMetadata &metadata() const;
1650
1656 virtual void setMetadata( const QgsLayerMetadata &metadata );
1657
1661 virtual QString htmlMetadata() const;
1662
1664 virtual QDateTime timestamp() const;
1665
1672 virtual QSet<QgsMapLayerDependency> dependencies() const;
1673
1678 QString refreshOnNotifyMessage() const { return mRefreshOnNofifyMessage; }
1679
1684 bool isRefreshOnNotifyEnabled() const { return mIsRefreshOnNofifyEnabled; }
1685
1694 QString originalXmlProperties() const;
1695
1703 void setOriginalXmlProperties( const QString &originalXmlProperties );
1704
1709 static QString generateId( const QString &layerName );
1710
1720 virtual bool accept( QgsStyleEntityVisitorInterface *visitor ) const;
1721
1728
1735
1742
1748 QString legendPlaceholderImage() const { return mLegendPlaceholderImage;}
1749
1755 void setLegendPlaceholderImage( const QString &imgPath ) { mLegendPlaceholderImage = imgPath; }
1756
1763 virtual bool hasMapTips() const;
1764
1772 QString mapTipTemplate() const;
1773
1781 void setMapTipTemplate( const QString &mapTipTemplate );
1782
1789 void setMapTipsEnabled( bool enabled );
1790
1795 bool mapTipsEnabled() const;
1796
1804 static Qgis::DataProviderReadFlags providerReadFlags( const QDomNode &layerNode, QgsMapLayer::ReadFlags layerReadFlags );
1805
1806 public slots:
1807
1817 void setMinimumScale( double scale );
1818
1828 void setMaximumScale( double scale );
1829
1837 void setScaleBasedVisibility( bool enabled );
1838
1847 void triggerRepaint( bool deferredUpdate = false );
1848
1855 void trigger3DUpdate();
1856
1860 void emitStyleChanged();
1861
1869 virtual bool setDependencies( const QSet<QgsMapLayerDependency> &layers );
1870
1875 void setRefreshOnNotifyEnabled( bool enabled );
1876
1883 void setRefreshOnNofifyMessage( const QString &message ) { mRefreshOnNofifyMessage = message; }
1884
1890 virtual void setTransformContext( const QgsCoordinateTransformContext &transformContext ) = 0;
1891
1892#ifdef SIP_RUN
1893 SIP_PYOBJECT __repr__();
1894 % MethodCode
1895 QString str = QStringLiteral( "<QgsMapLayer: '%1' (%2)>" ).arg( sipCpp->name(), sipCpp->dataProvider() ? sipCpp->dataProvider()->name() : QStringLiteral( "Invalid" ) );
1896 sipRes = PyUnicode_FromString( str.toUtf8().constData() );
1897 % End
1898#endif
1899
1906 QgsProject *project() const;
1907
1908 signals:
1909
1917
1919 void statusChanged( const QString &status );
1920
1929 void idChanged( const QString &id );
1930
1935
1945
1956
1973
1980 void repaintRequested( bool deferredUpdate = false );
1981
1984
1987
1989 void blendModeChanged( QPainter::CompositionMode blendMode );
1990
1999 void opacityChanged( double opacity );
2000
2006
2018
2023
2028
2035
2041
2046
2053
2058 void autoRefreshIntervalChanged( int interval );
2059
2066
2074
2083
2090
2097
2103 void customPropertyChanged( const QString &key );
2104
2110
2116
2122
2129
2137
2138 private slots:
2139
2140 void onNotified( const QString &message );
2141
2157 virtual void setDataSourcePrivate( const QString &dataSource, const QString &baseName, const QString &provider, const QgsDataProvider::ProviderOptions &options, Qgis::DataProviderReadFlags flags );
2158
2159 protected:
2160
2165 void clone( QgsMapLayer *layer ) const;
2166
2168 virtual void setExtent( const QgsRectangle &rect );
2169
2174 virtual void setExtent3D( const QgsBox3D &box );
2175
2177 void setValid( bool valid );
2178
2183 virtual bool readXml( const QDomNode &layer_node, QgsReadWriteContext &context );
2184
2189 virtual bool writeXml( QDomNode &layer_node, QDomDocument &document, const QgsReadWriteContext &context ) const;
2190
2202 virtual QString encodedSource( const QString &source, const QgsReadWriteContext &context ) const;
2203
2216 virtual QString decodedSource( const QString &source, const QString &dataProvider, const QgsReadWriteContext &context ) const;
2217
2223 void readCustomProperties( const QDomNode &layerNode, const QString &keyStartsWith = QString() );
2224
2226 void writeCustomProperties( QDomNode &layerNode, QDomDocument &doc ) const;
2227
2229 void readStyleManager( const QDomNode &layerNode );
2231 void writeStyleManager( QDomNode &layerNode, QDomDocument &doc ) const;
2232
2236 void writeCommonStyle( QDomElement &layerElement, QDomDocument &document,
2237 const QgsReadWriteContext &context,
2238 StyleCategories categories = AllStyleCategories ) const;
2239
2243 void readCommonStyle( const QDomElement &layerElement, const QgsReadWriteContext &context,
2244 StyleCategories categories = AllStyleCategories );
2245
2247 void setProviderType( const QString &providerType );
2248
2249#ifndef SIP_RUN
2250#if 0
2252 void connectNotify( const char *signal ) override;
2253#endif
2254#endif
2255
2257 void appendError( const QgsErrorMessage &error ) { mError.append( error );}
2259 void setError( const QgsError &error ) { mError = error;}
2260
2267 void invalidateWgs84Extent();
2268
2270 bool mValid = false;
2271
2274
2276 QString mLayerName;
2277
2279 QString mLegendUrl;
2281
2284
2286 QSet<QgsMapLayerDependency> mDependencies;
2287
2293 Q_DECL_DEPRECATED bool hasDependencyCycle( const QSet<QgsMapLayerDependency> & ) const {return false;}
2294
2295 bool mIsRefreshOnNofifyEnabled = false;
2297
2300
2301 //TODO QGIS 4 - move to readXml as a new argument (breaks API)
2302
2305
2311 bool mShouldValidateCrs = true;
2312
2318 double mLayerOpacity = 1.0;
2319
2325 int mBlockStyleChangedSignal = 0;
2326
2327#ifndef SIP_RUN
2328
2337 QString crsHtmlMetadata() const;
2338#endif
2339
2340#ifndef SIP_RUN
2341
2350 QString generalHtmlMetadata() const;
2351
2360 QString customPropertyHtmlMetadata() const;
2361#endif
2362
2363#ifndef SIP_RUN
2364
2372 std::unique_ptr<QgsDataProvider> mPreloadedProvider;
2373#endif
2374
2375 private:
2376
2377 virtual QString baseURI( PropertyType type ) const;
2378 QString saveNamedProperty( const QString &uri, QgsMapLayer::PropertyType type,
2379 bool &resultFlag, StyleCategories categories = AllStyleCategories );
2380 QString loadNamedProperty( const QString &uri, QgsMapLayer::PropertyType type,
2381 bool &namedPropertyExists, bool &propertySuccessfullyLoaded, StyleCategories categories = AllStyleCategories, Qgis::LoadStyleFlags flags = Qgis::LoadStyleFlags() );
2382 bool loadNamedPropertyFromDatabase( const QString &db, const QString &uri, QString &xml, QgsMapLayer::PropertyType type );
2383
2384 // const method because extents are mutable
2385 void updateExtent( const QgsRectangle &extent ) const;
2386 void updateExtent( const QgsBox3D &extent ) const;
2387
2388 bool rebuildCrs3D( QString *error = nullptr );
2389
2394 virtual bool isReadOnly() const;
2395
2401 QgsCoordinateReferenceSystem mVerticalCrs;
2403
2405 QString mID;
2406
2408 Qgis::LayerType mLayerType;
2409
2410 LayerFlags mFlags = LayerFlags( Identifiable | Removable | Searchable );
2411
2413 QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;
2414
2416 QString mTag;
2417
2418 //set some generous defaults for scale based visibility
2419
2421 double mMinScale = 0;
2423 double mMaxScale = 100000000;
2425 bool mScaleBasedVisibility = false;
2426
2430 std::unique_ptr< QgsMapLayerServerProperties > mServerProperties;
2431
2433 QUndoStack *mUndoStack = nullptr;
2434
2435 QUndoStack *mUndoStackStyles = nullptr;
2436
2438 QgsObjectCustomProperties mCustomProperties;
2439
2441 QgsMapLayerLegend *mLegend = nullptr;
2442
2444 QgsMapLayerStyleManager *mStyleManager = nullptr;
2445
2447
2449 QTimer *mRefreshTimer = nullptr;
2450
2451 QgsLayerMetadata mMetadata;
2452
2454 QgsAbstract3DRenderer *m3DRenderer = nullptr;
2455
2457 mutable QgsBox3D mExtent3D;
2458
2460 mutable QgsRectangle mExtent2D;
2461
2463 mutable QgsRectangle mWgs84Extent;
2464
2470 QString mOriginalXmlProperties;
2471
2473 bool mRepaintRequestedFired = false;
2474
2476 QString mLegendPlaceholderImage;
2477
2479 QString mMapTipTemplate;
2480
2482 bool mMapTipsEnabled = true;
2483
2484 friend class QgsVectorLayer;
2485 friend class TestQgsProject;
2486 friend class TestQgsMapLayer;
2487};
2488
2492
2493
2494#ifndef SIP_RUN
2495
2500typedef QPointer< QgsMapLayer > QgsWeakMapLayerPointer;
2501
2506typedef QList< QgsWeakMapLayerPointer > QgsWeakMapLayerPointerList;
2507#endif
2508
2509#endif
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54
QFlags< DataProviderReadFlag > DataProviderReadFlags
Flags which control data provider construction.
Definition qgis.h:450
LayerType
Types of layers that can be added to a map.
Definition qgis.h:169
@ Group
Composite group layer. Added in QGIS 3.24.
@ Plugin
Plugin based layer.
@ TiledScene
Tiled scene layer. Added in QGIS 3.34.
@ Annotation
Contains freeform, georeferenced annotations. Added in QGIS 3.16.
@ Vector
Vector layer.
@ VectorTile
Vector tile layer. Added in QGIS 3.14.
@ Mesh
Mesh layer. Added in QGIS 3.2.
@ Raster
Raster layer.
@ PointCloud
Point cloud layer. Added in QGIS 3.18.
QFlags< LoadStyleFlag > LoadStyleFlags
Flags for loading layer styles.
Definition qgis.h:225
AutoRefreshMode
Map layer automatic refresh modes.
Definition qgis.h:2128
@ Disabled
Automatic refreshing is disabled.
Base class for all renderers that may to participate in 3D view.
A 3-dimensional box composed of x, y, z coordinates.
Definition qgsbox3d.h:43
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.
Definition qgserror.h:33
A container for error messages.
Definition qgserror.h:81
A structured metadata store for a map layer.
This class models dependencies with or between map layers.
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.
Base class for storage of map layer selection properties.
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.
Definition qgsmaplayer.h:76
void crs3DChanged()
Emitted when the crs3D() of the layer has changed.
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.
QFlags< ReadFlag > ReadFlags
QFlags< LayerFlag > LayerFlags
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.
QgsError mError
Error.
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 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 mapTipTemplateChanged()
Emitted when the map tip template changes.
void renderer3DChanged()
Signal emitted when 3D renderer associated with the layer has changed.
virtual QgsMapLayerSelectionProperties * selectionProperties()
Returns the layer's selection properties.
void statusChanged(const QString &status)
Emit a signal with status (e.g. to be caught by QgisApp and display a msg on status bar)
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.
QString mLegendUrlFormat
QFlags< StyleCategory > StyleCategories
const QgsMapLayerServerProperties * serverProperties() const
Returns QGIS Server Properties const for the map layer.
QString mProviderKey
Data provider key (name of the data provider)
void styleChanged()
Signal emitted whenever a change affects the layer's style.
std::unique_ptr< QgsDataProvider > mPreloadedProvider
Optionally used when loading a project, it is released when the layer is effectively created.
void rendererChanged()
Signal emitted when renderer is changed.
void crsChanged()
Emitted when the crs() of the layer has changed.
void dataSourceChanged()
Emitted whenever the layer's data source has been changed.
void idChanged(const QString &id)
Emitted when the layer's ID has been changed.
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.
virtual QgsMapLayerTemporalProperties * temporalProperties()
Returns the layer's temporal properties.
void dataChanged()
Data of layer changed.
virtual QgsMapLayerRenderer * createMapRenderer(QgsRenderContext &rendererContext)=0
Returns new instance of QgsMapLayerRenderer that will be used for rendering of given context.
void willBeDeleted()
Emitted in the destructor when the layer is about to be deleted, but it is still in a perfectly valid...
void verticalCrsChanged()
Emitted when the verticalCrs() of the layer has changed.
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.
QString mDataSource
Data source description string, varies by layer type.
virtual bool readSld(const QDomNode &node, QString &errorMessage)
ReadFlag
Flags which control project read behavior.
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 QgsMapLayerElevationProperties * elevationProperties()
Returns the layer's elevation properties.
virtual void setTransformContext(const QgsCoordinateTransformContext &transformContext)=0
Sets the coordinate transform context to transformContext.
void nameChanged()
Emitted when the name has been changed.
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.
void mapTipsEnabledChanged()
Emitted when map tips are enabled or disabled for the layer.
void setCustomEnumProperty(const QString &key, const T &value)
Set the value of a property based on an enum.
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,...
Definition qgsproject.h:107
Holds data provider key, description, and associated shared library file or function pointer informat...
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.
The QgsSldExportContext class holds SLD export options and other information related to SLD export of...
An interface for classes which can visit style entity (e.g.
Represents a vector layer which manages a vector based data sets.
#define str(x)
Definition qgis.cpp:39
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition qgis_sip.h:191
#define SIP_DEPRECATED
Definition qgis_sip.h:106
#define SIP_ENUM_BASETYPE(type)
Definition qgis_sip.h:278
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_TRANSFER
Definition qgis_sip.h:36
#define SIP_OUT
Definition qgis_sip.h:58
#define SIP_FACTORY
Definition qgis_sip.h:76
#define SIP_END
Definition qgis_sip.h:208
#define QgsDebugError(str)
Definition qgslogger.h:38
QPointer< QgsMapLayer > QgsWeakMapLayerPointer
Weak pointer for QgsMapLayer.
QList< QgsWeakMapLayerPointer > QgsWeakMapLayerPointerList
A list of weak pointers to QgsMapLayers.
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsTextRendererUtils::CurvedTextFlags)
const QgsCoordinateReferenceSystem & crs
Setting options for creating vector data providers.