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

#include <qgssubstitutionlistwidget.h>

Inheritance diagram for QgsSubstitutionListWidget:

[legend]

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

Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.

void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.

void	widgetChanged ()
	Emitted when the widget state changes.

Public Member Functions
	QgsSubstitutionListWidget (QWidget *parent=nullptr)
	Constructor for QgsSubstitutionListWidget.

void	setSubstitutions (const QgsStringReplacementCollection &substitutions)
	Sets the list of substitutions to show in the widget.

QgsStringReplacementCollection	substitutions () const
	Returns the list of substitutions currently defined by the widget.

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel.

virtual bool	applySizeConstraintsToStack () const
	Returns `true` if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.

bool	autoDelete ()
	The the auto delete property on the widget.

void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user.

bool	dockMode ()
	Returns the dock mode state.

virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or `nullptr` if no menu button is required.

virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.

QString	panelTitle ()
	The title of the panel.

void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.

virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.

Properties
QgsStringReplacementCollection	substitutions

Additional Inherited Members
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.

void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is `true` this method will emit the showPanel signal for connected slots to handle the open event.

Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Detailed Description

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

Definition at line 35 of file qgssubstitutionlistwidget.h.

Constructor & Destructor Documentation

◆ QgsSubstitutionListWidget()

QgsSubstitutionListWidget::QgsSubstitutionListWidget ( QWidget * parent = nullptr )

Constructor for QgsSubstitutionListWidget.

Parameters

parent parent widget

Definition at line 30 of file qgssubstitutionlistwidget.cpp.

Member Function Documentation

◆ setSubstitutions()

void QgsSubstitutionListWidget::setSubstitutions ( const QgsStringReplacementCollection & substitutions )

Sets the list of substitutions to show in the widget.

Parameters

substitutions substitution list

See also: substitutions()

Definition at line 43 of file qgssubstitutionlistwidget.cpp.

◆ substitutions()

QgsStringReplacementCollection QgsSubstitutionListWidget::substitutions ( ) const

Returns the list of substitutions currently defined by the widget.

See also: setSubstitutions()

Definition at line 55 of file qgssubstitutionlistwidget.cpp.

◆ substitutionsChanged

void QgsSubstitutionListWidget::substitutionsChanged ( const QgsStringReplacementCollection & substitutions )

signal

Emitted when the substitution definitions change.

Property Documentation

◆ substitutions

QgsStringReplacementCollection QgsSubstitutionListWidget::substitutions

readwrite

Definition at line 38 of file qgssubstitutionlistwidget.h.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/qgssubstitutionlistwidget.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/qgssubstitutionlistwidget.cpp

Signals

Public Member Functions

Properties

Additional Inherited Members