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("/Users/young/builds/2023-1/build/internal/lib/python3.8/site-packages/schrodinger/ui/qt/pushbutton-menu-arrow.png");\n        subcontrol-position: center right;\n        subcontrol-origin: padding;\n        left: -13px;\n    }\n    '
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])
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, bool) bool
changeEvent(self, QEvent)
checkStateSet(self)
childAt(self, QPoint) QWidget
GroupingMethodSelector.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 = '/Users/young/builds/2023-1/build/internal/lib/python3.8/site-packages/schrodinger/ui/qt/pushbutton-menu-arrow.png'
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
GroupingMethodSelector.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
isDefault(self) bool
isDown(self) bool
isEnabled(self) bool
isEnabledTo(self, 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, 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)
GroupingMethodSelector.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
platform_specific = 'left: -13px;'
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)
GroupingMethodSelector.repaint(self, int, int, int, int) -> None
repaint(self, QRect) None
repaint(self, QRegion) None
resize(self, QSize)
GroupingMethodSelector.resize(self, int, int) -> None
resizeEvent(self, QResizeEvent)
restoreGeometry(self, QByteArray) bool
saveGeometry(self) QByteArray
screen(self) QScreen
GroupingMethodSelector.scroll(self, int, int)
GroupingMethodSelector.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)
setAutoDefault(self, bool)
setAutoExclusive(self, bool)
setAutoFillBackground(self, bool)
setAutoRepeat(self, bool)
setAutoRepeatDelay(self, int)
setAutoRepeatInterval(self, int)
setBackgroundRole(self, QPalette.ColorRole)
GroupingMethodSelector.setBaseSize(self, int, int)
setBaseSize(self, QSize) None
setCheckable(self, bool)
setChecked(self, bool)
GroupingMethodSelector.setContentsMargins(self, int, int, int, int)
setContentsMargins(self, QMargins) None
setContextMenuPolicy(self, Qt.ContextMenuPolicy)
setCursor(self, Union[QCursor, Qt.CursorShape])
setDefault(self, bool)
setDisabled(self, bool)
setDown(self, bool)
setEnabled(self, bool)
setFixedHeight(self, int)
setFixedSize(self, QSize)
GroupingMethodSelector.setFixedSize(self, int, int) -> None
setFixedWidth(self, int)
setFlat(self, bool)
setFocus(self)
setFocus(self, Qt.FocusReason) None
setFocusPolicy(self, Qt.FocusPolicy)
setFocusProxy(self, QWidget)
setFont(self, QFont)
setForegroundRole(self, QPalette.ColorRole)
setGeometry(self, QRect)
GroupingMethodSelector.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)
GroupingMethodSelector.setMaximumSize(self, int, int)
setMaximumSize(self, QSize) None
setMaximumWidth(self, int)
setMenu(self, QMenu)
setMinimumHeight(self, int)
GroupingMethodSelector.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)
GroupingMethodSelector.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)
GroupingMethodSelector.setTabOrder(QWidget, QWidget)
setTabletTracking(self, bool)
setText(self, str)
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]

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
GroupingMethodSelector.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.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, QActionEvent)
actions(self) List[QAction]
activateWindow(self)
activated

activated(self, 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, 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, bool) bool
changeEvent(self, QEvent)
childAt(self, QPoint) QWidget
SpeciesSelector.childAt(self, int, int) -> QWidget
childEvent(self, QChildEvent)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clear(self)
clearEditText(self)
clearFocus(self)
clearMask(self)
close(self) bool
closeEvent(self, QCloseEvent)
colorCount(self) int
completer(self) QCompleter
connectNotify(self, QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, QContextMenuEvent)
contextMenuPolicy(self) Qt.ContextMenuPolicy
count(self) int
create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(QWindow, parent: 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
currentString()

Obsolete. Use QComboBox.currentText() instead.

Return type

str

Returns

The currentText() value of the ComboBox converted to a string

currentText(self) str
currentTextChanged

currentTextChanged(self, str) [signal]

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)
duplicatesEnabled(self) bool
dynamicPropertyNames(self) List[QByteArray]
editTextChanged

editTextChanged(self, 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, 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]
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, str, flags: Qt.MatchFlag = static_cast&lt;QFlags&lt;Qt.MatchFlag&gt;&gt;(Qt.MatchExactly|Qt.MatchCaseSensitive)) int
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
hasFocus(self) bool
hasFrame(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)
hidePopup(self)
highlighted

highlighted(self, int) [signal]

iconSize(self) QSize
inherits(self, str) bool
initPainter(self, QPainter)
initStyleOption(self, QStyleOptionComboBox)
inputMethodEvent(self, QInputMethodEvent)
inputMethodHints(self) Qt.InputMethodHint
inputMethodQuery(self, Qt.InputMethodQuery) Any
inputMethodQuery(self, Qt.InputMethodQuery, Any) Any
SpeciesSelector.insertAction(self, QAction, QAction)
insertActions(self, QAction, Iterable[QAction])
insertItem(self, int, str, userData: Any = None)
insertItem(self, int, QIcon, str, userData: Any = None) None
insertItems(self, int, Iterable[str])
insertPolicy(self) QComboBox.InsertPolicy
insertSeparator(self, int)
installEventFilter(self, QObject)
isActiveWindow(self) bool
isAncestorOf(self, QWidget) bool
isEditable(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
itemData(self, int, role: int = Qt.UserRole) Any
itemDelegate(self) QAbstractItemDelegate
itemIcon(self, int) QIcon
itemText(self, 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, QKeyEvent)
keyboardGrabber() QWidget
killTimer(self, int)
layout(self) QLayout
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, QEvent)
lineEdit(self) QLineEdit
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
maxCount(self) int
maxVisibleItems(self) int
maximumHeight(self) int
maximumSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject
metric(self, 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, QMouseEvent)
mouseGrabber() QWidget
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
move(self, QPoint)
SpeciesSelector.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
placeholderText(self) str
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)
removeItem(self, int)
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)
SpeciesSelector.repaint(self, int, int, int, int) -> None
repaint(self, QRect) None
repaint(self, QRegion) None
resize(self, QSize)
SpeciesSelector.resize(self, int, int) -> None
resizeEvent(self, QResizeEvent)
restoreGeometry(self, QByteArray) bool
rootModelIndex(self) QModelIndex
saveGeometry(self) QByteArray
screen(self) QScreen
SpeciesSelector.scroll(self, int, int)
SpeciesSelector.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)
setAutoFillBackground(self, bool)
setBackgroundRole(self, QPalette.ColorRole)
SpeciesSelector.setBaseSize(self, int, int)
setBaseSize(self, QSize) None
setCompleter(self, QCompleter)
SpeciesSelector.setContentsMargins(self, int, int, int, int)
setContentsMargins(self, QMargins) None
setContextMenuPolicy(self, 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, 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, Union[QCursor, Qt.CursorShape])
setDisabled(self, bool)
setDuplicatesEnabled(self, bool)
setEditText(self, str)
setEditable(self, 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, int)
setFixedSize(self, QSize)
SpeciesSelector.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)
setFrame(self, bool)
setGeometry(self, QRect)
SpeciesSelector.setGeometry(self, int, int, int, int) -> None
setGraphicsEffect(self, QGraphicsEffect)
setHidden(self, bool)
setIconSize(self, QSize)
setInputMethodHints(self, Qt.InputMethodHint)
setInsertPolicy(self, QComboBox.InsertPolicy)
setItemData(self, int, Any, role: int = Qt.UserRole)
setItemDelegate(self, QAbstractItemDelegate)
setItemIcon(self, int, QIcon)
setItemText(self, int, str)
setLayout(self, QLayout)
setLayoutDirection(self, Qt.LayoutDirection)
setLineEdit(self, QLineEdit)
setLocale(self, QLocale)
setMask(self, QBitmap)
setMask(self, QRegion) None
setMaxCount(self, int)
setMaxVisibleItems(self, int)
setMaximumHeight(self, int)
SpeciesSelector.setMaximumSize(self, int, int)
setMaximumSize(self, QSize) None
setMaximumWidth(self, int)
setMinimumContentsLength(self, int)
setMinimumHeight(self, int)
SpeciesSelector.setMinimumSize(self, int, int)
setMinimumSize(self, QSize) None
setMinimumWidth(self, int)
setModel(self, QAbstractItemModel)
setModelColumn(self, int)
setMouseTracking(self, bool)
setObjectName(self, str)
setPalette(self, QPalette)
setParent(self, QWidget)
setParent(self, QWidget, Qt.WindowType) None
setPlaceholderText(self, str)
setProperty(self, str, Any) bool
setRootModelIndex(self, QModelIndex)
setScreen(self, QScreen)
setShortcutAutoRepeat(self, int, enabled: bool = True)
setShortcutEnabled(self, int, enabled: bool = True)
setSizeAdjustPolicy(self, QComboBox.SizeAdjustPolicy)
SpeciesSelector.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)
SpeciesSelector.setTabOrder(QWidget, QWidget)
setTabletTracking(self, bool)
setToolTip(self, str)
setToolTipDuration(self, int)
setUpdatesEnabled(self, bool)
setValidator(self, QValidator)
setView(self, 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, 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(self, 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, 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
textActivated

textActivated(self, str) [signal]

textHighlighted

textHighlighted(self, str) [signal]

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
SpeciesSelector.update(self, int, int, int, 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, 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
mylayout

Place this layout into the parent GUI, not the ComboBox