Class: QgsCheckboxSearchWidgetWrapper

Wraps a checkbox edit widget for searching.

Class Hierarchy

Inheritance diagram of qgis.gui.QgsCheckboxSearchWidgetWrapper

Base classes

QgsSearchWidgetWrapper

Shows a search widget on a filter form.

QgsWidgetWrapper

Manages an editor widget.

QObject

Methods

value

Returns a variant representing the current state of the widget.
class qgis.gui.QgsCheckboxSearchWidgetWrapper[source]

Bases: QgsSearchWidgetWrapper

__init__(vl: QgsVectorLayer | None, fieldIdx: int, parent: QWidget | None = None)

Constructor for QgsCheckboxSearchWidgetWrapper.

Parameters:

  • vl (Optional[QgsVectorLayer]) – associated vector layer

  • fieldIdx (int) – index of associated field

  • parent (Optional[QWidget] = None) – parent widget

value(self) → Any[source]

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