Class: QgsRelationReferenceSearchWidgetWrapper

Wraps a relation reference search widget.

Class Hierarchy

Base classes

QgsSearchWidgetWrapper	Shows a search widget on a filter form.
QgsWidgetWrapper	Manages an editor widget.
QObject

Methods

onValueChanged	Called when current value of search widget changes
value	Returns a variant representing the current state of the widget.

Virtual Methods

In PyQGIS, only methods marked as virtual can be safely overridden in a Python subclass of QgsRelationReferenceSearchWidgetWrapper. See the FAQ for more details.

defaultFlags

Returns the default flags (equalTo)

class qgis.gui.QgsRelationReferenceSearchWidgetWrapper

Bases: QgsSearchWidgetWrapper

__init__(vl: QgsVectorLayer | None, fieldIdx: int, canvas: QgsMapCanvas | None, parent: QWidget | None = None)

Constructor for QgsRelationReferenceSearchWidgetWrapper

Parameters:

• vl (Optional[QgsVectorLayer]) – associated vector layer

• fieldIdx (int) – associated field index

• canvas (Optional[QgsMapCanvas]) – optional map canvas

• parent (Optional[QWidget] = None) – parent widget

virtual defaultFlags(self) → QgsSearchWidgetWrapper.FilterFlags

Returns the default flags (equalTo)

Return type:

QgsSearchWidgetWrapper.FilterFlags

onValueChanged(self, value: Any)

Called when current value of search widget changes

Deprecated since version 3.10: Made private.

Parameters:

value (Any)

value(self) → Any

Returns a variant representing the current state of the widget.

Return type:

Any