QGIS API Documentation 3.29.0-Master (da8bb1db43)
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
45{
46 public:
48 QgsProcessingParameterVectorTileWriterLayers( const QString &name, const QString &description = QString() );
49
51 QString type() const override;
52 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
53 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
55
57 static QString typeName() { return QStringLiteral( "vectortilewriterlayers" ); }
58
60 static QList<QgsVectorTileWriter::Layer> parameterAsLayers( const QVariant &layersVariant, QgsProcessingContext &context );
62 static QgsVectorTileWriter::Layer variantMapAsLayer( const QVariantMap &layerVariantMap, QgsProcessingContext &context );
64 static QVariantMap layerAsVariantMap( const QgsVectorTileWriter::Layer &layer );
65
66};
67
68#ifndef SIP_RUN
70
78class CORE_EXPORT QgsProcessingParameterTypeVectorTileWriterLayers : public QgsProcessingParameterType
79{
80 public:
81 QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
82 {
84 }
85
86 QString description() const override
87 {
88 return QCoreApplication::translate( "Processing", "An input allowing selection of multiple layers for export in vector tiles." );
89 }
90
91 QString name() const override
92 {
93 return QCoreApplication::translate( "Processing", "Vector Tile Writer Layers" );
94 }
95
96 QString id() const override
97 {
99 }
100
101 QString pythonImportString() const override
102 {
103 return QStringLiteral( "from qgis.core import QgsProcessingParameterVectorTileWriterLayers" );
104 }
105
106 QString className() const override
107 {
108 return QStringLiteral( "QgsProcessingParameterVectorTileWriterLayers" );
109 }
110
111 QStringList acceptedPythonTypes() const override
112 {
113 return QStringList() << QObject::tr( "list[dict]: list of input layers as dictionaries, see QgsProcessingParameterVectorTileWriterLayers docs" );
114 }
115};
116
118#endif
119
120#endif // QGSPROCESSINGPARAMETERVECTORTILEWRITERLAYERS_H
Contains information about the context in which a processing algorithm is executed.
Base class for the definition of processing parameters.
virtual QString asPythonString(QgsProcessing::PythonOutputType outputType=QgsProcessing::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.
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.
A parameter for processing algorithms that need a list of input vector layers for writing of vector t...
static QString typeName()
Returns the type name for the parameter class.
PythonOutputType
Available Python output types.
Definition: qgsprocessing.h:63
@ PythonQgsProcessingAlgorithmSubclass
Full Python QgsProcessingAlgorithm subclass.
Definition: qgsprocessing.h:64
Configuration of a single input vector layer to be included in the output.
#define SIP_FACTORY
Definition: qgis_sip.h:76