QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
Public Slots | Signals | Public Member Functions | List of all members
QgsAuthConfigSelect Class Reference

Selector widget for authentication configs. More...

#include <qgsauthconfigselect.h>

Inheritance diagram for QgsAuthConfigSelect:
Inheritance graph
[legend]

Public Slots

void clearMessage ()
 Clear and hide small message bar. More...
 
void showMessage (const QString &msg)
 Show a small message bar with a close button. More...
 

Signals

void selectedConfigIdChanged (const QString &authcfg)
 Emitted when authentication config is changed or missing. More...
 
void selectedConfigIdRemoved (const QString &authcfg)
 Emitted when authentication config is removed. More...
 

Public Member Functions

 QgsAuthConfigSelect (QWidget *parent=nullptr, const QString &dataprovider=QString())
 Create a dialog for setting an associated authentication config, either from existing configs, or creating/removing them from auth database. More...
 
const QString configId () const
 Gets the authentication config id for the resource. More...
 
void setConfigId (const QString &authcfg)
 Sets the authentication config id for the resource. More...
 
void setDataProviderKey (const QString &key)
 Sets key of layer provider, if applicable. More...
 

Detailed Description

Selector widget for authentication configs.

Definition at line 33 of file qgsauthconfigselect.h.

Constructor & Destructor Documentation

◆ QgsAuthConfigSelect()

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

Create a dialog for setting an associated authentication config, either from existing configs, or creating/removing them from auth database.

Parameters
parentParent widget
dataproviderThe key of the calling layer provider, if applicable

Definition at line 34 of file qgsauthconfigselect.cpp.

Member Function Documentation

◆ clearMessage

void QgsAuthConfigSelect::clearMessage ( )
slot

Clear and hide small message bar.

Definition at line 187 of file qgsauthconfigselect.cpp.

◆ configId()

const QString QgsAuthConfigSelect::configId ( ) const
inline

Gets the authentication config id for the resource.

Definition at line 51 of file qgsauthconfigselect.h.

◆ selectedConfigIdChanged

void QgsAuthConfigSelect::selectedConfigIdChanged ( const QString &  authcfg)
signal

Emitted when authentication config is changed or missing.

◆ selectedConfigIdRemoved

void QgsAuthConfigSelect::selectedConfigIdRemoved ( const QString &  authcfg)
signal

Emitted when authentication config is removed.

◆ setConfigId()

void QgsAuthConfigSelect::setConfigId ( const QString &  authcfg)

Sets the authentication config id for the resource.

Definition at line 75 of file qgsauthconfigselect.cpp.

◆ setDataProviderKey()

void QgsAuthConfigSelect::setDataProviderKey ( const QString &  key)

Sets key of layer provider, if applicable.

Definition at line 97 of file qgsauthconfigselect.cpp.

◆ showMessage

void QgsAuthConfigSelect::showMessage ( const QString &  msg)
slot

Show a small message bar with a close button.

Definition at line 177 of file qgsauthconfigselect.cpp.


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