Utility functions for use by authentication GUI widgets or standalone apps. More...

#include <qgsauthguiutils.h>

Static Public Member Functions
static void	clearCachedAuthenticationConfigs (QgsMessageBar *msgbar)
	Clear all cached authentication configs for session. More...

static void	clearCachedMasterPassword (QgsMessageBar *msgbar)
	Clear the currently cached master password (not its hash in database) More...

static void	eraseAuthenticationDatabase (QgsMessageBar msgbar, QWidget parent=nullptr)
	Completely clear out the authentication database (configs and master password) More...

static void	exportSelectedAuthenticationConfigs (QStringList authenticationConfigIds, QgsMessageBar *msgbar)
	Exports selected authentication configurations to a XML file. More...

static void	fileFound (bool found, QWidget *widget)
	Color a widget via a stylesheet if a file path is found or not. More...

static QString	getOpenFileName (QWidget *parent, const QString &title, const QString &extfilter)
	Open file dialog for auth associated widgets. More...

static QColor	greenColor ()
	Green color representing valid, trusted, etc. certificate. More...

static QString	greenTextStyleSheet (const QString &selector="*")
	Green text stylesheet representing valid, trusted, etc. certificate. More...

static void	importAuthenticationConfigs (QgsMessageBar *msgbar)
	Import authentication configurations from a XML file. More...

static bool	isDisabled (QgsMessageBar *msgbar)
	Verify the authentication system is active, else notify user. More...

static QColor	orangeColor ()
	Orange color representing loaded component, but not stored in database. More...

static QString	orangeTextStyleSheet (const QString &selector="*")
	Orange text stylesheet representing loaded component, but not stored in database. More...

static void	passwordHelperDelete (QgsMessageBar msgbar, QWidget parent=nullptr)
	Remove master password from wallet. More...

static void	passwordHelperEnable (bool enabled, QgsMessageBar *msgbar)
	Sets password helper enabled (enable/disable) More...

static void	passwordHelperLoggingEnable (bool enabled, QgsMessageBar *msgbar, int timeout=0)
	Sets password helper logging enabled (enable/disable) More...

static void	passwordHelperSync (QgsMessageBar *msgbar)
	Store master password into the wallet. More...

static QColor	redColor ()
	Red color representing invalid, untrusted, etc. certificate. More...

static QString	redTextStyleSheet (const QString &selector="*")
	Red text stylesheet representing invalid, untrusted, etc. certificate. More...

static void	removeAuthenticationConfigs (QgsMessageBar msgbar, QWidget parent=nullptr)
	Remove all authentication configs. More...

static void	resetMasterPassword (QgsMessageBar msgbar, QWidget parent=nullptr)
	Reset the cached master password, updating its hash in authentication database and resetting all existing configs to use it. More...

static void	setMasterPassword (QgsMessageBar *msgbar)
	Sets the cached master password (and verifies it if its hash is in authentication database) More...

static QColor	yellowColor ()
	Yellow color representing caution regarding action. More...

Detailed Description

Utility functions for use by authentication GUI widgets or standalone apps.

Note: not available in Python bindings

Definition at line 34 of file qgsauthguiutils.h.

Member Function Documentation

◆ clearCachedAuthenticationConfigs()

void QgsAuthGuiUtils::clearCachedAuthenticationConfigs ( QgsMessageBar * msgbar )

static

Clear all cached authentication configs for session.

Definition at line 234 of file qgsauthguiutils.cpp.

◆ clearCachedMasterPassword()

void QgsAuthGuiUtils::clearCachedMasterPassword ( QgsMessageBar * msgbar )

static

Clear the currently cached master password (not its hash in database)

Definition at line 169 of file qgsauthguiutils.cpp.

◆ eraseAuthenticationDatabase()

void QgsAuthGuiUtils::eraseAuthenticationDatabase	(	QgsMessageBar *	msgbar,
		QWidget *	parent = `nullptr`
	)

static

Completely clear out the authentication database (configs and master password)

Definition at line 271 of file qgsauthguiutils.cpp.

◆ exportSelectedAuthenticationConfigs()

void QgsAuthGuiUtils::exportSelectedAuthenticationConfigs	(	QStringList	authenticationConfigIds,
		QgsMessageBar *	msgbar
	)

static

Exports selected authentication configurations to a XML file.

Since: QGIS 3.20

Definition at line 79 of file qgsauthguiutils.cpp.

◆ fileFound()

void QgsAuthGuiUtils::fileFound	(	bool	found,
		QWidget *	widget
	)

static

Color a widget via a stylesheet if a file path is found or not.

Definition at line 313 of file qgsauthguiutils.cpp.

◆ getOpenFileName()

QString QgsAuthGuiUtils::getOpenFileName	(	QWidget *	parent,
		const QString &	title,
		const QString &	extfilter
	)

static

Open file dialog for auth associated widgets.

Definition at line 327 of file qgsauthguiutils.cpp.

◆ greenColor()

QColor QgsAuthGuiUtils::greenColor ( )

static

Green color representing valid, trusted, etc. certificate.

Definition at line 32 of file qgsauthguiutils.cpp.

◆ greenTextStyleSheet()

QString QgsAuthGuiUtils::greenTextStyleSheet ( const QString & selector = "*" )

static

Green text stylesheet representing valid, trusted, etc. certificate.

Definition at line 52 of file qgsauthguiutils.cpp.

◆ importAuthenticationConfigs()

void QgsAuthGuiUtils::importAuthenticationConfigs ( QgsMessageBar * msgbar )

static

Import authentication configurations from a XML file.

Since: QGIS 3.20

Definition at line 109 of file qgsauthguiutils.cpp.

◆ isDisabled()

bool QgsAuthGuiUtils::isDisabled ( QgsMessageBar * msgbar )

static

Verify the authentication system is active, else notify user.

Definition at line 67 of file qgsauthguiutils.cpp.

◆ orangeColor()

QColor QgsAuthGuiUtils::orangeColor ( )

static

Orange color representing loaded component, but not stored in database.

Definition at line 37 of file qgsauthguiutils.cpp.

◆ orangeTextStyleSheet()

QString QgsAuthGuiUtils::orangeTextStyleSheet ( const QString & selector = "*" )

static

Orange text stylesheet representing loaded component, but not stored in database.

Definition at line 57 of file qgsauthguiutils.cpp.

◆ passwordHelperDelete()

void QgsAuthGuiUtils::passwordHelperDelete	(	QgsMessageBar *	msgbar,
		QWidget *	parent = `nullptr`
	)

static

Remove master password from wallet.

Definition at line 339 of file qgsauthguiutils.cpp.

◆ passwordHelperEnable()

void QgsAuthGuiUtils::passwordHelperEnable	(	bool	enabled,
		QgsMessageBar *	msgbar
	)

static

Sets password helper enabled (enable/disable)

Definition at line 392 of file qgsauthguiutils.cpp.

◆ passwordHelperLoggingEnable()

void QgsAuthGuiUtils::passwordHelperLoggingEnable	(	bool	enabled,
		QgsMessageBar *	msgbar,
		int	timeout = `0`
	)

static

Sets password helper logging enabled (enable/disable)

Definition at line 402 of file qgsauthguiutils.cpp.

◆ passwordHelperSync()

void QgsAuthGuiUtils::passwordHelperSync ( QgsMessageBar * msgbar )

static

Store master password into the wallet.

Definition at line 367 of file qgsauthguiutils.cpp.

◆ redColor()

QColor QgsAuthGuiUtils::redColor ( )

static

Red color representing invalid, untrusted, etc. certificate.

Definition at line 42 of file qgsauthguiutils.cpp.

◆ redTextStyleSheet()

QString QgsAuthGuiUtils::redTextStyleSheet ( const QString & selector = "*" )

static

Red text stylesheet representing invalid, untrusted, etc. certificate.

Definition at line 62 of file qgsauthguiutils.cpp.

◆ removeAuthenticationConfigs()

void QgsAuthGuiUtils::removeAuthenticationConfigs	(	QgsMessageBar *	msgbar,
		QWidget *	parent = `nullptr`
	)

static

Remove all authentication configs.

Definition at line 244 of file qgsauthguiutils.cpp.

◆ resetMasterPassword()

void QgsAuthGuiUtils::resetMasterPassword	(	QgsMessageBar *	msgbar,
		QWidget *	parent = `nullptr`
	)

static

Reset the cached master password, updating its hash in authentication database and resetting all existing configs to use it.

Definition at line 191 of file qgsauthguiutils.cpp.

◆ setMasterPassword()

void QgsAuthGuiUtils::setMasterPassword ( QgsMessageBar * msgbar )

static

Sets the cached master password (and verifies it if its hash is in authentication database)

Definition at line 154 of file qgsauthguiutils.cpp.

◆ yellowColor()

QColor QgsAuthGuiUtils::yellowColor ( )

static

Yellow color representing caution regarding action.

Definition at line 47 of file qgsauthguiutils.cpp.

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

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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ clearCachedAuthenticationConfigs()

◆ clearCachedMasterPassword()

◆ eraseAuthenticationDatabase()

◆ exportSelectedAuthenticationConfigs()

◆ fileFound()

◆ getOpenFileName()

◆ greenColor()

◆ greenTextStyleSheet()

◆ importAuthenticationConfigs()

◆ isDisabled()

◆ orangeColor()

◆ orangeTextStyleSheet()

◆ passwordHelperDelete()

◆ passwordHelperEnable()

◆ passwordHelperLoggingEnable()

◆ passwordHelperSync()

◆ redColor()

◆ redTextStyleSheet()

◆ removeAuthenticationConfigs()

◆ resetMasterPassword()

◆ setMasterPassword()

◆ yellowColor()