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.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsSubstitutionListWidget

Base classes

QgsPanelWidget

Base class for any widget that can be shown as an inline panel.

QWidget

QObject

QPaintDevice

class qgis.gui.QgsSubstitutionListWidget[source]

Bases: QgsPanelWidget

__init__(parent: QWidget | None = None)

Constructor for QgsSubstitutionListWidget.

Parameters:

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

setSubstitutions(self, substitutions: QgsStringReplacementCollection)[source]

Sets the list of substitutions to show in the widget.

Parameters:

substitutions (QgsStringReplacementCollection) – substitution list

See also

substitutions()

substitutions(self) QgsStringReplacementCollection[source]

Returns the list of substitutions currently defined by the widget.

Return type:

QgsStringReplacementCollection

signal substitutionsChanged[source]

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.