QGIS API Documentation 3.99.0-Master (21b3aa880ba)
Loading...
Searching...
No Matches
QgsServerMetadataUrlProperties Class Referenceabstract

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

#include <qgsmaplayerserverproperties.h>

Inheritance diagram for QgsServerMetadataUrlProperties:

Classes

struct  MetadataUrl
 MetadataUrl structure. More...

Public Member Functions

virtual ~QgsServerMetadataUrlProperties ()=default
void addMetadataUrl (const QgsServerMetadataUrlProperties::MetadataUrl &metaUrl)
 Add a metadataUrl for the layer.
virtual const QgsMapLayerlayer () const =0
 Gets the parent layer.
QList< QgsServerMetadataUrlProperties::MetadataUrlmetadataUrls () const
 Returns a list of metadataUrl resources associated for the layer.
bool operator!= (const QgsServerMetadataUrlProperties &other) const
bool operator== (const QgsServerMetadataUrlProperties &other) const
void setMetadataUrls (const QList< QgsServerMetadataUrlProperties::MetadataUrl > &metaUrls)
 Sets a the list of metadata URL for the layer.

Protected Member Functions

void copyTo (QgsServerMetadataUrlProperties *properties) const
 Copy properties to another instance.
void readXml (const QDomNode &layerNode)
 Reads server properties from project file.
void reset ()
 Reset properties to default.
void writeXml (QDomNode &layerNode, 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.22

Definition at line 39 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 103 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 62 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 90 of file qgsmaplayerserverproperties.h.

◆ operator!=()

bool QgsServerMetadataUrlProperties::operator!= ( const QgsServerMetadataUrlProperties & other) const

Definition at line 41 of file qgsmaplayerserverproperties.cpp.

◆ operator==()

bool QgsServerMetadataUrlProperties::operator== ( const QgsServerMetadataUrlProperties & other) const

Definition at line 36 of file qgsmaplayerserverproperties.cpp.

◆ readXml()

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

Reads server properties from project file.

Definition at line 72 of file qgsmaplayerserverproperties.cpp.

◆ reset()

void QgsServerMetadataUrlProperties::reset ( )
protected

Reset properties to default.

Definition at line 67 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 97 of file qgsmaplayerserverproperties.h.

◆ writeXml()

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

Saves server properties to xml under the layer node.

Definition at line 88 of file qgsmaplayerserverproperties.cpp.


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