QGIS API Documentation 4.1.0-Master (60fea48833c)
Loading...
Searching...
No Matches
qgsprocessingparametervectortilewriterlayers.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsprocessingparametervectortilewriterlayers.h
3 ---------------------
4 Date : April 2020
5 Copyright : (C) 2020 by Martin Dobias
6 Email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSPROCESSINGPARAMETERVECTORTILEWRITERLAYERS_H
17#define QGSPROCESSINGPARAMETERVECTORTILEWRITERLAYERS_H
18
21#include "qgsvectortilewriter.h"
22
23#include <QString>
24
25using namespace Qt::StringLiterals;
26
52{
53 public:
55 QgsProcessingParameterVectorTileWriterLayers( const QString &name, const QString &description = QString() );
56
58 QString type() const override;
59 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
60 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
62
64 static QString typeName() { return u"vectortilewriterlayers"_s; }
65
67 static QList<QgsVectorTileWriter::Layer> parameterAsLayers( const QVariant &layersVariant, QgsProcessingContext &context );
69 static QgsVectorTileWriter::Layer variantMapAsLayer( const QVariantMap &layerVariantMap, QgsProcessingContext &context );
71 static QVariantMap layerAsVariantMap( const QgsVectorTileWriter::Layer &layer );
72};
73
74#ifndef SIP_RUN
76
84class CORE_EXPORT QgsProcessingParameterTypeVectorTileWriterLayers : public QgsProcessingParameterType
85{
86 public:
87 QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY { return new QgsProcessingParameterVectorTileWriterLayers( name ); }
88
89 QString description() const override { return QCoreApplication::translate( "Processing", "An input allowing selection of multiple layers for export in vector tiles." ); }
90
91 QString name() const override { return QCoreApplication::translate( "Processing", "Vector Tile Writer Layers" ); }
92
93 QString id() const override { return QgsProcessingParameterVectorTileWriterLayers::typeName(); }
94
95 QString pythonImportString() const override { return u"from qgis.core import QgsProcessingParameterVectorTileWriterLayers"_s; }
96
97 QString className() const override { return u"QgsProcessingParameterVectorTileWriterLayers"_s; }
98
99 QStringList acceptedPythonTypes() const override
100 {
101 return QStringList() << QObject::tr( "list[dict]: list of input layers as dictionaries, see QgsProcessingParameterVectorTileWriterLayers docs" );
102 }
103
104 QStringList acceptedParameterTypes() const override { return QStringList(); }
105
106 QStringList acceptedOutputTypes() const override { return QStringList(); }
107};
108
110#endif
111
112#endif // QGSPROCESSINGPARAMETERVECTORTILEWRITERLAYERS_H
Contains information about the context in which a processing algorithm is executed.
virtual QString asPythonString(QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonOutputType::PythonQgsProcessingAlgorithmSubclass) const
Returns the parameter definition as a Python command which can be used within a Python Processing scr...
QString description() const
Returns the description for the parameter.
QgsProcessingParameterDefinition(const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &help=QString())
Constructor for QgsProcessingParameterDefinition.
virtual QgsProcessingParameterDefinition * clone() const =0
Creates a clone of the parameter definition.
virtual QString type() const =0
Unique parameter type name.
QString name() const
Returns the name of the parameter.
virtual QString valueAsPythonString(const QVariant &value, QgsProcessingContext &context) const
Returns a string version of the parameter input value, which is suitable for use as an input paramete...
virtual bool checkValueIsAcceptable(const QVariant &input, QgsProcessingContext *context=nullptr) const
Checks whether the specified input value is acceptable for the parameter.
Makes metadata of processing parameters available.
QgsProcessingParameterVectorTileWriterLayers(const QString &name, const QString &description=QString())
Constructor for QgsProcessingParameterVectorTileWriterLayers.
static QString typeName()
Returns the type name for the parameter class.
PythonOutputType
Available Python output types.
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
Configuration of a single input vector layer to be included in the output.
#define SIP_FACTORY
Definition qgis_sip.h:83