QGIS API Documentation  3.6.0-Noosa (5873452)
Public Member Functions | Properties | List of all members
QgsSubstitutionListDialog Class Reference

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

Public Member Functions

 QgsSubstitutionListDialog (QWidget *parent=nullptr)
 Constructor for QgsSubstitutionListDialog. More...
 
void setSubstitutions (const QgsStringReplacementCollection &substitutions)
 Sets the list of substitutions to show in the dialog. More...
 
QgsStringReplacementCollection substitutions () const
 Returns the list of substitutions currently defined by the dialog. More...
 

Properties

QgsStringReplacementCollection substitutions
 

Detailed Description

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

See also
QgsSubstitutionListWidget
Since
QGIS 3.0

Definition at line 89 of file qgssubstitutionlistwidget.h.

Constructor & Destructor Documentation

◆ QgsSubstitutionListDialog()

QgsSubstitutionListDialog::QgsSubstitutionListDialog ( QWidget *  parent = nullptr)

Constructor for QgsSubstitutionListDialog.

Parameters
parentparent widget

Definition at line 211 of file qgssubstitutionlistwidget.cpp.

Member Function Documentation

◆ setSubstitutions()

void QgsSubstitutionListDialog::setSubstitutions ( const QgsStringReplacementCollection substitutions)

Sets the list of substitutions to show in the dialog.

Parameters
substitutionssubstitution list
See also
substitutions()

Definition at line 226 of file qgssubstitutionlistwidget.cpp.

◆ substitutions()

QgsStringReplacementCollection QgsSubstitutionListDialog::substitutions ( ) const

Returns the list of substitutions currently defined by the dialog.

See also
setSubstitutions()

Property Documentation

◆ substitutions

QgsStringReplacementCollection QgsSubstitutionListDialog::substitutions
readwrite

Definition at line 92 of file qgssubstitutionlistwidget.h.


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