Class: QgsDefaultSearchWidgetWrapper

class qgis.gui.QgsDefaultSearchWidgetWrapper

Bases: QgsSearchWidgetWrapper

Wraps a search widget. Default form is just a QgsLineFilterEdit

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

Methods

applyDirectly

rtype:

bool

caseSensitiveCheckBox

Returns a pointer to the case sensitivity checkbox in the widget.

childEvent

clearExpression

clears the expression to search for all features

clearWidget

connectNotify

createExpression

param flags:

createWidget

param parent:

customEvent

defaultFlags

rtype:

QgsSearchWidgetWrapper.FilterFlags

disconnectNotify

expression

rtype:

str

initWidget

param editor:

isSignalConnected

lineEdit

Returns a pointer to the line edit part of the widget.

receivers

sender

senderSignalIndex

setEnabled

param enabled:

setExpression

param exp:

setFeature

supportedFlags

rtype:

QgsSearchWidgetWrapper.FilterFlags

timerEvent

valid

rtype:

bool

applyDirectly(self) bool
Return type:

bool

caseSensitiveCheckBox(self) QCheckBox

Returns a pointer to the case sensitivity checkbox in the widget.

Note

this method is in place for unit testing only, and is not considered stable API

Return type:

QCheckBox

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:

QgsSearchWidgetWrapper.FilterFlags

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

str

initWidget(self, editor: QWidget)
Parameters:

editor (QWidget) –

isSignalConnected(self, QMetaMethod) bool
lineEdit(self) QgsFilterLineEdit

Returns a pointer to the line edit part of the widget.

Note

this method is in place for unit testing only, and is not considered stable API

Return type:

QgsFilterLineEdit

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

enabled (bool) –

setExpression(self, exp: str)
Parameters:

exp (str) –

setFeature(self, feature: QgsFeature)
supportedFlags(self) QgsSearchWidgetWrapper.FilterFlags
Return type:

QgsSearchWidgetWrapper.FilterFlags

timerEvent(self, QTimerEvent)
valid(self) bool
Return type:

bool