schrodinger.application.matsci.kmcgui module

Run initial calculations to store mobility information for all the structures in a system.

Copyright Schrodinger, LLC. All rights reserved.

schrodinger.application.matsci.kmcgui.robust_log(value)

A sqrt function that is robust to missing (0.0) values

Parameters

value (float) – The value to take the log of

Return type

float

Returns

The log10 of value or 0 if value is 0

schrodinger.application.matsci.kmcgui.get_charged_prop_value(info, selector)

Get the full property name for a property that appends ‘h’ or ‘e’ at the end based on the charge the property is for and the state of a charge radiobutton group

Parameters
Return type

str

Returns

The full name of the property with the correct suffix

schrodinger.application.matsci.kmcgui.get_plottable_table_data(info, selector)

Get the data from the SQL database

Parameters
Return type

list

Returns

The values for prop in each row of table

class schrodinger.application.matsci.kmcgui.PlotInfo(combo, title, function, charged, prop, table_getter)

Bases: tuple

__contains__(key, /)

Return key in self.

__len__()

Return len(self).

charged

Alias for field number 3

combo

Alias for field number 0

count(value, /)

Return number of occurrences of value.

function

Alias for field number 2

index(value, start=0, stop=9223372036854775807, /)

Return first index of value.

Raises ValueError if the value is not present.

prop

Alias for field number 4

table_getter

Alias for field number 5

title

Alias for field number 1

schrodinger.application.matsci.kmcgui.get_field_strength_string(components)

Get the string indicating field direction and strength, to be shown in the UI

Parameters

components (list) – Field value components

Return type

str

Returns

A string indicating field direction and strength

class schrodinger.application.matsci.kmcgui.PropertyCombo(text, items, values, layout, selector)

Bases: schrodinger.ui.qt.swidgets.SComboBox

A combobox used to select KMC properties

values_changed
__init__(text, items, values, layout, selector)

Create a PropertyCombo instance

Parameters

  • text (str) – The label for the combobox. If no text is provided, there no label will be created and self.label will be None

  • items (list) – List of PlotInfo items to display in the combobox

  • values (dict) – Keys are property names (such as the .prop property from PropInfo objects (modified by the charge suffix), values are a list of values for that property. Initially, this dict can be empty and will be populated as properties are selected by the user. This prevents obtaining expensive properties unless needed, and allows multiple comboboxes to share the same property/value cache

  • layout (swidgets.SBoxLayout) – The layout to place this combobox into

  • selector (InputSelectorWithDatabase) – The database input selector

setEnabled(state)

Set all child widgets to enabled state of state

Parameters

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

getValuesFromFile(info)

Get the values for info from the file

Parameters

info (PlotInfo) – The info object to get values for

loadAndProcessData(*_, quiet=False, info=None, prop=None)

Get the values for the current or passed info, loading them from a file if need be. The values_changed signal will be emitted unless quiet is specified. Args are signal arguments and are ignored.

Parameters

  • quiet (bool) – Whether to emit the values_changed signal

  • info (PlotInfo) – The info object to load values for. If not supplied, the current selection will be used.

  • prop (str) – The property to load values for. If not supplied, the current selection will be used.

reset()

Reset this combobox. Will emit the values_changed signal.

getCurrentInfoAndProp()

Get the current info object and property name from the combobox

Return type

(PlotInfo, str)

Returns

The current info object and name of the associated property

getCurrentInfoPropAndValues(quiet=True)

Get the current info object, property name and associated values from the combobox

Return type

(PlotInfo, str, list)

Returns

The current info object, property name and associated values. The values returned are the directly cached list, not a copy. So modifying the list will modify the values returned by future calls to this function.

getPropAndValues(info, quiet=True)

Get property name and associated values using the info object

Parameters

  • info (PlotInfo) – The info object to get values for

  • quiet (bool) – Whether to emit the values_changed signal

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<QFlags<Qt.MatchFlag>>(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)
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)
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(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
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
class schrodinger.application.matsci.kmcgui.DatabaseInfo

Bases: PyQt6.QtCore.QObject

Holds Schrodinger info from and about the SQL database

pathChanged
__init__()

Create a DatabaseInfo object

setPath(path)

Set the path

Parameters

path (str or pathlib.Path) – The path to the database file

loadInfo()

Load info from the database

getPath()

Get the current path

Return type

pathlib.Path or None

Returns

The current path to the database file, or None if none has been specified

reset(force_emit=False)

Reset the data properties

Parameters

force_emit (bool) – Emit the pathChanged signal even if the path doesn’t actually change.

getPathLabelText()

Get the string version of the path to the database file

Return type

str

Returns

The path to the database file. NO_DB is returned if the path is not set.

isHole()

Check if the current database is for a hole calculation

Return type

bool

Returns

True if the database is for a hole calculation, False if for electron or there is no database

blockSignals(self, b: bool) → bool
childEvent(self, a0: QChildEvent)
children(self) → List[QObject]
connectNotify(self, signal: QMetaMethod)
customEvent(self, a0: QEvent)
deleteLater(self)
destroyed

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

disconnect(a0: QMetaObject.Connection) → bool
disconnect(self) → None
disconnectNotify(self, signal: QMetaMethod)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) → List[QByteArray]
event(self, a0: QEvent) → bool
eventFilter(self, a0: QObject, a1: QEvent) → bool
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]
inherits(self, classname: str) → bool
installEventFilter(self, a0: QObject)
isSignalConnected(self, signal: QMetaMethod) → bool
isWidgetType(self) → bool
isWindowType(self) → bool
killTimer(self, id: int)
metaObject(self) → QMetaObject
moveToThread(self, thread: QThread)
objectName(self) → str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

parent(self) → QObject
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.

receivers(self, signal: PYQT_SIGNAL) → int
removeEventFilter(self, a0: QObject)
sender(self) → QObject
senderSignalIndex(self) → int
setObjectName(self, name: str)
setParent(self, a0: QObject)
setProperty(self, name: str, value: Any) → bool
signalsBlocked(self) → bool
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) → int
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
thread(self) → QThread
timerEvent(self, a0: QTimerEvent)
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) → str
class schrodinger.application.matsci.kmcgui.InputSelectorWithDatabase(parent, show_entry_cb=True, **options)

Bases: schrodinger.ui.qt.input_selector.InputSelector

Adds the ability to pick an SQL database instead of a structure file

DATABASE = 'Database'
database_changed
USE_ENTRY_DB = ('included_entry', 'file')
__init__(parent, show_entry_cb=True, **options)

Create a InputSelectorWithDatabase object

Parameters

  • parent (af2.JobApp) – The panel this selector will be part of

  • show_entry_cb (bool) – Show the “Use database for this structure” checkbox

useEntryDatabaseToggled()

React to the the use existing database checkbox toggling

showOrHideEntryDBFrame()

Set the visibility of the widgets that allow the user to request the database associated with the included entry

checkEntryDatabase()

Check the current included entry to see if there is an associated database

databaseComboChanged()

React to the value of the database combo changing

inputState(true_state=False)

Get the current input state of the selector

Parameters

true_state (bool) – If True, DATABASE will be returned if DATABASE is the selected input. If False, INCLUDED_ENTRY will be returned if DATABASE is the selected input. INCLUDED_ENTRY is returned in this case because that is where the input structure will actually come from.

Return type

str

Returns

The input source. See true_state param.

isDatabaseSource()

Check if DATABASE is the current input source

Return type

bool

Returns

Whether DATABASE is currently selected

validate()

Validate the state of the selector

Return type

str or None

Returns

None if there are no issues. A message describing the problem if there is an issue.

currentDBInfo(only_if_used=False)

Get the DatabaseInfo object for the current input selector settings

Parameters

only_if_used (bool) – If True, the included entry database info will only be returned if the user has elected to use it

Return type

DatabaseInfo or None

Returns

The info for the current settings, or None if the chosen input method does not allow for a database

getDatabasePath()

Get the path to the currently-used existing database

Return type

pathlib.Path or None

Returns

The path to the existing database to use or None if no database should be used

usingExistingDatabase()

Check if the user has specified an existing database be used

Return type

bool

Returns

Whether an existing database is used

existingDatabaseJobFilename()

Get the filename for the existing database in the job directory.

Note: !! This method is only valid during job launch - i.e. after the setup method has been called. Calling at other times may incorrectly yield None or a stale file name from the previous job launch.

Return type

str or None

Returns

The name of the database from the most recent job launch that used an existing database. None may be returned if no such job has been launched or the current job does not use an existing database.

reset()

Reset the widget

setup(jobname)
Prepares for job start. In addition to standard behavior, will copy the

chosen database to the job directory if DATABASE is the input source

Parameters

jobname (str) – The job name

Return type

bool

Returns

True if everything is OK, False if start should be aborted

validateDBAndStructure()

Check that everything looks OK with the chosen database and given structure

Return type

str or None

Returns

None if there are no issues. A message describing the problem if there is an issue.

browseFiles()

Allow the user to select an input file

In addition to parent class behavior, allows the selection of a SQL file

Box = 1
DrawChildren = 2
DrawWindowBackground = 1
FILE = 'file'
HLine = 4
INCLUDED_ENTRIES = 'included_entries'
INCLUDED_ENTRY = 'included_entry'
IgnoreMask = 4
NoFrame = 0
PROJECT_TABLE = 'selected_entries'
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
SELECTED_ENTRIES = 'selected_entries'
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
WORKSPACE = 'workspace'
WinPanel = 3
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])
addAllCallbacks()

Add callbacks.

addCallback(callback_adder, method)

Add a callback for a method - quietly do nothing if such callback already exists. Example: self.addCallback(maestro.workspace_changed_function_add, self.wsChanged)

This method tracks callbacks that are added for easy removal later. This tracking is done because Maestro prints an uncatchable WARNING to the terminal if we try to remove a callback that has not been added.

Parameters

  • callback_adder (callable) – A callable function that adds a callback, such as maestro.workspace_changed_function_add

  • method (callable) – The method to use as the callback function.

addFileWidgets()

Add widgets associated with a file input source to the input frame.

addRangeWidgets()

Add from/to range widgets under the file entry field.

adjustSize(self)
af2SettingsGetValue()

This function adds support for the settings mixin.

Returns

(Input source string, file path)

Return type

(str, str)

af2SettingsSetValue(value)

This function adds support for the settings mixin.

Parameters

value ((str, str)) – (Input source string, file path).

autoFillBackground(self) → bool
backgroundRole(self) → QPalette.ColorRole
baseSize(self) → QSize
blockSignals(self, b: bool) → bool
changeEvent(self, a0: 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
clearFocus(self)
clearMask(self)
close(self) → bool
closeEvent(self, a0: QCloseEvent)
cmsModels()

A generator that returns the user-specified Cms model structures one at a time.

Return type

generator of cms.Cms

Returns

Each item yielded is a Cms model

Raises

TypeError – If any of the selected input is not a valid Cms model

colorCount(self) → int
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) → QMargins
contentsRect(self) → QRect
contextMenuEvent(self, a0: QContextMenuEvent)
contextMenuPolicy(self) → Qt.ContextMenuPolicy
countStructures()

Return the number of structures specified. If input is invalid, zero will be returned. NOTE: If input source is file, this call can take some time for larger structures files.

Returns

Number of input structrues

Return type

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
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)
drawFrame(self, a0: QPainter)
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
frameRect(self) → QRect
frameShadow(self) → QFrame.Shadow
frameShape(self) → QFrame.Shape
frameSize(self) → QSize
frameStyle(self) → int
frameWidth(self) → int
geometry(self) → QRect
getFile()

Private method; use structFile() method instead.

Returns the contents of the filename entry field. If self.original_dir is defined, relative paths will be converted to absolute paths based on that (This is expected by AF2).

Returns ‘’ if this is called while file input is not allowed.

getFileInputInfo()

Emit input_changed if the new file picked by the user is different from the old file

getFiles()

Private method; use structFiles() method instead.

Return the list of file names from the file entry field. This is a true list, not a comma-separated list.

getSelectedEntryInfo()

Set self._previous_selection to the entries that are selected by the user, depending on the source. Trigger input_changed if the selection has changed.

For INCLUDED_ENTRY and INCLUDED_ENTRIES, this is the IDs of the entries included in the Workspace. For SELECTED_ENTRIES, it’s the IDs of the entries selected in the PT.

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
handleNewDatabaseSource()

Do the work required if the user picks a new database file as the source

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(event)

Deregister callbacks when the panel hides itself so that we are not monitoring changes when the panel is inactive.

Parameters

event (QHideEvent) – The QEvent object generated by this event

Returns

The return value of the QFrame hideEvent method

inherits(self, classname: str) → bool
initPainter(self, painter: QPainter)
initStyleOption(self, option: QStyleOptionFrame)
inputMethodEvent(self, a0: QInputMethodEvent)
inputMethodHints(self) → Qt.InputMethodHint
inputMethodQuery(self, a0: Qt.InputMethodQuery) → Any
input_changed
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
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
keyPressEvent(self, a0: QKeyEvent)
keyReleaseEvent(self, a0: QKeyEvent)
keyboardGrabber() → QWidget
killTimer(self, id: int)
layout(self) → QLayout
layoutDirection(self) → Qt.LayoutDirection
leaveEvent(self, a0: QEvent)
lineWidth(self) → int
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
metaObject(self) → QMetaObject
metric(self, a0: QPaintDevice.PaintDeviceMetric) → int
midLineWidth(self) → 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, a0: QMouseEvent)
mouseReleaseEvent(self, a0: 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]

originalStructFile()
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
pos(self) → QPoint
previousInFocusChain(self) → QWidget
projectUpdated()

If tracking is enabled, emit input_changed when PT source is included or selected entries, and user’s entry selection changes.

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)
removeAllCallbacks()

Remove any previously added callbacks. We need to track callbacks in this manner because Maestro prints a WARNING message to the terminal if a non-registered callback is attempted to be removed.

removeCallback(callback_adder, method)

Remove a callback that may have been registered previously - silently do nothing if the callback isn’t registered. We need to track callbacks in this manner because Maestro prints a WARNING message to the terminal if a non-registered callback is attempted to be removed.

Parameters

  • callback_adder (callable) – A callable function that adds a callback, such as maestro.workspace_changed_function_add. This adder and its remover must be entered into the callback_removers dictionary.

  • method (callable) – The method to use as the callback function.

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)
setAutoFillBackground(self, enabled: bool)
setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) → None
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])
setDisabled(self, a0: bool)
setEnabled(self, a0: bool)
setFile(filename)

Private method; do not use directly.

Select the specified filename in the input selector. To specify multiple files, separate them using commas. “File” or “Files” will be selected as the input source as appropriate.

Parameters

filename (str) – The name of the file or files to select

Raises

  • RuntimeError – If the file entry input state is not avaiable.

  • ValueError – If multiple files were provided, but the multiple files input state is not available.

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)
setFrameRect(self, a0: QRect)
setFrameShadow(self, a0: QFrame.Shadow)
setFrameShape(self, a0: QFrame.Shape)
setFrameStyle(self, a0: int)
setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) → None
setGraphicsEffect(self, effect: QGraphicsEffect)
setHidden(self, hidden: bool)
setInputMethodHints(self, hints: Qt.InputMethodHint)
setInputSourceComboVisible(set_visible)

Show or hide input source combo.

Parameters

set_visible (bool) – True - show input combo, False - hide it.

setInputState(input_state)

Set the input type.

Parameters

input_state (str) – The input state to change to. It must one of FILE, SELECTED_ENTRIES, INCLUDED_ENTRIES, INCLUDED_ENTRY, or WORKSPACE.

Raises

ValueError – If the specified input type is not present

setLayout(self, a0: QLayout)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLineWidth(self, a0: int)
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)
setMidLineWidth(self, a0: int)
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)
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)
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
show(self)
showEvent(event)

Make sure the proper signals are emitted and proper callbacks are registered when the panel shows itself

Parameters

event (QShowEvent) – The QEvent object generated by this event

Returns

The return value of the QFrame showEvent method

showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
signalsBlocked(self) → bool
size(self) → QSize
sizeHint(self) → QSize
sizeIncrement(self) → QSize
sizePolicy(self) → QSizePolicy
sourceType()
source_changed
stackUnder(self, a0: QWidget)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) → int
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
statusTip(self) → str
structFile()
structFiles()
structures(validate=True)

A generator that returns the user-specified input structures one at a time.

API Example:

# appframework1
for struct in self._if.structures():
    do something
# appframework2
for struct in self.input_selector.structures():
    do something
Parameters

validate (bool) – Validate that the InputSelector is in a consistent and complete state (rows are actually selected or file is specified, etc.) Return an empty iterator if input is empty or invalid. Default is True. This option is obsolete.

style(self) → QStyle
styleSheet(self) → str
tabletEvent(self, a0: QTabletEvent)
testAttribute(self, attribute: Qt.WidgetAttribute) → bool
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
validateEntries(rows)

Ensure that the passed entry rows are valid

Parameters

rows (iterable) – Project rows

Return type

str or None

Returns

Error message

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
workspaceChanged(what_changed)

If tracking is enabled, emit input_changed if the Workspace change merits it.

Parameters

what_changed (maestro module constant (str)) – Description of what changed

writePTEntries(filename, source)

Write selected Project Table entries to ‘filename’.

Raises a RuntimeError on error. Returns False if the user cancelled. Returns True on success.

x(self) → int
y(self) → int
current_file

The currently chosen file path if tracking is on

findOrCreateDBEntry()

Find the structure that was used to generate the database and put it in the Workspace.

Raises a warning dialog if no structure can be found