QGIS/python/core/auto_generated/qgsvectorlayerserverproperties.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsvectorlayerserverproperties.h                            *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/






class QgsVectorLayerServerProperties
{
%Docstring
Manages QGIS Server properties for a vector layer

.. versionadded:: 3.10
%End

%TypeHeaderCode
#include "qgsvectorlayerserverproperties.h"
%End
  public:
    static const QMetaObject staticMetaObject;

  public:

    enum PredefinedWmsDimensionName
    {
      TIME,
      DATE,
      ELEVATION
    };

    struct WmsDimensionInfo
    {

      enum DefaultDisplay
      {
        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 = QgsVectorLayerServerProperties::WmsDimensionInfo::AllValues,
                                 const QVariant &dimReferenceValue = QVariant() );
%Docstring
Constructor for WmsDimensionInfo.
%End
      QString name;
      QString fieldName;
      QString endFieldName;
      QString units;
      QString unitSymbol;
      int defaultDisplayType;
      QVariant referenceValue;
    };

    QgsVectorLayerServerProperties( QgsVectorLayer *layer = 0 );
%Docstring
Constructor - Creates a Vector Layer QGIS Server Properties

:param layer: The vector layer
%End

    static QMap<int, QString> wmsDimensionDefaultDisplayLabels();
%Docstring
Returns WMS Dimension default display labels

.. versionadded:: 3.10
%End

    bool addWmsDimension( const QgsVectorLayerServerProperties::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

    const QList<QgsVectorLayerServerProperties::WmsDimensionInfo> wmsDimensions() const;
%Docstring
Returns the QGIS Server WMS Dimension list.

.. versionadded:: 3.10
%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

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsvectorlayerserverproperties.h                            *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/