QGIS API Documentation
3.0.2-Girona (307d082)
|
A vector layer or feature source field parameter for processing algorithms. More...
#include <qgsprocessingparameters.h>
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 } |
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) | |
Constructor for QgsProcessingParameterField. More... | |
bool | allowMultiple () const |
Returns whether multiple field selections are permitted. More... | |
QString | asScriptCode () const override |
Returns the parameter definition encoded in a string which can be used within a Python 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... | |
QgsProcessingParameterDefinition * | clone () const override |
Creates a clone of the parameter definition. More... | |
DataType | dataType () const |
Returns the acceptable data type for the field. 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 | 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 |
QgsProcessingAlgorithm * | algorithm () 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... | |
QgsProcessingProvider * | provider () const |
Returns a pointer to the provider for the algorithm which owns 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 QgsProcessingParameterField * | fromScriptCode (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 | |
QgsProcessingAlgorithm * | mAlgorithm = 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 customise their appearance and behavior. More... | |
QString | mName |
Parameter name. More... | |
QgsPropertyDefinition | mPropertyDefinition |
Data defined property definition. More... | |
A vector layer or feature source field parameter for processing algorithms.
Definition at line 1570 of file qgsprocessingparameters.h.
Field data types.
Enumerator | |
---|---|
Any | Accepts any field. |
Numeric | Accepts numeric fields. |
String | Accepts string fields. |
DateTime | Accepts datetime fields. |
Definition at line 1575 of file qgsprocessingparameters.h.
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 |
||
) |
Constructor for QgsProcessingParameterField.
Definition at line 2657 of file qgsprocessingparameters.cpp.
bool QgsProcessingParameterField::allowMultiple | ( | ) | const |
Returns whether multiple field selections are permitted.
Definition at line 2795 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Returns the parameter definition encoded in a string which can be used within a Python processing script.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 2733 of file qgsprocessingparameters.cpp.
|
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 2671 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Creates a clone of the parameter definition.
Implements QgsProcessingParameterDefinition.
Definition at line 2666 of file qgsprocessingparameters.cpp.
QgsProcessingParameterField::DataType QgsProcessingParameterField::dataType | ( | ) | const |
Returns the acceptable data type for the field.
Definition at line 2785 of file qgsprocessingparameters.cpp.
|
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 2767 of file qgsprocessingparameters.cpp.
|
static |
Creates a new parameter using the definition from a script code.
Definition at line 2823 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Restores this parameter to a QVariantMap.
Subclasses should ensure that they call the base class method.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 2814 of file qgsprocessingparameters.cpp.
QString QgsProcessingParameterField::parentLayerParameterName | ( | ) | const |
Returns the name of the parent layer parameter, or an empty string if this is not set.
Definition at line 2775 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterField::setAllowMultiple | ( | bool | allowMultiple | ) |
Sets whether multiple field selections are permitted.
Definition at line 2800 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterField::setDataType | ( | DataType | type | ) |
Sets the acceptable data type for the field.
Definition at line 2790 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterField::setParentLayerParameterName | ( | const QString & | parentLayerParameterName | ) |
Sets the name of the parent layer parameter.
Use an empty string if this is not required.
Definition at line 2780 of file qgsprocessingparameters.cpp.
|
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.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 2805 of file qgsprocessingparameters.cpp.
|
inlineoverridevirtual |
Unique parameter type name.
Implements QgsProcessingParameterDefinition.
Definition at line 1597 of file qgsprocessingparameters.h.
|
inlinestatic |
Returns the type name for the parameter class.
Definition at line 1595 of file qgsprocessingparameters.h.
|
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.
The returned value must be correctly escaped - e.g. string values must be wrapped in ' 's.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 2706 of file qgsprocessingparameters.cpp.