Class: QgsCheckboxSearchWidgetWrapper

class qgis.gui.QgsCheckboxSearchWidgetWrapper

Bases: QgsSearchWidgetWrapper

Wraps a checkbox edit widget for searching.

New in version 2.16.

QgsCheckboxSearchWidgetWrapper(vl: QgsVectorLayer, fieldIdx: int, parent: QWidget = None) Constructor for QgsCheckboxSearchWidgetWrapper.

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
Return type

QgsSearchWidgetWrapper.FilterFlags

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

str

initWidget(self, editor: QWidget)
Parameters

editor (QWidget) –

isSignalConnected(self, QMetaMethod)bool
receivers(self, PYQT_SIGNAL)int
sender(self)QObject
senderSignalIndex(self)int
setEnabled(self, enabled: bool)
Parameters

enabled (bool) –

setExpression(self, expression: str)
Parameters

expression (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.

Note

this will not be a boolean True or False value, it will instead be the values configured to represent checked and unchecked states in the editor widget configuration.

Return type

Any