QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
Public Types | Signals | Public Member Functions | List of all members
QgsAuthConfigEdit Class Reference

Widget for editing an authentication configuration. More...

#include <qgsauthconfigedit.h>

Inheritance diagram for QgsAuthConfigEdit:
Inheritance graph
[legend]

Public Types

enum  Validity { Valid , Invalid , Unknown }
 Type of configuration validity. More...
 

Signals

void authenticationConfigStored (const QString &authcfg)
 Emit generated id when a new config is saved to auth database. More...
 
void authenticationConfigUpdated (const QString &authcfg)
 Emit current id when an existing config is updated in auth database. More...
 

Public Member Functions

 QgsAuthConfigEdit (QWidget *parent=nullptr, const QString &authcfg=QString(), const QString &dataprovider=QString())
 Create a dialog for editing an authentication configuration. More...
 
const QString configId () const
 Authentication config id, updated with generated id when a new config is saved to auth database. More...
 

Detailed Description

Widget for editing an authentication configuration.

Note
not available in Python bindings

Definition at line 36 of file qgsauthconfigedit.h.

Member Enumeration Documentation

◆ Validity

Type of configuration validity.

Enumerator
Valid 
Invalid 
Unknown 

Definition at line 42 of file qgsauthconfigedit.h.

Constructor & Destructor Documentation

◆ QgsAuthConfigEdit()

QgsAuthConfigEdit::QgsAuthConfigEdit ( QWidget *  parent = nullptr,
const QString &  authcfg = QString(),
const QString &  dataprovider = QString() 
)
explicit

Create a dialog for editing an authentication configuration.

Parameters
parentParent widget
authcfgAuthentication config id for a existing config in auth database
dataproviderThe provider origin of the edit, to allow for customized code and filtering

Definition at line 29 of file qgsauthconfigedit.cpp.

Member Function Documentation

◆ authenticationConfigStored

void QgsAuthConfigEdit::authenticationConfigStored ( const QString &  authcfg)
signal

Emit generated id when a new config is saved to auth database.

◆ authenticationConfigUpdated

void QgsAuthConfigEdit::authenticationConfigUpdated ( const QString &  authcfg)
signal

Emit current id when an existing config is updated in auth database.

◆ configId()

const QString QgsAuthConfigEdit::configId ( ) const
inline

Authentication config id, updated with generated id when a new config is saved to auth database.

Definition at line 59 of file qgsauthconfigedit.h.


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