106 Q_PROPERTY( QStringList nonIdentifiableLayers READ nonIdentifiableLayers WRITE setNonIdentifiableLayers NOTIFY nonIdentifiableLayersChanged )
107 Q_PROPERTY( QString fileName READ fileName WRITE setFileName NOTIFY fileNameChanged )
108 Q_PROPERTY( QString homePath READ homePath WRITE setPresetHomePath NOTIFY homePathChanged )
111 Q_PROPERTY( QString ellipsoid READ ellipsoid WRITE setEllipsoid NOTIFY ellipsoidChanged )
112 Q_PROPERTY(
QgsMapThemeCollection *mapThemeCollection READ mapThemeCollection NOTIFY mapThemeCollectionChanged )
113 Q_PROPERTY(
QgsSnappingConfig snappingConfig READ snappingConfig WRITE setSnappingConfig NOTIFY snappingConfigChanged )
115 Q_PROPERTY(
Qgis::AvoidIntersectionsMode avoidIntersectionsMode READ avoidIntersectionsMode WRITE setAvoidIntersectionsMode NOTIFY avoidIntersectionsModeChanged )
116 Q_PROPERTY( QList<QgsVectorLayer *> avoidIntersectionsLayers READ avoidIntersectionsLayers WRITE setAvoidIntersectionsLayers NOTIFY avoidIntersectionsLayersChanged )
117 Q_PROPERTY(
QgsProjectMetadata metadata READ metadata WRITE setMetadata NOTIFY metadataChanged )
118 Q_PROPERTY( QColor backgroundColor READ backgroundColor WRITE setBackgroundColor NOTIFY backgroundColorChanged )
119 Q_PROPERTY( QColor selectionColor READ selectionColor WRITE setSelectionColor NOTIFY selectionColorChanged )
120 Q_PROPERTY(
bool topologicalEditing READ topologicalEditing WRITE setTopologicalEditing NOTIFY topologicalEditingChanged )
136 WMSOnlineResource = 2,
150 static void setInstance(
QgsProject *project ) ;
173 void setTitle(
const QString &title );
181 QString title()
const;
189 Qgis::ProjectCapabilities
capabilities()
const {
return mCapabilities; }
199 Qgis::ProjectFlags
flags()
const {
return mFlags; }
209 void setFlags( Qgis::ProjectFlags flags );
228 QString saveUser()
const;
237 QString saveUserFullName()
const;
244 QDateTime lastSaveDateTime()
const;
256 bool isDirty()
const;
264 void setFileName(
const QString &name );
272 QString fileName()
const;
285 void setOriginalPath(
const QString &path );
298 QString originalPath()
const;
324 QDateTime lastModified() const;
331 QString absoluteFilePath() const;
338 QString absolutePath() const;
344 QString baseName() const;
352 Qgis::FilePathType filePathStorage() const;
360 void setFilePathStorage(
Qgis::FilePathType type );
387 QString ellipsoid() const;
395 void setEllipsoid( const QString &ellipsoid );
433 bool read( const QString &filename,
Qgis::ProjectReadFlags flags =
Qgis::ProjectReadFlags() );
443 bool read(
Qgis::ProjectReadFlags flags =
Qgis::ProjectReadFlags() );
454 bool readLayer( const QDomNode &layerNode );
464 bool write( const QString &filename );
484 bool writeEntry( const QString &scope, const QString &key,
bool value )
SIP_PYNAME( writeEntryBool );
497 bool writeEntry( const QString &scope, const QString &key,
double value )
SIP_PYNAME( writeEntryDouble );
509 bool writeEntry( const QString &scope, const QString &key,
int value );
521 bool writeEntry( const QString &scope, const QString &key, const QString &value );
533 bool writeEntry( const QString &scope, const QString &key, const QStringList &value );
545 QStringList readListEntry( const QString &scope, const QString &key, const QStringList &def = QStringList(),
bool *ok
SIP_OUT =
nullptr ) const;
557 QString readEntry( const QString &scope, const QString &key, const QString &def = QString(),
bool *ok
SIP_OUT =
nullptr ) const;
569 int readNumEntry( const QString &scope, const QString &key,
int def = 0,
bool *ok
SIP_OUT =
nullptr ) const;
581 double readDoubleEntry( const QString &scope, const QString &key,
double def = 0,
bool *ok
SIP_OUT =
nullptr ) const;
593 bool readBoolEntry( const QString &scope, const QString &key,
bool def = false,
bool *ok
SIP_OUT =
nullptr ) const;
598 bool removeEntry( const QString &scope, const QString &key );
608 QStringList entryList( const QString &scope, const QString &key ) const;
618 QStringList subkeyList( const QString &scope, const QString &key ) const;
626 void dumpProperties() const;
640 QString writePath( const QString &filename ) const;
645 QString readPath( const QString &filename ) const;
648 QString error() const;
661 QString layerIsEmbedded( const QString &
id ) const;
671 bool createEmbeddedLayer( const QString &layerId, const QString &projectFilePath, QList<QDomNode> &brokenNodes,
672 bool saveFlag = true,
Qgis::ProjectReadFlags flags =
Qgis::ProjectReadFlags() )
SIP_SKIP;
681 QgsLayerTreeGroup *createEmbeddedGroup( const QString &groupName, const QString &projectFilePath, const QStringList &invisibleLayers,
Qgis::ProjectReadFlags flags =
Qgis::ProjectReadFlags() );
684 void setTopologicalEditing(
bool enabled );
687 bool topologicalEditing() const;
703 void setDistanceUnits(
QgsUnitTypes::DistanceUnit unit );
732 QString homePath() const;
746 QString presetHomePath() const;
911 Q_DECL_DEPRECATED
void setNonIdentifiableLayers( const QList<
QgsMapLayer *> &layers );
917 Q_DECL_DEPRECATED
void setNonIdentifiableLayers( const QStringList &layerIds );
923 Q_DECL_DEPRECATED QStringList nonIdentifiableLayers() const;
945 Q_DECL_DEPRECATED
void setAutoTransaction(
bool autoTransaction )
SIP_DEPRECATED;
953 Qgis::TransactionMode transactionMode() const;
964 bool setTransactionMode(
Qgis::TransactionMode transactionMode );
983 QgsTransactionGroup *transactionGroup( const QString &providerKey, const QString &connString );
997 Q_DECL_DEPRECATED
bool evaluateDefaultValues() const
SIP_DEPRECATED;
1004 Q_DECL_DEPRECATED
void setEvaluateDefaultValues(
bool evaluateDefaultValues )
SIP_DEPRECATED;
1029 void setAvoidIntersectionsLayers( const QList<
QgsVectorLayer *> &layers );
1036 void setAvoidIntersectionsMode( const
Qgis::AvoidIntersectionsMode mode );
1043 Qgis::AvoidIntersectionsMode avoidIntersectionsMode()
const {
return mAvoidIntersectionsMode; }
1050 QVariantMap customVariables()
const;
1056 void setCustomVariables(
const QVariantMap &customVariables );
1090 int validCount()
const;
1099 Q_INVOKABLE
QgsMapLayer *mapLayer(
const QString &layerId )
const;
1121 return qobject_cast<T>( mapLayer( layerId ) );
1132 QList<QgsMapLayer *> mapLayersByName(
const QString &layerName )
const;
1143 QList<QgsMapLayer *> mapLayersByShortName(
const QString &shortName )
const;
1154 QMap<QString, QgsMapLayer *> mapLayers(
const bool validOnly =
false )
const;
1159 bool isZipped()
const;
1174 template <
typename T>
1177 return mLayerStore->layers<T>();
1191 template <
typename T>
1195 const auto constMapLayers { mLayerStore->layers<T>() };
1196 for (
const auto l : constMapLayers )
1198 if ( ! l->shortName().isEmpty() )
1200 if ( l->shortName() == shortName )
1203 else if ( l->name() == shortName )
1238 QList<QgsMapLayer *> addMapLayers(
const QList<QgsMapLayer *> &mapLayers
SIP_TRANSFER,
1239 bool addToLegend =
true,
1270 bool addToLegend =
true,
1287 void removeMapLayers(
const QStringList &layerIds );
1304 void removeMapLayers(
const QList<QgsMapLayer *> &layers );
1319 void removeMapLayer(
const QString &layerId );
1368 void removeAllMapLayers();
1375 void reloadAllLayers();
1394 Q_DECL_DEPRECATED
void setTrustLayerMetadata(
bool trust )
SIP_DEPRECATED;
1406 Q_DECL_DEPRECATED
bool trustLayerMetadata() const
SIP_DEPRECATED;
1430 QString createAttachedFile( const QString &nameTemplate );
1438 QStringList attachedFiles() const;
1447 bool removeAttachedFile( const QString &path );
1457 QString attachmentIdentifier( const QString &attachedFile ) const;
1465 QString resolveAttachmentIdentifier( const QString &identifier ) const;
1491 Q_DECL_DEPRECATED QSet<
QgsMapLayer *> requiredLayers() const;
1501 Q_DECL_DEPRECATED
void setRequiredLayers( const QSet<
QgsMapLayer *> &layers );
1517 void setBackgroundColor( const QColor &color );
1525 QColor backgroundColor() const;
1533 void setSelectionColor( const QColor &color );
1541 QColor selectionColor() const;
1554 Q_DECL_DEPRECATED
void setMapScales( const QVector<
double> &scales )
SIP_DEPRECATED;
1567 Q_DECL_DEPRECATED QVector<
double> mapScales() const
SIP_DEPRECATED;
1577 Q_DECL_DEPRECATED
void setUseProjectScales(
bool enabled )
SIP_DEPRECATED;
1593 void generateTsFile( const QString &locale );
1605 QString translate( const QString &context, const QString &sourceText, const
char *disambiguation =
nullptr,
int n = -1 ) const override;
1619 SIP_PYOBJECT __repr__();
1621 QString
str = QStringLiteral(
"<QgsProject: '%1'%2>" ).arg( sipCpp->fileName(),
1623 sipRes = PyUnicode_FromString(
str.toUtf8().constData() );
2002 void setDirty(
bool b = true );
2012 void setPresetHomePath( const QString &path );
2091 bool commitChanges( QStringList &commitErrors
SIP_OUT,
bool stopEditing = true,
QgsVectorLayer *vectorLayer =
nullptr );
2101 bool rollBack( QStringList &rollbackErrors
SIP_OUT,
bool stopEditing = true,
QgsVectorLayer *vectorLayer =
nullptr );
2104 void onMapLayersAdded( const QList<
QgsMapLayer *> &layers );
2105 void onMapLayersRemoved( const QList<
QgsMapLayer *> &layers );
2106 void cleanTransactionGroups(
bool force = false );
2107 void updateTransactionGroups();
2122 bool _getMapLayers( const QDomDocument &doc, QList<QDomNode> &brokenNodes,
Qgis::ProjectReadFlags flags =
Qgis::ProjectReadFlags() );
2128 void setError( const QString &errorMessage )
SIP_SKIP;
2143 bool addLayer( const QDomElement &layerElem, QList<QDomNode> &brokenNodes,
QgsReadWriteContext &context,
Qgis::ProjectReadFlags flags =
Qgis::ProjectReadFlags() )
SIP_SKIP;
2159 bool readProjectFile( const QString &filename,
Qgis::ProjectReadFlags flags =
Qgis::ProjectReadFlags() );
2162 bool writeProjectFile( const QString &filename );
2165 bool unzip( const QString &filename,
Qgis::ProjectReadFlags flags =
Qgis::ProjectReadFlags() );
2168 bool zip( const QString &filename );
2171 bool saveAuxiliaryStorage( const QString &filename = QString() );
2176 Qgis::ProjectCapabilities mCapabilities;
2180 QString mErrorMessage;
2189 QHash< QString, QPair< QString,
bool> > mEmbeddedLayers;
2192 Qgis::AvoidIntersectionsMode mAvoidIntersectionsMode =
Qgis::AvoidIntersectionsMode::AllowIntersections;
2227 QVariantMap mCustomVariables;
2235 QString mOriginalPath;
2238 QString mSaveUserFull;
2239 QDateTime mSaveDateTime;
2247 mutable QString mCachedHomePath;
2249 QColor mBackgroundColor;
2250 QColor mSelectionColor;
2253 Qgis::TransactionMode mTransactionMode =
Qgis::TransactionMode::Disabled;
2255 Qgis::ProjectFlags mFlags;
2257 bool mDirty = false;
2258 int mDirtyBlockCount = 0;
2268 bool mIsBeingDeleted = false;
2274 int mBlockSnappingUpdates = 0;
2284 friend class TestQgsProject;
2320 : mProject( project )
2322 mProject->mDirtyBlockCount++;
2333 mProject->mDirtyBlockCount--;
2358 GetNamedProjectColor(
const QgsProject *project );
2364 GetNamedProjectColor(
const QHash< QString, QColor > &colors );
2371 QHash< QString, QColor > mColors;
The Qgis class provides global constants for use throughout the application.
@ ProjectStyles
Enable the project embedded style library. Enabling this flag can increase the time required to clear...
AvoidIntersectionsMode
Flags which control how intersections of pre-existing feature are handled when digitizing new feature...
ProjectFlag
Flags which control the behavior of QgsProjects.
Represents a map layer containing a set of georeferenced annotations, e.g.
Manages storage of a set of QgsAnnotation annotation objects.
Class allowing to manage the zip/unzip actions.
This is a container for attribute editors, used to group them visually in the attribute form if it is...
Class providing some utility methods to manage auxiliary storage.
Manages storage of a set of bookmarks.
This class represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
Abstract interface for generating an expression context.
Abstract interface for generating an expression context scope.
Single scope for storing variables and functions for use within a QgsExpressionContext.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
An expression node for expression functions.
Class for parsing and evaluation of expressions (formerly called "search strings").
Stores global configuration for labeling engine.
Layer tree group node serves as a container for layers and further groups.
Listens to the updates in map layer registry and does changes in layer tree.
Namespace with helper functions for layer tree operations.
Manages storage of a set of layouts.
A storage object for map layers, in which the layers are owned by the store and have their lifetime b...
Base class for all map layer types.
Container class that allows storage of map themes consisting of visible map layers and layer styles.
Manages storage of a set of views.
Resolves relative paths into absolute paths and vice versa.
Interface for classes that handle missing layer files when reading project file.
Temporarily blocks QgsProject "dirtying" for the lifetime of the object.
QgsProjectDirtyBlocker & operator=(const QgsProjectDirtyBlocker &other)=delete
QgsProjectDirtyBlocker cannot be copied.
QgsProjectDirtyBlocker(QgsProject *project)
Constructor for QgsProjectDirtyBlocker.
~QgsProjectDirtyBlocker()
QgsProjectDirtyBlocker(const QgsProjectDirtyBlocker &other)=delete
QgsProjectDirtyBlocker cannot be copied.
Contains settings and properties relating to how a QgsProject should display values such as map coord...
Contains elevation properties for a QgsProject.
Project property key node.
Abstract interface for project storage - to be implemented by various backends and registered in QgsP...
Contains settings and properties relating to how a QgsProject should handle styling.
Contains temporal settings and properties for the project, this may be used when animating maps or sh...
Wherever an object of this class is available, the derived translate function can be called from.
A class to describe the version of a project.
Contains settings and properties relating to how a QgsProject should be displayed inside map canvas,...
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
void layersRemoved(const QStringList &layerIds)
Emitted after one or more layers were removed from the registry.
Qgis::ProjectFlags flags() const
Returns the project's flags, which dictate the behavior of the project.
void mapThemeCollectionChanged()
Emitted when the map theme collection changes.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Q_DECL_DEPRECATED void mapScalesChanged()
Emitted when the list of custom project map scales changes.
void readVersionMismatchOccurred(const QString &fileVersion)
Emitted when a project is read and the version of QGIS used to save the project differs from the curr...
void fileNameChanged()
Emitted when the file name of the project changes.
void writeMapLayer(QgsMapLayer *mapLayer, QDomElement &layerElem, QDomDocument &doc)
Emitted when a layer is being saved.
Q_DECL_DEPRECATED void nonIdentifiableLayersChanged(QStringList nonIdentifiableLayers)
Emitted when the list of layer which are excluded from map identification changes.
void layersWillBeRemoved(const QStringList &layerIds)
Emitted when one or more layers are about to be removed from the registry.
void snappingConfigChanged(const QgsSnappingConfig &config)
Emitted whenever the configuration for snapping has changed.
void layerWasAdded(QgsMapLayer *layer)
Emitted when a layer was added to the registry.
void crsChanged()
Emitted when the CRS of the project has changed.
void avoidIntersectionsLayersChanged()
Emitted whenever avoidIntersectionsLayers has changed.
void layerWillBeRemoved(const QString &layerId)
Emitted when a layer is about to be removed from the registry.
void readMapLayer(QgsMapLayer *mapLayer, const QDomElement &layerNode)
Emitted after the basic initialization of a layer from the project file is done.
void cleared()
Emitted when the project is cleared (and additionally when an open project is cleared just before a n...
DataDefinedServerProperty
Data defined properties.
Q_DECL_DEPRECATED void oldProjectVersionWarning(const QString &)
Emitted when an old project file is read.
void metadataChanged()
Emitted when the project's metadata is changed.
void ellipsoidChanged(const QString &ellipsoid)
Emitted when the project ellipsoid is changed.
void projectColorsChanged()
Emitted whenever the project's color scheme has been changed.
QVector< T > layers() const
Returns a list of registered map layers with a specified layer type.
void labelingEngineSettingsChanged()
Emitted when global configuration of the labeling engine changes.
void customVariablesChanged()
Emitted whenever the expression variables stored in the project have been changed.
void readProject(const QDomDocument &)
Emitted when a project is being read.
T mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layerId converted to type T.
QgsMapThemeCollection * mapThemeCollection()
Returns pointer to the project's map theme collection.
void missingDatumTransforms(const QStringList &missingTransforms)
Emitted when datum transforms stored in the project are not available locally.
void readProjectWithContext(const QDomDocument &, QgsReadWriteContext &context)
Emitted when a project is being read.
void layerWillBeRemoved(QgsMapLayer *layer)
Emitted when a layer is about to be removed from the registry.
void transactionGroupsChanged()
Emitted whenever a new transaction group has been created or a transaction group has been removed.
void loadingLayerMessageReceived(const QString &layerName, const QList< QgsReadWriteContext::ReadWriteMessage > &messages)
Emitted when loading layers has produced some messages.
QVector< T > mapLayersByShortName(const QString &shortName) const
Retrieves a list of matching registered layers by layer shortName with a specified layer type,...
void writeProject(QDomDocument &)
Emitted when the project is being written.
Qgis::ProjectCapabilities capabilities() const
Returns the project's capabilities, which dictate optional functionality which can be selectively ena...
void projectSaved()
Emitted when the project file has been written and closed.
void layersWillBeRemoved(const QList< QgsMapLayer * > &layers)
Emitted when one or more layers are about to be removed from the registry.
void layerLoaded(int i, int n)
Emitted when a layer from a projects was read.
void selectionColorChanged()
Emitted whenever the project's selection color has been changed.
void removeAll()
Emitted when all layers are removed, before layersWillBeRemoved() and layerWillBeRemoved() signals ar...
void backgroundColorChanged()
Emitted whenever the project's canvas background color has been changed.
void transformContextChanged()
Emitted when the project transformContext() is changed.
void legendLayersAdded(const QList< QgsMapLayer * > &layers)
Emitted, when a layer was added to the registry and the legend.
void layerRemoved(const QString &layerId)
Emitted after a layer was removed from the registry.
void homePathChanged()
Emitted when the home path of the project changes.
void dirtySet()
Emitted when setDirty(true) is called.
void layersAdded(const QList< QgsMapLayer * > &layers)
Emitted when one or more layers were added to the registry.
void isDirtyChanged(bool dirty)
Emitted when the project dirty status changes.
void topologicalEditingChanged()
Emitted when the topological editing flag has changed.
void avoidIntersectionsModeChanged()
Emitted whenever the avoid intersections mode has changed.
void loadingLayer(const QString &layerName)
Emitted when a layer is loaded.
A grouped map of multiple QgsProperty objects, each referenced by a integer key value.
A registry / canonical manager of data providers.
The class is used as a container of context for various read/write operations on other objects.
This class manages a set of relations between layers.
Expression function for use within a QgsExpressionContextScope.
The QgsServer class provides OGC web services.
This class is a composition of two QSettings instances:
This is a container for configuration of the snapping of the project.
An interface for classes which can visit style entity (e.g.
This is the class is providing tolerance value in map unit values.
Used for the collecting of strings from projects for translation and creation of ts files.
Helper functions for various unit types.
The edit buffer group manages a group of edit buffers.
Represents a vector layer which manages a vector based data sets.
QList< QPair< QColor, QString > > QgsNamedColorList
List of colors paired with a friendly display name identifying the color.
CORE_EXPORT bool unzip(const QString &zip, const QString &dir, QStringList &files)
Unzip a zip file in an output directory.
CORE_EXPORT bool zip(const QString &zip, const QStringList &files)
Zip the list of files in the zip file.
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
CORE_EXPORT QgsProjectVersion getVersion(QDomDocument const &doc)
Returns the version string found in the given DOM document.
QMap< int, QgsPropertyDefinition > QgsPropertiesDefinition
Definition of available properties.
const QgsCoordinateReferenceSystem & crs