New name, for example new layer name dialog. More...

#include <qgsnewnamedialog.h>

Inheritance diagram for QgsNewNameDialog:

[legend]

Public Slots
void	nameChanged ()

Signals
void	newNameChanged ()
	Emitted when the name is changed in the dialog.

Public Member Functions
	QgsNewNameDialog (const QString &source=QString(), const QString &initial=QString(), const QStringList &extensions=QStringList(), const QStringList &existing=QStringList(), Qt::CaseSensitivity cs=Qt::CaseSensitive, QWidget *parent=nullptr, Qt::WindowFlags flags=QgsGuiUtils::ModalDialogFlags)
	New dialog constructor.

bool	allowEmptyName () const
	Returns `true` if the widget can be left empty (no name filled).

QString	conflictingNameWarning () const
	Returns the string used for warning users if a conflicting name exists.

QString	hintString () const
	Returns the hint string for the dialog (the text shown above the name input box).

QString	name () const
	Name entered by user.

bool	overwriteEnabled () const
	Returns whether users are permitted to overwrite existing names.

void	setAllowEmptyName (bool allowed)
	Sets whether users are permitted to leave the widget empty.

void	setConflictingNameWarning (const QString &string)
	Sets the string used for warning users if a conflicting name exists.

void	setHintString (const QString &hintString)
	Sets the hint string for the dialog (the text shown above the name input box).

void	setOverwriteEnabled (bool enabled)
	Sets whether users are permitted to overwrite existing names.

void	setRegularExpression (const QString &expression)
	Sets a regular expression to use for validating user-entered names in the dialog.

Public Member Functions inherited from QgsDialog
	QgsDialog (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags, QDialogButtonBox::StandardButtons buttons=QDialogButtonBox::Close, Qt::Orientation orientation=Qt::Horizontal)
	Constructor for QgsDialog.

QDialogButtonBox *	buttonBox ()
	Returns the button box.

QVBoxLayout *	layout ()
	Returns the central layout. Widgets added to it must have this dialog as parent.

Static Public Member Functions
static bool	exists (const QString &name, const QStringList &extensions, const QStringList &existing, Qt::CaseSensitivity cs=Qt::CaseSensitive)
	Test if name or name with at least one extension exists.

Protected Member Functions
QString	highlightText (const QString &text)

Static Protected Member Functions
static QStringList	fullNames (const QString &name, const QStringList &extensions)

static QStringList	matching (const QStringList &newNames, const QStringList &existingNames, Qt::CaseSensitivity cs=Qt::CaseSensitive)

Protected Attributes
bool	mAllowEmptyName = false

Qt::CaseSensitivity	mCaseSensitivity = Qt::CaseSensitive

QString	mConflictingNameWarning

QLabel *	mErrorLabel = nullptr

QStringList	mExiting

QStringList	mExtensions

QLabel *	mHintLabel = nullptr

QLineEdit *	mLineEdit = nullptr

QLabel *	mNamesLabel = nullptr
	List of names with extensions.

QString	mOkString

bool	mOverwriteEnabled = true

QRegularExpression	mRegularExpression

Protected Attributes inherited from QgsDialog
QDialogButtonBox *	mButtonBox = nullptr

QVBoxLayout *	mLayout = nullptr

Detailed Description

New name, for example new layer name dialog.

If existing names are provided, the dialog warns users if an entered name already exists.

Definition at line 32 of file qgsnewnamedialog.h.

Constructor & Destructor Documentation

◆ QgsNewNameDialog()

QgsNewNameDialog::QgsNewNameDialog	(	const QString &	source = `QString()`,
		const QString &	initial = `QString()`,
		const QStringList &	extensions = `QStringList()`,
		const QStringList &	existing = `QStringList()`,
		Qt::CaseSensitivity	cs = `Qt::CaseSensitive`,
		QWidget *	parent = `nullptr`,
		Qt::WindowFlags	flags = `QgsGuiUtils::ModalDialogFlags`
	)

New dialog constructor.

Parameters

source	original data source name, e.g. original layer name of the layer to be copied
initial	initial name
extensions	base name extensions, e.g. raster base name band extensions or vector layer type extensions
existing	existing names
cs	case sensitivity for new name to existing names comparison
parent	parent widget
flags	window flags

Note: Earlier versions had a similar constructor but with extra arguments for regexp which were removed in QGIS 3.22 as they relied on the deprecated QRegExp class. Use setRegularExpression() instead.

Since: QGIS 3.22

Definition at line 27 of file qgsnewnamedialog.cpp.

Member Function Documentation

◆ allowEmptyName()

bool QgsNewNameDialog::allowEmptyName ( ) const

inline

Returns true if the widget can be left empty (no name filled).

See also: setAllowEmptyName()

Since: QGIS 3.14

Definition at line 92 of file qgsnewnamedialog.h.

◆ conflictingNameWarning()

QString QgsNewNameDialog::conflictingNameWarning ( ) const

inline

Returns the string used for warning users if a conflicting name exists.

See also: setConflictingNameWarning()

Definition at line 105 of file qgsnewnamedialog.h.

◆ exists()

bool QgsNewNameDialog::exists	(	const QString &	name,
		const QStringList &	extensions,
		const QStringList &	existing,
		Qt::CaseSensitivity	cs = `Qt::CaseSensitive`
	)

static

Test if name or name with at least one extension exists.

Parameters

name	name or base name
extensions	base name extensions
existing	existing names
cs	case sensitivity for new name to existing names comparison

Returns: true if name exists

Definition at line 212 of file qgsnewnamedialog.cpp.

◆ fullNames()

QStringList QgsNewNameDialog::fullNames	(	const QString &	name,
		const QStringList &	extensions
	)

staticprotected

Definition at line 178 of file qgsnewnamedialog.cpp.

◆ highlightText()

QString QgsNewNameDialog::highlightText ( const QString & text )

protected

Definition at line 121 of file qgsnewnamedialog.cpp.

◆ hintString()

QString QgsNewNameDialog::hintString ( ) const

Returns the hint string for the dialog (the text shown above the name input box).

See also: setHintString()

Definition at line 82 of file qgsnewnamedialog.cpp.

◆ matching()

QStringList QgsNewNameDialog::matching	(	const QStringList &	newNames,
		const QStringList &	existingNames,
		Qt::CaseSensitivity	cs = `Qt::CaseSensitive`
	)

staticprotected

Definition at line 193 of file qgsnewnamedialog.cpp.

◆ name()

QString QgsNewNameDialog::name ( ) const

Name entered by user.

Returns: new name

See also: newNameChanged()

Definition at line 173 of file qgsnewnamedialog.cpp.

◆ nameChanged

void QgsNewNameDialog::nameChanged ( )

slot

Definition at line 126 of file qgsnewnamedialog.cpp.

◆ newNameChanged

void QgsNewNameDialog::newNameChanged ( )

signal

Emitted when the name is changed in the dialog.

Since: QGIS 3.2

◆ overwriteEnabled()

bool QgsNewNameDialog::overwriteEnabled ( ) const

inline

Returns whether users are permitted to overwrite existing names.

See also: setOverwriteEnabled()

Definition at line 77 of file qgsnewnamedialog.h.

◆ setAllowEmptyName()

void QgsNewNameDialog::setAllowEmptyName ( bool allowed )

Sets whether users are permitted to leave the widget empty.

If true, the dialog will accept an empty name value.

See also: allowEmptyName()

Since: QGIS 3.14

Definition at line 93 of file qgsnewnamedialog.cpp.

◆ setConflictingNameWarning()

void QgsNewNameDialog::setConflictingNameWarning ( const QString & string )

Sets the string used for warning users if a conflicting name exists.

Parameters

string warning string. If empty a default warning string will be used.

See also: conflictingNameWarning()

Definition at line 99 of file qgsnewnamedialog.cpp.

◆ setHintString()

void QgsNewNameDialog::setHintString ( const QString & hintString )

Sets the hint string for the dialog (the text shown above the name input box).

Parameters

hintString hint text

See also: hintString()

Definition at line 77 of file qgsnewnamedialog.cpp.

◆ setOverwriteEnabled()

void QgsNewNameDialog::setOverwriteEnabled ( bool enabled )

Sets whether users are permitted to overwrite existing names.

If true, then the dialog will reflect that the new name will overwrite an existing name. If false, then the dialog will not accept names which already exist.

See also: overwriteEnabled()

Definition at line 87 of file qgsnewnamedialog.cpp.

◆ setRegularExpression()

void QgsNewNameDialog::setRegularExpression ( const QString & expression )

Sets a regular expression to use for validating user-entered names in the dialog.

Since: QGIS 3.22

Definition at line 105 of file qgsnewnamedialog.cpp.

Member Data Documentation

◆ mAllowEmptyName

bool QgsNewNameDialog::mAllowEmptyName = false

protected

Definition at line 156 of file qgsnewnamedialog.h.

◆ mCaseSensitivity

Qt::CaseSensitivity QgsNewNameDialog::mCaseSensitivity = Qt::CaseSensitive

protected

Definition at line 147 of file qgsnewnamedialog.h.

◆ mConflictingNameWarning

QString QgsNewNameDialog::mConflictingNameWarning

protected

Definition at line 157 of file qgsnewnamedialog.h.

◆ mErrorLabel

QLabel* QgsNewNameDialog::mErrorLabel = nullptr

protected

Definition at line 152 of file qgsnewnamedialog.h.

◆ mExiting

QStringList QgsNewNameDialog::mExiting

protected

Definition at line 145 of file qgsnewnamedialog.h.

◆ mExtensions

QStringList QgsNewNameDialog::mExtensions

protected

Definition at line 146 of file qgsnewnamedialog.h.

◆ mHintLabel

QLabel* QgsNewNameDialog::mHintLabel = nullptr

protected

Definition at line 148 of file qgsnewnamedialog.h.

◆ mLineEdit

QLineEdit* QgsNewNameDialog::mLineEdit = nullptr

protected

Definition at line 149 of file qgsnewnamedialog.h.

◆ mNamesLabel

QLabel* QgsNewNameDialog::mNamesLabel = nullptr

protected

List of names with extensions.

Definition at line 151 of file qgsnewnamedialog.h.

◆ mOkString

QString QgsNewNameDialog::mOkString

protected

Definition at line 153 of file qgsnewnamedialog.h.

◆ mOverwriteEnabled

bool QgsNewNameDialog::mOverwriteEnabled = true

protected

Definition at line 155 of file qgsnewnamedialog.h.

◆ mRegularExpression

QRegularExpression QgsNewNameDialog::mRegularExpression

protected

Definition at line 154 of file qgsnewnamedialog.h.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgsnewnamedialog.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgsnewnamedialog.cpp

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ QgsNewNameDialog()

Member Function Documentation

◆ allowEmptyName()

◆ conflictingNameWarning()

◆ exists()

◆ fullNames()

◆ highlightText()

◆ hintString()

◆ matching()

◆ name()

◆ nameChanged

◆ newNameChanged

◆ overwriteEnabled()

◆ setAllowEmptyName()

◆ setConflictingNameWarning()

◆ setHintString()

◆ setOverwriteEnabled()

◆ setRegularExpression()

Member Data Documentation

◆ mAllowEmptyName

◆ mCaseSensitivity

◆ mConflictingNameWarning

◆ mErrorLabel

◆ mExiting

◆ mExtensions

◆ mHintLabel

◆ mLineEdit

◆ mNamesLabel

◆ mOkString

◆ mOverwriteEnabled

◆ mRegularExpression