QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgsprocessingparameters.h>
Public Member Functions | |
QgsProcessingParameterDatabaseTable (const QString &name, const QString &description, const QString &connectionParameterName=QString(), const QString &schemaParameterName=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, bool allowNewTableNames=false) | |
Constructor for QgsProcessingParameterDatabaseTable. More... | |
bool | allowNewTableNames () const |
Returns true if the parameter allows users to enter names for a new (non-existing) tables. 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... | |
QgsProcessingParameterDefinition * | clone () const override |
Creates a clone of the parameter definition. 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 | parentConnectionParameterName () const |
Returns the name of the parent connection parameter, or an empty string if this is not set. More... | |
QString | parentSchemaParameterName () const |
Returns the name of the parent schema parameter, or an empty string if this is not set. More... | |
void | setAllowNewTableNames (bool allowed) |
Sets whether the parameter allows users to enter names for a new (non-existing) tables. More... | |
void | setParentConnectionParameterName (const QString &name) |
Sets the name of the parent connection parameter. More... | |
void | setParentSchemaParameterName (const QString &name) |
Sets the name of the parent schema 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... | |
![]() | |
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... | |
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 () |
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... | |
Static Public Member Functions | |
static QgsProcessingParameterDatabaseTable * | 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... | |
A database table name parameter for processing algorithms, allowing users to select from existing database tables on a registered database connection (or optionally to enter a new table name).
QgsProcessingParameterDatabaseTable should be evaluated by calling QgsProcessingAlgorithm::parameterAsDatabaseTableName().
Definition at line 3740 of file qgsprocessingparameters.h.
QgsProcessingParameterDatabaseTable::QgsProcessingParameterDatabaseTable | ( | const QString & | name, |
const QString & | description, | ||
const QString & | connectionParameterName = QString() , |
||
const QString & | schemaParameterName = QString() , |
||
const QVariant & | defaultValue = QVariant() , |
||
bool | optional = false , |
||
bool | allowNewTableNames = false |
||
) |
Constructor for QgsProcessingParameterDatabaseTable.
The connectionParameterName specifies the name of the parent QgsProcessingParameterProviderConnection parameter. The schemaParameterName specifies the name of the parent QgsProcessingParameterDatabaseSchema parameter.
Definition at line 7204 of file qgsprocessingparameters.cpp.
bool QgsProcessingParameterDatabaseTable::allowNewTableNames | ( | ) | const |
Returns true
if the parameter allows users to enter names for a new (non-existing) tables.
Definition at line 7355 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 7259 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Returns the parameter definition encoded in a string which can be used within a Processing script.
Reimplemented from QgsProcessingParameterDefinition.
Definition at line 7245 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 7222 of file qgsprocessingparameters.cpp.
|
overridevirtual |
Creates a clone of the parameter definition.
Implements QgsProcessingParameterDefinition.
Definition at line 7217 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 7285 of file qgsprocessingparameters.cpp.
|
static |
Creates a new parameter using the definition from a script code.
Definition at line 7333 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 7324 of file qgsprocessingparameters.cpp.
QString QgsProcessingParameterDatabaseTable::parentConnectionParameterName | ( | ) | const |
Returns the name of the parent connection parameter, or an empty string if this is not set.
Definition at line 7295 of file qgsprocessingparameters.cpp.
QString QgsProcessingParameterDatabaseTable::parentSchemaParameterName | ( | ) | const |
Returns the name of the parent schema parameter, or an empty string if this is not set.
Definition at line 7305 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterDatabaseTable::setAllowNewTableNames | ( | bool | allowed | ) |
Sets whether the parameter allows users to enter names for a new (non-existing) tables.
Definition at line 7360 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterDatabaseTable::setParentConnectionParameterName | ( | const QString & | name | ) |
Sets the name of the parent connection parameter.
Use an empty string if this is not required.
Definition at line 7300 of file qgsprocessingparameters.cpp.
void QgsProcessingParameterDatabaseTable::setParentSchemaParameterName | ( | const QString & | name | ) |
Sets the name of the parent schema parameter.
Use an empty string if this is not required.
Definition at line 7310 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 7315 of file qgsprocessingparameters.cpp.
|
inlineoverridevirtual |
Unique parameter type name.
Implements QgsProcessingParameterDefinition.
Definition at line 3765 of file qgsprocessingparameters.h.
|
inlinestatic |
Returns the type name for the parameter class.
Definition at line 3763 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 7234 of file qgsprocessingparameters.cpp.