schrodinger.ui.qt.filter_list module

Module for widgets that allow for dynamic filtering of a list.

Copyright Schrodinger, LLC. All rights reserved.

class schrodinger.ui.qt.filter_list.FilterCheckBox(label_text, filter_func, parent=None, on_by_default=False)

Bases: PyQt6.QtWidgets.QCheckBox

A checkbox that applies a predefined filter to items in a QtWidgets.QListWidget.

__init__(label_text, filter_func, parent=None, on_by_default=False)

Parameters

• label_text (str) – Label text to be shown for this checkbox.

• filter_func (callable) – Filter function to be applied to the list items.

• parent (QtWidgets.QWidget) – Parent widget.

• on_by_default (bool) – Whether the filter is on by default.

setDefault()

Reset the checkbox to it’s default state.

applyFilter(list_items)

Apply the filter for this checkbox to the specified list items. Note that items will not be unhidden, so any allowed items should be explicitly unhidden before being passed here.

Parameters

list_items (iterable(QtWidgets.QListWidgetItem)) – List items to be filtered

DrawChildren = 2

DrawWindowBackground = 1

IgnoreMask = 4

class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1

PdmHeight = 2

PdmWidthMM = 3

PdmHeightMM = 4

PdmNumColors = 5

PdmDepth = 6

PdmDpiX = 7

PdmDpiY = 8

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1

DrawChildren = 2

IgnoreMask = 4

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

adjustSize(self)

animateClick(self)

autoExclusive(self) → bool

autoFillBackground(self) → bool

autoRepeat(self) → bool

autoRepeatDelay(self) → int

autoRepeatInterval(self) → int

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, bool) → bool

changeEvent(self, QEvent)

checkState(self) → Qt.CheckState

checkStateSet(self)

childAt(self, QPoint) → QWidget

FilterCheckBox.childAt(self, int, int) -> QWidget

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

click(self)

clicked

clicked(self, checked: bool = False) [signal]

close(self) → bool

closeEvent(self, QCloseEvent)

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)

createWindowContainer(QWindow, parent: QWidget = None, flags: Qt.WindowType = Qt.WindowFlags()) → QWidget

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)

deleteLater(self)

depth(self) → int

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)

destroyed

destroyed(self, object: QObject = None) [signal]

devType(self) → int

devicePixelRatio(self) → float

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, QMetaMethod)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → PyQt6.sip.voidptr

ensurePolished(self)

enterEvent(self, QEnterEvent)

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

find(PyQt6.sip.voidptr) → QWidget

findChild(self, type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObject

findChild(self, Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObject

findChildren(self, type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, type, QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

frameGeometry(self) → QRect

frameSize(self) → QSize

geometry(self) → QRect

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) → QPixmap

grabGesture(self, Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())

grabKeyboard(self)

grabMouse(self)

grabMouse(self, Union[QCursor, Qt.CursorShape]) → None

grabShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) → int

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

group(self) → QButtonGroup

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, int) → int

heightMM(self) → int

hide(self)

hideEvent(self, QHideEvent)

hitButton(self, QPoint) → bool

icon(self) → QIcon

iconSize(self) → QSize

inherits(self, str) → bool

initPainter(self, QPainter)

initStyleOption(self, QStyleOptionButton)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHint

inputMethodQuery(self, Qt.InputMethodQuery) → Any

FilterCheckBox.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

installEventFilter(self, QObject)

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isCheckable(self) → bool

isChecked(self) → bool

isDown(self) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, QMetaMethod) → bool

isTristate(self) → bool

isVisible(self) → bool

isVisibleTo(self, QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, QEvent)

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFrom(self, QWidget, QPointF) → QPointF

mapFromGlobal(self, QPoint) → QPoint

mapFromGlobal(self, QPointF) → QPointF

mapFromParent(self, QPoint) → QPoint

mapFromParent(self, QPointF) → QPointF

mapTo(self, QWidget, QPoint) → QPoint

mapTo(self, QWidget, QPointF) → QPointF

mapToGlobal(self, QPoint) → QPoint

mapToGlobal(self, QPointF) → QPointF

mapToParent(self, QPoint) → QPoint

mapToParent(self, QPointF) → QPointF

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

FilterCheckBox.move(self, int, int) -> None

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

nativeEvent(self, QByteArray, PyQt6.sip.voidptr) → Tuple[bool, PyQt6.sip.voidptr]

nativeParentWidget(self) → QWidget

nextCheckState(self)

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

overrideWindowFlags(self, Qt.WindowType)

overrideWindowState(self, Qt.WindowState)

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

pos(self) → QPoint

pressed

pressed(self) [signal]

previousInFocusChain(self) → QWidget

property(self, str) → Any

pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

released

released(self) [signal]

removeAction(self, QAction)

removeEventFilter(self, QObject)

render(self, QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))

render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) → None

repaint(self)

FilterCheckBox.repaint(self, int, int, int, int) -> None

repaint(self, QRect) → None

repaint(self, QRegion) → None

resize(self, QSize)

FilterCheckBox.resize(self, int, int) -> None

resizeEvent(self, QResizeEvent)

restoreGeometry(self, QByteArray) → bool

saveGeometry(self) → QByteArray

screen(self) → QScreen

FilterCheckBox.scroll(self, int, int)

FilterCheckBox.scroll(self, int, int, QRect) -> None

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

setAttribute(self, Qt.WidgetAttribute, on: bool = True)

setAutoExclusive(self, bool)

setAutoFillBackground(self, bool)

setAutoRepeat(self, bool)

setAutoRepeatDelay(self, int)

setAutoRepeatInterval(self, int)

setBackgroundRole(self, QPalette.ColorRole)

FilterCheckBox.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

setCheckState(self, Qt.CheckState)

setCheckable(self, bool)

setChecked(self, bool)

FilterCheckBox.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins) → None

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

setCursor(self, Union[QCursor, Qt.CursorShape])

setDisabled(self, bool)

setDown(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

FilterCheckBox.setFixedSize(self, int, int) -> None

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason) → None

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setGeometry(self, QRect)

FilterCheckBox.setGeometry(self, int, int, int, int) -> None

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setIcon(self, QIcon)

setIconSize(self, QSize)

setInputMethodHints(self, Qt.InputMethodHint)

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion) → None

setMaximumHeight(self, int)

FilterCheckBox.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMinimumHeight(self, int)

FilterCheckBox.setMinimumSize(self, int, int)

setMinimumSize(self, QSize) → None

setMinimumWidth(self, int)

setMouseTracking(self, bool)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

setParent(self, QWidget, Qt.WindowType) → None

setProperty(self, str, Any) → bool

setScreen(self, QScreen)

setShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int])

setShortcutAutoRepeat(self, int, enabled: bool = True)

setShortcutEnabled(self, int, enabled: bool = True)

FilterCheckBox.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize) → None

setSizePolicy(self, QSizePolicy)

setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy) → None

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

FilterCheckBox.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setText(self, str)

setToolTip(self, str)

setToolTipDuration(self, int)

setTristate(self, on: bool = True)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

setWindowFlag(self, Qt.WindowType, on: bool = True)

setWindowFlags(self, Qt.WindowType)

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Qt.WindowState)

setWindowTitle(self, str)

sharedPainter(self) → QPainter

shortcut(self) → QKeySequence

show(self)

showEvent(self, QShowEvent)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

stateChanged

stateChanged(self, int) [signal]

staticMetaObject = <PyQt6.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

text(self) → str

thread(self) → QThread

timerEvent(self, QTimerEvent)

toggle(self)

toggled

toggled(self, bool) [signal]

toolTip(self) → str

toolTipDuration(self) → int

tr(str, disambiguation: str = None, n: int = - 1) → str

underMouse(self) → bool

ungrabGesture(self, Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QRect) → None

update(self, QRegion) → None

FilterCheckBox.update(self, int, int, int, int) -> None

updateGeometry(self)

updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → PyQt6.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowType

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowState

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class schrodinger.ui.qt.filter_list.PredefinedFiltersPopUp(parent, filter_cbs, toggle_filtering_text=None, match_msg=None, no_match_msg=None)

Bases: schrodinger.ui.qt.appframework2.settings.SettingsMixin, schrodinger.ui.qt.pop_up_widgets.PopUp

Class for a popup containing predefined filter checkboxes.

__init__(parent, filter_cbs, toggle_filtering_text=None, match_msg=None, no_match_msg=None)

Parameters

• parent (QtWidgets.QWidget) – Parent widget.

• filter_cbs (iterable(FilterCheckBox)) – tuple of filter checkboxes for this popup.

• toggle_filtering_text (str) – Text to show for a group box checkbox to turn filtering on and off. If not specified, no group box checkbox will be shown.

• match_msg (str) – Label message to display when items match

• no_match_msg (str) – Text to show when no items match filters

setup()

Set up the filters and lay them out in the pop up widget.

hasActiveFilters()

Return whether there are currently active filters.

Returns

Whether there are active filters.

Return type

bool

applyFilters(list_items)

Apply all active filters to the specified list items. Note that this function will not unhide any items, so all allowed items should be explicitly shown before being passed here.

Parameters

list_items (iterable(QtWidgets.QListWidgetItem)) – List items to be filtered.

clearFilters()

Clear all predefined filters.

getSettings(**kwargs)

Get the current filter settings.

Returns

Map of the current filter settings

Return type

dict

applySettings(settings)

Apply the specified settings to the filters.

Parameters

settings (dict) – Settings to be applied.

Box = 1

DrawChildren = 2

DrawWindowBackground = 1

HLine = 4

IgnoreMask = 4

NoFrame = 0

class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1

PdmHeight = 2

PdmWidthMM = 3

PdmHeightMM = 4

PdmNumColors = 5

PdmDepth = 6

PdmDpiX = 7

PdmDpiY = 8

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

Panel = 2

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

Plain = 16

Raised = 32

class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1

DrawChildren = 2

IgnoreMask = 4

class Shadow(value)

Bases: enum.IntEnum

An enumeration.

Plain = 16

Raised = 32

Sunken = 48

Shadow_Mask = 240

class Shape(value)

Bases: enum.IntEnum

An enumeration.

NoFrame = 0

Box = 1

Panel = 2

WinPanel = 3

HLine = 4

VLine = 5

StyledPanel = 6

Shape_Mask = 15

class StyleMask(value)

Bases: enum.Enum

An enumeration.

Shadow_Mask = 240

Shape_Mask = 15

StyledPanel = 6

Sunken = 48

VLine = 5

WinPanel = 3

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

adjustSize(self)

applyAliasedSettings(settings)

Applies any aliased settings with new values from the dictionary. Any aliases not present in the settings dictionary will be left unchanged.

Parameters

settings (dict) – a dictionary mapping aliases to new values to apply

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, bool) → bool

changeEvent(self, QEvent)

childAt(self, QPoint) → QWidget

PredefinedFiltersPopUp.childAt(self, int, int) -> QWidget

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(self, QCloseEvent)

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)

createWindowContainer(QWindow, parent: QWidget = None, flags: Qt.WindowType = Qt.WindowFlags()) → QWidget

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)

dataChanged

deleteLater(self)

depth(self) → int

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)

destroyed

destroyed(self, object: QObject = None) [signal]

devType(self) → int

devicePixelRatio(self) → float

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, QMetaMethod)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

drawFrame(self, QPainter)

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → PyQt6.sip.voidptr

ensurePolished(self)

enterEvent(self, QEnterEvent)

estimateMaxHeight()

Return an estimate of the maximum allowable height of this pop up. This estimate is used to ensure that the pop up is positioned within the window. The default implementation uses the current size hint. Subclasses can reimplement this function if they can calculate a more accurate allowable height. This is typically only applicable if the pop up is likely to change size.

Returns

The maximum allowable height

Return type

int

estimateMaxWidth()

Return an estimate of the maximum allowable width of this pop up. This estimate is used to ensure that the pop up is positioned within the window. The default implementation uses the current size hint. Subclasses can reimplement this function if they can calculate a more accurate allowable width. This is typically only applicable if the pop up is likely to change size.

Returns

The maximum allowable width

Return type

int

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

find(PyQt6.sip.voidptr) → QWidget

findChild(self, type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObject

findChild(self, Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObject

findChildren(self, type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, type, QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

frameGeometry(self) → QRect

frameRect(self) → QRect

frameShadow(self) → QFrame.Shadow

frameShape(self) → QFrame.Shape

frameSize(self) → QSize

frameStyle(self) → int

frameWidth(self) → int

geometry(self) → QRect

getAliasedSettings()

getAliasedValue(alias)

getObjValue(obj)

getPersistenceKey(alias)

Return a unique identifier for saving/restoring a setting in the preferences. Override this method to change the key scheme (this is necessary if creating a common resource which is shared by multiple panels).

Parameters

alias (str) – the alias for which we are generating a key

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) → QPixmap

grabGesture(self, Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())

grabKeyboard(self)

grabMouse(self)

grabMouse(self, Union[QCursor, Qt.CursorShape]) → None

grabShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) → int

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, int) → int

heightMM(self) → int

hide(self)

hideEvent(event)

Emit a signal every time this pop up is hidden.

inherits(self, str) → bool

initPainter(self, QPainter)

initStyleOption(self, QStyleOptionFrame)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHint

inputMethodQuery(self, Qt.InputMethodQuery) → Any

PredefinedFiltersPopUp.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

installEventFilter(self, QObject)

installPopUpEventFilter(event_filter)

Install the provided event filter on all widgets within this pop up that can receive focus.

Note

This function only installs the event filter on immediate children of this widget. As a result, keyboard events on grandchildren (or later descendant) widgets will not be handled properly. If this causes issues, the implementation will have to be modified.

Parameters

event_filter (_BasisSelectorPopUpEventFilter) – The event filter to install

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, QEvent)

lineEditUpdated(text)

Update this pop up in response to the user changing the line edit text. Note that, by default, this widget will not be able to send signals during execution of this method. This prevents an infinite loop of PopUp.lineEditUpdated and LineEditWithPopUp.popUpUpdated. To modify this behavior, subclass LineEditWithPopUp and reimplement LineEditWithPopUp.popUpUpdated.

Parameters

text (str) – The current text of the line edit

lineWidth(self) → int

loadPersistentOptions()

Load all persistent options from the preferences.

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFrom(self, QWidget, QPointF) → QPointF

mapFromGlobal(self, QPoint) → QPoint

mapFromGlobal(self, QPointF) → QPointF

mapFromParent(self, QPoint) → QPoint

mapFromParent(self, QPointF) → QPointF

mapTo(self, QWidget, QPoint) → QPoint

mapTo(self, QWidget, QPointF) → QPointF

mapToGlobal(self, QPoint) → QPoint

mapToGlobal(self, QPointF) → QPointF

mapToParent(self, QPoint) → QPoint

mapToParent(self, QPointF) → QPointF

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

midLineWidth(self) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

PredefinedFiltersPopUp.move(self, int, int) -> None

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

nativeEvent(self, QByteArray, PyQt6.sip.voidptr) → Tuple[bool, PyQt6.sip.voidptr]

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

overrideWindowFlags(self, Qt.WindowType)

overrideWindowState(self, Qt.WindowState)

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

popUpResized

pos(self) → QPoint

previousInFocusChain(self) → QWidget

property(self, str) → Any

pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

render(self, QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))

render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) → None

repaint(self)

PredefinedFiltersPopUp.repaint(self, int, int, int, int) -> None

repaint(self, QRect) → None

repaint(self, QRegion) → None

resize(self, QSize)

PredefinedFiltersPopUp.resize(self, int, int) -> None

resizeEvent(self, QResizeEvent)

restoreGeometry(self, QByteArray) → bool

saveGeometry(self) → QByteArray

savePersistentOptions()

Store all persistent options to the preferences.

screen(self) → QScreen

PredefinedFiltersPopUp.scroll(self, int, int)

PredefinedFiltersPopUp.scroll(self, int, int, QRect) -> None

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

setAlias(alias, obj, persistent=False)

Sets an alias to conveniently access an object.

Parameters

• alias (hashable) – any hashable, but typically a string name

• obj (object) – the actual object to be referenced

• persistent (bool) – whether to make the setting persistent

setAliasedValue(alias, value)

setAliases(alias_dict, persistent=False)

Sets multiple aliases at once. Already used aliases are overwritten; other existing aliases are not affected.

Parameters

• alias_dict (dict) – map of aliases to objects

• persistent (bool) – whether to make the settings persistent

setAttribute(self, Qt.WidgetAttribute, on: bool = True)

setAutoFillBackground(self, bool)

setBackgroundRole(self, QPalette.ColorRole)

PredefinedFiltersPopUp.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

PredefinedFiltersPopUp.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins) → None

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

setCursor(self, Union[QCursor, Qt.CursorShape])

setDisabled(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

PredefinedFiltersPopUp.setFixedSize(self, int, int) -> None

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason) → None

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setFrameRect(self, QRect)

setFrameShadow(self, QFrame.Shadow)

setFrameShape(self, QFrame.Shape)

setFrameStyle(self, int)

setGeometry(self, QRect)

PredefinedFiltersPopUp.setGeometry(self, int, int, int, int) -> None

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setInputMethodHints(self, Qt.InputMethodHint)

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLineWidth(self, int)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion) → None

setMaximumHeight(self, int)

PredefinedFiltersPopUp.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMidLineWidth(self, int)

setMinimumHeight(self, int)

PredefinedFiltersPopUp.setMinimumSize(self, int, int)

setMinimumSize(self, QSize) → None

setMinimumWidth(self, int)

setMouseTracking(self, bool)

setObjValue(obj, value)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

setParent(self, QWidget, Qt.WindowType) → None

setPersistent(alias=None)

Set options to be persistent. Any options to be made persistent must be aliased, since the alias is used to form the preference key. If no alias is specified, all aliased settings will be made persistent.

Parameters

alias (str or None) – the alias to save, or None

setProperty(self, str, Any) → bool

setScreen(self, QScreen)

setShortcutAutoRepeat(self, int, enabled: bool = True)

setShortcutEnabled(self, int, enabled: bool = True)

PredefinedFiltersPopUp.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize) → None

setSizePolicy(self, QSizePolicy)

setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy) → None

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

PredefinedFiltersPopUp.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

setWindowFlag(self, Qt.WindowType, on: bool = True)

setWindowFlags(self, Qt.WindowType)

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Qt.WindowState)

setWindowTitle(self, str)

sharedPainter(self) → QPainter

show(self)

showEvent(event)

Emit a signal every time this pop up is shown.

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

staticMetaObject = <PyQt6.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

subWidgetHasFocus()

Return True if any widget within the pop up has focus. False otherwise.

Note

Note that combo boxes have various list view and frame children that can receive focus (and which of these widgets can receive focus varies by OS). As a result, we check the full ancestry of the focus widget here rather than just checking it’s parent. Also note that we can’t use Qt’s isAncestorOf() function to check ancestry, since combo box drop downs are considered to be their own window and isAncestorOf() requires ancestors to be part of the same window.

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, QTimerEvent)

toolTip(self) → str

toolTipDuration(self) → int

tr(str, disambiguation: str = None, n: int = - 1) → str

underMouse(self) → bool

ungrabGesture(self, Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QRect) → None

update(self, QRegion) → None

PredefinedFiltersPopUp.update(self, int, int, int, int) -> None

updateGeometry(self)

updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)

updatesEnabled(self) → bool

visibilityChanged

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → PyQt6.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowType

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowState

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class schrodinger.ui.qt.filter_list.FilterListPopUp(parent, list_items=(), filter_cbs=(), toggle_filtering_text=None, match_msg=None, no_match_msg=None)

Bases: schrodinger.ui.qt.appframework2.settings.SettingsMixin, schrodinger.ui.qt.pop_up_widgets.PopUp

This class implements a group of widgets that can be used to dynamically filter the contents of a list in a popup that can be associated with another widget.

Variables

filtersChanged – Signal emitted when filters are toggled. emits a dict of current filter settings.

filtersChanged

__init__(parent, list_items=(), filter_cbs=(), toggle_filtering_text=None, match_msg=None, no_match_msg=None)

Parameters

• parent (QtWidgets.QWidget) – Parent widget.

• list_items (iterable(QtWidget.QListWidgetItem)) – Items to populate in the filtered list

• filter_cbs (tuple(FilterCheckBox)) – tuple of filter checkboxes for this popup.

• toggle_filtering_text (str) – Text to show for a group box checkbox to turn filtering on and off. If not specified, no group box checkbox will be shown.

• match_msg (str) – Label message to display when items match

• no_match_msg (str) – Text to show when no items match filters

setup()

Sets up the widget’s UI and connections.

applyFilters()

Apply the current filter text and predefined filters to the list contents.

clearFilters()

Clear all item filters.

isItemHidden(item_txt)

Returns

True if the item with the specified text is in the list and hidden, False otherwise.

Return type

bool

onDataChanged()

Emit the dataChanged signal when a new item is selected.

onReturnPressed()

Check if an item has been selected and, if so, set that item as the current item. If a current item has been set, hide the popup.

keyPressEvent(event)

Close the popup if enter/return is pressed.

See Qt documentation for argument documentation.

subWidgetHasFocus()

Return True if any widget within the pop up has focus. False otherwise.

Note

Note that combo boxes have various list view and frame children that can receive focus (and which of these widgets can receive focus varies by OS). As a result, we check the full ancestry of the focus widget here rather than just checking it’s parent. Also note that we can’t use Qt’s isAncestorOf() function to check ancestry, since combo box drop downs are considered to be their own window and isAncestorOf() requires ancestors to be part of the same window.

Box = 1

DrawChildren = 2

DrawWindowBackground = 1

HLine = 4

IgnoreMask = 4

NoFrame = 0

class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1

PdmHeight = 2

PdmWidthMM = 3

PdmHeightMM = 4

PdmNumColors = 5

PdmDepth = 6

PdmDpiX = 7

PdmDpiY = 8

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

Panel = 2

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

Plain = 16

Raised = 32

class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1

DrawChildren = 2

IgnoreMask = 4

class Shadow(value)

Bases: enum.IntEnum

An enumeration.

Plain = 16

Raised = 32

Sunken = 48

Shadow_Mask = 240

class Shape(value)

Bases: enum.IntEnum

An enumeration.

NoFrame = 0

Box = 1

Panel = 2

WinPanel = 3

HLine = 4

VLine = 5

StyledPanel = 6

Shape_Mask = 15

class StyleMask(value)

Bases: enum.Enum

An enumeration.

Shadow_Mask = 240

Shape_Mask = 15

StyledPanel = 6

Sunken = 48

VLine = 5

WinPanel = 3

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

adjustSize(self)

applyAliasedSettings(settings)

Applies any aliased settings with new values from the dictionary. Any aliases not present in the settings dictionary will be left unchanged.

Parameters

settings (dict) – a dictionary mapping aliases to new values to apply

applySettings(settings, target=None)

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, bool) → bool

changeEvent(self, QEvent)

childAt(self, QPoint) → QWidget

FilterListPopUp.childAt(self, int, int) -> QWidget

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(self, QCloseEvent)

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)

createWindowContainer(QWindow, parent: QWidget = None, flags: Qt.WindowType = Qt.WindowFlags()) → QWidget

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)

dataChanged

deleteLater(self)

depth(self) → int

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)

destroyed

destroyed(self, object: QObject = None) [signal]

devType(self) → int

devicePixelRatio(self) → float

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, QMetaMethod)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

drawFrame(self, QPainter)

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → PyQt6.sip.voidptr

ensurePolished(self)

enterEvent(self, QEnterEvent)

estimateMaxHeight()

Return an estimate of the maximum allowable height of this pop up. This estimate is used to ensure that the pop up is positioned within the window. The default implementation uses the current size hint. Subclasses can reimplement this function if they can calculate a more accurate allowable height. This is typically only applicable if the pop up is likely to change size.

Returns

The maximum allowable height

Return type

int

estimateMaxWidth()

Return an estimate of the maximum allowable width of this pop up. This estimate is used to ensure that the pop up is positioned within the window. The default implementation uses the current size hint. Subclasses can reimplement this function if they can calculate a more accurate allowable width. This is typically only applicable if the pop up is likely to change size.

Returns

The maximum allowable width

Return type

int

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

find(PyQt6.sip.voidptr) → QWidget

findChild(self, type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObject

findChild(self, Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObject

findChildren(self, type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, type, QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

frameGeometry(self) → QRect

frameRect(self) → QRect

frameShadow(self) → QFrame.Shadow

frameShape(self) → QFrame.Shape

frameSize(self) → QSize

frameStyle(self) → int

frameWidth(self) → int

geometry(self) → QRect

getAliasedSettings()

getAliasedValue(alias)

getObjValue(obj)

getPersistenceKey(alias)

Return a unique identifier for saving/restoring a setting in the preferences. Override this method to change the key scheme (this is necessary if creating a common resource which is shared by multiple panels).

Parameters

alias (str) – the alias for which we are generating a key

getSettings(target=None, ignore_list=None)

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) → QPixmap

grabGesture(self, Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())

grabKeyboard(self)

grabMouse(self)

grabMouse(self, Union[QCursor, Qt.CursorShape]) → None

grabShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) → int

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, int) → int

heightMM(self) → int

hide(self)

hideEvent(event)

Emit a signal every time this pop up is hidden.

inherits(self, str) → bool

initPainter(self, QPainter)

initStyleOption(self, QStyleOptionFrame)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHint

inputMethodQuery(self, Qt.InputMethodQuery) → Any

FilterListPopUp.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

installEventFilter(self, QObject)

installPopUpEventFilter(event_filter)

Install the provided event filter on all widgets within this pop up that can receive focus.

Note

This function only installs the event filter on immediate children of this widget. As a result, keyboard events on grandchildren (or later descendant) widgets will not be handled properly. If this causes issues, the implementation will have to be modified.

Parameters

event_filter (_BasisSelectorPopUpEventFilter) – The event filter to install

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, QEvent)

lineEditUpdated(text)

Update this pop up in response to the user changing the line edit text. Note that, by default, this widget will not be able to send signals during execution of this method. This prevents an infinite loop of PopUp.lineEditUpdated and LineEditWithPopUp.popUpUpdated. To modify this behavior, subclass LineEditWithPopUp and reimplement LineEditWithPopUp.popUpUpdated.

Parameters

text (str) – The current text of the line edit

lineWidth(self) → int

loadPersistentOptions()

Load all persistent options from the preferences.

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFrom(self, QWidget, QPointF) → QPointF

mapFromGlobal(self, QPoint) → QPoint

mapFromGlobal(self, QPointF) → QPointF

mapFromParent(self, QPoint) → QPoint

mapFromParent(self, QPointF) → QPointF

mapTo(self, QWidget, QPoint) → QPoint

mapTo(self, QWidget, QPointF) → QPointF

mapToGlobal(self, QPoint) → QPoint

mapToGlobal(self, QPointF) → QPointF

mapToParent(self, QPoint) → QPoint

mapToParent(self, QPointF) → QPointF

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

midLineWidth(self) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

FilterListPopUp.move(self, int, int) -> None

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

nativeEvent(self, QByteArray, PyQt6.sip.voidptr) → Tuple[bool, PyQt6.sip.voidptr]

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

overrideWindowFlags(self, Qt.WindowType)

overrideWindowState(self, Qt.WindowState)

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

popUpResized

pos(self) → QPoint

previousInFocusChain(self) → QWidget

property(self, str) → Any

pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

render(self, QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))

render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) → None

repaint(self)

FilterListPopUp.repaint(self, int, int, int, int) -> None

repaint(self, QRect) → None

repaint(self, QRegion) → None

resize(self, QSize)

FilterListPopUp.resize(self, int, int) -> None

resizeEvent(self, QResizeEvent)

restoreGeometry(self, QByteArray) → bool

saveGeometry(self) → QByteArray

savePersistentOptions()

Store all persistent options to the preferences.

screen(self) → QScreen

FilterListPopUp.scroll(self, int, int)

FilterListPopUp.scroll(self, int, int, QRect) -> None

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

setAlias(alias, obj, persistent=False)

Sets an alias to conveniently access an object.

Parameters

• alias (hashable) – any hashable, but typically a string name

• obj (object) – the actual object to be referenced

• persistent (bool) – whether to make the setting persistent

setAliasedValue(alias, value)

setAliases(alias_dict, persistent=False)

Sets multiple aliases at once. Already used aliases are overwritten; other existing aliases are not affected.

Parameters

• alias_dict (dict) – map of aliases to objects

• persistent (bool) – whether to make the settings persistent

setAttribute(self, Qt.WidgetAttribute, on: bool = True)

setAutoFillBackground(self, bool)

setBackgroundRole(self, QPalette.ColorRole)

FilterListPopUp.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

FilterListPopUp.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins) → None

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

setCursor(self, Union[QCursor, Qt.CursorShape])

setDisabled(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

FilterListPopUp.setFixedSize(self, int, int) -> None

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason) → None

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setFrameRect(self, QRect)

setFrameShadow(self, QFrame.Shadow)

setFrameShape(self, QFrame.Shape)

setFrameStyle(self, int)

setGeometry(self, QRect)

FilterListPopUp.setGeometry(self, int, int, int, int) -> None

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setInputMethodHints(self, Qt.InputMethodHint)

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLineWidth(self, int)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion) → None

setMaximumHeight(self, int)

FilterListPopUp.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMidLineWidth(self, int)

setMinimumHeight(self, int)

FilterListPopUp.setMinimumSize(self, int, int)

setMinimumSize(self, QSize) → None

setMinimumWidth(self, int)

setMouseTracking(self, bool)

setObjValue(obj, value)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

setParent(self, QWidget, Qt.WindowType) → None

setPersistent(alias=None)

Set options to be persistent. Any options to be made persistent must be aliased, since the alias is used to form the preference key. If no alias is specified, all aliased settings will be made persistent.

Parameters

alias (str or None) – the alias to save, or None

setProperty(self, str, Any) → bool

setScreen(self, QScreen)

setShortcutAutoRepeat(self, int, enabled: bool = True)

setShortcutEnabled(self, int, enabled: bool = True)

FilterListPopUp.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize) → None

setSizePolicy(self, QSizePolicy)

setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy) → None

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

FilterListPopUp.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

setWindowFlag(self, Qt.WindowType, on: bool = True)

setWindowFlags(self, Qt.WindowType)

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Qt.WindowState)

setWindowTitle(self, str)

sharedPainter(self) → QPainter

show(self)

showEvent(event)

Emit a signal every time this pop up is shown.

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

staticMetaObject = <PyQt6.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, QTimerEvent)

toolTip(self) → str

toolTipDuration(self) → int

tr(str, disambiguation: str = None, n: int = - 1) → str

underMouse(self) → bool

ungrabGesture(self, Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QRect) → None

update(self, QRegion) → None

FilterListPopUp.update(self, int, int, int, int) -> None

updateGeometry(self)

updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)

updatesEnabled(self) → bool

visibilityChanged

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → PyQt6.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowType

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowState

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class schrodinger.ui.qt.filter_list.ToolButtonWithFilterListPopUp(parent)

Bases: schrodinger.ui.qt.pop_up_widgets.ToolButtonWithPopUp

Custom toolbutton with a filter list popup.

Variables

filtersChanged – Signal emitted when filters are toggled. emits a dict of current filter settings.

POP_UP_CLASS

alias of schrodinger.ui.qt.filter_list.FilterListPopUp

filtersChanged

__init__(parent)

Parameters

• parent (PyQt5.QtWidgets.QWidget) – The Qt parent widget

• pop_up_class (type) – The class of the pop up widget. Should be a subclass of PopUp.

• arrow_type (Qt.ArrowType) – Type of arrow to display in the button

• text (str) – Text to set for this button. If not specified, only an icon will be shown.

setPopUp(pop_up)

Set the pop up widget to the specified pop up widget instance.

isItemHidden(item_txt)

Return whether the specified item text is hidden.

Parameters

item_txt (str) – Item text to check

Returns

True if item is n list and is hidden, False otherwise

Return type

bool

clearFilters()

Clear all pop up filters

getSettings(**kwargs)

Get the current filter settings.

Returns

Map of the current filter settings

Return type

dict

applySettings(settings)

Apply the specified settings to the filters.

Parameters

settings (dict) – Settings to be applied.

ALIGN_AUTO = 4

ALIGN_BOTTOM = 1

ALIGN_LEFT = 3

ALIGN_RIGHT = 2

ALIGN_TOP = 0

DelayedPopup = 0

DrawChildren = 2

DrawWindowBackground = 1

IgnoreMask = 4

InstantPopup = 2

MenuButtonPopup = 1

class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1

PdmHeight = 2

PdmWidthMM = 3

PdmHeightMM = 4

PdmNumColors = 5

PdmDepth = 6

PdmDpiX = 7

PdmDpiY = 8

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1

DrawChildren = 2

IgnoreMask = 4

class ToolButtonPopupMode(value)

Bases: enum.Enum

An enumeration.

DelayedPopup = 0

MenuButtonPopup = 1

InstantPopup = 2

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

adjustSize(self)

animateClick(self)

arrowType(self) → Qt.ArrowType

autoExclusive(self) → bool

autoFillBackground(self) → bool

autoRaise(self) → bool

autoRepeat(self) → bool

autoRepeatDelay(self) → int

autoRepeatInterval(self) → int

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, bool) → bool

changeEvent(self, QEvent)

checkStateSet(self)

childAt(self, QPoint) → QWidget

ToolButtonWithFilterListPopUp.childAt(self, int, int) -> QWidget

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

click(self)

clicked

clicked(self, checked: bool = False) [signal]

close(self) → bool

closeEvent(self, QCloseEvent)

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)

createWindowContainer(QWindow, parent: QWidget = None, flags: Qt.WindowType = Qt.WindowFlags()) → QWidget

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)

defaultAction(self) → QAction

deleteLater(self)

depth(self) → int

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)

destroyed

destroyed(self, object: QObject = None) [signal]

devType(self) → int

devicePixelRatio(self) → float

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, QMetaMethod)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → PyQt6.sip.voidptr

ensurePolished(self)

enterEvent(self, QEnterEvent)

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

find(PyQt6.sip.voidptr) → QWidget

findChild(self, type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObject

findChild(self, Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → QObject

findChildren(self, type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, type, QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

findChildren(self, Tuple, QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) → List[QObject]

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

frameGeometry(self) → QRect

frameSize(self) → QSize

geometry(self) → QRect

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) → QPixmap

grabGesture(self, Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())

grabKeyboard(self)

grabMouse(self)

grabMouse(self, Union[QCursor, Qt.CursorShape]) → None

grabShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) → int

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

group(self) → QButtonGroup

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, int) → int

heightMM(self) → int

hide(self)

hideEvent(self, QHideEvent)

hitButton(self, QPoint) → bool

icon(self) → QIcon

iconSize(self) → QSize

inherits(self, str) → bool

initPainter(self, QPainter)

initStyleOption(self, QStyleOptionToolButton)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHint

inputMethodQuery(self, Qt.InputMethodQuery) → Any

ToolButtonWithFilterListPopUp.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

installEventFilter(self, QObject)

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isCheckable(self) → bool

isChecked(self) → bool

isDown(self) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, QEvent)

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFrom(self, QWidget, QPointF) → QPointF

mapFromGlobal(self, QPoint) → QPoint

mapFromGlobal(self, QPointF) → QPointF

mapFromParent(self, QPoint) → QPoint

mapFromParent(self, QPointF) → QPointF

mapTo(self, QWidget, QPoint) → QPoint

mapTo(self, QWidget, QPointF) → QPointF

mapToGlobal(self, QPoint) → QPoint

mapToGlobal(self, QPointF) → QPointF

mapToParent(self, QPoint) → QPoint

mapToParent(self, QPointF) → QPointF

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

menu(self) → QMenu

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

ToolButtonWithFilterListPopUp.move(self, int, int) -> None

moveEvent(event)

Update the pop up position and size when the widget is moved

moveToThread(self, QThread)

nativeEvent(self, QByteArray, PyQt6.sip.voidptr) → Tuple[bool, PyQt6.sip.voidptr]

nativeParentWidget(self) → QWidget

nextCheckState(self)

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

onClicked()

If the button is clicked, toggle the check state of the button, which should toggle the visibility of the pop up.

overrideWindowFlags(self, Qt.WindowType)

overrideWindowState(self, Qt.WindowState)

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

popUpClosing

popUpUpdated(text)

Whenever the pop up emits the dataChanged signal, update the widget. This function should be implemented in subclasses if required.

Parameters

text (str) – The text emitted with the dataChanged signal

property pop_up_visible

Returns

whether the pop up frame is visible to its parent

Return type

bool

popupMode(self) → QToolButton.ToolButtonPopupMode

pos(self) → QPoint

pressed

pressed(self) [signal]

previousInFocusChain(self) → QWidget

property(self, str) → Any

pyqtConfigure(...)

Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

released

released(self) [signal]

removeAction(self, QAction)

removeEventFilter(self, QObject)

render(self, QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))

render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) → None

repaint(self)

ToolButtonWithFilterListPopUp.repaint(self, int, int, int, int) -> None

repaint(self, QRect) → None

repaint(self, QRegion) → None

resize(self, QSize)

ToolButtonWithFilterListPopUp.resize(self, int, int) -> None

resizeEvent(event)

Update the pop up position and size when the widget is resized

restoreGeometry(self, QByteArray) → bool

saveGeometry(self) → QByteArray

screen(self) → QScreen

ToolButtonWithFilterListPopUp.scroll(self, int, int)

ToolButtonWithFilterListPopUp.scroll(self, int, int, QRect) -> None

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

setArrowType(self, Qt.ArrowType)

setAttribute(self, Qt.WidgetAttribute, on: bool = True)

setAutoExclusive(self, bool)

setAutoFillBackground(self, bool)

setAutoRaise(self, bool)

setAutoRepeat(self, bool)

setAutoRepeatDelay(self, int)

setAutoRepeatInterval(self, int)

setBackgroundRole(self, QPalette.ColorRole)

ToolButtonWithFilterListPopUp.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

setCheckable(self, bool)

setChecked(checked)

Set the button check state, and also alter the pop up visibility. Note that the button should be checked if and only if the pop up is visible, and that changing the visibility of the pop up (e.g. by clicking the button) will also change the check state. :param checked: whether the button should be checked :type checked: bool

ToolButtonWithFilterListPopUp.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins) → None

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

setCursor(self, Union[QCursor, Qt.CursorShape])

setDefaultAction(self, QAction)

setDisabled(self, bool)

setDown(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

ToolButtonWithFilterListPopUp.setFixedSize(self, int, int) -> None

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason) → None

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setGeometry(self, QRect)

ToolButtonWithFilterListPopUp.setGeometry(self, int, int, int, int) -> None

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setIcon(self, QIcon)

setIconSize(self, QSize)

setInputMethodHints(self, Qt.InputMethodHint)

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion) → None

setMaximumHeight(self, int)

ToolButtonWithFilterListPopUp.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMenu(self, QMenu)

setMinimumHeight(self, int)

ToolButtonWithFilterListPopUp.setMinimumSize(self, int, int)

setMinimumSize(self, QSize) → None

setMinimumWidth(self, int)

setMouseTracking(self, bool)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

setParent(self, QWidget, Qt.WindowType) → None

setPopUpClass(pop_up_class)

If a pop up class was not specified via the constructor, use this method to set it after the fact. Useful for placing widgets into *.ui files.

setPopupHalign(popup_halign)

Specify whether the pop up should have its right edge aligned with the right edge of the widget (ALIGN_RIGHT), have its left edge aligned with the left edge of the widget (ALIGN_LEFT), or have it’s horizontal alignment determined automatically (ALIGN_AUTO). Note that this setting is moot if the widget is wider than the pop up’s size hint, as the pop up will be extended to the same width as the widget.

Parameters

popup_halign (int) – The desired horizontal alignment of the pop up. Must be one of ALIGN_RIGHT, ALIGN_LEFT, or ALIGN_AUTO.

setPopupMode(self, QToolButton.ToolButtonPopupMode)

setPopupValign(popup_valign)

Specify whether the pop up should appear above (ALIGN_TOP), below (ALIGN_BOTTOM) the widget, or have it’s vertical alignment determined automatically (ALIGN_AUTO).

Parameters

popup_valign (int) – The desired vertical alignment of the pop up. Must be either ALIGN_TOP, ALIGN_BOTTOM, or ALIGN_AUTO.

setProperty(self, str, Any) → bool

setScreen(self, QScreen)

setShortcut(self, Union[QKeySequence, QKeySequence.StandardKey, str, int])

setShortcutAutoRepeat(self, int, enabled: bool = True)

setShortcutEnabled(self, int, enabled: bool = True)

ToolButtonWithFilterListPopUp.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize) → None

setSizePolicy(self, QSizePolicy)

setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy) → None

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

ToolButtonWithFilterListPopUp.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setText(self, str)

setToolButtonStyle(self, Qt.ToolButtonStyle)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

setWindowFlag(self, Qt.WindowType, on: bool = True)

setWindowFlags(self, Qt.WindowType)

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Qt.WindowState)

setWindowTitle(self, str)

sharedPainter(self) → QPainter

shortcut(self) → QKeySequence

show(self)

showEvent(self, QShowEvent)

showFullScreen(self)

showMaximized(self)

showMenu(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

startTimer(self, int, timerType: Qt.TimerType = Qt.CoarseTimer) → int

staticMetaObject = <PyQt6.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

text(self) → str

thread(self) → QThread

timerEvent(self, QTimerEvent)

toggle(self)

toggled

toggled(self, bool) [signal]

toolButtonStyle(self) → Qt.ToolButtonStyle

toolTip(self) → str

toolTipDuration(self) → int

tr(str, disambiguation: str = None, n: int = - 1) → str

triggered

triggered(self, QAction) [signal]

underMouse(self) → bool

ungrabGesture(self, Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QRect) → None

update(self, QRegion) → None

ToolButtonWithFilterListPopUp.update(self, int, int, int, int) -> None

updateGeometry(self)

updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → PyQt6.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowType

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowState

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int