schrodinger.trajectory.trajectory_gui_dir.traj_plot_gui module¶
Plot panel for the Trajectory Player.
Copyright Schrodinger, LLC. All rights reserved.
-
class
schrodinger.trajectory.trajectory_gui_dir.traj_plot_gui.
TrajectoryPlotType
¶ Bases:
enum.Enum
Enum of plot types to generate
-
MEASUREMENT_WORKSPACE
= 1¶
-
MEASUREMENT_ADD
= 2¶
-
MEASUREMENT_PLANAR_ANGLE
= 3¶
-
MEASUREMENT_CENTROID
= 4¶
-
INTERACTIONS_ALL
= 5¶
-
INTERACTIONS_NONCOVALENT
= 6¶
-
INTERACTIONS_PI
= 7¶
-
INTERACTIONS_CONTACT
= 8¶
-
DESCRIPTORS_RMSD
= 9¶
-
DESCRIPTORS_RADIUS_GYRATION
= 10¶
-
DESCRIPTORS_PSA
= 11¶
-
DESCRIPTORS_SASA
= 12¶
-
DESCRIPTORS_MOLECULAR_SA
= 13¶
-
-
class
schrodinger.trajectory.trajectory_gui_dir.traj_plot_gui.
CollapsiblePlot
(parent=None, parent_layout=None, system_title='', plot_title='', widget=None)¶ Bases:
PyQt5.QtWidgets.QWidget
This class defines a collapsible plot. The widget has an area for title text, a ‘collapse’ button and a ‘close’ button.
-
widgetClosed
¶
-
__init__
(parent=None, parent_layout=None, system_title='', plot_title='', widget=None)¶ Parameters: - system_title (str) – System title for the widget
- plot_title (str) – Title to set for this title bar
- parent_layout (
QtWidgets.QLayout
) – Parent layout this widget is contained in - widget (
QtWidgets.QWidget
) – Widget to set in the collapsible area
-
setWidget
(widget)¶ Set the widget in the collapsible area to the specified widget.
Parameters: widget ( QtWidget.QWidget
) – Widget to set in the collapsible area.
-
onCollapseButtonClicked
()¶ Collapse or expand the widget depending on its current state.
-
close
()¶ Close and remove this widget.
-
DrawChildren
= 2¶
-
DrawWindowBackground
= 1¶
-
IgnoreMask
= 4¶
-
class
PaintDeviceMetric
¶ Bases:
int
-
__init__
= <method-wrapper '__init__' of sip.enumtype object at 0x34f04c8>¶
-
-
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
-
__init__
= <method-wrapper '__init__' of sip.enumtype object at 0x42c1a78>¶
-
-
class
RenderFlags
¶ Bases:
sip.simplewrapper
QWidget.RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) QWidget.RenderFlags(QWidget.RenderFlags)
-
__init__
¶ Initialize self. See help(type(self)) for accurate signature.
-
-
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¶ childAt(self, int, int) -> QWidget
-
childEvent
(self, QChildEvent)¶
-
children
(self) → List[QObject]¶
-
childrenRect
(self) → QRect¶
-
childrenRegion
(self) → QRegion¶
-
clearFocus
(self)¶
-
clearMask
(self)¶
-
closeEvent
(self, QCloseEvent)¶
-
colorCount
(self) → int¶
-
connectNotify
(self, QMetaMethod)¶
-
contentsMargins
(self) → QMargins¶
-
contentsRect
(self) → QRect¶
-
contextMenuEvent
(self, QContextMenuEvent)¶
-
contextMenuPolicy
(self) → Qt.ContextMenuPolicy¶
-
create
(self, window: 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
(self)¶
-
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) → sip.voidptr¶
-
ensurePolished
(self)¶
-
enterEvent
(self, QEvent)¶
-
event
(self, QEvent) → bool¶
-
eventFilter
(self, QObject, QEvent) → bool¶
-
find
(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])
-
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¶
-
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¶
-
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)¶ move(self, int, int)
-
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.
-
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.DrawWindowBackground|QWidget.DrawChildren))¶ render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground|QWidget.DrawChildren))
-
repaint
(self)¶ repaint(self, int, int, int, int) repaint(self, QRect) repaint(self, QRegion)
-
resize
(self, QSize)¶ resize(self, int, int)
-
resizeEvent
(self, QResizeEvent)¶
-
restoreGeometry
(self, Union[QByteArray, bytes, bytearray]) → bool¶
-
saveGeometry
(self) → QByteArray¶
-
scroll
(self, int, int)¶ scroll(self, int, int, QRect)
-
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)¶
-
setBaseSize
(self, int, int)¶ setBaseSize(self, QSize)
-
setContentsMargins
(self, int, int, int, int)¶ setContentsMargins(self, QMargins)
-
setContextMenuPolicy
(self, Qt.ContextMenuPolicy)¶
-
setCursor
(self, Union[QCursor, Qt.CursorShape])¶
-
setDisabled
(self, bool)¶
-
setEnabled
(self, bool)¶
-
setFixedHeight
(self, int)¶
-
setFixedSize
(self, QSize)¶ setFixedSize(self, int, int)
-
setFixedWidth
(self, int)¶
-
setFocus
(self)¶ setFocus(self, Qt.FocusReason)
-
setFocusPolicy
(self, Qt.FocusPolicy)¶
-
setFocusProxy
(self, QWidget)¶
-
setFont
(self, QFont)¶
-
setForegroundRole
(self, QPalette.ColorRole)¶
-
setGeometry
(self, QRect)¶ setGeometry(self, int, int, int, int)
-
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)
-
setMaximumHeight
(self, int)¶
-
setMaximumSize
(self, int, int)¶ setMaximumSize(self, QSize)
-
setMaximumWidth
(self, int)¶
-
setMinimumHeight
(self, int)¶
-
setMinimumSize
(self, int, int)¶ setMinimumSize(self, QSize)
-
setMinimumWidth
(self, int)¶
-
setMouseTracking
(self, bool)¶
-
setObjectName
(self, str)¶
-
setPalette
(self, QPalette)¶
-
setParent
(self, QWidget)¶ setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
-
setProperty
(self, str, Any) → bool¶
-
setShortcutAutoRepeat
(self, int, enabled: bool = True)¶
-
setShortcutEnabled
(self, int, enabled: bool = True)¶
-
setSizeIncrement
(self, int, int)¶ setSizeIncrement(self, QSize)
-
setSizePolicy
(self, QSizePolicy)¶ setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
-
setStatusTip
(self, str)¶
-
setStyle
(self, QStyle)¶
-
setStyleSheet
(self, str)¶
-
setTabOrder
(QWidget, QWidget)¶
-
setTabletTracking
(self, bool)¶
-
setToolTip
(self, str)¶
-
setToolTipDuration
(self, int)¶
-
setUpdatesEnabled
(self, bool)¶
-
setVisible
(self, bool)¶
-
setWhatsThis
(self, str)¶
-
setWindowFilePath
(self, str)¶
-
setWindowFlag
(self, Qt.WindowType, on: bool = True)¶
-
setWindowFlags
(self, 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)¶
-
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)¶
-
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) update(self, QRegion) update(self, int, int, int, int)
-
updateGeometry
(self)¶
-
updateMicroFocus
(self)¶
-
updatesEnabled
(self) → bool¶
-
visibleRegion
(self) → QRegion¶
-
whatsThis
(self) → str¶
-
wheelEvent
(self, QWheelEvent)¶
-
width
(self) → int¶
-
widthMM
(self) → int¶
-
winId
(self) → 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.trajectory.trajectory_gui_dir.traj_plot_gui.
TrajAnalysisPlotPanel
(*args, **kwargs)¶ Bases:
schrodinger.ui.qt.basewidgets.MaestroDockPanel
Main class for setting up the panel.
-
model_class
¶ alias of
schrodinger.trajectory.trajectory_gui_dir.traj_plot_models.TrajPlotModel
-
ui_module
= <module 'schrodinger.trajectory.trajectory_gui_dir.traj_plot_ui' from '/scr/buildbot/savedbuilds/2019-3/NB/build-143/internal/lib/python3.6/site-packages/schrodinger/trajectory/trajectory_gui_dir/traj_plot_ui.py'>¶
-
createPlot
¶
-
trajectoryChanged
¶
-
initSetOptions
()¶ Suggested subclass use: set instance variables, excluding layouts and subwidgets.
-
initSetUp
()¶ Creates widget from
ui
and stores itui_widget
.Suggested subclass use: create and initialize subwidgets, and connect signals.
-
initLayout
()¶
-
getSignalsAndSlots
(model)¶ Override this method to specify signal and slot pairs that need to be connected/disconnected whenever the model instance is switched using setModel. The model instance is provided as an argument so that instance-specific signals can be used, but any pairs of signals and slots may be returned from this method.
Returns: a list of 2-tuples where each tuple is a signal, slot pair
-
defineMappings
()¶ Override this in the subclass to define mappings. Should return a list of tuples [(<target>, <param>)]. Most commonly, targets will be a basic widget, like QLineEdit or QComboBox, or a custom widget that inherits from MapperMixin or TargetMixin.
For more fine-grain custom control, instantiate a Target object, which allows custom setters, getters, and signals to be specified.
The param is an abstract param reference, e.g. MyModel.my_param.
Example:
def defineMappings(self): combo = self.style_combo return [(self.name_le, MyModel.name), (TargetSpec(combo, getter=combo.currentText, setter=combo.setCurrentText), MyModel.style), (self.coord_widget, MyModel.coord)]
-
createTrajectoryPlot
(plot_type)¶ Starts the creation of a plot to be displayed in the panel. Shows the panel.
Parameters: plot_type – Type of plot for the panel to create and display Type: PlotType
-
showRmsdSettingsDialog
()¶ Shows the RMSD Settings Dialog
-
addWorkspaceMeasurements
()¶ Opens the workspace measurement banner, allowing the user to add measurements
-
AllDockWidgetFeatures
= 7¶
-
DockWidgetClosable
= 1¶
-
class
DockWidgetFeature
¶ Bases:
int
-
__init__
= <method-wrapper '__init__' of sip.enumtype object at 0x338cd08>¶
-
-
class
DockWidgetFeatures
¶ Bases:
sip.simplewrapper
QDockWidget.DockWidgetFeatures(Union[QDockWidget.DockWidgetFeatures, QDockWidget.DockWidgetFeature]) QDockWidget.DockWidgetFeatures(QDockWidget.DockWidgetFeatures)
-
__init__
¶ Initialize self. See help(type(self)) for accurate signature.
-
-
DockWidgetFloatable
= 4¶
-
DockWidgetMovable
= 2¶
-
DockWidgetVerticalTitleBar
= 8¶
-
DrawChildren
= 2¶
-
DrawWindowBackground
= 1¶
-
IgnoreMask
= 4¶
-
NoDockWidgetFeatures
= 0¶
-
class
PaintDeviceMetric
¶ Bases:
int
-
__init__
= <method-wrapper '__init__' of sip.enumtype object at 0x34f04c8>¶
-
-
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
-
__init__
= <method-wrapper '__init__' of sip.enumtype object at 0x42c1a78>¶
-
-
class
RenderFlags
¶ Bases:
sip.simplewrapper
QWidget.RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) QWidget.RenderFlags(QWidget.RenderFlags)
-
__init__
¶ Initialize self. See help(type(self)) for accurate signature.
-
-
SHOW_AS_WINDOW
= True¶
-
__init__
(*args, **kwargs)¶ Initialize self. See help(type(self)) for accurate signature.
-
acceptDrops
(self) → bool¶
-
accepted
¶
-
accessibleDescription
(self) → str¶
-
accessibleName
(self) → str¶
-
actionEvent
()¶
-
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¶
-
auto_update_model
= True¶
-
auto_update_target
= True¶
-
backgroundRole
(self) → QPalette.ColorRole¶
-
baseSize
(self) → QSize¶
-
blockSignals
(self, bool) → bool¶
-
changeEvent
()¶
-
childAt
(self, QPoint) → QWidget¶ childAt(self, int, int) -> QWidget
-
childEvent
()¶
-
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
()¶
-
contentsMargins
(self) → QMargins¶
-
contentsRect
(self) → QRect¶
-
contextMenuEvent
()¶
-
contextMenuPolicy
(self) → Qt.ContextMenuPolicy¶
-
create
()¶
-
createWindowContainer
(QWindow, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = 0) → QWidget¶
-
cursor
(self) → QCursor¶
-
customContextMenuRequested
¶ customContextMenuRequested(self, QPoint) [signal]
-
customEvent
()¶
-
debug
()¶
-
deleteLater
(self)¶
-
depth
(self) → int¶
-
destroy
()¶
-
destroyed
¶ destroyed(self, object: QObject = None) [signal]
-
devType
(self) → int¶
-
devicePixelRatio
(self) → int¶
-
devicePixelRatioF
(self) → float¶
-
devicePixelRatioFScale
() → float¶
-
discardChanges
()¶ Revert the model to the value it was the last time
saveCleanState
was called.
-
disconnect
(self)¶
-
disconnectNotify
()¶
-
dockLocationChanged
¶ dockLocationChanged(self, Qt.DockWidgetArea) [signal]
-
dragEnterEvent
()¶
-
dragLeaveEvent
()¶
-
dragMoveEvent
()¶
-
dropEvent
()¶
-
dumpObjectInfo
(self)¶
-
dumpObjectTree
(self)¶
-
dynamicPropertyNames
(self) → List[QByteArray]¶
-
effectiveWinId
(self) → sip.voidptr¶
-
ensurePolished
(self)¶
-
enterEvent
()¶
-
error
(*args, **kwargs)¶ Shows a popup error message box. For parameter documentation see
messagebox.MessageBox
.
-
event
()¶
-
eventFilter
(self, QObject, QEvent) → bool¶
-
features
(self) → QDockWidget.DockWidgetFeatures¶
-
featuresChanged
¶ featuresChanged(self, Union[QDockWidget.DockWidgetFeatures, QDockWidget.DockWidgetFeature]) [signal]
-
find
(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
()¶
-
focusNextChild
()¶
-
focusNextPrevChild
()¶
-
focusOutEvent
()¶
-
focusPolicy
(self) → Qt.FocusPolicy¶
-
focusPreviousChild
()¶
-
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¶
-
getContentsMargins
(self) → Tuple[int, int, int, int]¶
-
getModel
()¶
-
classmethod
getPanelInstance
()¶ Return the singleton instance of this panel, creating one if necessary.
Returns: instance of this panel. Return type: PanelMixin
-
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])
-
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
()¶
-
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
()¶ @overrides: widgetmixins.InitMixin
-
initPainter
()¶
-
initSetDefaults
()¶ @overrides: widgetmixins.InitMixin
-
initStyleOption
()¶
-
inputMethodEvent
()¶
-
inputMethodHints
(self) → Qt.InputMethodHints¶
-
inputMethodQuery
(self, Qt.InputMethodQuery) → Any¶
-
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
()¶
-
isVisible
(self) → bool¶
-
isVisibleTo
(self, QWidget) → bool¶
-
isWidgetType
(self) → bool¶
-
isWindow
(self) → bool¶
-
isWindowModified
(self) → bool¶
-
isWindowType
(self) → bool¶
-
keyPressEvent
()¶
-
keyReleaseEvent
()¶
-
keyboardGrabber
() → QWidget¶
-
killTimer
(self, int)¶
-
layout
(self) → QLayout¶
-
layoutDirection
(self) → Qt.LayoutDirection¶
-
leaveEvent
()¶
-
locale
(self) → QLocale¶
-
logicalDpiX
(self) → int¶
-
logicalDpiY
(self) → int¶
-
lower
(self)¶
-
makeInitialModel
()¶
-
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¶
-
mappedParams
()¶ Return a list of the abstract params that are mapped to.
-
mask
(self) → QRegion¶
-
maximumHeight
(self) → int¶
-
maximumSize
(self) → QSize¶
-
maximumWidth
(self) → int¶
-
metaObject
(self) → QMetaObject¶
-
metric
()¶
-
minimumHeight
(self) → int¶
-
minimumSize
(self) → QSize¶
-
minimumSizeHint
(self) → QSize¶
-
minimumWidth
(self) → int¶
-
model
¶
-
modelChanged
¶
-
mouseDoubleClickEvent
()¶
-
mouseGrabber
() → QWidget¶
-
mouseMoveEvent
()¶
-
mousePressEvent
()¶
-
mouseReleaseEvent
()¶
-
move
(self, QPoint)¶ move(self, int, int)
-
moveEvent
()¶
-
moveToThread
(self, QThread)¶
-
nativeEvent
()¶
-
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
()¶
-
paintingActive
(self) → bool¶
-
palette
(self) → QPalette¶
-
classmethod
panel
(blocking=False, modal=False, finished_callback=None)¶ Open an instance of this class.
For full argument documentation, see
ExecutionMixin.run
.
-
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
()¶
-
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.DrawWindowBackground|QWidget.DrawChildren))¶ render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground|QWidget.DrawChildren))
-
repaint
(self)¶ repaint(self, int, int, int, int) repaint(self, QRect) repaint(self, QRegion)
-
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
andquestion
methods have been defined in the subclass, as in e.g.widget_mixins.MessageBoxMixin
.Parameters: results ( validation.ValidationResults
) – Set of validation results generated byvalidate
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.
-
resetMappedParams
()¶
-
resize
(self, QSize)¶ resize(self, int, int)
-
resizeEvent
()¶
-
restoreGeometry
(self, Union[QByteArray, bytes, bytearray]) → bool¶
-
run
(*args, **kwargs)¶ Mark the current state as clean. This is useful for panels that implement a “Cancel” button. To implement a cancel button, connect the button to a slot that calls
self.discardChanges()
-
runAllSlots
()¶
-
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- 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
-
saveCleanState
()¶ Copy the model as a clean state. Next time
discardChanges
is called, the model will be updated to reflect this current state.
-
saveGeometry
(self) → QByteArray¶
-
scroll
(self, int, int)¶ scroll(self, int, int, QRect)
-
sender
()¶
-
senderSignalIndex
()¶
-
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)¶
-
setBaseSize
(self, int, int)¶ setBaseSize(self, QSize)
-
setContentsMargins
(self, int, int, int, int)¶ setContentsMargins(self, QMargins)
-
setContextMenuPolicy
(self, Qt.ContextMenuPolicy)¶
-
setCursor
(self, Union[QCursor, Qt.CursorShape])¶
-
setDefaults
()¶ @overrides: af2.App
-
setDisabled
(self, bool)¶
-
setEnabled
(self, bool)¶
-
setFeatures
(self, Union[QDockWidget.DockWidgetFeatures, QDockWidget.DockWidgetFeature])¶
-
setFixedHeight
(self, int)¶
-
setFixedSize
(self, QSize)¶ setFixedSize(self, int, int)
-
setFixedWidth
(self, int)¶
-
setFloating
(self, bool)¶
-
setFocus
(self)¶ setFocus(self, Qt.FocusReason)
-
setFocusPolicy
(self, Qt.FocusPolicy)¶
-
setFocusProxy
(self, QWidget)¶
-
setFont
(self, QFont)¶
-
setForegroundRole
(self, QPalette.ColorRole)¶
-
setGeometry
(self, QRect)¶ setGeometry(self, int, int, int, int)
-
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)
-
setMaximumHeight
(self, int)¶
-
setMaximumSize
(self, int, int)¶ setMaximumSize(self, QSize)
-
setMaximumWidth
(self, int)¶
-
setMinimumHeight
(self, int)¶
-
setMinimumSize
(self, int, int)¶ setMinimumSize(self, QSize)
-
setMinimumWidth
(self, int)¶
-
setModel
(model)¶ Sets the model object for the mapper. Disconnects the old model, if one is set, and connects the new model. Pass in None to have no model set.
Parameters: model – the model instance or None
-
setModelWithoutSlots
(model)¶ This is called when this MapperMixin is a sub-widget of a parent MapperMixin. Since the slots will all be called at the end of the parent setModel, they shouldn’t be called during the sub-widget’s setModel.
-
setMouseTracking
(self, bool)¶
-
setObjectName
(self, str)¶
-
setPalette
(self, QPalette)¶
-
setParent
(self, QWidget)¶ setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])
-
setProperty
(self, str, Any) → bool¶
-
setShortcutAutoRepeat
(self, int, enabled: bool = True)¶
-
setShortcutEnabled
(self, int, enabled: bool = True)¶
-
setSizeIncrement
(self, int, int)¶ setSizeIncrement(self, QSize)
-
setSizePolicy
(self, QSizePolicy)¶ setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)
-
setStatusTip
(self, str)¶
-
setStyle
(self, QStyle)¶
-
setStyleSheet
(self, str)¶
-
setTabOrder
(QWidget, QWidget)¶
-
setTabletTracking
(self, bool)¶
-
setTitleBarWidget
(self, QWidget)¶
-
setToolTip
(self, str)¶
-
setToolTipDuration
(self, int)¶
-
setUpdatesEnabled
(self, bool)¶
-
setVisible
(set_visible)¶
-
setWhatsThis
(self, str)¶
-
setWidget
(self, QWidget)¶
-
setWidgetLayout
()¶ Set the widget layout. A QDockWidget’s layout does not allow nested layouts so we create a container widget to hold the widget layout.
-
setWindowFilePath
(self, str)¶
-
setWindowFlag
(self, Qt.WindowType, on: bool = True)¶
-
setWindowFlags
(flags=None)¶
-
setWindowFlagsForRun
()¶ Don’t set any window flags for run
-
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)¶
-
setting_model
()¶
-
setupDockWidget
¶
-
show
()¶ Override the show method to clear and previous value of self.accepted
-
showEvent
()¶
-
showFullScreen
(self)¶
-
showMaximized
(self)¶
-
showMinimized
(self)¶
-
showNormal
(self)¶
-
signalsBlocked
(self) → bool¶
-
size
(self) → QSize¶
-
sizeHint
(self) → QSize¶
-
sizeIncrement
(self) → QSize¶
-
sizePolicy
(self) → QSizePolicy¶
-
sshowMessageBox
(*args, **kwargs)¶ Shows a popup message box. For parameter documentation see
messagebox.MessageBox
.
-
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
()¶
-
testAttribute
(self, Qt.WidgetAttribute) → bool¶
-
thread
(self) → QThread¶
-
timerEvent
()¶
-
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) update(self, QRegion) update(self, int, int, int, int)
-
updateGeometry
(self)¶
-
updateMicroFocus
()¶
-
updatesEnabled
(self) → bool¶
-
visibilityChanged
¶ visibilityChanged(self, bool) [signal]
-
visibleRegion
(self) → QRegion¶
-
warning
(*args, **kwargs)¶ Shows a popup warning message box. For parameter documentation see
messagebox.MessageBox
.
-
whatsThis
(self) → str¶
-
wheelEvent
()¶
-
widget
(self) → QWidget¶
-
width
(self) → int¶
-
widthMM
(self) → int¶
-
winId
(self) → 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¶
-