Class: QgsProviderConnectionModel¶
- class qgis.core.QgsProviderConnectionModel¶
Bases:
PyQt5.QtCore.QAbstractItemModel
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.New in version 3.14.
QgsProviderConnectionModel(provider: str, parent: QObject = None) Constructor for
QgsProviderConnectionModel
, for the specifiedprovider
.Warning
The
provider
must support the connection API methods in itsQgsProviderMetadata
implementation in order for the model to work correctly.Enums
Bases:
enum.IntEnum
alias of
CustomRole
Methods
Returns
True
if the model allows the empty connection ("not set") choice.- param parent:
- param index:
- param row:
- param child:
- param parent:
Sets whether an optional empty connection ("not set") option is present in the model.
- class CustomRole(value)¶
Bases:
enum.IntEnum
Custom model roles.
Note
Prior to QGIS 3.36 this was available as QgsProviderConnectionModel.Role
New in version 3.36.
RoleConnectionName
: Connection nameRoleUri
: Connection URI stringRoleConfiguration
: Connection configuration variant mapRoleEmpty
: Entry is an empty entry
- baseClass¶
alias of
QgsProviderConnectionModel
- Role¶
alias of
CustomRole
- allowEmptyConnection(self) bool ¶
Returns
True
if the model allows the empty connection (“not set”) choice.See also
- Return type:
bool
- beginInsertColumns(self, QModelIndex, int, int)¶
- beginInsertRows(self, QModelIndex, int, int)¶
- beginMoveColumns(self, QModelIndex, int, int, QModelIndex, int) bool ¶
- beginMoveRows(self, QModelIndex, int, int, QModelIndex, int) bool ¶
- beginRemoveColumns(self, QModelIndex, int, int)¶
- beginRemoveRows(self, QModelIndex, int, int)¶
- beginResetModel(self)¶
- changePersistentIndex(self, QModelIndex, QModelIndex)¶
- changePersistentIndexList(self, Iterable[QModelIndex], Iterable[QModelIndex])¶
- childEvent(self, QChildEvent)¶
- columnCount(self, parent: QModelIndex = QModelIndex()) int ¶
- Parameters:
parent (QModelIndex = QModelIndex()) –
- Return type:
int
- connectNotify(self, QMetaMethod)¶
- createIndex(self, int, int, object: object = 0) QModelIndex ¶
- customEvent(self, QEvent)¶
- data(self, index: QModelIndex, role: int = Qt.DisplayRole) Any ¶
- Parameters:
index (QModelIndex) –
role (int = Qt.DisplayRole) –
- Return type:
Any
- decodeData(self, int, int, QModelIndex, QDataStream) bool ¶
- disconnectNotify(self, QMetaMethod)¶
- encodeData(self, Iterable[QModelIndex], QDataStream)¶
- endInsertColumns(self)¶
- endInsertRows(self)¶
- endMoveColumns(self)¶
- endMoveRows(self)¶
- endRemoveColumns(self)¶
- endRemoveRows(self)¶
- endResetModel(self)¶
- index(self, row: int, column: int, parent: QModelIndex) QModelIndex ¶
- Parameters:
row (int) –
column (int) –
parent (QModelIndex) –
- Return type:
QModelIndex
- isSignalConnected(self, QMetaMethod) bool ¶
- parent(self, child: QModelIndex) QModelIndex ¶
- Parameters:
child (QModelIndex) –
- Return type:
QModelIndex
- persistentIndexList(self) List[QModelIndex] ¶
- receivers(self, PYQT_SIGNAL) int ¶
- resetInternalData(self)¶
- rowCount(self, parent: QModelIndex = QModelIndex()) int ¶
- Parameters:
parent (QModelIndex = QModelIndex()) –
- Return type:
int
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setAllowEmptyConnection(self, allowEmpty: bool)¶
Sets whether an optional empty connection (“not set”) option is present in the model.
See also
- Parameters:
allowEmpty (bool) –
- timerEvent(self, QTimerEvent)¶