qgsproject.cpp File Reference

#include "qgsproject.h"
#include "qgsdatasourceuri.h"
#include "qgslabelingenginesettings.h"
#include "qgslayertree.h"
#include "qgslayertreeutils.h"
#include "qgslayertreeregistrybridge.h"
#include "qgslogger.h"
#include "qgsmessagelog.h"
#include "qgspluginlayer.h"
#include "qgspluginlayerregistry.h"
#include "qgsprojectfiletransform.h"
#include "qgssnappingconfig.h"
#include "qgspathresolver.h"
#include "qgsprojectstorage.h"
#include "qgsprojectstorageregistry.h"
#include "qgsprojectversion.h"
#include "qgsrasterlayer.h"
#include "qgsreadwritecontext.h"
#include "qgsrectangle.h"
#include "qgsrelationmanager.h"
#include "qgsannotationmanager.h"
#include "qgsvectorlayerjoininfo.h"
#include "qgsmapthemecollection.h"
#include "qgslayerdefinition.h"
#include "qgsunittypes.h"
#include "qgstransaction.h"
#include "qgstransactiongroup.h"
#include "qgsvectordataprovider.h"
#include "qgsprojectbadlayerhandler.h"
#include "qgssettings.h"
#include "qgsmaplayerlistutils.h"
#include "qgsmeshlayer.h"
#include "qgslayoutmanager.h"
#include "qgsbookmarkmanager.h"
#include "qgsmaplayerstore.h"
#include "qgsziputils.h"
#include "qgsauxiliarystorage.h"
#include "qgssymbollayerutils.h"
#include "qgsapplication.h"
#include "qgsexpressioncontextutils.h"
#include "qgsstyleentityvisitor.h"
#include "qgsprojectviewsettings.h"
#include "qgsprojectdisplaysettings.h"
#include "qgsprojecttimesettings.h"
#include "qgsvectortilelayer.h"
#include <algorithm>
#include <QApplication>
#include <QFileInfo>
#include <QDomNode>
#include <QObject>
#include <QTextStream>
#include <QTemporaryFile>
#include <QDir>
#include <QUrl>
#include <utime.h>

Go to the source code of this file.

Functions
void	_getProperties (const QDomDocument &doc, QgsProjectPropertyKey &project_properties)
	Restore any optional properties found in "doc" to "properties". More...
QgsProjectProperty *	addKey_ (const QString &scope, const QString &key, QgsProjectPropertyKey *rootProperty, const QVariant &value, bool &propertiesModified)
	Add the given key and value. More...
void	dump_ (const QgsProjectPropertyKey &topQgsPropertyKey)
QgsProjectProperty *	findKey_ (const QString &scope, const QString &key, QgsProjectPropertyKey &rootProperty)
	return the property that matches the given key sequence, if any More...
QgsPropertyCollection	getDataDefinedServerProperties (const QDomDocument &doc, const QgsPropertiesDefinition &dataDefinedServerPropertyDefinitions)
	Returns the data defined server properties collection found in "doc" to "dataDefinedServerProperties". More...
QgsProjectVersion	getVersion (const QDomDocument &doc)
	Returns the version string found in the given DOM document. More...
QStringList	makeKeyTokens_ (const QString &scope, const QString &key)
	Take the given scope and key and convert them to a string list of key tokens that will be used to navigate through a Property hierarchy. More...
void	removeKey_ (const QString &scope, const QString &key, QgsProjectPropertyKey &rootProperty)
	Remove a given key. More...

Function Documentation

_getProperties()

void _getProperties	(	const QDomDocument &	doc,
		QgsProjectPropertyKey &	project_properties
	)

Restore any optional properties found in "doc" to "properties".

properties tags for all optional properties. Within that there will be scope tags. In the following example there exist one property in the "fsplugin" scope. "layers" is a list containing three string values.

<properties>
  <fsplugin>
    <foo type="int" >42</foo>
    <baz type="int" >1</baz>
    <layers type="QStringList" >
      <value>railroad</value>
      <value>airport</value>
    </layers>
    <xyqzzy type="int" >1</xyqzzy>
    <bar type="double" >123.456</bar>
    <feature_types type="QStringList" >
       <value>type</value>
    </feature_types>
  </fsplugin>
</properties>

Parameters

doc	xml document
project_properties	should be the top QgsProjectPropertyKey node.

Definition at line 889 of file qgsproject.cpp.

addKey_()

QgsProjectProperty* addKey_	(	const QString &	scope,
		const QString &	key,
		QgsProjectPropertyKey *	rootProperty,
		const QVariant &	value,
		bool &	propertiesModified
	)

Add the given key and value.

Parameters

scope	scope of key
key	key name
rootProperty	is the property from which to start adding
value	the value associated with the key
propertiesModified	the parameter will be set to true if the written entry modifies pre-existing properties

Definition at line 212 of file qgsproject.cpp.

dump_()

void dump_

(

const QgsProjectPropertyKey &

topQgsPropertyKey

)

Definition at line 852 of file qgsproject.cpp.

findKey_()

QgsProjectProperty* findKey_	(	const QString &	scope,
		const QString &	key,
		QgsProjectPropertyKey &	rootProperty
	)

return the property that matches the given key sequence, if any

Parameters

scope	scope of key
key	keyname
rootProperty	is likely to be the top level QgsProjectPropertyKey in QgsProject:e:Imp.

Returns

null if not found, otherwise located Property

Definition at line 135 of file qgsproject.cpp.

getDataDefinedServerProperties()

QgsPropertyCollection getDataDefinedServerProperties	(	const QDomDocument &	doc,
		const QgsPropertiesDefinition &	dataDefinedServerPropertyDefinitions
	)

Returns the data defined server properties collection found in "doc" to "dataDefinedServerProperties".

Parameters

doc	xml document
dataDefinedServerPropertyDefinitions	property collection of the server overrides

Since

QGIS 3.14

Definition at line 918 of file qgsproject.cpp.

getVersion()

QgsProjectVersion getVersion

(

QDomDocument const &

doc

)

Returns the version string found in the given DOM document.

Returns

the version string or an empty string if none found

Note

not available in Python bindings.

Definition at line 990 of file qgsproject.cpp.

makeKeyTokens_()

QStringList makeKeyTokens_	(	const QString &	scope,
		const QString &	key
	)

Take the given scope and key and convert them to a string list of key tokens that will be used to navigate through a Property hierarchy.

E.g., scope "someplugin" and key "/foo/bar/baz" will become a string list of { "properties", "someplugin", "foo", "bar", "baz" }. "properties" is always first because that's the permanent `‘root’' Property node.

Definition at line 93 of file qgsproject.cpp.

removeKey_()

void removeKey_	(	const QString &	scope,
		const QString &	key,
		QgsProjectPropertyKey &	rootProperty
	)

Remove a given key.

Parameters

scope	scope of key
key	key name
rootProperty	is the property from which to start adding

Definition at line 299 of file qgsproject.cpp.