QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
QgsProcessingParameterLayoutItem Class Reference

A print layout item parameter, allowing users to select a particular item from a print layout. More...

#include <qgsprocessingparameters.h>

Inheritance diagram for QgsProcessingParameterLayoutItem:
Inheritance graph
[legend]

Public Member Functions

 QgsProcessingParameterLayoutItem (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), const QString &parentLayoutParameterName=QString(), int itemType=-1, bool optional=false)
 Constructor for QgsProcessingParameterLayoutItem.
 
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.
 
QString asScriptCode () const override
 Returns the parameter definition encoded in a string which can be used within a Processing script.
 
QgsProcessingParameterDefinitionclone () const override
 Creates a clone of the parameter definition.
 
QStringList dependsOnOtherParameters () const override
 Returns a list of other parameter names on which this parameter is dependent (e.g.
 
bool fromVariantMap (const QVariantMap &map) override
 Restores this parameter to a QVariantMap.
 
int itemType () const
 Returns the acceptable item type, or -1 if any item type is allowed.
 
QString parentLayoutParameterName () const
 Returns the name of the parent layout parameter, or an empty string if this is not set.
 
void setItemType (int type)
 Sets the acceptable item type, or -1 if any item type is allowed.
 
void setParentLayoutParameterName (const QString &name)
 Sets the name of the parent layout parameter.
 
QVariantMap toVariantMap () const override
 Saves this parameter to a QVariantMap.
 
QString type () const override
 Unique parameter type name.
 
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.
 
- Public Member Functions inherited from QgsProcessingParameterDefinition
 QgsProcessingParameterDefinition (const QString &name, const QString &description=QString(), const QVariant &defaultValue=QVariant(), bool optional=false, const QString &help=QString())
 Constructor for QgsProcessingParameterDefinition.
 
virtual ~QgsProcessingParameterDefinition ()=default
 
QStringList additionalExpressionContextVariables () const
 Returns a list of additional expression context variables which are available for use when evaluating this parameter.
 
QgsProcessingAlgorithmalgorithm () const
 Returns a pointer to the algorithm which owns this parameter.
 
virtual bool checkValueIsAcceptable (const QVariant &input, QgsProcessingContext *context=nullptr) const
 Checks whether the specified input value is acceptable for the parameter.
 
QVariant defaultValue () const
 Returns the default value for the parameter.
 
QVariant defaultValueForGui () const
 Returns the default value to use for the parameter in a GUI.
 
QString description () const
 Returns the description for the parameter.
 
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.
 
QgsPropertyDefinition dynamicPropertyDefinition () const
 Returns the property definition for dynamic properties.
 
Flags flags () const
 Returns any flags associated with the parameter.
 
QVariant guiDefaultValueOverride () const
 Returns the default value to use in the GUI for the parameter.
 
QString help () const
 Returns the help for the parameter.
 
virtual bool isDestination () const
 Returns true if this parameter represents a file or layer destination, e.g.
 
bool isDynamic () const
 Returns true if the parameter supports is dynamic, and can support data-defined values (i.e.
 
QVariantMap & metadata ()
 Returns the parameter's freeform metadata.
 
QVariantMap metadata () const
 Returns the parameter's freeform metadata.
 
QString name () const
 Returns the name of the parameter.
 
QgsProcessingProviderprovider () const
 Returns a pointer to the provider for the algorithm which owns this parameter.
 
void setAdditionalExpressionContextVariables (const QStringList &variables)
 Sets a list of additional expression context variables which are available for use when evaluating this parameter.
 
void setDefaultValue (const QVariant &value)
 Sets the default value for the parameter.
 
void setDescription (const QString &description)
 Sets the description for the parameter.
 
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.
 
void setDynamicPropertyDefinition (const QgsPropertyDefinition &definition)
 Sets the property definition for dynamic properties.
 
void setFlags (Flags flags)
 Sets the flags associated with the parameter.
 
void setGuiDefaultValueOverride (const QVariant &value)
 Sets the default value to use for the parameter in GUI widgets.
 
void setHelp (const QString &help)
 Sets the help for the parameter.
 
void setIsDynamic (bool dynamic)
 Sets whether the parameter is dynamic, and can support data-defined values (i.e.
 
void setMetadata (const QVariantMap &metadata)
 Sets the parameter's freeform metadata.
 
void setName (const QString &name)
 Sets the name of the parameter.
 
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).
 
virtual QVariant valueAsJsonObject (const QVariant &value, QgsProcessingContext &context) const
 Returns a version of the parameter input value, which is suitable for use in a JSON object.
 
virtual QString valueAsPythonComment (const QVariant &value, QgsProcessingContext &context) const
 Returns a Python comment explaining a parameter value, or an empty string if no comment is required.
 
virtual QString valueAsString (const QVariant &value, QgsProcessingContext &context, bool &ok) const
 Returns a string version of the parameter input value (if possible).
 
virtual QStringList valueAsStringList (const QVariant &value, QgsProcessingContext &context, bool &ok) const
 Returns a string list version of the parameter input value (if possible).
 

Static Public Member Functions

static QgsProcessingParameterLayoutItemfromScriptCode (const QString &name, const QString &description, bool isOptional, const QString &definition)
 Creates a new parameter using the definition from a script code.
 
static QString typeName ()
 Returns the type name for the parameter class.
 

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...
 
enum class  ValueAsStringFlag : int { AllowMapLayerValues = 1 << 0 }
 Flags for passing to the valueAsStringPrivate() method. More...
 
- Protected Member Functions inherited from QgsProcessingParameterDefinition
QVariant defaultGuiValueFromSetting () const
 Default gui value for an algorithm parameter from settings.
 
QVariant valueAsJsonObjectPrivate (const QVariant &value, QgsProcessingContext &context, ValueAsStringFlags flags) const
 Internal method for evaluating values as JSON objects.
 
QString valueAsStringPrivate (const QVariant &value, QgsProcessingContext &context, bool &ok, ValueAsStringFlags flags) const
 Internal method for evaluating values as string.
 
- Protected Attributes inherited from QgsProcessingParameterDefinition
QStringList mAdditionalExpressionVariables
 Additional expression context variables exposed for use by this parameter.
 
QgsProcessingAlgorithmmAlgorithm = nullptr
 Pointer to algorithm which owns this parameter.
 
QVariant mDefault
 Default value for parameter.
 
QString mDescription
 Parameter description.
 
QString mDynamicLayerParameterName
 Linked vector layer parameter name for dynamic properties.
 
Flags mFlags
 Parameter flags.
 
QVariant mGuiDefault
 Default value for parameter in GUI.
 
QString mHelp
 Parameter help.
 
bool mIsDynamic = false
 True for dynamic parameters, which can have data-defined (QgsProperty) based values.
 
QVariantMap mMetadata
 Freeform metadata for parameter. Mostly used by widget wrappers to customize their appearance and behavior.
 
QString mName
 Parameter name.
 
QgsPropertyDefinition mPropertyDefinition
 Data defined property definition.
 

Detailed Description

A print layout item parameter, allowing users to select a particular item from a print layout.

QgsProcessingParameterLayoutItem should be evaluated by calling QgsProcessingAlgorithm::parameterAsLayoutItem(). Internally, QgsProcessingParameterLayoutItems are string parameters, storing references to items either by their UUID (QgsLayoutItem::uuid()) or ID (QgsLayoutItem::id()).

Since
QGIS 3.8

Definition at line 3783 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

◆ QgsProcessingParameterLayoutItem()

QgsProcessingParameterLayoutItem::QgsProcessingParameterLayoutItem ( const QString &  name,
const QString &  description = QString(),
const QVariant &  defaultValue = QVariant(),
const QString &  parentLayoutParameterName = QString(),
int  itemType = -1,
bool  optional = false 
)

Constructor for QgsProcessingParameterLayoutItem.

Definition at line 7822 of file qgsprocessingparameters.cpp.

Member Function Documentation

◆ asPythonString()

QString QgsProcessingParameterLayoutItem::asPythonString ( QgsProcessing::PythonOutputType  outputType = QgsProcessing::PythonQgsProcessingAlgorithmSubclass) const
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.

Since
QGIS 3.6

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 7862 of file qgsprocessingparameters.cpp.

◆ asScriptCode()

QString QgsProcessingParameterLayoutItem::asScriptCode ( ) const
overridevirtual

Returns the parameter definition encoded in a string which can be used within a Processing script.

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 7847 of file qgsprocessingparameters.cpp.

◆ clone()

QgsProcessingParameterDefinition * QgsProcessingParameterLayoutItem::clone ( ) const
overridevirtual

Creates a clone of the parameter definition.

Implements QgsProcessingParameterDefinition.

Definition at line 7830 of file qgsprocessingparameters.cpp.

◆ dependsOnOtherParameters()

QStringList QgsProcessingParameterLayoutItem::dependsOnOtherParameters ( ) const
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 7902 of file qgsprocessingparameters.cpp.

◆ fromScriptCode()

QgsProcessingParameterLayoutItem * QgsProcessingParameterLayoutItem::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 7910 of file qgsprocessingparameters.cpp.

◆ fromVariantMap()

bool QgsProcessingParameterLayoutItem::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 7894 of file qgsprocessingparameters.cpp.

◆ itemType()

int QgsProcessingParameterLayoutItem::itemType ( ) const

Returns the acceptable item type, or -1 if any item type is allowed.

These values correspond to the registered item types from QgsLayoutItemRegistry.

See also
setItemType()

Definition at line 7942 of file qgsprocessingparameters.cpp.

◆ parentLayoutParameterName()

QString QgsProcessingParameterLayoutItem::parentLayoutParameterName ( ) const

Returns the name of the parent layout parameter, or an empty string if this is not set.

See also
setParentLayoutParameterName()

Definition at line 7932 of file qgsprocessingparameters.cpp.

◆ setItemType()

void QgsProcessingParameterLayoutItem::setItemType ( int  type)

Sets the acceptable item type, or -1 if any item type is allowed.

These values correspond to the registered item types from QgsLayoutItemRegistry.

See also
itemType()

Definition at line 7947 of file qgsprocessingparameters.cpp.

◆ setParentLayoutParameterName()

void QgsProcessingParameterLayoutItem::setParentLayoutParameterName ( const QString &  name)

Sets the name of the parent layout parameter.

Use an empty string if this is not required.

See also
parentLayoutParameterName()

Definition at line 7937 of file qgsprocessingparameters.cpp.

◆ toVariantMap()

QVariantMap QgsProcessingParameterLayoutItem::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 7886 of file qgsprocessingparameters.cpp.

◆ type()

QString QgsProcessingParameterLayoutItem::type ( ) const
inlineoverridevirtual

Unique parameter type name.

Implements QgsProcessingParameterDefinition.

Definition at line 3800 of file qgsprocessingparameters.h.

◆ typeName()

static QString QgsProcessingParameterLayoutItem::typeName ( )
inlinestatic

Returns the type name for the parameter class.

Definition at line 3798 of file qgsprocessingparameters.h.

◆ valueAsPythonString()

QString QgsProcessingParameterLayoutItem::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.

See also
valueAsJsonObject()
valueAsString()

Reimplemented from QgsProcessingParameterDefinition.

Definition at line 7835 of file qgsprocessingparameters.cpp.


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