schrodinger.ui.qt.appframework2.baseapp module

class schrodinger.ui.qt.appframework2.baseapp.DockWidget(object_name, dockarea)

Bases: schrodinger.ui._maestro_ui.MM_QDockWidget

This class propagates closeEvents to the App so that panel knows that it is closed. Otherwise maestro callbacks will not get removed.

__init__(object_name, dockarea)

closeEvent(event)

Do not close the floating python panel and instead emit a SIGNAL to Maestro which redocks the panel back into main window. This is a temporary workaround for Qt5 redock issues

AllDockWidgetFeatures = 7

DockWidgetClosable = 1

class DockWidgetFeature

Bases: int

class DockWidgetFeatures

class DockWidgetFeatures(Union[QDockWidget.DockWidgetFeatures, QDockWidget.DockWidgetFeature]) → None

class DockWidgetFeatures(QDockWidget.DockWidgetFeatures) → None

Bases: sip.simplewrapper

__init__(*args, **kwargs)

DockWidgetFloatable = 4

DockWidgetMovable = 2

DockWidgetVerticalTitleBar = 8

DrawChildren = 2

DrawWindowBackground = 1

IgnoreMask = 4

NoDockWidgetFeatures = 0

class PaintDeviceMetric

Bases: int

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

Bases: int

class RenderFlags

class RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) → None

class RenderFlags(QWidget.RenderFlags) → None

Bases: sip.simplewrapper

__init__(*args, **kwargs)

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

adjustSize(self)

allowedAreas(self) → Qt.DockWidgetAreas

allowedAreasChanged

allowedAreasChanged(self, Union[Qt.DockWidgetAreas, Qt.DockWidgetArea]) [signal]

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, bool) → bool

changeEvent(self, QEvent)

childAt(self, QPoint) → QWidget

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

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

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

createWindowContainer(QWindow, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0) → 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) → int

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, QMetaMethod)

dockLocationChanged

dockLocationChanged(self, Qt.DockWidgetArea) [signal]

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → PyQt5.sip.voidptr

ensurePolished(self)

enterEvent(self, QEvent)

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

features(self) → QDockWidget.DockWidgetFeatures

featuresChanged

featuresChanged(self, Union[QDockWidget.DockWidgetFeatures, QDockWidget.DockWidgetFeature]) [signal]

find(PyQt5.sip.voidptr) → QWidget

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

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

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

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

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

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

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

findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, 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

getContentsMargins(self) → Tuple[int, int, int, int]

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

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

grabKeyboard(self)

grabMouse(self)

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

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

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, int) → int

heightMM(self) → int

hide(self)

hideEvent(self, QHideEvent)

inherits(self, str) → bool

initPainter(self, QPainter)

initStyleOption(self, QStyleOptionDockWidget)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHints

inputMethodQuery(self, Qt.InputMethodQuery) → Any

DockWidget.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

installEventFilter(self, QObject)

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isAreaAllowed(self, Qt.DockWidgetArea) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFloating(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

mapFromGlobal(self, QPoint) → QPoint

mapFromParent(self, QPoint) → QPoint

mapTo(self, QWidget, QPoint) → QPoint

mapToGlobal(self, QPoint) → QPoint

mapToParent(self, QPoint) → QPoint

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

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

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

overrideWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])

overrideWindowState(self, Union[Qt.WindowStates, Qt.WindowState])

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

pos(self) → QPoint

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.

pythonPanelAboutToBeClosed

raise_(self)

receivers(self, PYQT_SIGNAL) → int

reconfigureDockWidget

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

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

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

repaint(self)

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

repaint(self, QRect) → None

repaint(self, QRegion) → None

resize(self, QSize)

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

resizeEvent(self, QResizeEvent)

restoreGeometry(self, Union[QByteArray, bytes, bytearray]) → bool

saveGeometry(self) → QByteArray

DockWidget.scroll(self, int, int)

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

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

setAllowedAreas(self, Union[Qt.DockWidgetAreas, Qt.DockWidgetArea])

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

setAutoFillBackground(self, bool)

setBackgroundRole(self, QPalette.ColorRole)

DockWidget.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

DockWidget.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins) → None

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

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

setDisabled(self, bool)

setEnabled(self, bool)

setFeatures(self, Union[QDockWidget.DockWidgetFeatures, QDockWidget.DockWidgetFeature])

setFixedHeight(self, int)

setFixedSize(self, QSize)

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

setFixedWidth(self, int)

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

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

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion) → None

setMaximumHeight(self, int)

DockWidget.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMinimumHeight(self, int)

DockWidget.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, Union[Qt.WindowFlags, Qt.WindowType]) → None

setProperty(self, str, Any) → bool

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

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

DockWidget.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)

DockWidget.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setTitleBarWidget(self, QWidget)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWidget(self, QWidget)

setWindowFilePath(self, str)

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

setWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Union[Qt.WindowStates, Qt.WindowState])

setWindowTitle(self, str)

setupDockWidget

sharedPainter(self) → QPainter

show(self)

showEvent(self, QShowEvent)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

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

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, QTimerEvent)

titleBarWidget(self) → QWidget

toggleViewAction(self) → QAction

toolTip(self) → str

toolTipDuration(self) → int

topLevelChanged

topLevelChanged(self, bool) [signal]

tr(self, 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

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

updateGeometry(self)

updateMicroFocus(self)

updatesEnabled(self) → bool

visibilityChanged

visibilityChanged(self, bool) [signal]

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

widget(self) → QWidget

width(self) → int

widthMM(self) → int

winId(self) → PyQt5.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowFlags

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.WindowStates

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class schrodinger.ui.qt.appframework2.baseapp.BasePanel(stop_before=None, parent=None, in_knime=False, workspace_st_file=None)

Bases: PyQt5.QtWidgets.QWidget

gui_closed

__init__(stop_before=None, parent=None, in_knime=False, workspace_st_file=None)

Parameters

• stop_before (int) – Exit the constructor before specified step.

• parent (QWidget) – Parent widget, if any.

• in_knime (bool) – Whether we are currently running under KNIME - a mode in which input selector is hidden, optionally a custom Workspace Structure is specified, and buttom bar has OK & Cancel buttons.

• workspace_st_file (bool) – Structure to be returned by getWorkspaceStructure() when in_knime is True.

startUp()

setPanelOptions()

setup()

setDefaults()

setStyleSheet(self, str)

layOut()

showEvent(show_event)

Override the normal processing when the panel is shown.

setVisible(self, bool)

runMode()

run()

cleanup()

closeEvent(event)

Close panel and quit application if this is a top level standalone window. Otherwise, hide the panel.

runSubpanel()

runMaestro()

This can be extended in derived classes to perform maestro-only tasks such as setting up the mini-monitor or connecting maestro callbacks

runCanvas()

This handles Canvas-specific logic

runStandalone()

show(self)

parent(self) → QObject

property title

warning(text, preferences=None, key='')

Display a warning dialog with the specified text. If preferences and key are both supplied, then the dialog will contain a “Don’t show this again” checkbox. Future invocations of this dialog with the same preferences and key values will obey the user’s show preference.

Parameters

• text (str) – The information to display in the dialog

• preferences – obsolete; ignored.

• key (str) – The key to store the preference under. If specified, a “Do not show again” checkbox will be rendered in the dialog box.

Return type

None

info(text, preferences=None, key='')

Display an information dialog with the specified text. If preferences and key are both supplied, then the dialog will contain a “Don’t show this again” checkbox. Future invocations of this dialog with the same preferences and key values will obey the user’s show preference.

Parameters

• text (str) – The information to display in the dialog

• preferences – obsolete; ignored.

• key (str) – The key to store the preference under. If specified, a “Do not show again” checkbox will be rendered in the dialog box.

Return type

None

error(text, preferences=None, key='')

Display an error dialog with the specified text. If preferences and key are both supplied, then the dialog will contain a “Don’t show this again” checkbox. Future invocations of this dialog with the same preferences and key values will obey the user’s show preference.

Parameters

• text (str) – The information to display in the dialog

• preferences – obsolete; ignored.

• key (str) – The key to store the preference under. If specified, a “Do not show again” checkbox will be rendered in the dialog box.

Return type

None

question(msg, button1='OK', button2='Cancel', title='Question')

Display a prompt dialog window with specified text. Returns True if first button (default OK) is pressed, False otherwise.

setWaitCursor(app_wide=True)

Set the cursor to the wait cursor. This will be an hourglass, clock or similar. Call restoreCursor() to return to the default cursor.

Parameters

app_wide (bool) – If True then this will apply to the entire application (including Maestro if running there). If False then this will apply only to this panel.

restoreCursor(app_wide=True)

Restore the application level cursor to the default. If ‘app_wide’ is True then if will be restored for the entire application, if it’s False, it will be just for this panel.

Parameters

app_wide (bool) – If True then this will restore the cursor for the entire application (including Maestro if running there). If False then this will apply only to this panel.

keyPressEvent(self, QKeyEvent)

DrawChildren = 2

DrawWindowBackground = 1

IgnoreMask = 4

class PaintDeviceMetric

Bases: int

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

Bases: int

class RenderFlags

class RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) → None

class RenderFlags(QWidget.RenderFlags) → None

Bases: sip.simplewrapper

__init__(*args, **kwargs)

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

adjustSize(self)

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, bool) → bool

changeEvent(self, QEvent)

childAt(self, QPoint) → QWidget

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

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

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

createWindowContainer(QWindow, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0) → 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) → int

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) → PyQt5.sip.voidptr

ensurePolished(self)

enterEvent(self, QEvent)

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

find(PyQt5.sip.voidptr) → QWidget

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

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

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

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

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

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

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

findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, 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

getContentsMargins(self) → Tuple[int, int, int, int]

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

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

grabKeyboard(self)

grabMouse(self)

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

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

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, int) → int

heightMM(self) → int

hide(self)

hideEvent(self, QHideEvent)

inherits(self, str) → bool

initPainter(self, QPainter)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHints

inputMethodQuery(self, Qt.InputMethodQuery) → Any

BasePanel.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

installEventFilter(self, QObject)

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, QEvent)

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFromGlobal(self, QPoint) → QPoint

mapFromParent(self, QPoint) → QPoint

mapTo(self, QWidget, QPoint) → QPoint

mapToGlobal(self, QPoint) → QPoint

mapToParent(self, QPoint) → QPoint

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

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

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

overrideWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])

overrideWindowState(self, Union[Qt.WindowStates, Qt.WindowState])

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

pos(self) → QPoint

previousInFocusChain(self) → QWidget

property(self, str) → Any

pyqtConfigure(...)

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

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

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

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

repaint(self)

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

repaint(self, QRect) → None

repaint(self, QRegion) → None

resize(self, QSize)

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

resizeEvent(self, QResizeEvent)

restoreGeometry(self, Union[QByteArray, bytes, bytearray]) → bool

saveGeometry(self) → QByteArray

BasePanel.scroll(self, int, int)

BasePanel.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)

BasePanel.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

BasePanel.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins) → None

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

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

setDisabled(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

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

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason) → None

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setGeometry(self, QRect)

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

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion) → None

setMaximumHeight(self, int)

BasePanel.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMinimumHeight(self, int)

BasePanel.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, Union[Qt.WindowFlags, Qt.WindowType]) → None

setProperty(self, str, Any) → bool

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

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

BasePanel.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize) → None

setSizePolicy(self, QSizePolicy)

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

setStatusTip(self, str)

setStyle(self, QStyle)

BasePanel.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

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

setWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Union[Qt.WindowStates, Qt.WindowState])

setWindowTitle(self, str)

sharedPainter(self) → QPainter

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

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

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, QTimerEvent)

toolTip(self) → str

toolTipDuration(self) → int

tr(self, 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

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

updateGeometry(self)

updateMicroFocus(self)

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → PyQt5.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowFlags

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.WindowStates

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class schrodinger.ui.qt.appframework2.baseapp.ValidatedPanel(*args, **kwargs)

Bases: schrodinger.ui.qt.appframework2.baseapp.BasePanel, schrodinger.ui.qt.appframework2.validation.ValidationMixin

DrawChildren = 2

DrawWindowBackground = 1

IgnoreMask = 4

class PaintDeviceMetric

Bases: int

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

Bases: int

class RenderFlags

class RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) → None

class RenderFlags(QWidget.RenderFlags) → None

Bases: sip.simplewrapper

__init__(*args, **kwargs)

__init__(*args, **kwargs)

Parameters

• stop_before (int) – Exit the constructor before specified step.

• parent (QWidget) – Parent widget, if any.

• in_knime (bool) – Whether we are currently running under KNIME - a mode in which input selector is hidden, optionally a custom Workspace Structure is specified, and buttom bar has OK & Cancel buttons.

• workspace_st_file (bool) – Structure to be returned by getWorkspaceStructure() when in_knime is True.

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

adjustSize(self)

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, bool) → bool

changeEvent(self, QEvent)

childAt(self, QPoint) → QWidget

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

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

cleanup()

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(event)

Close panel and quit application if this is a top level standalone window. Otherwise, hide the panel.

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

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

createWindowContainer(QWindow, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0) → 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) → int

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) → PyQt5.sip.voidptr

ensurePolished(self)

enterEvent(self, QEvent)

error(text, preferences=None, key='')

Display an error dialog with the specified text. If preferences and key are both supplied, then the dialog will contain a “Don’t show this again” checkbox. Future invocations of this dialog with the same preferences and key values will obey the user’s show preference.

Parameters

• text (str) – The information to display in the dialog

• preferences – obsolete; ignored.

• key (str) – The key to store the preference under. If specified, a “Do not show again” checkbox will be rendered in the dialog box.

Return type

None

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

find(PyQt5.sip.voidptr) → QWidget

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

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

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

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

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

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

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

findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, 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

getContentsMargins(self) → Tuple[int, int, int, int]

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

grabGesture(self, Qt.GestureType, flags: Union[Qt.GestureFlags, 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

gui_closed

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)

info(text, preferences=None, key='')

Display an information dialog with the specified text. If preferences and key are both supplied, then the dialog will contain a “Don’t show this again” checkbox. Future invocations of this dialog with the same preferences and key values will obey the user’s show preference.

Parameters

• text (str) – The information to display in the dialog

• preferences – obsolete; ignored.

• key (str) – The key to store the preference under. If specified, a “Do not show again” checkbox will be rendered in the dialog box.

Return type

None

inherits(self, str) → bool

initPainter(self, QPainter)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHints

inputMethodQuery(self, Qt.InputMethodQuery) → Any

ValidatedPanel.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

installEventFilter(self, QObject)

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, int)

layOut()

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

mapFromGlobal(self, QPoint) → QPoint

mapFromParent(self, QPoint) → QPoint

mapTo(self, QWidget, QPoint) → QPoint

mapToGlobal(self, QPoint) → QPoint

mapToParent(self, QPoint) → QPoint

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

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

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

overrideWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])

overrideWindowState(self, Union[Qt.WindowStates, Qt.WindowState])

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

pos(self) → QPoint

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.

question(msg, button1='OK', button2='Cancel', title='Question')

Display a prompt dialog window with specified text. Returns True if first button (default OK) is pressed, False otherwise.

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

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

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

repaint(self)

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

repaint(self, QRect) → None

repaint(self, QRegion) → None

reportValidation(results)

Present validation messages to the user. This is an implmentation of the ValidationMixin interface and does not need to be called directly.

This method assumes that error and question methods have been defined in the subclass, as in e.g. widget_mixins.MessageBoxMixin.

Parameters

results (validation.ValidationResults) – Set of validation results generated by validate

Returns

if True, there were no validation errors and the user decided to continue despite any warnings. If False, there was at least one validation error or the user decided to abort when faced with a warning.

resize(self, QSize)

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

resizeEvent(self, QResizeEvent)

restoreCursor(app_wide=True)

Restore the application level cursor to the default. If ‘app_wide’ is True then if will be restored for the entire application, if it’s False, it will be just for this panel.

Parameters

app_wide (bool) – If True then this will restore the cursor for the entire application (including Maestro if running there). If False then this will apply only to this panel.

restoreGeometry(self, Union[QByteArray, bytes, bytearray]) → bool

run()

runCanvas()

This handles Canvas-specific logic

runMaestro()

This can be extended in derived classes to perform maestro-only tasks such as setting up the mini-monitor or connecting maestro callbacks

runMode()

runStandalone()

runSubpanel()

runValidation(silent=False, validate_children=True, stop_on_fail=True)

Runs validation and reports the results (unless run silently).

Parameters

• silent (bool) – run without any reporting (i.e. error messages to the user). This is useful if we want to programmatically test validity. Changes return value of this method from ValidationResults to a boolean.

• validate_children (bool) – run validation on all child objects. See _validateChildren for documentation on what this entails.

• stop_on_fail (bool) – stop validation when first failure is encountered

Returns

if silent is False, returns the validation results. If silent is True, returns a boolean generated by reportValidation.

Return type

ValidationResults or bool

saveGeometry(self) → QByteArray

ValidatedPanel.scroll(self, int, int)

ValidatedPanel.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)

ValidatedPanel.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

ValidatedPanel.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins) → None

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

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

setDefaults()

setDisabled(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

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

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason) → None

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setGeometry(self, QRect)

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

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion) → None

setMaximumHeight(self, int)

ValidatedPanel.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMinimumHeight(self, int)

ValidatedPanel.setMinimumSize(self, int, int)

setMinimumSize(self, QSize) → None

setMinimumWidth(self, int)

setMouseTracking(self, bool)

setObjectName(self, str)

setPalette(self, QPalette)

setPanelOptions()

setParent(self, QWidget)

setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType]) → None

setProperty(self, str, Any) → bool

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

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

ValidatedPanel.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)

ValidatedPanel.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWaitCursor(app_wide=True)

Set the cursor to the wait cursor. This will be an hourglass, clock or similar. Call restoreCursor() to return to the default cursor.

Parameters

app_wide (bool) – If True then this will apply to the entire application (including Maestro if running there). If False then this will apply only to this panel.

setWhatsThis(self, str)

setWindowFilePath(self, str)

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

setWindowFlags(self, Union[Qt.WindowFlags, Qt.WindowType])

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Union[Qt.WindowStates, Qt.WindowState])

setWindowTitle(self, str)

setup()

sharedPainter(self) → QPainter

show(self)

showEvent(show_event)

Override the normal processing when the panel is shown.

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

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

startUp()

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, QTimerEvent)

property title

toolTip(self) → str

toolTipDuration(self) → int

tr(self, 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

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

updateGeometry(self)

updateMicroFocus(self)

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

warning(text, preferences=None, key='')

Display a warning dialog with the specified text. If preferences and key are both supplied, then the dialog will contain a “Don’t show this again” checkbox. Future invocations of this dialog with the same preferences and key values will obey the user’s show preference.

Parameters

• text (str) – The information to display in the dialog

• preferences – obsolete; ignored.

• key (str) – The key to store the preference under. If specified, a “Do not show again” checkbox will be rendered in the dialog box.

Return type

None

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → PyQt5.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowFlags

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.WindowStates

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int