QGIS API Documentation
3.0.2-Girona (307d082)
|
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>
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 () |
Return the dock mode state. 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 QgsPanelWidget * | findParentPanel (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... | |
A widget which allows users to specify a list of substitutions to apply to a string, with options for exporting and importing substitution lists.
Definition at line 36 of file qgssubstitutionlistwidget.h.
QgsSubstitutionListWidget::QgsSubstitutionListWidget | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsSubstitutionListWidget.
parent | parent widget |
Definition at line 27 of file qgssubstitutionlistwidget.cpp.
void QgsSubstitutionListWidget::setSubstitutions | ( | const QgsStringReplacementCollection & | substitutions | ) |
Sets the list of substitutions to show in the widget.
substitutions | substitution list |
Definition at line 38 of file qgssubstitutionlistwidget.cpp.
QgsStringReplacementCollection QgsSubstitutionListWidget::substitutions | ( | ) | const |
Returns the list of substitutions currently defined by the widget.
|
signal |
Emitted when the substitution definitions change.
|
readwrite |
Definition at line 39 of file qgssubstitutionlistwidget.h.