Class: QgsSubstitutionListWidget

A widget which allows users to specify a list of substitutions to apply to a string, with options for exporting and importing substitution lists.

See also

QgsSubstitutionListDialog

Class Hierarchy

Base classes

QgsPanelWidget	Base class for any widget that can be shown as an inline panel.
QWidget
QObject
QPaintDevice

Methods

setSubstitutions	Sets the list of substitutions to show in the widget.
substitutions	Returns the list of substitutions currently defined by the widget.

Signals

substitutionsChanged

Emitted when the substitution definitions change.

class qgis.gui.QgsSubstitutionListWidget

Bases: QgsPanelWidget

__init__(parent: QWidget | None = None)

Constructor for QgsSubstitutionListWidget.

Parameters:

parent (Optional[QWidget] = None) – parent widget

setSubstitutions(self, substitutions: QgsStringReplacementCollection)

Sets the list of substitutions to show in the widget.

Parameters:

substitutions (QgsStringReplacementCollection) – substitution list

See also

substitutions()

substitutions(self) → QgsStringReplacementCollection

Returns the list of substitutions currently defined by the widget.

See also

setSubstitutions()

Return type:

QgsStringReplacementCollection

signal substitutionsChanged(substitutions: QgsStringReplacementCollection)

Emitted when the substitution definitions change.

Parameters:

substitutions (QgsStringReplacementCollection)