QGIS API Documentation  3.4.15-Madeira (e83d02e274)
Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingParameterMatrix Class Reference

A table (matrix) parameter for processing algorithms. More...

#include <qgsprocessingparameters.h>

Inheritance diagram for QgsProcessingParameterMatrix:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingParameterMatrix (const QString &name, const QString &description=QString(), int numberRows=3, bool hasFixedNumberRows=false, const QStringList &headers=QStringList(), const QVariant &defaultValue=QVariant(), bool optional=false)
 Constructor for QgsProcessingParameterMatrix. 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...
 
bool fromVariantMap (const QVariantMap &map) override
 Restores this parameter to a QVariantMap. More...
 
bool hasFixedNumberRows () const
 Returns whether the table has a fixed number of rows. More...
 
QStringList headers () const
 Returns a list of column headers (if set). More...
 
int numberRows () const
 Returns the fixed number of rows in the table. More...
 
void setHasFixedNumberRows (bool hasFixedNumberRows)
 Sets whether the table has a fixed number of rows. More...
 
void setHeaders (const QStringList &headers)
 Sets the list of column headers. More...
 
void setNumberRows (int rows)
 Sets the fixed number of rows in the table. 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
 
QgsProcessingAlgorithmalgorithm () 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 Python 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 () 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 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 QgsProcessingParameterMatrixfromScriptCode (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, FlagIsModelOutput = 1 << 4 }
 Parameter flags. More...
 
- Protected Attributes inherited from QgsProcessingParameterDefinition
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 table (matrix) parameter for processing algorithms.

Since
QGIS 3.0

Definition at line 1210 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

QgsProcessingParameterMatrix::QgsProcessingParameterMatrix ( const QString &  name,
const QString &  description = QString(),
int  numberRows = 3,
bool  hasFixedNumberRows = false,
const QStringList &  headers = QStringList(),
const QVariant &  defaultValue = QVariant(),
bool  optional = false 
)

Constructor for QgsProcessingParameterMatrix.

Definition at line 2128 of file qgsprocessingparameters.cpp.

Member Function Documentation

bool QgsProcessingParameterMatrix::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 2142 of file qgsprocessingparameters.cpp.

QgsProcessingParameterDefinition * QgsProcessingParameterMatrix::clone ( ) const
overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

Definition at line 2137 of file qgsprocessingparameters.cpp.

QgsProcessingParameterMatrix * QgsProcessingParameterMatrix::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 2258 of file qgsprocessingparameters.cpp.

bool QgsProcessingParameterMatrix::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 2249 of file qgsprocessingparameters.cpp.

bool QgsProcessingParameterMatrix::hasFixedNumberRows ( ) const

Returns whether the table has a fixed number of rows.

See also
numberRows()
setHasFixedNumberRows()

Definition at line 2230 of file qgsprocessingparameters.cpp.

QStringList QgsProcessingParameterMatrix::headers ( ) const

Returns a list of column headers (if set).

See also
setHeaders()

Definition at line 2210 of file qgsprocessingparameters.cpp.

int QgsProcessingParameterMatrix::numberRows ( ) const

Returns the fixed number of rows in the table.

This parameter only has an effect if hasFixedNumberRows() is true.

See also
setNumberRows()
setHasFixedNumberRows()

Definition at line 2220 of file qgsprocessingparameters.cpp.

void QgsProcessingParameterMatrix::setHasFixedNumberRows ( bool  hasFixedNumberRows)

Sets whether the table has a fixed number of rows.

See also
setNumberRows()
hasFixedNumberRows()

Definition at line 2235 of file qgsprocessingparameters.cpp.

void QgsProcessingParameterMatrix::setHeaders ( const QStringList &  headers)

Sets the list of column headers.

See also
headers()

Definition at line 2215 of file qgsprocessingparameters.cpp.

void QgsProcessingParameterMatrix::setNumberRows ( int  rows)

Sets the fixed number of rows in the table.

This parameter only has an effect if hasFixedNumberRows() is true.

See also
numberRows()
setHasFixedNumberRows()

Definition at line 2225 of file qgsprocessingparameters.cpp.

QVariantMap QgsProcessingParameterMatrix::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 2240 of file qgsprocessingparameters.cpp.

QString QgsProcessingParameterMatrix::type ( ) const
inlineoverridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

Definition at line 1227 of file qgsprocessingparameters.h.

static QString QgsProcessingParameterMatrix::typeName ( )
inlinestatic

Returns the type name for the parameter class.

Definition at line 1225 of file qgsprocessingparameters.h.

QString QgsProcessingParameterMatrix::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 2167 of file qgsprocessingparameters.cpp.


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