Class: QgsProcessingModelComment

class qgis.core.QgsProcessingModelComment

Bases: QgsProcessingModelComponent

Represents a comment in a model.

New in version 3.14.

QgsProcessingModelComment(description: str = ‘’) Constructor for QgsProcessingModelComment with the specified description.

QgsProcessingModelComment(QgsProcessingModelComment)

Methods

clone

rtype

QgsProcessingModelComment

copyNonDefinitionProperties

Copies all non-specific definition properties from the other component definition.

loadVariant

Loads this comment from a QVariantMap.

restoreCommonProperties

Restores the component properties from a QVariantMap.

saveCommonProperties

Saves the component properties to a QVariantMap.

toVariant

Saves this comment to a QVariant.

clone(self)QgsProcessingModelComment
Return type

QgsProcessingModelComment

copyNonDefinitionProperties(self, other: QgsProcessingModelComponent)

Copies all non-specific definition properties from the other component definition.

This includes properties like the size and position of the component, but not properties like the specific algorithm or input details.

New in version 3.14.

loadVariant(self, map: Dict[str, Any])bool

Loads this comment from a QVariantMap.

See also

toVariant()

Parameters

map (Dict[str) –

Return type

bool

restoreCommonProperties(self, map: Dict[str, Any])

Restores the component properties from a QVariantMap.

saveCommonProperties(self, map: Dict[str, Any])

Saves the component properties to a QVariantMap.

toVariant(self)Any

Saves this comment to a QVariant.

See also

loadVariant()

Return type

Any