QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
List of all members
QgsProcessingParameterTypeFile Class Reference

An input file or folder parameter for processing algorithms. More...

#include <qgsprocessingparametertypeimpl.h>

Inheritance diagram for QgsProcessingParameterTypeFile:
Inheritance graph
[legend]

Additional Inherited Members

- Public Types inherited from QgsProcessingParameterType
enum  ParameterFlag { ExposeToModeler = 1 }
 Each parameter type can offer a number of additional flags to finetune its behavior and capabilities. More...
 
- Public Member Functions inherited from QgsProcessingParameterType
virtual ~QgsProcessingParameterType ()=default
 Destructor. More...
 
virtual QStringList acceptedPythonTypes () const
 Returns a list of the Python data types accepted as values for the parameter. More...
 
virtual QStringList acceptedStringValues () const
 Returns a descriptive list of the possible string values acceptable for the parameter. More...
 
virtual QString className () const
 Returns the corresponding class name for the parameter type. More...
 
virtual QgsProcessingParameterDefinitioncreate (const QString &name) const =0
 Creates a new parameter of this type. More...
 
virtual QString description () const =0
 A human readable and translatable description for this parameter type. More...
 
virtual ParameterFlags flags () const
 Determines if this parameter is available in the modeler. More...
 
virtual QString id () const =0
 A static id for this type which will be used for storing this parameter type. More...
 
virtual QVariantMap metadata () const
 Metadata for this parameter type. More...
 
virtual QString name () const =0
 A human readable and translatable short name for this parameter type. More...
 
virtual QString pythonImportString () const
 Returns a valid Python import string for importing the corresponding parameter type, e.g. More...
 

Detailed Description

An input file or folder parameter for processing algorithms.

Note
No Python bindings available. Get your copy from QgsApplication.processingRegistry().parameterType('file')
Since
QGIS 3.2

Definition at line 747 of file qgsprocessingparametertypeimpl.h.


The documentation for this class was generated from the following file: