QGIS API Documentation
3.0.2-Girona (307d082)
|
A parameter for processing algorithms which accepts multiple map layers. More...
#include <qgsprocessingparameters.h>
Public Member Functions | |
QgsProcessingParameterMultipleLayers (const QString &name, const QString &description=QString(), QgsProcessing::SourceType layerType=QgsProcessing::TypeVectorAnyGeometry, const QVariant &defaultValue=QVariant(), bool optional=false) | |
Constructor for QgsProcessingParameterMultipleLayers. 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... | |
bool | fromVariantMap (const QVariantMap &map) override |
Restores this parameter to a QVariantMap. More... | |
QgsProcessing::SourceType | layerType () const |
Returns the layer type for layers acceptable by the parameter. More... | |
int | minimumNumberInputs () const |
Returns the minimum number of layers required for the parameter. More... | |
void | setLayerType (QgsProcessing::SourceType type) |
Sets the layer type for layers acceptable by the parameter. More... | |
void | setMinimumNumberInputs (int minimum) |
Sets the minimum number of layers required for the 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... | |
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 () 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 QgsProcessingParameterMultipleLayers * | 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 | |
Public Types inherited from QgsProcessingParameterDefinition | |
enum | Flag { FlagAdvanced = 1 << 1, FlagHidden = 1 << 2, FlagOptional = 1 << 3 } |
Parameter flags. More... | |
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 parameter for processing algorithms which accepts multiple map layers.
Definition at line 1085 of file qgsprocessingparameters.h.
QgsProcessingParameterMultipleLayers::QgsProcessingParameterMultipleLayers | ( | const QString & | name, |
const QString & | description = QString() , |
||
QgsProcessing::SourceType | layerType = QgsProcessing::TypeVectorAnyGeometry , |
||
const QVariant & | defaultValue = QVariant() , |
||
bool | optional = false |
||
) |
Constructor for QgsProcessingParameterMultipleLayers.
Definition at line 1790 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 1888 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 1802 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Creates a clone of the parameter definition.
Implements QgsProcessingParameterDefinition.
Definition at line 1797 of file qgsprocessingparameters.cpp.
|
static |
Creates a new parameter using the definition from a script code.
Definition at line 1965 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 1957 of file qgsprocessingparameters.cpp.
QgsProcessing::SourceType QgsProcessingParameterMultipleLayers::layerType | ( | ) | const |
Returns the layer type for layers acceptable by the parameter.
Definition at line 1928 of file qgsprocessingparameters.cpp.
int QgsProcessingParameterMultipleLayers::minimumNumberInputs | ( | ) | const |
Returns the minimum number of layers required for the parameter.
If the return value is < 1 then the parameter accepts any number of layers.
Definition at line 1938 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterMultipleLayers::setLayerType | ( | QgsProcessing::SourceType | type | ) |
Sets the layer type for layers acceptable by the parameter.
Definition at line 1933 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterMultipleLayers::setMinimumNumberInputs | ( | int | minimum | ) |
Sets the minimum number of layers required for the parameter.
The minimum must be >= 1 if the parameter is not optional.
Definition at line 1943 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 1949 of file qgsprocessingparameters.cpp.
|
inlineoverridevirtual |
Unique parameter type name.
Implements QgsProcessingParameterDefinition.
Definition at line 1101 of file qgsprocessingparameters.h.
|
inlinestatic |
Returns the type name for the parameter class.
Definition at line 1099 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 1867 of file qgsprocessingparameters.cpp.