Class: QgsSearchWidgetToolButton¶
-
class
qgis.gui.
QgsSearchWidgetToolButton
(parent: QWidget = None)¶ Bases:
PyQt5.QtWidgets.QToolButton
Constructor for QgsSearchWidgetToolButton.
- Parameters
parent (QWidget = None) – parent object
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.
Methods
Returns the active filter flags shown in the widget.
Returns the available filter flags shown in the widget.
Returns
True
if the widget is set to be included in the search.Sets the search widget as active by selecting the first available search type.
Sets the current active filter flags for the widget.
Sets the available filter flags to show in the widget.
Sets the default filter flags to show in the widget.
Sets the search widget as inactive, ie do not search the corresponding field.
Toggles an individual active filter flag for the widget.
Signals
Emitted when the active flags selected in the widget is changed
-
actionEvent
(self, QActionEvent)¶
-
activeFlags
(self) → QgsSearchWidgetWrapper.FilterFlags¶ Returns the active filter flags shown in the widget.
See also
See also
See also
- Return type
-
activeFlagsChanged
¶ Emitted when the active flags selected in the widget is changed
- Parameters
flags (Union[QgsSearchWidgetWrapper.FilterFlags) – active flags [signal]
-
availableFlags
(self) → QgsSearchWidgetWrapper.FilterFlags¶ Returns the available filter flags shown in the widget.
See also
See also
- Return type
-
changeEvent
(self, QEvent)¶
-
checkStateSet
(self)¶
-
childEvent
(self, QChildEvent)¶
-
closeEvent
(self, QCloseEvent)¶
-
connectNotify
(self, QMetaMethod)¶
-
contextMenuEvent
(self, QContextMenuEvent)¶
-
create
(self, window: 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
See also
- 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], 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
See also
-
setActiveFlags
(self, flags: Union[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
See also
See also
-
setAvailableFlags
(self, flags: Union[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
See also
See also
-
setDefaultFlags
(self, flags: Union[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
See also
-
setInactive
(self)¶ Sets the search widget as inactive, ie do not search the corresponding field.
See also
See also
-
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
See also
-
updateMicroFocus
(self)¶
-
wheelEvent
(self, QWheelEvent)¶