QGIS API Documentation 3.27.0-Master (1c05421486)
Public Types | Public Member Functions | List of all members
QgsProviderConnectionModel Class Reference

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

#include <qgsproviderconnectionmodel.h>

Inheritance diagram for QgsProviderConnectionModel:
Inheritance graph
[legend]

Public Types

enum  Role { RoleConnectionName = Qt::UserRole , RoleUri , RoleConfiguration , RoleEmpty }
 Model roles. More...
 

Public Member Functions

 QgsProviderConnectionModel (const QString &provider, QObject *parent=nullptr)
 Constructor for QgsProviderConnectionModel, for the specified provider. More...
 
bool allowEmptyConnection () const
 Returns true if the model allows the empty connection ("not set") choice. More...
 
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. More...
 

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.
Since
QGIS 3.14

Definition at line 38 of file qgsproviderconnectionmodel.h.

Member Enumeration Documentation

◆ Role

Model roles.

Enumerator
RoleConnectionName 

Connection name.

RoleUri 

Connection URI string.

RoleConfiguration 

Connection configuration variant map.

RoleEmpty 

Entry is an empty entry.

Definition at line 45 of file qgsproviderconnectionmodel.h.

Constructor & Destructor Documentation

◆ QgsProviderConnectionModel()

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.

Definition at line 20 of file qgsproviderconnectionmodel.cpp.

Member Function Documentation

◆ allowEmptyConnection()

bool QgsProviderConnectionModel::allowEmptyConnection ( ) const
inline

Returns true if the model allows the empty connection ("not set") choice.

See also
setAllowEmptyConnection()

Definition at line 72 of file qgsproviderconnectionmodel.h.

◆ columnCount()

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

Definition at line 85 of file qgsproviderconnectionmodel.cpp.

◆ data()

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

Definition at line 92 of file qgsproviderconnectionmodel.cpp.

◆ index()

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

Definition at line 158 of file qgsproviderconnectionmodel.cpp.

◆ parent()

QModelIndex QgsProviderConnectionModel::parent ( const QModelIndex &  child) const
override

Definition at line 70 of file qgsproviderconnectionmodel.cpp.

◆ rowCount()

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

Definition at line 77 of file qgsproviderconnectionmodel.cpp.

◆ setAllowEmptyConnection()

void QgsProviderConnectionModel::setAllowEmptyConnection ( bool  allowEmpty)

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

See also
allowEmptyConnection()

Definition at line 33 of file qgsproviderconnectionmodel.cpp.


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