Class: QgsCheckboxSearchWidgetWrapper¶
- class qgis.gui.QgsCheckboxSearchWidgetWrapper¶
Bases:
QgsSearchWidgetWrapper
Wraps a checkbox edit widget for searching.
QgsCheckboxSearchWidgetWrapper(vl:
QgsVectorLayer
, fieldIdx: int, parent: QWidget = None) Constructor for QgsCheckboxSearchWidgetWrapper.- Parameters:
vl – associated vector layer
fieldIdx – index of associated field
parent –
parent widget
Methods
- rtype:
bool
clears the expression to search for all features
- param flags:
- param parent:
- rtype:
QgsSearchWidgetWrapper.FilterFlags
- rtype:
str
- param editor:
- param enabled:
- param expression:
- rtype:
QgsSearchWidgetWrapper.FilterFlags
- rtype:
bool
Returns a variant representing the current state of the widget.
- 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: 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:
- 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:
- 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
orFalse
value, it will instead be the values configured to represent checked and unchecked states in the editor widget configuration.- Return type:
Any