QgsMapLayerServerProperties Class Reference

Manages QGIS Server properties for a map layer. More...

#include <qgsmaplayerserverproperties.h>

Inheritance diagram for QgsMapLayerServerProperties:

Public Member Functions
	QgsMapLayerServerProperties (QgsMapLayer *layer=nullptr)
	Constructor - Creates a Map Layer QGIS Server Properties.
void	copyTo (QgsMapLayerServerProperties *properties) const
	Copy properties to another instance.
const QgsMapLayer *	layer () const override
	Gets the parent layer.
void	readXml (const QDomNode &layer_node)
	Reads server properties from project file.
void	reset ()
	Reset properties to default.
void	writeXml (QDomNode &layer_node, QDomDocument &document) const
	Saves server properties to xml under the layer node.
Public Member Functions inherited from QgsServerMetadataUrlProperties
virtual	~QgsServerMetadataUrlProperties ()=default
void	addMetadataUrl (const QgsServerMetadataUrlProperties::MetadataUrl &metaUrl)
	Add a metadataUrl for the layer.
QList< QgsServerMetadataUrlProperties::MetadataUrl >	metadataUrls () const
	Returns a list of metadataUrl resources associated for the layer.
void	setMetadataUrls (const QList< QgsServerMetadataUrlProperties::MetadataUrl > &metaUrls)
	Sets a the list of metadata URL for the layer.
Public Member Functions inherited from QgsServerWmsDimensionProperties
virtual	~QgsServerWmsDimensionProperties ()=default
bool	addWmsDimension (const QgsServerWmsDimensionProperties::WmsDimensionInfo &wmsDimInfo)
	Adds a QGIS Server WMS Dimension.
bool	removeWmsDimension (const QString &wmsDimName)
	Removes a QGIS Server WMS Dimension.
void	setWmsDimensions (const QList< QgsServerWmsDimensionProperties::WmsDimensionInfo > &dimensions)
	Set WMS Dimensions.
const QList< QgsServerWmsDimensionProperties::WmsDimensionInfo >	wmsDimensions () const
	Returns the QGIS Server WMS Dimension list.

Additional Inherited Members
Public Types inherited from QgsServerWmsDimensionProperties
enum	PredefinedWmsDimensionName { TIME , DATE , ELEVATION }
	Predefined/Restricted WMS Dimension name. More...
Static Public Member Functions inherited from QgsServerWmsDimensionProperties
static QMap< int, QString >	wmsDimensionDefaultDisplayLabels ()
	Returns WMS Dimension default display labels.
Protected Member Functions inherited from QgsServerMetadataUrlProperties
void	copyTo (QgsServerMetadataUrlProperties *properties) const
	Copy properties to another instance.
void	readXml (const QDomNode &layer_node)
	Reads server properties from project file.
void	reset ()
	Reset properties to default.
void	writeXml (QDomNode &layer_node, QDomDocument &document) const
	Saves server properties to xml under the layer node.
Protected Member Functions inherited from QgsServerWmsDimensionProperties
void	copyTo (QgsServerWmsDimensionProperties *properties) const
	Copy properties to another instance.
void	readXml (const QDomNode &layer_node)
	Reads server properties from project file.
void	reset ()
	Reset properties to default.
void	writeXml (QDomNode &layer_node, QDomDocument &document) const
	Saves server properties to xml under the layer node.

Detailed Description

Manages QGIS Server properties for a map layer.

Since

QGIS 3.10

Definition at line 272 of file qgsmaplayerserverproperties.h.

Constructor & Destructor Documentation

QgsMapLayerServerProperties()

QgsMapLayerServerProperties::QgsMapLayerServerProperties

(

QgsMapLayer *

layer = nullptr

)

Constructor - Creates a Map Layer QGIS Server Properties.

Parameters

layer

The map layer

Definition at line 211 of file qgsmaplayerserverproperties.cpp.

Member Function Documentation

copyTo()

void QgsMapLayerServerProperties::copyTo

(

QgsMapLayerServerProperties *

properties

)

const

Copy properties to another instance.

Parameters

properties

The properties to copy to

Definition at line 216 of file qgsmaplayerserverproperties.cpp.

layer()

const QgsMapLayer * QgsMapLayerServerProperties::layer ( ) const

inlineoverridevirtual

Gets the parent layer.

Implements QgsServerMetadataUrlProperties.

Definition at line 311 of file qgsmaplayerserverproperties.h.

readXml()

void QgsMapLayerServerProperties::readXml

(

const QDomNode &

layer_node

)

Reads server properties from project file.

Since

QGIS 3.10

Definition at line 228 of file qgsmaplayerserverproperties.cpp.

reset()

void QgsMapLayerServerProperties::reset

(

)

Reset properties to default.

Since

QGIS 3.22

Definition at line 222 of file qgsmaplayerserverproperties.cpp.

writeXml()

void QgsMapLayerServerProperties::writeXml	(	QDomNode &	layer_node,
		QDomDocument &	document
	)		const

Saves server properties to xml under the layer node.

Since

QGIS 3.10

Definition at line 234 of file qgsmaplayerserverproperties.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.36.0+99sid/src/core/qgsmaplayerserverproperties.h
• /build/qgis-3.36.0+99sid/src/core/qgsmaplayerserverproperties.cpp