QGIS API Documentation 3.37.0-Master (4ace69f83af)
Loading...
Searching...
No Matches
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.
 
void setSubstitutions (const QgsStringReplacementCollection &substitutions)
 Sets the list of substitutions to show in the dialog.
 
QgsStringReplacementCollection substitutions () const
 Returns the list of substitutions currently defined by the dialog.
 

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

Definition at line 87 of file qgssubstitutionlistwidget.h.

Constructor & Destructor Documentation

◆ QgsSubstitutionListDialog()

QgsSubstitutionListDialog::QgsSubstitutionListDialog ( QWidget *  parent = nullptr)

Constructor for QgsSubstitutionListDialog.

Parameters
parentparent widget

Definition at line 219 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 234 of file qgssubstitutionlistwidget.cpp.

◆ substitutions()

QgsStringReplacementCollection QgsSubstitutionListDialog::substitutions ( ) const

Returns the list of substitutions currently defined by the dialog.

See also
setSubstitutions()

Definition at line 239 of file qgssubstitutionlistwidget.cpp.

Property Documentation

◆ substitutions

QgsStringReplacementCollection QgsSubstitutionListDialog::substitutions
readwrite

Definition at line 90 of file qgssubstitutionlistwidget.h.


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