Class: QgsRelationReferenceSearchWidgetWrapper¶

class qgis.gui.QgsRelationReferenceSearchWidgetWrapper¶

Bases: QgsSearchWidgetWrapper

Wraps a relation reference search widget.

QgsRelationReferenceSearchWidgetWrapper(vl: Optional[QgsVectorLayer], fieldIdx: int, canvas: Optional[QgsMapCanvas], parent: Optional[QWidget] = None) Constructor for QgsRelationReferenceSearchWidgetWrapper

Parameters:

vl – associated vector layer
fieldIdx – associated field index
canvas – optional map canvas

parent –

parent widget

Methods

`applyDirectly`	rtype: bool
`childEvent`
`clearExpression`	clears the expression to search for all features
`clearWidget`
`connectNotify`
`createExpression`	param flags:
`createWidget`	param parent:
`customEvent`
`defaultFlags`	Returns the default flags (equalTo)
`disconnectNotify`
`expression`	rtype: str
`initWidget`	param editor:
`isSignalConnected`
`onValueChanged`	Called when current value of search widget changes
`receivers`
`sender`
`senderSignalIndex`
`setEnabled`	param enabled:
`setExpression`	param exp:
`setFeature`
`supportedFlags`	rtype: QgsSearchWidgetWrapper.FilterFlags
`timerEvent`
`valid`	rtype: bool
`value`	Returns a variant representing the current state of the widget.

applyDirectly(self) → bool¶

Return type:: bool

childEvent(self, a0: QChildEvent | None)¶

clearExpression(self)¶: clears the expression to search for all features

clearWidget(self)¶

connectNotify(self, signal: QMetaMethod)¶

createExpression(self, flags: QgsSearchWidgetWrapper.FilterFlags | QgsSearchWidgetWrapper.FilterFlag) → str¶

Parameters:: flags (Union[QgsSearchWidgetWrapper.FilterFlags)
Return type:: str

createWidget(self, parent: QWidget | None) → QWidget | None¶

Parameters:: parent (Optional[QWidget])
Return type:: Optional[QWidget]

customEvent(self, a0: QEvent | None)¶

defaultFlags(self) → QgsSearchWidgetWrapper.FilterFlags¶

Returns the default flags (equalTo)

Return type:: QgsSearchWidgetWrapper.FilterFlags

disconnectNotify(self, signal: QMetaMethod)¶

expression(self) → str¶

Return type:: str

initWidget(self, editor: QWidget | None)¶

Parameters:: editor (Optional[QWidget])

isSignalConnected(self, signal: QMetaMethod) → bool¶

onValueChanged(self, value: Any)¶

Called when current value of search widget changes

Deprecated since version QGIS: 3.10 made private

Parameters:: value (Any)

receivers(self, signal: PYQT_SIGNAL) → int¶

sender(self) → QObject | None¶

senderSignalIndex(self) → int¶

setEnabled(self, enabled: bool)¶

Parameters:: enabled (bool)

setExpression(self, exp: str | None)¶

Parameters:: exp (Optional[str])

setFeature(self, feature: QgsFeature)¶

supportedFlags(self) → QgsSearchWidgetWrapper.FilterFlags¶

Return type:: QgsSearchWidgetWrapper.FilterFlags

timerEvent(self, a0: QTimerEvent | None)¶

valid(self) → bool¶

Return type:: bool

value(self) → Any¶

Returns a variant representing the current state of the widget.

Return type:: Any