QGIS API Documentation 3.41.0-Master (181b2f43d8e)
Loading...
Searching...
No Matches
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.
 
QString abstract () const
 Returns the abstract of the layerused by QGIS Server in GetCapabilities request.
 
QString attribution () const
 Returns the attribution of the layer used by QGIS Server in GetCapabilities request.
 
QString attributionUrl () const
 Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request.
 
void copyTo (QgsMapLayerServerProperties *properties) const
 Copy properties to another instance.
 
QString dataUrl () const
 Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.
 
QString dataUrlFormat () const
 Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.
 
QString keywordList () const
 Returns the keyword list of the layerused by QGIS Server in GetCapabilities request.
 
const QgsMapLayerlayer () 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 setAbstract (const QString &abstract)
 Sets the abstract of the layer used by QGIS Server in GetCapabilities request.
 
void setAttribution (const QString &attrib)
 Sets the attribution of the layer used by QGIS Server in GetCapabilities request.
 
void setAttributionUrl (const QString &url)
 Sets the attribution url of the layer used by QGIS Server in GetCapabilities request.
 
void setDataUrl (const QString &dataUrl)
 Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.
 
void setDataUrlFormat (const QString &dataUrlFormat)
 Sets the DataUrl format of the layerused by QGIS Server in GetCapabilities request.
 
void setKeywordList (const QString &keywords)
 Sets the keywords list of the layerused by QGIS Server in GetCapabilities request.
 
void setShortName (const QString &name)
 Sets the short name of the layer used by QGIS Server to identify the layer.
 
void setTitle (const QString &title)
 Sets the title of the layer used by QGIS Server in GetCapabilities request.
 
void setWfsTitle (const QString &title)
 Sets the title of the layer used by QGIS Server in WFS GetCapabilities request.
 
QString shortName () const
 Returns the short name of the layer used by QGIS Server to identify the layer.
 
QString title () const
 Returns the title of the layer used by QGIS Server in GetCapabilities request.
 
QString wfsTitle () const
 Returns the optional WFS title if set or the title of the layer used by QGIS WFS in GetCapabilities request.
 
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::MetadataUrlmetadataUrls () 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::WmsDimensionInfowmsDimensions () 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
layerThe map layer

Definition at line 212 of file qgsmaplayerserverproperties.cpp.

Member Function Documentation

◆ abstract()

QString QgsMapLayerServerProperties::abstract ( ) const
inline

Returns the abstract of the layerused by QGIS Server in GetCapabilities request.

See also
setAbstract()
Since
QGIS 3.38

Definition at line 381 of file qgsmaplayerserverproperties.h.

◆ attribution()

QString QgsMapLayerServerProperties::attribution ( ) const
inline

Returns the attribution of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

See also
setAttribution()
Since
QGIS 3.38

Definition at line 465 of file qgsmaplayerserverproperties.h.

◆ attributionUrl()

QString QgsMapLayerServerProperties::attributionUrl ( ) const
inline

Returns the attribution URL of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

See also
setAttributionUrl()
Since
QGIS 3.38

Definition at line 487 of file qgsmaplayerserverproperties.h.

◆ copyTo()

void QgsMapLayerServerProperties::copyTo ( QgsMapLayerServerProperties properties) const

Copy properties to another instance.

Parameters
propertiesThe properties to copy to

Definition at line 217 of file qgsmaplayerserverproperties.cpp.

◆ dataUrl()

QString QgsMapLayerServerProperties::dataUrl ( ) const
inline

Returns the DataUrl of the layer used by QGIS Server in GetCapabilities request.

DataUrl is a a link to the underlying data represented by a particular layer.

See also
setDataUrl()
Since
QGIS 3.38

Definition at line 421 of file qgsmaplayerserverproperties.h.

◆ dataUrlFormat()

QString QgsMapLayerServerProperties::dataUrlFormat ( ) const
inline

Returns the DataUrl format of the layer used by QGIS Server in GetCapabilities request.

DataUrl is a a link to the underlying data represented by a particular layer.

See also
setDataUrlFormat()
Since
QGIS 3.38

Definition at line 443 of file qgsmaplayerserverproperties.h.

◆ keywordList()

QString QgsMapLayerServerProperties::keywordList ( ) const
inline

Returns the keyword list of the layerused by QGIS Server in GetCapabilities request.

See also
setKeywordList()
Since
QGIS 3.38

Definition at line 399 of file qgsmaplayerserverproperties.h.

◆ layer()

const QgsMapLayer * QgsMapLayerServerProperties::layer ( ) const
inlineoverridevirtual

Gets the parent layer.

Implements QgsServerMetadataUrlProperties.

Definition at line 490 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 238 of file qgsmaplayerserverproperties.cpp.

◆ reset()

void QgsMapLayerServerProperties::reset ( )

Reset properties to default.

Since
QGIS 3.22

Definition at line 232 of file qgsmaplayerserverproperties.cpp.

◆ setAbstract()

void QgsMapLayerServerProperties::setAbstract ( const QString &  abstract)
inline

Sets the abstract of the layer used by QGIS Server in GetCapabilities request.

See also
abstract()
Since
QGIS 3.38

Definition at line 372 of file qgsmaplayerserverproperties.h.

◆ setAttribution()

void QgsMapLayerServerProperties::setAttribution ( const QString &  attrib)
inline

Sets the attribution of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

See also
attribution()
Since
QGIS 3.38

Definition at line 454 of file qgsmaplayerserverproperties.h.

◆ setAttributionUrl()

void QgsMapLayerServerProperties::setAttributionUrl ( const QString &  url)
inline

Sets the attribution url of the layer used by QGIS Server in GetCapabilities request.

Attribution indicates the provider of a layer or collection of layers.

See also
attributionUrl()
Since
QGIS 3.38

Definition at line 476 of file qgsmaplayerserverproperties.h.

◆ setDataUrl()

void QgsMapLayerServerProperties::setDataUrl ( const QString &  dataUrl)
inline

Sets the DataUrl of the layer used by QGIS Server in GetCapabilities request.

DataUrl is a a link to the underlying data represented by a particular layer.

See also
dataUrl()
Since
QGIS 3.38

Definition at line 410 of file qgsmaplayerserverproperties.h.

◆ setDataUrlFormat()

void QgsMapLayerServerProperties::setDataUrlFormat ( const QString &  dataUrlFormat)
inline

Sets the DataUrl format of the layerused by QGIS Server in GetCapabilities request.

DataUrl is a a link to the underlying data represented by a particular layer.

See also
dataUrlFormat()
Since
QGIS 3.38

Definition at line 432 of file qgsmaplayerserverproperties.h.

◆ setKeywordList()

void QgsMapLayerServerProperties::setKeywordList ( const QString &  keywords)
inline

Sets the keywords list of the layerused by QGIS Server in GetCapabilities request.

See also
keywordList()
Since
QGIS 3.38

Definition at line 390 of file qgsmaplayerserverproperties.h.

◆ setShortName()

void QgsMapLayerServerProperties::setShortName ( const QString &  name)
inline

Sets the short name of the layer used by QGIS Server to identify the layer.

See also
shortName()
Since
QGIS 3.38

Definition at line 317 of file qgsmaplayerserverproperties.h.

◆ setTitle()

void QgsMapLayerServerProperties::setTitle ( const QString &  title)
inline

Sets the title of the layer used by QGIS Server in GetCapabilities request.

See also
title()
Since
QGIS 3.38

Definition at line 335 of file qgsmaplayerserverproperties.h.

◆ setWfsTitle()

void QgsMapLayerServerProperties::setWfsTitle ( const QString &  title)
inline

Sets the title of the layer used by QGIS Server in WFS GetCapabilities request.

See also
title()
Since
QGIS 3.40

Definition at line 344 of file qgsmaplayerserverproperties.h.

◆ shortName()

QString QgsMapLayerServerProperties::shortName ( ) const
inline

Returns the short name of the layer used by QGIS Server to identify the layer.

See also
setShortName()
Since
QGIS 3.38

Definition at line 326 of file qgsmaplayerserverproperties.h.

◆ title()

QString QgsMapLayerServerProperties::title ( ) const
inline

Returns the title of the layer used by QGIS Server in GetCapabilities request.

See also
setTitle()
Since
QGIS 3.38

Definition at line 353 of file qgsmaplayerserverproperties.h.

◆ wfsTitle()

QString QgsMapLayerServerProperties::wfsTitle ( ) const
inline

Returns the optional WFS title if set or the title of the layer used by QGIS WFS in GetCapabilities request.

See also
setWfsTitle()
Since
QGIS 3.40

Definition at line 363 of file qgsmaplayerserverproperties.h.

◆ 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 294 of file qgsmaplayerserverproperties.cpp.


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