18#ifndef QGSPROCESSINGPARAMETERTYPEIMPL_H
19#define QGSPROCESSINGPARAMETERTYPEIMPL_H
24#include <QCoreApplication>
44 return QCoreApplication::translate(
"Processing",
"A raster layer parameter." );
47 QString
name()
const override
49 return QCoreApplication::translate(
"Processing",
"Raster Layer" );
54 return QStringLiteral(
"from qgis.core import QgsProcessingParameterRasterLayer" );
59 return QStringLiteral(
"QgsProcessingParameterRasterLayer" );
62 QString
id()
const override
64 return QStringLiteral(
"raster" );
69 return QStringList() << QObject::tr(
"str: layer ID" )
70 << QObject::tr(
"str: layer name" )
71 << QObject::tr(
"str: layer source" )
72 << QStringLiteral(
"QgsProperty" )
73 << QStringLiteral(
"QgsRasterLayer" );
78 return QStringList() << QObject::tr(
"Path to a raster layer" );
98 return QCoreApplication::translate(
"Processing",
"A mesh layer parameter." );
101 QString
name()
const override
103 return QCoreApplication::translate(
"Processing",
"Mesh Layer" );
108 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMeshLayer" );
113 return QStringLiteral(
"QgsProcessingParameterMeshLayer" );
116 QString
id()
const override
118 return QStringLiteral(
"mesh" );
123 return QStringList() << QObject::tr(
"str: layer ID" )
124 << QObject::tr(
"str: layer name" )
125 << QObject::tr(
"str: layer source" )
126 << QStringLiteral(
"QgsMeshLayer" );
131 return QStringList() << QObject::tr(
"Path to a mesh layer" );
151 return QCoreApplication::translate(
"Processing",
"A vector layer parameter, e.g. for algorithms which change layer styles, edit layers in place, or other operations which affect an entire layer." );
154 QString
name()
const override
156 return QCoreApplication::translate(
"Processing",
"Vector Layer" );
161 return QStringLiteral(
"from qgis.core import QgsProcessingParameterVectorLayer" );
166 return QStringLiteral(
"QgsProcessingParameterVectorLayer" );
169 QString
id()
const override
171 return QStringLiteral(
"vector" );
176 return QStringList() << QObject::tr(
"str: layer ID" )
177 << QObject::tr(
"str: layer name" )
178 << QObject::tr(
"str: layer source" )
179 << QStringLiteral(
"QgsProperty" )
180 << QStringLiteral(
"QgsVectorLayer" );
185 return QStringList() << QObject::tr(
"Path to a vector layer" );
205 return QCoreApplication::translate(
"Processing",
"A generic map layer parameter, which accepts either vector or raster layers." );
208 QString
name()
const override
210 return QCoreApplication::translate(
"Processing",
"Map Layer" );
213 QString
id()
const override
215 return QStringLiteral(
"layer" );
220 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMapLayer" );
225 return QStringLiteral(
"QgsProcessingParameterMapLayer" );
230 return QStringList() << QObject::tr(
"str: layer ID" )
231 << QObject::tr(
"str: layer name" )
232 << QObject::tr(
"str: layer source" )
233 << QStringLiteral(
"QgsMapLayer" )
234 << QStringLiteral(
"QgsProperty" )
235 << QStringLiteral(
"QgsRasterLayer" )
236 << QStringLiteral(
"QgsVectorLayer" );
241 return QStringList() << QObject::tr(
"Path to a vector, raster or mesh layer" );
261 return QCoreApplication::translate(
"Processing",
"A boolean parameter, for true/false values." );
264 QString
name()
const override
266 return QCoreApplication::translate(
"Processing",
"Boolean" );
269 QString
id()
const override
271 return QStringLiteral(
"boolean" );
276 return QStringLiteral(
"from qgis.core import QgsProcessingParameterBoolean" );
281 return QStringLiteral(
"QgsProcessingParameterBoolean" );
286 return QStringList() << QStringLiteral(
"bool" )
287 << QStringLiteral(
"int" )
288 << QStringLiteral(
"str" )
289 << QStringLiteral(
"QgsProperty" );
294 return QStringList() << QObject::tr(
"1 for true/yes" )
295 << QObject::tr(
"0 for false/no" )
296 << QObject::tr(
"field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field" )
297 << QObject::tr(
"expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression" );
317 return QCoreApplication::translate(
"Processing",
"An expression parameter, to add custom expressions based on layer fields." );
320 QString
name()
const override
322 return QCoreApplication::translate(
"Processing",
"Expression" );
325 QString
id()
const override
327 return QStringLiteral(
"expression" );
332 return QStringLiteral(
"from qgis.core import QgsProcessingParameterExpression" );
337 return QStringLiteral(
"QgsProcessingParameterExpression" );
342 return QStringList() << QStringLiteral(
"str" )
343 << QStringLiteral(
"QgsProperty" );
348 return QStringList() << QObject::tr(
"A valid QGIS expression string, e.g \"road_name\" = 'MAIN RD'" );
368 return QCoreApplication::translate(
"Processing",
"A coordinate reference system (CRS) input parameter." );
371 QString
name()
const override
373 return QCoreApplication::translate(
"Processing",
"CRS" );
376 QString
id()
const override
378 return QStringLiteral(
"crs" );
383 return QStringLiteral(
"from qgis.core import QgsProcessingParameterCrs" );
388 return QStringLiteral(
"QgsProcessingParameterCrs" );
394 << QStringLiteral(
"str: 'ProjectCrs'" )
395 << QObject::tr(
"str: CRS auth ID (e.g. 'EPSG:3111')" )
396 << QObject::tr(
"str: CRS PROJ4 (e.g. 'PROJ4:…')" )
397 << QObject::tr(
"str: CRS WKT (e.g. 'WKT:…')" )
398 << QObject::tr(
"str: layer ID. CRS of layer is used." )
399 << QObject::tr(
"str: layer name. CRS of layer is used." )
400 << QObject::tr(
"str: layer source. CRS of layer is used." )
401 << QObject::tr(
"QgsCoordinateReferenceSystem" )
402 << QObject::tr(
"QgsMapLayer: CRS of layer is used" )
403 << QObject::tr(
"QgsProcessingFeatureSourceDefinition: CRS of source is used" )
404 << QStringLiteral(
"QgsProperty" );
409 return QStringList() << QObject::tr(
"CRS as an auth ID (e.g. 'EPSG:3111')" )
410 << QObject::tr(
"CRS as a PROJ4 string (e.g. 'PROJ4:…')" )
411 << QObject::tr(
"CRS as a WKT string (e.g. 'WKT:…')" )
412 << QObject::tr(
"Path to a layer. The CRS of the layer is used." ) ;
432 return QCoreApplication::translate(
"Processing",
"A numeric range parameter for processing algorithms." );
435 QString
name()
const override
437 return QCoreApplication::translate(
"Processing",
"Range" );
440 QString
id()
const override
442 return QStringLiteral(
"range" );
447 return QStringLiteral(
"from qgis.core import QgsProcessingParameterRange" );
452 return QStringLiteral(
"QgsProcessingParameterRange" );
457 return QStringList() << QObject::tr(
"list[float]: list of 2 float values" )
458 << QObject::tr(
"list[str]: list of strings representing floats" )
459 << QObject::tr(
"str: as two comma delimited floats, e.g. '1,10'" )
460 << QStringLiteral(
"QgsProperty" );
465 return QStringList() << QObject::tr(
"Two comma separated numeric values, e.g. '1,10'" );
485 return QCoreApplication::translate(
"Processing",
"A point geometry parameter." );
488 QString
name()
const override
490 return QCoreApplication::translate(
"Processing",
"Point" );
493 QString
id()
const override
495 return QStringLiteral(
"point" );
500 return QStringLiteral(
"from qgis.core import QgsProcessingParameterPoint" );
505 return QStringLiteral(
"QgsProcessingParameterPoint" );
510 return QStringList() << QObject::tr(
"str: as an 'x,y' string, e.g. '1.5,10.1'" )
511 << QStringLiteral(
"QgsPointXY" )
512 << QStringLiteral(
"QgsProperty" )
513 << QStringLiteral(
"QgsReferencedPointXY" )
514 << QStringLiteral(
"QgsGeometry: centroid of geometry is used" );
519 return QStringList() << QObject::tr(
"Point coordinate as an 'x,y' string, e.g. '1.5,10.1'" );
539 return QCoreApplication::translate(
"Processing",
"A geometry parameter." );
542 QString
name()
const override
544 return QCoreApplication::translate(
"Processing",
"Geometry" );
547 QString
id()
const override
549 return QStringLiteral(
"geometry" );
554 return QStringLiteral(
"from qgis.core import QgsProcessingParameterGeometry" );
559 return QStringLiteral(
"QgsProcessingParameterGeometry" );
564 return QStringList() << QObject::tr(
"str: as Well-Known Text string (WKT)" )
565 << QStringLiteral(
"QgsGeometry" )
566 << QStringLiteral(
"QgsProperty" );
571 return QStringList() << QObject::tr(
"Well-Known Text string (WKT)" );
591 return QCoreApplication::translate(
"Processing",
"An enumerated type parameter." );
594 QString
name()
const override
596 return QCoreApplication::translate(
"Processing",
"Enum" );
599 QString
id()
const override
601 return QStringLiteral(
"enum" );
606 return QStringLiteral(
"from qgis.core import QgsProcessingParameterEnum" );
611 return QStringLiteral(
"QgsProcessingParameterEnum" );
616 return QStringList() << QStringLiteral(
"int" )
617 << QObject::tr(
"str: as string representation of int, e.g. '1'" )
618 << QStringLiteral(
"QgsProperty" );
623 return QStringList() << QObject::tr(
"Number of selected option, e.g. '1'" )
624 << QObject::tr(
"Comma separated list of options, e.g. '1,3'" );
644 return QCoreApplication::translate(
"Processing",
"A map extent parameter." );
647 QString
name()
const override
649 return QCoreApplication::translate(
"Processing",
"Extent" );
652 QString
id()
const override
654 return QStringLiteral(
"extent" );
659 return QStringLiteral(
"from qgis.core import QgsProcessingParameterExtent" );
664 return QStringLiteral(
"QgsProcessingParameterExtent" );
669 return QStringList() << QObject::tr(
"str: as comma delimited list of x min, x max, y min, y max. E.g. '4,10,101,105'" )
670 << QObject::tr(
"str: layer ID. Extent of layer is used." )
671 << QObject::tr(
"str: layer name. Extent of layer is used." )
672 << QObject::tr(
"str: layer source. Extent of layer is used." )
673 << QObject::tr(
"QgsMapLayer: Extent of layer is used" )
674 << QObject::tr(
"QgsProcessingFeatureSourceDefinition: Extent of source is used" )
675 << QStringLiteral(
"QgsProperty" )
676 << QStringLiteral(
"QgsRectangle" )
677 << QStringLiteral(
"QgsReferencedRectangle" )
678 << QStringLiteral(
"QgsGeometry: bounding box of geometry is used" );
683 return QStringList() << QObject::tr(
"A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'" )
684 << QObject::tr(
"Path to a layer. The extent of the layer is used." ) ;
704 return QCoreApplication::translate(
"Processing",
"A table (matrix) parameter for processing algorithms." );
707 QString
name()
const override
709 return QCoreApplication::translate(
"Processing",
"Matrix" );
712 QString
id()
const override
714 return QStringLiteral(
"matrix" );
719 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMatrix" );
724 return QStringLiteral(
"QgsProcessingParameterMatrix" );
729 return QStringList() << QObject::tr(
"str: as comma delimited list of values" )
730 << QStringLiteral(
"list" )
731 << QStringLiteral(
"QgsProperty" );
736 return QStringList() << QObject::tr(
"A comma delimited list of values" );
756 return QCoreApplication::translate(
"Processing",
"A file or folder parameter, for use with non-map layer file sources or folders." );
759 QString
name()
const override
761 return QCoreApplication::translate(
"Processing",
"File/Folder" );
764 QString
id()
const override
766 return QStringLiteral(
"file" );
771 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFile" );
776 return QStringLiteral(
"QgsProcessingParameterFile" );
781 return QStringList() << QStringLiteral(
"str" )
782 << QStringLiteral(
"QgsProperty" );
787 return QStringList() << QObject::tr(
"Path to a file" );
807 return QCoreApplication::translate(
"Processing",
"A vector field parameter, for selecting an existing field from a vector source." );
810 QString
name()
const override
812 return QCoreApplication::translate(
"Processing",
"Vector Field" );
815 QString
id()
const override
817 return QStringLiteral(
"field" );
822 return QStringLiteral(
"from qgis.core import QgsProcessingParameterField" );
827 return QStringLiteral(
"QgsProcessingParameterField" );
832 return QStringList() << QStringLiteral(
"str" )
833 << QStringLiteral(
"QgsProperty" );
838 return QStringList() << QObject::tr(
"The name of an existing field" )
839 << QObject::tr(
"; delimited list of existing field names" );
860 return QCoreApplication::translate(
"Processing",
"A vector layer destination parameter." );
863 QString
name()
const override
865 return QCoreApplication::translate(
"Processing",
"Vector Destination" );
868 QString
id()
const override
870 return QStringLiteral(
"vectorDestination" );
875 return QStringLiteral(
"from qgis.core import QgsProcessingParameterVectorDestination" );
880 return QStringLiteral(
"QgsProcessingParameterVectorDestination" );
892 return QStringList() << QStringLiteral(
"str" )
893 << QStringLiteral(
"QgsProperty" )
894 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" );
899 return QStringList() << QObject::tr(
"Path for new vector layer" );
920 return QCoreApplication::translate(
"Processing",
"A generic file based destination parameter." );
923 QString
name()
const override
925 return QCoreApplication::translate(
"Processing",
"File Destination" );
928 QString
id()
const override
930 return QStringLiteral(
"fileDestination" );
935 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFileDestination" );
940 return QStringLiteral(
"QgsProcessingParameterFileDestination" );
952 return QStringList() << QStringLiteral(
"str" )
953 << QStringLiteral(
"QgsProperty" );
958 return QStringList() << QObject::tr(
"Path for new file" );
980 return QCoreApplication::translate(
"Processing",
"A folder destination parameter." );
983 QString
name()
const override
985 return QCoreApplication::translate(
"Processing",
"Folder Destination" );
988 QString
id()
const override
990 return QStringLiteral(
"folderDestination" );
995 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFolderDestination" );
1000 return QStringLiteral(
"QgsProcessingParameterFolderDestination" );
1012 return QStringList() << QStringLiteral(
"str" )
1013 << QStringLiteral(
"QgsProperty" );
1018 return QStringList() << QObject::tr(
"Path for an existing or new folder" );
1039 return QCoreApplication::translate(
"Processing",
"A raster layer destination parameter." );
1042 QString
name()
const override
1044 return QCoreApplication::translate(
"Processing",
"Raster Destination" );
1047 QString
id()
const override
1049 return QStringLiteral(
"rasterDestination" );
1054 return QStringLiteral(
"from qgis.core import QgsProcessingParameterRasterDestination" );
1059 return QStringLiteral(
"QgsProcessingParameterRasterDestination" );
1071 return QStringList() << QStringLiteral(
"str" )
1072 << QStringLiteral(
"QgsProperty" )
1073 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" );
1078 return QStringList() << QObject::tr(
"Path for new raster layer" );
1098 return QCoreApplication::translate(
"Processing",
"A freeform string parameter." );
1101 QString
name()
const override
1103 return QCoreApplication::translate(
"Processing",
"String" );
1106 QString
id()
const override
1108 return QStringLiteral(
"string" );
1113 return QStringLiteral(
"from qgis.core import QgsProcessingParameterString" );
1118 return QStringLiteral(
"QgsProcessingParameterString" );
1123 return QStringList() << QStringLiteral(
"str" )
1124 << QStringLiteral(
"QgsProperty" );
1129 return QStringList() << QObject::tr(
"String value" )
1130 << QObject::tr(
"field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field" )
1131 << QObject::tr(
"expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression" );
1151 return QCoreApplication::translate(
"Processing",
"A authentication configuration parameter." );
1154 QString
name()
const override
1156 return QCoreApplication::translate(
"Processing",
"Authentication Configuration" );
1159 QString
id()
const override
1161 return QStringLiteral(
"authcfg" );
1166 return QStringLiteral(
"from qgis.core import QgsProcessingParameterAuthConfig" );
1171 return QStringLiteral(
"QgsProcessingParameterAuthConfig" );
1176 return QStringList() << QStringLiteral(
"str" );
1181 return QStringList() << QObject::tr(
"An existing QGIS authentication ID string" );
1201 return QCoreApplication::translate(
"Processing",
"An input allowing selection of multiple sources, including multiple map layers or file sources." );
1204 QString
name()
const override
1206 return QCoreApplication::translate(
"Processing",
"Multiple Input" );
1209 QString
id()
const override
1211 return QStringLiteral(
"multilayer" );
1216 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMultipleLayers" );
1221 return QStringLiteral(
"QgsProcessingParameterMultipleLayers" );
1226 return QStringList() << QObject::tr(
"list[str]: list of layer IDs" )
1227 << QObject::tr(
"list[str]: list of layer names" )
1228 << QObject::tr(
"list[str]: list of layer sources" )
1229 << QStringLiteral(
"list[QgsMapLayer]" )
1230 << QStringLiteral(
"QgsProperty" );
1250 return QCoreApplication::translate(
"Processing",
"A vector feature parameter, e.g. for algorithms which operate on the features within a layer." );
1253 QString
name()
const override
1255 return QCoreApplication::translate(
"Processing",
"Vector Features" );
1258 QString
id()
const override
1260 return QStringLiteral(
"source" );
1265 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFeatureSource" );
1270 return QStringLiteral(
"QgsProcessingParameterFeatureSource" );
1275 return QStringList() << QObject::tr(
"str: layer ID" )
1276 << QObject::tr(
"str: layer name" )
1277 << QObject::tr(
"str: layer source" )
1278 << QStringLiteral(
"QgsProcessingFeatureSourceDefinition" )
1279 << QStringLiteral(
"QgsProperty" )
1280 << QStringLiteral(
"QgsVectorLayer" );
1285 return QStringList() << QObject::tr(
"Path to a vector layer" );
1305 return QCoreApplication::translate(
"Processing",
"A numeric parameter, including float or integer values." );
1308 QString
name()
const override
1310 return QCoreApplication::translate(
"Processing",
"Number" );
1313 QString
id()
const override
1315 return QStringLiteral(
"number" );
1320 return QStringLiteral(
"from qgis.core import QgsProcessingParameterNumber" );
1325 return QStringLiteral(
"QgsProcessingParameterNumber" );
1330 return QStringList() << QStringLiteral(
"int" )
1331 << QStringLiteral(
"float" )
1332 << QStringLiteral(
"QgsProperty" );
1337 return QStringList() << QObject::tr(
"A numeric value" )
1338 << QObject::tr(
"field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field" )
1339 << QObject::tr(
"expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression" );
1359 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a distance measure." );
1362 QString
name()
const override
1364 return QCoreApplication::translate(
"Processing",
"Distance" );
1367 QString
id()
const override
1369 return QStringLiteral(
"distance" );
1374 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDistance" );
1379 return QStringLiteral(
"QgsProcessingParameterDistance" );
1384 return QStringList() << QStringLiteral(
"int" )
1385 << QStringLiteral(
"float" )
1386 << QStringLiteral(
"QgsProperty" );
1391 return QStringList() << QObject::tr(
"A numeric value" )
1392 << QObject::tr(
"field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field" )
1393 << QObject::tr(
"expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression" );
1414 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing an area measure." );
1417 QString
name()
const override
1419 return QCoreApplication::translate(
"Processing",
"Area" );
1422 QString
id()
const override
1424 return QStringLiteral(
"area" );
1429 return QStringLiteral(
"from qgis.core import QgsProcessingParameterArea" );
1434 return QStringLiteral(
"QgsProcessingParameterArea" );
1439 return QStringList() << QStringLiteral(
"int" )
1440 << QStringLiteral(
"float" )
1441 << QStringLiteral(
"QgsProperty" );
1446 return QStringList() << QObject::tr(
"A numeric value" )
1447 << QObject::tr(
"field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field" )
1448 << QObject::tr(
"expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression" );
1469 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a volume measure." );
1472 QString
name()
const override
1474 return QCoreApplication::translate(
"Processing",
"Volume" );
1477 QString
id()
const override
1479 return QStringLiteral(
"volume" );
1484 return QStringLiteral(
"from qgis.core import QgsProcessingParameterVolume" );
1489 return QStringLiteral(
"QgsProcessingParameterVolume" );
1494 return QStringList() << QStringLiteral(
"int" )
1495 << QStringLiteral(
"float" )
1496 << QStringLiteral(
"QgsProperty" );
1501 return QStringList() << QObject::tr(
"A numeric value" )
1502 << QObject::tr(
"field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field" )
1503 << QObject::tr(
"expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression" );
1525 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a duration measure." );
1528 QString
name()
const override
1530 return QCoreApplication::translate(
"Processing",
"Duration" );
1533 QString
id()
const override
1535 return QStringLiteral(
"duration" );
1540 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDuration" );
1545 return QStringLiteral(
"QgsProcessingParameterDuration" );
1550 return QStringList() << QStringLiteral(
"int" )
1551 << QStringLiteral(
"float" )
1552 << QStringLiteral(
"QgsProperty" );
1557 return QStringList() << QObject::tr(
"A numeric value (unit type set by algorithms)" )
1558 << QObject::tr(
"field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field" )
1559 << QObject::tr(
"expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression" );
1579 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a map scale." );
1582 QString
name()
const override
1584 return QCoreApplication::translate(
"Processing",
"Scale" );
1587 QString
id()
const override
1589 return QStringLiteral(
"scale" );
1594 return QStringLiteral(
"from qgis.core import QgsProcessingParameterScale" );
1599 return QStringLiteral(
"QgsProcessingParameterScale" );
1604 return QStringList() << QStringLiteral(
"int: scale denominator" )
1605 << QStringLiteral(
"float: scale denominator" )
1606 << QStringLiteral(
"QgsProperty" );
1611 return QStringList() << QObject::tr(
"A numeric value representing the scale denominator" );
1631 return QCoreApplication::translate(
"Processing",
"A raster band parameter, for selecting an existing band from a raster source." );
1634 QString
name()
const override
1636 return QCoreApplication::translate(
"Processing",
"Raster Band" );
1639 QString
id()
const override
1641 return QStringLiteral(
"band" );
1646 return QStringLiteral(
"from qgis.core import QgsProcessingParameterBand" );
1651 return QStringLiteral(
"QgsProcessingParameterBand" );
1656 return QStringList() << QStringLiteral(
"int" )
1657 << QStringLiteral(
"QgsProperty" );
1662 return QStringList() << QObject::tr(
"Integer value representing an existing raster band number" );
1689 return QCoreApplication::translate(
"Processing",
"A feature sink destination parameter." );
1692 QString
name()
const override
1694 return QCoreApplication::translate(
"Processing",
"Feature Sink" );
1697 QString
id()
const override
1699 return QStringLiteral(
"sink" );
1704 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFeatureSink" );
1709 return QStringLiteral(
"QgsProcessingParameterFeatureSink" );
1714 return QStringList() << QObject::tr(
"str: destination vector file, e.g. 'd:/test.shp'" )
1715 << QObject::tr(
"str: 'memory:' to store result in temporary memory layer" )
1716 << QObject::tr(
"str: using vector provider ID prefix and destination URI, e.g. 'postgres:…' to store result in PostGIS table" )
1717 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" )
1718 << QStringLiteral(
"QgsProperty" );
1723 return QStringList() << QObject::tr(
"Path for new vector layer" );
1743 return QCoreApplication::translate(
"Processing",
"A print layout parameter." );
1746 QString
name()
const override
1748 return QCoreApplication::translate(
"Processing",
"Print Layout" );
1751 QString
id()
const override
1753 return QStringLiteral(
"layout" );
1758 return QStringLiteral(
"from qgis.core import QgsProcessingParameterLayout" );
1763 return QStringLiteral(
"QgsProcessingParameterLayout" );
1768 return QStringList() << QObject::tr(
"str: name of print layout in current project" )
1769 << QStringLiteral(
"QgsProperty" );
1774 return QStringList() << QObject::tr(
"Name of print layout in current project" );
1794 return QCoreApplication::translate(
"Processing",
"A print layout item parameter." );
1797 QString
name()
const override
1799 return QCoreApplication::translate(
"Processing",
"Print Layout Item" );
1802 QString
id()
const override
1804 return QStringLiteral(
"layoutitem" );
1809 return QStringLiteral(
"from qgis.core import QgsProcessingParameterLayoutItem" );
1814 return QStringLiteral(
"QgsProcessingParameterLayoutItem" );
1819 return QStringList() << QObject::tr(
"str: UUID of print layout item" )
1820 << QObject::tr(
"str: id of print layout item" )
1821 << QStringLiteral(
"QgsProperty" );
1826 return QStringList() << QObject::tr(
"UUID or item id of layout item" );
1846 return QCoreApplication::translate(
"Processing",
"A color parameter." );
1849 QString
name()
const override
1851 return QCoreApplication::translate(
"Processing",
"Color" );
1854 QString
id()
const override
1856 return QStringLiteral(
"color" );
1861 return QStringLiteral(
"from qgis.core import QgsProcessingParameterColor" );
1866 return QStringLiteral(
"QgsProcessingParameterColor" );
1871 return QStringList() << QObject::tr(
"str: string representation of color, e.g #ff0000 or rgba(200,100,50,0.8)" )
1872 << QStringLiteral(
"QColor" )
1873 << QStringLiteral(
"QgsProperty" );
1878 return QStringList() << QObject::tr(
"String representation of color, e.g #ff0000 or rgba(200,100,50,0.8)" )
1879 << QObject::tr(
"field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field" )
1880 << QObject::tr(
"expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression" );
1900 return QCoreApplication::translate(
"Processing",
"A coordinate operation parameter." );
1903 QString
name()
const override
1905 return QCoreApplication::translate(
"Processing",
"Coordinate Operation" );
1908 QString
id()
const override
1910 return QStringLiteral(
"coordinateoperation" );
1915 return QStringLiteral(
"from qgis.core import QgsProcessingParameterCoordinateOperation" );
1920 return QStringLiteral(
"QgsProcessingParameterCoordinateOperation" );
1925 return QStringList() << QObject::tr(
"str: string representation of a Proj coordinate operation" );
1930 return QStringList() << QObject::tr(
"String representation of Proj coordinate operation" );
1950 return QCoreApplication::translate(
"Processing",
"A map theme parameter." );
1953 QString
name()
const override
1955 return QCoreApplication::translate(
"Processing",
"Map Theme" );
1958 QString
id()
const override
1960 return QStringLiteral(
"maptheme" );
1965 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMapTheme" );
1970 return QStringLiteral(
"QgsProcessingParameterMapTheme" );
1975 return QStringList() << QObject::tr(
"str: name of an existing map theme" )
1976 << QStringLiteral(
"QgsProperty" );
1981 return QStringList() << QObject::tr(
"Name of an existing map theme" );
2001 return QCoreApplication::translate(
"Processing",
"A datetime parameter, including datetime, date or time values." );
2004 QString
name()
const override
2006 return QCoreApplication::translate(
"Processing",
"Datetime" );
2009 QString
id()
const override
2011 return QStringLiteral(
"datetime" );
2016 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDateTime" );
2021 return QStringLiteral(
"QgsProcessingParameterDateTime" );
2026 return QStringList() << QStringLiteral(
"str" )
2027 << QStringLiteral(
"QDateTime" )
2028 << QStringLiteral(
"QDate" )
2029 << QStringLiteral(
"QTime" )
2030 << QStringLiteral(
"QgsProperty" );
2035 return QStringList() << QObject::tr(
"A datetime value in ISO format" )
2036 << QObject::tr(
"field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field" )
2037 << QObject::tr(
"expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression" );
2057 return QCoreApplication::translate(
"Processing",
"A connection name parameter, for registered database connections." );
2060 QString
name()
const override
2062 return QCoreApplication::translate(
"Processing",
"Connection Name" );
2065 QString
id()
const override
2067 return QStringLiteral(
"providerconnection" );
2072 return QStringLiteral(
"from qgis.core import QgsProcessingParameterProviderConnection" );
2077 return QStringLiteral(
"QgsProcessingParameterProviderConnection" );
2082 return QStringList() << QStringLiteral(
"str" )
2083 << QStringLiteral(
"QgsProperty" );
2088 return QStringList() << QObject::tr(
"Name of registered database connection" );
2108 return QCoreApplication::translate(
"Processing",
"A database schema parameter." );
2111 QString
name()
const override
2113 return QCoreApplication::translate(
"Processing",
"Database Schema" );
2116 QString
id()
const override
2118 return QStringLiteral(
"databaseschema" );
2123 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDatabaseSchema" );
2128 return QStringLiteral(
"QgsProcessingParameterDatabaseSchema" );
2133 return QStringList() << QStringLiteral(
"str" )
2134 << QStringLiteral(
"QgsProperty" );
2139 return QStringList() << QObject::tr(
"Name of existing database schema" );
2159 return QCoreApplication::translate(
"Processing",
"A database table parameter." );
2162 QString
name()
const override
2164 return QCoreApplication::translate(
"Processing",
"Database Table" );
2167 QString
id()
const override
2169 return QStringLiteral(
"databasetable" );
2174 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDatabaseTable" );
2179 return QStringLiteral(
"QgsProcessingParameterDatabaseTable" );
2184 return QStringList() << QStringLiteral(
"str" )
2185 << QStringLiteral(
"QgsProperty" );
2190 return QStringList() << QObject::tr(
"Name of existing database table" );
2210 return QCoreApplication::translate(
"Processing",
"A point cloud layer parameter." );
2213 QString
name()
const override
2215 return QCoreApplication::translate(
"Processing",
"Point Cloud Layer" );
2220 return QStringLiteral(
"from qgis.core import QgsProcessingParameterPointCloudLayer" );
2225 return QStringLiteral(
"QgsProcessingParameterPointCloudLayer" );
2228 QString
id()
const override
2230 return QStringLiteral(
"pointcloud" );
2235 return QStringList() << QObject::tr(
"str: layer ID" )
2236 << QObject::tr(
"str: layer name" )
2237 << QObject::tr(
"str: layer source" )
2238 << QStringLiteral(
"QgsPointCloudLayer" );
2243 return QStringList() << QObject::tr(
"Path to a point cloud layer" );
2263 return QCoreApplication::translate(
"Processing",
"An annotation layer parameter." );
2266 QString
name()
const override
2268 return QCoreApplication::translate(
"Processing",
"Annotation Layer" );
2273 return QStringLiteral(
"from qgis.core import QgsProcessingParameterAnnotationLayer" );
2278 return QStringLiteral(
"QgsProcessingParameterAnnotationLayer" );
2281 QString
id()
const override
2283 return QStringLiteral(
"annotation" );
2288 return QStringList() << QObject::tr(
"str: layer ID" )
2289 << QObject::tr(
"str: layer name" )
2290 << QObject::tr(
"\"main\": main annotation layer for a project" )
2291 << QStringLiteral(
"QgsAnnotationLayer" );
2296 return QStringList() << QObject::tr(
"Layer ID for an annotation layer, or \"main\" for the main annotation layer in a project." );
2317 return QCoreApplication::translate(
"Processing",
"A point cloud layer destination parameter." );
2320 QString
name()
const override
2322 return QCoreApplication::translate(
"Processing",
"Point Cloud Destination" );
2325 QString
id()
const override
2327 return QStringLiteral(
"pointCloudDestination" );
2332 return QStringLiteral(
"from qgis.core import QgsProcessingParameterPointCloudDestination" );
2337 return QStringLiteral(
"QgsProcessingParameterPointCloudDestination" );
2349 return QStringList() << QStringLiteral(
"str" )
2350 << QStringLiteral(
"QgsProperty" )
2351 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" );
2356 return QStringList() << QObject::tr(
"Path for new point cloud layer" );
2376 return QCoreApplication::translate(
"Processing",
"A point cloud attribute parameter, for selecting an attribute from a point cloud source." );
2379 QString
name()
const override
2381 return QCoreApplication::translate(
"Processing",
"Point Cloud Attribute" );
2384 QString
id()
const override
2386 return QStringLiteral(
"attribute" );
2391 return QStringLiteral(
"from qgis.core import QgsProcessingParameterPointCloudAttribute" );
2396 return QStringLiteral(
"QgsProcessingParameterPointCloudAttribute" );
2401 return QStringList() << QStringLiteral(
"str" )
2402 << QStringLiteral(
"QgsProperty" );
2407 return QStringList() << QObject::tr(
"The name of an attribute" )
2408 << QObject::tr(
"; delimited list of attribute names" );
2429 return QCoreApplication::translate(
"Processing",
"A vector tiles layer destination parameter." );
2432 QString
name()
const override
2434 return QCoreApplication::translate(
"Processing",
"Vector Tile Destination" );
2437 QString
id()
const override
2439 return QStringLiteral(
"vectorTileDestination" );
2444 return QStringLiteral(
"from qgis.core import QgsProcessingParameterVectorTileDestination" );
2449 return QStringLiteral(
"QgsProcessingParameterVectorTileDestination" );
2461 return QStringList() << QStringLiteral(
"str" )
2462 << QStringLiteral(
"QgsProperty" )
2463 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" );
2468 return QStringList() << QObject::tr(
"Path for new vector tile layer" );
@ ExposeToModeler
Is this parameter available in the modeler. Is set to on by default.
QFlags< ProcessingParameterTypeFlag > ProcessingParameterTypeFlags
Flags which dictate the behavior of Processing parameter types.
An annotation layer parameter for processing algorithms.
A double numeric parameter for area values.
A string parameter for authentication configuration ID values.
A raster band parameter for Processing algorithms.
A boolean parameter for processing algorithms.
A color parameter for processing algorithms.
A coordinate operation parameter for processing algorithms, for selection between available coordinat...
A coordinate reference system parameter for processing algorithms.
A database schema parameter for processing algorithms, allowing users to select from existing schemas...
A database table name parameter for processing algorithms, allowing users to select from existing dat...
A datetime (or pure date or time) parameter for processing algorithms.
Base class for the definition of processing parameters.
A double numeric parameter for distance values.
A double numeric parameter for duration values.
An enum based parameter for processing algorithms, allowing for selection from predefined values.
An expression parameter for processing algorithms.
A rectangular map extent parameter for processing algorithms.
A feature sink output for processing algorithms.
An input feature source (such as vector layers) parameter for processing algorithms.
A vector layer or feature source field parameter for processing algorithms.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
An input file or folder parameter for processing algorithms.
A folder destination parameter, for specifying the destination path for a folder created by the algor...
A geometry parameter for processing algorithms.
A print layout item parameter, allowing users to select a particular item from a print layout.
A print layout parameter, allowing users to select a print layout.
A map layer parameter for processing algorithms.
A map theme parameter for processing algorithms, allowing users to select an existing map theme from ...
A table (matrix) parameter for processing algorithms.
A mesh layer parameter for processing algorithms.
A parameter for processing algorithms which accepts multiple map layers.
A numeric parameter for processing algorithms.
A point cloud layer attribute parameter for Processing algorithms.
A point cloud layer destination parameter, for specifying the destination path for a point cloud laye...
A point cloud layer parameter for processing algorithms.
A point parameter for processing algorithms.
A data provider connection parameter for processing algorithms, allowing users to select from availab...
A numeric range parameter for processing algorithms.
A raster layer destination parameter, for specifying the destination path for a raster layer created ...
A raster layer parameter for processing algorithms.
A double numeric parameter for map scale values.
A string parameter for processing algorithms.
An annotation layer parameter for processing algorithms.
An area parameter for processing algorithms.
A authentication configuration parameter for processing algorithms.
A raster band parameter for Processing algorithms.
A boolean parameter for processing algorithms.
A color parameter for Processing algorithms.
A coordinate operation parameter for Processing algorithms.
A crs parameter for processing algorithms.
A database schema name parameter for processing algorithms.
A database table name parameter for processing algorithms.
A datetime parameter for processing algorithms.
A distance parameter for processing algorithms.
A duration parameter for processing algorithms.
An enum based parameter for processing algorithms, allowing for selection from predefined values.
An expression parameter for processing algorithms.
A rectangular map extent parameter for processing algorithms.
A feature sink parameter for Processing algorithms.
An input feature source (such as vector layers) parameter for processing algorithms.
A vector layer or feature source field parameter for processing algorithms.
A generic file based destination parameter, for specifying the destination path for a file (non-map l...
An input file or folder parameter for processing algorithms.
A folder destination parameter, for specifying the destination path for a folder created by the algor...
A geometry parameter for processing algorithms.
A print layout item parameter for Processing algorithms.
A print layout parameter for Processing algorithms.
A generic map layer parameter for processing algorithms.
A map theme parameter for Processing algorithms.
A table (matrix) parameter for processing algorithms.
A mesh layer parameter for processing algorithms.
A parameter for processing algorithms which accepts multiple map layers.
A numeric parameter for processing algorithms.
A point cloud layer attribute parameter for Processing algorithms.
A pointcloud layer destination parameter, for specifying the destination path for a point cloud layer...
A point cloud layer parameter for processing algorithms.
A point parameter for processing algorithms.
A provider connection name parameter for processing algorithms.
A numeric range parameter for processing algorithms.
A raster layer destination parameter, for specifying the destination path for a raster layer created ...
A raster layer parameter for processing algorithms.
A scale parameter for processing algorithms.
A string parameter for processing algorithms.
A vector layer destination parameter, for specifying the destination path for a vector layer created ...
A vector layer parameter for processing algorithms.
A vector tile layer destination parameter, for specifying the destination path for a vector tile laye...
A volume parameter for processing algorithms.
Makes metadata of processing parameters available.
virtual QString name() const =0
A human readable and translatable short name for this parameter type.
virtual QStringList acceptedPythonTypes() const
Returns a list of the Python data types accepted as values for the parameter.
virtual QgsProcessingParameterDefinition * create(const QString &name) const =0
Creates a new parameter of this type.
virtual QString description() const =0
A human readable and translatable description for this parameter type.
virtual QString id() const =0
A static id for this type which will be used for storing this parameter type.
virtual QString className() const
Returns the corresponding class name for the parameter type.
virtual Qgis::ProcessingParameterTypeFlags flags() const
Determines if this parameter is available in the modeler.
virtual QStringList acceptedStringValues() const
Returns a descriptive list of the possible string values acceptable for the parameter.
virtual QString pythonImportString() const
Returns a valid Python import string for importing the corresponding parameter type,...
A vector layer destination parameter, for specifying the destination path for a vector layer created ...
A vector layer (with or without geometry) parameter for processing algorithms.
A vector tile layer destination parameter, for specifying the destination path for a vector tile laye...
A double numeric parameter for volume values.