Class: QgsFieldsItem

class qgis.core.QgsFieldsItem(parent: QgsDataItem, path: str, connectionUri: str, providerKey: str, schema: str, tableName: str)

Bases: QgsDataItem

Constructor for QgsFieldsItem, with the specified parent item.

The path argument gives the item path in the browser tree. The path string can take any form, but QgsDataItem items pointing to different logical locations should always use a different item path. The connectionUri argument is the connection part of the layer URI that it is used internally to create a connection and retrieve fields information. The providerKey string can be used to specify the key for the QgsDataItemProvider that created this item. The schema and tableName are used to retrieve the layer and field information from the connectionUri.

A collection of field items with some internal logic to retrieve the fields and a the vector layer instance from a connection URI, the schema and the table name.

New in version 3.16.

  • parent (QgsDataItem) –

  • path (str) –

  • connectionUri (str) –

  • providerKey (str) –

  • schema (str) –

  • tableName

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
connectionUri(self) → str

Returns the connection URI

Return type


createChildren(self) → object
Return type


customEvent(self, QEvent)
deferredDelete(self) → bool

The item is scheduled to be deleted. E.g. if deleteLater() is called when item is in Populating state (createChildren() running in another thread), the deferredDelete() returns True and item will be deleted once Populating finished. Items with slow reateChildren() (for example network or database based) may check during createChildren() if deferredDelete() returns True and return from createChildren() immediately because result will be useless.

disconnectNotify(self, QMetaMethod)
icon(self) → QIcon
Return type


isSignalConnected(self, QMetaMethod) → bool

Creates and returns a (possibly NULL) layer from the connection URI and schema/table information

Return type


populate(self, children: object)

populate(self, foreground: bool = False)

receivers(self, PYQT_SIGNAL) → int
refresh(self, children: object)

Refresh the items from a specified list of child items.


schema(self) → str

Returns the schema name

Return type


sender(self) → QObject
senderSignalIndex(self) → int
tableName(self) → str

Returns the table name

Return type



Returns the (possibly NULL) properties of the table this fields belong to.

New in version 3.16.

Return type


timerEvent(self, QTimerEvent)

Will request a repaint of this icon.

New in version 3.0.