QGIS API Documentation  3.13.0-Master (7f54853aae)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingParameterField Class Reference

A vector layer or feature source field parameter for processing algorithms. More...

#include <qgsprocessingparameters.h>

Inheritance diagram for QgsProcessingParameterField:
Inheritance graph
[legend]

Public Types

enum  DataType { Any = -1, Numeric = 0, String = 1, DateTime = 2 }
 Field data types. 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

 QgsProcessingParameterField (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayerParameterName=QString(), DataType type=Any, bool allowMultiple=false, bool optional=false, bool defaultToAllFields=false)
 Constructor for QgsProcessingParameterField. More...
 
bool allowMultiple () const
 Returns whether multiple field selections are permitted. 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...
 
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...
 
DataType dataType () const
 Returns the acceptable data type for the field. More...
 
bool defaultToAllFields () const
 Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all fields as the default value. More...
 
QStringList dependsOnOtherParameters () const override
 Returns a list of other parameter names on which this parameter is dependent (e.g. More...
 
bool fromVariantMap (const QVariantMap &map) override
 Restores this parameter to a QVariantMap. More...
 
QString parentLayerParameterName () const
 Returns the name of the parent layer parameter, or an empty string if this is not set. More...
 
void setAllowMultiple (bool allowMultiple)
 Sets whether multiple field selections are permitted. More...
 
void setDataType (DataType type)
 Sets the acceptable data type for the field. More...
 
void setDefaultToAllFields (bool enabled)
 Sets whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all fields as the default value. More...
 
void setParentLayerParameterName (const QString &parentLayerParameterName)
 Sets the name of the parent layer parameter. More...
 
QVariantMap toVariantMap () const override
 Saves this parameter to a QVariantMap. More...
 
QString type () const override
 Unique parameter type name. More...
 
QString valueAsPythonString (const QVariant &value, QgsProcessingContext &context) const override
 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...
 
- 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...
 
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 () const
 Returns the parameter's freeform metadata. More...
 
QVariantMap & metadata ()
 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...
 

Static Public Member Functions

static QgsProcessingParameterFieldfromScriptCode (const QString &name, const QString &description, bool isOptional, const QString &definition)
 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

A vector layer or feature source field parameter for processing algorithms.

Since
QGIS 3.0

Definition at line 2302 of file qgsprocessingparameters.h.

Member Enumeration Documentation

◆ DataType

Field data types.

Enumerator
Any 

Accepts any field.

Numeric 

Accepts numeric fields.

String 

Accepts string fields.

DateTime 

Accepts datetime fields.

Definition at line 2307 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterField()

QgsProcessingParameterField::QgsProcessingParameterField ( const QString &  name,
const QString &  description = QString(),
const QVariant &  defaultValue = QVariant(),
const QString &  parentLayerParameterName = QString(),
DataType  type = Any,
bool  allowMultiple = false,
bool  optional = false,
bool  defaultToAllFields = false 
)

Constructor for QgsProcessingParameterField.

Definition at line 3998 of file qgsprocessingparameters.cpp.

Member Function Documentation

◆ allowMultiple()

bool QgsProcessingParameterField::allowMultiple ( ) const

Returns whether multiple field selections are permitted.

See also
setAllowMultiple()

Definition at line 4193 of file qgsprocessingparameters.cpp.

◆ asPythonString()

QString QgsProcessingParameterField::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 4118 of file qgsprocessingparameters.cpp.

◆ asScriptCode()

QString QgsProcessingParameterField::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 4081 of file qgsprocessingparameters.cpp.

◆ checkValueIsAcceptable()

bool QgsProcessingParameterField::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 4014 of file qgsprocessingparameters.cpp.

◆ clone()

QgsProcessingParameterDefinition * QgsProcessingParameterField::clone ( ) const
overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

Definition at line 4009 of file qgsprocessingparameters.cpp.

◆ dataType()

QgsProcessingParameterField::DataType QgsProcessingParameterField::dataType ( ) const

Returns the acceptable data type for the field.

See also
setDataType()

Definition at line 4183 of file qgsprocessingparameters.cpp.

◆ defaultToAllFields()

bool QgsProcessingParameterField::defaultToAllFields ( ) const

Returns whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all fields as the default value.

If true, this will override any existing defaultValue() set on the parameter.

See also
setDefaultToAllFields()
Since
QGIS 3.12

Definition at line 4203 of file qgsprocessingparameters.cpp.

◆ dependsOnOtherParameters()

QStringList QgsProcessingParameterField::dependsOnOtherParameters ( ) const
overridevirtual

Returns a list of other parameter names on which this parameter is dependent (e.g.

field parameters which depend on a parent layer parameter).

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 4165 of file qgsprocessingparameters.cpp.

◆ fromScriptCode()

QgsProcessingParameterField * QgsProcessingParameterField::fromScriptCode ( const QString &  name,
const QString &  description,
bool  isOptional,
const QString &  definition 
)
static

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

Definition at line 4233 of file qgsprocessingparameters.cpp.

◆ fromVariantMap()

bool QgsProcessingParameterField::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 4223 of file qgsprocessingparameters.cpp.

◆ parentLayerParameterName()

QString QgsProcessingParameterField::parentLayerParameterName ( ) const

Returns the name of the parent layer parameter, or an empty string if this is not set.

See also
setParentLayerParameterName()

Definition at line 4173 of file qgsprocessingparameters.cpp.

◆ setAllowMultiple()

void QgsProcessingParameterField::setAllowMultiple ( bool  allowMultiple)

Sets whether multiple field selections are permitted.

See also
allowMultiple()

Definition at line 4198 of file qgsprocessingparameters.cpp.

◆ setDataType()

void QgsProcessingParameterField::setDataType ( DataType  type)

Sets the acceptable data type for the field.

See also
dataType()

Definition at line 4188 of file qgsprocessingparameters.cpp.

◆ setDefaultToAllFields()

void QgsProcessingParameterField::setDefaultToAllFields ( bool  enabled)

Sets whether a parameter which allows multiple selections (see allowMultiple()) should automatically select all fields as the default value.

If true, this will override any existing defaultValue() set on the parameter.

See also
defaultToAllFields()
Since
QGIS 3.12

Definition at line 4208 of file qgsprocessingparameters.cpp.

◆ setParentLayerParameterName()

void QgsProcessingParameterField::setParentLayerParameterName ( const QString &  parentLayerParameterName)

Sets the name of the parent layer parameter.

Use an empty string if this is not required.

See also
parentLayerParameterName()

Definition at line 4178 of file qgsprocessingparameters.cpp.

◆ toVariantMap()

QVariantMap QgsProcessingParameterField::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 4213 of file qgsprocessingparameters.cpp.

◆ type()

QString QgsProcessingParameterField::type ( ) const
inlineoverridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

Definition at line 2330 of file qgsprocessingparameters.h.

◆ typeName()

static QString QgsProcessingParameterField::typeName ( )
inlinestatic

Returns the type name for the parameter class.

Definition at line 2328 of file qgsprocessingparameters.h.

◆ valueAsPythonString()

QString QgsProcessingParameterField::valueAsPythonString ( const QVariant &  value,
QgsProcessingContext context 
) const
overridevirtual

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.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 4049 of file qgsprocessingparameters.cpp.


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