Class: QgsCheckboxSearchWidgetWrapper

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

Bases: QgsSearchWidgetWrapper

Constructor for QgsCheckboxSearchWidgetWrapper.

Parameters
  • vl (QgsVectorLayer) – associated vector layer

  • fieldIdx (int) – index of associated field

  • parent (QWidget = None) – parent widget

Wraps a checkbox edit widget for searching.

Methods

applyDirectly

rtype

bool

childEvent

clearExpression

clearWidget

connectNotify

createExpression

param flags

createWidget

param parent

customEvent

defaultFlags

rtype

QgsSearchWidgetWrapper.FilterFlags

disconnectNotify

expression

rtype

str

initWidget

param editor

isSignalConnected

receivers

sender

senderSignalIndex

setEnabled

param enabled

setExpression

param expression

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()
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()
receivers()
sender()
senderSignalIndex()
setEnabled(self, enabled: bool)
Parameters

enabled (bool) –

setExpression(self, expression: str)
Parameters

expression (str) –

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

QgsSearchWidgetWrapper.FilterFlags

timerEvent()
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