QGIS API Documentation 4.3.0-Master (c8cdfe19d7b)
Loading...
Searching...
No Matches
QgsAuthConfigSelect Class Reference

Selector widget for authentication configs. More...

#include <qgsauthconfigselect.h>

Inheritance diagram for QgsAuthConfigSelect:

Public Slots

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

Signals

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

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.
const QString configId () const
 Gets the authentication config id for the resource.
void setConfigId (const QString &authcfg)
 Sets the authentication config id for the resource.
void setDataProviderKey (const QString &key)
 Sets key of layer provider, if applicable.

Static Public Attributes

static const QgsSettingsEntryStringList * settingsDetailsNotDisplayedAuthStores = new QgsSettingsEntryStringList( u"detailsNotDisplayedAuthStores"_s, QgsSettingsTree::sTreeQgis, QStringList(), u"List of AuthStore ids where the details (e.g. user, pw) should not be displayed in the auth config select dialog"_s )
 Settings entry details not displayed auth stores.

Detailed Description

Selector widget for authentication configs.

Definition at line 35 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 45 of file qgsauthconfigselect.cpp.

Member Function Documentation

◆ clearMessage

void QgsAuthConfigSelect::clearMessage ( )
slot

Clear and hide small message bar.

Definition at line 199 of file qgsauthconfigselect.cpp.

◆ configId()

const QString QgsAuthConfigSelect::configId ( ) const
inline

Gets the authentication config id for the resource.

Definition at line 52 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 85 of file qgsauthconfigselect.cpp.

◆ setDataProviderKey()

void QgsAuthConfigSelect::setDataProviderKey ( const QString & key)

Sets key of layer provider, if applicable.

Definition at line 106 of file qgsauthconfigselect.cpp.

◆ showMessage

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

Show a small message bar with a close button.

Definition at line 189 of file qgsauthconfigselect.cpp.

Member Data Documentation

◆ settingsDetailsNotDisplayedAuthStores

const QgsSettingsEntryStringList * QgsAuthConfigSelect::settingsDetailsNotDisplayedAuthStores = new QgsSettingsEntryStringList( u"detailsNotDisplayedAuthStores"_s, QgsSettingsTree::sTreeQgis, QStringList(), u"List of AuthStore ids where the details (e.g. user, pw) should not be displayed in the auth config select dialog"_s )
static

Settings entry details not displayed auth stores.

Definition at line 58 of file qgsauthconfigselect.h.


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