Class: QgsFieldItem

class qgis.core.QgsFieldItem

Bases: QgsDataItem

A layer field item, information about the connection URI, the schema and the table as well as the layer instance the field belongs to can be retrieved from the parent QgsFieldsItem object.

New in version 3.16.

QgsFieldItem(parent: QgsDataItem, field: QgsField) Constructor for QgsFieldItem, with the specified parent item and field.

Note

parent item must be a QgsFieldsItem

Methods

childEvent

connectNotify

customEvent

deferredDelete

The item is scheduled to be deleted.

disconnectNotify

equal

param other:

field

Returns the field definition.

icon

rtype:

QIcon

isSignalConnected

populate

receivers

refresh

Refresh the items from a specified list of child items.

sender

senderSignalIndex

timerEvent

updateIcon

Will request a repaint of this icon.

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
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)
equal(self, other: QgsDataItem) bool
Parameters:

other (QgsDataItem) –

Return type:

bool

field(self) QgsField

Returns the field definition.

New in version 3.26.

Return type:

QgsField

icon(self) QIcon
Return type:

QIcon

isSignalConnected(self, QMetaMethod) bool
populate(self, children: Iterable[QgsDataItem])
populate(self, foreground: bool = False) None
receivers(self, PYQT_SIGNAL) int
refresh(self, children: Iterable[QgsDataItem])

Refresh the items from a specified list of child items.

refresh(self)

sender(self) QObject
senderSignalIndex(self) int
timerEvent(self, QTimerEvent)
updateIcon(self)

Will request a repaint of this icon.

New in version 3.0.