QGIS API Documentation  3.17.0-Master (a84647cf30)
Signals | Public Member Functions | Properties | List of all members
QgsSubstitutionListWidget Class Reference

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:
Inheritance graph
[legend]

Signals

void substitutionsChanged (const QgsStringReplacementCollection &substitutions)
 Emitted when the substitution definitions change. More...
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user. More...
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface. More...
 
void widgetChanged ()
 Emitted when the widget state changes. More...
 

Public Member Functions

 QgsSubstitutionListWidget (QWidget *parent=nullptr)
 Constructor for QgsSubstitutionListWidget. More...
 
void setSubstitutions (const QgsStringReplacementCollection &substitutions)
 Sets the list of substitutions to show in the widget. More...
 
QgsStringReplacementCollection substitutions () const
 Returns the list of substitutions currently defined by the widget. More...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as a inline panel. More...
 
bool autoDelete ()
 The the auto delete property on the widget. More...
 
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. More...
 
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. More...
 
bool dockMode ()
 Returns the dock mode state. More...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Properties

QgsStringReplacementCollection substitutions
 

Additional Inherited Members

- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel. More...
 
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. More...
 
- Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget. More...
 

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
Since
QGIS 3.0

Definition at line 36 of file qgssubstitutionlistwidget.h.

Constructor & Destructor Documentation

◆ QgsSubstitutionListWidget()

QgsSubstitutionListWidget::QgsSubstitutionListWidget ( QWidget *  parent = nullptr)

Constructor for QgsSubstitutionListWidget.

Parameters
parentparent widget

Definition at line 29 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
substitutionssubstitution list
See also
substitutions()

Definition at line 42 of file qgssubstitutionlistwidget.cpp.

◆ substitutions()

QgsStringReplacementCollection QgsSubstitutionListWidget::substitutions ( ) const

Returns the list of substitutions currently defined by the widget.

See also
setSubstitutions()

◆ substitutionsChanged

void QgsSubstitutionListWidget::substitutionsChanged ( const QgsStringReplacementCollection substitutions)
signal

Emitted when the substitution definitions change.

Property Documentation

◆ substitutions

QgsStringReplacementCollection QgsSubstitutionListWidget::substitutions
readwrite

Definition at line 39 of file qgssubstitutionlistwidget.h.


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