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" );
315 return QCoreApplication::translate(
"Processing",
"An expression parameter, to add custom expressions based on layer fields." );
318 QString
name()
const override
320 return QCoreApplication::translate(
"Processing",
"Expression" );
323 QString
id()
const override
325 return QStringLiteral(
"expression" );
330 return QStringLiteral(
"from qgis.core import QgsProcessingParameterExpression" );
335 return QStringLiteral(
"QgsProcessingParameterExpression" );
340 return QStringList() << QStringLiteral(
"str" )
341 << QStringLiteral(
"QgsProperty" );
346 return QStringList() << QObject::tr(
"A valid QGIS expression string, e.g \"road_name\" = 'MAIN RD'" );
366 return QCoreApplication::translate(
"Processing",
"A coordinate reference system (CRS) input parameter." );
369 QString
name()
const override
371 return QCoreApplication::translate(
"Processing",
"CRS" );
374 QString
id()
const override
376 return QStringLiteral(
"crs" );
381 return QStringLiteral(
"from qgis.core import QgsProcessingParameterCrs" );
386 return QStringLiteral(
"QgsProcessingParameterCrs" );
392 << QStringLiteral(
"str: 'ProjectCrs'" )
393 << QObject::tr(
"str: CRS auth ID (e.g. 'EPSG:3111')" )
394 << QObject::tr(
"str: CRS PROJ4 (e.g. 'PROJ4:…')" )
395 << QObject::tr(
"str: CRS WKT (e.g. 'WKT:…')" )
396 << QObject::tr(
"str: layer ID. CRS of layer is used." )
397 << QObject::tr(
"str: layer name. CRS of layer is used." )
398 << QObject::tr(
"str: layer source. CRS of layer is used." )
399 << QObject::tr(
"QgsCoordinateReferenceSystem" )
400 << QObject::tr(
"QgsMapLayer: CRS of layer is used" )
401 << QObject::tr(
"QgsProcessingFeatureSourceDefinition: CRS of source is used" )
402 << QStringLiteral(
"QgsProperty" );
407 return QStringList() << QObject::tr(
"CRS as an auth ID (e.g. 'EPSG:3111')" )
408 << QObject::tr(
"CRS as a PROJ4 string (e.g. 'PROJ4:…')" )
409 << QObject::tr(
"CRS as a WKT string (e.g. 'WKT:…')" )
410 << QObject::tr(
"Path to a layer. The CRS of the layer is used." ) ;
430 return QCoreApplication::translate(
"Processing",
"A numeric range parameter for processing algorithms." );
433 QString
name()
const override
435 return QCoreApplication::translate(
"Processing",
"Range" );
438 QString
id()
const override
440 return QStringLiteral(
"range" );
445 return QStringLiteral(
"from qgis.core import QgsProcessingParameterRange" );
450 return QStringLiteral(
"QgsProcessingParameterRange" );
455 return QStringList() << QObject::tr(
"list[float]: list of 2 float values" )
456 << QObject::tr(
"list[str]: list of strings representing floats" )
457 << QObject::tr(
"str: as two comma delimited floats, e.g. '1,10'" )
458 << QStringLiteral(
"QgsProperty" );
463 return QStringList() << QObject::tr(
"Two comma separated numeric values, e.g. '1,10'" );
483 return QCoreApplication::translate(
"Processing",
"A geographic point parameter." );
486 QString
name()
const override
488 return QCoreApplication::translate(
"Processing",
"Point" );
491 QString
id()
const override
493 return QStringLiteral(
"point" );
498 return QStringLiteral(
"from qgis.core import QgsProcessingParameterPoint" );
503 return QStringLiteral(
"QgsProcessingParameterPoint" );
508 return QStringList() << QObject::tr(
"str: as an 'x,y' string, e.g. '1.5,10.1'" )
509 << QStringLiteral(
"QgsPointXY" )
510 << QStringLiteral(
"QgsProperty" )
511 << QStringLiteral(
"QgsReferencedPointXY" )
512 << QStringLiteral(
"QgsGeometry: centroid of geometry is used" );
517 return QStringList() << QObject::tr(
"Point coordinate as an 'x,y' string, e.g. '1.5,10.1'" );
537 return QCoreApplication::translate(
"Processing",
"A geometry parameter." );
540 QString
name()
const override
542 return QCoreApplication::translate(
"Processing",
"Geometry" );
545 QString
id()
const override
547 return QStringLiteral(
"geometry" );
552 return QStringLiteral(
"from qgis.core import QgsProcessingParameterGeometry" );
557 return QStringLiteral(
"QgsProcessingParameterGeometry" );
562 return QStringList() << QObject::tr(
"str: as Well-Known Text string (WKT)" )
563 << QStringLiteral(
"QgsGeometry" )
564 << QStringLiteral(
"QgsProperty" );
569 return QStringList() << QObject::tr(
"Well-Known Text string (WKT)" );
589 return QCoreApplication::translate(
"Processing",
"An enumerated type parameter." );
592 QString
name()
const override
594 return QCoreApplication::translate(
"Processing",
"Enum" );
597 QString
id()
const override
599 return QStringLiteral(
"enum" );
604 return QStringLiteral(
"from qgis.core import QgsProcessingParameterEnum" );
609 return QStringLiteral(
"QgsProcessingParameterEnum" );
614 return QStringList() << QStringLiteral(
"int" )
615 << QObject::tr(
"str: as string representation of int, e.g. '1'" )
616 << QStringLiteral(
"QgsProperty" );
621 return QStringList() << QObject::tr(
"Number of selected option, e.g. '1'" )
622 << QObject::tr(
"Comma separated list of options, e.g. '1,3'" );
642 return QCoreApplication::translate(
"Processing",
"A map extent parameter." );
645 QString
name()
const override
647 return QCoreApplication::translate(
"Processing",
"Extent" );
650 QString
id()
const override
652 return QStringLiteral(
"extent" );
657 return QStringLiteral(
"from qgis.core import QgsProcessingParameterExtent" );
662 return QStringLiteral(
"QgsProcessingParameterExtent" );
667 return QStringList() << QObject::tr(
"str: as comma delimited list of x min, x max, y min, y max. E.g. '4,10,101,105'" )
668 << QObject::tr(
"str: layer ID. Extent of layer is used." )
669 << QObject::tr(
"str: layer name. Extent of layer is used." )
670 << QObject::tr(
"str: layer source. Extent of layer is used." )
671 << QObject::tr(
"QgsMapLayer: Extent of layer is used" )
672 << QObject::tr(
"QgsProcessingFeatureSourceDefinition: Extent of source is used" )
673 << QStringLiteral(
"QgsProperty" )
674 << QStringLiteral(
"QgsRectangle" )
675 << QStringLiteral(
"QgsReferencedRectangle" )
676 << QStringLiteral(
"QgsGeometry: bounding box of geometry is used" );
681 return QStringList() << QObject::tr(
"A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'" )
682 << QObject::tr(
"Path to a layer. The extent of the layer is used." ) ;
702 return QCoreApplication::translate(
"Processing",
"A table (matrix) parameter for processing algorithms." );
705 QString
name()
const override
707 return QCoreApplication::translate(
"Processing",
"Matrix" );
710 QString
id()
const override
712 return QStringLiteral(
"matrix" );
717 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMatrix" );
722 return QStringLiteral(
"QgsProcessingParameterMatrix" );
727 return QStringList() << QObject::tr(
"str: as comma delimited list of values" )
728 << QStringLiteral(
"list" )
729 << QStringLiteral(
"QgsProperty" );
734 return QStringList() << QObject::tr(
"A comma delimited list of values" );
754 return QCoreApplication::translate(
"Processing",
"A file or folder parameter, for use with non-map layer file sources or folders." );
757 QString
name()
const override
759 return QCoreApplication::translate(
"Processing",
"File/Folder" );
762 QString
id()
const override
764 return QStringLiteral(
"file" );
769 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFile" );
774 return QStringLiteral(
"QgsProcessingParameterFile" );
779 return QStringList() << QStringLiteral(
"str" )
780 << QStringLiteral(
"QgsProperty" );
785 return QStringList() << QObject::tr(
"Path to a file" );
805 return QCoreApplication::translate(
"Processing",
"A vector field parameter, for selecting an existing field from a vector source." );
808 QString
name()
const override
810 return QCoreApplication::translate(
"Processing",
"Vector Field" );
813 QString
id()
const override
815 return QStringLiteral(
"field" );
820 return QStringLiteral(
"from qgis.core import QgsProcessingParameterField" );
825 return QStringLiteral(
"QgsProcessingParameterField" );
830 return QStringList() << QStringLiteral(
"str" )
831 << QStringLiteral(
"QgsProperty" );
836 return QStringList() << QObject::tr(
"The name of an existing field" )
837 << QObject::tr(
"; delimited list of existing field names" );
858 return QCoreApplication::translate(
"Processing",
"A vector layer destination parameter." );
861 QString
name()
const override
863 return QCoreApplication::translate(
"Processing",
"Vector Destination" );
866 QString
id()
const override
868 return QStringLiteral(
"vectorDestination" );
873 return QStringLiteral(
"from qgis.core import QgsProcessingParameterVectorDestination" );
878 return QStringLiteral(
"QgsProcessingParameterVectorDestination" );
881 ParameterFlags
flags()
const override
884 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
890 return QStringList() << QStringLiteral(
"str" )
891 << QStringLiteral(
"QgsProperty" )
892 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" );
897 return QStringList() << QObject::tr(
"Path for new vector layer" );
919 return QCoreApplication::translate(
"Processing",
"A generic file based destination parameter." );
922 QString
name()
const override
924 return QCoreApplication::translate(
"Processing",
"File Destination" );
927 QString
id()
const override
929 return QStringLiteral(
"fileDestination" );
934 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFileDestination" );
939 return QStringLiteral(
"QgsProcessingParameterFileDestination" );
942 ParameterFlags
flags()
const override
945 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
951 return QStringList() << QStringLiteral(
"str" )
952 << QStringLiteral(
"QgsProperty" );
957 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" );
1003 ParameterFlags
flags()
const override
1006 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
1012 return QStringList() << QStringLiteral(
"str" )
1013 << QStringLiteral(
"QgsProperty" );
1018 return QStringList() << QObject::tr(
"Path for an existing or new folder" );
1040 return QCoreApplication::translate(
"Processing",
"A raster layer destination parameter." );
1043 QString
name()
const override
1045 return QCoreApplication::translate(
"Processing",
"Raster Destination" );
1048 QString
id()
const override
1050 return QStringLiteral(
"rasterDestination" );
1055 return QStringLiteral(
"from qgis.core import QgsProcessingParameterRasterDestination" );
1060 return QStringLiteral(
"QgsProcessingParameterRasterDestination" );
1063 ParameterFlags
flags()
const override
1066 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
1072 return QStringList() << QStringLiteral(
"str" )
1073 << QStringLiteral(
"QgsProperty" )
1074 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" );
1079 return QStringList() << QObject::tr(
"Path for new raster layer" );
1100 return QCoreApplication::translate(
"Processing",
"A freeform string parameter." );
1103 QString
name()
const override
1105 return QCoreApplication::translate(
"Processing",
"String" );
1108 QString
id()
const override
1110 return QStringLiteral(
"string" );
1115 return QStringLiteral(
"from qgis.core import QgsProcessingParameterString" );
1120 return QStringLiteral(
"QgsProcessingParameterString" );
1125 return QStringList() << QStringLiteral(
"str" )
1126 << QStringLiteral(
"QgsProperty" );
1131 return QStringList() << QObject::tr(
"String value" );
1152 return QCoreApplication::translate(
"Processing",
"A authentication configuration parameter." );
1155 QString
name()
const override
1157 return QCoreApplication::translate(
"Processing",
"Authentication Configuration" );
1160 QString
id()
const override
1162 return QStringLiteral(
"authcfg" );
1167 return QStringLiteral(
"from qgis.core import QgsProcessingParameterAuthConfig" );
1172 return QStringLiteral(
"QgsProcessingParameterAuthConfig" );
1177 return QStringList() << QStringLiteral(
"str" );
1182 return QStringList() << QObject::tr(
"An existing QGIS authentication ID string" );
1203 return QCoreApplication::translate(
"Processing",
"An input allowing selection of multiple sources, including multiple map layers or file sources." );
1206 QString
name()
const override
1208 return QCoreApplication::translate(
"Processing",
"Multiple Input" );
1211 QString
id()
const override
1213 return QStringLiteral(
"multilayer" );
1218 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMultipleLayers" );
1223 return QStringLiteral(
"QgsProcessingParameterMultipleLayers" );
1228 return QStringList() << QObject::tr(
"list[str]: list of layer IDs" )
1229 << QObject::tr(
"list[str]: list of layer names" )
1230 << QObject::tr(
"list[str]: list of layer sources" )
1231 << QStringLiteral(
"list[QgsMapLayer]" )
1232 << QStringLiteral(
"QgsProperty" );
1252 return QCoreApplication::translate(
"Processing",
"A vector feature parameter, e.g. for algorithms which operate on the features within a layer." );
1255 QString
name()
const override
1257 return QCoreApplication::translate(
"Processing",
"Vector Features" );
1260 QString
id()
const override
1262 return QStringLiteral(
"source" );
1267 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFeatureSource" );
1272 return QStringLiteral(
"QgsProcessingParameterFeatureSource" );
1277 return QStringList() << QObject::tr(
"str: layer ID" )
1278 << QObject::tr(
"str: layer name" )
1279 << QObject::tr(
"str: layer source" )
1280 << QStringLiteral(
"QgsProcessingFeatureSourceDefinition" )
1281 << QStringLiteral(
"QgsProperty" )
1282 << QStringLiteral(
"QgsVectorLayer" );
1287 return QStringList() << QObject::tr(
"Path to a vector layer" );
1308 return QCoreApplication::translate(
"Processing",
"A numeric parameter, including float or integer values." );
1311 QString
name()
const override
1313 return QCoreApplication::translate(
"Processing",
"Number" );
1316 QString
id()
const override
1318 return QStringLiteral(
"number" );
1323 return QStringLiteral(
"from qgis.core import QgsProcessingParameterNumber" );
1328 return QStringLiteral(
"QgsProcessingParameterNumber" );
1333 return QStringList() << QStringLiteral(
"int" )
1334 << QStringLiteral(
"float" )
1335 << QStringLiteral(
"QgsProperty" );
1340 return QStringList() << QObject::tr(
"A numeric value" );
1361 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a distance measure." );
1364 QString
name()
const override
1366 return QCoreApplication::translate(
"Processing",
"Distance" );
1369 QString
id()
const override
1371 return QStringLiteral(
"distance" );
1376 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDistance" );
1381 return QStringLiteral(
"QgsProcessingParameterDistance" );
1386 return QStringList() << QStringLiteral(
"int" )
1387 << QStringLiteral(
"float" )
1388 << QStringLiteral(
"QgsProperty" );
1393 return QStringList() << QObject::tr(
"A numeric value" );
1416 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a duration measure." );
1419 QString
name()
const override
1421 return QCoreApplication::translate(
"Processing",
"Duration" );
1424 QString
id()
const override
1426 return QStringLiteral(
"duration" );
1431 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDuration" );
1436 return QStringLiteral(
"QgsProcessingParameterDuration" );
1441 return QStringList() << QStringLiteral(
"int" )
1442 << QStringLiteral(
"float" )
1443 << QStringLiteral(
"QgsProperty" );
1448 return QStringList() << QObject::tr(
"A numeric value (unit type set by algorithms)" );
1469 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a map scale." );
1472 QString
name()
const override
1474 return QCoreApplication::translate(
"Processing",
"Scale" );
1477 QString
id()
const override
1479 return QStringLiteral(
"scale" );
1484 return QStringLiteral(
"from qgis.core import QgsProcessingParameterScale" );
1489 return QStringLiteral(
"QgsProcessingParameterScale" );
1494 return QStringList() << QStringLiteral(
"int: scale denominator" )
1495 << QStringLiteral(
"float: scale denominator" )
1496 << QStringLiteral(
"QgsProperty" );
1501 return QStringList() << QObject::tr(
"A numeric value representing the scale denominator" );
1523 return QCoreApplication::translate(
"Processing",
"A raster band parameter, for selecting an existing band from a raster source." );
1526 QString
name()
const override
1528 return QCoreApplication::translate(
"Processing",
"Raster Band" );
1531 QString
id()
const override
1533 return QStringLiteral(
"band" );
1538 return QStringLiteral(
"from qgis.core import QgsProcessingParameterBand" );
1543 return QStringLiteral(
"QgsProcessingParameterBand" );
1548 return QStringList() << QStringLiteral(
"int" )
1549 << QStringLiteral(
"QgsProperty" );
1554 return QStringList() << QObject::tr(
"Integer value representing an existing raster band number" );
1574 ParameterFlags
flags()
const override
1577 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
1583 return QCoreApplication::translate(
"Processing",
"A feature sink destination parameter." );
1586 QString
name()
const override
1588 return QCoreApplication::translate(
"Processing",
"Feature Sink" );
1591 QString
id()
const override
1593 return QStringLiteral(
"sink" );
1598 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFeatureSink" );
1603 return QStringLiteral(
"QgsProcessingParameterFeatureSink" );
1608 return QStringList() << QObject::tr(
"str: destination vector file, e.g. 'd:/test.shp'" )
1609 << QObject::tr(
"str: 'memory:' to store result in temporary memory layer" )
1610 << QObject::tr(
"str: using vector provider ID prefix and destination URI, e.g. 'postgres:…' to store result in PostGIS table" )
1611 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" )
1612 << QStringLiteral(
"QgsProperty" );
1617 return QStringList() << QObject::tr(
"Path for new vector layer" );
1640 return QCoreApplication::translate(
"Processing",
"A print layout parameter." );
1643 QString
name()
const override
1645 return QCoreApplication::translate(
"Processing",
"Print Layout" );
1648 QString
id()
const override
1650 return QStringLiteral(
"layout" );
1655 return QStringLiteral(
"from qgis.core import QgsProcessingParameterLayout" );
1660 return QStringLiteral(
"QgsProcessingParameterLayout" );
1665 return QStringList() << QObject::tr(
"str: name of print layout in current project" )
1666 << QStringLiteral(
"QgsProperty" );
1671 return QStringList() << QObject::tr(
"Name of print layout in current project" );
1695 return QCoreApplication::translate(
"Processing",
"A print layout item parameter." );
1698 QString
name()
const override
1700 return QCoreApplication::translate(
"Processing",
"Print Layout Item" );
1703 QString
id()
const override
1705 return QStringLiteral(
"layoutitem" );
1710 return QStringLiteral(
"from qgis.core import QgsProcessingParameterLayoutItem" );
1715 return QStringLiteral(
"QgsProcessingParameterLayoutItem" );
1720 return QStringList() << QObject::tr(
"str: UUID of print layout item" )
1721 << QObject::tr(
"str: id of print layout item" )
1722 << QStringLiteral(
"QgsProperty" );
1727 return QStringList() << QObject::tr(
"UUID or item id of layout item" );
1750 return QCoreApplication::translate(
"Processing",
"A color parameter." );
1753 QString
name()
const override
1755 return QCoreApplication::translate(
"Processing",
"Color" );
1758 QString
id()
const override
1760 return QStringLiteral(
"color" );
1765 return QStringLiteral(
"from qgis.core import QgsProcessingParameterColor" );
1770 return QStringLiteral(
"QgsProcessingParameterColor" );
1775 return QStringList() << QObject::tr(
"str: string representation of color, e.g #ff0000 or rgba(200,100,50,0.8)" )
1776 << QStringLiteral(
"QColor" )
1777 << QStringLiteral(
"QgsProperty" );
1782 return QStringList() << QObject::tr(
"String representation of color, e.g #ff0000 or rgba(200,100,50,0.8)" );
1804 return QCoreApplication::translate(
"Processing",
"A coordinate operation parameter." );
1807 QString
name()
const override
1809 return QCoreApplication::translate(
"Processing",
"Coordinate Operation" );
1812 QString
id()
const override
1814 return QStringLiteral(
"coordinateoperation" );
1819 return QStringLiteral(
"from qgis.core import QgsProcessingParameterCoordinateOperation" );
1824 return QStringLiteral(
"QgsProcessingParameterCoordinateOperation" );
1829 return QStringList() << QObject::tr(
"str: string representation of a Proj coordinate operation" );
1834 return QStringList() << QObject::tr(
"String representation of Proj coordinate operation" );
1857 return QCoreApplication::translate(
"Processing",
"A map theme parameter." );
1860 QString
name()
const override
1862 return QCoreApplication::translate(
"Processing",
"Map Theme" );
1865 QString
id()
const override
1867 return QStringLiteral(
"maptheme" );
1872 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMapTheme" );
1877 return QStringLiteral(
"QgsProcessingParameterMapTheme" );
1882 return QStringList() << QObject::tr(
"str: name of an existing map theme" )
1883 << QStringLiteral(
"QgsProperty" );
1888 return QStringList() << QObject::tr(
"Name of an existing map theme" );
1909 return QCoreApplication::translate(
"Processing",
"A datetime parameter, including datetime, date or time values." );
1912 QString
name()
const override
1914 return QCoreApplication::translate(
"Processing",
"Datetime" );
1917 QString
id()
const override
1919 return QStringLiteral(
"datetime" );
1924 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDateTime" );
1929 return QStringLiteral(
"QgsProcessingParameterDateTime" );
1934 return QStringList() << QStringLiteral(
"str" )
1935 << QStringLiteral(
"QDateTime" )
1936 << QStringLiteral(
"QDate" )
1937 << QStringLiteral(
"QTime" )
1938 << QStringLiteral(
"QgsProperty" );
1943 return QStringList() << QObject::tr(
"A datetime value in ISO format" );
1965 return QCoreApplication::translate(
"Processing",
"A connection name parameter, for registered database connections." );
1968 QString
name()
const override
1970 return QCoreApplication::translate(
"Processing",
"Connection Name" );
1973 QString
id()
const override
1975 return QStringLiteral(
"providerconnection" );
1980 return QStringLiteral(
"from qgis.core import QgsProcessingParameterProviderConnection" );
1985 return QStringLiteral(
"QgsProcessingParameterProviderConnection" );
1990 return QStringList() << QStringLiteral(
"str" )
1991 << QStringLiteral(
"QgsProperty" );
1996 return QStringList() << QObject::tr(
"Name of registered database connection" );
2017 return QCoreApplication::translate(
"Processing",
"A database schema parameter." );
2020 QString
name()
const override
2022 return QCoreApplication::translate(
"Processing",
"Database Schema" );
2025 QString
id()
const override
2027 return QStringLiteral(
"databaseschema" );
2032 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDatabaseSchema" );
2037 return QStringLiteral(
"QgsProcessingParameterDatabaseSchema" );
2042 return QStringList() << QStringLiteral(
"str" )
2043 << QStringLiteral(
"QgsProperty" );
2048 return QStringList() << QObject::tr(
"Name of existing database schema" );
2070 return QCoreApplication::translate(
"Processing",
"A database table parameter." );
2073 QString
name()
const override
2075 return QCoreApplication::translate(
"Processing",
"Database Table" );
2078 QString
id()
const override
2080 return QStringLiteral(
"databasetable" );
2085 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDatabaseTable" );
2090 return QStringLiteral(
"QgsProcessingParameterDatabaseTable" );
2095 return QStringList() << QStringLiteral(
"str" )
2096 << QStringLiteral(
"QgsProperty" );
2101 return QStringList() << QObject::tr(
"Name of existing database table" );
2123 return QCoreApplication::translate(
"Processing",
"A point cloud layer parameter." );
2126 QString
name()
const override
2128 return QCoreApplication::translate(
"Processing",
"Point Cloud Layer" );
2133 return QStringLiteral(
"from qgis.core import QgsProcessingParameterPointCloudLayer" );
2138 return QStringLiteral(
"QgsProcessingParameterPointCloudLayer" );
2141 QString
id()
const override
2143 return QStringLiteral(
"pointcloud" );
2148 return QStringList() << QObject::tr(
"str: layer ID" )
2149 << QObject::tr(
"str: layer name" )
2150 << QObject::tr(
"str: layer source" )
2151 << QStringLiteral(
"QgsPointCloudLayer" );
2156 return QStringList() << QObject::tr(
"Path to a point cloud layer" );
2177 return QCoreApplication::translate(
"Processing",
"An annotation layer parameter." );
2180 QString
name()
const override
2182 return QCoreApplication::translate(
"Processing",
"Annotation Layer" );
2187 return QStringLiteral(
"from qgis.core import QgsProcessingParameterAnnotationLayer" );
2192 return QStringLiteral(
"QgsProcessingParameterAnnotationLayer" );
2195 QString
id()
const override
2197 return QStringLiteral(
"annotation" );
2202 return QStringList() << QObject::tr(
"str: layer ID" )
2203 << QObject::tr(
"str: layer name" )
2204 << QObject::tr(
"\"main\": main annotation layer for a project" )
2205 << QStringLiteral(
"QgsAnnotationLayer" );
2210 return QStringList() << QObject::tr(
"Layer ID for an annotation layer, or \"main\" for the main annotation layer in a project." );
An annotation layer parameter for processing algorithms.
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 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.
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 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.
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 QString description() const =0
A human readable and translatable description for this parameter type.
virtual ParameterFlags flags() const
Determines if this parameter is available in the modeler.
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 QgsProcessingParameterDefinition * create(const QString &name) const =0
Creates a new parameter of this type.
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.