Class: QgsValueRelationSearchWidgetWrapper

class qgis.gui.QgsValueRelationSearchWidgetWrapper(vl: QgsVectorLayer, fieldIdx: int, parent: QWidget = None)

Bases: QgsSearchWidgetWrapper

Constructor for QgsValueRelationSearchWidgetWrapper

Wraps a value relation search widget. This widget will offer a combobox with values from another layer referenced by a foreign key (a constraint may be set but is not required on data level). It will be used as a search widget and produces expression to look for in the layer.

Parameters
applyDirectly(self) → bool
Return type

bool

childEvent()
clearExpression()
clearWidget(self)
connectNotify()
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()
defaultFlags(self) → QgsSearchWidgetWrapper.FilterFlags
Return type

QgsSearchWidgetWrapper.FilterFlags

disconnectNotify()
expression(self) → str
Return type

str

initWidget(self, editor: QWidget)
Parameters

editor (QWidget) –

isSignalConnected()
onValueChanged(self)

Called when current value of search widget changes

receivers()
sender()
senderSignalIndex()
setEnabled(self, enabled: bool)
Parameters

enabled (bool) –

setExpression(self, exp: str)
Parameters

exp (str) –

setFeature()
supportedFlags(self) → QgsSearchWidgetWrapper.FilterFlags
Return type

QgsSearchWidgetWrapper.FilterFlags

timerEvent()
valid(self) → bool
Return type

bool

value(self) → Any
Return type

Any