QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | List of all members
QgsMapLayerServerProperties Class Reference

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

#include <qgsmaplayerserverproperties.h>

Inheritance diagram for QgsMapLayerServerProperties:
Inheritance graph
[legend]

Public Member Functions

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

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. More...
 
- Protected Member Functions inherited from QgsServerMetadataUrlProperties
void copyTo (QgsServerMetadataUrlProperties *properties) const
 Copy properties to another instance. More...
 
void readXml (const QDomNode &layer_node)
 Reads server properties from project file. More...
 
void reset ()
 Reset properties to default. More...
 
void writeXml (QDomNode &layer_node, QDomDocument &document) const
 Saves server properties to xml under the layer node. More...
 
- Protected Member Functions inherited from QgsServerWmsDimensionProperties
void copyTo (QgsServerWmsDimensionProperties *properties) const
 Copy properties to another instance. More...
 
void readXml (const QDomNode &layer_node)
 Reads server properties from project file. More...
 
void reset ()
 Reset properties to default. More...
 
void writeXml (QDomNode &layer_node, QDomDocument &document) const
 Saves server properties to xml under the layer node. More...
 

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
layerThe 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
propertiesThe 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: