Class: QgsFeatureListComboBox

class qgis.gui.QgsFeatureListComboBox(parent: QWidget = None)

Bases: PyQt5.QtWidgets.QComboBox

Create a new QgsFeatureListComboBox, optionally specifying a parent.

This offers a combobox with autocompleter that allows selecting features from a layer.

It will show up to 100 entries at a time. The entries can be chosen based on the displayExpression and whenever text is typed into the combobox, the completer and popup will adjust to features matching the typed text.

New in version 3.0.

Parameters

parent –

actionEvent()

allowNull(self) → bool

Determines if a NULL value should be available in the list.

Return type

bool

allowNullChanged

Determines if a NULL value should be available in the list. [signal]

changeEvent()

childEvent()

closeEvent()

connectNotify()

contextMenuEvent()

create()

currentFeatureRequest(self) → QgsFeatureRequest

Shorthand for getting a feature request to query the currently selected feature.

Return type

QgsFeatureRequest

currentModelIndex(self) → QModelIndex

The index of the currently selected item.

Return type

QModelIndex

customEvent()

destroy()

disconnectNotify()

displayExpression(self) → str

The display expression will be used to display features as well as the value to match the typed text against.

Return type

str

displayExpressionChanged

The display expression will be used to display features as well as the the value to match the typed text against. [signal]

dragEnterEvent()

dragLeaveEvent()

dragMoveEvent()

dropEvent()

enterEvent()

filterExpression(self) → str

An additional expression to further restrict the available features. This can be used to integrate additional spatial or other constraints.

Return type

str

filterExpressionChanged

An additional expression to further restrict the available features. This can be used to integrate additional spatial or other constraints. [signal]

focusInEvent()

focusNextChild()

focusNextPrevChild()

focusOutEvent(self, event: QFocusEvent)

Parameters

event (QFocusEvent) –

focusPreviousChild()

hideEvent()

identifierField(self) → str

Field name that will be used to uniquely identify the current feature. Normally the primary key of the layer.

Return type

str

identifierFieldChanged

Field name that will be used to uniquely identify the current feature. Normally the primary key of the layer. [signal]

identifierValue(self) → Any

The identifier value of the currently selected feature. A value from the identifierField.

Return type

Any

identifierValueChanged

The identifier value of the currently selected feature. A value from the identifierField. [signal]

initPainter()

initStyleOption()

inputMethodEvent()

isSignalConnected()

keyPressEvent(self, event: QKeyEvent)

Parameters

event (QKeyEvent) –

keyReleaseEvent()

leaveEvent()

metric()

modelUpdated

The underlying model has been updated.

New in version 3.2: [signal]

mouseDoubleClickEvent()

mouseMoveEvent()

mousePressEvent()

mouseReleaseEvent()

moveEvent()

nativeEvent()

nullIndex(self) → int

Returns the current index of the NULL value, or -1 if NULL values are not allowed.

New in version 3.2.

Return type

int

paintEvent()

receivers()

resizeEvent()

sender()

senderSignalIndex()

setAllowNull(self, allowNull: bool)

Determines if a NULL value should be available in the list.

Parameters

allowNull (bool) –

setDisplayExpression(self, displayExpression: str)

The display expression will be used to display features as well as the value to match the typed text against.

Parameters

displayExpression (str) –

setFilterExpression(self, filterExpression: str)

An additional expression to further restrict the available features. This can be used to integrate additional spatial or other constraints.

TODO!

Parameters

filterExpression (str) –

setIdentifierField(self, identifierField: str)

Field name that will be used to uniquely identify the current feature. Normally the primary key of the layer.

Parameters

identifierField (str) –

setIdentifierValue(self, identifierValue: Any)

The identifier value of the currently selected feature. A value from the identifierField.

Parameters

identifierValue (Any) –

setSourceLayer(self, sourceLayer: QgsVectorLayer)

The layer from which features should be listed.

Parameters

sourceLayer (QgsVectorLayer) –

sharedPainter()

showEvent()

sourceLayer(self) → QgsVectorLayer

The layer from which features should be listed.

Return type

QgsVectorLayer

sourceLayerChanged

The layer from which features should be listed. [signal]

tabletEvent()

timerEvent()

updateMicroFocus()

wheelEvent()