QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgsprocessingparameters.h>
Public Member Functions | |
QgsProcessingParameterVectorLayer (const QString &name, const QString &description=QString(), const QList< int > &types=QList< int >(), const QVariant &defaultValue=QVariant(), bool optional=false) | |
Constructor for QgsProcessingParameterVectorLayer. 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... | |
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... | |
QString | createFileFilter () const override |
This method needs to be reimplemented in all classes which implement this interface and return a file filter. More... | |
bool | fromVariantMap (const QVariantMap &map) override |
Restores this parameter to a QVariantMap. 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... | |
![]() | |
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... | |
QgsProcessingAlgorithm * | algorithm () const |
Returns a pointer to the algorithm which owns this parameter. More... | |
virtual QString | asScriptCode () const |
Returns the parameter definition encoded in a string which can be used within a Processing script. 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... | |
QgsProcessingProvider * | provider () 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... | |
![]() | |
QgsProcessingParameterLimitedDataTypes (const QList< int > &types=QList< int >()) | |
Constructor for QgsProcessingParameterLimitedDataTypes, with a list of acceptable data types. More... | |
QList< int > | dataTypes () const |
Returns the geometry types for sources acceptable by the parameter. More... | |
void | setDataTypes (const QList< int > &types) |
Sets the geometry types for sources acceptable by the parameter. More... | |
![]() | |
virtual | ~QgsFileFilterGenerator ()=default |
Static Public Member Functions | |
static QgsProcessingParameterVectorLayer * | 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 | |
![]() | |
enum | Flag { FlagAdvanced = 1 << 1, FlagHidden = 1 << 2, FlagOptional = 1 << 3, FlagIsModelOutput = 1 << 4 } |
Parameter flags. More... | |
![]() | |
QStringList | mAdditionalExpressionVariables |
Additional expression context variables exposed for use by this parameter. More... | |
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 customize their appearance and behavior. More... | |
QString | mName |
Parameter name. More... | |
QgsPropertyDefinition | mPropertyDefinition |
Data defined property definition. More... | |
![]() | |
QList< int > | mDataTypes |
List of acceptable data types for the parameter. More... | |
A vector layer (with or without geometry) parameter for processing algorithms. Consider using the more versatile QgsProcessingParameterFeatureSource wherever possible.
Definition at line 2382 of file qgsprocessingparameters.h.
QgsProcessingParameterVectorLayer::QgsProcessingParameterVectorLayer | ( | const QString & | name, |
const QString & | description = QString() , |
||
const QList< int > & | types = QList< int >() , |
||
const QVariant & | defaultValue = QVariant() , |
||
bool | optional = false |
||
) |
Constructor for QgsProcessingParameterVectorLayer.
Definition at line 4133 of file qgsprocessingparameters.cpp.
|
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.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 4199 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 4145 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Creates a clone of the parameter definition.
Implements QgsProcessingParameterDefinition.
Definition at line 4140 of file qgsprocessingparameters.cpp.
|
overridevirtual |
This method needs to be reimplemented in all classes which implement this interface and return a file filter.
Implements QgsFileFilterGenerator.
Definition at line 4225 of file qgsprocessingparameters.cpp.
|
static |
Creates a new parameter using the definition from a script code.
Definition at line 4264 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 4252 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 4240 of file qgsprocessingparameters.cpp.
|
inlineoverridevirtual |
Unique parameter type name.
Implements QgsProcessingParameterDefinition.
Definition at line 2400 of file qgsprocessingparameters.h.
|
inlinestatic |
Returns the type name for the parameter class.
Definition at line 2398 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.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 4184 of file qgsprocessingparameters.cpp.