QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsExpressionStoreDialog Class Reference

A generic dialog for editing expression text, label and help text. More...

#include <qgsexpressionstoredialog.h>

Inheritance diagram for QgsExpressionStoreDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsExpressionStoreDialog (const QString &label, const QString &expression, const QString &helpText, const QStringList &existingLabels=QStringList(), QWidget *parent=nullptr)
 Creates a QgsExpressionStoreDialog with given label, expression and helpText.
 
QString expression ()
 Returns the expression text.
 
QString helpText () const
 Returns the help text.
 
bool isLabelModified () const SIP_SKIP
 Returns whether the label text was modified either manually by the user, or automatically because it contained slashes or leading/trailing whitespace characters.
 
QString label ()
 Returns the label text.
 

Detailed Description

A generic dialog for editing expression text, label and help text.

Since
QGIS 3.12

Definition at line 29 of file qgsexpressionstoredialog.h.

Constructor & Destructor Documentation

◆ QgsExpressionStoreDialog()

QgsExpressionStoreDialog::QgsExpressionStoreDialog ( const QString &  label,
const QString &  expression,
const QString &  helpText,
const QStringList &  existingLabels = QStringList(),
QWidget *  parent = nullptr 
)

Creates a QgsExpressionStoreDialog with given label, expression and helpText.

existingLabels is an optional list of existing labels for unique label validation, parent is the optional parent widget.

Definition at line 21 of file qgsexpressionstoredialog.cpp.

Member Function Documentation

◆ expression()

QString QgsExpressionStoreDialog::expression ( )
inline

Returns the expression text.

Definition at line 43 of file qgsexpressionstoredialog.h.

◆ helpText()

QString QgsExpressionStoreDialog::helpText ( ) const

Returns the help text.

Definition at line 63 of file qgsexpressionstoredialog.cpp.

◆ isLabelModified()

bool QgsExpressionStoreDialog::isLabelModified ( ) const
inline

Returns whether the label text was modified either manually by the user, or automatically because it contained slashes or leading/trailing whitespace characters.

Definition at line 59 of file qgsexpressionstoredialog.h.

◆ label()

QString QgsExpressionStoreDialog::label ( )
inline

Returns the label text.

Definition at line 48 of file qgsexpressionstoredialog.h.


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