QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
Classes | Public Member Functions | Protected Member Functions | List of all members
QgsServerMetadataUrlProperties Class Referenceabstract

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

#include <qgsmaplayerserverproperties.h>

Inheritance diagram for QgsServerMetadataUrlProperties:
Inheritance graph
[legend]

Classes

struct  MetadataUrl
 MetadataUrl structure. More...
 

Public Member Functions

virtual ~QgsServerMetadataUrlProperties ()=default
 
void addMetadataUrl (const QgsServerMetadataUrlProperties::MetadataUrl &metaUrl)
 Add a metadataUrl for the layer. More...
 
virtual const QgsMapLayerlayer () const =0
 Gets the parent 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...
 

Protected Member Functions

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...
 

Detailed Description

Manages QGIS Server properties for a map layer.

Since
QGIS 3.22

Definition at line 38 of file qgsmaplayerserverproperties.h.

Constructor & Destructor Documentation

◆ ~QgsServerMetadataUrlProperties()

virtual QgsServerMetadataUrlProperties::~QgsServerMetadataUrlProperties ( )
virtualdefault

Member Function Documentation

◆ addMetadataUrl()

void QgsServerMetadataUrlProperties::addMetadataUrl ( const QgsServerMetadataUrlProperties::MetadataUrl metaUrl)
inline

Add a metadataUrl for the layer.

See also
setMetadataUrls()

Definition at line 102 of file qgsmaplayerserverproperties.h.

◆ copyTo()

void QgsServerMetadataUrlProperties::copyTo ( QgsServerMetadataUrlProperties properties) const
protected

Copy properties to another instance.

Parameters
propertiesThe properties to copy to

Definition at line 33 of file qgsmaplayerserverproperties.cpp.

◆ layer()

virtual const QgsMapLayer * QgsServerMetadataUrlProperties::layer ( ) const
pure virtual

Gets the parent layer.

Implemented in QgsMapLayerServerProperties.

◆ metadataUrls()

QList< QgsServerMetadataUrlProperties::MetadataUrl > QgsServerMetadataUrlProperties::metadataUrls ( ) const
inline

Returns a list of metadataUrl resources associated for the layer.

Returns
the list of metadata URLs
See also
setMetadataUrls()

Definition at line 89 of file qgsmaplayerserverproperties.h.

◆ readXml()

void QgsServerMetadataUrlProperties::readXml ( const QDomNode &  layer_node)
protected

Reads server properties from project file.

Definition at line 43 of file qgsmaplayerserverproperties.cpp.

◆ reset()

void QgsServerMetadataUrlProperties::reset ( )
protected

Reset properties to default.

Definition at line 38 of file qgsmaplayerserverproperties.cpp.

◆ setMetadataUrls()

void QgsServerMetadataUrlProperties::setMetadataUrls ( const QList< QgsServerMetadataUrlProperties::MetadataUrl > &  metaUrls)
inline

Sets a the list of metadata URL for the layer.

See also
metadataUrls()
addMetadataUrl()

Definition at line 96 of file qgsmaplayerserverproperties.h.

◆ writeXml()

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

Saves server properties to xml under the layer node.

Definition at line 59 of file qgsmaplayerserverproperties.cpp.


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