The QgsServerProjectUtils namespace provides a way to retrieve specific entries from a QgsProject. More...

Functions
SERVER_EXPORT double	ceilWithPrecision (double number, int places)
	Returns a double greater than number to the specified number of places.

SERVER_EXPORT double	floorWithPrecision (double number, int places)
	Returns a double less than number to the specified number of places.

SERVER_EXPORT QString	owsServiceAbstract (const QgsProject &project)
	Returns the owsService abstract defined in project.

SERVER_EXPORT QString	owsServiceAccessConstraints (const QgsProject &project)
	Returns the owsService access constraints defined in project.

SERVER_EXPORT bool	owsServiceCapabilities (const QgsProject &project)
	Returns if owsService capabilities are enabled.

SERVER_EXPORT QString	owsServiceContactMail (const QgsProject &project)
	Returns the owsService contact mail defined in project.

SERVER_EXPORT QString	owsServiceContactOrganization (const QgsProject &project)
	Returns the owsService contact organization defined in project.

SERVER_EXPORT QString	owsServiceContactPerson (const QgsProject &project)
	Returns the owsService contact person defined in project.

SERVER_EXPORT QString	owsServiceContactPhone (const QgsProject &project)
	Returns the owsService contact phone defined in project.

SERVER_EXPORT QString	owsServiceContactPosition (const QgsProject &project)
	Returns the owsService contact position defined in project.

SERVER_EXPORT QString	owsServiceFees (const QgsProject &project)
	Returns the owsService fees defined in project.

SERVER_EXPORT QStringList	owsServiceKeywords (const QgsProject &project)
	Returns the owsService keywords defined in project.

SERVER_EXPORT QString	owsServiceOnlineResource (const QgsProject &project)
	Returns the owsService online resource defined in project.

SERVER_EXPORT QString	owsServiceTitle (const QgsProject &project)
	Returns the owsService title defined in project.

SERVER_EXPORT QString	serviceUrl (const QString &service, const QgsServerRequest &request, const QgsServerSettings &settings)
	Returns the service url defined in the environment variable or with HTTP header.

SERVER_EXPORT QStringList	wcsLayerIds (const QgsProject &project)
	Returns the Layer ids list defined in a QGIS project as published in WCS.

SERVER_EXPORT QString	wcsServiceUrl (const QgsProject &project, const QgsServerRequest &request=QgsServerRequest(), const QgsServerSettings &settings=QgsServerSettings())
	Returns the WCS service url.

SERVER_EXPORT QStringList	wfsLayerIds (const QgsProject &project)
	Returns the Layer ids list defined in a QGIS project as published in WFS.

SERVER_EXPORT int	wfsLayerPrecision (const QgsProject &project, const QString &layerId)
	Returns the Layer precision defined in a QGIS project for the WFS GetFeature.

SERVER_EXPORT QString	wfsServiceUrl (const QgsProject &project, const QgsServerRequest &request=QgsServerRequest(), const QgsServerSettings &settings=QgsServerSettings())
	Returns the WFS service url.

SERVER_EXPORT QStringList	wfstDeleteLayerIds (const QgsProject &project)
	Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities.

SERVER_EXPORT QStringList	wfstInsertLayerIds (const QgsProject &project)
	Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities.

SERVER_EXPORT QStringList	wfstUpdateLayerIds (const QgsProject &project)
	Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities.

SERVER_EXPORT bool	wmsAddLegendGroupsLegendGraphic (const QgsProject &project)
	Returns if legend groups should be in the legend graphic response if GetLegendGraphic is called on a layer group.

SERVER_EXPORT double	wmsDefaultMapUnitsPerMm (const QgsProject &project)
	Returns the default number of map units per millimeters in case of the scale is not given.

SERVER_EXPORT QgsRectangle	wmsExtent (const QgsProject &project)
	Returns the WMS Extent restriction.

SERVER_EXPORT bool	wmsFeatureInfoAddWktGeometry (const QgsProject &project)
	Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.

SERVER_EXPORT QString	wmsFeatureInfoDocumentElement (const QgsProject &project)
	Returns the document element name for XML GetFeatureInfo request.

SERVER_EXPORT QString	wmsFeatureInfoDocumentElementNs (const QgsProject &project)
	Returns the document element namespace for XML GetFeatureInfo request.

SERVER_EXPORT QHash< QString, QString >	wmsFeatureInfoLayerAliasMap (const QgsProject &project)
	Returns the mapping between layer name and wms layer name for GetFeatureInfo request.

SERVER_EXPORT int	wmsFeatureInfoPrecision (const QgsProject &project)
	Returns the geometry precision for GetFeatureInfo request.

SERVER_EXPORT QString	wmsFeatureInfoSchema (const QgsProject &project)
	Returns the schema URL for XML GetFeatureInfo request.

SERVER_EXPORT bool	wmsFeatureInfoSegmentizeWktGeometry (const QgsProject &project)
	Returns if the geometry has to be segmentize in GetFeatureInfo request.

SERVER_EXPORT bool	wmsFeatureInfoUseAttributeFormSettings (const QgsProject &project)
	Returns if feature form settings should be considered for the format of the feature info response.

SERVER_EXPORT int	wmsImageQuality (const QgsProject &project)
	Returns the quality for WMS images defined in a QGIS project.

SERVER_EXPORT bool	wmsInfoFormatSia2045 (const QgsProject &project)
	Returns if the info format is SIA20145.

SERVER_EXPORT bool	wmsInspireActivate (const QgsProject &project)
	Returns if Inspire is activated.

SERVER_EXPORT QString	wmsInspireLanguage (const QgsProject &project)
	Returns the Inspire language.

SERVER_EXPORT QString	wmsInspireMetadataDate (const QgsProject &project)
	Returns the Inspire metadata date.

SERVER_EXPORT QString	wmsInspireMetadataUrl (const QgsProject &project)
	Returns the Inspire metadata URL.

SERVER_EXPORT QString	wmsInspireMetadataUrlType (const QgsProject &project)
	Returns the Inspire metadata URL type.

SERVER_EXPORT QString	wmsInspireTemporalReference (const QgsProject &project)
	Returns the Inspire temporal reference.

SERVER_EXPORT int	wmsMaxAtlasFeatures (const QgsProject &project)
	Returns the maximum number of atlas features which can be printed in a request.

SERVER_EXPORT int	wmsMaxHeight (const QgsProject &project)
	Returns the maximum height for WMS images defined in a QGIS project.

SERVER_EXPORT int	wmsMaxWidth (const QgsProject &project)
	Returns the maximum width for WMS images defined in a QGIS project.

SERVER_EXPORT QStringList	wmsOutputCrsList (const QgsProject &project)
	Returns the WMS output CRS list.

SERVER_EXPORT bool	wmsRenderMapTiles (const QgsProject &project)
	Returns `true` if WMS requests should use the QgsMapSettings::RenderMapTile flag, so that no visible artifacts are visible between adjacent tiles.

SERVER_EXPORT QStringList	wmsRestrictedComposers (const QgsProject &project)
	Returns the restricted composer list.

SERVER_EXPORT QStringList	wmsRestrictedLayers (const QgsProject &project)
	Returns the restricted layer name list.

SERVER_EXPORT QString	wmsRootName (const QgsProject &project)
	Returns the WMS root layer name defined in a QGIS project.

SERVER_EXPORT QString	wmsServiceUrl (const QgsProject &project, const QgsServerRequest &request=QgsServerRequest(), const QgsServerSettings &settings=QgsServerSettings())
	Returns the WMS service url.

SERVER_EXPORT int	wmsTileBuffer (const QgsProject &project)
	Returns the tile buffer in pixels for WMS images defined in a QGIS project.

SERVER_EXPORT bool	wmsUseLayerIds (const QgsProject &project)
	Returns if layer ids are used as name in WMS.

SERVER_EXPORT QString	wmtsServiceUrl (const QgsProject &project, const QgsServerRequest &request=QgsServerRequest(), const QgsServerSettings &settings=QgsServerSettings())
	Returns the WMTS service url.

Detailed Description

The QgsServerProjectUtils namespace provides a way to retrieve specific entries from a QgsProject.

Since: QGIS 3.0

Function Documentation

◆ ceilWithPrecision()

double QgsServerProjectUtils::ceilWithPrecision	(	double	number,
		int	places
	)

Returns a double greater than number to the specified number of places.

Since: QGIS 3.10.1

Definition at line 22 of file qgsserverprojectutils.cpp.

◆ floorWithPrecision()

double QgsServerProjectUtils::floorWithPrecision	(	double	number,
		int	places
	)

Returns a double less than number to the specified number of places.

Since: QGIS 3.10.1

Definition at line 28 of file qgsserverprojectutils.cpp.

◆ owsServiceAbstract()

QString QgsServerProjectUtils::owsServiceAbstract ( const QgsProject & project )

Returns the owsService abstract defined in project.

Parameters

project the QGIS project

Returns: the owsService abstract if defined in project.

Definition at line 53 of file qgsserverprojectutils.cpp.

◆ owsServiceAccessConstraints()

QString QgsServerProjectUtils::owsServiceAccessConstraints ( const QgsProject & project )

Returns the owsService access constraints defined in project.

Parameters

project the QGIS project

Returns: the owsService access constraints if defined in project.

Definition at line 120 of file qgsserverprojectutils.cpp.

◆ owsServiceCapabilities()

bool QgsServerProjectUtils::owsServiceCapabilities ( const QgsProject & project )

Returns if owsService capabilities are enabled.

Parameters

project the QGIS project

Returns: if owsService capabilities are enabled.

Definition at line 34 of file qgsserverprojectutils.cpp.

◆ owsServiceContactMail()

QString QgsServerProjectUtils::owsServiceContactMail ( const QgsProject & project )

Returns the owsService contact mail defined in project.

Parameters

project the QGIS project

Returns: the owsService contact mail if defined in project.

Definition at line 105 of file qgsserverprojectutils.cpp.

◆ owsServiceContactOrganization()

QString QgsServerProjectUtils::owsServiceContactOrganization ( const QgsProject & project )

Returns the owsService contact organization defined in project.

Parameters

project the QGIS project

Returns: the owsService contact organization if defined in project.

Definition at line 90 of file qgsserverprojectutils.cpp.

◆ owsServiceContactPerson()

QString QgsServerProjectUtils::owsServiceContactPerson ( const QgsProject & project )

Returns the owsService contact person defined in project.

Parameters

project the QGIS project

Returns: the owsService contact person if defined in project.

Definition at line 100 of file qgsserverprojectutils.cpp.

◆ owsServiceContactPhone()

QString QgsServerProjectUtils::owsServiceContactPhone ( const QgsProject & project )

Returns the owsService contact phone defined in project.

Parameters

project the QGIS project

Returns: the owsService contact phone if defined in project.

Definition at line 110 of file qgsserverprojectutils.cpp.

◆ owsServiceContactPosition()

QString QgsServerProjectUtils::owsServiceContactPosition ( const QgsProject & project )

Returns the owsService contact position defined in project.

Parameters

project the QGIS project

Returns: the owsService contact position if defined in project.

Definition at line 95 of file qgsserverprojectutils.cpp.

◆ owsServiceFees()

QString QgsServerProjectUtils::owsServiceFees ( const QgsProject & project )

Returns the owsService fees defined in project.

Parameters

project the QGIS project

Returns: the owsService fees if defined in project.

Definition at line 115 of file qgsserverprojectutils.cpp.

◆ owsServiceKeywords()

QStringList QgsServerProjectUtils::owsServiceKeywords ( const QgsProject & project )

Returns the owsService keywords defined in project.

Parameters

project the QGIS project

Returns: the owsService keywords if defined in project.

Definition at line 58 of file qgsserverprojectutils.cpp.

◆ owsServiceOnlineResource()

QString QgsServerProjectUtils::owsServiceOnlineResource ( const QgsProject & project )

Returns the owsService online resource defined in project.

Parameters

project the QGIS project

Returns: the owsService online resource if defined in project.

Definition at line 76 of file qgsserverprojectutils.cpp.

◆ owsServiceTitle()

QString QgsServerProjectUtils::owsServiceTitle ( const QgsProject & project )

Returns the owsService title defined in project.

Parameters

project the QGIS project

Returns: the owsService title if defined in project with project title as fallback, "Untitled" otherwise.

Definition at line 39 of file qgsserverprojectutils.cpp.

◆ serviceUrl()

QString QgsServerProjectUtils::serviceUrl	(	const QString &	service,
		const QgsServerRequest &	request,
		const QgsServerSettings &	settings
	)

Returns the service url defined in the environment variable or with HTTP header.

This is calculated from (in order of precedence):

Value defined in the project per service
The QGIS_SERVER_<service>_SERVICE_URL environment variable
The QGIS_SERVER_SERVICE_URL environment variable
The custom X-Qgis-<service>-Service-Url header
The custom X-Qgis-Service-Url header
Build from the standard Forwarded header
Build from the pseudo standard X-Forwarded-Host and X-Forwarded-Proto headers
Build from the standard Host header and the server protocol
Build from the server name and the server protocol.

Parameters

request	the request
service	the used service
settings	the server settings

Returns: url to use for this service

Since: QGIS 3.20

Definition at line 325 of file qgsserverprojectutils.cpp.

◆ wcsLayerIds()

QStringList QgsServerProjectUtils::wcsLayerIds ( const QgsProject & project )

Returns the Layer ids list defined in a QGIS project as published in WCS.

Parameters

project the QGIS project

Returns: the Layer ids list.

Definition at line 524 of file qgsserverprojectutils.cpp.

◆ wcsServiceUrl()

QString QgsServerProjectUtils::wcsServiceUrl	(	const QgsProject &	project,
		const QgsServerRequest &	request = `QgsServerRequest()`,
		const QgsServerSettings &	settings = `QgsServerSettings()`
	)

Returns the WCS service url.

The URL defined in the project or if not defined the URL from serviceUrl.

Parameters

project	the QGIS project
request	the request
settings	the server settings

Returns: url to use for this service

Definition at line 514 of file qgsserverprojectutils.cpp.

◆ wfsLayerIds()

QStringList QgsServerProjectUtils::wfsLayerIds ( const QgsProject & project )

Returns the Layer ids list defined in a QGIS project as published in WFS.

Parameters

project the QGIS project

Returns: the Layer ids list.

Definition at line 489 of file qgsserverprojectutils.cpp.

◆ wfsLayerPrecision()

int QgsServerProjectUtils::wfsLayerPrecision	(	const QgsProject &	project,
		const QString &	layerId
	)

Returns the Layer precision defined in a QGIS project for the WFS GetFeature.

Parameters

project	the QGIS project
layerId	the layer id in the project

Returns: the layer precision for WFS GetFeature.

Definition at line 494 of file qgsserverprojectutils.cpp.

◆ wfsServiceUrl()

QString QgsServerProjectUtils::wfsServiceUrl	(	const QgsProject &	project,
		const QgsServerRequest &	request = `QgsServerRequest()`,
		const QgsServerSettings &	settings = `QgsServerSettings()`
	)

Returns the WFS service url.

The URL defined in the project or if not defined the URL from serviceUrl.

Parameters

project	the QGIS project
request	the request
settings	the server settings

Returns: url to use for this service

Definition at line 479 of file qgsserverprojectutils.cpp.

◆ wfstDeleteLayerIds()

QStringList QgsServerProjectUtils::wfstDeleteLayerIds ( const QgsProject & project )

Returns the Layer ids list defined in a QGIS project as published as WFS-T with delete capabilities.

Parameters

project the QGIS project

Returns: the Layer ids list.

Definition at line 509 of file qgsserverprojectutils.cpp.

◆ wfstInsertLayerIds()

QStringList QgsServerProjectUtils::wfstInsertLayerIds ( const QgsProject & project )

Returns the Layer ids list defined in a QGIS project as published as WFS-T with insert capabilities.

Parameters

project the QGIS project

Returns: the Layer ids list.

Definition at line 504 of file qgsserverprojectutils.cpp.

◆ wfstUpdateLayerIds()

QStringList QgsServerProjectUtils::wfstUpdateLayerIds ( const QgsProject & project )

Returns the Layer ids list defined in a QGIS project as published as WFS-T with update capabilities.

Parameters

project the QGIS project

Returns: the Layer ids list.

Definition at line 499 of file qgsserverprojectutils.cpp.

◆ wmsAddLegendGroupsLegendGraphic()

bool QgsServerProjectUtils::wmsAddLegendGroupsLegendGraphic ( const QgsProject & project )

Returns if legend groups should be in the legend graphic response if GetLegendGraphic is called on a layer group.

Parameters

project the QGIS project

Returns: if the GetLegendGraphic response has to contain legend groups

Definition at line 191 of file qgsserverprojectutils.cpp.

◆ wmsDefaultMapUnitsPerMm()

double QgsServerProjectUtils::wmsDefaultMapUnitsPerMm ( const QgsProject & project )

Returns the default number of map units per millimeters in case of the scale is not given.

Parameters

project the QGIS project

Returns: the default number of map units per millimeter

Since: QGIS 3.4

Definition at line 155 of file qgsserverprojectutils.cpp.

◆ wmsExtent()

QgsRectangle QgsServerProjectUtils::wmsExtent ( const QgsProject & project )

Returns the WMS Extent restriction.

Parameters

project the QGIS project

Returns: the WMS Extent restriction.

Definition at line 463 of file qgsserverprojectutils.cpp.

◆ wmsFeatureInfoAddWktGeometry()

bool QgsServerProjectUtils::wmsFeatureInfoAddWktGeometry ( const QgsProject & project )

Returns if the geometry is displayed as Well Known Text in GetFeatureInfo request.

Parameters

project the QGIS project

Returns: if the geometry is displayed as Well Known Text in GetFeatureInfo request.

Definition at line 168 of file qgsserverprojectutils.cpp.

◆ wmsFeatureInfoDocumentElement()

QString QgsServerProjectUtils::wmsFeatureInfoDocumentElement ( const QgsProject & project )

Returns the document element name for XML GetFeatureInfo request.

Parameters

project the QGIS project

Returns: the document element name for XML GetFeatureInfo request.

Definition at line 203 of file qgsserverprojectutils.cpp.

◆ wmsFeatureInfoDocumentElementNs()

QString QgsServerProjectUtils::wmsFeatureInfoDocumentElementNs ( const QgsProject & project )

Returns the document element namespace for XML GetFeatureInfo request.

Parameters

project the QGIS project

Returns: the document element namespace for XML GetFeatureInfo request.

Definition at line 208 of file qgsserverprojectutils.cpp.

◆ wmsFeatureInfoLayerAliasMap()

QHash< QString, QString > QgsServerProjectUtils::wmsFeatureInfoLayerAliasMap ( const QgsProject & project )

Returns the mapping between layer name and wms layer name for GetFeatureInfo request.

Parameters

project the QGIS project

Returns: the mapping between layer name and wms layer name for GetFeatureInfo request.

Definition at line 218 of file qgsserverprojectutils.cpp.

◆ wmsFeatureInfoPrecision()

int QgsServerProjectUtils::wmsFeatureInfoPrecision ( const QgsProject & project )

Returns the geometry precision for GetFeatureInfo request.

Parameters

project the QGIS project

Returns: the geometry precision for GetFeatureInfo request.

Definition at line 198 of file qgsserverprojectutils.cpp.

◆ wmsFeatureInfoSchema()

QString QgsServerProjectUtils::wmsFeatureInfoSchema ( const QgsProject & project )

Returns the schema URL for XML GetFeatureInfo request.

Parameters

project the QGIS project

Returns: the schema URL for XML GetFeatureInfo request.

Definition at line 213 of file qgsserverprojectutils.cpp.

◆ wmsFeatureInfoSegmentizeWktGeometry()

bool QgsServerProjectUtils::wmsFeatureInfoSegmentizeWktGeometry ( const QgsProject & project )

Returns if the geometry has to be segmentize in GetFeatureInfo request.

Parameters

project the QGIS project

Returns: if the geometry has to be segmentize in GetFeatureInfo request.

Definition at line 183 of file qgsserverprojectutils.cpp.

◆ wmsFeatureInfoUseAttributeFormSettings()

bool QgsServerProjectUtils::wmsFeatureInfoUseAttributeFormSettings ( const QgsProject & project )

Returns if feature form settings should be considered for the format of the feature info response.

Parameters

project the QGIS project

Returns: true if the feature form settings shall be considered for the feature info response

Definition at line 176 of file qgsserverprojectutils.cpp.

◆ wmsImageQuality()

int QgsServerProjectUtils::wmsImageQuality ( const QgsProject & project )

Returns the quality for WMS images defined in a QGIS project.

Parameters

project the QGIS project

Returns: quality if defined in project, -1 otherwise.

Definition at line 140 of file qgsserverprojectutils.cpp.

◆ wmsInfoFormatSia2045()

bool QgsServerProjectUtils::wmsInfoFormatSia2045 ( const QgsProject & project )

Returns if the info format is SIA20145.

Parameters

project the QGIS project

Returns: if the info format is SIA20145.

Definition at line 160 of file qgsserverprojectutils.cpp.

◆ wmsInspireActivate()

bool QgsServerProjectUtils::wmsInspireActivate ( const QgsProject & project )

Returns if Inspire is activated.

Parameters

project the QGIS project

Returns: if Inspire is activated.

Definition at line 245 of file qgsserverprojectutils.cpp.

◆ wmsInspireLanguage()

QString QgsServerProjectUtils::wmsInspireLanguage ( const QgsProject & project )

Returns the Inspire language.

Parameters

project the QGIS project

Returns: the Inspire language if defined in project.

Definition at line 250 of file qgsserverprojectutils.cpp.

◆ wmsInspireMetadataDate()

QString QgsServerProjectUtils::wmsInspireMetadataDate ( const QgsProject & project )

Returns the Inspire metadata date.

Parameters

project the QGIS project

Returns: the Inspire metadata date if defined in project.

Definition at line 270 of file qgsserverprojectutils.cpp.

◆ wmsInspireMetadataUrl()

QString QgsServerProjectUtils::wmsInspireMetadataUrl ( const QgsProject & project )

Returns the Inspire metadata URL.

Parameters

project the QGIS project

Returns: the Inspire metadata URL if defined in project.

Definition at line 255 of file qgsserverprojectutils.cpp.

◆ wmsInspireMetadataUrlType()

QString QgsServerProjectUtils::wmsInspireMetadataUrlType ( const QgsProject & project )

Returns the Inspire metadata URL type.

Parameters

project the QGIS project

Returns: the Inspire metadata URL type if defined in project.

Definition at line 260 of file qgsserverprojectutils.cpp.

◆ wmsInspireTemporalReference()

QString QgsServerProjectUtils::wmsInspireTemporalReference ( const QgsProject & project )

Returns the Inspire temporal reference.

Parameters

project the QGIS project

Returns: the Inspire temporal reference if defined in project.

Definition at line 265 of file qgsserverprojectutils.cpp.

◆ wmsMaxAtlasFeatures()

int QgsServerProjectUtils::wmsMaxAtlasFeatures ( const QgsProject & project )

Returns the maximum number of atlas features which can be printed in a request.

Parameters

project the QGIS project

Returns: the number of atlas features

Definition at line 150 of file qgsserverprojectutils.cpp.

◆ wmsMaxHeight()

int QgsServerProjectUtils::wmsMaxHeight ( const QgsProject & project )

Returns the maximum height for WMS images defined in a QGIS project.

Parameters

project the QGIS project

Returns: height if defined in project, -1 otherwise.

Definition at line 130 of file qgsserverprojectutils.cpp.

◆ wmsMaxWidth()

int QgsServerProjectUtils::wmsMaxWidth ( const QgsProject & project )

Returns the maximum width for WMS images defined in a QGIS project.

Parameters

project the QGIS project

Returns: width if defined in project, -1 otherwise.

Definition at line 125 of file qgsserverprojectutils.cpp.

◆ wmsOutputCrsList()

QStringList QgsServerProjectUtils::wmsOutputCrsList ( const QgsProject & project )

Returns the WMS output CRS list.

Parameters

project the QGIS project

Returns: the WMS output CRS list.

Definition at line 280 of file qgsserverprojectutils.cpp.

◆ wmsRenderMapTiles()

bool QgsServerProjectUtils::wmsRenderMapTiles ( const QgsProject & project )

Returns true if WMS requests should use the QgsMapSettings::RenderMapTile flag, so that no visible artifacts are visible between adjacent tiles.

This flag can slow down rendering considerably, so it is only used if the corresponding setting is enabled in the project.

Parameters

project the QGIS project

Returns: true if the flag should be used, or false if not.

Since: QGIS 3.18

Definition at line 539 of file qgsserverprojectutils.cpp.

◆ wmsRestrictedComposers()

QStringList QgsServerProjectUtils::wmsRestrictedComposers ( const QgsProject & project )

Returns the restricted composer list.

Parameters

project the QGIS project

Returns: the restricted composer list if defined in project.

Definition at line 275 of file qgsserverprojectutils.cpp.

◆ wmsRestrictedLayers()

QStringList QgsServerProjectUtils::wmsRestrictedLayers ( const QgsProject & project )

Returns the restricted layer name list.

Parameters

project the QGIS project

Returns: the restricted layer name list if defined in project.

Definition at line 458 of file qgsserverprojectutils.cpp.

◆ wmsRootName()

QString QgsServerProjectUtils::wmsRootName ( const QgsProject & project )

Returns the WMS root layer name defined in a QGIS project.

Parameters

project the QGIS project

Returns: root layer name to use for this service

Definition at line 453 of file qgsserverprojectutils.cpp.

◆ wmsServiceUrl()

QString QgsServerProjectUtils::wmsServiceUrl	(	const QgsProject &	project,
		const QgsServerRequest &	request = `QgsServerRequest()`,
		const QgsServerSettings &	settings = `QgsServerSettings()`
	)

Returns the WMS service url.

The URL defined in the project or if not defined the URL from serviceUrl.

Parameters

project	the QGIS project
request	the request
settings	the server settings

Returns: url to use for this service

Definition at line 443 of file qgsserverprojectutils.cpp.

◆ wmsTileBuffer()

int QgsServerProjectUtils::wmsTileBuffer ( const QgsProject & project )

Returns the tile buffer in pixels for WMS images defined in a QGIS project.

Parameters

project the QGIS project

Returns: tile buffer if defined in project, 0 otherwise.

Since: QGIS 3.10

Definition at line 145 of file qgsserverprojectutils.cpp.

◆ wmsUseLayerIds()

bool QgsServerProjectUtils::wmsUseLayerIds ( const QgsProject & project )

Returns if layer ids are used as name in WMS.

Parameters

project the QGIS project

Returns: if layer ids are used as name.

Definition at line 135 of file qgsserverprojectutils.cpp.

◆ wmtsServiceUrl()

QString QgsServerProjectUtils::wmtsServiceUrl	(	const QgsProject &	project,
		const QgsServerRequest &	request = `QgsServerRequest()`,
		const QgsServerSettings &	settings = `QgsServerSettings()`
	)

Returns the WMTS service url.

The URL defined in the project or if not defined the URL from serviceUrl.

Parameters

project	the QGIS project
request	the request
settings	the server settings

Returns: url to use for this service

Since: QGIS 3.4

Definition at line 529 of file qgsserverprojectutils.cpp.

Functions

Detailed Description

Function Documentation

◆ ceilWithPrecision()

◆ floorWithPrecision()

◆ owsServiceAbstract()

◆ owsServiceAccessConstraints()

◆ owsServiceCapabilities()

◆ owsServiceContactMail()

◆ owsServiceContactOrganization()

◆ owsServiceContactPerson()

◆ owsServiceContactPhone()

◆ owsServiceContactPosition()

◆ owsServiceFees()

◆ owsServiceKeywords()

◆ owsServiceOnlineResource()

◆ owsServiceTitle()

◆ serviceUrl()

◆ wcsLayerIds()

◆ wcsServiceUrl()

◆ wfsLayerIds()

◆ wfsLayerPrecision()

◆ wfsServiceUrl()

◆ wfstDeleteLayerIds()

◆ wfstInsertLayerIds()

◆ wfstUpdateLayerIds()

◆ wmsAddLegendGroupsLegendGraphic()

◆ wmsDefaultMapUnitsPerMm()

◆ wmsExtent()

◆ wmsFeatureInfoAddWktGeometry()

◆ wmsFeatureInfoDocumentElement()

◆ wmsFeatureInfoDocumentElementNs()

◆ wmsFeatureInfoLayerAliasMap()

◆ wmsFeatureInfoPrecision()

◆ wmsFeatureInfoSchema()

◆ wmsFeatureInfoSegmentizeWktGeometry()

◆ wmsFeatureInfoUseAttributeFormSettings()

◆ wmsImageQuality()

◆ wmsInfoFormatSia2045()

◆ wmsInspireActivate()

◆ wmsInspireLanguage()

◆ wmsInspireMetadataDate()

◆ wmsInspireMetadataUrl()

◆ wmsInspireMetadataUrlType()

◆ wmsInspireTemporalReference()

◆ wmsMaxAtlasFeatures()

◆ wmsMaxHeight()

◆ wmsMaxWidth()

◆ wmsOutputCrsList()

◆ wmsRenderMapTiles()

◆ wmsRestrictedComposers()

◆ wmsRestrictedLayers()

◆ wmsRootName()

◆ wmsServiceUrl()

◆ wmsTileBuffer()

◆ wmsUseLayerIds()

◆ wmtsServiceUrl()