/
qgsproject.sip.in
1375 lines (937 loc) · 35.3 KB
/
qgsproject.sip.in
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
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsproject.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsProject : QObject, QgsExpressionContextGenerator
{
%Docstring
Reads and writes project states.
\note
Has two general kinds of state to make persistent. (I.e., to read and
write.) First, QGIS proprietary information. Second plug-in information.
A singleton since there shall only be one active project at a time; and
provides canonical location for plug-ins and main app to find/set
properties.
%End
%TypeHeaderCode
#include "qgsproject.h"
%End
public:
static QgsProject *instance();
%Docstring
Returns the QgsProject singleton instance
%End
explicit QgsProject( QObject *parent /TransferThis/ = 0 );
%Docstring
Create a new QgsProject.
Most of the time you want to use QgsProject.instance() instead as many components of QGIS work with the singleton.
%End
~QgsProject();
void setTitle( const QString &title );
%Docstring
Sets the project's title.
:param title: new title
.. note::
Since QGIS 3.2 this is just a shortcut to setting the title in the project's metadata().
.. seealso:: :py:func:`title`
.. versionadded:: 2.4
%End
QString title() const;
%Docstring
Returns the project's title.
.. seealso:: :py:func:`setTitle`
.. note::
Since QGIS 3.2 this is just a shortcut to retrieving the title from the project's metadata().
%End
bool isDirty() const;
%Docstring
Returns true if the project has been modified since the last write()
%End
void setFileName( const QString &name );
%Docstring
Sets the file name associated with the project. This is the file which contains the project's XML
representation.
:param name: project file name
.. seealso:: :py:func:`fileName`
%End
QString fileName() const;
%Docstring
Returns the project's file name. This is the file which contains the project's XML
representation.
.. seealso:: :py:func:`setFileName`
.. seealso:: :py:func:`fileInfo`
%End
QFileInfo fileInfo() const /Deprecated/;
%Docstring
Returns QFileInfo object for the project's associated file.
.. note::
The use of this method is discouraged since QGIS 3.2 as it only works with project files stored
in the file system. It is recommended to use absoluteFilePath(), baseName(), lastModifiedTime() as
replacements that are aware of the fact that projects may be saved in other project storages.
.. seealso:: :py:func:`fileName`
.. versionadded:: 2.9
.. deprecated:: Use absoluteFilePath(), baseName() or lastModifiedTime() instead
%End
QgsProjectStorage *projectStorage() const;
%Docstring
Returns pointer to project storage implementation that handles read/write of the project file.
If the project file is stored in the local file system, returns null pointer.
The project storage object is inferred from fileName() of the project.
.. versionadded:: 3.2
%End
QDateTime lastModified() const;
%Docstring
Returns last modified time of the project file as returned by the file system (or other project storage).
.. versionadded:: 3.2
%End
QString absoluteFilePath() const;
%Docstring
Returns full absolute path to the project file if the project is stored in a file system - derived from fileName().
Returns empty string when the project is stored in a project storage (there is no concept of paths for custom project storages).
.. versionadded:: 3.2
%End
QString baseName() const;
%Docstring
Returns the base name of the project file without the path and without extension - derived from fileName().
.. versionadded:: 3.2
%End
QgsCoordinateReferenceSystem crs() const;
%Docstring
Returns the project's native coordinate reference system.
.. seealso:: :py:func:`setCrs`
.. seealso:: :py:func:`ellipsoid`
.. versionadded:: 3.0
%End
void setCrs( const QgsCoordinateReferenceSystem &crs );
%Docstring
Sets the project's native coordinate reference system.
.. seealso:: :py:func:`crs`
.. seealso:: :py:func:`setEllipsoid`
.. versionadded:: 3.0
%End
QString ellipsoid() const;
%Docstring
Returns a proj string representing the project's ellipsoid setting, e.g., "WGS84".
.. seealso:: :py:func:`setEllipsoid`
.. seealso:: :py:func:`crs`
.. versionadded:: 3.0
%End
void setEllipsoid( const QString &ellipsoid );
%Docstring
Sets the project's ellipsoid from a proj string representation, e.g., "WGS84".
.. seealso:: :py:func:`ellipsoid`
.. seealso:: :py:func:`setCrs`
.. versionadded:: 3.0
%End
QgsCoordinateTransformContext transformContext() const;
%Docstring
Returns a copy of the project's coordinate transform context, which stores various
information regarding which datum transforms should be used when transforming points
from a source to destination coordinate reference system.
.. seealso:: :py:func:`setTransformContext`
.. seealso:: :py:func:`transformContextChanged`
.. versionadded:: 3.0
%End
void setTransformContext( const QgsCoordinateTransformContext &context );
%Docstring
Sets the project's coordinate transform ``context``, which stores various
information regarding which datum transforms should be used when transforming points
from a source to destination coordinate reference system.
.. seealso:: :py:func:`transformContext`
.. seealso:: :py:func:`transformContextChanged`
.. versionadded:: 3.0
%End
void clear();
%Docstring
Clear the project - removes all settings and resets it back to an empty, default state.
.. versionadded:: 2.4
%End
bool read( const QString &filename );
%Docstring
Reads given project file from the given file.
:param filename: name of project file to read
:return: true if project file has been read successfully
%End
bool read();
%Docstring
Reads the project from its currently associated file (see fileName() ).
:return: true if project file has been read successfully
%End
bool readLayer( const QDomNode &layerNode );
%Docstring
Reads the layer described in the associated DOM node.
.. note::
This method is mainly for use by QgsProjectBadLayerHandler subclasses
that may fix definition of bad layers with the user's help in GUI. Calling
this method with corrected DOM node adds the layer back to the project.
:param layerNode: represents a QgsProject DOM node that encodes a specific layer.
%End
bool write( const QString &filename );
%Docstring
Writes the project to a file.
:param filename: destination file
:return: true if project was written successfully
.. note::
calling this implicitly sets the project's filename (see setFileName() )
.. note::
isDirty() will be set to false if project is successfully written
.. versionadded:: 3.0
%End
bool write();
%Docstring
Writes the project to its current associated file (see fileName() ).
:return: true if project was written successfully
.. note::
isDirty() will be set to false if project is successfully written
%End
bool writeEntry( const QString &scope, const QString &key, bool value ) /PyName=writeEntryBool/;
%Docstring
Write a boolean entry to the project file.
Keys are '/'-delimited entries, implying
a hierarchy of keys and corresponding values
.. note::
The key string must be valid xml tag names in order to be saved to the file.
.. note::
available in Python bindings as writeEntryBool
%End
bool writeEntry( const QString &scope, const QString &key, double value ) /PyName=writeEntryDouble/;
%Docstring
Write a double entry to the project file.
Keys are '/'-delimited entries, implying
a hierarchy of keys and corresponding values
.. note::
The key string must be valid xml tag names in order to be saved to the file.
.. note::
available in Python bindings as writeEntryDouble
%End
bool writeEntry( const QString &scope, const QString &key, int value );
%Docstring
Write an integer entry to the project file.
Keys are '/'-delimited entries, implying
a hierarchy of keys and corresponding values
.. note::
The key string must be valid xml tag names in order to be saved to the file.
%End
bool writeEntry( const QString &scope, const QString &key, const QString &value );
%Docstring
Write a string entry to the project file.
Keys are '/'-delimited entries, implying
a hierarchy of keys and corresponding values
.. note::
The key string must be valid xml tag names in order to be saved to the file.
%End
bool writeEntry( const QString &scope, const QString &key, const QStringList &value );
%Docstring
Write a string list entry to the project file.
Keys are '/'-delimited entries, implying
a hierarchy of keys and corresponding values
.. note::
The key string must be valid xml tag names in order to be saved to the file.
%End
QStringList readListEntry( const QString &scope, const QString &key, const QStringList &def = QStringList(), bool *ok = 0 ) const;
%Docstring
Key value accessors
keys would be the familiar QgsSettings-like '/' delimited entries,
implying a hierarchy of keys and corresponding values
%End
QString readEntry( const QString &scope, const QString &key, const QString &def = QString(), bool *ok = 0 ) const;
int readNumEntry( const QString &scope, const QString &key, int def = 0, bool *ok = 0 ) const;
double readDoubleEntry( const QString &scope, const QString &key, double def = 0, bool *ok = 0 ) const;
bool readBoolEntry( const QString &scope, const QString &key, bool def = false, bool *ok = 0 ) const;
bool removeEntry( const QString &scope, const QString &key );
%Docstring
Remove the given key
%End
QStringList entryList( const QString &scope, const QString &key ) const;
%Docstring
Returns keys with values -- do not return keys that contain other keys
.. note::
equivalent to QgsSettings entryList()
%End
QStringList subkeyList( const QString &scope, const QString &key ) const;
%Docstring
Returns keys with keys -- do not return keys that contain only values
.. note::
equivalent to QgsSettings subkeyList()
%End
void dumpProperties() const;
QgsPathResolver pathResolver() const;
%Docstring
Returns path resolver object with considering whether the project uses absolute
or relative paths and using current project's path.
.. versionadded:: 3.0
%End
QString writePath( const QString &filename ) const;
%Docstring
Prepare a filename to save it to the project file.
Creates an absolute or relative path according to the project settings.
Paths written to the project file should be prepared with this method.
%End
QString readPath( const QString &filename ) const;
%Docstring
Turn filename read from the project file to an absolute path
%End
QString error() const;
%Docstring
Returns error message from previous read/write
%End
void setBadLayerHandler( QgsProjectBadLayerHandler *handler /Transfer/ );
%Docstring
Change handler for missing layers.
Deletes old handler and takes ownership of the new one.
%End
QString layerIsEmbedded( const QString &id ) const;
%Docstring
Returns project file path if layer is embedded from other project file. Returns empty string if layer is not embedded
%End
QgsLayerTreeGroup *createEmbeddedGroup( const QString &groupName, const QString &projectFilePath, const QStringList &invisibleLayers );
%Docstring
Create layer group instance defined in an arbitrary project file.
.. versionadded:: 2.4
%End
void setTopologicalEditing( bool enabled );
%Docstring
Convenience function to set topological editing
%End
bool topologicalEditing() const;
%Docstring
Convenience function to query topological editing status
%End
QgsUnitTypes::DistanceUnit distanceUnits() const;
%Docstring
Convenience function to query default distance measurement units for project.
.. seealso:: :py:func:`setDistanceUnits`
.. seealso:: :py:func:`areaUnits`
.. versionadded:: 2.14
%End
void setDistanceUnits( QgsUnitTypes::DistanceUnit unit );
%Docstring
Sets the default distance measurement units for the project.
.. seealso:: :py:func:`distanceUnits`
.. seealso:: :py:func:`setAreaUnits`
.. versionadded:: 3.0
%End
QgsUnitTypes::AreaUnit areaUnits() const;
%Docstring
Convenience function to query default area measurement units for project.
.. seealso:: :py:func:`distanceUnits`
.. versionadded:: 2.14
%End
void setAreaUnits( QgsUnitTypes::AreaUnit unit );
%Docstring
Sets the default area measurement units for the project.
.. seealso:: :py:func:`areaUnits`
.. seealso:: :py:func:`setDistanceUnits`
.. versionadded:: 3.0
%End
QString homePath() const;
%Docstring
Returns the project's home path. This will either be a manually set home path
(see presetHomePath()) or the path containing the project file itself.
This method always returns the absolute path to the project's home. See
presetHomePath() to retrieve any manual project home path override (e.g.
relative home paths).
.. seealso:: :py:func:`setPresetHomePath`
.. seealso:: :py:func:`presetHomePath`
.. seealso:: :py:func:`homePathChanged`
%End
QString presetHomePath() const;
%Docstring
Returns any manual project home path setting, or an empty string if not set.
This path may be a relative path. See homePath() to retrieve a path which is always
an absolute path.
.. seealso:: :py:func:`homePath`
.. seealso:: :py:func:`setPresetHomePath`
.. seealso:: :py:func:`homePathChanged`
.. versionadded:: 3.2
%End
QgsRelationManager *relationManager() const;
QgsLayoutManager *layoutManager();
%Docstring
Returns the project's layout manager, which manages compositions within
the project.
.. versionadded:: 3.0
%End
QgsLayerTree *layerTreeRoot() const;
%Docstring
Returns pointer to the root (invisible) node of the project's layer tree
.. versionadded:: 2.4
%End
QgsLayerTreeRegistryBridge *layerTreeRegistryBridge() const;
%Docstring
Returns pointer to the helper class that synchronizes map layer registry with layer tree
.. versionadded:: 2.4
%End
QgsMapThemeCollection *mapThemeCollection();
%Docstring
Returns pointer to the project's map theme collection.
.. note::
renamed in QGIS 3.0, formerly :py:class:`QgsVisibilityPresetCollection`
.. versionadded:: 2.12
%End
QgsAnnotationManager *annotationManager();
%Docstring
Returns pointer to the project's annotation manager.
.. versionadded:: 3.0
%End
void setNonIdentifiableLayers( const QList<QgsMapLayer *> &layers );
%Docstring
Set a list of layers which should not be taken into account on map identification
%End
void setNonIdentifiableLayers( const QStringList &layerIds );
%Docstring
Set a list of layers which should not be taken into account on map identification
%End
QStringList nonIdentifiableLayers() const;
%Docstring
Gets the list of layers which currently should not be taken into account on map identification
%End
bool autoTransaction() const;
%Docstring
Transactional editing means that on supported datasources (postgres databases) the edit state of
all tables that originate from the same database are synchronized and executed in a server side
transaction.
.. versionadded:: 2.16
%End
void setAutoTransaction( bool autoTransaction );
%Docstring
Transactional editing means that on supported datasources (postgres databases) the edit state of
all tables that originate from the same database are synchronized and executed in a server side
transaction.
Make sure that this is only called when all layers are not in edit mode.
.. versionadded:: 2.16
%End
QgsTransactionGroup *transactionGroup( const QString &providerKey, const QString &connString );
%Docstring
Get a transaction group from a provider key and connection string.
Returns None if a matching transaction group is not available.
.. versionadded:: 3.2
%End
bool evaluateDefaultValues() const;
%Docstring
Should default values be evaluated on provider side when requested and not when committed.
.. versionadded:: 2.16
%End
void setEvaluateDefaultValues( bool evaluateDefaultValues );
%Docstring
Defines if default values should be evaluated on provider side when requested and not when committed.
.. versionadded:: 2.16
%End
virtual QgsExpressionContext createExpressionContext() const;
QgsSnappingConfig snappingConfig() const;
%Docstring
The snapping configuration for this project.
.. versionadded:: 3.0
%End
QList<QgsVectorLayer *> avoidIntersectionsLayers() const;
%Docstring
A list of layers with which intersections should be avoided.
.. versionadded:: 3.0
%End
void setAvoidIntersectionsLayers( const QList<QgsVectorLayer *> &layers );
%Docstring
A list of layers with which intersections should be avoided.
.. versionadded:: 3.0
%End
QVariantMap customVariables() const;
%Docstring
A map of custom project variables.
To get all available variables including generated ones
use QgsExpressionContextUtils.projectScope() instead.
%End
void setCustomVariables( const QVariantMap &customVariables );
%Docstring
A map of custom project variables.
Be careful not to set generated variables.
%End
void setLabelingEngineSettings( const QgsLabelingEngineSettings &settings );
%Docstring
Sets project's global labeling engine settings
.. versionadded:: 3.0
%End
const QgsLabelingEngineSettings &labelingEngineSettings() const;
%Docstring
Returns project's global labeling engine settings
.. versionadded:: 3.0
%End
QgsMapLayerStore *layerStore();
%Docstring
Returns a pointer to the project's internal layer store.
/since QGIS 3.0
%End
int count() const;
%Docstring
Returns the number of registered layers.
%End
QgsMapLayer *mapLayer( const QString &layerId ) const;
%Docstring
Retrieve a pointer to a registered layer by layer ID.
:param layerId: ID of layer to retrieve
:return: matching layer, or None if no matching layer found
.. seealso:: :py:func:`mapLayersByName`
.. seealso:: :py:func:`mapLayers`
%End
QList<QgsMapLayer *> mapLayersByName( const QString &layerName ) const;
%Docstring
Retrieve a list of matching registered layers by layer name.
:param layerName: name of layers to match
:return: list of matching layers
.. seealso:: :py:func:`mapLayer`
.. seealso:: :py:func:`mapLayers`
%End
QMap<QString, QgsMapLayer *> mapLayers() const;
%Docstring
Returns a map of all registered layers by layer ID.
.. seealso:: :py:func:`mapLayer`
.. seealso:: :py:func:`mapLayersByName`
.. seealso:: :py:func:`layers`
%End
bool isZipped() const;
%Docstring
Returns true if the project comes from a zip archive, false otherwise.
%End
QList<QgsMapLayer *> addMapLayers( const QList<QgsMapLayer *> &mapLayers /Transfer/,
bool addToLegend = true);
%Docstring
Add a list of layers to the map of loaded layers.
The layersAdded() and layerWasAdded() signals will always be emitted.
The legendLayersAdded() signal is emitted only if addToLegend is true.
:param mapLayers: A list of layer which should be added to the registry
:param addToLegend: If true (by default), the layers will be added to the
legend and to the main canvas. If you have a private
layer you can set this parameter to false to hide it.
:param takeOwnership: Ownership will be transferred to the layer registry.
If you specify false here you have take care of deleting
the layers yourself. Not available in Python.
:return: a list of the map layers that were added
successfully. If a layer is invalid, or already exists in the registry,
it will not be part of the returned QList.
.. note::
As a side-effect QgsProject is made dirty.
.. note::
takeOwnership is not available in the Python bindings - the registry will always
take ownership
.. seealso:: :py:func:`addMapLayer`
.. versionadded:: 1.8
%End
QgsMapLayer *addMapLayer( QgsMapLayer *mapLayer /Transfer/,
bool addToLegend = true);
%Docstring
Add a layer to the map of loaded layers.
The layersAdded() and layerWasAdded() signals will always be emitted.
The legendLayersAdded() signal is emitted only if addToLegend is true.
If you are adding multiple layers at once, you should use
addMapLayers() instead.
:param mapLayer: A layer to add to the registry
:param addToLegend: If true (by default), the layer will be added to the
legend and to the main canvas. If you have a private
layer you can set this parameter to false to hide it.
:param takeOwnership: Ownership will be transferred to the layer registry.
If you specify false here you have take care of deleting
the layer yourself. Not available in Python.
:return: None if unable to add layer, otherwise pointer to newly added layer
.. seealso:: :py:func:`addMapLayers`
.. note::
As a side-effect QgsProject is made dirty.
.. note::
Use addMapLayers if adding more than one layer at a time
.. note::
takeOwnership is not available in the Python bindings - the registry will always
take ownership
.. seealso:: :py:func:`addMapLayers`
%End
void removeMapLayers( const QStringList &layerIds );
%Docstring
Remove a set of layers from the registry by layer ID.
The specified layers will be removed from the registry. If the registry has ownership
of any layers these layers will also be deleted.
:param layerIds: list of IDs of the layers to remove
.. note::
As a side-effect the QgsProject instance is marked dirty.
.. seealso:: :py:func:`removeMapLayer`
.. seealso:: :py:func:`removeAllMapLayers`
.. versionadded:: 1.8
%End
void removeMapLayers( const QList<QgsMapLayer *> &layers );
void removeMapLayer( const QString &layerId );
%Docstring
Remove a layer from the registry by layer ID.
The specified layer will be removed from the registry. If the registry has ownership
of the layer then it will also be deleted.
:param layerId: ID of the layer to remove
.. note::
As a side-effect the QgsProject instance is marked dirty.
.. seealso:: :py:func:`removeMapLayers`
.. seealso:: :py:func:`removeAllMapLayers`
%End
void removeMapLayer( QgsMapLayer *layer );
%Docstring
Remove a layer from the registry.
The specified layer will be removed from the registry. If the registry has ownership
of the layer then it will also be deleted.
:param layer: The layer to remove. Null pointers are ignored.
.. note::
As a side-effect the QgsProject instance is marked dirty.
.. seealso:: :py:func:`removeMapLayers`
.. seealso:: :py:func:`removeAllMapLayers`
%End
QgsMapLayer *takeMapLayer( QgsMapLayer *layer ) /TransferBack/;
%Docstring
Takes a layer from the registry. If the layer was owned by the project, the
layer will be returned without deleting it. The caller takes ownership of
the layer and is responsible for deleting it.
.. seealso:: :py:func:`removeMapLayer`
.. versionadded:: 3.0
%End
void removeAllMapLayers();
%Docstring
Removes all registered layers. If the registry has ownership
of any layers these layers will also be deleted.
.. note::
As a side-effect the QgsProject instance is marked dirty.
.. note::
Calling this method will cause the removeAll() signal to
be emitted.
.. seealso:: :py:func:`removeMapLayer`
.. seealso:: :py:func:`removeMapLayers`
%End
void reloadAllLayers();
%Docstring
Reload all registered layer's provider data caches, synchronising the layer
with any changes in the datasource.
.. seealso:: :py:func:`QgsMapLayer.reload`
%End
QgsCoordinateReferenceSystem defaultCrsForNewLayers() const;
%Docstring
Returns the default CRS for new layers based on the settings and
the current project CRS
%End
void setTrustLayerMetadata( bool trust );
%Docstring
Sets the trust option allowing to indicate if the extent has to be
read from the XML document when data source has no metadata or if the
data provider has to determine it. Moreover, when this option is
activated, primary key unicity is not checked for views and
materialized views with Postgres provider.
:param trust: True to trust the project, false otherwise
.. versionadded:: 3.0
%End
bool trustLayerMetadata() const;
%Docstring
Returns true if the trust option is activated, false otherwise. This
option allows indicateing if the extent has to be read from the XML
document when data source has no metadata or if the data provider has
to determine it. Moreover, when this option is activated, primary key
unicity is not checked for views and materialized views with Postgres
provider.
.. versionadded:: 3.0
%End
QgsAuxiliaryStorage *auxiliaryStorage();
%Docstring
Returns the current auxiliary storage.
.. versionadded:: 3.0
%End
const QgsProjectMetadata &metadata() const;
%Docstring
Returns a reference to the project's metadata store.
.. seealso:: :py:func:`setMetadata`
.. seealso:: :py:func:`metadataChanged`
.. versionadded:: 3.2
%End
void setMetadata( const QgsProjectMetadata &metadata );
%Docstring
Sets the project's ``metadata`` store.
.. seealso:: :py:func:`metadata`
.. seealso:: :py:func:`metadataChanged`
.. versionadded:: 3.2
%End
QSet<QgsMapLayer *> requiredLayers() const;
%Docstring
Returns a set of map layers that are required in the project and therefore they should not get
removed from the project. The set of layers may be configured by users in project properties.
and it is mainly a hint for the user interface to protect users from removing layers that important
in the project. The removeMapLayer(), removeMapLayers() calls do not block removal of layers listed here.
.. versionadded:: 3.2
%End
void setRequiredLayers( const QSet<QgsMapLayer *> &layers );
%Docstring
Configures a set of map layers that are required in the project and therefore they should not get
removed from the project. The set of layers may be configured by users in project properties.
and it is mainly a hint for the user interface to protect users from removing layers that important
in the project. The removeMapLayer(), removeMapLayers() calls do not block removal of layers listed here.
.. versionadded:: 3.2
%End
signals:
void readProject( const QDomDocument & );
%Docstring
emitted when project is being read
%End
void writeProject( QDomDocument & );
%Docstring
emitted when project is being written
%End
void readMapLayer( QgsMapLayer *mapLayer, const QDomElement &layerNode );
%Docstring
Emitted, after the basic initialization of a layer from the project
file is done. You can use this signal to read additional information