schrodinger.application.matsci.speciesgui module

GUI Module to group structure object in to species

Copyright Schrodinger, LLC. All rights reserved.

class schrodinger.application.matsci.speciesgui.GroupingMethodSelector(species_collections, default, command=None, layout=None)

Bases: schrodinger.ui.qt.swidgets.ActionPushButton

Widget to select the method of finding species

selection_type_changed

__init__(species_collections, default, command=None, layout=None)

Constructs a new instance of GroupingMethodSelector

Parameters

• species_collections (list) – List of species.SpeciesCollectionTypes that are supported by the selector

• default (species.SpeciesCollectionTypes) – The default species.SpeciesCollectionTypes

• command (callable) – The command to call whenever the finder method is changed

• layout (QLayout) – layout to place the GroupingMethodSelector in

getMenuAction(menu, sc_type)

Add passed species finder to the passed menu

Parameters

• menu (QtWidgets.QMenu) – Menu to add the species finder to

• sc_type (SpeciesCollectionTypes) – The type of SpeciesCollectionTypes

Return type

QtWidgets.QAction

Returns

Menu item for the species finder

setSpeciesCollection(sc_type)

Sets the species finder to be used to find species

Parameters

sc_type (str) – Name of the SpeciesCollectionTypes

findSpecies(structs)

Find and load species for the current species collection

Parameters

structs – The structure to find species in

getFlags()

Gets the flags for the driver

Returns

list

Return type

list of flags and value for the command line

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

STYLE_SHEET = '\n    QPushButton::menu-indicator {\n        image: url("/scr/buildbot/savedbuilds/2023-4/NB/build-133/internal/lib/python3.8/site-packages/schrodinger/ui/qt/pushbutton-menu-arrow.png");\n        subcontrol-position: center right;\n        subcontrol-origin: padding;\n        width: 13px;\n    }\n    '

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, a0: QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, action: QAction)

addActions(self, actions: Iterable[QAction])

addItem(text, function)

addSeparator()

adjustSize(self)

animateClick(self)

autoDefault(self) → bool

autoExclusive(self) → bool

autoFillBackground(self) → bool

autoRepeat(self) → bool

autoRepeatDelay(self) → int

autoRepeatInterval(self) → int

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, b: bool) → bool

changeEvent(self, e: QEvent)

checkStateSet(self)

childAt(self, p: QPoint) → QWidget

childAt(self, ax: int, ay: int) → QWidget

childEvent(self, a0: 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, a0: QCloseEvent)

colorCount(self) → int

connectNotify(self, signal: QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, a0: QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

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

createWindowContainer(window: QWindow, parent: typing.Optional[QWidget] = None, flags: Qt.WindowType = Qt.WindowFlags()) → QWidget

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)

deleteLater(self)

depth(self) → int

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

destroyed

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

devType(self) → int

devicePixelRatio(self) → float

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(a0: QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, signal: QMetaMethod)

dragEnterEvent(self, a0: QDragEnterEvent)

dragLeaveEvent(self, a0: QDragLeaveEvent)

dragMoveEvent(self, a0: QDragMoveEvent)

dropEvent(self, a0: QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → PyQt6.sip.voidptr

ensurePolished(self)

enterEvent(self, event: QEnterEvent)

event(self, e: QEvent) → bool

eventFilter(self, a0: QObject, a1: QEvent) → bool

find(a0: PyQt6.sip.voidptr) → QWidget

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

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

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

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

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

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

focusInEvent(self, a0: QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, next: bool) → bool

focusOutEvent(self, a0: 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, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())

grabKeyboard(self)

grabMouse(self)

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

grabShortcut(self, key: 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, a0: int) → int

heightMM(self) → int

hide(self)

hideEvent(self, a0: QHideEvent)

hitButton(self, pos: QPoint) → bool

icon = '/scr/buildbot/savedbuilds/2023-4/NB/build-133/internal/lib/python3.8/site-packages/schrodinger/ui/qt/pushbutton-menu-arrow.png'

iconSize(self) → QSize

inherits(self, classname: str) → bool

initPainter(self, painter: QPainter)

initStyleOption(self, option: QStyleOptionButton)

inputMethodEvent(self, a0: QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHint

inputMethodQuery(self, a0: Qt.InputMethodQuery) → Any

insertAction(self, before: QAction, action: QAction)

insertActions(self, before: QAction, actions: Iterable[QAction])

installEventFilter(self, a0: QObject)

isActiveWindow(self) → bool

isAncestorOf(self, child: QWidget) → bool

isCheckable(self) → bool

isChecked(self) → bool

isDefault(self) → bool

isDown(self) → bool

isEnabled(self) → bool

isEnabledTo(self, a0: QWidget) → bool

isFlat(self) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, signal: QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, a0: QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyPressEvent(self, a0: QKeyEvent)

keyReleaseEvent(self, e: QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, id: int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, a0: QEvent)

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, a0: QWidget, a1: QPoint) → QPoint

mapFrom(self, a0: QWidget, a1: QPointF) → QPointF

mapFromGlobal(self, a0: QPoint) → QPoint

mapFromGlobal(self, a0: QPointF) → QPointF

mapFromParent(self, a0: QPoint) → QPoint

mapFromParent(self, a0: QPointF) → QPointF

mapTo(self, a0: QWidget, a1: QPoint) → QPoint

mapTo(self, a0: QWidget, a1: QPointF) → QPointF

mapToGlobal(self, a0: QPoint) → QPoint

mapToGlobal(self, a0: QPointF) → QPointF

mapToParent(self, a0: QPoint) → QPoint

mapToParent(self, a0: QPointF) → QPointF

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

menu(self) → QMenu

metaObject(self) → QMetaObject

metric(self, a0: QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, a0: QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, a0: QMouseEvent)

mousePressEvent(self, e: QMouseEvent)

mouseReleaseEvent(self, e: QMouseEvent)

move(self, a0: QPoint)

move(self, ax: int, ay: int) → None

moveEvent(self, a0: QMoveEvent)

moveToThread(self, thread: QThread)

nativeEvent(self, eventType: QByteArray, message: 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, objectName: str) [signal]

overrideWindowFlags(self, type: Qt.WindowType)

overrideWindowState(self, state: Qt.WindowState)

paintEngine(self) → QPaintEngine

paintEvent(self, a0: QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

platform_specific = 'width: 13px;'

pos(self) → QPoint

pressed

pressed(self) [signal]

previousInFocusChain(self) → QWidget

property(self, name: 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, signal: PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, id: int)

released

released(self) [signal]

removeAction(self, action: QAction)

removeEventFilter(self, a0: QObject)

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

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

repaint(self)

repaint(self, x: int, y: int, w: int, h: int) → None

repaint(self, a0: QRect) → None

repaint(self, a0: QRegion) → None

resize(self, a0: QSize)

resize(self, w: int, h: int) → None

resizeEvent(self, a0: QResizeEvent)

restoreGeometry(self, geometry: QByteArray) → bool

saveGeometry(self) → QByteArray

screen(self) → QScreen

scroll(self, dx: int, dy: int)

scroll(self, dx: int, dy: int, a2: QRect) → None

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, on: bool)

setAccessibleDescription(self, description: str)

setAccessibleName(self, name: str)

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

setAutoDefault(self, a0: bool)

setAutoExclusive(self, a0: bool)

setAutoFillBackground(self, enabled: bool)

setAutoRepeat(self, a0: bool)

setAutoRepeatDelay(self, a0: int)

setAutoRepeatInterval(self, a0: int)

setBackgroundRole(self, a0: QPalette.ColorRole)

setBaseSize(self, basew: int, baseh: int)

setBaseSize(self, s: QSize) → None

setCheckable(self, a0: bool)

setChecked(self, a0: bool)

setContentsMargins(self, left: int, top: int, right: int, bottom: int)

setContentsMargins(self, margins: QMargins) → None

setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)

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

setDefault(self, a0: bool)

setDisabled(self, a0: bool)

setDown(self, a0: bool)

setEnabled(self, a0: bool)

setFixedHeight(self, h: int)

setFixedSize(self, a0: QSize)

setFixedSize(self, w: int, h: int) → None

setFixedWidth(self, w: int)

setFlat(self, a0: bool)

setFocus(self)

setFocus(self, reason: Qt.FocusReason) → None

setFocusPolicy(self, policy: Qt.FocusPolicy)

setFocusProxy(self, a0: QWidget)

setFont(self, a0: QFont)

setForegroundRole(self, a0: QPalette.ColorRole)

setGeometry(self, a0: QRect)

setGeometry(self, ax: int, ay: int, aw: int, ah: int) → None

setGraphicsEffect(self, effect: QGraphicsEffect)

setHidden(self, hidden: bool)

setIcon(self, icon: QIcon)

setIconSize(self, size: QSize)

setInputMethodHints(self, hints: Qt.InputMethodHint)

setLayout(self, a0: QLayout)

setLayoutDirection(self, direction: Qt.LayoutDirection)

setLocale(self, locale: QLocale)

setMask(self, a0: QBitmap)

setMask(self, a0: QRegion) → None

setMaximumHeight(self, maxh: int)

setMaximumSize(self, maxw: int, maxh: int)

setMaximumSize(self, s: QSize) → None

setMaximumWidth(self, maxw: int)

setMenu(self, menu: QMenu)

setMinimumHeight(self, minh: int)

setMinimumSize(self, minw: int, minh: int)

setMinimumSize(self, s: QSize) → None

setMinimumWidth(self, minw: int)

setMouseTracking(self, enable: bool)

setObjectName(self, name: str)

setPalette(self, a0: QPalette)

setParent(self, parent: QWidget)

setParent(self, parent: QWidget, f: Qt.WindowType) → None

setProperty(self, name: str, value: Any) → bool

setScreen(self, a0: QScreen)

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

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

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

setSizeIncrement(self, w: int, h: int)

setSizeIncrement(self, s: QSize) → None

setSizePolicy(self, a0: QSizePolicy)

setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) → None

setStatusTip(self, a0: str)

setStyle(self, a0: QStyle)

setStyleSheet(self, styleSheet: str)

setTabOrder(a0: QWidget, a1: QWidget)

setTabletTracking(self, enable: bool)

setText(self, text: str)

setToolTip(self, a0: str)

setToolTipDuration(self, msec: int)

setUpdatesEnabled(self, enable: bool)

setVisible(self, visible: bool)

setWhatsThis(self, a0: str)

setWindowFilePath(self, filePath: str)

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

setWindowFlags(self, type: Qt.WindowType)

setWindowIcon(self, icon: QIcon)

setWindowIconText(self, a0: str)

setWindowModality(self, windowModality: Qt.WindowModality)

setWindowModified(self, a0: bool)

setWindowOpacity(self, level: float)

setWindowRole(self, a0: str)

setWindowState(self, state: Qt.WindowState)

setWindowTitle(self, a0: str)

sharedPainter(self) → QPainter

shortcut(self) → QKeySequence

show(self)

showEvent(self, a0: 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, a0: QWidget)

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

staticMetaObject = <PyQt6.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, a0: QTabletEvent)

testAttribute(self, attribute: Qt.WidgetAttribute) → bool

text(self) → str

thread(self) → QThread

timerEvent(self, e: QTimerEvent)

toggle(self)

toggled

toggled(self, checked: bool) [signal]

toolTip(self) → str

toolTipDuration(self) → int

tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) → str

underMouse(self) → bool

ungrabGesture(self, type: Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, a0: QRect) → None

update(self, a0: QRegion) → None

update(self, ax: int, ay: int, aw: int, ah: int) → None

updateGeometry(self)

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

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, a0: 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, icon: QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowState

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class schrodinger.application.matsci.speciesgui.SpeciesSelector(label, species_collections=None, default=SpeciesCollectionTypes.formula, layout=None, command=None, update_command=None)

Bases: schrodinger.ui.qt.swidgets.SLabeledComboBox

Labeled Combobox that allows the user to select a species.

species_changed

species_updated

__init__(label, species_collections=None, default=SpeciesCollectionTypes.formula, layout=None, command=None, update_command=None)

Create a SpeciesSelector instance

Parameters

• label (str) – The text for the combobox

• species_collections (list or None) – List of species.SpeciesCollectionTypes that are supported by the selector. If None all the available collection types will be added.

• default (species.SpeciesCollectionTypes) – The default species.SpeciesCollectionTypes

• layout (QLayout) – layout to place the SpeciesSelector in

• command (callable) – The slot to connect to the species_changed signal

• update_command (callable) – The slot to connect to the species_updated signal

property species_collection

Get species collection in the selector

Returns

Species collection in the selector

Return type

species.SpeciesCollection

property species_collection_type

Get name of the species collection type in the selector

Returns

Name of the species collection type in the selector

Return type

str

currentSpecies()

Return the currently selected species

Return type

species.SpeciesData

Returns

The currently selected species

speciesChanged()

React to a new species being selected

speciesUpdated()

React to a species selection method being selected

hasSpecies()

Check if any species have been loaded

Return type

bool

Returns

True of any species has been loaded, False if not

reloadSpecies()

Reload species with previously called structure

loadSpecies(structs)

Find all the species in the given structures and load them into the species type combobox

Parameters

structs (list(structure.Structure)) – The list of structures to find the species in

getFlags()

Gets the flags for the driver

Returns

list

Return type

list of flags and value for the command line

reset()

Reset the widget, including clearing the species type combo

AdjustToContents = 0

AdjustToContentsOnFirstShow = 1

AdjustToMinimumContentsLengthWithIcon = 2

DrawChildren = 2

DrawWindowBackground = 1

IgnoreMask = 4

InsertAfterCurrent = 4

InsertAlphabetically = 6

InsertAtBottom = 3

InsertAtCurrent = 2

InsertAtTop = 1

InsertBeforeCurrent = 5

class InsertPolicy(value)

Bases: enum.Enum

An enumeration.

NoInsert = 0

InsertAtTop = 1

InsertAtCurrent = 2

InsertAtBottom = 3

InsertAfterCurrent = 4

InsertBeforeCurrent = 5

InsertAlphabetically = 6

NoInsert = 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

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 SizeAdjustPolicy(value)

Bases: enum.Enum

An enumeration.

AdjustToContents = 0

AdjustToContentsOnFirstShow = 1

AdjustToMinimumContentsLengthWithIcon = 2

__len__()

Return len(self).

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, a0: QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

activated

activated(self, index: int) [signal]

addAction(text, callback)

Add an “action” menu item. When selected by the user, it will invoke the callback and re-select the previously selected item.

addActions(self, actions: Iterable[QAction])

addItem(*args, **kwargs)

Add given items and emit signals as needed.

addItems(*args, **kwargs)

Add given items and emit signals as needed.

addItemsFromDict(items)

Add items to the combo box from a dictionary of {text: user_data}. Note that setting the order of elements requires a collections.OrderedDict

Parameters

items (dict) – A dictionary of {text: user_data} to add to the combo box

adjustSize(self)

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, b: bool) → bool

changeEvent(self, e: QEvent)

childAt(self, p: QPoint) → QWidget

childAt(self, ax: int, ay: int) → QWidget

childEvent(self, a0: QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clear(self)

clearEditText(self)

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(self, a0: QCloseEvent)

colorCount(self) → int

completer(self) → QCompleter

connectNotify(self, signal: QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, e: QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

count(self) → int

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

createWindowContainer(window: QWindow, parent: typing.Optional[QWidget] = None, flags: Qt.WindowType = Qt.WindowFlags()) → QWidget

currentData(role=ItemDataRole.UserRole)

Get the user data for the currently selected item

Parameters

role (int) – The role to retrieve data for

Returns

The user data

currentIndex(self) → int

currentIndexChanged

currentText(self) → str

currentTextChanged

currentTextChanged(self, a0: str) [signal]

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)

deleteLater(self)

depth(self) → int

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

destroyed

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

devType(self) → int

devicePixelRatio(self) → float

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(a0: QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, signal: QMetaMethod)

dragEnterEvent(self, a0: QDragEnterEvent)

dragLeaveEvent(self, a0: QDragLeaveEvent)

dragMoveEvent(self, a0: QDragMoveEvent)

dropEvent(self, a0: QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

duplicatesEnabled(self) → bool

dynamicPropertyNames(self) → List[QByteArray]

editTextChanged

editTextChanged(self, a0: str) [signal]

effectiveWinId(self) → PyQt6.sip.voidptr

enableAllItems(enable=True)

Enable/disable all item in combobox

Parameters

enable (bool) – Enable or disable item

enableItems(texts=None, enable=True)

Enable/disable item in combo box based on texts :param list texts: list of item text to be enabled or disabled :param bool enable: Enable or disable item

ensurePolished(self)

enterEvent(self, event: QEnterEvent)

event(self, event: QEvent) → bool

eventFilter(self, a0: QObject, a1: QEvent) → bool

find(a0: PyQt6.sip.voidptr) → QWidget

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

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

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

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

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

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

findData(data, role=ItemDataRole.UserRole)

Get the index of the item containing the specified data. Comparisons are done in Python rather than in C++ (as they are in QComboBox.findData) so that Python types without a direct C++ mapping can be compared correctly. See qt_utils.combo_find_data_py for additional documentation.

Parameters

• data (object) – The data to search for

• role (Qt.ItemDataRole) – The role to search

findDataPy(data, role=ItemDataRole.UserRole)

Get the index of the item containing the specified data. Similar to findData, but a ValueError will be raised if the specified data cannot be found. (findData mimics the QComboBox.findData behavior and returns a -1 in that scenario.)

See findData documentation for parameter documentation.

findText(self, text: str, flags: Qt.MatchFlag = static_cast&lt;QFlags&lt;Qt.MatchFlag&gt;&gt;(Qt.MatchExactly|Qt.MatchCaseSensitive)) → int

focusInEvent(self, e: QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, next: bool) → bool

focusOutEvent(self, e: 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, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())

grabKeyboard(self)

grabMouse(self)

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

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

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

hasFocus(self) → bool

hasFrame(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, a0: int) → int

heightMM(self) → int

hide(self)

hideEvent(self, e: QHideEvent)

hidePopup(self)

highlighted

highlighted(self, index: int) [signal]

iconSize(self) → QSize

inherits(self, classname: str) → bool

initPainter(self, painter: QPainter)

initStyleOption(self, option: QStyleOptionComboBox)

inputMethodEvent(self, a0: QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHint

inputMethodQuery(self, a0: Qt.InputMethodQuery) → Any

inputMethodQuery(self, query: Qt.InputMethodQuery, argument: Any) → Any

insertAction(self, before: QAction, action: QAction)

insertActions(self, before: QAction, actions: Iterable[QAction])

insertItem(self, index: int, text: str, userData: Any = None)

insertItem(self, index: int, icon: QIcon, text: str, userData: Any = None) → None

insertItems(self, index: int, texts: Iterable[str])

insertPolicy(self) → QComboBox.InsertPolicy

insertSeparator(self, index: int)

installEventFilter(self, a0: QObject)

isActiveWindow(self) → bool

isAncestorOf(self, child: QWidget) → bool

isEditable(self) → bool

isEnabled(self) → bool

isEnabledTo(self, a0: 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, signal: QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, a0: QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

itemData(self, index: int, role: int = Qt.UserRole) → Any

itemDelegate(self) → QAbstractItemDelegate

itemIcon(self, index: int) → QIcon

itemText(self, index: int) → str

items()

Return the current list of items in the combo box.

Return type

list

Returns

the current list of items

keyPressEvent(event)

Ignore Up/Down key press events if any action items are present. In the future, consider re-implementing these handlers; it’s a non- trivial task. See http://code.metager.de/source/xref/lib/qt/src/gui/widgets/qcombobox.cpp#2931

keyReleaseEvent(self, e: QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, id: int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, a0: QEvent)

lineEdit(self) → QLineEdit

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, a0: QWidget, a1: QPoint) → QPoint

mapFrom(self, a0: QWidget, a1: QPointF) → QPointF

mapFromGlobal(self, a0: QPoint) → QPoint

mapFromGlobal(self, a0: QPointF) → QPointF

mapFromParent(self, a0: QPoint) → QPoint

mapFromParent(self, a0: QPointF) → QPointF

mapTo(self, a0: QWidget, a1: QPoint) → QPoint

mapTo(self, a0: QWidget, a1: QPointF) → QPointF

mapToGlobal(self, a0: QPoint) → QPoint

mapToGlobal(self, a0: QPointF) → QPointF

mapToParent(self, a0: QPoint) → QPoint

mapToParent(self, a0: QPointF) → QPointF

mask(self) → QRegion

maxCount(self) → int

maxVisibleItems(self) → int

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, a0: QPaintDevice.PaintDeviceMetric) → int

minimumContentsLength(self) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

model(self) → QAbstractItemModel

modelColumn(self) → int

mouseDoubleClickEvent(self, a0: QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, a0: QMouseEvent)

mousePressEvent(self, e: QMouseEvent)

mouseReleaseEvent(self, e: QMouseEvent)

move(self, a0: QPoint)

move(self, ax: int, ay: int) → None

moveEvent(self, a0: QMoveEvent)

moveToThread(self, thread: QThread)

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

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, objectName: str) [signal]

overrideWindowFlags(self, type: Qt.WindowType)

overrideWindowState(self, state: Qt.WindowState)

paintEngine(self) → QPaintEngine

paintEvent(self, e: QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

placeholderText(self) → str

pos(self) → QPoint

previousInFocusChain(self) → QWidget

property(self, name: 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, signal: PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, id: int)

removeAction(self, action: QAction)

removeEventFilter(self, a0: QObject)

removeItem(self, index: int)

removeItemByText(text)

Removes the item with the given text

Parameters

text (str) – the text of the item to be removed

Return type

bool

Returns

True if an item was removed, False otherwise

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

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

repaint(self)

repaint(self, x: int, y: int, w: int, h: int) → None

repaint(self, a0: QRect) → None

repaint(self, a0: QRegion) → None

resize(self, a0: QSize)

resize(self, w: int, h: int) → None

resizeEvent(self, e: QResizeEvent)

restoreGeometry(self, geometry: QByteArray) → bool

rootModelIndex(self) → QModelIndex

saveGeometry(self) → QByteArray

screen(self) → QScreen

scroll(self, dx: int, dy: int)

scroll(self, dx: int, dy: int, a2: QRect) → None

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, on: bool)

setAccessibleDescription(self, description: str)

setAccessibleName(self, name: str)

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

setAutoFillBackground(self, enabled: bool)

setBackgroundRole(self, a0: QPalette.ColorRole)

setBaseSize(self, basew: int, baseh: int)

setBaseSize(self, s: QSize) → None

setCompleter(self, c: QCompleter)

setContentsMargins(self, left: int, top: int, right: int, bottom: int)

setContentsMargins(self, margins: QMargins) → None

setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)

setCurrentData(data, role=ItemDataRole.UserRole)

Select the index with the specified user data

Parameters

• text – The user data to select

• role (int) – The role to search

Raises

ValueError – If the specified data is not found in the combo box

setCurrentIndex(self, index: int)

setCurrentText(text)

Set the combobox to the item with the supplied text

Parameters

text (str) – The text of the item to make the current item

Raise

ValueError if no item with text exists

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

setDisabled(self, a0: bool)

setDuplicatesEnabled(self, enable: bool)

setEditText(self, text: str)

setEditable(self, editable: bool)

setEnabled(state)

Set all child widgets to enabled state of state

Parameters

state (bool) – True if widgets should be enabled, False if not

setFixedHeight(self, h: int)

setFixedSize(self, a0: QSize)

setFixedSize(self, w: int, h: int) → None

setFixedWidth(self, w: int)

setFocus(self)

setFocus(self, reason: Qt.FocusReason) → None

setFocusPolicy(self, policy: Qt.FocusPolicy)

setFocusProxy(self, a0: QWidget)

setFont(self, a0: QFont)

setForegroundRole(self, a0: QPalette.ColorRole)

setFrame(self, a0: bool)

setGeometry(self, a0: QRect)

setGeometry(self, ax: int, ay: int, aw: int, ah: int) → None

setGraphicsEffect(self, effect: QGraphicsEffect)

setHidden(self, hidden: bool)

setIconSize(self, size: QSize)

setInputMethodHints(self, hints: Qt.InputMethodHint)

setInsertPolicy(self, policy: QComboBox.InsertPolicy)

setItemData(self, index: int, value: Any, role: int = Qt.UserRole)

setItemDelegate(self, delegate: QAbstractItemDelegate)

setItemIcon(self, index: int, icon: QIcon)

setItemText(self, index: int, text: str)

setLayout(self, a0: QLayout)

setLayoutDirection(self, direction: Qt.LayoutDirection)

setLineEdit(self, edit: QLineEdit)

setLocale(self, locale: QLocale)

setMask(self, a0: QBitmap)

setMask(self, a0: QRegion) → None

setMaxCount(self, max: int)

setMaxVisibleItems(self, maxItems: int)

setMaximumHeight(self, maxh: int)

setMaximumSize(self, maxw: int, maxh: int)

setMaximumSize(self, s: QSize) → None

setMaximumWidth(self, maxw: int)

setMinimumContentsLength(self, characters: int)

setMinimumHeight(self, minh: int)

setMinimumSize(self, minw: int, minh: int)

setMinimumSize(self, s: QSize) → None

setMinimumWidth(self, minw: int)

setModel(self, model: QAbstractItemModel)

setModelColumn(self, visibleColumn: int)

setMouseTracking(self, enable: bool)

setObjectName(self, name: str)

setPalette(self, a0: QPalette)

setParent(self, parent: QWidget)

setParent(self, parent: QWidget, f: Qt.WindowType) → None

setPlaceholderText(self, placeholderText: str)

setProperty(self, name: str, value: Any) → bool

setRootModelIndex(self, index: QModelIndex)

setScreen(self, a0: QScreen)

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

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

setSizeAdjustPolicy(self, policy: QComboBox.SizeAdjustPolicy)

setSizeIncrement(self, w: int, h: int)

setSizeIncrement(self, s: QSize) → None

setSizePolicy(self, a0: QSizePolicy)

setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) → None

setStatusTip(self, a0: str)

setStyle(self, a0: QStyle)

setStyleSheet(self, styleSheet: str)

setTabOrder(a0: QWidget, a1: QWidget)

setTabletTracking(self, enable: bool)

setToolTip(self, a0: str)

setToolTipDuration(self, msec: int)

setUpdatesEnabled(self, enable: bool)

setValidator(self, v: QValidator)

setView(self, itemView: QAbstractItemView)

setVisible(state)

Set all child widgets to visible state of state

Parameters

state (bool) – True if widgets should be visible, False if not

setWhatsThis(self, a0: str)

setWindowFilePath(self, filePath: str)

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

setWindowFlags(self, type: Qt.WindowType)

setWindowIcon(self, icon: QIcon)

setWindowIconText(self, a0: str)

setWindowModality(self, windowModality: Qt.WindowModality)

setWindowModified(self, a0: bool)

setWindowOpacity(self, level: float)

setWindowRole(self, a0: str)

setWindowState(self, state: Qt.WindowState)

setWindowTitle(self, a0: str)

sharedPainter(self) → QPainter

show(self)

showEvent(self, e: QShowEvent)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

showPopup(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeAdjustPolicy(self) → QComboBox.SizeAdjustPolicy

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, a0: QWidget)

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

staticMetaObject = <PyQt6.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, a0: QTabletEvent)

testAttribute(self, attribute: Qt.WidgetAttribute) → bool

textActivated

textActivated(self, a0: str) [signal]

textHighlighted

textHighlighted(self, a0: str) [signal]

thread(self) → QThread

timerEvent(self, a0: QTimerEvent)

toolTip(self) → str

toolTipDuration(self) → int

tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) → str

underMouse(self) → bool

ungrabGesture(self, type: Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, a0: QRect) → None

update(self, a0: QRegion) → None

update(self, ax: int, ay: int, aw: int, ah: int) → None

updateGeometry(self)

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

updatesEnabled(self) → bool

validator(self) → QValidator

view(self) → QAbstractItemView

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, e: 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, icon: QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowState

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

mylayout

Place this layout into the parent GUI, not the ComboBox