/************************************************************************ * This file has been generated automatically from * * * * src/core/qgsmaplayerserverproperties.h * * * * Do not edit manually ! Edit header and run scripts/sipify.py again * ************************************************************************/ class QgsServerMetadataUrlProperties { %Docstring(signature="appended") Manages QGIS Server properties for a map layer. .. versionadded:: 3.22 %End %TypeHeaderCode #include "qgsmaplayerserverproperties.h" %End public: static const QMetaObject staticMetaObject; public: struct MetadataUrl { MetadataUrl( const QString &url = QString(), const QString &type = QString(), const QString &format = QString() ); %Docstring Constructor for MetadataUrl. %End QString url; QString type; QString format; bool operator==( const QgsServerMetadataUrlProperties::MetadataUrl &other ) const; }; virtual ~QgsServerMetadataUrlProperties(); QList metadataUrls() const; %Docstring Returns a list of metadataUrl resources associated for the layer. :return: the list of metadata URLs .. seealso:: :py:func:`setMetadataUrls` %End void setMetadataUrls( const QList &metaUrls ); %Docstring Sets a the list of metadata URL for the layer .. seealso:: :py:func:`metadataUrls` .. seealso:: :py:func:`addMetadataUrl` %End void addMetadataUrl( const QgsServerMetadataUrlProperties::MetadataUrl &metaUrl ); %Docstring Add a metadataUrl for the layer .. seealso:: :py:func:`setMetadataUrls` %End virtual const QgsMapLayer *layer() const = 0; %Docstring Gets the parent layer %End bool operator==( const QgsServerMetadataUrlProperties &other ) const; bool operator!=( const QgsServerMetadataUrlProperties &other ) const; protected: }; class QgsServerWmsDimensionProperties { %Docstring(signature="appended") Manages QGIS Server properties for WMS dimensions. .. versionadded:: 3.22 %End %TypeHeaderCode #include "qgsmaplayerserverproperties.h" %End public: static const QMetaObject staticMetaObject; public: enum PredefinedWmsDimensionName /BaseType=IntEnum/ { TIME, DATE, ELEVATION }; struct WmsDimensionInfo { enum DefaultDisplay /BaseType=IntEnum/ { AllValues, MinValue, MaxValue, ReferenceValue, }; explicit WmsDimensionInfo( const QString &dimName, const QString &dimFieldName, const QString &dimEndFieldName = QString(), const QString &dimUnits = QString(), const QString &dimUnitSymbol = QString(), const int &dimDefaultDisplayType = QgsServerWmsDimensionProperties::WmsDimensionInfo::AllValues, const QVariant &dimReferenceValue = QVariant() ); %Docstring Constructor for WmsDimensionInfo. %End bool operator==( const WmsDimensionInfo &other ) const; bool operator!=( const WmsDimensionInfo &other ) const; QString name; QString fieldName; QString endFieldName; QString units; QString unitSymbol; int defaultDisplayType; QVariant referenceValue; }; virtual ~QgsServerWmsDimensionProperties(); bool operator==( const QgsServerWmsDimensionProperties &other ) const; bool operator!=( const QgsServerWmsDimensionProperties &other ) const; static QMap wmsDimensionDefaultDisplayLabels(); %Docstring Returns WMS Dimension default display labels .. versionadded:: 3.10 %End bool addWmsDimension( const QgsServerWmsDimensionProperties::WmsDimensionInfo &wmsDimInfo ); %Docstring Adds a QGIS Server WMS Dimension :param wmsDimInfo: QGIS Server WMS Dimension object with, name, field, etc :return: ``True`` if QGIS Server WMS Dimension has been successfully added .. versionadded:: 3.10 %End bool removeWmsDimension( const QString &wmsDimName ); %Docstring Removes a QGIS Server WMS Dimension :return: ``True`` if QGIS Server WMS Dimension was found and successfully removed .. versionadded:: 3.10 %End void setWmsDimensions( const QList &dimensions ); %Docstring Set WMS Dimensions :param dimensions: the new dimensions that replace the current ones. %End const QList wmsDimensions() const; %Docstring Returns the QGIS Server WMS Dimension list. .. versionadded:: 3.10 %End virtual const QgsMapLayer *layer() const = 0; %Docstring Gets the parent layer %End protected: }; class QgsMapLayerServerProperties: QgsServerMetadataUrlProperties, QgsServerWmsDimensionProperties { %Docstring(signature="appended") Manages QGIS Server properties for a map layer. .. versionadded:: 3.10 %End %TypeHeaderCode #include "qgsmaplayerserverproperties.h" %End public: static const QMetaObject staticMetaObject; public: QgsMapLayerServerProperties( QgsMapLayer *layer = 0 ); %Docstring Constructor - Creates a Map Layer QGIS Server Properties :param layer: The map layer %End bool operator==( const QgsMapLayerServerProperties &other ) const; bool operator!=( const QgsMapLayerServerProperties &other ) const; void copyTo( QgsMapLayerServerProperties *properties ) const; %Docstring Copy properties to another instance :param properties: The properties to copy to %End void writeXml( QDomNode &layer_node, QDomDocument &document ) const; %Docstring Saves server properties to xml under the layer node .. versionadded:: 3.10 %End void readXml( const QDomNode &layer_node ); %Docstring Reads server properties from project file. .. versionadded:: 3.10 %End void reset(); %Docstring Reset properties to default .. versionadded:: 3.22 %End void setShortName( const QString &name ); %Docstring Sets the short ``name`` of the layer used by QGIS Server to identify the layer. .. seealso:: :py:func:`shortName` .. versionadded:: 3.38 %End QString shortName() const; %Docstring Returns the short name of the layer used by QGIS Server to identify the layer. .. seealso:: :py:func:`setShortName` .. versionadded:: 3.38 %End void setTitle( const QString &title ); %Docstring Sets the ``title`` of the layer used by QGIS Server in GetCapabilities request. .. seealso:: :py:func:`title` .. versionadded:: 3.38 %End void setWfsTitle( const QString &title ); %Docstring Sets the ``title`` of the layer used by QGIS Server in WFS GetCapabilities request. .. seealso:: :py:func:`title` .. versionadded:: 3.40 %End QString title() const; %Docstring Returns the title of the layer used by QGIS Server in GetCapabilities request. .. seealso:: :py:func:`setTitle` .. versionadded:: 3.38 %End QString wfsTitle() const; %Docstring Returns the optional WFS title if set or the title of the layer used by QGIS WFS in GetCapabilities request. .. seealso:: :py:func:`setWfsTitle` .. versionadded:: 3.40 %End void setAbstract( const QString &abstract ); %Docstring Sets the ``abstract`` of the layer used by QGIS Server in GetCapabilities request. .. seealso:: :py:func:`abstract` .. versionadded:: 3.38 %End QString abstract() const; %Docstring Returns the abstract of the layerused by QGIS Server in GetCapabilities request. .. seealso:: :py:func:`setAbstract` .. versionadded:: 3.38 %End void setKeywordList( const QString &keywords ); %Docstring Sets the ``keywords`` list of the layerused by QGIS Server in GetCapabilities request. .. seealso:: :py:func:`keywordList` .. versionadded:: 3.38 %End QString keywordList() const; %Docstring Returns the keyword list of the layerused by QGIS Server in GetCapabilities request. .. seealso:: :py:func:`setKeywordList` .. versionadded:: 3.38 %End void setDataUrl( const QString &dataUrl ); %Docstring 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. .. seealso:: :py:func:`dataUrl` .. versionadded:: 3.38 %End QString dataUrl() const; %Docstring 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. .. seealso:: :py:func:`setDataUrl` .. versionadded:: 3.38 %End void setDataUrlFormat( const QString &dataUrlFormat ); %Docstring 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. .. seealso:: :py:func:`dataUrlFormat` .. versionadded:: 3.38 %End QString dataUrlFormat() const; %Docstring 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. .. seealso:: :py:func:`setDataUrlFormat` .. versionadded:: 3.38 %End void setAttribution( const QString &attrib ); %Docstring Sets the ``attribution`` of the layer used by QGIS Server in GetCapabilities request. Attribution indicates the provider of a layer or collection of layers. .. seealso:: :py:func:`attribution` .. versionadded:: 3.38 %End QString attribution() const; %Docstring Returns the attribution of the layer used by QGIS Server in GetCapabilities request. Attribution indicates the provider of a layer or collection of layers. .. seealso:: :py:func:`setAttribution` .. versionadded:: 3.38 %End void setAttributionUrl( const QString &url ); %Docstring 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. .. seealso:: :py:func:`attributionUrl` .. versionadded:: 3.38 %End QString attributionUrl() const; %Docstring 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. .. seealso:: :py:func:`setAttributionUrl` .. versionadded:: 3.38 %End void setLegendUrl( const QString &legendUrl ); %Docstring Sets the URL for the layer's legend. .. versionadded:: 3.44 %End QString legendUrl() const; %Docstring Returns the URL for the layer's legend. .. versionadded:: 3.44 %End void setLegendUrlFormat( const QString &legendUrlFormat ); %Docstring Sets the format for a URL based layer legend. .. versionadded:: 3.44 %End QString legendUrlFormat() const; %Docstring Returns the format for a URL based layer legend. .. versionadded:: 3.44 %End virtual const QgsMapLayer *layer() const; %Docstring Gets the parent layer %End }; class QgsVectorLayerServerProperties: QgsMapLayerServerProperties { %Docstring(signature="appended") Convenient class for API compatibility. .. deprecated:: 3.22 .. versionadded:: 3.10 %End %TypeHeaderCode #include "qgsmaplayerserverproperties.h" %End public: static const QMetaObject staticMetaObject; }; /************************************************************************ * This file has been generated automatically from * * * * src/core/qgsmaplayerserverproperties.h * * * * Do not edit manually ! Edit header and run scripts/sipify.py again * ************************************************************************/