QgsSubstitutionListWidget class

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

Base classes

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

Constructors, destructors, conversion operators

QgsSubstitutionListWidget(QWidget* parent = nullptr)
Constructor for QgsSubstitutionListWidget.

Public functions

void setSubstitutions(const QgsStringReplacementCollection& substitutions)
Sets the list of substitutions to show in the widget.
auto substitutions() const -> QgsStringReplacementCollection
Returns the list of substitutions currently defined by the widget.

Signals

void substitutionsChanged(const QgsStringReplacementCollection& substitutions)
Emitted when the substitution definitions change.

Function documentation

QgsSubstitutionListWidget::QgsSubstitutionListWidget(QWidget* parent = nullptr)

Constructor for QgsSubstitutionListWidget.

Parameters
parent parent widget

void QgsSubstitutionListWidget::setSubstitutions(const QgsStringReplacementCollection& substitutions)

Sets the list of substitutions to show in the widget.

Parameters
substitutions substitution list

QgsStringReplacementCollection QgsSubstitutionListWidget::substitutions() const

Returns the list of substitutions currently defined by the widget.