QGIS API Documentation 3.43.0-Master (b60ef06885e)
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
49{
50 public:
52 QgsProcessingParameterVectorTileWriterLayers( const QString &name, const QString &description = QString() );
53
55 QString type() const override;
56 bool checkValueIsAcceptable( const QVariant &input, QgsProcessingContext *context = nullptr ) const override;
57 QString valueAsPythonString( const QVariant &value, QgsProcessingContext &context ) const override;
59
61 static QString typeName() { return QStringLiteral( "vectortilewriterlayers" ); }
62
64 static QList<QgsVectorTileWriter::Layer> parameterAsLayers( const QVariant &layersVariant, QgsProcessingContext &context );
66 static QgsVectorTileWriter::Layer variantMapAsLayer( const QVariantMap &layerVariantMap, QgsProcessingContext &context );
68 static QVariantMap layerAsVariantMap( const QgsVectorTileWriter::Layer &layer );
69
70};
71
72#ifndef SIP_RUN
74
82class CORE_EXPORT QgsProcessingParameterTypeVectorTileWriterLayers : public QgsProcessingParameterType
83{
84 public:
85 QgsProcessingParameterDefinition *create( const QString &name ) const override SIP_FACTORY
86 {
88 }
89
90 QString description() const override
91 {
92 return QCoreApplication::translate( "Processing", "An input allowing selection of multiple layers for export in vector tiles." );
93 }
94
95 QString name() const override
96 {
97 return QCoreApplication::translate( "Processing", "Vector Tile Writer Layers" );
98 }
99
100 QString id() const override
101 {
103 }
104
105 QString pythonImportString() const override
106 {
107 return QStringLiteral( "from qgis.core import QgsProcessingParameterVectorTileWriterLayers" );
108 }
109
110 QString className() const override
111 {
112 return QStringLiteral( "QgsProcessingParameterVectorTileWriterLayers" );
113 }
114
115 QStringList acceptedPythonTypes() const override
116 {
117 return QStringList() << QObject::tr( "list[dict]: list of input layers as dictionaries, see QgsProcessingParameterVectorTileWriterLayers docs" );
118 }
119};
120
122#endif
123
124#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::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.
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.
@ 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:76