Class: QgsRelationReferenceSearchWidgetWrapper

class qgis.gui.QgsRelationReferenceSearchWidgetWrapper

Bases: QgsSearchWidgetWrapper

Wraps a relation reference search widget.

New in version 2.16.

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

Parameters
applyDirectly(self) bool
Return type

bool

childEvent(self, QChildEvent)
clearExpression(self)

clears the expression to search for all features

clearWidget(self)
connectNotify(self, QMetaMethod)
createExpression(self, flags: Union[QgsSearchWidgetWrapper.FilterFlags, QgsSearchWidgetWrapper.FilterFlag]) str
Parameters

flags (Union[QgsSearchWidgetWrapper.FilterFlags) –

Return type

str

createWidget(self, parent: QWidget) QWidget
Parameters

parent (QWidget) –

Return type

QWidget

customEvent(self, QEvent)
defaultFlags(self) QgsSearchWidgetWrapper.FilterFlags

Returns the default flags (equalTo)

Return type

QgsSearchWidgetWrapper.FilterFlags

disconnectNotify(self, QMetaMethod)
expression(self) str
Return type

str

initWidget(self, editor: QWidget)
Parameters

editor (QWidget) –

isSignalConnected(self, 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, PYQT_SIGNAL) int
sender(self) QObject
senderSignalIndex(self) int
setEnabled(self, enabled: bool)
Parameters

enabled (bool) –

setExpression(self, exp: str)
Parameters

exp (str) –

setFeature(self, feature: QgsFeature)
supportedFlags(self) QgsSearchWidgetWrapper.FilterFlags
Return type

QgsSearchWidgetWrapper.FilterFlags

timerEvent(self, QTimerEvent)
valid(self) bool
Return type

bool

value(self) Any

Returns a variant representing the current state of the widget.

Return type

Any