A model containing registered connection names for a specific data provider. More...

Inheritance diagram for QgsProviderConnectionModel:

Public Types
enum class	CustomRole : int { ConnectionName = Qt::UserRole , Uri , Configuration , Empty }
	Custom model roles. More...

Public Member Functions
	QgsProviderConnectionModel (const QString &provider, QObject *parent=nullptr)
	Constructor for QgsProviderConnectionModel, for the specified provider.

bool	allowEmptyConnection () const
	Returns `true` if the model allows the empty connection ("not set") choice.

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

QModelIndex	index (int row, int column, const QModelIndex &parent) const override

QModelIndex	parent (const QModelIndex &child) const override

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

void	setAllowEmptyConnection (bool allowEmpty)
	Sets whether an optional empty connection ("not set") option is present in the model.

Detailed Description

A model containing registered connection names for a specific data provider.

Warning: The provider must support the connection API methods in its QgsProviderMetadata implementation in order for the model to work correctly.

Member Enumeration Documentation

strong

Custom model roles.

Note: Prior to QGIS 3.36 this was available as QgsProviderConnectionModel::Role

Enumerator
ConnectionName	Connection name.
Uri	Connection URI string.
Configuration	Connection configuration variant map.
Empty	Entry is an empty entry.

QgsProviderConnectionModel::QgsProviderConnectionModel	(	const QString &	provider,
		QObject *	parent = `nullptr`
	)

explicit

Constructor for QgsProviderConnectionModel, for the specified provider.

Warning: The provider must support the connection API methods in its QgsProviderMetadata implementation in order for the model to work correctly.