QgsAuthConfigIdEdit Class Reference

Custom widget for editing an authentication configuration ID. More...

#include <qgsauthconfigidedit.h>

Inheritance diagram for QgsAuthConfigIdEdit:

Public Slots
void	clear ()
	Clear all of the widget's editing state and contents. More...
void	setAllowEmptyId (bool allowed)
	Sets whether to allow no ID to be set. More...
void	setAuthConfigId (const QString &authcfg)
	Sets the authentication configuration ID, storing it, and validating the passed value. More...

Signals
void	validityChanged (bool valid)
	Validity of the ID has changed. More...

Public Member Functions
	QgsAuthConfigIdEdit (QWidget *parent=nullptr, const QString &authcfg=QString(), bool allowEmpty=true)
	Widget to unlock and edit an authentication configuration ID. More...
bool	allowEmptyId ()
	Whether to allow no ID to be set. More...
QString const	configId ()
	The authentication configuration ID, if valid, otherwise null QString. More...
bool	validate ()
	Validate the widget state and ID. More...

Detailed Description

Custom widget for editing an authentication configuration ID.

Note

Validates the input against the database and for ID's 7-character alphanumeric syntax

not available in Python bindings

Definition at line 33 of file qgsauthconfigidedit.h.

Constructor & Destructor Documentation

QgsAuthConfigIdEdit()

QgsAuthConfigIdEdit::QgsAuthConfigIdEdit ( QWidget *  parent = nullptr, const QString &  authcfg = QString(), bool  allowEmpty = true  )

explicit

Widget to unlock and edit an authentication configuration ID.

Parameters

parent	Parent widget
authcfg	Authentication configuration ID
allowEmpty	Whether to allow no ID to be set, even when editing, e.g. Add config functions

Definition at line 27 of file qgsauthconfigidedit.cpp.

Member Function Documentation

allowEmptyId()

bool QgsAuthConfigIdEdit::allowEmptyId ( )

inline

Whether to allow no ID to be set.

Definition at line 51 of file qgsauthconfigidedit.h.

clear

void QgsAuthConfigIdEdit::clear ( )

slot

Clear all of the widget's editing state and contents.

Definition at line 89 of file qgsauthconfigidedit.cpp.

configId()

const QString QgsAuthConfigIdEdit::configId

(

)

The authentication configuration ID, if valid, otherwise null QString.

Definition at line 44 of file qgsauthconfigidedit.cpp.

setAllowEmptyId

void QgsAuthConfigIdEdit::setAllowEmptyId ( bool  allowed )

slot

Sets whether to allow no ID to be set.

Definition at line 83 of file qgsauthconfigidedit.cpp.

setAuthConfigId

void QgsAuthConfigIdEdit::setAuthConfigId ( const QString &  authcfg )

slot

Sets the authentication configuration ID, storing it, and validating the passed value.

Definition at line 73 of file qgsauthconfigidedit.cpp.

validate()

bool QgsAuthConfigIdEdit::validate

(

)

Validate the widget state and ID.

Definition at line 53 of file qgsauthconfigidedit.cpp.

validityChanged

void QgsAuthConfigIdEdit::validityChanged ( bool  valid )

signal

Validity of the ID has changed.

---

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

• /build/qgis-3.28.0+99sid/src/gui/auth/qgsauthconfigidedit.h
• /build/qgis-3.28.0+99sid/src/gui/auth/qgsauthconfigidedit.cpp