QgsFeatureListComboBox Class Reference

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

#include <qgsfeaturelistcombobox.h>

Inheritance diagram for QgsFeatureListComboBox:

Signals
void	allowNullChanged ()
	Determines if a NULL value should be available in the list. More...
void	currentFeatureChanged ()
	Emitted when the current feature changes. More...
void	displayExpressionChanged ()
	The display expression will be used to display features as well as the the value to match the typed text against. More...
void	filterExpressionChanged ()
	An additional expression to further restrict the available features. More...
void	identifierFieldChanged ()
	Field name that will be used to uniquely identify the current feature. More...
void	identifierValueChanged ()
	The identifier value of the currently selected feature. More...
void	modelUpdated ()
	The underlying model has been updated. More...
void	sourceLayerChanged ()
	The layer from which features should be listed. More...

Public Member Functions
	QgsFeatureListComboBox (QWidget *parent=nullptr)
	Create a new QgsFeatureListComboBox, optionally specifying a parent. More...
bool	allowNull () const
	Determines if a NULL value should be available in the list. More...
QgsFeatureRequest	currentFeatureRequest () const
	Shorthand for getting a feature request to query the currently selected feature. More...
QModelIndex	currentModelIndex () const
	The index of the currently selected item. More...
QString	displayExpression () const
	The display expression will be used to display features as well as the value to match the typed text against. More...
QString	filterExpression () const
	An additional expression to further restrict the available features. More...
void	focusOutEvent (QFocusEvent *event) override
Q_DECL_DEPRECATED QString	identifierField () const
	Field name that will be used to uniquely identify the current feature. More...
QStringList	identifierFields () const
	Field name that will be used to uniquely identify the current feature. More...
Q_DECL_DEPRECATED QVariant	identifierValue () const
	The identifier value of the currently selected feature. More...
QVariantList	identifierValues () const
	The identifier values of the currently selected feature. More...
void	keyPressEvent (QKeyEvent *event) override
int	nullIndex () const
	Returns the current index of the NULL value, or -1 if NULL values are not allowed. More...
void	setAllowNull (bool allowNull)
	Determines if a NULL value should be available in the list. More...
void	setCurrentFeature (const QgsFeature &feature)
	Sets the current index by using the given feature. More...
void	setDisplayExpression (const QString &displayExpression)
	The display expression will be used to display features as well as the value to match the typed text against. More...
void	setFilterExpression (const QString &filterExpression)
	An additional expression to further restrict the available features. More...
Q_DECL_DEPRECATED void	setIdentifierField (const QString &identifierField)
	Field name that will be used to uniquely identify the current feature. More...
void	setIdentifierFields (const QStringList &identifierFields)
	Field name that will be used to uniquely identify the current feature. More...
Q_DECL_DEPRECATED void	setIdentifierValue (const QVariant &identifierValue)
	The identifier value of the currently selected feature. More...
void	setIdentifierValues (const QVariantList &identifierValues)
	The identifier values of the currently selected feature. More...
void	setIdentifierValuesToNull ()
	Sets the identifier values of the currently selected feature to NULL value(s). More...
void	setSourceLayer (QgsVectorLayer *sourceLayer)
	The layer from which features should be listed. More...
QgsVectorLayer *	sourceLayer () const
	The layer from which features should be listed. More...

Properties
bool	allowNull
QString	displayExpression
QString	filterExpression
QString	identifierField
QVariant	identifierValue
QVariantList	identifierValues
QgsVectorLayer *	sourceLayer

Friends
class	TestQgsFeatureListComboBox

Detailed Description

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.

Since

QGIS 3.0

Definition at line 39 of file qgsfeaturelistcombobox.h.

Constructor & Destructor Documentation

QgsFeatureListComboBox()

QgsFeatureListComboBox::QgsFeatureListComboBox

(

QWidget *

parent = nullptr

)

Create a new QgsFeatureListComboBox, optionally specifying a parent.

Definition at line 27 of file qgsfeaturelistcombobox.cpp.

Member Function Documentation

allowNull()

bool QgsFeatureListComboBox::allowNull

(

)

const

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

Definition at line 231 of file qgsfeaturelistcombobox.cpp.

allowNullChanged

void QgsFeatureListComboBox::allowNullChanged ( )

signal

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

currentFeatureChanged

void QgsFeatureListComboBox::currentFeatureChanged ( )

signal

Emitted when the current feature changes.

Since

QGIS 3.16.5

currentFeatureRequest()

QgsFeatureRequest QgsFeatureListComboBox::currentFeatureRequest

(

)

const

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

Definition at line 269 of file qgsfeaturelistcombobox.cpp.

currentModelIndex()

QModelIndex QgsFeatureListComboBox::currentModelIndex

(

)

const

The index of the currently selected item.

Definition at line 210 of file qgsfeaturelistcombobox.cpp.

displayExpression()

QString QgsFeatureListComboBox::displayExpression

(

)

const

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

Definition at line 90 of file qgsfeaturelistcombobox.cpp.

displayExpressionChanged

void QgsFeatureListComboBox::displayExpressionChanged ( )

signal

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

filterExpression()

QString QgsFeatureListComboBox::filterExpression

(

)

const

An additional expression to further restrict the available features.

This can be used to integrate additional spatial or other constraints.

Definition at line 296 of file qgsfeaturelistcombobox.cpp.

filterExpressionChanged

void QgsFeatureListComboBox::filterExpressionChanged ( )

signal

An additional expression to further restrict the available features.

This can be used to integrate additional spatial or other constraints.

focusOutEvent()

void QgsFeatureListComboBox::focusOutEvent ( QFocusEvent *  event )

override

Definition at line 215 of file qgsfeaturelistcombobox.cpp.

identifierField()

QString QgsFeatureListComboBox::identifierField

(

)

const

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

Normally the primary key of the layer.

Deprecated:

since QGIS 3.10

Definition at line 186 of file qgsfeaturelistcombobox.cpp.

identifierFieldChanged

void QgsFeatureListComboBox::identifierFieldChanged ( )

signal

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

Normally the primary key of the layer.

identifierFields()

QStringList QgsFeatureListComboBox::identifierFields

(

)

const

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

Normally the primary key of the layer.

Since

QGIS 3.10

Definition at line 195 of file qgsfeaturelistcombobox.cpp.

identifierValue()

QVariant QgsFeatureListComboBox::identifierValue

(

)

const

The identifier value of the currently selected feature.

A value from the identifierField.

Deprecated:

since QGIS 3.10

Definition at line 242 of file qgsfeaturelistcombobox.cpp.

identifierValueChanged

void QgsFeatureListComboBox::identifierValueChanged ( )

signal

The identifier value of the currently selected feature.

A value from the identifierField.

identifierValues()

QVariantList QgsFeatureListComboBox::identifierValues

(

)

const

The identifier values of the currently selected feature.

A value from the identifierField.

Since

QGIS 3.10

Definition at line 249 of file qgsfeaturelistcombobox.cpp.

keyPressEvent()

void QgsFeatureListComboBox::keyPressEvent ( QKeyEvent *  event )

override

Definition at line 222 of file qgsfeaturelistcombobox.cpp.

modelUpdated

void QgsFeatureListComboBox::modelUpdated ( )

signal

The underlying model has been updated.

Since

QGIS 3.2

nullIndex()

int QgsFeatureListComboBox::nullIndex

(

)

const

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

Since

QGIS 3.2

Definition at line 160 of file qgsfeaturelistcombobox.cpp.

setAllowNull()

void QgsFeatureListComboBox::setAllowNull

(

bool

allowNull

)

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

Definition at line 236 of file qgsfeaturelistcombobox.cpp.

setCurrentFeature()

void QgsFeatureListComboBox::setCurrentFeature

(

const QgsFeature &

feature

)

Sets the current index by using the given feature.

Since

QGIS 3.10

Definition at line 79 of file qgsfeaturelistcombobox.cpp.

setDisplayExpression()

void QgsFeatureListComboBox::setDisplayExpression

(

const QString &

displayExpression

)

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

Definition at line 95 of file qgsfeaturelistcombobox.cpp.

setFilterExpression()

void QgsFeatureListComboBox::setFilterExpression

(

const QString &

filterExpression

)

An additional expression to further restrict the available features.

This can be used to integrate additional spatial or other constraints.

Definition at line 301 of file qgsfeaturelistcombobox.cpp.

setIdentifierField()

void QgsFeatureListComboBox::setIdentifierField

(

const QString &

identifierField

)

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

Normally the primary key of the layer.

Deprecated:

since QGIS 3.10

Definition at line 200 of file qgsfeaturelistcombobox.cpp.

setIdentifierFields()

void QgsFeatureListComboBox::setIdentifierFields

(

const QStringList &

identifierFields

)

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

Normally the primary key of the layer.

Since

QGIS 3.10

Definition at line 205 of file qgsfeaturelistcombobox.cpp.

setIdentifierValue()

void QgsFeatureListComboBox::setIdentifierValue

(

const QVariant &

identifierValue

)

The identifier value of the currently selected feature.

A value from the identifierField.

Deprecated:

since QGIS 3.10 use setIdentifierValues

Definition at line 254 of file qgsfeaturelistcombobox.cpp.

setIdentifierValues()

void QgsFeatureListComboBox::setIdentifierValues

(

const QVariantList &

identifierValues

)

The identifier values of the currently selected feature.

A value from the identifierFields.

Since

QGIS 3.10

Definition at line 259 of file qgsfeaturelistcombobox.cpp.

setIdentifierValuesToNull()

void QgsFeatureListComboBox::setIdentifierValuesToNull

(

)

Sets the identifier values of the currently selected feature to NULL value(s).

Since

QGIS 3.10

Definition at line 264 of file qgsfeaturelistcombobox.cpp.

setSourceLayer()

void QgsFeatureListComboBox::setSourceLayer

(

QgsVectorLayer *

sourceLayer

)

The layer from which features should be listed.

Definition at line 74 of file qgsfeaturelistcombobox.cpp.

sourceLayer()

QgsVectorLayer * QgsFeatureListComboBox::sourceLayer

(

)

const

The layer from which features should be listed.

Definition at line 69 of file qgsfeaturelistcombobox.cpp.

sourceLayerChanged

void QgsFeatureListComboBox::sourceLayerChanged ( )

signal

The layer from which features should be listed.

Friends And Related Function Documentation

TestQgsFeatureListComboBox

friend class TestQgsFeatureListComboBox

friend

Definition at line 261 of file qgsfeaturelistcombobox.h.

Property Documentation

allowNull

bool QgsFeatureListComboBox::allowNull

readwrite

Definition at line 39 of file qgsfeaturelistcombobox.h.

displayExpression

QString QgsFeatureListComboBox::displayExpression

readwrite

Definition at line 39 of file qgsfeaturelistcombobox.h.

filterExpression

QString QgsFeatureListComboBox::filterExpression

readwrite

Definition at line 39 of file qgsfeaturelistcombobox.h.

identifierField

QString QgsFeatureListComboBox::identifierField

readwrite

Definition at line 39 of file qgsfeaturelistcombobox.h.

identifierValue

QVariant QgsFeatureListComboBox::identifierValue

readwrite

Definition at line 39 of file qgsfeaturelistcombobox.h.

identifierValues

QVariantList QgsFeatureListComboBox::identifierValues

readwrite

Definition at line 39 of file qgsfeaturelistcombobox.h.

sourceLayer

QgsVectorLayer * QgsFeatureListComboBox::sourceLayer

readwrite

Definition at line 39 of file qgsfeaturelistcombobox.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.28.0+99sid/src/gui/qgsfeaturelistcombobox.h
• /build/qgis-3.28.0+99sid/src/gui/qgsfeaturelistcombobox.cpp