Class: QgsSearchWidgetToolButton

class qgis.gui.QgsSearchWidgetToolButton

Bases: PyQt5.QtWidgets.QToolButton

A tool button widget which is displayed next to search widgets in forms, and allows for controlling how the widget behaves and how the filtering/searching operates.

New in version 2.16.

QgsSearchWidgetToolButton(parent: QWidget = None) Constructor for QgsSearchWidgetToolButton.

Parameters:

parent

parent object

Methods

actionEvent

activeFlags

Returns the active filter flags shown in the widget.

availableFlags

Returns the available filter flags shown in the widget.

changeEvent

checkStateSet

childEvent

closeEvent

connectNotify

contextMenuEvent

create

customEvent

destroy

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

enterEvent

event

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPreviousChild

hideEvent

hitButton

initPainter

initStyleOption

inputMethodEvent

isActive

Returns True if the widget is set to be included in the search.

isSignalConnected

keyPressEvent

keyReleaseEvent

leaveEvent

metric

mouseDoubleClickEvent

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

moveEvent

nativeEvent

nextCheckState

paintEvent

receivers

resizeEvent

sender

senderSignalIndex

setActive

Sets the search widget as active by selecting the first available search type.

setActiveFlags

Sets the current active filter flags for the widget.

setAvailableFlags

Sets the available filter flags to show in the widget.

setDefaultFlags

Sets the default filter flags to show in the widget.

setInactive

Sets the search widget as inactive, ie do not search the corresponding field.

sharedPainter

showEvent

tabletEvent

timerEvent

toggleFlag

Toggles an individual active filter flag for the widget.

updateMicroFocus

wheelEvent

Signals

activeFlagsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

actionEvent(self, QActionEvent)
activeFlags(self) QgsSearchWidgetWrapper.FilterFlags

Returns the active filter flags shown in the widget.

See also

setActiveFlags()

See also

toggleFlag()

See also

availableFlags()

Return type:

QgsSearchWidgetWrapper.FilterFlags

activeFlagsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:
  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

availableFlags(self) QgsSearchWidgetWrapper.FilterFlags

Returns the available filter flags shown in the widget.

See also

activeFlags()

Return type:

QgsSearchWidgetWrapper.FilterFlags

changeEvent(self, QEvent)
checkStateSet(self)
childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: PyQt5.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent) bool
focusInEvent(self, QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, bool) bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self) bool
hideEvent(self, QHideEvent)
hitButton(self, QPoint) bool
initPainter(self, QPainter)
initStyleOption(self, QStyleOptionToolButton)
inputMethodEvent(self, QInputMethodEvent)
isActive(self) bool

Returns True if the widget is set to be included in the search.

See also

setInactive()

See also

setActive()

Return type:

bool

isSignalConnected(self, QMetaMethod) bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
metric(self, QPaintDevice.PaintDeviceMetric) int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], PyQt5.sip.voidptr) Tuple[bool, int]
nextCheckState(self)
paintEvent(self, QPaintEvent)
receivers(self, PYQT_SIGNAL) int
resizeEvent(self, QResizeEvent)
sender(self) QObject
senderSignalIndex(self) int
setActive(self)

Sets the search widget as active by selecting the first available search type.

See also

isActive()

See also

setInactive()

setActiveFlags(self, flags: QgsSearchWidgetWrapper.FilterFlags | QgsSearchWidgetWrapper.FilterFlag)

Sets the current active filter flags for the widget. Any flags which are not present in the available filter flags (see availableFlags()) will not be set.

Parameters:

flags (Union[QgsSearchWidgetWrapper.FilterFlags) – active flags to show in widget

See also

toggleFlag()

See also

activeFlags()

setAvailableFlags(self, flags: QgsSearchWidgetWrapper.FilterFlags | QgsSearchWidgetWrapper.FilterFlag)

Sets the available filter flags to show in the widget. Any active flags (see activeFlags()) which are not present in the new available filter flags will be cleared;

Parameters:

flags (Union[QgsSearchWidgetWrapper.FilterFlags) – available flags to show in widget

See also

availableFlags()

See also

setActiveFlags()

setDefaultFlags(self, flags: QgsSearchWidgetWrapper.FilterFlags | QgsSearchWidgetWrapper.FilterFlag)

Sets the default filter flags to show in the widget.

Parameters:

flags (Union[QgsSearchWidgetWrapper.FilterFlags) – default flags to show in widget

See also

setActiveFlags()

setInactive(self)

Sets the search widget as inactive, ie do not search the corresponding field.

See also

isActive()

See also

setActive()

sharedPainter(self) QPainter
showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
toggleFlag(self, flag: QgsSearchWidgetWrapper.FilterFlag)

Toggles an individual active filter flag for the widget. Any flags which are not present in the available filter flags (see availableFlags()) will be ignore. Other flags may be cleared if they conflict with the newly toggled flag.

Parameters:

flag (QgsSearchWidgetWrapper.FilterFlag) – flag to toggle

See also

setActiveFlags()

See also

activeFlags()

updateMicroFocus(self)
wheelEvent(self, QWheelEvent)