Class: QgsSearchWidgetWrapper

class qgis.gui.QgsSearchWidgetWrapper

Bases: QgsWidgetWrapper

Shows a search widget on a filter form.

QgsSearchWidgetWrapper(vl: QgsVectorLayer, fieldIdx: int, parent: QWidget = None) Create a new widget wrapper

Parameters
Between = 128
CaseInsensitive = 256
Contains = 512
DoesNotContain = 1024
EndsWith = 32768
EqualTo = 2
class FilterFlag

Bases: int

class FilterFlags
class FilterFlags(Union[QgsSearchWidgetWrapper.FilterFlags, QgsSearchWidgetWrapper.FilterFlag]) None
class FilterFlags(QgsSearchWidgetWrapper.FilterFlags) None

Bases: sip.wrapper

GreaterThan = 8
GreaterThanOrEqualTo = 32
IsNotBetween = 4096
IsNotNull = 8192
IsNull = 2048
LessThan = 16
LessThanOrEqualTo = 64
NotEqualTo = 4
StartsWith = 16384
aggregate(self) str

If in AggregateSearch mode, which aggregate should be used to construct the filter expression. Is a Null String if none.

New in version 3.0.

Return type

str

applyDirectly(self) bool

If this is True, then this search widget should take effect directly when its expression changes

Return type

bool

childEvent(self, QChildEvent)
clearExpression(self)

clears the expression to search for all features

clearWidget(self)

Clears the widget’s current value and resets it back to the default state

New in version 2.16.

connectNotify(self, QMetaMethod)
createExpression(self, flags: Union[QgsSearchWidgetWrapper.FilterFlags, QgsSearchWidgetWrapper.FilterFlag]) str

Creates a filter expression based on the current state of the search widget and the specified filter flags.

Parameters

flags (Union[QgsSearchWidgetWrapper.FilterFlags) – filter flags

Return type

str

Returns

filter expression

New in version 2.16.

createFieldIdentifier(self) str

Gets a field name or expression to use as field comparison. If in SearchMode returns a quoted field identifier. If in AggregateSearchMode returns an appropriate aggregate expression.

New in version 3.0.

Return type

str

customEvent(self, QEvent)
defaultFlags(self) QgsSearchWidgetWrapper.FilterFlags

Returns the filter flags which should be set by default for the search widget.

See also

supportedFlags()

New in version 2.16.

Return type

QgsSearchWidgetWrapper.FilterFlags

disconnectNotify(self, QMetaMethod)
exclusiveFilterFlags() object

Returns a list of exclusive filter flags, which cannot be combined with other flags (e.g., EqualTo/NotEqualTo)

New in version 2.16.

Return type

object

expression(self) str

Will be used to access the widget’s value. Read the value from the widget and return it properly formatted to be saved in the attribute.

If an invalid variant is returned this will be interpreted as no change. Be sure to return a NULL QVariant if it should be set to NULL.

Return type

str

Returns

The current value the widget represents

expressionChanged

Emitted whenever the expression changes

Parameters

exp (str) – The new search expression [signal]

fieldIndex(self) int

Returns the field index

New in version 3.10.

Return type

int

isSignalConnected(self, QMetaMethod) bool
nonExclusiveFilterFlags() object

Returns a list of non-exclusive filter flags, which can be combined with other flags (e.g., CaseInsensitive)

New in version 2.16.

Return type

object

receivers(self, PYQT_SIGNAL) int
sender(self) QObject
senderSignalIndex(self) int
setAggregate(self, aggregate: str)

If in AggregateSearch mode, which aggregate should be used to construct the filter expression. Is a Null String if none.

New in version 3.0.

Parameters

aggregate (str) –

setEnabled(self, enabled: bool)

Toggles whether the search widget is enabled or disabled.

Parameters

enabled (bool) – set to True to enable widget

setExpression(self, expression: str)

Set the expression which is currently used as filter for this widget.

Parameters

expression (str) –

setFeature(self, feature: QgsFeature)
Parameters

feature (QgsFeature) –

supportedFlags(self) QgsSearchWidgetWrapper.FilterFlags

Returns filter flags supported by the search widget.

See also

defaultFlags()

New in version 2.16.

Return type

QgsSearchWidgetWrapper.FilterFlags

timerEvent(self, QTimerEvent)
toString(flag: QgsSearchWidgetWrapper.FilterFlag) str

Returns a translated string representing a filter flag.

Parameters

flag (QgsSearchWidgetWrapper.FilterFlag) – flag to convert to string

New in version 2.16.

Return type

str

valueChanged

Emitted when a user changes the value of the search widget.

New in version 2.16: [signal]

valueCleared

Emitted when a user changes the value of the search widget back to an empty, default state.

New in version 2.16: [signal]