Class: QgsFeatureListComboBox

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.

Class Hierarchy

Base classes

QComboBox
QWidget
QObject
QPaintDevice

Methods

allowNull	Determines if a NULL value should be available in the list.
currentFeatureRequest	Shorthand for getting a feature request to query the currently selected feature.
currentModelIndex	The index of the currently selected item.
displayExpression	The display expression will be used to display features as well as the value to match the typed text against.
fetchLimit	Returns the feature request fetch limit
filterExpression	An additional expression to further restrict the available features.
formFeature	Returns an attribute form feature to be used with the filter expression.
identifierField	Field name that will be used to uniquely identify the current feature.
identifierFields	Field name that will be used to uniquely identify the current feature.
identifierValue	The identifier value of the currently selected feature.
identifierValues	The identifier values of the currently selected feature.
nullIndex	Returns the current index of the NULL value, or -1 if NULL values are not allowed.
parentFormFeature	Returns a parent attribute form feature to be used with the filter expression.
setAllowNull	Determines if a NULL value should be available in the list.
setCurrentFeature	Sets the current index by using the given feature
setDisplayExpression	The display expression will be used to display features as well as the value to match the typed text against.
setFetchLimit	Defines the feature request fetch limit If set to 0, no limit is applied when fetching
setFilterExpression	An additional expression to further restrict the available features.
setFormFeature	Sets an attribute form feature to be used with the filter expression.
setIdentifierField	Field name that will be used to uniquely identify the current feature.
setIdentifierFields	Field name that will be used to uniquely identify the current feature.
setIdentifierValue	The identifier value of the currently selected feature.
setIdentifierValues	The identifier values of the currently selected feature.
setIdentifierValuesToNull	Sets the identifier values of the currently selected feature to NULL
setParentFormFeature	Sets a parent attribute form feature to be used with the filter expression.
setSourceLayer	The layer from which features should be listed.
sourceLayer	The layer from which features should be listed.

Signals

allowNullChanged	Determines if a NULL value should be available in the list.
currentFeatureChanged	Emitted when the current feature changes
currentFeatureFoundChanged	Emitted when the feature picker model changes its feature found state
displayExpressionChanged	The display expression will be used to display features as well as the the value to match the typed text against.
filterExpressionChanged	An additional expression to further restrict the available features.
formFeatureChanged	An attribute form feature to be used alongside the filter expression.
identifierFieldChanged	Field name that will be used to uniquely identify the current feature.
identifierValueChanged	The identifier value of the currently selected feature.
modelUpdated	The underlying model has been updated.
parentFormFeatureChanged	A parent attribute form feature to be used alongside the filter expression.
sourceLayerChanged	The layer from which features should be listed.

class qgis.gui.QgsFeatureListComboBox

Bases: QComboBox

__init__(parent: QWidget | None = None)

Create a new QgsFeatureListComboBox, optionally specifying a parent.

Parameters:

parent (Optional[QWidget] = None)

allowNull(self) → bool

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

Return type:

bool

signal allowNullChanged

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

signal currentFeatureChanged

Emitted when the current feature changes

Added in version 3.16.5.

signal currentFeatureFoundChanged(found: bool)

Emitted when the feature picker model changes its feature found state

Added in version 3.38.

Parameters:

found (bool)

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

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

signal displayExpressionChanged

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

fetchLimit(self) → int

Returns the feature request fetch limit

Added in version 3.32.

Return type:

int

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

signal filterExpressionChanged

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

formFeature(self) → QgsFeature

Returns an attribute form feature to be used with the filter expression.

Added in version 3.42.2.

Return type:

QgsFeature

signal formFeatureChanged

An attribute form feature to be used alongside the filter expression.

Added in version 3.42.2.

identifierField(self) → str

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

Deprecated since version 3.10.

Return type:

str

signal identifierFieldChanged

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

identifierFields(self) → List[str]

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

Added in version 3.10.

Return type:

List[str]

identifierValue(self) → Any

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

Deprecated since version 3.10.

Return type:

Any

signal identifierValueChanged

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

identifierValues(self) → List[Any]

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

Added in version 3.10.

Return type:

List[Any]

signal modelUpdated

The underlying model has been updated.

Added in version 3.2.

nullIndex(self) → int

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

Added in version 3.2.

Return type:

int

parentFormFeature(self) → QgsFeature

Returns a parent attribute form feature to be used with the filter expression.

Added in version 3.42.2.

Return type:

QgsFeature

signal parentFormFeatureChanged

A parent attribute form feature to be used alongside the filter expression.

Added in version 3.42.2.

setAllowNull(self, allowNull: bool)

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

Parameters:

allowNull (bool)

setCurrentFeature(self, feature: QgsFeature)

Sets the current index by using the given feature

Added in version 3.10.

Parameters:

feature (QgsFeature)

setDisplayExpression(self, displayExpression: str | None)

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

Parameters:

displayExpression (Optional[str])

setFetchLimit(self, fetchLimit: int)

Defines the feature request fetch limit If set to 0, no limit is applied when fetching

Added in version 3.32.

Parameters:

fetchLimit (int)

setFilterExpression(self, filterExpression: str | None)

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

Parameters:

filterExpression (Optional[str])

setFormFeature(self, feature: QgsFeature)

Sets an attribute form feature to be used with the filter expression.

Added in version 3.42.2.

Parameters:

feature (QgsFeature)

setIdentifierField(self, identifierField: str | None)

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

Deprecated since version 3.10.

Parameters:

identifierField (Optional[str])

setIdentifierFields(self, identifierFields: Iterable[str | None])

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

Added in version 3.10.

Parameters:

identifierFields (Iterable[Optional[str]])

setIdentifierValue(self, identifierValue: Any)

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

Deprecated since version 3.10: Use setIdentifierValues.

Parameters:

identifierValue (Any)

setIdentifierValues(self, identifierValues: Iterable[Any])

The identifier values of the currently selected feature. A value from the identifierFields.

Added in version 3.10.

Parameters:

identifierValues (Iterable[Any])

setIdentifierValuesToNull(self)

Sets the identifier values of the currently selected feature to NULL

QgsFeatureListComboBox.setIdentifierValuesToNull(s).

setIdentifierValuesToNull(s).

Added in version 3.10.

setParentFormFeature(self, feature: QgsFeature)

Sets a parent attribute form feature to be used with the filter expression.

Added in version 3.42.2.

Parameters:

feature (QgsFeature)

setSourceLayer(self, sourceLayer: QgsVectorLayer | None)

The layer from which features should be listed.

Parameters:

sourceLayer (Optional[QgsVectorLayer])

sourceLayer(self) → QgsVectorLayer | None

The layer from which features should be listed.

Return type:

Optional[QgsVectorLayer]

signal sourceLayerChanged

The layer from which features should be listed.