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: Enums

Methods

actionEvent

allowNull

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

changeEvent

childEvent

closeEvent

connectNotify

contextMenuEvent

create

currentFeatureRequest

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

currentModelIndex

The index of the currently selected item.

customEvent

destroy

disconnectNotify

displayExpression

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

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

filterExpression

An additional expression to further restrict the available features.

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

identifierField

Field name that will be used to uniquely identify the current feature.

identifierValue

The identifier value of the currently selected feature.

initPainter

initStyleOption

inputMethodEvent

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

nullIndex

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

paintEvent

receivers

resizeEvent

sender

senderSignalIndex

setAllowNull

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

setDisplayExpression

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

setFilterExpression

An additional expression to further restrict the available features.

setIdentifierField

Field name that will be used to uniquely identify the current feature.

setIdentifierValue

The identifier value of the currently selected feature.

setSourceLayer

The layer from which features should be listed.

sharedPainter

showEvent

sourceLayer

The layer from which features should be listed.

tabletEvent

timerEvent

updateMicroFocus

wheelEvent

Signals

allowNullChanged

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

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.

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.

sourceLayerChanged

The layer from which features should be listed.

Attributes

actionEvent()
allowNull(self) → bool

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

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.

currentModelIndex(self) → QModelIndex

The index of the currently selected item.

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.

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.

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)
focusPreviousChild()
hideEvent()
identifierField(self) → str

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

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.

identifierValueChanged

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

initPainter()
initStyleOption()
inputMethodEvent()
isSignalConnected()
keyPressEvent(self, 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.

paintEvent()
receivers()
resizeEvent()
sender()
senderSignalIndex()
setAllowNull(self, allowNull: bool)

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

setDisplayExpression(self, displayExpression: str)

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

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!

setIdentifierField(self, identifierField: str)

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

setIdentifierValue(self, identifierValue: Any)

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

setSourceLayer(self, sourceLayer: QgsVectorLayer)

The layer from which features should be listed.

sharedPainter()
showEvent()
sourceLayer(self) → QgsVectorLayer

The layer from which features should be listed.

sourceLayerChanged

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

tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()