QgsAuthConfigIdEdit class

Custom widget for editing an authentication configuration ID.

Contents

Constructors, destructors, conversion operators

QgsAuthConfigIdEdit(QWidget* parent = nullptr, const QString& authcfg = QString(), bool allowEmpty = true) explicit
Widget to unlock and edit an authentication configuration ID.

Public functions

auto allowEmptyId() -> bool
Whether to allow no ID to be set.
auto configId() -> QString const
The authentication configuration ID, if valid, otherwise null QString.
auto validate() -> bool
Validate the widget state and ID.

Signals

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

Public slots

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

Function documentation

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