-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsmaplayer.h
1359 lines (1147 loc) · 45.8 KB
/
qgsmaplayer.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/***************************************************************************
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 "qgis.h"
#include "qgserror.h"
#include "qgsobjectcustomproperties.h"
#include "qgsrectangle.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsrendercontext.h"
#include "qgsmaplayerdependency.h"
#include "qgslayermetadata.h"
class QgsAbstract3DRenderer;
class QgsDataProvider;
class QgsMapLayerLegend;
class QgsMapLayerRenderer;
class QgsMapLayerStyleManager;
class QgsReadWriteContext;
class QgsProject;
class QDomDocument;
class QKeyEvent;
class QPainter;
/**
* \ingroup core
* Base class for all map layer types.
* This is the base class for all map layer types (vector, raster).
*/
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 )
#ifdef SIP_RUN
SIP_CONVERT_TO_SUBCLASS_CODE
QgsMapLayer *layer = qobject_cast<QgsMapLayer *>( sipCpp );
sipType = 0;
if ( layer )
{
switch ( layer->type() )
{
case QgsMapLayer::VectorLayer:
sipType = sipType_QgsVectorLayer;
break;
case QgsMapLayer::RasterLayer:
sipType = sipType_QgsRasterLayer;
break;
case QgsMapLayer::PluginLayer:
sipType = sipType_QgsPluginLayer;
break;
default:
sipType = nullptr;
break;
}
}
SIP_END
#endif
public:
//! Types of layers that can be added to a map
enum LayerType
{
VectorLayer,
RasterLayer,
PluginLayer
};
/**
* Maplayer has a style and a metadata property
* \since QGIS 3.0
*/
enum PropertyType
{
Style = 0,
Metadata,
};
/**
* Constructor for QgsMapLayer
* \param type layer type
* \param name display name for the layer
* \param source datasource of layer
*/
QgsMapLayer( QgsMapLayer::LayerType type = VectorLayer, const QString &name = QString(), const QString &source = QString() );
~QgsMapLayer() override;
//! QgsMapLayer cannot be copied
QgsMapLayer( QgsMapLayer const & ) = delete;
//! QgsMapLayer cannot be copied
QgsMapLayer &operator=( QgsMapLayer const & ) = delete;
/**
* Returns a new instance equivalent to this one except for the id which
* is still unique.
* \returns a new layer instance
* \since QGIS 3.0
*/
virtual QgsMapLayer *clone() const = 0;
/**
* Returns the type of the layer.
*/
QgsMapLayer::LayerType type() const;
/**
* Returns the extension of a Property.
* \returns The extension
* \since QGIS 3.0
*/
static QString extensionPropertyType( PropertyType type );
//! Returns the layer's unique ID, which is used to access this layer from QgsProject.
QString id() const;
/**
* Set the display \a name of the layer.
* \since QGIS 2.16
* \see name()
*/
void setName( const QString &name );
/**
* Returns the display name of the layer.
* \see setName()
*/
QString name() const;
/**
* Returns the layer's data provider.
*/
virtual QgsDataProvider *dataProvider();
/**
* Returns the layer's data provider in a const-correct manner
* \note not available in Python bindings
*/
virtual const QgsDataProvider *dataProvider() const SIP_SKIP;
/**
* Sets the short name of the layer
* used by QGIS Server to identify the layer.
* \returns the layer short name
* \see shortName()
*/
void setShortName( const QString &shortName ) { mShortName = shortName; }
/**
* Returns the short name of the layer
* used by QGIS Server to identify the layer.
* \see setShortName()
*/
QString shortName() const { return mShortName; }
/**
* Sets the title of the layer
* used by QGIS Server in GetCapabilities request.
* \see title()
*/
void setTitle( const QString &title ) { mTitle = title; }
/**
* Returns the title of the layer
* used by QGIS Server in GetCapabilities request.
* \returns the layer title
* \see setTitle()
*/
QString title() const { return mTitle; }
/**
* Sets the abstract of the layer
* used by QGIS Server in GetCapabilities request.
* \returns the layer abstract
* \see abstract()
*/
void setAbstract( const QString &abstract ) { mAbstract = abstract; }
/**
* Returns the abstract of the layer
* used by QGIS Server in GetCapabilities request.
* \returns the layer abstract
* \see setAbstract()
*/
QString abstract() const { return mAbstract; }
/**
* Sets the keyword list of the layer
* used by QGIS Server in GetCapabilities request.
* \returns the layer keyword list
* \see keywordList()
*/
void setKeywordList( const QString &keywords ) { mKeywordList = keywords; }
/**
* Returns the keyword list of the layer
* used by QGIS Server in GetCapabilities request.
* \returns the layer keyword list
* \see setKeywordList()
*/
QString keywordList() const { return mKeywordList; }
/* Layer dataUrl information */
/**
* Sets the DataUrl of the layer
* used by QGIS Server in GetCapabilities request.
* DataUrl is a a link to the underlying data represented by a particular layer.
* \returns the layer DataUrl
* \see dataUrl()
*/
void setDataUrl( const QString &dataUrl ) { mDataUrl = dataUrl; }
/**
* Returns the DataUrl of the layer
* used by QGIS Server in GetCapabilities request.
* DataUrl is a a link to the underlying data represented by a particular layer.
* \returns the layer DataUrl
* \see setDataUrl()
*/
QString dataUrl() const { return mDataUrl; }
/**
* Sets the DataUrl format of the layer
* used by QGIS Server in GetCapabilities request.
* DataUrl is a a link to the underlying data represented by a particular layer.
* \returns the layer DataUrl format
* \see dataUrlFormat()
*/
void setDataUrlFormat( const QString &dataUrlFormat ) { mDataUrlFormat = dataUrlFormat; }
/**
* Returns the DataUrl format of the layer
* used by QGIS Server in GetCapabilities request.
* DataUrl is a a link to the underlying data represented by a particular layer.
* \returns the layer DataUrl format
* \see setDataUrlFormat()
*/
QString dataUrlFormat() const { return mDataUrlFormat; }
/* Layer attribution information */
/**
* Sets the attribution of the layer
* used by QGIS Server in GetCapabilities request.
* Attribution indicates the provider of a layer or collection of layers.
* \returns the layer attribution
* \see attribution()
*/
void setAttribution( const QString &attrib ) { mAttribution = attrib; }
/**
* Returns the attribution of the layer
* used by QGIS Server in GetCapabilities request.
* Attribution indicates the provider of a layer or collection of layers.
* \returns the layer attribution
* \see setAttribution()
*/
QString attribution() const { return mAttribution; }
/**
* Sets the attribution URL of the layer
* used by QGIS Server in GetCapabilities request.
* Attribution indicates the provider of a layer or collection of layers.
* \returns the layer attribution URL
* \see attributionUrl()
*/
void setAttributionUrl( const QString &attribUrl ) { mAttributionUrl = attribUrl; }
/**
* Returns the attribution URL of the layer
* used by QGIS Server in GetCapabilities request.
* Attribution indicates the provider of a layer or collection of layers.
* \returns the layer attribution URL
* \see setAttributionUrl()
*/
QString attributionUrl() const { return mAttributionUrl; }
/* Layer metadataUrl information */
/**
* Sets the metadata URL of the layer
* used by QGIS Server in GetCapabilities request.
* MetadataUrl is a a link to the detailed, standardized metadata about the data.
* \returns the layer metadata URL
* \see metadataUrl()
*/
void setMetadataUrl( const QString &metaUrl ) { mMetadataUrl = metaUrl; }
/**
* Returns the metadata URL of the layer
* used by QGIS Server in GetCapabilities request.
* MetadataUrl is a a link to the detailed, standardized metadata about the data.
* \returns the layer metadata URL
* \see setMetadataUrl()
*/
QString metadataUrl() const { return mMetadataUrl; }
/**
* Set the metadata type of the layer
* used by QGIS Server in GetCapabilities request
* MetadataUrlType indicates the standard to which the metadata complies.
* \returns the layer metadata type
* \see metadataUrlType()
*/
void setMetadataUrlType( const QString &metaUrlType ) { mMetadataUrlType = metaUrlType; }
/**
* Returns the metadata type of the layer
* used by QGIS Server in GetCapabilities request.
* MetadataUrlType indicates the standard to which the metadata complies.
* \returns the layer metadata type
* \see setMetadataUrlType()
*/
QString metadataUrlType() const { return mMetadataUrlType; }
/**
* Sets the metadata format of the layer
* used by QGIS Server in GetCapabilities request.
* MetadataUrlType indicates how the metadata is structured.
* \returns the layer metadata format
* \see metadataUrlFormat()
*/
void setMetadataUrlFormat( const QString &metaUrlFormat ) { mMetadataUrlFormat = metaUrlFormat; }
/**
* Returns the metadata format of the layer
* used by QGIS Server in GetCapabilities request.
* MetadataUrlType indicates how the metadata is structured.
* \returns the layer metadata format
* \see setMetadataUrlFormat()
*/
QString metadataUrlFormat() const { return mMetadataUrlFormat; }
/**
* Set the blending mode used for rendering a layer.
* \param blendMode new blending mode
* \see blendMode()
*/
void setBlendMode( QPainter::CompositionMode blendMode );
/**
* Returns the current blending mode for a layer.
* \see setBlendMode()
*/
QPainter::CompositionMode blendMode() const;
//! Returns if this layer is read only.
bool readOnly() const { return isReadOnly(); }
/**
* Synchronises with changes in the datasource
*/
virtual void reload() {}
/**
* Return new instance of QgsMapLayerRenderer that will be used for rendering of given context
* \since QGIS 2.4
*/
virtual QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) = 0 SIP_FACTORY;
//! Returns the extent of the layer.
virtual QgsRectangle extent() const;
/**
* Return the status of the layer. An invalid layer is one which has a bad datasource
* or other problem. Child classes set this flag when initialized.
* \returns true if the layer is valid and can be accessed
*/
bool isValid() const;
/**
* Gets a version of the internal layer definition that has sensitive
* bits removed (for example, the password). This function should
* be used when displaying the source name for general viewing.
* \see source()
*/
QString publicSource() const;
/**
* Returns the source for the layer. This source may contain usernames, passwords
* and other sensitive information.
* \see publicSource()
*/
QString source() const;
/**
* Returns the sublayers of this layer.
* (Useful for providers that manage their own layers, such as WMS).
*/
virtual QStringList subLayers() const;
/**
* Reorders the *previously selected* sublayers of this layer from bottom to top.
* (Useful for providers that manage their own layers, such as WMS).
*/
virtual void setLayerOrder( const QStringList &layers );
/**
* Set the visibility of the given sublayer name.
* \param name sublayer name
* \param visible sublayer visibility
*/
virtual void setSubLayerVisibility( const QString &name, bool visible );
//! Returns true if the layer can be edited.
virtual bool isEditable() const;
/**
* Returns true if the layer is considered a spatial layer, ie it has some form of geometry associated with it.
* \since QGIS 2.16
*/
virtual bool isSpatial() const;
/**
* Sets state from Dom document
\param layerElement The Dom element corresponding to ``maplayer'' tag
\param context writing context (e.g. for conversion between relative and absolute paths)
\note
The Dom node corresponds to a Dom document project file XML element read
by QgsProject.
This, in turn, calls readXml(), which is over-rideable by sub-classes so
that they can read their own specific state from the given Dom node.
Invoked by QgsProject::read().
\returns true if successful
*/
bool readLayerXml( const QDomElement &layerElement, const QgsReadWriteContext &context );
/**
* Stores state in Dom node
* \param layerElement is a Dom element corresponding to ``maplayer'' tag
* \param document is a the dom document being written
* \param context reading context (e.g. for conversion between relative and absolute paths)
* \note
*
* The Dom node corresponds to a Dom document project file XML element to be
* written by QgsProject.
*
* This, in turn, calls writeXml(), which is over-rideable by sub-classes so
* that they can write their own specific state to the given Dom node.
*
* Invoked by QgsProject::write().
*
* \returns true if successful
*/
bool writeLayerXml( QDomElement &layerElement, QDomDocument &document, const QgsReadWriteContext &context ) const;
/**
* Resolve references to other layers (kept as layer IDs after reading XML) into layer objects.
* \since QGIS 3.0
*/
virtual void resolveReferences( QgsProject *project );
/**
* Returns list of all keys within custom properties. Properties are stored in a map and saved in project file.
* \see customProperty()
* \since QGIS 3.0
*/
QStringList customPropertyKeys() const;
/**
* Set a custom property for layer. Properties are stored in a map and saved in project file.
* \see customProperty()
* \see removeCustomProperty()
*/
void setCustomProperty( const QString &key, const QVariant &value );
/**
* Read a custom property from layer. Properties are stored in a map and saved in project file.
* \see setCustomProperty()
*/
QVariant customProperty( const QString &value, const QVariant &defaultValue = QVariant() ) const;
/**
* Set custom properties for layer. Current properties are dropped.
* \since QGIS 3.0
*/
void setCustomProperties( const QgsObjectCustomProperties &properties );
/**
* Remove a custom property from layer. Properties are stored in a map and saved in project file.
* \see setCustomProperty()
*/
void removeCustomProperty( const QString &key );
/**
* Get current status error. This error describes some principal problem
* for which layer cannot work and thus is not valid. It is not last error
* after accessing data by draw() etc.
*/
virtual QgsError error() const;
/**
* Returns the layer's spatial reference system.
\since QGIS 1.4
*/
QgsCoordinateReferenceSystem crs() const;
//! Sets layer's spatial reference system
void setCrs( const QgsCoordinateReferenceSystem &srs, bool emitSignal = true );
/**
* A convenience function to capitalize and format a layer \a name.
*
* \since QGIS 3.0
*/
static QString formatLayerName( const QString &name );
/**
* Retrieve the metadata URI for this layer
* (either as a .qmd file on disk or as a
* record in the users style table in their personal qgis.db)
* \returns a QString with the metadata file name
* \since QGIS 3.0
*/
virtual QString metadataUri() const;
/**
* Export the current metadata of this layer as named metadata in a QDomDocument
* \param doc the target QDomDocument
* \param errorMsg this QString will be initialized on error
* \since QGIS 3.0
*/
void exportNamedMetadata( QDomDocument &doc, QString &errorMsg ) const;
/**
* Save the current metadata of this layer as the default metadata
* (either as a .qmd file on disk or as a
* record in the users style table in their personal qgis.db)
* \param resultFlag a reference to a flag that will be set to false if
* we did not manage to save the default metadata.
* \returns a QString with any status messages
* \since QGIS 3.0
*/
virtual QString saveDefaultMetadata( bool &resultFlag SIP_OUT );
/**
* Save the current metadata of this layer as a named metadata
* (either as a .qmd file on disk or as a
* record in the users style table in their personal qgis.db)
* \param uri the file name or other URI for the
* metadata file. First an attempt will be made to see if this
* is a file and save to that, if that fails the qgis.db metadata
* table will be used to create a metadata entry who's
* key matches the URI.
* \param resultFlag a reference to a flag that will be set to false if
* we did not manage to save the default metadata.
* \returns a QString with any status messages
* \since QGIS 3.0
*/
QString saveNamedMetadata( const QString &uri, bool &resultFlag );
/**
* Retrieve a named metadata for this layer if one
* exists (either as a .qmd file on disk or as a
* record in the users style table in their personal qgis.db)
* \param uri - the file name or other URI for the
* metadata file. First an attempt will be made to see if this
* is a file and load that, if that fails the qgis.db metadata
* table will be consulted to see if there is a metadata who's
* key matches the URI.
* \param resultFlag a reference to a flag that will be set to false if
* we did not manage to load the default metadata.
* \returns a QString with any status messages
* \since QGIS 3.0
*/
virtual QString loadNamedMetadata( const QString &uri, bool &resultFlag SIP_OUT );
/**
* Retrieve the default metadata for this layer if one
* exists (either as a .qmd file on disk or as a
* record in the users metadata table in their personal qgis.db)
* \param resultFlag a reference to a flag that will be set to false if
* we did not manage to load the default metadata.
* \returns a QString with any status messages
* \since QGIS 3.0
*/
QString loadDefaultMetadata( bool &resultFlag );
/**
* Retrieve a named metadata for this layer from a sqlite database.
* \param db path to sqlite database
* \param uri uri for table
* \param qmd will be set to QMD xml metadata content from database
* \returns true if style was successfully loaded
* \since QGIS 3.0
*/
bool loadNamedMetadataFromDatabase( const QString &db, const QString &uri, QString &qmd );
/**
* Import the metadata of this layer from a QDomDocument
* \param document source QDomDocument
* \param errorMessage this QString will be initialized on error
* \returns true on success
* \since QGIS 3.0
*/
bool importNamedMetadata( QDomDocument &document, QString &errorMessage );
/**
* Retrieve the style URI for this layer
* (either as a .qml file on disk or as a
* record in the users style table in their personal qgis.db)
* \returns a QString with the style file name
* \see also loadNamedStyle () and saveNamedStyle ();
*/
virtual QString styleURI() const;
/**
* Retrieve the default style for this layer if one
* exists (either as a .qml file on disk or as a
* record in the users style table in their personal qgis.db)
* \param resultFlag a reference to a flag that will be set to false if
* we did not manage to load the default style.
* \returns a QString with any status messages
* \see also loadNamedStyle ();
*/
virtual QString loadDefaultStyle( bool &resultFlag SIP_OUT );
/**
* Retrieve a named style for this layer if one
* exists (either as a .qml file on disk or as a
* record in the users style table in their personal qgis.db)
* \param uri - the file name or other URI for the
* style file. First an attempt will be made to see if this
* is a file and load that, if that fails the qgis.db styles
* table will be consulted to see if there is a style who's
* key matches the URI.
* \param resultFlag a reference to a flag that will be set to false if
* we did not manage to load the default style.
* \returns a QString with any status messages
* \see also loadDefaultStyle ();
*/
virtual QString loadNamedStyle( const QString &uri, bool &resultFlag SIP_OUT );
/**
* Retrieve a named style for this layer from a sqlite database.
* \param db path to sqlite database
* \param uri uri for table
* \param qml will be set to QML style content from database
* \returns true if style was successfully loaded
*/
virtual bool loadNamedStyleFromDatabase( const QString &db, const QString &uri, QString &qml SIP_OUT );
/**
* Import the properties of this layer from a QDomDocument
* \param doc source QDomDocument
* \param errorMsg this QString will be initialized on error
* during the execution of readSymbology
* \returns true on success
* \since QGIS 2.8
*/
virtual bool importNamedStyle( QDomDocument &doc, QString &errorMsg SIP_OUT );
/**
* Export the properties of this layer as named style in a QDomDocument
* \param doc the target QDomDocument
* \param errorMsg this QString will be initialized on error
* during the execution of writeSymbology
*/
virtual void exportNamedStyle( QDomDocument &doc, QString &errorMsg ) const;
/**
* Export the properties of this layer as SLD style in a QDomDocument
* \param doc the target QDomDocument
* \param errorMsg this QString will be initialized on error
* during the execution of writeSymbology
*/
virtual void exportSldStyle( QDomDocument &doc, QString &errorMsg ) const;
/**
* Save the properties of this layer as the default style
* (either as a .qml file on disk or as a
* record in the users style table in their personal qgis.db)
* \param resultFlag a reference to a flag that will be set to false if
* we did not manage to save the default style.
* \returns a QString with any status messages
* \see loadNamedStyle() and \see saveNamedStyle()
*/
virtual QString saveDefaultStyle( bool &resultFlag SIP_OUT );
/**
* Save the properties of this layer as a named style
* (either as a .qml file on disk or as a
* record in the users style table in their personal qgis.db)
* \param uri the file name or other URI for the
* style file. First an attempt will be made to see if this
* is a file and save to that, if that fails the qgis.db styles
* table will be used to create a style entry who's
* key matches the URI.
* \param resultFlag a reference to a flag that will be set to false if
* we did not manage to save the default style.
* \returns a QString with any status messages
* \see saveDefaultStyle()
*/
virtual QString saveNamedStyle( const QString &uri, bool &resultFlag SIP_OUT );
/**
* Saves the properties of this layer to an SLD format file.
* \param uri uri of destination for exported SLD file.
* \param resultFlag a reference to a flag that will be set to false if
* the SLD file could not be generated
* \returns a string with any status or error messages
* \see loadSldStyle()
*/
virtual QString saveSldStyle( const QString &uri, bool &resultFlag ) const;
/**
* Attempts to style the layer using the formatting from an SLD type file.
* \param uri uri of source SLD file
* \param resultFlag a reference to a flag that will be set to false if
* the SLD file could not be loaded
* \returns a string with any status or error messages
* \see saveSldStyle()
*/
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( type() ); return false; }
/**
* Read the symbology for the current layer from the Dom node supplied.
* \param node node that will contain the symbology definition for this layer.
* \param errorMessage reference to string that will be updated with any error messages
* \param context reading context (used for transform from relative to absolute paths)
* \returns true in case of success.
*/
virtual bool readSymbology( const QDomNode &node, QString &errorMessage, const QgsReadWriteContext &context ) = 0;
/**
* Read the style for the current layer from the Dom node supplied.
* \param node node that will contain the style definition for this layer.
* \param errorMessage reference to string that will be updated with any error messages
* \param context reading context (used for transform from relative to absolute paths)
* \returns true in case of success.
* \since QGIS 2.16
* \note To be implemented in subclasses. Default implementation does nothing and returns false.
*/
virtual bool readStyle( const QDomNode &node, QString &errorMessage, const QgsReadWriteContext &context );
/**
* Write the symbology for the layer into the docment provided.
* \param node the node that will have the style element added to it.
* \param doc the document that will have the QDomNode added.
* \param errorMessage reference to string that will be updated with any error messages
* \param context writing context (used for transform from absolute to relative paths)
* \returns true in case of success.
*/
virtual bool writeSymbology( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context ) const = 0;
/**
* Write just the style information for the layer into the document
* \param node the node that will have the style element added to it.
* \param doc the document that will have the QDomNode added.
* \param errorMessage reference to string that will be updated with any error messages
* \param context writing context (used for transform from absolute to relative paths)
* \returns true in case of success.
* \since QGIS 2.16
* \note To be implemented in subclasses. Default implementation does nothing and returns false.
*/
virtual bool writeStyle( QDomNode &node, QDomDocument &doc, QString &errorMessage, const QgsReadWriteContext &context ) const;
//! Return pointer to layer's undo stack
QUndoStack *undoStack();
/**
* Return pointer to layer's style undo stack
* \since QGIS 2.16
*/
QUndoStack *undoStackStyles();
/**
* Sets the URL for the layer's legend.
*/
void setLegendUrl( const QString &legendUrl ) { mLegendUrl = legendUrl; }
/**
* Returns the URL for the layer's legend.
*/
QString legendUrl() const { return mLegendUrl; }
/**
* Sets the format for a URL based layer legend.
*/
void setLegendUrlFormat( const QString &legendUrlFormat ) { mLegendUrlFormat = legendUrlFormat; }
/**
* Returns the format for a URL based layer legend.
*/
QString legendUrlFormat() const { return mLegendUrlFormat; }
/**
* Assign a legend controller to the map layer. The object will be responsible for providing legend items.
* \param legend Takes ownership of the object. Can be null pointer
* \since QGIS 2.6
*/
void setLegend( QgsMapLayerLegend *legend SIP_TRANSFER );
/**
* Can be null.
* \since QGIS 2.6
*/
QgsMapLayerLegend *legend() const;
/**
* Get access to the layer's style manager. Style manager allows switching between multiple styles.
* \since QGIS 2.8
*/
QgsMapLayerStyleManager *styleManager() const;
/**
* Sets 3D renderer for the layer. Takes ownership of the renderer.
* \since QGIS 3.0
*/
void setRenderer3D( QgsAbstract3DRenderer *renderer SIP_TRANSFER );
/**
* Returns 3D renderer associated with the layer. May be null.
* \since QGIS 3.0
*/
QgsAbstract3DRenderer *renderer3D() const;
/**
* Tests whether the layer should be visible at the specified \a scale.
* The \a scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* \returns true if the layer is visible at the given scale.
* \since QGIS 2.16
* \see minimumScale()
* \see maximumScale()
* \see hasScaleBasedVisibility()
*/
bool isInScaleRange( double scale ) const;
/**
* Returns the minimum map scale (i.e. most "zoomed out" scale) at which the layer will be visible.
* The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* A scale of 0 indicates no minimum scale visibility.
* \note Scale based visibility is only used if setScaleBasedVisibility() is set to true.
* \see setMinimumScale()
* \see maximumScale()
* \see hasScaleBasedVisibility()
* \see isInScaleRange()
*/
double minimumScale() const;
/**
* Returns the maximum map scale (i.e. most "zoomed in" scale) at which the layer will be visible.
* The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* A scale of 0 indicates no maximum scale visibility.
* \note Scale based visibility is only used if setScaleBasedVisibility() is set to true.
* \see setMaximumScale()
* \see minimumScale()
* \see hasScaleBasedVisibility()
* \see isInScaleRange()
*/
double maximumScale() const;
/**
* Returns whether scale based visibility is enabled for the layer.
* \returns true if scale based visibility is enabled
* \see minimumScale()
* \see maximumScale()
* \see setScaleBasedVisibility()
* \see isInScaleRange()
*/
bool hasScaleBasedVisibility() const;
/**
* Returns true if auto refresh is enabled for the layer.
* \since QGIS 3.0
* \see autoRefreshInterval()
* \see setAutoRefreshEnabled()
*/
bool hasAutoRefreshEnabled() const;
/**
* Returns the auto refresh interval (in milliseconds). Note that
* auto refresh is only active when hasAutoRefreshEnabled() is true.
* \since QGIS 3.0
* \see autoRefreshEnabled()
* \see setAutoRefreshInterval()
*/
int autoRefreshInterval() const;
/**
* Sets the auto refresh interval (in milliseconds) for the layer. This
* will cause the layer to be automatically redrawn on a matching interval.
* Note that auto refresh must be enabled by calling setAutoRefreshEnabled().
*
* Note that auto refresh triggers deferred repaints of the layer. Any map
* canvas must be refreshed separately in order to view the refreshed layer.
* \since QGIS 3.0
* \see autoRefreshInterval()
* \see setAutoRefreshEnabled()
*/
void setAutoRefreshInterval( int interval );
/**
* Sets whether auto refresh is enabled for the layer.
* \since QGIS 3.0
* \see hasAutoRefreshEnabled()
* \see setAutoRefreshInterval()
*/
void setAutoRefreshEnabled( bool enabled );
/**
* Returns a reference to the layer's metadata store.
* \since QGIS 3.0
* \see setMetadata()
* \see metadataChanged()
*/
virtual const QgsLayerMetadata &metadata() const;
/**
* Sets the layer's \a metadata store.
* \since QGIS 3.0
* \see metadata()
* \see metadataChanged()
*/
virtual void setMetadata( const QgsLayerMetadata &metadata );
/**
* Obtain a formatted HTML string containing assorted metadata for this layer.
* \since QGIS 3.0
*/
virtual QString htmlMetadata() const;
//! Time stamp of data source in the moment when data/metadata were loaded by provider
virtual QDateTime timestamp() const;
/**
* Gets the list of dependencies. This includes data dependencies set by the user (\see setDataDependencies)
* as well as dependencies given by the provider
*
* \returns a set of QgsMapLayerDependency
* \since QGIS 3.0
*/
virtual QSet<QgsMapLayerDependency> dependencies() const;
/**
* Returns the message that should be notified by the provider to triggerRepaint
*
* \since QGIS 3.0
*/
QString refreshOnNotifyMessage() const { return mRefreshOnNofifyMessage; }
/**
* Returns true if the refresh on provider nofification is enabled
*
* \since QGIS 3.0
*/
bool isRefreshOnNotifyEnabled() const { return mIsRefreshOnNofifyEnabled; }
public slots:
/**
* Sets the minimum map \a scale (i.e. most "zoomed out" scale) at which the layer will be visible.
* The \a scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
* A \a scale of 0 indicates no minimum scale visibility.
* \note Scale based visibility is only used if setScaleBasedVisibility() is set to true.
* \see minimumScale()
* \see setMaximumScale()