QGIS API Documentation  3.14.0-Pi (9f7028fd23)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingParameterFile Class Reference

#include <qgsprocessingparameters.h>

Inheritance diagram for QgsProcessingParameterFile:
Inheritance graph
[legend]

Public Types

enum  Behavior { File = 0, Folder }
 Parameter behavior. More...
 
- Public Types inherited from QgsProcessingParameterDefinition
enum  Flag { FlagAdvanced = 1 << 1, FlagHidden = 1 << 2, FlagOptional = 1 << 3, FlagIsModelOutput = 1 << 4 }
 Parameter flags. More...
 

Public Member Functions

 QgsProcessingParameterFile (const QString &name, const QString &description=QString(), Behavior behavior=File, const QString &extension=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &fileFilter=QString())
 Constructor for QgsProcessingParameterFile. More...
 
QString asPythonString (QgsProcessing::PythonOutputType outputType=QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const override
 Returns the parameter definition as a Python command which can be used within a Python Processing script. More...
 
QString asScriptCode () const override
 Returns the parameter definition encoded in a string which can be used within a Processing script. More...
 
Behavior behavior () const
 Returns the parameter behavior (e.g. More...
 
bool checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const override
 Checks whether the specified input value is acceptable for the parameter. More...
 
QgsProcessingParameterDefinitionclone () const override
 Creates a clone of the parameter definition. More...
 
QString extension () const
 Returns any specified file extension for the parameter. More...
 
QString fileFilter () const
 Returns the file filter string for file destinations compatible with this parameter. More...
 
bool fromVariantMap (const QVariantMap &map) override
 Restores this parameter to a QVariantMap. More...
 
void setBehavior (Behavior behavior)
 Sets the parameter behavior (e.g. More...
 
void setExtension (const QString &extension)
 Sets a file extension for the parameter. More...
 
void setFileFilter (const QString &filter)
 Sets the file filter string for file destinations compatible with this parameter. More...
 
QVariantMap toVariantMap () const override
 Saves this parameter to a QVariantMap. More...
 
QString type () const override
 Unique parameter type name. More...
 
- Public Member Functions inherited from QgsProcessingParameterDefinition
 QgsProcessingParameterDefinition (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false)
 Constructor for QgsProcessingParameterDefinition. More...
 
virtual ~QgsProcessingParameterDefinition ()=default
 
QStringList additionalExpressionContextVariables () const
 Returns a list of additional expression context variables which are available for use when evaluating this parameter. More...
 
QgsProcessingAlgorithmalgorithm () const
 Returns a pointer to the algorithm which owns this parameter. More...
 
QVariant defaultValue () const
 Returns the default value for the parameter. More...
 
virtual QStringList dependsOnOtherParameters () const
 Returns a list of other parameter names on which this parameter is dependent (e.g. More...
 
QString description () const
 Returns the description for the parameter. More...
 
QString dynamicLayerParameterName () const
 Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. More...
 
QgsPropertyDefinition dynamicPropertyDefinition () const
 Returns the property definition for dynamic properties. More...
 
Flags flags () const
 Returns any flags associated with the parameter. More...
 
virtual bool isDestination () const
 Returns true if this parameter represents a file or layer destination, e.g. More...
 
bool isDynamic () const
 Returns true if the parameter supports is dynamic, and can support data-defined values (i.e. More...
 
QVariantMap & metadata ()
 Returns the parameter's freeform metadata. More...
 
QVariantMap metadata () const
 Returns the parameter's freeform metadata. More...
 
QString name () const
 Returns the name of the parameter. More...
 
QgsProcessingProviderprovider () const
 Returns a pointer to the provider for the algorithm which owns this parameter. More...
 
void setAdditionalExpressionContextVariables (const QStringList &variables)
 Sets a list of additional expression context variables which are available for use when evaluating this parameter. More...
 
void setDefaultValue (const QVariant &value)
 Sets the default value for the parameter. More...
 
void setDescription (const QString &description)
 Sets the description for the parameter. More...
 
void setDynamicLayerParameterName (const QString &name)
 Sets the name for the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set. More...
 
void setDynamicPropertyDefinition (const QgsPropertyDefinition &definition)
 Sets the property definition for dynamic properties. More...
 
void setFlags (Flags flags)
 Sets the flags associated with the parameter. More...
 
void setIsDynamic (bool dynamic)
 Sets whether the parameter is dynamic, and can support data-defined values (i.e. More...
 
void setMetadata (const QVariantMap &metadata)
 Sets the parameter's freeform metadata. More...
 
void setName (const QString &name)
 Sets the name of the parameter. More...
 
virtual QString toolTip () const
 Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type). More...
 
virtual QString valueAsPythonString (const QVariant &value, QgsProcessingContext &context) const
 Returns a string version of the parameter input value, which is suitable for use as an input parameter value when running an algorithm directly from a Python command. More...
 

Static Public Member Functions

static QgsProcessingParameterFilefromScriptCode (const QString &name, const QString &description, bool isOptional, const QString &definition, Behavior behavior=File)
 Creates a new parameter using the definition from a script code. More...
 
static QString typeName ()
 Returns the type name for the parameter class. More...
 

Additional Inherited Members

- Protected Attributes inherited from QgsProcessingParameterDefinition
QStringList mAdditionalExpressionVariables
 Additional expression context variables exposed for use by this parameter. More...
 
QgsProcessingAlgorithmmAlgorithm = nullptr
 Pointer to algorithm which owns this parameter. More...
 
QVariant mDefault
 Default value for parameter. More...
 
QString mDescription
 Parameter description. More...
 
QString mDynamicLayerParameterName
 Linked vector layer parameter name for dynamic properties. More...
 
Flags mFlags
 Parameter flags. More...
 
bool mIsDynamic = false
 True for dynamic parameters, which can have data-defined (QgsProperty) based values. More...
 
QVariantMap mMetadata
 Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and behavior. More...
 
QString mName
 Parameter name. More...
 
QgsPropertyDefinition mPropertyDefinition
 Data defined property definition. More...
 

Detailed Description

An input file or folder parameter for processing algorithms.

Since
QGIS 3.0

Definition at line 1567 of file qgsprocessingparameters.h.

Member Enumeration Documentation

◆ Behavior

Parameter behavior.

Enumerator
File 

Parameter is a single file.

Folder 

Parameter is a folder.

Definition at line 1572 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterFile()

QgsProcessingParameterFile::QgsProcessingParameterFile ( const QString &  name,
const QString &  description = QString(),
Behavior  behavior = File,
const QString &  extension = QString(),
const QVariant &  defaultValue = QVariant(),
bool  optional = false,
const QString &  fileFilter = QString() 
)

Constructor for QgsProcessingParameterFile.

The extension argument allows for specifying a file extension associated with the parameter (e.g. "html"). Use fileFilter for a more flexible approach which allows for multiple file extensions. Only one of extension or fileFilter should be specified, if both are specified then fileFilter takes precedence.

Definition at line 2772 of file qgsprocessingparameters.cpp.

Member Function Documentation

◆ asPythonString()

QString QgsProcessingParameterFile::asPythonString ( QgsProcessing::PythonOutputType  outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const
overridevirtual

Returns the parameter definition as a Python command which can be used within a Python Processing script.

The outputType argument specifies the desired output format for the Python string, i.e. the intended end use of the generated Python code.

Since
QGIS 3.6

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 2836 of file qgsprocessingparameters.cpp.

◆ asScriptCode()

QString QgsProcessingParameterFile::asScriptCode ( ) const
overridevirtual

Returns the parameter definition encoded in a string which can be used within a Processing script.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 2826 of file qgsprocessingparameters.cpp.

◆ behavior()

Behavior QgsProcessingParameterFile::behavior ( ) const
inline

Returns the parameter behavior (e.g.

File or Folder).

See also
setBehavior()

Definition at line 1602 of file qgsprocessingparameters.h.

◆ checkValueIsAcceptable()

bool QgsProcessingParameterFile::checkValueIsAcceptable ( const QVariant &  input,
QgsProcessingContext context = nullptr 
) const
overridevirtual

Checks whether the specified input value is acceptable for the parameter.

Returns true if the value can be accepted. The optional context parameter can be specified to allow a more stringent check to be performed, capable of checking for the presence of required layers and other factors within the context.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 2786 of file qgsprocessingparameters.cpp.

◆ clone()

QgsProcessingParameterDefinition * QgsProcessingParameterFile::clone ( ) const
overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

Definition at line 2781 of file qgsprocessingparameters.cpp.

◆ extension()

QString QgsProcessingParameterFile::extension ( ) const
inline

Returns any specified file extension for the parameter.

Note
See fileFilter() for a more flexible approach.
See also
setExtension()

Definition at line 1617 of file qgsprocessingparameters.h.

◆ fileFilter()

QString QgsProcessingParameterFile::fileFilter ( ) const

Returns the file filter string for file destinations compatible with this parameter.

See also
setFileFilter()
extension()
Since
QGIS 3.10

Definition at line 2865 of file qgsprocessingparameters.cpp.

◆ fromScriptCode()

QgsProcessingParameterFile * QgsProcessingParameterFile::fromScriptCode ( const QString &  name,
const QString &  description,
bool  isOptional,
const QString &  definition,
QgsProcessingParameterFile::Behavior  behavior = File 
)
static

Creates a new parameter using the definition from a script code.

Definition at line 2894 of file qgsprocessingparameters.cpp.

◆ fromVariantMap()

bool QgsProcessingParameterFile::fromVariantMap ( const QVariantMap &  map)
overridevirtual

Restores this parameter to a QVariantMap.

Subclasses should ensure that they call the base class method.

See also
toVariantMap()

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 2885 of file qgsprocessingparameters.cpp.

◆ setBehavior()

void QgsProcessingParameterFile::setBehavior ( Behavior  behavior)
inline

Sets the parameter behavior (e.g.

File or Folder).

See also
behavior()

Definition at line 1608 of file qgsprocessingparameters.h.

◆ setExtension()

void QgsProcessingParameterFile::setExtension ( const QString &  extension)

Sets a file extension for the parameter.

Calling this method resets any existing fileFilter().

Note
See setFileFilter() for a more flexible approach.
See also
extension()

Definition at line 2859 of file qgsprocessingparameters.cpp.

◆ setFileFilter()

void QgsProcessingParameterFile::setFileFilter ( const QString &  filter)

Sets the file filter string for file destinations compatible with this parameter.

Calling this method resets any existing extension() setting.

See also
fileFilter()
setExtension()
Since
QGIS 3.10

Definition at line 2870 of file qgsprocessingparameters.cpp.

◆ toVariantMap()

QVariantMap QgsProcessingParameterFile::toVariantMap ( ) const
overridevirtual

Saves this parameter to a QVariantMap.

Subclasses should ensure that they call the base class method and then extend the result with additional properties.

See also
fromVariantMap()

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 2876 of file qgsprocessingparameters.cpp.

◆ type()

QString QgsProcessingParameterFile::type ( ) const
inlineoverridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

Definition at line 1593 of file qgsprocessingparameters.h.

◆ typeName()

static QString QgsProcessingParameterFile::typeName ( )
inlinestatic

Returns the type name for the parameter class.

Definition at line 1591 of file qgsprocessingparameters.h.


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