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 Widget and wrapper share the same parent
QObject

Methods

defaultFlags	Returns the default flags (equalTo)
onValueChanged	Called when current value of search widget changes
value	Returns a variant representing the current state of the widget.

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

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