Class: QgsRelationReferenceSearchWidgetWrapper

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

Bases: qgis._gui.QgsSearchWidgetWrapper

Constructor for QgsRelationReferenceSearchWidgetWrapper

Parameters:
  • vl – associated vector layer
  • fieldIdx – associated field index
  • canvas – optional map canvas
  • parent – parent widget

Wraps a relation reference search widget.

New in version 2.16: Methods

applyDirectly
childEvent
clearExpression
clearWidget
connectNotify
createExpression
createWidget
customEvent
disconnectNotify
expression
initWidget
isSignalConnected
onValueChanged Called when current value of search widget changes
receivers
sender
senderSignalIndex
setEnabled
setExpression
setFeature
supportedFlags
timerEvent
valid
value Returns a variant representing the current state of the widget.

Signals

Attributes

applyDirectly(self) → bool
childEvent()
clearExpression()
clearWidget(self)
connectNotify()
createExpression(self, flags: Union[QgsSearchWidgetWrapper.FilterFlags, QgsSearchWidgetWrapper.FilterFlag]) → str
createWidget(self, parent: QWidget) → QWidget
customEvent()
disconnectNotify()
expression(self) → str
initWidget(self, editor: QWidget)
isSignalConnected()
onValueChanged(self, value: Any)

Called when current value of search widget changes

receivers()
sender()
senderSignalIndex()
setEnabled(self, enabled: bool)
setExpression(self, exp: str)
setFeature()
supportedFlags(self) → QgsSearchWidgetWrapper.FilterFlags
timerEvent()
valid(self) → bool
value(self) → Any

Returns a variant representing the current state of the widget.