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" );
918 return QCoreApplication::translate(
"Processing",
"A generic file based destination parameter." );
921 QString
name()
const override
923 return QCoreApplication::translate(
"Processing",
"File Destination" );
926 QString
id()
const override
928 return QStringLiteral(
"fileDestination" );
933 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFileDestination" );
938 return QStringLiteral(
"QgsProcessingParameterFileDestination" );
941 ParameterFlags
flags()
const override
944 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
950 return QStringList() << QStringLiteral(
"str" )
951 << QStringLiteral(
"QgsProperty" );
956 return QStringList() << QObject::tr(
"Path for new file" );
978 return QCoreApplication::translate(
"Processing",
"A folder destination parameter." );
981 QString
name()
const override
983 return QCoreApplication::translate(
"Processing",
"Folder Destination" );
986 QString
id()
const override
988 return QStringLiteral(
"folderDestination" );
993 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFolderDestination" );
998 return QStringLiteral(
"QgsProcessingParameterFolderDestination" );
1001 ParameterFlags
flags()
const override
1004 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
1010 return QStringList() << QStringLiteral(
"str" )
1011 << QStringLiteral(
"QgsProperty" );
1016 return QStringList() << QObject::tr(
"Path for an existing or new folder" );
1037 return QCoreApplication::translate(
"Processing",
"A raster layer destination parameter." );
1040 QString
name()
const override
1042 return QCoreApplication::translate(
"Processing",
"Raster Destination" );
1045 QString
id()
const override
1047 return QStringLiteral(
"rasterDestination" );
1052 return QStringLiteral(
"from qgis.core import QgsProcessingParameterRasterDestination" );
1057 return QStringLiteral(
"QgsProcessingParameterRasterDestination" );
1060 ParameterFlags
flags()
const override
1063 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
1069 return QStringList() << QStringLiteral(
"str" )
1070 << QStringLiteral(
"QgsProperty" )
1071 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" );
1076 return QStringList() << QObject::tr(
"Path for new raster layer" );
1096 return QCoreApplication::translate(
"Processing",
"A freeform string parameter." );
1099 QString
name()
const override
1101 return QCoreApplication::translate(
"Processing",
"String" );
1104 QString
id()
const override
1106 return QStringLiteral(
"string" );
1111 return QStringLiteral(
"from qgis.core import QgsProcessingParameterString" );
1116 return QStringLiteral(
"QgsProcessingParameterString" );
1121 return QStringList() << QStringLiteral(
"str" )
1122 << QStringLiteral(
"QgsProperty" );
1127 return QStringList() << QObject::tr(
"String value" );
1147 return QCoreApplication::translate(
"Processing",
"A authentication configuration parameter." );
1150 QString
name()
const override
1152 return QCoreApplication::translate(
"Processing",
"Authentication Configuration" );
1155 QString
id()
const override
1157 return QStringLiteral(
"authcfg" );
1162 return QStringLiteral(
"from qgis.core import QgsProcessingParameterAuthConfig" );
1167 return QStringLiteral(
"QgsProcessingParameterAuthConfig" );
1172 return QStringList() << QStringLiteral(
"str" );
1177 return QStringList() << QObject::tr(
"An existing QGIS authentication ID string" );
1197 return QCoreApplication::translate(
"Processing",
"An input allowing selection of multiple sources, including multiple map layers or file sources." );
1200 QString
name()
const override
1202 return QCoreApplication::translate(
"Processing",
"Multiple Input" );
1205 QString
id()
const override
1207 return QStringLiteral(
"multilayer" );
1212 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMultipleLayers" );
1217 return QStringLiteral(
"QgsProcessingParameterMultipleLayers" );
1222 return QStringList() << QObject::tr(
"list[str]: list of layer IDs" )
1223 << QObject::tr(
"list[str]: list of layer names" )
1224 << QObject::tr(
"list[str]: list of layer sources" )
1225 << QStringLiteral(
"list[QgsMapLayer]" )
1226 << QStringLiteral(
"QgsProperty" );
1246 return QCoreApplication::translate(
"Processing",
"A vector feature parameter, e.g. for algorithms which operate on the features within a layer." );
1249 QString
name()
const override
1251 return QCoreApplication::translate(
"Processing",
"Vector Features" );
1254 QString
id()
const override
1256 return QStringLiteral(
"source" );
1261 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFeatureSource" );
1266 return QStringLiteral(
"QgsProcessingParameterFeatureSource" );
1271 return QStringList() << QObject::tr(
"str: layer ID" )
1272 << QObject::tr(
"str: layer name" )
1273 << QObject::tr(
"str: layer source" )
1274 << QStringLiteral(
"QgsProcessingFeatureSourceDefinition" )
1275 << QStringLiteral(
"QgsProperty" )
1276 << QStringLiteral(
"QgsVectorLayer" );
1281 return QStringList() << QObject::tr(
"Path to a vector layer" );
1301 return QCoreApplication::translate(
"Processing",
"A numeric parameter, including float or integer values." );
1304 QString
name()
const override
1306 return QCoreApplication::translate(
"Processing",
"Number" );
1309 QString
id()
const override
1311 return QStringLiteral(
"number" );
1316 return QStringLiteral(
"from qgis.core import QgsProcessingParameterNumber" );
1321 return QStringLiteral(
"QgsProcessingParameterNumber" );
1326 return QStringList() << QStringLiteral(
"int" )
1327 << QStringLiteral(
"float" )
1328 << QStringLiteral(
"QgsProperty" );
1333 return QStringList() << QObject::tr(
"A numeric value" );
1353 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a distance measure." );
1356 QString
name()
const override
1358 return QCoreApplication::translate(
"Processing",
"Distance" );
1361 QString
id()
const override
1363 return QStringLiteral(
"distance" );
1368 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDistance" );
1373 return QStringLiteral(
"QgsProcessingParameterDistance" );
1378 return QStringList() << QStringLiteral(
"int" )
1379 << QStringLiteral(
"float" )
1380 << QStringLiteral(
"QgsProperty" );
1385 return QStringList() << QObject::tr(
"A numeric value" );
1405 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a duration measure." );
1408 QString
name()
const override
1410 return QCoreApplication::translate(
"Processing",
"Duration" );
1413 QString
id()
const override
1415 return QStringLiteral(
"duration" );
1420 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDuration" );
1425 return QStringLiteral(
"QgsProcessingParameterDuration" );
1430 return QStringList() << QStringLiteral(
"int" )
1431 << QStringLiteral(
"float" )
1432 << QStringLiteral(
"QgsProperty" );
1437 return QStringList() << QObject::tr(
"A numeric value (unit type set by algorithms)" );
1457 return QCoreApplication::translate(
"Processing",
"A numeric parameter representing a map scale." );
1460 QString
name()
const override
1462 return QCoreApplication::translate(
"Processing",
"Scale" );
1465 QString
id()
const override
1467 return QStringLiteral(
"scale" );
1472 return QStringLiteral(
"from qgis.core import QgsProcessingParameterScale" );
1477 return QStringLiteral(
"QgsProcessingParameterScale" );
1482 return QStringList() << QStringLiteral(
"int: scale denominator" )
1483 << QStringLiteral(
"float: scale denominator" )
1484 << QStringLiteral(
"QgsProperty" );
1489 return QStringList() << QObject::tr(
"A numeric value representing the scale denominator" );
1509 return QCoreApplication::translate(
"Processing",
"A raster band parameter, for selecting an existing band from a raster source." );
1512 QString
name()
const override
1514 return QCoreApplication::translate(
"Processing",
"Raster Band" );
1517 QString
id()
const override
1519 return QStringLiteral(
"band" );
1524 return QStringLiteral(
"from qgis.core import QgsProcessingParameterBand" );
1529 return QStringLiteral(
"QgsProcessingParameterBand" );
1534 return QStringList() << QStringLiteral(
"int" )
1535 << QStringLiteral(
"QgsProperty" );
1540 return QStringList() << QObject::tr(
"Integer value representing an existing raster band number" );
1558 ParameterFlags
flags()
const override
1561 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
1567 return QCoreApplication::translate(
"Processing",
"A feature sink destination parameter." );
1570 QString
name()
const override
1572 return QCoreApplication::translate(
"Processing",
"Feature Sink" );
1575 QString
id()
const override
1577 return QStringLiteral(
"sink" );
1582 return QStringLiteral(
"from qgis.core import QgsProcessingParameterFeatureSink" );
1587 return QStringLiteral(
"QgsProcessingParameterFeatureSink" );
1592 return QStringList() << QObject::tr(
"str: destination vector file, e.g. 'd:/test.shp'" )
1593 << QObject::tr(
"str: 'memory:' to store result in temporary memory layer" )
1594 << QObject::tr(
"str: using vector provider ID prefix and destination URI, e.g. 'postgres:…' to store result in PostGIS table" )
1595 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" )
1596 << QStringLiteral(
"QgsProperty" );
1601 return QStringList() << QObject::tr(
"Path for new vector layer" );
1621 return QCoreApplication::translate(
"Processing",
"A print layout parameter." );
1624 QString
name()
const override
1626 return QCoreApplication::translate(
"Processing",
"Print Layout" );
1629 QString
id()
const override
1631 return QStringLiteral(
"layout" );
1636 return QStringLiteral(
"from qgis.core import QgsProcessingParameterLayout" );
1641 return QStringLiteral(
"QgsProcessingParameterLayout" );
1646 return QStringList() << QObject::tr(
"str: name of print layout in current project" )
1647 << QStringLiteral(
"QgsProperty" );
1652 return QStringList() << QObject::tr(
"Name of print layout in current project" );
1672 return QCoreApplication::translate(
"Processing",
"A print layout item parameter." );
1675 QString
name()
const override
1677 return QCoreApplication::translate(
"Processing",
"Print Layout Item" );
1680 QString
id()
const override
1682 return QStringLiteral(
"layoutitem" );
1687 return QStringLiteral(
"from qgis.core import QgsProcessingParameterLayoutItem" );
1692 return QStringLiteral(
"QgsProcessingParameterLayoutItem" );
1697 return QStringList() << QObject::tr(
"str: UUID of print layout item" )
1698 << QObject::tr(
"str: id of print layout item" )
1699 << QStringLiteral(
"QgsProperty" );
1704 return QStringList() << QObject::tr(
"UUID or item id of layout item" );
1724 return QCoreApplication::translate(
"Processing",
"A color parameter." );
1727 QString
name()
const override
1729 return QCoreApplication::translate(
"Processing",
"Color" );
1732 QString
id()
const override
1734 return QStringLiteral(
"color" );
1739 return QStringLiteral(
"from qgis.core import QgsProcessingParameterColor" );
1744 return QStringLiteral(
"QgsProcessingParameterColor" );
1749 return QStringList() << QObject::tr(
"str: string representation of color, e.g #ff0000 or rgba(200,100,50,0.8)" )
1750 << QStringLiteral(
"QColor" )
1751 << QStringLiteral(
"QgsProperty" );
1756 return QStringList() << QObject::tr(
"String representation of color, e.g #ff0000 or rgba(200,100,50,0.8)" );
1776 return QCoreApplication::translate(
"Processing",
"A coordinate operation parameter." );
1779 QString
name()
const override
1781 return QCoreApplication::translate(
"Processing",
"Coordinate Operation" );
1784 QString
id()
const override
1786 return QStringLiteral(
"coordinateoperation" );
1791 return QStringLiteral(
"from qgis.core import QgsProcessingParameterCoordinateOperation" );
1796 return QStringLiteral(
"QgsProcessingParameterCoordinateOperation" );
1801 return QStringList() << QObject::tr(
"str: string representation of a Proj coordinate operation" );
1806 return QStringList() << QObject::tr(
"String representation of Proj coordinate operation" );
1826 return QCoreApplication::translate(
"Processing",
"A map theme parameter." );
1829 QString
name()
const override
1831 return QCoreApplication::translate(
"Processing",
"Map Theme" );
1834 QString
id()
const override
1836 return QStringLiteral(
"maptheme" );
1841 return QStringLiteral(
"from qgis.core import QgsProcessingParameterMapTheme" );
1846 return QStringLiteral(
"QgsProcessingParameterMapTheme" );
1851 return QStringList() << QObject::tr(
"str: name of an existing map theme" )
1852 << QStringLiteral(
"QgsProperty" );
1857 return QStringList() << QObject::tr(
"Name of an existing map theme" );
1877 return QCoreApplication::translate(
"Processing",
"A datetime parameter, including datetime, date or time values." );
1880 QString
name()
const override
1882 return QCoreApplication::translate(
"Processing",
"Datetime" );
1885 QString
id()
const override
1887 return QStringLiteral(
"datetime" );
1892 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDateTime" );
1897 return QStringLiteral(
"QgsProcessingParameterDateTime" );
1902 return QStringList() << QStringLiteral(
"str" )
1903 << QStringLiteral(
"QDateTime" )
1904 << QStringLiteral(
"QDate" )
1905 << QStringLiteral(
"QTime" )
1906 << QStringLiteral(
"QgsProperty" );
1911 return QStringList() << QObject::tr(
"A datetime value in ISO format" );
1931 return QCoreApplication::translate(
"Processing",
"A connection name parameter, for registered database connections." );
1934 QString
name()
const override
1936 return QCoreApplication::translate(
"Processing",
"Connection Name" );
1939 QString
id()
const override
1941 return QStringLiteral(
"providerconnection" );
1946 return QStringLiteral(
"from qgis.core import QgsProcessingParameterProviderConnection" );
1951 return QStringLiteral(
"QgsProcessingParameterProviderConnection" );
1956 return QStringList() << QStringLiteral(
"str" )
1957 << QStringLiteral(
"QgsProperty" );
1962 return QStringList() << QObject::tr(
"Name of registered database connection" );
1982 return QCoreApplication::translate(
"Processing",
"A database schema parameter." );
1985 QString
name()
const override
1987 return QCoreApplication::translate(
"Processing",
"Database Schema" );
1990 QString
id()
const override
1992 return QStringLiteral(
"databaseschema" );
1997 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDatabaseSchema" );
2002 return QStringLiteral(
"QgsProcessingParameterDatabaseSchema" );
2007 return QStringList() << QStringLiteral(
"str" )
2008 << QStringLiteral(
"QgsProperty" );
2013 return QStringList() << QObject::tr(
"Name of existing database schema" );
2033 return QCoreApplication::translate(
"Processing",
"A database table parameter." );
2036 QString
name()
const override
2038 return QCoreApplication::translate(
"Processing",
"Database Table" );
2041 QString
id()
const override
2043 return QStringLiteral(
"databasetable" );
2048 return QStringLiteral(
"from qgis.core import QgsProcessingParameterDatabaseTable" );
2053 return QStringLiteral(
"QgsProcessingParameterDatabaseTable" );
2058 return QStringList() << QStringLiteral(
"str" )
2059 << QStringLiteral(
"QgsProperty" );
2064 return QStringList() << QObject::tr(
"Name of existing database table" );
2084 return QCoreApplication::translate(
"Processing",
"A point cloud layer parameter." );
2087 QString
name()
const override
2089 return QCoreApplication::translate(
"Processing",
"Point Cloud Layer" );
2094 return QStringLiteral(
"from qgis.core import QgsProcessingParameterPointCloudLayer" );
2099 return QStringLiteral(
"QgsProcessingParameterPointCloudLayer" );
2102 QString
id()
const override
2104 return QStringLiteral(
"pointcloud" );
2109 return QStringList() << QObject::tr(
"str: layer ID" )
2110 << QObject::tr(
"str: layer name" )
2111 << QObject::tr(
"str: layer source" )
2112 << QStringLiteral(
"QgsPointCloudLayer" );
2117 return QStringList() << QObject::tr(
"Path to a point cloud layer" );
2137 return QCoreApplication::translate(
"Processing",
"An annotation layer parameter." );
2140 QString
name()
const override
2142 return QCoreApplication::translate(
"Processing",
"Annotation Layer" );
2147 return QStringLiteral(
"from qgis.core import QgsProcessingParameterAnnotationLayer" );
2152 return QStringLiteral(
"QgsProcessingParameterAnnotationLayer" );
2155 QString
id()
const override
2157 return QStringLiteral(
"annotation" );
2162 return QStringList() << QObject::tr(
"str: layer ID" )
2163 << QObject::tr(
"str: layer name" )
2164 << QObject::tr(
"\"main\": main annotation layer for a project" )
2165 << QStringLiteral(
"QgsAnnotationLayer" );
2170 return QStringList() << QObject::tr(
"Layer ID for an annotation layer, or \"main\" for the main annotation layer in a project." );
2191 return QCoreApplication::translate(
"Processing",
"A point cloud layer destination parameter." );
2194 QString
name()
const override
2196 return QCoreApplication::translate(
"Processing",
"Point Cloud Destination" );
2199 QString
id()
const override
2201 return QStringLiteral(
"pointCloudDestination" );
2206 return QStringLiteral(
"from qgis.core import QgsProcessingParameterPointCloudDestination" );
2211 return QStringLiteral(
"QgsProcessingParameterPointCloudDestination" );
2214 ParameterFlags
flags()
const override
2217 flags.setFlag( ParameterFlag::ExposeToModeler,
false );
2223 return QStringList() << QStringLiteral(
"str" )
2224 << QStringLiteral(
"QgsProperty" )
2225 << QStringLiteral(
"QgsProcessingOutputLayerDefinition" );
2230 return QStringList() << QObject::tr(
"Path for new point cloud layer" );
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 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.
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 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.
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.