schrodinger.trajectory.trajectory_gui_dir.banners module

class schrodinger.trajectory.trajectory_gui_dir.banners.MeasurementMode(value)

Bases: enum.Enum

Type of measurement for the CentroidBanner to search for

DISTANCE = 1

ANGLE = 2

class schrodinger.trajectory.trajectory_gui_dir.banners.CentroidBanner

Bases: schrodinger.ui.qt.basewidgets.BaseWidget

Banner for picking the centroid of angles or distances

SETS_REQUIRED = {<MeasurementMode.DISTANCE: 1>: 2, <MeasurementMode.ANGLE: 2>: 3}

ui_module = <module 'schrodinger.trajectory.trajectory_gui_dir.centroid_banner_ui' from '/Users/young/builds/2023-1/build/internal/lib/python3.8/site-packages/schrodinger/trajectory/trajectory_gui_dir/centroid_banner_ui.py'>

closeBanner

centroidsPicked

__init__()

initSetUp()

Creates widget from ui and stores it ui_widget.

Suggested subclass use: create and initialize subwidgets, and connect signals.

startPicking()

stopPicking()

APPLY_LEGACY_STYLESHEET = True

APPLY_PANELX_STYLESHEET = False

class BtnPos(value)

Bases: enum.IntEnum

An enumeration.

Left = 0

Middle = 1

Right = 2

DrawChildren = 2

DrawWindowBackground = 1

IgnoreMask = 4

class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1

PdmHeight = 2

PdmWidthMM = 3

PdmHeightMM = 4

PdmNumColors = 5

PdmDepth = 6

PdmDpiX = 7

PdmDpiY = 8

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1

DrawChildren = 2

IgnoreMask = 4

SHOW_AS_WINDOW = False

class StdBtn(value)

Bases: enum.IntEnum

An enumeration.

Ok = 0

Cancel = 1

Reset = 2

Help = 3

acceptDrops(self) → bool

property accepted

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

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

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(event)

Ensures proper handling of OK, Cancel, and [X] button clicks

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

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

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

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)

debug()

deleteLater(self)

depth(self) → int

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

destroyed

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

devType(self) → int

devicePixelRatio(self) → float

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, QMetaMethod)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → PyQt6.sip.voidptr

ensurePolished(self)

enterEvent(self, QEnterEvent)

error(*args, **kwargs)

Shows a popup error message box. For parameter documentation see messagebox.MessageBox.

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

find(PyQt6.sip.voidptr) → QWidget

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

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

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

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

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

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

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

forgetMessageBoxResponse(key)

Forgets any previously saved response that was stored via a save_response_key.

Parameters

key – the key for the response to forget

frameGeometry(self) → QRect

frameSize(self) → QSize

geometry(self) → QRect

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

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

grabKeyboard(self)

grabMouse(self)

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

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

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

hasFocus(self) → bool

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(*args, **kwargs)

Shows a popup information message box. For parameter documentation see messagebox.MessageBox.

inherits(self, str) → bool

initFinalize()

Suggested subclass use: perform any remaining initialization.

initLayOut()

Create a vertical layout for the widget (widget_layout) and populate it with two vertical sub-layouts: main_layout and bottom_layout.

If the user has specified the ui data member, insert the resultant ui_widget into main_layout.

If the widget already has a layout defined, this method will produce a warning (but not a traceback). main_layout and bottom_layout will be inserted into the existing widget layout, which will not be the same as widget_layout. It is therefore recommended that this mixin is used only with widgets that do not already have a layout.

Suggested subclass use: create, initialize, and populate layouts.

initPainter(self, QPainter)

initSetDefaults()

Set widget to its default state. If the widget uses a model/mapper, it’s preferable to reset the widget state by resetting the model.

initSetOptions()

Suggested subclass use: set instance variables, excluding layouts and subwidgets. Also use here to (optionally) apply the legacy stylesheet spacing settings (PANEL-19101).

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHint

inputMethodQuery(self, Qt.InputMethodQuery) → Any

CentroidBanner.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(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, QEvent)

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFrom(self, QWidget, QPointF) → QPointF

mapFromGlobal(self, QPoint) → QPoint

mapFromGlobal(self, QPointF) → QPointF

mapFromParent(self, QPoint) → QPoint

mapFromParent(self, QPointF) → QPointF

mapTo(self, QWidget, QPoint) → QPoint

mapTo(self, QWidget, QPointF) → QPointF

mapToGlobal(self, QPoint) → QPoint

mapToGlobal(self, QPointF) → QPointF

mapToParent(self, QPoint) → QPoint

mapToParent(self, QPointF) → QPointF

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

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

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

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

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

overrideWindowFlags(self, Qt.WindowType)

overrideWindowState(self, Qt.WindowState)

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

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(*args, **kwargs)

Shows a popup question message box. For parameter documentation see messagebox.QuestionMessageBox.

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

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

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

repaint(self)

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

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

resizeEvent(self, QResizeEvent)

restoreGeometry(self, QByteArray) → bool

run(blocking=False, modal=False, finished_callback=None)

Show this widget, while optionally blocking, making the widget window modal, and registering a callback for when the widget is closed again.

Parameters

• blocking (bool) – if True, block progress in the calling method until the widget is closed again.

• modal (bool) – if True, open this widget as window modal. Otherwise, open this widget as nonmodal.

• finished_callback (a callable object) – an object that will be called with no arguments when this widget is closed.

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

screen(self) → QScreen

CentroidBanner.scroll(self, int, int)

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

CentroidBanner.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

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

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

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

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setInputMethodHints(self, Qt.InputMethodHint)

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion) → None

setMaximumHeight(self, int)

CentroidBanner.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMinimumHeight(self, int)

CentroidBanner.setMinimumSize(self, int, int)

setMinimumSize(self, QSize) → None

setMinimumWidth(self, int)

setMouseTracking(self, bool)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

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

setProperty(self, str, Any) → bool

setScreen(self, QScreen)

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

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

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

CentroidBanner.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWidgetLayout()

Set the widget layout

setWindowFilePath(self, str)

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

setWindowFlags(self, Qt.WindowType)

setWindowFlagsForRun()

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Qt.WindowState)

setWindowTitle(self, str)

sharedPainter(self) → QPainter

show()

Override the show method to clear and previous value of self.accepted

showEvent(self, QShowEvent)

showFullScreen(self)

showMaximized(self)

showMessageBox(*args, **kwargs)

Shows a popup message box. For parameter documentation see messagebox.MessageBox.

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

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

staticMetaObject = <PyQt6.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, QTimerEvent)

toolTip(self) → str

toolTipDuration(self) → int

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

underMouse(self) → bool

ungrabGesture(self, Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QRect) → None

update(self, QRegion) → None

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

updateGeometry(self)

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

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

warning(*args, **kwargs)

Shows a popup warning message box. For parameter documentation see messagebox.MessageBox.

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → PyQt6.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowType

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowState

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class schrodinger.trajectory.trajectory_gui_dir.banners.PlanarBanner

Bases: schrodinger.ui.qt.basewidgets.BaseWidget

Banner for picking the planar angle of six atoms

ui_module = <module 'schrodinger.trajectory.trajectory_gui_dir.planar_banner_ui' from '/Users/young/builds/2023-1/build/internal/lib/python3.8/site-packages/schrodinger/trajectory/trajectory_gui_dir/planar_banner_ui.py'>

closeBanner

planarAnglesPicked

__init__()

initSetUp()

Creates widget from ui and stores it ui_widget.

Suggested subclass use: create and initialize subwidgets, and connect signals.

startPicking()

stopPicking()

APPLY_LEGACY_STYLESHEET = True

APPLY_PANELX_STYLESHEET = False

class BtnPos(value)

Bases: enum.IntEnum

An enumeration.

Left = 0

Middle = 1

Right = 2

DrawChildren = 2

DrawWindowBackground = 1

IgnoreMask = 4

class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1

PdmHeight = 2

PdmWidthMM = 3

PdmHeightMM = 4

PdmNumColors = 5

PdmDepth = 6

PdmDpiX = 7

PdmDpiY = 8

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1

DrawChildren = 2

IgnoreMask = 4

SHOW_AS_WINDOW = False

class StdBtn(value)

Bases: enum.IntEnum

An enumeration.

Ok = 0

Cancel = 1

Reset = 2

Help = 3

acceptDrops(self) → bool

property accepted

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

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

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(event)

Ensures proper handling of OK, Cancel, and [X] button clicks

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

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

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

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)

debug()

deleteLater(self)

depth(self) → int

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

destroyed

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

devType(self) → int

devicePixelRatio(self) → float

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, QMetaMethod)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → PyQt6.sip.voidptr

ensurePolished(self)

enterEvent(self, QEnterEvent)

error(*args, **kwargs)

Shows a popup error message box. For parameter documentation see messagebox.MessageBox.

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

find(PyQt6.sip.voidptr) → QWidget

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

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

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

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

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

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

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

forgetMessageBoxResponse(key)

Forgets any previously saved response that was stored via a save_response_key.

Parameters

key – the key for the response to forget

frameGeometry(self) → QRect

frameSize(self) → QSize

geometry(self) → QRect

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

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

grabKeyboard(self)

grabMouse(self)

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

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

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

hasFocus(self) → bool

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(*args, **kwargs)

Shows a popup information message box. For parameter documentation see messagebox.MessageBox.

inherits(self, str) → bool

initFinalize()

Suggested subclass use: perform any remaining initialization.

initLayOut()

Create a vertical layout for the widget (widget_layout) and populate it with two vertical sub-layouts: main_layout and bottom_layout.

If the user has specified the ui data member, insert the resultant ui_widget into main_layout.

If the widget already has a layout defined, this method will produce a warning (but not a traceback). main_layout and bottom_layout will be inserted into the existing widget layout, which will not be the same as widget_layout. It is therefore recommended that this mixin is used only with widgets that do not already have a layout.

Suggested subclass use: create, initialize, and populate layouts.

initPainter(self, QPainter)

initSetDefaults()

Set widget to its default state. If the widget uses a model/mapper, it’s preferable to reset the widget state by resetting the model.

initSetOptions()

Suggested subclass use: set instance variables, excluding layouts and subwidgets. Also use here to (optionally) apply the legacy stylesheet spacing settings (PANEL-19101).

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHint

inputMethodQuery(self, Qt.InputMethodQuery) → Any

PlanarBanner.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(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, QEvent)

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFrom(self, QWidget, QPointF) → QPointF

mapFromGlobal(self, QPoint) → QPoint

mapFromGlobal(self, QPointF) → QPointF

mapFromParent(self, QPoint) → QPoint

mapFromParent(self, QPointF) → QPointF

mapTo(self, QWidget, QPoint) → QPoint

mapTo(self, QWidget, QPointF) → QPointF

mapToGlobal(self, QPoint) → QPoint

mapToGlobal(self, QPointF) → QPointF

mapToParent(self, QPoint) → QPoint

mapToParent(self, QPointF) → QPointF

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

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

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

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

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

overrideWindowFlags(self, Qt.WindowType)

overrideWindowState(self, Qt.WindowState)

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

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(*args, **kwargs)

Shows a popup question message box. For parameter documentation see messagebox.QuestionMessageBox.

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

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

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

repaint(self)

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

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

resizeEvent(self, QResizeEvent)

restoreGeometry(self, QByteArray) → bool

run(blocking=False, modal=False, finished_callback=None)

Show this widget, while optionally blocking, making the widget window modal, and registering a callback for when the widget is closed again.

Parameters

• blocking (bool) – if True, block progress in the calling method until the widget is closed again.

• modal (bool) – if True, open this widget as window modal. Otherwise, open this widget as nonmodal.

• finished_callback (a callable object) – an object that will be called with no arguments when this widget is closed.

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

screen(self) → QScreen

PlanarBanner.scroll(self, int, int)

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

PlanarBanner.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

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

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

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

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

setInputMethodHints(self, Qt.InputMethodHint)

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion) → None

setMaximumHeight(self, int)

PlanarBanner.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMinimumHeight(self, int)

PlanarBanner.setMinimumSize(self, int, int)

setMinimumSize(self, QSize) → None

setMinimumWidth(self, int)

setMouseTracking(self, bool)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

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

setProperty(self, str, Any) → bool

setScreen(self, QScreen)

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

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

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

PlanarBanner.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWidgetLayout()

Set the widget layout

setWindowFilePath(self, str)

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

setWindowFlags(self, Qt.WindowType)

setWindowFlagsForRun()

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

setWindowState(self, Qt.WindowState)

setWindowTitle(self, str)

sharedPainter(self) → QPainter

show()

Override the show method to clear and previous value of self.accepted

showEvent(self, QShowEvent)

showFullScreen(self)

showMaximized(self)

showMessageBox(*args, **kwargs)

Shows a popup message box. For parameter documentation see messagebox.MessageBox.

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

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

staticMetaObject = <PyQt6.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, QTimerEvent)

toolTip(self) → str

toolTipDuration(self) → int

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

underMouse(self) → bool

ungrabGesture(self, Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QRect) → None

update(self, QRegion) → None

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

updateGeometry(self)

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

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

warning(*args, **kwargs)

Shows a popup warning message box. For parameter documentation see messagebox.MessageBox.

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → PyQt6.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowType

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowState

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int