The QgsFieldComboBox is a combo box which displays the list of fields of a given layer. More...

#include <qgsfieldcombobox.h>

Inheritance diagram for QgsFieldComboBox:

Public Slots
void	setField (const QString &fieldName)
	setField sets the currently selected field

void	setLayer (QgsMapLayer *layer)
	Sets the layer for which fields are listed in the combobox.

Signals
void	fieldChanged (const QString &fieldName)
	Emitted when the currently selected field changes.

Public Member Functions
	QgsFieldComboBox (QWidget *parent=nullptr)
	QgsFieldComboBox creates a combo box to display the fields of a layer.

bool	allowEmptyFieldName () const
	Returns `true` if the combo box allows the empty field ("not set") choice.

QString	currentField () const
	Returns the currently selected field.

QgsFields	fields () const
	Returns the fields currently shown in the combobox.

QgsFieldProxyModel::Filters	filters () const
	currently used filter on list of fields

QgsVectorLayer *	layer () const
	Returns the layer currently associated with the combobox.

void	setAllowEmptyFieldName (bool allowEmpty)
	Sets whether an optional empty field ("not set") option is shown in the combo box.

void	setFields (const QgsFields &fields)
	Manually sets the fields to use for the combo box.

void	setFilters (QgsFieldProxyModel::Filters filters)
	setFilters allows filtering according to the type of field

Protected Slots
void	indexChanged (int i)

Properties
bool	allowEmptyFieldName

QgsFieldProxyModel::Filters	filters

Detailed Description

The QgsFieldComboBox is a combo box which displays the list of fields of a given layer.

It might be combined with a QgsMapLayerComboBox to automatically update fields according to a chosen layer. If expression must be used, QgsFieldExpressionWidget shall be used instead.

See also: QgsMapLayerComboBox

Definition at line 37 of file qgsfieldcombobox.h.

Constructor & Destructor Documentation

◆ QgsFieldComboBox()

QgsFieldComboBox::QgsFieldComboBox ( QWidget * parent = nullptr )

explicit

QgsFieldComboBox creates a combo box to display the fields of a layer.

The layer can be either manually given or dynamically set by connecting the signal QgsMapLayerComboBox::layerChanged to the slot setLayer.

Definition at line 23 of file qgsfieldcombobox.cpp.

Member Function Documentation

◆ allowEmptyFieldName()

bool QgsFieldComboBox::allowEmptyFieldName ( ) const

Returns true if the combo box allows the empty field ("not set") choice.

See also: setAllowEmptyFieldName()

Definition at line 42 of file qgsfieldcombobox.cpp.

◆ currentField()

QString QgsFieldComboBox::currentField ( ) const

Returns the currently selected field.

Definition at line 93 of file qgsfieldcombobox.cpp.

◆ fieldChanged

void QgsFieldComboBox::fieldChanged ( const QString & fieldName )

signal

Emitted when the currently selected field changes.

◆ fields()

QgsFields QgsFieldComboBox::fields ( ) const

Returns the fields currently shown in the combobox.

This will either be fields from the associated layer() or the fields manually set by a call to setFields().

Since: QGIS 3.14

Definition at line 63 of file qgsfieldcombobox.cpp.

◆ filters()

QgsFieldProxyModel::Filters QgsFieldComboBox::filters ( ) const

inline

currently used filter on list of fields

Definition at line 55 of file qgsfieldcombobox.h.

◆ indexChanged

void QgsFieldComboBox::indexChanged ( int i )

protectedslot

Definition at line 107 of file qgsfieldcombobox.cpp.

◆ layer()

QgsVectorLayer * QgsFieldComboBox::layer ( ) const

Returns the layer currently associated with the combobox.

See also: setLayer()

Definition at line 53 of file qgsfieldcombobox.cpp.

◆ setAllowEmptyFieldName()

void QgsFieldComboBox::setAllowEmptyFieldName ( bool allowEmpty )

Sets whether an optional empty field ("not set") option is shown in the combo box.

See also: allowEmptyFieldName()

Definition at line 37 of file qgsfieldcombobox.cpp.

◆ setField

void QgsFieldComboBox::setField ( const QString & fieldName )

slot

setField sets the currently selected field

Definition at line 68 of file qgsfieldcombobox.cpp.

◆ setFields()

void QgsFieldComboBox::setFields ( const QgsFields & fields )

Manually sets the fields to use for the combo box.

This method should only be used when the combo box ISN'T associated with a layer() and needs to show the fields from an arbitrary field collection instead. Calling setFields() will automatically clear any existing layer().

See also: fields()

Since: QGIS 3.14

Definition at line 58 of file qgsfieldcombobox.cpp.

◆ setFilters()

void QgsFieldComboBox::setFilters ( QgsFieldProxyModel::Filters filters )

setFilters allows filtering according to the type of field

Definition at line 32 of file qgsfieldcombobox.cpp.

◆ setLayer

void QgsFieldComboBox::setLayer ( QgsMapLayer * layer )

slot

Sets the layer for which fields are listed in the combobox.

If no layer is set or a non-vector layer is set then the combobox will be empty.

See also: layer()

Definition at line 47 of file qgsfieldcombobox.cpp.

Property Documentation

◆ allowEmptyFieldName

bool QgsFieldComboBox::allowEmptyFieldName

readwrite

Definition at line 41 of file qgsfieldcombobox.h.

◆ filters

QgsFieldProxyModel::Filters QgsFieldComboBox::filters