schrodinger.ui.qt.table module

Contains classes that can be used to display a QTable that can show both structures and text data in arbitrary cells.

Copyright Schrodinger, LLC. All rights reserved.

class schrodinger.ui.qt.table.EmittingScrollBar

Bases: PyQt6.QtWidgets.QScrollBar

Works the same as a normal scrollbar, but emits signals when it is shown or hidden.

shown
hidden
showEvent(event)

Emit a signal to indicate that the scrollbar has been shown

Parameters

event (QShowEvent object) – the event generated when shown

hideEvent(event)

Emit a signal to indicate that the scrollbar has been hidden

Parameters

event (QHideEvent object) – the event generated when hidden

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
class SliderAction(value)

Bases: enum.Enum

An enumeration.

SliderNoAction = 0
SliderSingleStepAdd = 1
SliderSingleStepSub = 2
SliderPageStepAdd = 3
SliderPageStepSub = 4
SliderToMinimum = 5
SliderToMaximum = 6
SliderMove = 7
class SliderChange(value)

Bases: enum.Enum

An enumeration.

SliderRangeChange = 0
SliderOrientationChange = 1
SliderStepsChange = 2
SliderValueChange = 3
SliderMove = 7
SliderNoAction = 0
SliderOrientationChange = 1
SliderPageStepAdd = 3
SliderPageStepSub = 4
SliderRangeChange = 0
SliderSingleStepAdd = 1
SliderSingleStepSub = 2
SliderStepsChange = 2
SliderToMaximum = 6
SliderToMinimum = 5
SliderValueChange = 3
__init__(*args, **kwargs)
acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, a0: QActionEvent)
actionTriggered

actionTriggered(self, action: int) [signal]

actions(self) List[QAction]
activateWindow(self)
addAction(self, action: QAction)
addActions(self, actions: Iterable[QAction])
adjustSize(self)
autoFillBackground(self) bool
backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, b: bool) bool
changeEvent(self, e: QEvent)
childAt(self, p: QPoint) QWidget
childAt(self, ax: int, ay: int) QWidget
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
close(self) bool
closeEvent(self, a0: QCloseEvent)
colorCount(self) int
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, a0: QContextMenuEvent)
contextMenuPolicy(self) Qt.ContextMenuPolicy
create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(window: QWindow, parent: typing.Optional[QWidget] = None, flags: Qt.WindowType = Qt.WindowFlags()) QWidget
cursor(self) QCursor
customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)
deleteLater(self)
depth(self) int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

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

devType(self) int
devicePixelRatio(self) float
devicePixelRatioF(self) float
devicePixelRatioFScale() float
disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
dragEnterEvent(self, a0: QDragEnterEvent)
dragLeaveEvent(self, a0: QDragLeaveEvent)
dragMoveEvent(self, a0: QDragMoveEvent)
dropEvent(self, a0: QDropEvent)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
effectiveWinId(self) PyQt6.sip.voidptr
ensurePolished(self)
enterEvent(self, event: QEnterEvent)
event(self, event: QEvent) bool
eventFilter(self, a0: QObject, a1: QEvent) bool
find(a0: PyQt6.sip.voidptr) QWidget
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
focusInEvent(self, a0: QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, a0: QFocusEvent)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget
focusWidget(self) QWidget
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameSize(self) QSize
geometry(self) QRect
grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) QPixmap
grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, a0: Union[QCursor, Qt.CursorShape]) None
grabShortcut(self, key: Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect
graphicsProxyWidget(self) QGraphicsProxyWidget
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
hasTracking(self) bool
height(self) int
heightForWidth(self, a0: int) int
heightMM(self) int
hide(self)
inherits(self, classname: str) bool
initPainter(self, painter: QPainter)
initStyleOption(self, option: QStyleOptionSlider)
inputMethodEvent(self, a0: QInputMethodEvent)
inputMethodHints(self) Qt.InputMethodHint
inputMethodQuery(self, a0: Qt.InputMethodQuery) Any
insertAction(self, before: QAction, action: QAction)
insertActions(self, before: QAction, actions: Iterable[QAction])
installEventFilter(self, a0: QObject)
invertedAppearance(self) bool
invertedControls(self) bool
isActiveWindow(self) bool
isAncestorOf(self, child: QWidget) bool
isEnabled(self) bool
isEnabledTo(self, a0: QWidget) bool
isFullScreen(self) bool
isHidden(self) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isRightToLeft(self) bool
isSignalConnected(self, signal: QMetaMethod) bool
isSliderDown(self) bool
isVisible(self) bool
isVisibleTo(self, a0: QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
keyPressEvent(self, ev: QKeyEvent)
keyReleaseEvent(self, a0: QKeyEvent)
keyboardGrabber() QWidget
killTimer(self, id: int)
layout(self) QLayout
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, a0: QEvent)
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self)
mapFrom(self, a0: QWidget, a1: QPoint) QPoint
mapFrom(self, a0: QWidget, a1: QPointF) QPointF
mapFromGlobal(self, a0: QPoint) QPoint
mapFromGlobal(self, a0: QPointF) QPointF
mapFromParent(self, a0: QPoint) QPoint
mapFromParent(self, a0: QPointF) QPointF
mapTo(self, a0: QWidget, a1: QPoint) QPoint
mapTo(self, a0: QWidget, a1: QPointF) QPointF
mapToGlobal(self, a0: QPoint) QPoint
mapToGlobal(self, a0: QPointF) QPointF
mapToParent(self, a0: QPoint) QPoint
mapToParent(self, a0: QPointF) QPointF
mask(self) QRegion
maximum(self) int
maximumHeight(self) int
maximumSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject
metric(self, a0: QPaintDevice.PaintDeviceMetric) int
minimum(self) int
minimumHeight(self) int
minimumSize(self) QSize
minimumSizeHint(self) QSize
minimumWidth(self) int
mouseDoubleClickEvent(self, a0: QMouseEvent)
mouseGrabber() QWidget
mouseMoveEvent(self, a0: QMouseEvent)
mousePressEvent(self, a0: QMouseEvent)
mouseReleaseEvent(self, a0: QMouseEvent)
move(self, a0: QPoint)
move(self, ax: int, ay: int) None
moveEvent(self, a0: QMoveEvent)
moveToThread(self, thread: QThread)
nativeEvent(self, eventType: QByteArray, message: PyQt6.sip.voidptr) Tuple[bool, PyQt6.sip.voidptr]
nativeParentWidget(self) QWidget
nextInFocusChain(self) QWidget
normalGeometry(self) QRect
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

orientation(self) Qt.Orientation
overrideWindowFlags(self, type: Qt.WindowType)
overrideWindowState(self, state: Qt.WindowState)
pageStep(self) int
paintEngine(self) QPaintEngine
paintEvent(self, a0: QPaintEvent)
paintingActive(self) bool
palette(self) QPalette
parent(self) QObject
parentWidget(self) QWidget
physicalDpiX(self) int
physicalDpiY(self) int
pos(self) QPoint
previousInFocusChain(self) QWidget
property(self, name: str) Any
pyqtConfigure(...)

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

raise_(self)
rangeChanged

rangeChanged(self, min: int, max: int) [signal]

receivers(self, signal: PYQT_SIGNAL) int
rect(self) QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id: int)
removeAction(self, action: QAction)
removeEventFilter(self, a0: QObject)
render(self, target: QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))
render(self, painter: QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) None
repaint(self)
repaint(self, x: int, y: int, w: int, h: int) None
repaint(self, a0: QRect) None
repaint(self, a0: QRegion) None
repeatAction(self) QAbstractSlider.SliderAction
resize(self, a0: QSize)
resize(self, w: int, h: int) None
resizeEvent(self, a0: QResizeEvent)
restoreGeometry(self, geometry: QByteArray) bool
saveGeometry(self) QByteArray
screen(self) QScreen
scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) None
sender(self) QObject
senderSignalIndex(self) int
setAcceptDrops(self, on: bool)
setAccessibleDescription(self, description: str)
setAccessibleName(self, name: str)
setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, enabled: bool)
setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) None
setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) None
setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)
setCursor(self, a0: Union[QCursor, Qt.CursorShape])
setDisabled(self, a0: bool)
setEnabled(self, a0: bool)
setFixedHeight(self, h: int)
setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int)
setFocus(self)
setFocus(self, reason: Qt.FocusReason) None
setFocusPolicy(self, policy: Qt.FocusPolicy)
setFocusProxy(self, a0: QWidget)
setFont(self, a0: QFont)
setForegroundRole(self, a0: QPalette.ColorRole)
setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
setGraphicsEffect(self, effect: QGraphicsEffect)
setHidden(self, hidden: bool)
setInputMethodHints(self, hints: Qt.InputMethodHint)
setInvertedAppearance(self, a0: bool)
setInvertedControls(self, a0: bool)
setLayout(self, a0: QLayout)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLocale(self, locale: QLocale)
setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) None
setMaximum(self, a0: int)
setMaximumHeight(self, maxh: int)
setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) None
setMaximumWidth(self, maxw: int)
setMinimum(self, a0: int)
setMinimumHeight(self, minh: int)
setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) None
setMinimumWidth(self, minw: int)
setMouseTracking(self, enable: bool)
setObjectName(self, name: str)
setOrientation(self, a0: Qt.Orientation)
setPageStep(self, a0: int)
setPalette(self, a0: QPalette)
setParent(self, parent: QWidget)
setParent(self, parent: QWidget, f: Qt.WindowType) None
setProperty(self, name: str, value: Any) bool
setRange(self, min: int, max: int)
setRepeatAction(self, action: QAbstractSlider.SliderAction, thresholdTime: int = 500, repeatTime: int = 50)
setScreen(self, a0: QScreen)
setShortcutAutoRepeat(self, id: int, enabled: bool = True)
setShortcutEnabled(self, id: int, enabled: bool = True)
setSingleStep(self, a0: int)
setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) None
setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
setSliderDown(self, a0: bool)
setSliderPosition(self, a0: int)
setStatusTip(self, a0: str)
setStyle(self, a0: QStyle)
setStyleSheet(self, styleSheet: str)
setTabOrder(a0: QWidget, a1: QWidget)
setTabletTracking(self, enable: bool)
setToolTip(self, a0: str)
setToolTipDuration(self, msec: int)
setTracking(self, enable: bool)
setUpdatesEnabled(self, enable: bool)
setValue(self, a0: int)
setVisible(self, visible: bool)
setWhatsThis(self, a0: str)
setWindowFilePath(self, filePath: str)
setWindowFlag(self, a0: Qt.WindowType, on: bool = True)
setWindowFlags(self, type: Qt.WindowType)
setWindowIcon(self, icon: QIcon)
setWindowIconText(self, a0: str)
setWindowModality(self, windowModality: Qt.WindowModality)
setWindowModified(self, a0: bool)
setWindowOpacity(self, level: float)
setWindowRole(self, a0: str)
setWindowState(self, state: Qt.WindowState)
setWindowTitle(self, a0: str)
sharedPainter(self) QPainter
show(self)
showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
signalsBlocked(self) bool
singleStep(self) int
size(self) QSize
sizeHint(self) QSize
sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
sliderChange(self, change: QAbstractSlider.SliderChange)
sliderMoved

sliderMoved(self, position: int) [signal]

sliderPosition(self) int
sliderPressed

sliderPressed(self) [signal]

sliderReleased

sliderReleased(self) [signal]

stackUnder(self, a0: QWidget)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
statusTip(self) str
style(self) QStyle
styleSheet(self) str
tabletEvent(self, a0: QTabletEvent)
testAttribute(self, attribute: Qt.WidgetAttribute) bool
thread(self) QThread
timerEvent(self, a0: QTimerEvent)
toolTip(self) str
toolTipDuration(self) int
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
triggerAction(self, action: QAbstractSlider.SliderAction)
underMouse(self) bool
ungrabGesture(self, type: Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, a0: QRect) None
update(self, a0: QRegion) None
update(self, ax: int, ay: int, aw: int, ah: int) None
updateGeometry(self)
updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)
updatesEnabled(self) bool
value(self) int
valueChanged

valueChanged(self, value: int) [signal]

visibleRegion(self) QRegion
whatsThis(self) str
wheelEvent(self, a0: QWheelEvent)
width(self) int
widthMM(self) int
winId(self) PyQt6.sip.voidptr
window(self) QWidget
windowFilePath(self) str
windowFlags(self) Qt.WindowType
windowHandle(self) QWindow
windowIcon(self) QIcon
windowIconChanged

windowIconChanged(self, icon: QIcon) [signal]

windowIconText(self) str
windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowState
windowTitle(self) str
windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) Qt.WindowType
x(self) int
y(self) int
class schrodinger.ui.qt.table.SHeaderView(orientation, parent)

Bases: PyQt6.QtWidgets.QHeaderView

Class for horizontal and vertical headers of a table. This class is robust to a resizing issue that can occur when the whole table begins to resize when the user resizes a row or column. It uses globalPos() for the mouse move event during resizing rather than pos(), as pos() is relative to the widget corner (which itself is moving when the problem occurs).

__init__(orientation, parent)

Instantiate an SHeaderView object

Parameters
  • orientation (int (QtCore.Qt.Horizontal or QtCore.Qt.Vertical)) – whether this is horizontal or vertical

  • parent (QTableView object) – The table that should be resized by this header

parent(self) QObject
mouseReleaseEvent(event)

Stop any resizing that we are doing

Parameters

event (QMouseEvent) – the event object

mouseMoveEvent(event)

Makes resizing of rows/columns robust to motion of the widget itself by using global mouse coordinates rather than local-to-the-widget coordinates.

Note that, if the mouse is pressed in the header, the header still gets mouse move events until the mouse button is released even if the cursor leaves the header area.

Parameters

event (QMouseEvent) – the event object

AboveItem = 1
AdjustIgnored = 0
AdjustToContents = 2
AdjustToContentsOnFirstShow = 1
AllEditTriggers = 31
AnimatingState = 6
AnyKeyPressed = 16
BelowItem = 2
Box = 1
CollapsingState = 5
ContiguousSelection = 4
CurrentChanged = 1
class CursorAction(value)

Bases: enum.Enum

An enumeration.

MoveUp = 0
MoveDown = 1
MoveLeft = 2
MoveRight = 3
MoveHome = 4
MoveEnd = 5
MovePageUp = 6
MovePageDown = 7
MoveNext = 8
MovePrevious = 9
Custom = 2
DoubleClicked = 2
DragDrop = 3
class DragDropMode(value)

Bases: enum.Enum

An enumeration.

NoDragDrop = 0
DragOnly = 1
DropOnly = 2
DragDrop = 3
InternalMove = 4
DragOnly = 1
DragSelectingState = 2
DraggingState = 1
DrawChildren = 2
DrawWindowBackground = 1
class DropIndicatorPosition(value)

Bases: enum.Enum

An enumeration.

OnItem = 0
AboveItem = 1
BelowItem = 2
OnViewport = 3
DropOnly = 2
EditKeyPressed = 8
class EditTrigger(value)

Bases: enum.Flag

An enumeration.

NoEditTriggers = 0
CurrentChanged = 1
DoubleClicked = 2
SelectedClicked = 4
EditKeyPressed = 8
AnyKeyPressed = 16
AllEditTriggers = 31
EditingState = 3
EnsureVisible = 0
ExpandingState = 4
ExtendedSelection = 3
Fixed = 2
HLine = 4
IgnoreMask = 4
Interactive = 0
InternalMove = 4
MoveDown = 1
MoveEnd = 5
MoveHome = 4
MoveLeft = 2
MoveNext = 8
MovePageDown = 7
MovePageUp = 6
MovePrevious = 9
MoveRight = 3
MoveUp = 0
MultiSelection = 2
NoDragDrop = 0
NoEditTriggers = 0
NoFrame = 0
NoSelection = 0
NoState = 0
OnItem = 0
OnViewport = 3
class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1
PdmHeight = 2
PdmWidthMM = 3
PdmHeightMM = 4
PdmNumColors = 5
PdmDepth = 6
PdmDpiX = 7
PdmDpiY = 8
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
Panel = 2
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
Plain = 16
PositionAtBottom = 2
PositionAtCenter = 3
PositionAtTop = 1
Raised = 32
class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1
DrawChildren = 2
IgnoreMask = 4
class ResizeMode(value)

Bases: enum.Enum

An enumeration.

Interactive = 0
Fixed = 2
Stretch = 1
ResizeToContents = 3
Custom = 2
ResizeToContents = 3
class ScrollHint(value)

Bases: enum.Enum

An enumeration.

EnsureVisible = 0
PositionAtTop = 1
PositionAtBottom = 2
PositionAtCenter = 3
class ScrollMode(value)

Bases: enum.Enum

An enumeration.

ScrollPerItem = 0
ScrollPerPixel = 1
ScrollPerItem = 0
ScrollPerPixel = 1
SelectColumns = 2
SelectItems = 0
SelectRows = 1
SelectedClicked = 4
class SelectionBehavior(value)

Bases: enum.Enum

An enumeration.

SelectItems = 0
SelectRows = 1
SelectColumns = 2
class SelectionMode(value)

Bases: enum.Enum

An enumeration.

NoSelection = 0
SingleSelection = 1
MultiSelection = 2
ExtendedSelection = 3
ContiguousSelection = 4
class Shadow(value)

Bases: enum.IntEnum

An enumeration.

Plain = 16
Raised = 32
Sunken = 48
Shadow_Mask = 240
class Shape(value)

Bases: enum.IntEnum

An enumeration.

NoFrame = 0
Box = 1
Panel = 2
WinPanel = 3
HLine = 4
VLine = 5
StyledPanel = 6
Shape_Mask = 15
SingleSelection = 1
class SizeAdjustPolicy(value)

Bases: enum.Enum

An enumeration.

AdjustIgnored = 0
AdjustToContentsOnFirstShow = 1
AdjustToContents = 2
class State(value)

Bases: enum.Enum

An enumeration.

NoState = 0
DraggingState = 1
DragSelectingState = 2
EditingState = 3
ExpandingState = 4
CollapsingState = 5
AnimatingState = 6
Stretch = 1
class StyleMask(value)

Bases: enum.Enum

An enumeration.

Shadow_Mask = 240
Shape_Mask = 15
StyledPanel = 6
Sunken = 48
VLine = 5
WinPanel = 3
__len__()

Return len(self).

acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, a0: QActionEvent)
actions(self) List[QAction]
activateWindow(self)
activated

activated(self, index: QModelIndex) [signal]

addAction(self, action: QAction)
addActions(self, actions: Iterable[QAction])
addScrollBarWidget(self, widget: QWidget, alignment: Qt.AlignmentFlag)
adjustSize(self)
alternatingRowColors(self) bool
autoFillBackground(self) bool
autoScrollMargin(self) int
backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, b: bool) bool
cascadingSectionResizes(self) bool
changeEvent(self, a0: QEvent)
childAt(self, p: QPoint) QWidget
childAt(self, ax: int, ay: int) QWidget
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
clearSelection(self)
clicked

clicked(self, index: QModelIndex) [signal]

close(self) bool
closeEditor(self, editor: QWidget, hint: QAbstractItemDelegate.EndEditHint)
closeEvent(self, a0: QCloseEvent)
closePersistentEditor(self, index: QModelIndex)
colorCount(self) int
commitData(self, editor: QWidget)
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, a0: QContextMenuEvent)
contextMenuPolicy(self) Qt.ContextMenuPolicy
cornerWidget(self) QWidget
count(self) int
create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(window: QWindow, parent: typing.Optional[QWidget] = None, flags: Qt.WindowType = Qt.WindowFlags()) QWidget
currentChanged(self, current: QModelIndex, old: QModelIndex)
currentIndex(self) QModelIndex
cursor(self) QCursor
customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)
dataChanged(self, topLeft: QModelIndex, bottomRight: QModelIndex, roles: Iterable[int] = [])
defaultAlignment(self) Qt.AlignmentFlag
defaultDropAction(self) Qt.DropAction
defaultSectionSize(self) int
deleteLater(self)
depth(self) int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

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

devType(self) int
devicePixelRatio(self) float
devicePixelRatioF(self) float
devicePixelRatioFScale() float
dirtyRegionOffset(self) QPoint
disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
doubleClicked

doubleClicked(self, index: QModelIndex) [signal]

dragDropMode(self) QAbstractItemView.DragDropMode
dragDropOverwriteMode(self) bool
dragEnabled(self) bool
dragEnterEvent(self, e: QDragEnterEvent)
dragLeaveEvent(self, e: QDragLeaveEvent)
dragMoveEvent(self, e: QDragMoveEvent)
drawFrame(self, a0: QPainter)
dropEvent(self, e: QDropEvent)
dropIndicatorPosition(self) QAbstractItemView.DropIndicatorPosition
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
edit(self, index: QModelIndex)
edit(self, index: QModelIndex, trigger: QAbstractItemView.EditTrigger, event: QEvent) bool
editTriggers(self) QAbstractItemView.EditTrigger
editorDestroyed(self, editor: QObject)
effectiveWinId(self) PyQt6.sip.voidptr
ensurePolished(self)
enterEvent(self, event: QEnterEvent)
entered

entered(self, index: QModelIndex) [signal]

event(self, e: QEvent) bool
eventFilter(self, object: QObject, event: QEvent) bool
executeDelayedItemsLayout(self)
find(a0: PyQt6.sip.voidptr) QWidget
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
focusInEvent(self, e: QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, e: QFocusEvent)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget
focusWidget(self) QWidget
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameRect(self) QRect
frameShadow(self) QFrame.Shadow
frameShape(self) QFrame.Shape
frameSize(self) QSize
frameStyle(self) int
frameWidth(self) int
geometriesChanged

geometriesChanged(self) [signal]

geometry(self) QRect
grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) QPixmap
grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, a0: Union[QCursor, Qt.CursorShape]) None
grabShortcut(self, key: Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect
graphicsProxyWidget(self) QGraphicsProxyWidget
hasAutoScroll(self) bool
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
headerDataChanged(self, orientation: Qt.Orientation, logicalFirst: int, logicalLast: int)
height(self) int
heightForWidth(self, a0: int) int
heightMM(self) int
hiddenSectionCount(self) int
hide(self)
hideEvent(self, a0: QHideEvent)
hideSection(self, alogicalIndex: int)
highlightSections(self) bool
horizontalOffset(self) int
horizontalScrollBar(self) QScrollBar
horizontalScrollBarPolicy(self) Qt.ScrollBarPolicy
horizontalScrollMode(self) QAbstractItemView.ScrollMode
horizontalScrollbarAction(self, action: int)
horizontalScrollbarValueChanged(self, value: int)
iconSize(self) QSize
iconSizeChanged

iconSizeChanged(self, size: QSize) [signal]

indexAt(self, p: QPoint) QModelIndex
indexWidget(self, index: QModelIndex) QWidget
inherits(self, classname: str) bool
initPainter(self, painter: QPainter)
initStyleOption(self, option: QStyleOptionHeader)
initStyleOptionForIndex(self, option: QStyleOptionHeader, logicalIndex: int)
initViewItemOption(self, option: QStyleOptionViewItem)
initialize(self)
initializeSections(self)
initializeSections(self, start: int, end: int) None
inputMethodEvent(self, event: QInputMethodEvent)
inputMethodHints(self) Qt.InputMethodHint
inputMethodQuery(self, query: Qt.InputMethodQuery) Any
insertAction(self, before: QAction, action: QAction)
insertActions(self, before: QAction, actions: Iterable[QAction])
installEventFilter(self, a0: QObject)
isActiveWindow(self) bool
isAncestorOf(self, child: QWidget) bool
isEnabled(self) bool
isEnabledTo(self, a0: QWidget) bool
isFirstSectionMovable(self) bool
isFullScreen(self) bool
isHidden(self) bool
isIndexHidden(self, index: QModelIndex) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isPersistentEditorOpen(self, index: QModelIndex) bool
isRightToLeft(self) bool
isSectionHidden(self, logicalIndex: int) bool
isSignalConnected(self, signal: QMetaMethod) bool
isSortIndicatorClearable(self) bool
isSortIndicatorShown(self) bool
isVisible(self) bool
isVisibleTo(self, a0: QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
itemDelegate(self) QAbstractItemDelegate
itemDelegateForColumn(self, column: int) QAbstractItemDelegate
itemDelegateForIndex(self, index: QModelIndex) QAbstractItemDelegate
itemDelegateForRow(self, row: int) QAbstractItemDelegate
keyPressEvent(self, e: QKeyEvent)
keyReleaseEvent(self, a0: QKeyEvent)
keyboardGrabber() QWidget
keyboardSearch(self, search: str)
killTimer(self, id: int)
layout(self) QLayout
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, a0: QEvent)
length(self) int
lineWidth(self) int
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
logicalIndex(self, visualIndex: int) int
logicalIndexAt(self, position: int) int
logicalIndexAt(self, ax: int, ay: int) int
logicalIndexAt(self, apos: QPoint) int
lower(self)
mapFrom(self, a0: QWidget, a1: QPoint) QPoint
mapFrom(self, a0: QWidget, a1: QPointF) QPointF
mapFromGlobal(self, a0: QPoint) QPoint
mapFromGlobal(self, a0: QPointF) QPointF
mapFromParent(self, a0: QPoint) QPoint
mapFromParent(self, a0: QPointF) QPointF
mapTo(self, a0: QWidget, a1: QPoint) QPoint
mapTo(self, a0: QWidget, a1: QPointF) QPointF
mapToGlobal(self, a0: QPoint) QPoint
mapToGlobal(self, a0: QPointF) QPointF
mapToParent(self, a0: QPoint) QPoint
mapToParent(self, a0: QPointF) QPointF
mask(self) QRegion
maximumHeight(self) int
maximumSectionSize(self) int
maximumSize(self) QSize
maximumViewportSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject
metric(self, a0: QPaintDevice.PaintDeviceMetric) int
midLineWidth(self) int
minimumHeight(self) int
minimumSectionSize(self) int
minimumSize(self) QSize
minimumSizeHint(self) QSize
minimumWidth(self) int
model(self) QAbstractItemModel
mouseDoubleClickEvent(self, e: QMouseEvent)
mouseGrabber() QWidget
mousePressEvent(self, e: QMouseEvent)
move(self, a0: QPoint)
move(self, ax: int, ay: int) None
moveCursor(self, a0: QAbstractItemView.CursorAction, a1: Qt.KeyboardModifier) QModelIndex
moveEvent(self, a0: QMoveEvent)
moveSection(self, from_: int, to: int)
moveToThread(self, thread: QThread)
nativeEvent(self, eventType: QByteArray, message: PyQt6.sip.voidptr) Tuple[bool, PyQt6.sip.voidptr]
nativeParentWidget(self) QWidget
nextInFocusChain(self) QWidget
normalGeometry(self) QRect
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

offset(self) int
openPersistentEditor(self, index: QModelIndex)
orientation(self) Qt.Orientation
overrideWindowFlags(self, type: Qt.WindowType)
overrideWindowState(self, state: Qt.WindowState)
paintEngine(self) QPaintEngine
paintEvent(self, e: QPaintEvent)
paintSection(self, painter: QPainter, rect: QRect, logicalIndex: int)
paintingActive(self) bool
palette(self) QPalette
parentWidget(self) QWidget
physicalDpiX(self) int
physicalDpiY(self) int
pos(self) QPoint
pressed

pressed(self, index: QModelIndex) [signal]

previousInFocusChain(self) QWidget
property(self, name: str) Any
pyqtConfigure(...)

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

raise_(self)
receivers(self, signal: PYQT_SIGNAL) int
rect(self) QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id: int)
removeAction(self, action: QAction)
removeEventFilter(self, a0: QObject)
render(self, target: QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))
render(self, painter: QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) None
repaint(self)
repaint(self, x: int, y: int, w: int, h: int) None
repaint(self, a0: QRect) None
repaint(self, a0: QRegion) None
reset(self)
resetDefaultSectionSize(self)
resetHorizontalScrollMode(self)
resetVerticalScrollMode(self)
resize(self, a0: QSize)
resize(self, w: int, h: int) None
resizeContentsPrecision(self) int
resizeEvent(self, e: QResizeEvent)
resizeSection(self, logicalIndex: int, size: int)
resizeSections(self)
resizeSections(self, mode: QHeaderView.ResizeMode) None
restoreGeometry(self, geometry: QByteArray) bool
restoreState(self, state: QByteArray) bool
rootIndex(self) QModelIndex
rowsAboutToBeRemoved(self, parent: QModelIndex, start: int, end: int)
rowsInserted(self, parent: QModelIndex, start: int, end: int)
saveGeometry(self) QByteArray
saveState(self) QByteArray
scheduleDelayedItemsLayout(self)
screen(self) QScreen
scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) None
scrollBarWidgets(self, alignment: Qt.AlignmentFlag) List[QWidget]
scrollContentsBy(self, dx: int, dy: int)
scrollDirtyRegion(self, dx: int, dy: int)
scrollTo(self, index: QModelIndex, hint: QAbstractItemView.ScrollHint)
scrollToBottom(self)
scrollToTop(self)
sectionClicked

sectionClicked(self, logicalIndex: int) [signal]

sectionCountChanged

sectionCountChanged(self, oldCount: int, newCount: int) [signal]

sectionDoubleClicked

sectionDoubleClicked(self, logicalIndex: int) [signal]

sectionEntered

sectionEntered(self, logicalIndex: int) [signal]

sectionHandleDoubleClicked

sectionHandleDoubleClicked(self, logicalIndex: int) [signal]

sectionMoved

sectionMoved(self, logicalIndex: int, oldVisualIndex: int, newVisualIndex: int) [signal]

sectionPosition(self, logicalIndex: int) int
sectionPressed

sectionPressed(self, logicalIndex: int) [signal]

sectionResizeMode(self, logicalIndex: int) QHeaderView.ResizeMode
sectionResized

sectionResized(self, logicalIndex: int, oldSize: int, newSize: int) [signal]

sectionSize(self, logicalIndex: int) int
sectionSizeFromContents(self, logicalIndex: int) QSize
sectionSizeHint(self, logicalIndex: int) int
sectionViewportPosition(self, logicalIndex: int) int
sectionsAboutToBeRemoved(self, parent: QModelIndex, logicalFirst: int, logicalLast: int)
sectionsClickable(self) bool
sectionsHidden(self) bool
sectionsInserted(self, parent: QModelIndex, logicalFirst: int, logicalLast: int)
sectionsMovable(self) bool
sectionsMoved(self) bool
selectAll(self)
selectedIndexes(self) List[QModelIndex]
selectionBehavior(self) QAbstractItemView.SelectionBehavior
selectionChanged(self, selected: QItemSelection, deselected: QItemSelection)
selectionCommand(self, index: QModelIndex, event: typing.Optional[QEvent] = None) QItemSelectionModel.SelectionFlag
selectionMode(self) QAbstractItemView.SelectionMode
selectionModel(self) QItemSelectionModel
sender(self) QObject
senderSignalIndex(self) int
setAcceptDrops(self, on: bool)
setAccessibleDescription(self, description: str)
setAccessibleName(self, name: str)
setAlternatingRowColors(self, enable: bool)
setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, enabled: bool)
setAutoScroll(self, enable: bool)
setAutoScrollMargin(self, margin: int)
setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) None
setCascadingSectionResizes(self, enable: bool)
setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) None
setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)
setCornerWidget(self, widget: QWidget)
setCurrentIndex(self, index: QModelIndex)
setCursor(self, a0: Union[QCursor, Qt.CursorShape])
setDefaultAlignment(self, alignment: Qt.AlignmentFlag)
setDefaultDropAction(self, dropAction: Qt.DropAction)
setDefaultSectionSize(self, size: int)
setDirtyRegion(self, region: QRegion)
setDisabled(self, a0: bool)
setDragDropMode(self, behavior: QAbstractItemView.DragDropMode)
setDragDropOverwriteMode(self, overwrite: bool)
setDragEnabled(self, enable: bool)
setDropIndicatorShown(self, enable: bool)
setEditTriggers(self, triggers: QAbstractItemView.EditTrigger)
setEnabled(self, a0: bool)
setFirstSectionMovable(self, movable: bool)
setFixedHeight(self, h: int)
setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int)
setFocus(self)
setFocus(self, reason: Qt.FocusReason) None
setFocusPolicy(self, policy: Qt.FocusPolicy)
setFocusProxy(self, a0: QWidget)
setFont(self, a0: QFont)
setForegroundRole(self, a0: QPalette.ColorRole)
setFrameRect(self, a0: QRect)
setFrameShadow(self, a0: QFrame.Shadow)
setFrameShape(self, a0: QFrame.Shape)
setFrameStyle(self, a0: int)
setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
setGraphicsEffect(self, effect: QGraphicsEffect)
setHidden(self, hidden: bool)
setHighlightSections(self, highlight: bool)
setHorizontalScrollBar(self, scrollbar: QScrollBar)
setHorizontalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setHorizontalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setIconSize(self, size: QSize)
setIndexWidget(self, index: QModelIndex, widget: QWidget)
setInputMethodHints(self, hints: Qt.InputMethodHint)
setItemDelegate(self, delegate: QAbstractItemDelegate)
setItemDelegateForColumn(self, column: int, delegate: QAbstractItemDelegate)
setItemDelegateForRow(self, row: int, delegate: QAbstractItemDelegate)
setLayout(self, a0: QLayout)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLineWidth(self, a0: int)
setLocale(self, locale: QLocale)
setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) None
setMaximumHeight(self, maxh: int)
setMaximumSectionSize(self, size: int)
setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) None
setMaximumWidth(self, maxw: int)
setMidLineWidth(self, a0: int)
setMinimumHeight(self, minh: int)
setMinimumSectionSize(self, size: int)
setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) None
setMinimumWidth(self, minw: int)
setModel(self, model: QAbstractItemModel)
setMouseTracking(self, enable: bool)
setObjectName(self, name: str)
setOffset(self, offset: int)
setOffsetToLastSection(self)
setOffsetToSectionPosition(self, visualIndex: int)
setPalette(self, a0: QPalette)
setParent(self, parent: QWidget)
setParent(self, parent: QWidget, f: Qt.WindowType) None
setProperty(self, name: str, value: Any) bool
setResizeContentsPrecision(self, precision: int)
setRootIndex(self, index: QModelIndex)
setScreen(self, a0: QScreen)
setSectionHidden(self, logicalIndex: int, hide: bool)
setSectionResizeMode(self, logicalIndex: int, mode: QHeaderView.ResizeMode)
setSectionResizeMode(self, mode: QHeaderView.ResizeMode) None
setSectionsClickable(self, clickable: bool)
setSectionsMovable(self, movable: bool)
setSelection(self, rect: QRect, flags: QItemSelectionModel.SelectionFlag)
setSelectionBehavior(self, behavior: QAbstractItemView.SelectionBehavior)
setSelectionMode(self, mode: QAbstractItemView.SelectionMode)
setSelectionModel(self, selectionModel: QItemSelectionModel)
setShortcutAutoRepeat(self, id: int, enabled: bool = True)
setShortcutEnabled(self, id: int, enabled: bool = True)
setSizeAdjustPolicy(self, policy: QAbstractScrollArea.SizeAdjustPolicy)
setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) None
setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
setSortIndicator(self, logicalIndex: int, order: Qt.SortOrder)
setSortIndicatorClearable(self, clearable: bool)
setSortIndicatorShown(self, show: bool)
setState(self, state: QAbstractItemView.State)
setStatusTip(self, a0: str)
setStretchLastSection(self, stretch: bool)
setStyle(self, a0: QStyle)
setStyleSheet(self, styleSheet: str)
setTabKeyNavigation(self, enable: bool)
setTabOrder(a0: QWidget, a1: QWidget)
setTabletTracking(self, enable: bool)
setTextElideMode(self, mode: Qt.TextElideMode)
setToolTip(self, a0: str)
setToolTipDuration(self, msec: int)
setUpdatesEnabled(self, enable: bool)
setVerticalScrollBar(self, scrollbar: QScrollBar)
setVerticalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setVerticalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setViewport(self, widget: QWidget)
setViewportMargins(self, left: int, top: int, right: int, bottom: int)
setViewportMargins(self, margins: QMargins) None
setVisible(self, v: bool)
setWhatsThis(self, a0: str)
setWindowFilePath(self, filePath: str)
setWindowFlag(self, a0: Qt.WindowType, on: bool = True)
setWindowFlags(self, type: Qt.WindowType)
setWindowIcon(self, icon: QIcon)
setWindowIconText(self, a0: str)
setWindowModality(self, windowModality: Qt.WindowModality)
setWindowModified(self, a0: bool)
setWindowOpacity(self, level: float)
setWindowRole(self, a0: str)
setWindowState(self, state: Qt.WindowState)
setWindowTitle(self, a0: str)
setupViewport(self, viewport: QWidget)
sharedPainter(self) QPainter
show(self)
showDropIndicator(self) bool
showEvent(self, a0: QShowEvent)
showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
showSection(self, alogicalIndex: int)
signalsBlocked(self) bool
size(self) QSize
sizeAdjustPolicy(self) QAbstractScrollArea.SizeAdjustPolicy
sizeHint(self) QSize
sizeHintForColumn(self, column: int) int
sizeHintForIndex(self, index: QModelIndex) QSize
sizeHintForRow(self, row: int) int
sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
sortIndicatorChanged

sortIndicatorChanged(self, logicalIndex: int, order: Qt.SortOrder) [signal]

sortIndicatorClearableChanged

sortIndicatorClearableChanged(self, clearable: bool) [signal]

sortIndicatorOrder(self) Qt.SortOrder
sortIndicatorSection(self) int
stackUnder(self, a0: QWidget)
startDrag(self, supportedActions: Qt.DropAction)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
state(self) QAbstractItemView.State
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
statusTip(self) str
stretchLastSection(self) bool
stretchSectionCount(self) int
style(self) QStyle
styleSheet(self) str
swapSections(self, first: int, second: int)
tabKeyNavigation(self) bool
tabletEvent(self, a0: QTabletEvent)
testAttribute(self, attribute: Qt.WidgetAttribute) bool
textElideMode(self) Qt.TextElideMode
thread(self) QThread
timerEvent(self, e: QTimerEvent)
toolTip(self) str
toolTipDuration(self) int
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
underMouse(self) bool
ungrabGesture(self, type: Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, index: QModelIndex) None
updateEditorData(self)
updateEditorGeometries(self)
updateGeometries(self)
updateGeometry(self)
updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)
updateSection(self, logicalIndex: int)
updatesEnabled(self) bool
verticalOffset(self) int
verticalScrollBar(self) QScrollBar
verticalScrollBarPolicy(self) Qt.ScrollBarPolicy
verticalScrollMode(self) QAbstractItemView.ScrollMode
verticalScrollbarAction(self, action: int)
verticalScrollbarValueChanged(self, value: int)
viewport(self) QWidget
viewportEntered

viewportEntered(self) [signal]

viewportEvent(self, e: QEvent) bool
viewportMargins(self) QMargins
viewportSizeHint(self) QSize
visibleRegion(self) QRegion
visualIndex(self, logicalIndex: int) int
visualIndexAt(self, position: int) int
visualRect(self, index: QModelIndex) QRect
visualRegionForSelection(self, selection: QItemSelection) QRegion
whatsThis(self) str
wheelEvent(self, a0: QWheelEvent)
width(self) int
widthMM(self) int
winId(self) PyQt6.sip.voidptr
window(self) QWidget
windowFilePath(self) str
windowFlags(self) Qt.WindowType
windowHandle(self) QWindow
windowIcon(self) QIcon
windowIconChanged

windowIconChanged(self, icon: QIcon) [signal]

windowIconText(self) str
windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowState
windowTitle(self) str
windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) Qt.WindowType
x(self) int
y(self) int
class schrodinger.ui.qt.table.DataViewerTable(model=None, parent=None, aspect_ratio=True, fill='rows', gang='both', resizable='none', fit_view='none', vscrollbar='default', hscrollbar='default', cell_height=100, cell_width=100, enable_copy=True, universal_row_gang_setting=False, universal_column_gang_setting=False)

Bases: PyQt6.QtWidgets.QTableView

__init__(model=None, parent=None, aspect_ratio=True, fill='rows', gang='both', resizable='none', fit_view='none', vscrollbar='default', hscrollbar='default', cell_height=100, cell_width=100, enable_copy=True, universal_row_gang_setting=False, universal_column_gang_setting=False)
Parameters
  • model (QAbstractTableModel) – The model for this table. The typical class to use with this table is the StructureDataViewerModel class

  • parent (QWidget) – The widget that owns this table widget

  • aspect_ratio (bool) – if True (default) keeps the cell height & width aspect ratio locked at the ratio indicated by cell_height and cell width. Note that True implies gang=”both”. If aspect_ratio is true, fill can be “rows” OR “columns”, but NOT “both”.

  • fill ("rows", "columns", "both" or "none") – The specified table feature will expand or contract to exactly fit within the table’s viewport.

  • “none”: means neither rows or columns will expand

  • “rows”: means rows will expand (default)

  • “columns”: means columns will expand

  • “both”: means both rows and columns will expand

fill cannot be “both” if aspect_ratio is True.

Setting a feature to fill will turn off the corresponding scrollbar.

Parameters

gang ("rows", "columns", "both" or "none") – Controls whether rows and/or columns can be independently resized.

  • “none” - rows and columns can be independently resized

  • “rows” - rows are ganged so that changing the size of one row will change all the rows

  • “columns” - columns are ganged so that changing the size of one column will change all the columns

  • “both” - both rows and columns are ganged (default)

Parameters
  • universal_row_gang_setting (bool) – If true, then the gang setting applies to ALL rows and a subset of rows may not be ganged. If False (the default), either a subset or all rows may be ganged. It is never necessary to set this option, however setting it does allow for a slight improvement in memory usage for very large tables. Note that this setting applies whether the rows are all ganged or all not ganged. Note that this setting in combination with ganging rows will prevent actions such as hiding the row that change the row size.

  • universal_column_gang_setting (bool) – If true, then the gang setting applies to ALL columns and a subset of columns may not be ganged. If False (the default), either a subset or all columns may be ganged. It is never necessary to set this option, however setting it does allow for a slight improvement in memory usage for very large tables. Note that this setting applies whether the columns are all ganged or all not ganged. Note that this setting in combination with ganging columns will prevent actions such as hiding the column that change the column size.

  • resizable ("rows", "columns", "both" or "none") – the table features that can be resized by the user.

  • “none” - neither rows nor columns can be resized by the user

  • “rows” - rows can be resized by the user

  • “columns” - columns can be resized by the user

  • “both” - both rows and columns can be resized by the user (default)

Note - a feature that has fill turned on cannot be resized by the user, and if fill is turned on and aspect_ratio is True, neither rows nor columns can be resized by the user.

Parameters

fit_view ("rows", "columns", "both" or "none") – the table features that determine the size of the table’s viewport (the part visible to the user).

When this is turned on for a feature, the visible part of the table resizes dynamically to exactly fit that feature. For instance, if fit_view=’rows’, the visible part of the table will resize to exactly fit all the rows any time the size of a row changes.

  • “none” - neither rows nor columns determine the viewport size

  • “rows” - rows determine the viewport height

  • “columns” - columns determine the viewport width

  • “both” - both rows and columns determine the viewport size

Note - a feature that has fill turned on cannot have viewport_fit turned on. fill uses the size of the viewport to determine the size of the cells, while fit_view uses the sie of the cells to determine the size of the viewport.

Note 2 - Setting a feature to fit_view will turn off the corresponding scrollbar.

Note 3 - User resizing of rows with both gang and fit_view=’rows’ or ‘both’ tends to be a bit wonky because the amount the row resizes depends on the placement of the mouse relative to the table, and the table moves as it resizes to the rows, so you tend to get very large changes rapidly.

Parameters

vscrollbar ("on", "off" or "default") – Vertical scrollbar setting - “on” - always on - “off” - always off - “default” - (default) on as needed

If either fit_view or fill = “rows” or “both”, the vertical scrollbar is turned off

Parameters

hscrollbar ("on", "off" or "default") – Horizontal scrollbar setting - “on” - always on - “off” - always off - “default” - (default) on as needed

If either fit_view for fill =”columns” or “both”, the horizontal scrollbar is turned off

Parameters
  • cell_width (int) – default width of cells in pixels

  • cell_height (int) – default height of cells in pixels

  • enable_copy (bool) – True if data in the table can be copied to the clipboard. Cells with structures copy the title of the structure to the clipboard, else the string conversion of the structure to the clipboard.

auto_size

Whether the table should automatically resize in response to changes

copyImageToClipboard()

Copy an image of the table to the clipboard

headerClicked(col)
enforceScrollBarPolicies()

Sets the scrollbar policies as required by the sizing policies

setFitViewPolicy(fit_view, resize=True, policy_check=True, enforce_scroll_bars=True)

Sets whether the viewport should be resized to the rows/columns or not

Parameters

fit_view ("rows", "columns", "both" or "none") – the table features that determine the size of the table’s viewport (the part visible to the user).

When this is turned on for a feature, the visible part of the table resizes dynamically to exactly fit that feature. For instance, if fit_view=’rows’, the visible part of the table will resize to exactly fit all the rows any time the size of a row changes.

  • “none” - neither rows nor columns determine the viewport size

  • “rows” - rows determine the viewport height

  • “columns” - columns determine the viewport width

  • “both” - both rows and columns determine the viewport size

Note - a feature that has fill turned on cannot have viewport_fit turned on. fill uses the size of the viewport to determine the size of the cells, while fit_view uses the sie of the cells to determine the size of the viewport.

Note 2 - Setting a feature to fit_view will turn off the corresponding scrollbar.

Note 3 - User resizing of rows with both gang and fit_view=’rows’ or ‘both’ tends to be a bit wonky because the amount the row resizes depends on the placement of the mouse relative to the table, and the table moves as it resizes to the rows, so you tend to get very large changes rapidly.

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

  • enforce_scroll_bars (bool) – Whether to enforce the default scrollbar policy for fit view settings

setFillPolicy(fill, resize=True, policy_check=True, enforce_scroll_bars=True)

Sets whether columns or rows should fill the viewport or not

Parameters
  • fill ("rows", "columns", "both" or "none") – The specified table feature will expand or contract to exactly fit within the table’s viewport. “both” means both rows and columns will expand, and “none” means neither will. fill cannot be “both” if aspect_ratio is True. Setting a feature to fill will turn off the corresponding scrollbar.

  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

  • enforce_scroll_bars (bool) – Whether to enforce the default scrollbar policy for fill settings

setGangPolicy(gang, resize=True, policy_check=True)

Sets whether the rows or columns are ganged or not

Parameters

gang ("rows", "columns", "both" or "none") – Controls whether rows and/or columns can be independently resized.

  • “none”: rows and columns can be independently resized

  • “rows”: rows are ganged so that changing the size of one row will change all the rows

  • “columns”: columns are ganged so that changing the size of one column will change all the columns

  • “both” - both rows and columns are ganged (default)

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies. Not used for this routine, but kept for consistency with other sizing policy routines

isRowGanged(row)

Returns True if row is ganged, False if not

Parameters

row (int) – the row to check for ganging

isColumnGanged(column)

Returns True if column is ganged, False if not

Parameters

column (int) – the column to check for ganging

setRowIsGanged(row, is_ganged)

Sets a flag on row to indicate whether its size is ganged with other rows or not. Note that this has no effect if rows are not already ganged. This function should not be called if universal_row_gang_settings was set to True.

Parameters
  • row (int) – the row number this applies to

  • is_ganged (bool) – True if the row should be ganged, False if not

setColumnIsGanged(column, is_ganged)

Sets a flag on column to indicate whether its size is ganged with other columns or not. Note that this has no effect if columns are not already ganged. This function should not be called if universal_column_gang_setting was set to True.

Parameters
  • column (int) – the column number this applies to

  • is_ganged (bool) – True if the column should be ganged, False if not

setAspectRatioPolicy(fixed, resize=True, policy_check=True)

Sets whether the cell aspect ratio is locked or not

Parameters
  • fixed (bool) – If True, cell aspect ratio is locked. If False, it is not

  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

setResizablePolicy(resizable, resize=True, policy_check=True)

Sets whether the rows/columns can be resized by the user

Parameters

resizable ("rows", "columns", "both" or "none") – the table features that can be resized by the user.

  • “none” - neither rows nor columns can be resized by the user

  • “rows” - rows can be resized by the user

  • “columns” - columns can be resized by the user

  • “both” - both rows and columns can be resized by the user (default)

Note - a feature that has fill turned on cannot be resized by the user, and if fill is turned on and aspect_ratio is True, neither rows nor columns can be resized by the user.

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

setSortingEnabled(sorting)

Sets sorting enabled

Parameters

sorting (bool) – If True, sorting is enabled

checkSizingPolicies()

Raises a ValueError if we have conflicting sizing policies

initiateCellSizes(rows=True, columns=True)

Sets all the cells to their intial default size

Parameters
  • rows (bool) – whether to set the rows to their default height

  • columns (bool) – whether to set the columns to their default width

rowsInserted(index, start, end)

Slot that receives a signal when rows are inserted in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the rows inserted

  • end (int) – The ending index of the rows inserted (inclusive)

rowsMoved(index1, start, end, index2, place)

Slot that receives a signal when rows are moved in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index1 (QModelIndex) – unused

  • start (int) – The starting index of the rows moved

  • end (int) – The ending index of the rows moved (inclusive)

  • index2 (QModelIndex) – unused

  • place (int) – The new starting index of the moved rows

rowsRemoved(index, start, end)

Slot that receives a signal when rows are removed in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the rows removed

  • end (int) – The ending index of the rows removed (inclusive)

columnsInserted(index, start, end)

Slot that receives a signal when columns are inserted in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the columns inserted

  • end (int) – The ending index of the columns inserted (inclusive)

columnsMoved(index1, start, end, index2, place)

Slot that receives a signal when columns are moved in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index1 (QModelIndex) – unused

  • start (int) – The starting index of the columns moved

  • end (int) – The ending index of the columns moved (inclusive)

  • index2 (QModelIndex) – unused

  • place (int) – The new starting index of the moved columns

columnsRemoved(index, start, end)

Slot that receives a signal when columns are removed in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the columns removed

  • end (int) – The ending index of the columns removed (inclusive)

columnCountChanged(old_count, new_count)

Called when a column is added or deleted, and sets the columns to their initial size.

Parameters
  • old_count (int) – the old number of columns

  • new_count (int) – the num number of columns

rowCountChanged(old_count, new_count)

Called when a row is added or deleted, and sets the rows to their initial size.

Parameters
  • old_count (int) – the old number of rows

  • new_count (int) – the num number of rows

keyPressEvent(event)
Parameters

event (QKeyEvent) – The keypress event

Currently only does anything for Ctrl-C (copy to clipboard)

setItemDelegate(delegate)

Set the delegate for this table

Parameters

delegate (StructureDataViewerDelegate) – delegate that draws the data for this table

setDelegate(delegate)

Set the delegate for this table

Parameters

delegate (StructureDataViewerDelegate) – delegate that draws the data for this table

rowResized(row, old_size, new_size, manual=False)

Resizes any cells that need to be resized when a row size is changed

Parameters
  • row (int) – the row number that changed

  • old_size (int) – the old size of the row

  • new_size (int) – the new size of the row

  • manual (bool) – True if this a manual resize being called by a script. If True, this forces the method to execute even if AutoResizing has been set to false.

columnResized(column, old_size, new_size, manual=False)

Resizes any cells that need to be resized when a column size is changed

Parameters
  • column (int) – the column number that changed

  • old_size (int) – the old size of the column

  • new_size (int) – the new size of the column

  • manual (bool) – True if this a manual resize being called by a script. If True, this forces the method to execute even if AutoResizing has been set to false.

reEnableColumnResize()
fitToRows()

Fits the viewport to exactly show all the rows

fitToColumns()

Fits the viewport to exactly show all the columns

totalRowHeight()

The sum of the heights of all the rows

Return type

int

Returns

the sum of all the row heights

averageGangedRowHeight()

This routine has been changed to return the MOST COMMON non-zero height of all the ganged rows

Return type

int

Returns

the most common integer average row height, or the default height if there are no non-zero ganged rows

totalColumnWidth()

The sum of the widths of all the columns

Return type

int

Returns

the sum of all the column widths

averageGangedColumnWidth()

This routine has been changed to return the MOST COMMON non-zero width of all the ganged columns

Return type

int

Returns

the most common integer average column width, or the default width if there are no non-zero ganged columns

scrollBarChanged(orientation)

A scrollbar has changed appearance, make sure we have the proper size

setAutoSizing(state)

Turn the auto resizing of rows and column on or off. Normally this should be on (default), however, if multiple changes will be made and no resizing needs to be done until all changes are complete, then setting AutoSizing to False will save considerable time for large tables. Be sure to setAutoSizing(True) when finished so the table can adjust to the changes made.

Parameters

state (bool) – True if rows and columns should be resized automatically in response to table changes, False if not

fixSize(manual=False)

Resize everything as the user and program desires

Parameters

manual (bool) – True if this a manual resize being called by a script. If True, this forces the method to execute even if AutoResizing has been set to false.

fitCellsToData(include_column_header=False)

Resizes rows and columns to fit the data they contain using the sizeHint from the delegate

Parameters

include_column_header (bool) – True if the column header should be included when figuring the column width, False if not

fitRowsToData()

Resizes all the rows to fit the data they contain using the sizeHint from the delegate.

fitRowToData(row)

Resizes row to the largest sizeHint of any of its cells. Uses the sizeHint of the delegate.

Parameters

row (int) – the row of interest

fitColumnsToData(include_header=False)

Resizes all the columns to fit the data they contain using the sizeHint from the delegate.

Parameters

include_header (bool) – True if the header should be included in the calculation of column width, False if not

fitColumnToData(column, include_header=False)

Resizes column to the largest sizeHint of any of its cells. Uses the sizeHint of the delegate.

Parameters
  • column (int) – the column of interest

  • include_header (bool) – True if the header should be included in the calculation of column width, False if not

resizeRowsToContents()

Resizes all the rows according to all the resize properties

resizeColumnsToContents()

Resizes all the columns according to all the resize properties

resizeEvent(event)

Called when the viewport changes size. Changes the size of any cells that need to be changed in response to this - typically because fill has been set on rows or columns.

Parameters

event (QEvent) – the event that occured

sizeHintForColumn(column)

This method gives the size hints for columns - its existance means that the resizeColumnsToContents() method uses this hint rather than hints from the delegate.

Parameters

column (int) – the column we want a size hint for

Return type

int

Returns

the size hint for column

sizeHintForRow(row)

This method gives the size hints for rows - its existance means that the resizeRowsToContents() method uses this hint rather than hints from the delegate.

Parameters

row (int) – the row we want a size hint for

Return type

int

Returns

the size hint for row

isScrolling()
isActivelyScrolling()
setToolTipSize(width, height)
Parameters
  • width (int) – width in pixels of tooltip

  • height (int) – height in pixels of tooltip

AboveItem = 1
AdjustIgnored = 0
AdjustToContents = 2
AdjustToContentsOnFirstShow = 1
AllEditTriggers = 31
AnimatingState = 6
AnyKeyPressed = 16
BelowItem = 2
Box = 1
CollapsingState = 5
ContiguousSelection = 4
CurrentChanged = 1
class CursorAction(value)

Bases: enum.Enum

An enumeration.

MoveUp = 0
MoveDown = 1
MoveLeft = 2
MoveRight = 3
MoveHome = 4
MoveEnd = 5
MovePageUp = 6
MovePageDown = 7
MoveNext = 8
MovePrevious = 9
DoubleClicked = 2
DragDrop = 3
class DragDropMode(value)

Bases: enum.Enum

An enumeration.

NoDragDrop = 0
DragOnly = 1
DropOnly = 2
DragDrop = 3
InternalMove = 4
DragOnly = 1
DragSelectingState = 2
DraggingState = 1
DrawChildren = 2
DrawWindowBackground = 1
class DropIndicatorPosition(value)

Bases: enum.Enum

An enumeration.

OnItem = 0
AboveItem = 1
BelowItem = 2
OnViewport = 3
DropOnly = 2
EditKeyPressed = 8
class EditTrigger(value)

Bases: enum.Flag

An enumeration.

NoEditTriggers = 0
CurrentChanged = 1
DoubleClicked = 2
SelectedClicked = 4
EditKeyPressed = 8
AnyKeyPressed = 16
AllEditTriggers = 31
EditingState = 3
EnsureVisible = 0
ExpandingState = 4
ExtendedSelection = 3
HLine = 4
IgnoreMask = 4
InternalMove = 4
MoveDown = 1
MoveEnd = 5
MoveHome = 4
MoveLeft = 2
MoveNext = 8
MovePageDown = 7
MovePageUp = 6
MovePrevious = 9
MoveRight = 3
MoveUp = 0
MultiSelection = 2
NoDragDrop = 0
NoEditTriggers = 0
NoFrame = 0
NoSelection = 0
NoState = 0
OnItem = 0
OnViewport = 3
class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1
PdmHeight = 2
PdmWidthMM = 3
PdmHeightMM = 4
PdmNumColors = 5
PdmDepth = 6
PdmDpiX = 7
PdmDpiY = 8
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
Panel = 2
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
Plain = 16
PositionAtBottom = 2
PositionAtCenter = 3
PositionAtTop = 1
Raised = 32
class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1
DrawChildren = 2
IgnoreMask = 4
class ScrollHint(value)

Bases: enum.Enum

An enumeration.

EnsureVisible = 0
PositionAtTop = 1
PositionAtBottom = 2
PositionAtCenter = 3
class ScrollMode(value)

Bases: enum.Enum

An enumeration.

ScrollPerItem = 0
ScrollPerPixel = 1
ScrollPerItem = 0
ScrollPerPixel = 1
SelectColumns = 2
SelectItems = 0
SelectRows = 1
SelectedClicked = 4
class SelectionBehavior(value)

Bases: enum.Enum

An enumeration.

SelectItems = 0
SelectRows = 1
SelectColumns = 2
class SelectionMode(value)

Bases: enum.Enum

An enumeration.

NoSelection = 0
SingleSelection = 1
MultiSelection = 2
ExtendedSelection = 3
ContiguousSelection = 4
class Shadow(value)

Bases: enum.IntEnum

An enumeration.

Plain = 16
Raised = 32
Sunken = 48
Shadow_Mask = 240
class Shape(value)

Bases: enum.IntEnum

An enumeration.

NoFrame = 0
Box = 1
Panel = 2
WinPanel = 3
HLine = 4
VLine = 5
StyledPanel = 6
Shape_Mask = 15
SingleSelection = 1
class SizeAdjustPolicy(value)

Bases: enum.Enum

An enumeration.

AdjustIgnored = 0
AdjustToContentsOnFirstShow = 1
AdjustToContents = 2
class State(value)

Bases: enum.Enum

An enumeration.

NoState = 0
DraggingState = 1
DragSelectingState = 2
EditingState = 3
ExpandingState = 4
CollapsingState = 5
AnimatingState = 6
class StyleMask(value)

Bases: enum.Enum

An enumeration.

Shadow_Mask = 240
Shape_Mask = 15
StyledPanel = 6
Sunken = 48
VLine = 5
WinPanel = 3
acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, a0: QActionEvent)
actions(self) List[QAction]
activateWindow(self)
activated

activated(self, index: QModelIndex) [signal]

addAction(self, action: QAction)
addActions(self, actions: Iterable[QAction])
addScrollBarWidget(self, widget: QWidget, alignment: Qt.AlignmentFlag)
adjustSize(self)
alternatingRowColors(self) bool
autoFillBackground(self) bool
autoScrollMargin(self) int
backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, b: bool) bool
changeEvent(self, a0: QEvent)
childAt(self, p: QPoint) QWidget
childAt(self, ax: int, ay: int) QWidget
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
clearSelection(self)
clearSpans(self)
clicked

clicked(self, index: QModelIndex) [signal]

close(self) bool
closeEditor(self, editor: QWidget, hint: QAbstractItemDelegate.EndEditHint)
closeEvent(self, a0: QCloseEvent)
closePersistentEditor(self, index: QModelIndex)
colorCount(self) int
columnAt(self, x: int) int
columnMoved(self, column: int, oldIndex: int, newIndex: int)
columnSpan(self, row: int, column: int) int
columnViewportPosition(self, column: int) int
columnWidth(self, column: int) int
commitData(self, editor: QWidget)
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, a0: QContextMenuEvent)
contextMenuPolicy(self) Qt.ContextMenuPolicy
cornerWidget(self) QWidget
create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(window: QWindow, parent: typing.Optional[QWidget] = None, flags: Qt.WindowType = Qt.WindowFlags()) QWidget
currentChanged(self, current: QModelIndex, previous: QModelIndex)
currentIndex(self) QModelIndex
cursor(self) QCursor
customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)
dataChanged(self, topLeft: QModelIndex, bottomRight: QModelIndex, roles: Iterable[int] = [])
defaultDropAction(self) Qt.DropAction
deleteLater(self)
depth(self) int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

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

devType(self) int
devicePixelRatio(self) float
devicePixelRatioF(self) float
devicePixelRatioFScale() float
dirtyRegionOffset(self) QPoint
disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
doubleClicked

doubleClicked(self, index: QModelIndex) [signal]

dragDropMode(self) QAbstractItemView.DragDropMode
dragDropOverwriteMode(self) bool
dragEnabled(self) bool
dragEnterEvent(self, e: QDragEnterEvent)
dragLeaveEvent(self, e: QDragLeaveEvent)
dragMoveEvent(self, e: QDragMoveEvent)
drawFrame(self, a0: QPainter)
dropEvent(self, e: QDropEvent)
dropIndicatorPosition(self) QAbstractItemView.DropIndicatorPosition
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
edit(self, index: QModelIndex)
edit(self, index: QModelIndex, trigger: QAbstractItemView.EditTrigger, event: QEvent) bool
editTriggers(self) QAbstractItemView.EditTrigger
editorDestroyed(self, editor: QObject)
effectiveWinId(self) PyQt6.sip.voidptr
ensurePolished(self)
enterEvent(self, event: QEnterEvent)
entered

entered(self, index: QModelIndex) [signal]

event(self, event: QEvent) bool
eventFilter(self, object: QObject, event: QEvent) bool
executeDelayedItemsLayout(self)
find(a0: PyQt6.sip.voidptr) QWidget
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
focusInEvent(self, e: QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, e: QFocusEvent)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget
focusWidget(self) QWidget
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameRect(self) QRect
frameShadow(self) QFrame.Shadow
frameShape(self) QFrame.Shape
frameSize(self) QSize
frameStyle(self) int
frameWidth(self) int
geometry(self) QRect
grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) QPixmap
grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, a0: Union[QCursor, Qt.CursorShape]) None
grabShortcut(self, key: Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect
graphicsProxyWidget(self) QGraphicsProxyWidget
gridStyle(self) Qt.PenStyle
hasAutoScroll(self) bool
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
height(self) int
heightForWidth(self, a0: int) int
heightMM(self) int
hide(self)
hideColumn(self, column: int)
hideEvent(self, a0: QHideEvent)
hideRow(self, row: int)
horizontalHeader(self) QHeaderView
horizontalOffset(self) int
horizontalScrollBar(self) QScrollBar
horizontalScrollBarPolicy(self) Qt.ScrollBarPolicy
horizontalScrollMode(self) QAbstractItemView.ScrollMode
horizontalScrollbarAction(self, action: int)
horizontalScrollbarValueChanged(self, value: int)
iconSize(self) QSize
iconSizeChanged

iconSizeChanged(self, size: QSize) [signal]

indexAt(self, p: QPoint) QModelIndex
indexWidget(self, index: QModelIndex) QWidget
inherits(self, classname: str) bool
initPainter(self, painter: QPainter)
initStyleOption(self, option: QStyleOptionFrame)
initViewItemOption(self, option: QStyleOptionViewItem)
inputMethodEvent(self, event: QInputMethodEvent)
inputMethodHints(self) Qt.InputMethodHint
inputMethodQuery(self, query: Qt.InputMethodQuery) Any
insertAction(self, before: QAction, action: QAction)
insertActions(self, before: QAction, actions: Iterable[QAction])
installEventFilter(self, a0: QObject)
isActiveWindow(self) bool
isAncestorOf(self, child: QWidget) bool
isColumnHidden(self, column: int) bool
isCornerButtonEnabled(self) bool
isEnabled(self) bool
isEnabledTo(self, a0: QWidget) bool
isFullScreen(self) bool
isHidden(self) bool
isIndexHidden(self, index: QModelIndex) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isPersistentEditorOpen(self, index: QModelIndex) bool
isRightToLeft(self) bool
isRowHidden(self, row: int) bool
isSignalConnected(self, signal: QMetaMethod) bool
isSortingEnabled(self) bool
isVisible(self) bool
isVisibleTo(self, a0: QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
itemDelegate(self) QAbstractItemDelegate
itemDelegateForColumn(self, column: int) QAbstractItemDelegate
itemDelegateForIndex(self, index: QModelIndex) QAbstractItemDelegate
itemDelegateForRow(self, row: int) QAbstractItemDelegate
keyReleaseEvent(self, a0: QKeyEvent)
keyboardGrabber() QWidget
keyboardSearch(self, search: str)
killTimer(self, id: int)
layout(self) QLayout
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, a0: QEvent)
lineWidth(self) int
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self)
mapFrom(self, a0: QWidget, a1: QPoint) QPoint
mapFrom(self, a0: QWidget, a1: QPointF) QPointF
mapFromGlobal(self, a0: QPoint) QPoint
mapFromGlobal(self, a0: QPointF) QPointF
mapFromParent(self, a0: QPoint) QPoint
mapFromParent(self, a0: QPointF) QPointF
mapTo(self, a0: QWidget, a1: QPoint) QPoint
mapTo(self, a0: QWidget, a1: QPointF) QPointF
mapToGlobal(self, a0: QPoint) QPoint
mapToGlobal(self, a0: QPointF) QPointF
mapToParent(self, a0: QPoint) QPoint
mapToParent(self, a0: QPointF) QPointF
mask(self) QRegion
maximumHeight(self) int
maximumSize(self) QSize
maximumViewportSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject
metric(self, a0: QPaintDevice.PaintDeviceMetric) int
midLineWidth(self) int
minimumHeight(self) int
minimumSize(self) QSize
minimumSizeHint(self) QSize
minimumWidth(self) int
model(self) QAbstractItemModel
mouseDoubleClickEvent(self, e: QMouseEvent)
mouseGrabber() QWidget
mouseMoveEvent(self, e: QMouseEvent)
mousePressEvent(self, e: QMouseEvent)
mouseReleaseEvent(self, e: QMouseEvent)
move(self, a0: QPoint)
move(self, ax: int, ay: int) None
moveCursor(self, cursorAction: QAbstractItemView.CursorAction, modifiers: Qt.KeyboardModifier) QModelIndex
moveEvent(self, a0: QMoveEvent)
moveToThread(self, thread: QThread)
nativeEvent(self, eventType: QByteArray, message: PyQt6.sip.voidptr) Tuple[bool, PyQt6.sip.voidptr]
nativeParentWidget(self) QWidget
nextInFocusChain(self) QWidget
normalGeometry(self) QRect
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

openPersistentEditor(self, index: QModelIndex)
overrideWindowFlags(self, type: Qt.WindowType)
overrideWindowState(self, state: Qt.WindowState)
paintEngine(self) QPaintEngine
paintEvent(self, e: QPaintEvent)
paintingActive(self) bool
palette(self) QPalette
parent(self) QObject
parentWidget(self) QWidget
physicalDpiX(self) int
physicalDpiY(self) int
pos(self) QPoint
pressed

pressed(self, index: QModelIndex) [signal]

previousInFocusChain(self) QWidget
property(self, name: str) Any
pyqtConfigure(...)

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

raise_(self)
receivers(self, signal: PYQT_SIGNAL) int
rect(self) QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id: int)
removeAction(self, action: QAction)
removeEventFilter(self, a0: QObject)
render(self, target: QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))
render(self, painter: QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) None
repaint(self)
repaint(self, x: int, y: int, w: int, h: int) None
repaint(self, a0: QRect) None
repaint(self, a0: QRegion) None
reset(self)
resetHorizontalScrollMode(self)
resetVerticalScrollMode(self)
resize(self, a0: QSize)
resize(self, w: int, h: int) None
resizeColumnToContents(self, column: int)
resizeRowToContents(self, row: int)
restoreGeometry(self, geometry: QByteArray) bool
rootIndex(self) QModelIndex
rowAt(self, y: int) int
rowHeight(self, row: int) int
rowMoved(self, row: int, oldIndex: int, newIndex: int)
rowSpan(self, row: int, column: int) int
rowViewportPosition(self, row: int) int
rowsAboutToBeRemoved(self, parent: QModelIndex, start: int, end: int)
saveGeometry(self) QByteArray
scheduleDelayedItemsLayout(self)
screen(self) QScreen
scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) None
scrollBarWidgets(self, alignment: Qt.AlignmentFlag) List[QWidget]
scrollContentsBy(self, dx: int, dy: int)
scrollDirtyRegion(self, dx: int, dy: int)
scrollTo(self, index: QModelIndex, hint: QAbstractItemView.ScrollHint = QAbstractItemView.EnsureVisible)
scrollToBottom(self)
scrollToTop(self)
selectAll(self)
selectColumn(self, column: int)
selectRow(self, row: int)
selectedIndexes(self) List[QModelIndex]
selectionBehavior(self) QAbstractItemView.SelectionBehavior
selectionChanged(self, selected: QItemSelection, deselected: QItemSelection)
selectionCommand(self, index: QModelIndex, event: typing.Optional[QEvent] = None) QItemSelectionModel.SelectionFlag
selectionMode(self) QAbstractItemView.SelectionMode
selectionModel(self) QItemSelectionModel
sender(self) QObject
senderSignalIndex(self) int
setAcceptDrops(self, on: bool)
setAccessibleDescription(self, description: str)
setAccessibleName(self, name: str)
setAlternatingRowColors(self, enable: bool)
setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, enabled: bool)
setAutoScroll(self, enable: bool)
setAutoScrollMargin(self, margin: int)
setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) None
setColumnHidden(self, column: int, hide: bool)
setColumnWidth(self, column: int, width: int)
setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) None
setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)
setCornerButtonEnabled(self, enable: bool)
setCornerWidget(self, widget: QWidget)
setCurrentIndex(self, index: QModelIndex)
setCursor(self, a0: Union[QCursor, Qt.CursorShape])
setDefaultDropAction(self, dropAction: Qt.DropAction)
setDirtyRegion(self, region: QRegion)
setDisabled(self, a0: bool)
setDragDropMode(self, behavior: QAbstractItemView.DragDropMode)
setDragDropOverwriteMode(self, overwrite: bool)
setDragEnabled(self, enable: bool)
setDropIndicatorShown(self, enable: bool)
setEditTriggers(self, triggers: QAbstractItemView.EditTrigger)
setEnabled(self, a0: bool)
setFixedHeight(self, h: int)
setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int)
setFocus(self)
setFocus(self, reason: Qt.FocusReason) None
setFocusPolicy(self, policy: Qt.FocusPolicy)
setFocusProxy(self, a0: QWidget)
setFont(self, a0: QFont)
setForegroundRole(self, a0: QPalette.ColorRole)
setFrameRect(self, a0: QRect)
setFrameShadow(self, a0: QFrame.Shadow)
setFrameShape(self, a0: QFrame.Shape)
setFrameStyle(self, a0: int)
setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
setGraphicsEffect(self, effect: QGraphicsEffect)
setGridStyle(self, style: Qt.PenStyle)
setHidden(self, hidden: bool)
setHorizontalHeader(self, header: QHeaderView)
setHorizontalScrollBar(self, scrollbar: QScrollBar)
setHorizontalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setHorizontalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setIconSize(self, size: QSize)
setIndexWidget(self, index: QModelIndex, widget: QWidget)
setInputMethodHints(self, hints: Qt.InputMethodHint)
setItemDelegateForColumn(self, column: int, delegate: QAbstractItemDelegate)
setItemDelegateForRow(self, row: int, delegate: QAbstractItemDelegate)
setLayout(self, a0: QLayout)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLineWidth(self, a0: int)
setLocale(self, locale: QLocale)
setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) None
setMaximumHeight(self, maxh: int)
setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) None
setMaximumWidth(self, maxw: int)
setMidLineWidth(self, a0: int)
setMinimumHeight(self, minh: int)
setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) None
setMinimumWidth(self, minw: int)
setModel(self, model: QAbstractItemModel)
setMouseTracking(self, enable: bool)
setObjectName(self, name: str)
setPalette(self, a0: QPalette)
setParent(self, parent: QWidget)
setParent(self, parent: QWidget, f: Qt.WindowType) None
setProperty(self, name: str, value: Any) bool
setRootIndex(self, index: QModelIndex)
setRowHeight(self, row: int, height: int)
setRowHidden(self, row: int, hide: bool)
setScreen(self, a0: QScreen)
setSelection(self, rect: QRect, command: QItemSelectionModel.SelectionFlag)
setSelectionBehavior(self, behavior: QAbstractItemView.SelectionBehavior)
setSelectionMode(self, mode: QAbstractItemView.SelectionMode)
setSelectionModel(self, selectionModel: QItemSelectionModel)
setShortcutAutoRepeat(self, id: int, enabled: bool = True)
setShortcutEnabled(self, id: int, enabled: bool = True)
setShowGrid(self, show: bool)
setSizeAdjustPolicy(self, policy: QAbstractScrollArea.SizeAdjustPolicy)
setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) None
setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
setSpan(self, row: int, column: int, rowSpan: int, columnSpan: int)
setState(self, state: QAbstractItemView.State)
setStatusTip(self, a0: str)
setStyle(self, a0: QStyle)
setStyleSheet(self, styleSheet: str)
setTabKeyNavigation(self, enable: bool)
setTabOrder(a0: QWidget, a1: QWidget)
setTabletTracking(self, enable: bool)
setTextElideMode(self, mode: Qt.TextElideMode)
setToolTip(self, a0: str)
setToolTipDuration(self, msec: int)
setUpdatesEnabled(self, enable: bool)
setVerticalHeader(self, header: QHeaderView)
setVerticalScrollBar(self, scrollbar: QScrollBar)
setVerticalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setVerticalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setViewport(self, widget: QWidget)
setViewportMargins(self, left: int, top: int, right: int, bottom: int)
setViewportMargins(self, margins: QMargins) None
setVisible(self, visible: bool)
setWhatsThis(self, a0: str)
setWindowFilePath(self, filePath: str)
setWindowFlag(self, a0: Qt.WindowType, on: bool = True)
setWindowFlags(self, type: Qt.WindowType)
setWindowIcon(self, icon: QIcon)
setWindowIconText(self, a0: str)
setWindowModality(self, windowModality: Qt.WindowModality)
setWindowModified(self, a0: bool)
setWindowOpacity(self, level: float)
setWindowRole(self, a0: str)
setWindowState(self, state: Qt.WindowState)
setWindowTitle(self, a0: str)
setWordWrap(self, on: bool)
setupViewport(self, viewport: QWidget)
sharedPainter(self) QPainter
show(self)
showColumn(self, column: int)
showDropIndicator(self) bool
showEvent(self, a0: QShowEvent)
showFullScreen(self)
showGrid(self) bool
showMaximized(self)
showMinimized(self)
showNormal(self)
showRow(self, row: int)
signalsBlocked(self) bool
size(self) QSize
sizeAdjustPolicy(self) QAbstractScrollArea.SizeAdjustPolicy
sizeHint(self) QSize
sizeHintForIndex(self, index: QModelIndex) QSize
sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
sortByColumn(self, column: int, order: Qt.SortOrder)
stackUnder(self, a0: QWidget)
startDrag(self, supportedActions: Qt.DropAction)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
state(self) QAbstractItemView.State
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
statusTip(self) str
style(self) QStyle
styleSheet(self) str
tabKeyNavigation(self) bool
tabletEvent(self, a0: QTabletEvent)
testAttribute(self, attribute: Qt.WidgetAttribute) bool
textElideMode(self) Qt.TextElideMode
thread(self) QThread
timerEvent(self, event: QTimerEvent)
toolTip(self) str
toolTipDuration(self) int
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
underMouse(self) bool
ungrabGesture(self, type: Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, index: QModelIndex) None
updateEditorData(self)
updateEditorGeometries(self)
updateGeometries(self)
updateGeometry(self)
updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)
updatesEnabled(self) bool
verticalHeader(self) QHeaderView
verticalOffset(self) int
verticalScrollBar(self) QScrollBar
verticalScrollBarPolicy(self) Qt.ScrollBarPolicy
verticalScrollMode(self) QAbstractItemView.ScrollMode
verticalScrollbarAction(self, action: int)
verticalScrollbarValueChanged(self, value: int)
viewport(self) QWidget
viewportEntered

viewportEntered(self) [signal]

viewportEvent(self, e: QEvent) bool
viewportMargins(self) QMargins
viewportSizeHint(self) QSize
visibleRegion(self) QRegion
visualRect(self, index: QModelIndex) QRect
visualRegionForSelection(self, selection: QItemSelection) QRegion
whatsThis(self) str
wheelEvent(self, a0: QWheelEvent)
width(self) int
widthMM(self) int
winId(self) PyQt6.sip.voidptr
window(self) QWidget
windowFilePath(self) str
windowFlags(self) Qt.WindowType
windowHandle(self) QWindow
windowIcon(self) QIcon
windowIconChanged

windowIconChanged(self, icon: QIcon) [signal]

windowIconText(self) str
windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowState
windowTitle(self) str
windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) Qt.WindowType
wordWrap(self) bool
x(self) int
y(self) int
class schrodinger.ui.qt.table.ViewerModel(rowcount=0, columncount=4, unique=False)

Bases: PyQt6.QtCore.QAbstractTableModel

sizeChanged
__init__(rowcount=0, columncount=4, unique=False)
structCount()
appendStruct(struct)
clearStructs()
getStruct(index)
setStruct(index, struct)

Given the index, replace the structure with the new value. If the _unique flag is true and the new value already exists in table, it is not added.

Returns

Return whether the new structure was successfully set at the specified index.

Return type

bool

removeStruct(row, column)
rowCount(self, parent: QModelIndex = QModelIndex()) int
columnCount(self, parent: QModelIndex = QModelIndex()) int
data(self, index: QModelIndex, role: int = Qt.DisplayRole) Any
insertRows(self, row: int, count: int, parent: QModelIndex = QModelIndex()) bool
insertColumns(self, column: int, count: int, parent: QModelIndex = QModelIndex()) bool
removeRows(self, row: int, count: int, parent: QModelIndex = QModelIndex()) bool
removeColumns(self, column: int, count: int, parent: QModelIndex = QModelIndex()) bool
resize(row, column)
resizeRows(row)
resizeColumns(cols)
setTable(view)
reset()

PANEL-8852: Method added to prevent QtUpgradeError. This preserves backwards compatibility with QtCore.QAbstractTableModel.reset() but does not reset anything.

class CheckIndexOption(value)

Bases: enum.Flag

An enumeration.

NoOption = 0
IndexIsValid = 1
DoNotUseParent = 2
ParentIsInvalid = 4
HorizontalSortHint = 2
class LayoutChangeHint(value)

Bases: enum.Enum

An enumeration.

NoLayoutChangeHint = 0
VerticalSortHint = 1
HorizontalSortHint = 2
NoLayoutChangeHint = 0
VerticalSortHint = 1
beginInsertColumns(self, parent: QModelIndex, first: int, last: int)
beginInsertRows(self, parent: QModelIndex, first: int, last: int)
beginMoveColumns(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationColumn: int) bool
beginMoveRows(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationRow: int) bool
beginRemoveColumns(self, parent: QModelIndex, first: int, last: int)
beginRemoveRows(self, parent: QModelIndex, first: int, last: int)
beginResetModel(self)
blockSignals(self, b: bool) bool
buddy(self, index: QModelIndex) QModelIndex
canDropMimeData(self, data: QMimeData, action: Qt.DropAction, row: int, column: int, parent: QModelIndex) bool
canFetchMore(self, parent: QModelIndex) bool
changePersistentIndex(self, from_: QModelIndex, to: QModelIndex)
changePersistentIndexList(self, from_: Iterable[QModelIndex], to: Iterable[QModelIndex])
checkIndex(self, index: QModelIndex, options: QAbstractItemModel.CheckIndexOption = QAbstractItemModel.CheckIndexOption.NoOption) bool
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
clearItemData(self, index: QModelIndex) bool
columnsAboutToBeInserted

columnsAboutToBeInserted(self, parent: QModelIndex, first: int, last: int) [signal]

columnsAboutToBeMoved

columnsAboutToBeMoved(self, sourceParent: QModelIndex, sourceStart: int, sourceEnd: int, destinationParent: QModelIndex, destinationColumn: int) [signal]

columnsAboutToBeRemoved

columnsAboutToBeRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

columnsInserted

columnsInserted(self, parent: QModelIndex, first: int, last: int) [signal]

columnsMoved

columnsMoved(self, parent: QModelIndex, start: int, end: int, destination: QModelIndex, column: int) [signal]

columnsRemoved

columnsRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

connectNotify(self, signal: QMetaMethod)
createIndex(self, row: int, column: int, object: object = 0) QModelIndex
customEvent(self, a0: QEvent)
dataChanged

dataChanged(self, topLeft: QModelIndex, bottomRight: QModelIndex, roles: Iterable[int] = []) [signal]

decodeData(self, row: int, column: int, parent: QModelIndex, stream: QDataStream) bool
deleteLater(self)
destroyed

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

disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
dropMimeData(self, data: QMimeData, action: Qt.DropAction, row: int, column: int, parent: QModelIndex) bool
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
encodeData(self, indexes: Iterable[QModelIndex], stream: QDataStream)
endInsertColumns(self)
endInsertRows(self)
endMoveColumns(self)
endMoveRows(self)
endRemoveColumns(self)
endRemoveRows(self)
endResetModel(self)
event(self, a0: QEvent) bool
eventFilter(self, a0: QObject, a1: QEvent) bool
fetchMore(self, parent: QModelIndex)
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
flags(self, index: QModelIndex) Qt.ItemFlag
hasChildren(self, parent: QModelIndex = QModelIndex()) bool
hasIndex(self, row: int, column: int, parent: QModelIndex = QModelIndex()) bool
headerData(self, section: int, orientation: Qt.Orientation, role: int = Qt.DisplayRole) Any
headerDataChanged

headerDataChanged(self, orientation: Qt.Orientation, first: int, last: int) [signal]

index(self, row: int, column: int, parent: QModelIndex = QModelIndex()) QModelIndex
inherits(self, classname: str) bool
insertColumn(self, column: int, parent: QModelIndex = QModelIndex()) bool
insertRow(self, row: int, parent: QModelIndex = QModelIndex()) bool
installEventFilter(self, a0: QObject)
isSignalConnected(self, signal: QMetaMethod) bool
isWidgetType(self) bool
isWindowType(self) bool
itemData(self, index: QModelIndex) Dict[int, Any]
killTimer(self, id: int)
layoutAboutToBeChanged

layoutAboutToBeChanged(self, parents: Iterable[QPersistentModelIndex] = [], hint: QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]

layoutChanged

layoutChanged(self, parents: Iterable[QPersistentModelIndex] = [], hint: QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]

match(self, start: QModelIndex, role: int, value: Any, hits: int = 1, flags: Qt.MatchFlag = Qt.MatchFlags(Qt.MatchStartsWith | Qt.MatchWrap)) List[QModelIndex]
metaObject(self) QMetaObject
mimeData(self, indexes: Iterable[QModelIndex]) QMimeData
mimeTypes(self) List[str]
modelAboutToBeReset

modelAboutToBeReset(self) [signal]

modelReset

modelReset(self) [signal]

moveColumn(self, sourceParent: QModelIndex, sourceColumn: int, destinationParent: QModelIndex, destinationChild: int) bool
moveColumns(self, sourceParent: QModelIndex, sourceColumn: int, count: int, destinationParent: QModelIndex, destinationChild: int) bool
moveRow(self, sourceParent: QModelIndex, sourceRow: int, destinationParent: QModelIndex, destinationChild: int) bool
moveRows(self, sourceParent: QModelIndex, sourceRow: int, count: int, destinationParent: QModelIndex, destinationChild: int) bool
moveToThread(self, thread: QThread)
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

parent(self) QObject
persistentIndexList(self) List[QModelIndex]
property(self, name: str) Any
pyqtConfigure(...)

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

receivers(self, signal: PYQT_SIGNAL) int
removeColumn(self, column: int, parent: QModelIndex = QModelIndex()) bool
removeEventFilter(self, a0: QObject)
removeRow(self, row: int, parent: QModelIndex = QModelIndex()) bool
resetInternalData(self)
revert(self)
roleNames(self) Dict[int, QByteArray]
rowsAboutToBeInserted

rowsAboutToBeInserted(self, parent: QModelIndex, first: int, last: int) [signal]

rowsAboutToBeMoved

rowsAboutToBeMoved(self, sourceParent: QModelIndex, sourceStart: int, sourceEnd: int, destinationParent: QModelIndex, destinationRow: int) [signal]

rowsAboutToBeRemoved

rowsAboutToBeRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

rowsInserted

rowsInserted(self, parent: QModelIndex, first: int, last: int) [signal]

rowsMoved

rowsMoved(self, parent: QModelIndex, start: int, end: int, destination: QModelIndex, row: int) [signal]

rowsRemoved

rowsRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

sender(self) QObject
senderSignalIndex(self) int
setData(self, index: QModelIndex, value: Any, role: int = Qt.EditRole) bool
setHeaderData(self, section: int, orientation: Qt.Orientation, value: Any, role: int = Qt.EditRole) bool
setItemData(self, index: QModelIndex, roles: Dict[int, Any]) bool
setObjectName(self, name: str)
setParent(self, a0: QObject)
setProperty(self, name: str, value: Any) bool
sibling(self, row: int, column: int, idx: QModelIndex) QModelIndex
signalsBlocked(self) bool
sort(self, column: int, order: Qt.SortOrder = Qt.AscendingOrder)
span(self, index: QModelIndex) QSize
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
submit(self) bool
supportedDragActions(self) Qt.DropAction
supportedDropActions(self) Qt.DropAction
thread(self) QThread
timerEvent(self, a0: QTimerEvent)
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
class schrodinger.ui.qt.table.StructureDataViewerModel(rows=4, columns=8, vlabels=None, hlabels=None)

Bases: schrodinger.ui.qt.table.ViewerModel

A table model that handles 2-D structures and data.

This inherits ViewerModel, but is designed to be less 2-D structure-centric than that model, which assumes all the cells contain structures.

headerDataChanged
__init__(rows=4, columns=8, vlabels=None, hlabels=None)
Parameters
  • rows (int) – number of rows in the table

  • columns (int) – number of columns in the table

  • vlabels (list of strings) – labels for the row headers

  • hlabels (list of strings) – labels for the column headers

setTable(table)
Parameters

table (DataViewerTable) – the table this model contains data for

Deprecated table

This function should not be used, because a model can refer to multiple views.

setDelegate(delegate)

Sets the Delegate that draws the data from this model.

Parameters

delegate (StructureDataViewerDelegate) – delegate that draws the data from this model

Deprecated delegate

This function should not be used, because a model can have many delegates

myDataChanged(row1, column1, row2, column2)

Emits the proper signal to indicate that data in the table has changed.

Rows and columns are 0-indexed

Parameters
  • row1 (non-negative int) – row index of the top, left-most cell that changed

  • row2 (non-negative int) – row index of the bottom, right-most cell that changed

  • column1 (non-negative int) – column index of the top, left-most cell that changed

  • column2 (non-negative int) – column index of the bottom, right-most cell changed

initializeValueMatrix(reset_row_labels=True, reset_column_labels=False)

Resets all the cells to values of None and resets the row labels (by default)

Parameters
  • reset_row_labels (bool) – if True, all row labels are reset to simple numbers, if False, they are not. This is True by default.

  • reset_column_labels (bool) – if True, all column labels are reset to simple numbers, if False, they are not. This is False by default.

setToolTip(row, column, value)

Sets the tooltip for the cell located at row, column

Parameters
  • row (int) – row the cell is in (0-indexed)

  • column (int) – column the cell is in (0-indexed)

  • value (type that can be set in a tooltip) – value for the tooltip in the cell at (row, column)

insertColumn(column, index=None, renumber_headers=False)

Insert a column into the model and table

Parameters
  • column (int) – the column index to insert a new column at

  • index (QModelIndex()) – unused

  • renumber_headers (bool) – True if all the column headers should be renumbered, false if not (leave as default if custom column headers have been used)

insertColumns(place, columns, index=None, renumber_headers=False)

Insert columns into the model and table at index place

Parameters
  • place (int) – the index to insert the columns at

  • columns (int) – the number of columns to insert

  • index (QModelIndex()) – unused

  • renumber_headers (bool) – True if all the column headers should be renumbered, false if not (leave as default if custom column headers have been used)

removeColumn(column, index=None, renumber_headers=False)

Remove a column from the model and table

Parameters
  • column (int) – the column index to remove

  • index (QModelIndex()) – unused

removeColumns(place, columns, index=None, renumber_headers=False)

Remove columns from the model and table starting at index place

Parameters
  • place (int) – the index to begin removing columns at

  • columns (int) – the number of columns to remove

  • index (QModelIndex()) – unused

insertRow(row, index=None, renumber_headers=False)

Insert a row into the model and table

Parameters
  • row (int) – the row index to insert a new row at

  • index (QModelIndex()) – unused

  • renumber_headers (bool) – True if all the row headers should be renumbered, false if not (leave as default if custom row headers have been used)

insertRows(place, rows, index=None, renumber_headers=False)

Insert rows into the model and table at index place

Parameters
  • place (int) – the index to insert the rows at

  • rows (int) – the number of rows to insert

  • index (QModelIndex()) – unused

  • renumber_headers (bool) – True if all the row headers should be renumbered, false if not (leave as default if custom row headers have been used)

removeRow(row, index=None, renumber_headers=False)

Remove a row from the model and table

Parameters
  • row (int) – the row index to remove

  • index (QModelIndex()) – unused

removeRows(place, rows, index=None, renumber_headers=False)

Remove rows from the model and table starting at index place

Parameters
  • place (int) – the index to begin removing rows at

  • rows (int) – the number of rows to remove

  • index (QModelIndex()) – unused

sortKey(myitem)

Returns the key to sort item by

Parameters

myitem (model item) – base class expects an iterable with the sort data of interest as the second item

Returns

The second item in myitem, or NO_ITEM if myitem does not have at least 2 items.

sortKeyUnsorted(myitem)

Returns the key to sort item by. In this case, it returns the cur_id of the data, allowing the sort to acheive the original data order.

Parameters

myitem (model item) – base class expects an iterable with the sort data of interest as the second item

Returns

The first item in myitem, or NO_ITEM if myitem does not have at least 2 items.

setVerticalHeadersSortable(state)

Sets vertical header labels to be sortable

Parameters

state (bool) – True if vertical headers should move with a column sort, or False if they should not (False for simple row numbers, for example)

sort(column, order=SortOrder.AscendingOrder)

This functions exists so that we can transition away from sorting directly in the model.

If you are writing a new table, this function should in called a QSortFilterProxyModel, not in the source model.

sortByColumn(column, order=SortOrder.AscendingOrder)

Sort by data by column

Parameters
  • column (int) – the index of the column to sort by

  • order (Qt.SortOrder) – Qt.AscendingOrder (0), Qt.DescendingOrder (1) or -1 for returning to original data order

sortHeaderKey(myitem)

Returns the key to sort item by, which in this case is the Header

Parameters

myitem (model item) – base class expects an iterable with the sort data of interest as the second item

Returns

The second item in myitem, or NO_ITEM if myitem does not have at least 2 items.

sortHeaderKeyUnsorted(myitem)

Returns the key to sort item by. In this case, it returns the cur_id of the data, allowing the sort to acheive the original data order.

Parameters

myitem (model item) – base class expects an iterable with the sort data of interest as the second item

Returns

The second item in myitem, or NO_ITEM if myitem does not have at least 2 items.

sortByVerticalHeader(order=SortOrder.AscendingOrder)

Sort by data by the Vertical Header values

Parameters

order (Qt.SortOrder) – Qt.AscendingOrder (0) or Qt.DescendingOrder (1)

setCellValue(row, column, value, timer=None)

Sets the data for the cell located at row, column

Parameters
  • row (int) – row the cell is in (0-indexed)

  • column (int) – column the cell is in (0-indexed)

  • value – value to store in the cell at (row, column) value can be either a structure or numerical/string data

Deprecated timer

This variable is no longer necessary. Formerly, we would perform a full scale update with 300ms timer. This caused an unnecessary race condition when updating cells. Now we implement the dataChanged signal for individual modelindexes, which should not have a performance penalty.

setHeaderData(section, orientation, label, role=ItemDataRole.DisplayRole)

Changes the label of the row or column for the table to draw

Parameters
  • section (int) – the index of the row or column header of interest

  • orientation (int) – QtCore.Qt.Horizontal (columns) or QtCore.Qt.Vertical (rows)

  • label (string) – text for the label

  • role (int) – should be 0 for the actual label text, unused - this method only sets the label text

headerData(section, orientation, role=ItemDataRole.DisplayRole)

Returns the label of the row or column for the table to draw

Parameters
  • section (int) – the index of the row or column header of interest

  • orientation (int) – 0 = horizontal (columns), 1 = vertical (rows)

  • role (int) – should be 0 for the actual label text

getCellValue(row, column)

Returns the value of the cell in the cell at row, column

Parameters
  • row (int) – the row of the cell of interest (0-indexed)

  • row – the column of the cell of interest (0-indexed)

Return type

Any

Returns

data or object stored in the model at row, column

setSize(numrows, numcolumns, reset_row_labels=True, reset_column_labels=False)

Sets the size of the table

Parameters
  • numrows (int) – the number of rows the table should have

  • numcolumns (int) – the number of columns the table should have

  • reset_row_labels (bool) – if True, all row labels are reset to simple numbers, if False, they are not

  • reset_column_labels (bool) – if True, all column labels are reset to simple numbers, if False, they are not

data(index, role=ItemDataRole.DisplayRole)

Returns the data (either Display or ToolTip) if requested.

The tooltips for structures are a different class, and handled manually by the StructureToolTip class.

Parameters
  • index (QModelIndex) – index of the cell for which data is requested

  • role (Qt.ItemDataRole) – role of the data requested. Currently only responds to Qt.ToolTipRole

clearTable()

Resets all the data in the table to None

class CheckIndexOption(value)

Bases: enum.Flag

An enumeration.

NoOption = 0
IndexIsValid = 1
DoNotUseParent = 2
ParentIsInvalid = 4
HorizontalSortHint = 2
class LayoutChangeHint(value)

Bases: enum.Enum

An enumeration.

NoLayoutChangeHint = 0
VerticalSortHint = 1
HorizontalSortHint = 2
NoLayoutChangeHint = 0
VerticalSortHint = 1
appendStruct(struct)
beginInsertColumns(self, parent: QModelIndex, first: int, last: int)
beginInsertRows(self, parent: QModelIndex, first: int, last: int)
beginMoveColumns(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationColumn: int) bool
beginMoveRows(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationRow: int) bool
beginRemoveColumns(self, parent: QModelIndex, first: int, last: int)
beginRemoveRows(self, parent: QModelIndex, first: int, last: int)
beginResetModel(self)
blockSignals(self, b: bool) bool
buddy(self, index: QModelIndex) QModelIndex
canDropMimeData(self, data: QMimeData, action: Qt.DropAction, row: int, column: int, parent: QModelIndex) bool
canFetchMore(self, parent: QModelIndex) bool
changePersistentIndex(self, from_: QModelIndex, to: QModelIndex)
changePersistentIndexList(self, from_: Iterable[QModelIndex], to: Iterable[QModelIndex])
checkIndex(self, index: QModelIndex, options: QAbstractItemModel.CheckIndexOption = QAbstractItemModel.CheckIndexOption.NoOption) bool
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
clearItemData(self, index: QModelIndex) bool
clearStructs()
columnCount(self, parent: QModelIndex = QModelIndex()) int
columnsAboutToBeInserted

columnsAboutToBeInserted(self, parent: QModelIndex, first: int, last: int) [signal]

columnsAboutToBeMoved

columnsAboutToBeMoved(self, sourceParent: QModelIndex, sourceStart: int, sourceEnd: int, destinationParent: QModelIndex, destinationColumn: int) [signal]

columnsAboutToBeRemoved

columnsAboutToBeRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

columnsInserted

columnsInserted(self, parent: QModelIndex, first: int, last: int) [signal]

columnsMoved

columnsMoved(self, parent: QModelIndex, start: int, end: int, destination: QModelIndex, column: int) [signal]

columnsRemoved

columnsRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

connectNotify(self, signal: QMetaMethod)
createIndex(self, row: int, column: int, object: object = 0) QModelIndex
customEvent(self, a0: QEvent)
dataChanged

dataChanged(self, topLeft: QModelIndex, bottomRight: QModelIndex, roles: Iterable[int] = []) [signal]

decodeData(self, row: int, column: int, parent: QModelIndex, stream: QDataStream) bool
deleteLater(self)
destroyed

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

disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
dropMimeData(self, data: QMimeData, action: Qt.DropAction, row: int, column: int, parent: QModelIndex) bool
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
encodeData(self, indexes: Iterable[QModelIndex], stream: QDataStream)
endInsertColumns(self)
endInsertRows(self)
endMoveColumns(self)
endMoveRows(self)
endRemoveColumns(self)
endRemoveRows(self)
endResetModel(self)
event(self, a0: QEvent) bool
eventFilter(self, a0: QObject, a1: QEvent) bool
fetchMore(self, parent: QModelIndex)
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
flags(self, index: QModelIndex) Qt.ItemFlag
getStruct(index)
hasChildren(self, parent: QModelIndex = QModelIndex()) bool
hasIndex(self, row: int, column: int, parent: QModelIndex = QModelIndex()) bool
index(self, row: int, column: int, parent: QModelIndex = QModelIndex()) QModelIndex
inherits(self, classname: str) bool
installEventFilter(self, a0: QObject)
isSignalConnected(self, signal: QMetaMethod) bool
isWidgetType(self) bool
isWindowType(self) bool
itemData(self, index: QModelIndex) Dict[int, Any]
killTimer(self, id: int)
layoutAboutToBeChanged

layoutAboutToBeChanged(self, parents: Iterable[QPersistentModelIndex] = [], hint: QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]

layoutChanged

layoutChanged(self, parents: Iterable[QPersistentModelIndex] = [], hint: QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]

match(self, start: QModelIndex, role: int, value: Any, hits: int = 1, flags: Qt.MatchFlag = Qt.MatchFlags(Qt.MatchStartsWith | Qt.MatchWrap)) List[QModelIndex]
metaObject(self) QMetaObject
mimeData(self, indexes: Iterable[QModelIndex]) QMimeData
mimeTypes(self) List[str]
modelAboutToBeReset

modelAboutToBeReset(self) [signal]

modelReset

modelReset(self) [signal]

moveColumn(self, sourceParent: QModelIndex, sourceColumn: int, destinationParent: QModelIndex, destinationChild: int) bool
moveColumns(self, sourceParent: QModelIndex, sourceColumn: int, count: int, destinationParent: QModelIndex, destinationChild: int) bool
moveRow(self, sourceParent: QModelIndex, sourceRow: int, destinationParent: QModelIndex, destinationChild: int) bool
moveRows(self, sourceParent: QModelIndex, sourceRow: int, count: int, destinationParent: QModelIndex, destinationChild: int) bool
moveToThread(self, thread: QThread)
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

parent(self) QObject
persistentIndexList(self) List[QModelIndex]
property(self, name: str) Any
pyqtConfigure(...)

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

receivers(self, signal: PYQT_SIGNAL) int
removeEventFilter(self, a0: QObject)
removeStruct(row, column)
reset()

PANEL-8852: Method added to prevent QtUpgradeError. This preserves backwards compatibility with QtCore.QAbstractTableModel.reset() but does not reset anything.

resetInternalData(self)
resize(row, column)
resizeColumns(cols)
resizeRows(row)
revert(self)
roleNames(self) Dict[int, QByteArray]
rowCount(self, parent: QModelIndex = QModelIndex()) int
rowsAboutToBeInserted

rowsAboutToBeInserted(self, parent: QModelIndex, first: int, last: int) [signal]

rowsAboutToBeMoved

rowsAboutToBeMoved(self, sourceParent: QModelIndex, sourceStart: int, sourceEnd: int, destinationParent: QModelIndex, destinationRow: int) [signal]

rowsAboutToBeRemoved

rowsAboutToBeRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

rowsInserted

rowsInserted(self, parent: QModelIndex, first: int, last: int) [signal]

rowsMoved

rowsMoved(self, parent: QModelIndex, start: int, end: int, destination: QModelIndex, row: int) [signal]

rowsRemoved

rowsRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

sender(self) QObject
senderSignalIndex(self) int
setData(self, index: QModelIndex, value: Any, role: int = Qt.EditRole) bool
setItemData(self, index: QModelIndex, roles: Dict[int, Any]) bool
setObjectName(self, name: str)
setParent(self, a0: QObject)
setProperty(self, name: str, value: Any) bool
setStruct(index, struct)

Given the index, replace the structure with the new value. If the _unique flag is true and the new value already exists in table, it is not added.

Returns

Return whether the new structure was successfully set at the specified index.

Return type

bool

sibling(self, row: int, column: int, idx: QModelIndex) QModelIndex
signalsBlocked(self) bool
sizeChanged
span(self, index: QModelIndex) QSize
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
structCount()
submit(self) bool
supportedDragActions(self) Qt.DropAction
supportedDropActions(self) Qt.DropAction
thread(self) QThread
timerEvent(self, a0: QTimerEvent)
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
class schrodinger.ui.qt.table.GenericViewerDelegate(tableview, tablemodel=None)

Bases: PyQt6.QtWidgets.QItemDelegate

This is the class that handles the actual drawing of data. This doesn’t handle any actual data, so you’ll have to subclass it to get it to work. For your own widget table, you should subclass this class, add any data input you need into the __init__, and reimplement the _paint class for your needs, using your data.

An example of this is the StructureReaderDelegate in this file.

__init__(tableview, tablemodel=None)
Parameters
  • tableview (ViewerTable) – Table this delegate paints to

  • tablemodel (StructureDataViewerModel) – DEPRECATED Model containing the data this delegate paints This parameter should not be used, because a delegate should only get information from a QModelIndex, not a model directly

paint(painter, option, index)

This handles the logic behind painting/not-painting when the scrollbar is being dragged.

setPaintWait(val)

Use this function to turn on/off delaying drawing of cells until the scrollbar is not being used. This may be useful in CPU intensive cell-drawing delegates.

paintWait()

Returns if we are drawing during while the scrollbar is dragged.

EditNextItem = 1
EditPreviousItem = 2
class EndEditHint(value)

Bases: enum.Enum

An enumeration.

NoHint = 0
EditNextItem = 1
EditPreviousItem = 2
SubmitModelCache = 3
RevertModelCache = 4
NoHint = 0
RevertModelCache = 4
SubmitModelCache = 3
blockSignals(self, b: bool) bool
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
closeEditor

closeEditor(self, editor: QWidget, hint: QAbstractItemDelegate.EndEditHint = QAbstractItemDelegate.NoHint) [signal]

commitData

commitData(self, editor: QWidget) [signal]

connectNotify(self, signal: QMetaMethod)
createEditor(self, parent: QWidget, option: QStyleOptionViewItem, index: QModelIndex) QWidget
customEvent(self, a0: QEvent)
deleteLater(self)
destroyEditor(self, editor: QWidget, index: QModelIndex)
destroyed

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

disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
drawBackground(self, painter: QPainter, option: QStyleOptionViewItem, index: QModelIndex)
drawCheck(self, painter: QPainter, option: QStyleOptionViewItem, rect: QRect, state: Qt.CheckState)
drawDecoration(self, painter: QPainter, option: QStyleOptionViewItem, rect: QRect, pixmap: QPixmap)
drawDisplay(self, painter: QPainter, option: QStyleOptionViewItem, rect: QRect, text: str)
drawFocus(self, painter: QPainter, option: QStyleOptionViewItem, rect: QRect)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
editorEvent(self, event: QEvent, model: QAbstractItemModel, option: QStyleOptionViewItem, index: QModelIndex) bool
event(self, a0: QEvent) bool
eventFilter(self, object: QObject, event: QEvent) bool
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
hasClipping(self) bool
helpEvent(self, event: QHelpEvent, view: QAbstractItemView, option: QStyleOptionViewItem, index: QModelIndex) bool
inherits(self, classname: str) bool
installEventFilter(self, a0: QObject)
isSignalConnected(self, signal: QMetaMethod) bool
isWidgetType(self) bool
isWindowType(self) bool
itemEditorFactory(self) QItemEditorFactory
killTimer(self, id: int)
metaObject(self) QMetaObject
moveToThread(self, thread: QThread)
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

parent(self) QObject
property(self, name: str) Any
pyqtConfigure(...)

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

receivers(self, signal: PYQT_SIGNAL) int
removeEventFilter(self, a0: QObject)
sender(self) QObject
senderSignalIndex(self) int
setClipping(self, clip: bool)
setEditorData(self, editor: QWidget, index: QModelIndex)
setItemEditorFactory(self, factory: QItemEditorFactory)
setModelData(self, editor: QWidget, model: QAbstractItemModel, index: QModelIndex)
setObjectName(self, name: str)
setParent(self, a0: QObject)
setProperty(self, name: str, value: Any) bool
signalsBlocked(self) bool
sizeHint(self, option: QStyleOptionViewItem, index: QModelIndex) QSize
sizeHintChanged

sizeHintChanged(self, a0: QModelIndex) [signal]

startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
thread(self) QThread
timerEvent(self, a0: QTimerEvent)
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
updateEditorGeometry(self, editor: QWidget, option: QStyleOptionViewItem, index: QModelIndex)
class schrodinger.ui.qt.table.StructureDataViewerDelegate(tableview, tablemodel=None, structure_class=None, max_scale=0.5, elide=TextElideMode.ElideRight, alignment=None)

Bases: schrodinger.ui.qt.table.GenericViewerDelegate

A table that can display both 2-D structures and data.

This Delegate should be used with the StructureDataViewerModel

Much of this class is built off of the StructureViewerDelegate class. Structures are cached for quicker drawing of the table while keeping memory use low. Data is not cached.

__init__(tableview, tablemodel=None, structure_class=None, max_scale=0.5, elide=TextElideMode.ElideRight, alignment=None)

Intialize the StructreDataViewerDelegate

Parameters
  • tableview (ViewerTable) – Table this delegate paints to

  • tablemodel (StructureDataViewerModel) – DEPRECATED Model containing the data this delegate paints This parameter should not be used, because a delegate should only get information from a QModelIndex, not a model directly

  • structure_class (class) – class (or superclass) of the objects that should be displayed in the table as 2D pictures - usually schrodinger.structure.Structure (the default)

  • max_scale (float) – restricts the maximum scale-up of 2D structure images so that very small molecules don’t look so large.

  • elide (int) – Determines where ‘…’ should occur in strings that are too large to fit in the table cell. Common values are Qt.ElideLeft, Qt.ElideRight, Qt.ElideMiddle, Qt.ElideNone

  • alignment (Qt.AlignmentFlag object) – The alignment of text in the cells.

To put a structure in a cell, store a structure_class object in that cell of the model. To put any other type of data in a cell, store that data in that cell of the model.

sizeHint(option, index, actual_column_width=False, actual_size=False, actual_row_height=False)

Returns the sizeHint for the data in the cell at index. If the data is a structure, returns the default cell size for the table.

Parameters
  • option (QStyleOptionViewItem) – the style options for this item

  • index (QModelIndex) – The index of the cell being examimed

  • actual_column_width (bool) – True if the column widths and row heights should be calculated from the width of the data as a string. Normally, sizeHint seems to return 0 for the width of text and an acceptable constant for the height, so actual_column_width is the better option.

  • actual_column_width – True if the row heights should be calculated from the height of the data as a string. Normally, sizeHint returns an acceptable constant for the row height, so this is not usually needed.

  • actual_column_width – True if the column widths should be calculated from the width of the data as a string. Normally, sizeHint seems to return 0 for the width of text.

clearCache()

Will clear all QPictures that are cached.

isStructure(object)

Returns true if object is the type given as a structure

generatePicture(struct)

Generates a 2D chemical structure of the object

If object is a chemical structure, returns the picture is a 2D rendering of that structure; None otherwise.

Parameters

struct (Object of type StructureDataViewerDelegate.structure_class) – The structure object

Return type

QPicture or None

Returns

QPicture of struct or None

paintStructure(painter, option, pic, index=None)

Draws the given QPicture (typically a 2D structure image) into the specified painter. Called from the paint() method of the delegate. Adds a bit of padding all around the cell, then passes the data on to the proper drawing routine.

Parameters
  • option – Appears to be the part of the gui that contains the cell

  • pic (QPicture) – the picture to be painted

  • index (QModelIndex) – Model index for the cell which is being painted. Not used in default implementation, but may be used in subclass implementations.

paintCell(painter, option, data)

Adds a bit of padding all around the cell, then passes the data on to the proper drawing routine.

Parameters
  • option – Appears to be the part of the gui that contains the cell

  • data (type convertable to string) – the data to be painted into the cell as a string

drawDataIntoRect(painter, data, rect, selected_brush=False)

Draws string data onto a cell

Parameters
  • painter (QtGui.QPainter) – The painter that is drawing the table

  • data (string, int, or float) – the information to be drawn on the table

  • rect (QtCore.Qrect) – The rectangle that defines the current cell of the table

EditNextItem = 1
EditPreviousItem = 2
class EndEditHint(value)

Bases: enum.Enum

An enumeration.

NoHint = 0
EditNextItem = 1
EditPreviousItem = 2
SubmitModelCache = 3
RevertModelCache = 4
NoHint = 0
RevertModelCache = 4
SubmitModelCache = 3
blockSignals(self, b: bool) bool
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
closeEditor

closeEditor(self, editor: QWidget, hint: QAbstractItemDelegate.EndEditHint = QAbstractItemDelegate.NoHint) [signal]

commitData

commitData(self, editor: QWidget) [signal]

connectNotify(self, signal: QMetaMethod)
createEditor(self, parent: QWidget, option: QStyleOptionViewItem, index: QModelIndex) QWidget
customEvent(self, a0: QEvent)
deleteLater(self)
destroyEditor(self, editor: QWidget, index: QModelIndex)
destroyed

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

disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
drawBackground(self, painter: QPainter, option: QStyleOptionViewItem, index: QModelIndex)
drawCheck(self, painter: QPainter, option: QStyleOptionViewItem, rect: QRect, state: Qt.CheckState)
drawDecoration(self, painter: QPainter, option: QStyleOptionViewItem, rect: QRect, pixmap: QPixmap)
drawDisplay(self, painter: QPainter, option: QStyleOptionViewItem, rect: QRect, text: str)
drawFocus(self, painter: QPainter, option: QStyleOptionViewItem, rect: QRect)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
editorEvent(self, event: QEvent, model: QAbstractItemModel, option: QStyleOptionViewItem, index: QModelIndex) bool
event(self, a0: QEvent) bool
eventFilter(self, object: QObject, event: QEvent) bool
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
hasClipping(self) bool
helpEvent(self, event: QHelpEvent, view: QAbstractItemView, option: QStyleOptionViewItem, index: QModelIndex) bool
inherits(self, classname: str) bool
installEventFilter(self, a0: QObject)
isSignalConnected(self, signal: QMetaMethod) bool
isWidgetType(self) bool
isWindowType(self) bool
itemEditorFactory(self) QItemEditorFactory
killTimer(self, id: int)
metaObject(self) QMetaObject
moveToThread(self, thread: QThread)
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

paint(painter, option, index)

This handles the logic behind painting/not-painting when the scrollbar is being dragged.

paintWait()

Returns if we are drawing during while the scrollbar is dragged.

parent(self) QObject
property(self, name: str) Any
pyqtConfigure(...)

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

receivers(self, signal: PYQT_SIGNAL) int
removeEventFilter(self, a0: QObject)
sender(self) QObject
senderSignalIndex(self) int
setClipping(self, clip: bool)
setEditorData(self, editor: QWidget, index: QModelIndex)
setItemEditorFactory(self, factory: QItemEditorFactory)
setModelData(self, editor: QWidget, model: QAbstractItemModel, index: QModelIndex)
setObjectName(self, name: str)
setPaintWait(val)

Use this function to turn on/off delaying drawing of cells until the scrollbar is not being used. This may be useful in CPU intensive cell-drawing delegates.

setParent(self, a0: QObject)
setProperty(self, name: str, value: Any) bool
signalsBlocked(self) bool
sizeHintChanged

sizeHintChanged(self, a0: QModelIndex) [signal]

startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
thread(self) QThread
timerEvent(self, a0: QTimerEvent)
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
updateEditorGeometry(self, editor: QWidget, option: QStyleOptionViewItem, index: QModelIndex)
class schrodinger.ui.qt.table.ToolTipFilter(view)

Bases: PyQt6.QtCore.QObject

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

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

disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
event(self, a0: QEvent) bool
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
inherits(self, classname: str) bool
installEventFilter(self, a0: QObject)
isSignalConnected(self, signal: QMetaMethod) bool
isWidgetType(self) bool
isWindowType(self) bool
killTimer(self, id: int)
metaObject(self) QMetaObject
moveToThread(self, thread: QThread)
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

parent(self) QObject
property(self, name: str) Any
pyqtConfigure(...)

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

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

Bases: schrodinger.ui.qt.table.DataViewerTable

A simple class that automatically sets up the table/model/delegate trio for a table object

__init__(**table_args)

Creates an SEasySDTable class object. __init__ Keywords for the model, delegate and table objects can be passed in and will be passed on as appropriate.

By default, this will set up a sortable table using a proxymodel.

The sourcemodel should be used when need to add/remove data.

The proxymodel should be used when you need to reference data from the view.

AboveItem = 1
AdjustIgnored = 0
AdjustToContents = 2
AdjustToContentsOnFirstShow = 1
AllEditTriggers = 31
AnimatingState = 6
AnyKeyPressed = 16
BelowItem = 2
Box = 1
CollapsingState = 5
ContiguousSelection = 4
CurrentChanged = 1
class CursorAction(value)

Bases: enum.Enum

An enumeration.

MoveUp = 0
MoveDown = 1
MoveLeft = 2
MoveRight = 3
MoveHome = 4
MoveEnd = 5
MovePageUp = 6
MovePageDown = 7
MoveNext = 8
MovePrevious = 9
DoubleClicked = 2
DragDrop = 3
class DragDropMode(value)

Bases: enum.Enum

An enumeration.

NoDragDrop = 0
DragOnly = 1
DropOnly = 2
DragDrop = 3
InternalMove = 4
DragOnly = 1
DragSelectingState = 2
DraggingState = 1
DrawChildren = 2
DrawWindowBackground = 1
class DropIndicatorPosition(value)

Bases: enum.Enum

An enumeration.

OnItem = 0
AboveItem = 1
BelowItem = 2
OnViewport = 3
DropOnly = 2
EditKeyPressed = 8
class EditTrigger(value)

Bases: enum.Flag

An enumeration.

NoEditTriggers = 0
CurrentChanged = 1
DoubleClicked = 2
SelectedClicked = 4
EditKeyPressed = 8
AnyKeyPressed = 16
AllEditTriggers = 31
EditingState = 3
EnsureVisible = 0
ExpandingState = 4
ExtendedSelection = 3
HLine = 4
IgnoreMask = 4
InternalMove = 4
MoveDown = 1
MoveEnd = 5
MoveHome = 4
MoveLeft = 2
MoveNext = 8
MovePageDown = 7
MovePageUp = 6
MovePrevious = 9
MoveRight = 3
MoveUp = 0
MultiSelection = 2
NoDragDrop = 0
NoEditTriggers = 0
NoFrame = 0
NoSelection = 0
NoState = 0
OnItem = 0
OnViewport = 3
class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1
PdmHeight = 2
PdmWidthMM = 3
PdmHeightMM = 4
PdmNumColors = 5
PdmDepth = 6
PdmDpiX = 7
PdmDpiY = 8
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
Panel = 2
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
Plain = 16
PositionAtBottom = 2
PositionAtCenter = 3
PositionAtTop = 1
Raised = 32
class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1
DrawChildren = 2
IgnoreMask = 4
class ScrollHint(value)

Bases: enum.Enum

An enumeration.

EnsureVisible = 0
PositionAtTop = 1
PositionAtBottom = 2
PositionAtCenter = 3
class ScrollMode(value)

Bases: enum.Enum

An enumeration.

ScrollPerItem = 0
ScrollPerPixel = 1
ScrollPerItem = 0
ScrollPerPixel = 1
SelectColumns = 2
SelectItems = 0
SelectRows = 1
SelectedClicked = 4
class SelectionBehavior(value)

Bases: enum.Enum

An enumeration.

SelectItems = 0
SelectRows = 1
SelectColumns = 2
class SelectionMode(value)

Bases: enum.Enum

An enumeration.

NoSelection = 0
SingleSelection = 1
MultiSelection = 2
ExtendedSelection = 3
ContiguousSelection = 4
class Shadow(value)

Bases: enum.IntEnum

An enumeration.

Plain = 16
Raised = 32
Sunken = 48
Shadow_Mask = 240
class Shape(value)

Bases: enum.IntEnum

An enumeration.

NoFrame = 0
Box = 1
Panel = 2
WinPanel = 3
HLine = 4
VLine = 5
StyledPanel = 6
Shape_Mask = 15
SingleSelection = 1
class SizeAdjustPolicy(value)

Bases: enum.Enum

An enumeration.

AdjustIgnored = 0
AdjustToContentsOnFirstShow = 1
AdjustToContents = 2
class State(value)

Bases: enum.Enum

An enumeration.

NoState = 0
DraggingState = 1
DragSelectingState = 2
EditingState = 3
ExpandingState = 4
CollapsingState = 5
AnimatingState = 6
class StyleMask(value)

Bases: enum.Enum

An enumeration.

Shadow_Mask = 240
Shape_Mask = 15
StyledPanel = 6
Sunken = 48
VLine = 5
WinPanel = 3
acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, a0: QActionEvent)
actions(self) List[QAction]
activateWindow(self)
activated

activated(self, index: QModelIndex) [signal]

addAction(self, action: QAction)
addActions(self, actions: Iterable[QAction])
addScrollBarWidget(self, widget: QWidget, alignment: Qt.AlignmentFlag)
adjustSize(self)
alternatingRowColors(self) bool
autoFillBackground(self) bool
autoScrollMargin(self) int
averageGangedColumnWidth()

This routine has been changed to return the MOST COMMON non-zero width of all the ganged columns

Return type

int

Returns

the most common integer average column width, or the default width if there are no non-zero ganged columns

averageGangedRowHeight()

This routine has been changed to return the MOST COMMON non-zero height of all the ganged rows

Return type

int

Returns

the most common integer average row height, or the default height if there are no non-zero ganged rows

backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, b: bool) bool
changeEvent(self, a0: QEvent)
checkSizingPolicies()

Raises a ValueError if we have conflicting sizing policies

childAt(self, p: QPoint) QWidget
childAt(self, ax: int, ay: int) QWidget
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
clearSelection(self)
clearSpans(self)
clicked

clicked(self, index: QModelIndex) [signal]

close(self) bool
closeEditor(self, editor: QWidget, hint: QAbstractItemDelegate.EndEditHint)
closeEvent(self, a0: QCloseEvent)
closePersistentEditor(self, index: QModelIndex)
colorCount(self) int
columnAt(self, x: int) int
columnCountChanged(old_count, new_count)

Called when a column is added or deleted, and sets the columns to their initial size.

Parameters
  • old_count (int) – the old number of columns

  • new_count (int) – the num number of columns

columnMoved(self, column: int, oldIndex: int, newIndex: int)
columnResized(column, old_size, new_size, manual=False)

Resizes any cells that need to be resized when a column size is changed

Parameters
  • column (int) – the column number that changed

  • old_size (int) – the old size of the column

  • new_size (int) – the new size of the column

  • manual (bool) – True if this a manual resize being called by a script. If True, this forces the method to execute even if AutoResizing has been set to false.

columnSpan(self, row: int, column: int) int
columnViewportPosition(self, column: int) int
columnWidth(self, column: int) int
columnsInserted(index, start, end)

Slot that receives a signal when columns are inserted in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the columns inserted

  • end (int) – The ending index of the columns inserted (inclusive)

columnsMoved(index1, start, end, index2, place)

Slot that receives a signal when columns are moved in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index1 (QModelIndex) – unused

  • start (int) – The starting index of the columns moved

  • end (int) – The ending index of the columns moved (inclusive)

  • index2 (QModelIndex) – unused

  • place (int) – The new starting index of the moved columns

columnsRemoved(index, start, end)

Slot that receives a signal when columns are removed in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the columns removed

  • end (int) – The ending index of the columns removed (inclusive)

commitData(self, editor: QWidget)
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, a0: QContextMenuEvent)
contextMenuPolicy(self) Qt.ContextMenuPolicy
copyImageToClipboard()

Copy an image of the table to the clipboard

cornerWidget(self) QWidget
create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(window: QWindow, parent: typing.Optional[QWidget] = None, flags: Qt.WindowType = Qt.WindowFlags()) QWidget
currentChanged(self, current: QModelIndex, previous: QModelIndex)
currentIndex(self) QModelIndex
cursor(self) QCursor
customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)
dataChanged(self, topLeft: QModelIndex, bottomRight: QModelIndex, roles: Iterable[int] = [])
defaultDropAction(self) Qt.DropAction
deleteLater(self)
depth(self) int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

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

devType(self) int
devicePixelRatio(self) float
devicePixelRatioF(self) float
devicePixelRatioFScale() float
dirtyRegionOffset(self) QPoint
disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
doubleClicked

doubleClicked(self, index: QModelIndex) [signal]

dragDropMode(self) QAbstractItemView.DragDropMode
dragDropOverwriteMode(self) bool
dragEnabled(self) bool
dragEnterEvent(self, e: QDragEnterEvent)
dragLeaveEvent(self, e: QDragLeaveEvent)
dragMoveEvent(self, e: QDragMoveEvent)
drawFrame(self, a0: QPainter)
dropEvent(self, e: QDropEvent)
dropIndicatorPosition(self) QAbstractItemView.DropIndicatorPosition
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
edit(self, index: QModelIndex)
edit(self, index: QModelIndex, trigger: QAbstractItemView.EditTrigger, event: QEvent) bool
editTriggers(self) QAbstractItemView.EditTrigger
editorDestroyed(self, editor: QObject)
effectiveWinId(self) PyQt6.sip.voidptr
enforceScrollBarPolicies()

Sets the scrollbar policies as required by the sizing policies

ensurePolished(self)
enterEvent(self, event: QEnterEvent)
entered

entered(self, index: QModelIndex) [signal]

event(self, event: QEvent) bool
eventFilter(self, object: QObject, event: QEvent) bool
executeDelayedItemsLayout(self)
find(a0: PyQt6.sip.voidptr) QWidget
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
fitCellsToData(include_column_header=False)

Resizes rows and columns to fit the data they contain using the sizeHint from the delegate

Parameters

include_column_header (bool) – True if the column header should be included when figuring the column width, False if not

fitColumnToData(column, include_header=False)

Resizes column to the largest sizeHint of any of its cells. Uses the sizeHint of the delegate.

Parameters
  • column (int) – the column of interest

  • include_header (bool) – True if the header should be included in the calculation of column width, False if not

fitColumnsToData(include_header=False)

Resizes all the columns to fit the data they contain using the sizeHint from the delegate.

Parameters

include_header (bool) – True if the header should be included in the calculation of column width, False if not

fitRowToData(row)

Resizes row to the largest sizeHint of any of its cells. Uses the sizeHint of the delegate.

Parameters

row (int) – the row of interest

fitRowsToData()

Resizes all the rows to fit the data they contain using the sizeHint from the delegate.

fitToColumns()

Fits the viewport to exactly show all the columns

fitToRows()

Fits the viewport to exactly show all the rows

fixSize(manual=False)

Resize everything as the user and program desires

Parameters

manual (bool) – True if this a manual resize being called by a script. If True, this forces the method to execute even if AutoResizing has been set to false.

focusInEvent(self, e: QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, e: QFocusEvent)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget
focusWidget(self) QWidget
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameRect(self) QRect
frameShadow(self) QFrame.Shadow
frameShape(self) QFrame.Shape
frameSize(self) QSize
frameStyle(self) int
frameWidth(self) int
geometry(self) QRect
grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) QPixmap
grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, a0: Union[QCursor, Qt.CursorShape]) None
grabShortcut(self, key: Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect
graphicsProxyWidget(self) QGraphicsProxyWidget
gridStyle(self) Qt.PenStyle
hasAutoScroll(self) bool
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
headerClicked(col)
height(self) int
heightForWidth(self, a0: int) int
heightMM(self) int
hide(self)
hideColumn(self, column: int)
hideEvent(self, a0: QHideEvent)
hideRow(self, row: int)
horizontalHeader(self) QHeaderView
horizontalOffset(self) int
horizontalScrollBar(self) QScrollBar
horizontalScrollBarPolicy(self) Qt.ScrollBarPolicy
horizontalScrollMode(self) QAbstractItemView.ScrollMode
horizontalScrollbarAction(self, action: int)
horizontalScrollbarValueChanged(self, value: int)
iconSize(self) QSize
iconSizeChanged

iconSizeChanged(self, size: QSize) [signal]

indexAt(self, p: QPoint) QModelIndex
indexWidget(self, index: QModelIndex) QWidget
inherits(self, classname: str) bool
initPainter(self, painter: QPainter)
initStyleOption(self, option: QStyleOptionFrame)
initViewItemOption(self, option: QStyleOptionViewItem)
initiateCellSizes(rows=True, columns=True)

Sets all the cells to their intial default size

Parameters
  • rows (bool) – whether to set the rows to their default height

  • columns (bool) – whether to set the columns to their default width

inputMethodEvent(self, event: QInputMethodEvent)
inputMethodHints(self) Qt.InputMethodHint
inputMethodQuery(self, query: Qt.InputMethodQuery) Any
insertAction(self, before: QAction, action: QAction)
insertActions(self, before: QAction, actions: Iterable[QAction])
installEventFilter(self, a0: QObject)
isActiveWindow(self) bool
isActivelyScrolling()
isAncestorOf(self, child: QWidget) bool
isColumnGanged(column)

Returns True if column is ganged, False if not

Parameters

column (int) – the column to check for ganging

isColumnHidden(self, column: int) bool
isCornerButtonEnabled(self) bool
isEnabled(self) bool
isEnabledTo(self, a0: QWidget) bool
isFullScreen(self) bool
isHidden(self) bool
isIndexHidden(self, index: QModelIndex) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isPersistentEditorOpen(self, index: QModelIndex) bool
isRightToLeft(self) bool
isRowGanged(row)

Returns True if row is ganged, False if not

Parameters

row (int) – the row to check for ganging

isRowHidden(self, row: int) bool
isScrolling()
isSignalConnected(self, signal: QMetaMethod) bool
isSortingEnabled(self) bool
isVisible(self) bool
isVisibleTo(self, a0: QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
itemDelegate(self) QAbstractItemDelegate
itemDelegateForColumn(self, column: int) QAbstractItemDelegate
itemDelegateForIndex(self, index: QModelIndex) QAbstractItemDelegate
itemDelegateForRow(self, row: int) QAbstractItemDelegate
keyPressEvent(event)
Parameters

event (QKeyEvent) – The keypress event

Currently only does anything for Ctrl-C (copy to clipboard)

keyReleaseEvent(self, a0: QKeyEvent)
keyboardGrabber() QWidget
keyboardSearch(self, search: str)
killTimer(self, id: int)
layout(self) QLayout
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, a0: QEvent)
lineWidth(self) int
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self)
mapFrom(self, a0: QWidget, a1: QPoint) QPoint
mapFrom(self, a0: QWidget, a1: QPointF) QPointF
mapFromGlobal(self, a0: QPoint) QPoint
mapFromGlobal(self, a0: QPointF) QPointF
mapFromParent(self, a0: QPoint) QPoint
mapFromParent(self, a0: QPointF) QPointF
mapTo(self, a0: QWidget, a1: QPoint) QPoint
mapTo(self, a0: QWidget, a1: QPointF) QPointF
mapToGlobal(self, a0: QPoint) QPoint
mapToGlobal(self, a0: QPointF) QPointF
mapToParent(self, a0: QPoint) QPoint
mapToParent(self, a0: QPointF) QPointF
mask(self) QRegion
maximumHeight(self) int
maximumSize(self) QSize
maximumViewportSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject
metric(self, a0: QPaintDevice.PaintDeviceMetric) int
midLineWidth(self) int
minimumHeight(self) int
minimumSize(self) QSize
minimumSizeHint(self) QSize
minimumWidth(self) int
model(self) QAbstractItemModel
mouseDoubleClickEvent(self, e: QMouseEvent)
mouseGrabber() QWidget
mouseMoveEvent(self, e: QMouseEvent)
mousePressEvent(self, e: QMouseEvent)
mouseReleaseEvent(self, e: QMouseEvent)
move(self, a0: QPoint)
move(self, ax: int, ay: int) None
moveCursor(self, cursorAction: QAbstractItemView.CursorAction, modifiers: Qt.KeyboardModifier) QModelIndex
moveEvent(self, a0: QMoveEvent)
moveToThread(self, thread: QThread)
nativeEvent(self, eventType: QByteArray, message: PyQt6.sip.voidptr) Tuple[bool, PyQt6.sip.voidptr]
nativeParentWidget(self) QWidget
nextInFocusChain(self) QWidget
normalGeometry(self) QRect
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

openPersistentEditor(self, index: QModelIndex)
overrideWindowFlags(self, type: Qt.WindowType)
overrideWindowState(self, state: Qt.WindowState)
paintEngine(self) QPaintEngine
paintEvent(self, e: QPaintEvent)
paintingActive(self) bool
palette(self) QPalette
parent(self) QObject
parentWidget(self) QWidget
physicalDpiX(self) int
physicalDpiY(self) int
pos(self) QPoint
pressed

pressed(self, index: QModelIndex) [signal]

previousInFocusChain(self) QWidget
property(self, name: str) Any
pyqtConfigure(...)

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

raise_(self)
reEnableColumnResize()
receivers(self, signal: PYQT_SIGNAL) int
rect(self) QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id: int)
removeAction(self, action: QAction)
removeEventFilter(self, a0: QObject)
render(self, target: QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))
render(self, painter: QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) None
repaint(self)
repaint(self, x: int, y: int, w: int, h: int) None
repaint(self, a0: QRect) None
repaint(self, a0: QRegion) None
reset(self)
resetHorizontalScrollMode(self)
resetVerticalScrollMode(self)
resize(self, a0: QSize)
resize(self, w: int, h: int) None
resizeColumnToContents(self, column: int)
resizeColumnsToContents()

Resizes all the columns according to all the resize properties

resizeEvent(event)

Called when the viewport changes size. Changes the size of any cells that need to be changed in response to this - typically because fill has been set on rows or columns.

Parameters

event (QEvent) – the event that occured

resizeRowToContents(self, row: int)
resizeRowsToContents()

Resizes all the rows according to all the resize properties

restoreGeometry(self, geometry: QByteArray) bool
rootIndex(self) QModelIndex
rowAt(self, y: int) int
rowCountChanged(old_count, new_count)

Called when a row is added or deleted, and sets the rows to their initial size.

Parameters
  • old_count (int) – the old number of rows

  • new_count (int) – the num number of rows

rowHeight(self, row: int) int
rowMoved(self, row: int, oldIndex: int, newIndex: int)
rowResized(row, old_size, new_size, manual=False)

Resizes any cells that need to be resized when a row size is changed

Parameters
  • row (int) – the row number that changed

  • old_size (int) – the old size of the row

  • new_size (int) – the new size of the row

  • manual (bool) – True if this a manual resize being called by a script. If True, this forces the method to execute even if AutoResizing has been set to false.

rowSpan(self, row: int, column: int) int
rowViewportPosition(self, row: int) int
rowsAboutToBeRemoved(self, parent: QModelIndex, start: int, end: int)
rowsInserted(index, start, end)

Slot that receives a signal when rows are inserted in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the rows inserted

  • end (int) – The ending index of the rows inserted (inclusive)

rowsMoved(index1, start, end, index2, place)

Slot that receives a signal when rows are moved in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index1 (QModelIndex) – unused

  • start (int) – The starting index of the rows moved

  • end (int) – The ending index of the rows moved (inclusive)

  • index2 (QModelIndex) – unused

  • place (int) – The new starting index of the moved rows

rowsRemoved(index, start, end)

Slot that receives a signal when rows are removed in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the rows removed

  • end (int) – The ending index of the rows removed (inclusive)

saveGeometry(self) QByteArray
scheduleDelayedItemsLayout(self)
screen(self) QScreen
scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) None
scrollBarChanged(orientation)

A scrollbar has changed appearance, make sure we have the proper size

scrollBarWidgets(self, alignment: Qt.AlignmentFlag) List[QWidget]
scrollContentsBy(self, dx: int, dy: int)
scrollDirtyRegion(self, dx: int, dy: int)
scrollTo(self, index: QModelIndex, hint: QAbstractItemView.ScrollHint = QAbstractItemView.EnsureVisible)
scrollToBottom(self)
scrollToTop(self)
selectAll(self)
selectColumn(self, column: int)
selectRow(self, row: int)
selectedIndexes(self) List[QModelIndex]
selectionBehavior(self) QAbstractItemView.SelectionBehavior
selectionChanged(self, selected: QItemSelection, deselected: QItemSelection)
selectionCommand(self, index: QModelIndex, event: typing.Optional[QEvent] = None) QItemSelectionModel.SelectionFlag
selectionMode(self) QAbstractItemView.SelectionMode
selectionModel(self) QItemSelectionModel
sender(self) QObject
senderSignalIndex(self) int
setAcceptDrops(self, on: bool)
setAccessibleDescription(self, description: str)
setAccessibleName(self, name: str)
setAlternatingRowColors(self, enable: bool)
setAspectRatioPolicy(fixed, resize=True, policy_check=True)

Sets whether the cell aspect ratio is locked or not

Parameters
  • fixed (bool) – If True, cell aspect ratio is locked. If False, it is not

  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, enabled: bool)
setAutoScroll(self, enable: bool)
setAutoScrollMargin(self, margin: int)
setAutoSizing(state)

Turn the auto resizing of rows and column on or off. Normally this should be on (default), however, if multiple changes will be made and no resizing needs to be done until all changes are complete, then setting AutoSizing to False will save considerable time for large tables. Be sure to setAutoSizing(True) when finished so the table can adjust to the changes made.

Parameters

state (bool) – True if rows and columns should be resized automatically in response to table changes, False if not

setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) None
setColumnHidden(self, column: int, hide: bool)
setColumnIsGanged(column, is_ganged)

Sets a flag on column to indicate whether its size is ganged with other columns or not. Note that this has no effect if columns are not already ganged. This function should not be called if universal_column_gang_setting was set to True.

Parameters
  • column (int) – the column number this applies to

  • is_ganged (bool) – True if the column should be ganged, False if not

setColumnWidth(self, column: int, width: int)
setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) None
setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)
setCornerButtonEnabled(self, enable: bool)
setCornerWidget(self, widget: QWidget)
setCurrentIndex(self, index: QModelIndex)
setCursor(self, a0: Union[QCursor, Qt.CursorShape])
setDefaultDropAction(self, dropAction: Qt.DropAction)
setDelegate(delegate)

Set the delegate for this table

Parameters

delegate (StructureDataViewerDelegate) – delegate that draws the data for this table

setDirtyRegion(self, region: QRegion)
setDisabled(self, a0: bool)
setDragDropMode(self, behavior: QAbstractItemView.DragDropMode)
setDragDropOverwriteMode(self, overwrite: bool)
setDragEnabled(self, enable: bool)
setDropIndicatorShown(self, enable: bool)
setEditTriggers(self, triggers: QAbstractItemView.EditTrigger)
setEnabled(self, a0: bool)
setFillPolicy(fill, resize=True, policy_check=True, enforce_scroll_bars=True)

Sets whether columns or rows should fill the viewport or not

Parameters
  • fill ("rows", "columns", "both" or "none") – The specified table feature will expand or contract to exactly fit within the table’s viewport. “both” means both rows and columns will expand, and “none” means neither will. fill cannot be “both” if aspect_ratio is True. Setting a feature to fill will turn off the corresponding scrollbar.

  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

  • enforce_scroll_bars (bool) – Whether to enforce the default scrollbar policy for fill settings

setFitViewPolicy(fit_view, resize=True, policy_check=True, enforce_scroll_bars=True)

Sets whether the viewport should be resized to the rows/columns or not

Parameters

fit_view ("rows", "columns", "both" or "none") – the table features that determine the size of the table’s viewport (the part visible to the user).

When this is turned on for a feature, the visible part of the table resizes dynamically to exactly fit that feature. For instance, if fit_view=’rows’, the visible part of the table will resize to exactly fit all the rows any time the size of a row changes.

  • “none” - neither rows nor columns determine the viewport size

  • “rows” - rows determine the viewport height

  • “columns” - columns determine the viewport width

  • “both” - both rows and columns determine the viewport size

Note - a feature that has fill turned on cannot have viewport_fit turned on. fill uses the size of the viewport to determine the size of the cells, while fit_view uses the sie of the cells to determine the size of the viewport.

Note 2 - Setting a feature to fit_view will turn off the corresponding scrollbar.

Note 3 - User resizing of rows with both gang and fit_view=’rows’ or ‘both’ tends to be a bit wonky because the amount the row resizes depends on the placement of the mouse relative to the table, and the table moves as it resizes to the rows, so you tend to get very large changes rapidly.

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

  • enforce_scroll_bars (bool) – Whether to enforce the default scrollbar policy for fit view settings

setFixedHeight(self, h: int)
setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int)
setFocus(self)
setFocus(self, reason: Qt.FocusReason) None
setFocusPolicy(self, policy: Qt.FocusPolicy)
setFocusProxy(self, a0: QWidget)
setFont(self, a0: QFont)
setForegroundRole(self, a0: QPalette.ColorRole)
setFrameRect(self, a0: QRect)
setFrameShadow(self, a0: QFrame.Shadow)
setFrameShape(self, a0: QFrame.Shape)
setFrameStyle(self, a0: int)
setGangPolicy(gang, resize=True, policy_check=True)

Sets whether the rows or columns are ganged or not

Parameters

gang ("rows", "columns", "both" or "none") – Controls whether rows and/or columns can be independently resized.

  • “none”: rows and columns can be independently resized

  • “rows”: rows are ganged so that changing the size of one row will change all the rows

  • “columns”: columns are ganged so that changing the size of one column will change all the columns

  • “both” - both rows and columns are ganged (default)

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies. Not used for this routine, but kept for consistency with other sizing policy routines

setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
setGraphicsEffect(self, effect: QGraphicsEffect)
setGridStyle(self, style: Qt.PenStyle)
setHidden(self, hidden: bool)
setHorizontalHeader(self, header: QHeaderView)
setHorizontalScrollBar(self, scrollbar: QScrollBar)
setHorizontalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setHorizontalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setIconSize(self, size: QSize)
setIndexWidget(self, index: QModelIndex, widget: QWidget)
setInputMethodHints(self, hints: Qt.InputMethodHint)
setItemDelegate(delegate)

Set the delegate for this table

Parameters

delegate (StructureDataViewerDelegate) – delegate that draws the data for this table

setItemDelegateForColumn(self, column: int, delegate: QAbstractItemDelegate)
setItemDelegateForRow(self, row: int, delegate: QAbstractItemDelegate)
setLayout(self, a0: QLayout)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLineWidth(self, a0: int)
setLocale(self, locale: QLocale)
setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) None
setMaximumHeight(self, maxh: int)
setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) None
setMaximumWidth(self, maxw: int)
setMidLineWidth(self, a0: int)
setMinimumHeight(self, minh: int)
setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) None
setMinimumWidth(self, minw: int)
setModel(self, model: QAbstractItemModel)
setMouseTracking(self, enable: bool)
setObjectName(self, name: str)
setPalette(self, a0: QPalette)
setParent(self, parent: QWidget)
setParent(self, parent: QWidget, f: Qt.WindowType) None
setProperty(self, name: str, value: Any) bool
setResizablePolicy(resizable, resize=True, policy_check=True)

Sets whether the rows/columns can be resized by the user

Parameters

resizable ("rows", "columns", "both" or "none") – the table features that can be resized by the user.

  • “none” - neither rows nor columns can be resized by the user

  • “rows” - rows can be resized by the user

  • “columns” - columns can be resized by the user

  • “both” - both rows and columns can be resized by the user (default)

Note - a feature that has fill turned on cannot be resized by the user, and if fill is turned on and aspect_ratio is True, neither rows nor columns can be resized by the user.

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

setRootIndex(self, index: QModelIndex)
setRowHeight(self, row: int, height: int)
setRowHidden(self, row: int, hide: bool)
setRowIsGanged(row, is_ganged)

Sets a flag on row to indicate whether its size is ganged with other rows or not. Note that this has no effect if rows are not already ganged. This function should not be called if universal_row_gang_settings was set to True.

Parameters
  • row (int) – the row number this applies to

  • is_ganged (bool) – True if the row should be ganged, False if not

setScreen(self, a0: QScreen)
setSelection(self, rect: QRect, command: QItemSelectionModel.SelectionFlag)
setSelectionBehavior(self, behavior: QAbstractItemView.SelectionBehavior)
setSelectionMode(self, mode: QAbstractItemView.SelectionMode)
setSelectionModel(self, selectionModel: QItemSelectionModel)
setShortcutAutoRepeat(self, id: int, enabled: bool = True)
setShortcutEnabled(self, id: int, enabled: bool = True)
setShowGrid(self, show: bool)
setSizeAdjustPolicy(self, policy: QAbstractScrollArea.SizeAdjustPolicy)
setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) None
setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
setSortingEnabled(sorting)

Sets sorting enabled

Parameters

sorting (bool) – If True, sorting is enabled

setSpan(self, row: int, column: int, rowSpan: int, columnSpan: int)
setState(self, state: QAbstractItemView.State)
setStatusTip(self, a0: str)
setStyle(self, a0: QStyle)
setStyleSheet(self, styleSheet: str)
setTabKeyNavigation(self, enable: bool)
setTabOrder(a0: QWidget, a1: QWidget)
setTabletTracking(self, enable: bool)
setTextElideMode(self, mode: Qt.TextElideMode)
setToolTip(self, a0: str)
setToolTipDuration(self, msec: int)
setToolTipSize(width, height)
Parameters
  • width (int) – width in pixels of tooltip

  • height (int) – height in pixels of tooltip

setUpdatesEnabled(self, enable: bool)
setVerticalHeader(self, header: QHeaderView)
setVerticalScrollBar(self, scrollbar: QScrollBar)
setVerticalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setVerticalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setViewport(self, widget: QWidget)
setViewportMargins(self, left: int, top: int, right: int, bottom: int)
setViewportMargins(self, margins: QMargins) None
setVisible(self, visible: bool)
setWhatsThis(self, a0: str)
setWindowFilePath(self, filePath: str)
setWindowFlag(self, a0: Qt.WindowType, on: bool = True)
setWindowFlags(self, type: Qt.WindowType)
setWindowIcon(self, icon: QIcon)
setWindowIconText(self, a0: str)
setWindowModality(self, windowModality: Qt.WindowModality)
setWindowModified(self, a0: bool)
setWindowOpacity(self, level: float)
setWindowRole(self, a0: str)
setWindowState(self, state: Qt.WindowState)
setWindowTitle(self, a0: str)
setWordWrap(self, on: bool)
setupViewport(self, viewport: QWidget)
sharedPainter(self) QPainter
show(self)
showColumn(self, column: int)
showDropIndicator(self) bool
showEvent(self, a0: QShowEvent)
showFullScreen(self)
showGrid(self) bool
showMaximized(self)
showMinimized(self)
showNormal(self)
showRow(self, row: int)
signalsBlocked(self) bool
size(self) QSize
sizeAdjustPolicy(self) QAbstractScrollArea.SizeAdjustPolicy
sizeHint(self) QSize
sizeHintForColumn(column)

This method gives the size hints for columns - its existance means that the resizeColumnsToContents() method uses this hint rather than hints from the delegate.

Parameters

column (int) – the column we want a size hint for

Return type

int

Returns

the size hint for column

sizeHintForIndex(self, index: QModelIndex) QSize
sizeHintForRow(row)

This method gives the size hints for rows - its existance means that the resizeRowsToContents() method uses this hint rather than hints from the delegate.

Parameters

row (int) – the row we want a size hint for

Return type

int

Returns

the size hint for row

sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
sortByColumn(self, column: int, order: Qt.SortOrder)
stackUnder(self, a0: QWidget)
startDrag(self, supportedActions: Qt.DropAction)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
state(self) QAbstractItemView.State
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
statusTip(self) str
style(self) QStyle
styleSheet(self) str
tabKeyNavigation(self) bool
tabletEvent(self, a0: QTabletEvent)
testAttribute(self, attribute: Qt.WidgetAttribute) bool
textElideMode(self) Qt.TextElideMode
thread(self) QThread
timerEvent(self, event: QTimerEvent)
toolTip(self) str
toolTipDuration(self) int
totalColumnWidth()

The sum of the widths of all the columns

Return type

int

Returns

the sum of all the column widths

totalRowHeight()

The sum of the heights of all the rows

Return type

int

Returns

the sum of all the row heights

tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
underMouse(self) bool
ungrabGesture(self, type: Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, index: QModelIndex) None
updateEditorData(self)
updateEditorGeometries(self)
updateGeometries(self)
updateGeometry(self)
updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)
updatesEnabled(self) bool
verticalHeader(self) QHeaderView
verticalOffset(self) int
verticalScrollBar(self) QScrollBar
verticalScrollBarPolicy(self) Qt.ScrollBarPolicy
verticalScrollMode(self) QAbstractItemView.ScrollMode
verticalScrollbarAction(self, action: int)
verticalScrollbarValueChanged(self, value: int)
viewport(self) QWidget
viewportEntered

viewportEntered(self) [signal]

viewportEvent(self, e: QEvent) bool
viewportMargins(self) QMargins
viewportSizeHint(self) QSize
visibleRegion(self) QRegion
visualRect(self, index: QModelIndex) QRect
visualRegionForSelection(self, selection: QItemSelection) QRegion
whatsThis(self) str
wheelEvent(self, a0: QWheelEvent)
width(self) int
widthMM(self) int
winId(self) PyQt6.sip.voidptr
window(self) QWidget
windowFilePath(self) str
windowFlags(self) Qt.WindowType
windowHandle(self) QWindow
windowIcon(self) QIcon
windowIconChanged

windowIconChanged(self, icon: QIcon) [signal]

windowIconText(self) str
windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowState
windowTitle(self) str
windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) Qt.WindowType
wordWrap(self) bool
x(self) int
y(self) int
auto_size

Whether the table should automatically resize in response to changes

class schrodinger.ui.qt.table.VStackedDataViewerTable(model, model2, scrollbar_at_bottom=True, bottom_table=None, **kwarg)

Bases: schrodinger.ui.qt.table.DataViewerTable

__init__(model, model2, scrollbar_at_bottom=True, bottom_table=None, **kwarg)

Two DataViewerTables stacked on top of each other. They share a single horizontal header and a single scrollbar. The object returned when this class is created is the upper table. The lower table is accessed via VStackedDataViewerTable.table2.

The VStackedDataViewerTable has a layout property .mylayout which is what should be added to the GUI to properly place this widget.

Parameters
  • model (QAbstractTableModel) – The model for the upper table. The typical class to use with this table is the StructureDataViewerModel class.

  • model – The model for the lower table. The typical class to use with this table is the StructureDataViewerModel class.

  • model – The class for the lower table. If not supplied, a VSubDataViewerTable object will be used.

Keyword arguments are documented in the DataViewerTable class

headerClicked(col)
enforceScrollBarPolicies()

Sets the scrollbar policies as required by the sizing policies

setColumnWidth(column, width)

Sets column to width in both tables

Parameters
  • column (int) – the index of the column to change

  • width (int) – the new width of the column

resizeRowsToContents()

Resizes all the rows according to all the resize properties

setFixedWidth(width)

Sets the viewport size to width

Parameters

width (int) – new viewport size in pixels

fitColumnToData(column, include_header=False)

Resizes column to the largest sizeHint of any of its cells. Uses the sizeHint of the delegate.

Parameters

column (int) – the column of interest

resizeEvent(event)

Called when the viewport changes size. Changes the size of any cells that need to be changed in response to this - typically because fill has been set on rows or columns.

Parameters

event (QEvent) – the event that occured

sizeHintForRow(row)

This method gives the size hints for rows - its existance means that the resizeRowsToContents() method uses this hint rather than hints from the delegate.

Parameters

row (int) – the row we want a size hint for

Return type

int

Returns

the size hint for row

AboveItem = 1
AdjustIgnored = 0
AdjustToContents = 2
AdjustToContentsOnFirstShow = 1
AllEditTriggers = 31
AnimatingState = 6
AnyKeyPressed = 16
BelowItem = 2
Box = 1
CollapsingState = 5
ContiguousSelection = 4
CurrentChanged = 1
class CursorAction(value)

Bases: enum.Enum

An enumeration.

MoveUp = 0
MoveDown = 1
MoveLeft = 2
MoveRight = 3
MoveHome = 4
MoveEnd = 5
MovePageUp = 6
MovePageDown = 7
MoveNext = 8
MovePrevious = 9
DoubleClicked = 2
DragDrop = 3
class DragDropMode(value)

Bases: enum.Enum

An enumeration.

NoDragDrop = 0
DragOnly = 1
DropOnly = 2
DragDrop = 3
InternalMove = 4
DragOnly = 1
DragSelectingState = 2
DraggingState = 1
DrawChildren = 2
DrawWindowBackground = 1
class DropIndicatorPosition(value)

Bases: enum.Enum

An enumeration.

OnItem = 0
AboveItem = 1
BelowItem = 2
OnViewport = 3
DropOnly = 2
EditKeyPressed = 8
class EditTrigger(value)

Bases: enum.Flag

An enumeration.

NoEditTriggers = 0
CurrentChanged = 1
DoubleClicked = 2
SelectedClicked = 4
EditKeyPressed = 8
AnyKeyPressed = 16
AllEditTriggers = 31
EditingState = 3
EnsureVisible = 0
ExpandingState = 4
ExtendedSelection = 3
HLine = 4
IgnoreMask = 4
InternalMove = 4
MoveDown = 1
MoveEnd = 5
MoveHome = 4
MoveLeft = 2
MoveNext = 8
MovePageDown = 7
MovePageUp = 6
MovePrevious = 9
MoveRight = 3
MoveUp = 0
MultiSelection = 2
NoDragDrop = 0
NoEditTriggers = 0
NoFrame = 0
NoSelection = 0
NoState = 0
OnItem = 0
OnViewport = 3
class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1
PdmHeight = 2
PdmWidthMM = 3
PdmHeightMM = 4
PdmNumColors = 5
PdmDepth = 6
PdmDpiX = 7
PdmDpiY = 8
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
Panel = 2
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
Plain = 16
PositionAtBottom = 2
PositionAtCenter = 3
PositionAtTop = 1
Raised = 32
class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1
DrawChildren = 2
IgnoreMask = 4
class ScrollHint(value)

Bases: enum.Enum

An enumeration.

EnsureVisible = 0
PositionAtTop = 1
PositionAtBottom = 2
PositionAtCenter = 3
class ScrollMode(value)

Bases: enum.Enum

An enumeration.

ScrollPerItem = 0
ScrollPerPixel = 1
ScrollPerItem = 0
ScrollPerPixel = 1
SelectColumns = 2
SelectItems = 0
SelectRows = 1
SelectedClicked = 4
class SelectionBehavior(value)

Bases: enum.Enum

An enumeration.

SelectItems = 0
SelectRows = 1
SelectColumns = 2
class SelectionMode(value)

Bases: enum.Enum

An enumeration.

NoSelection = 0
SingleSelection = 1
MultiSelection = 2
ExtendedSelection = 3
ContiguousSelection = 4
class Shadow(value)

Bases: enum.IntEnum

An enumeration.

Plain = 16
Raised = 32
Sunken = 48
Shadow_Mask = 240
class Shape(value)

Bases: enum.IntEnum

An enumeration.

NoFrame = 0
Box = 1
Panel = 2
WinPanel = 3
HLine = 4
VLine = 5
StyledPanel = 6
Shape_Mask = 15
SingleSelection = 1
class SizeAdjustPolicy(value)

Bases: enum.Enum

An enumeration.

AdjustIgnored = 0
AdjustToContentsOnFirstShow = 1
AdjustToContents = 2
class State(value)

Bases: enum.Enum

An enumeration.

NoState = 0
DraggingState = 1
DragSelectingState = 2
EditingState = 3
ExpandingState = 4
CollapsingState = 5
AnimatingState = 6
class StyleMask(value)

Bases: enum.Enum

An enumeration.

Shadow_Mask = 240
Shape_Mask = 15
StyledPanel = 6
Sunken = 48
VLine = 5
WinPanel = 3
acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, a0: QActionEvent)
actions(self) List[QAction]
activateWindow(self)
activated

activated(self, index: QModelIndex) [signal]

addAction(self, action: QAction)
addActions(self, actions: Iterable[QAction])
addScrollBarWidget(self, widget: QWidget, alignment: Qt.AlignmentFlag)
adjustSize(self)
alternatingRowColors(self) bool
autoFillBackground(self) bool
autoScrollMargin(self) int
averageGangedColumnWidth()

This routine has been changed to return the MOST COMMON non-zero width of all the ganged columns

Return type

int

Returns

the most common integer average column width, or the default width if there are no non-zero ganged columns

averageGangedRowHeight()

This routine has been changed to return the MOST COMMON non-zero height of all the ganged rows

Return type

int

Returns

the most common integer average row height, or the default height if there are no non-zero ganged rows

backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, b: bool) bool
changeEvent(self, a0: QEvent)
checkSizingPolicies()

Raises a ValueError if we have conflicting sizing policies

childAt(self, p: QPoint) QWidget
childAt(self, ax: int, ay: int) QWidget
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
clearSelection(self)
clearSpans(self)
clicked

clicked(self, index: QModelIndex) [signal]

close(self) bool
closeEditor(self, editor: QWidget, hint: QAbstractItemDelegate.EndEditHint)
closeEvent(self, a0: QCloseEvent)
closePersistentEditor(self, index: QModelIndex)
colorCount(self) int
columnAt(self, x: int) int
columnCountChanged(old_count, new_count)

Called when a column is added or deleted, and sets the columns to their initial size.

Parameters
  • old_count (int) – the old number of columns

  • new_count (int) – the num number of columns

columnMoved(self, column: int, oldIndex: int, newIndex: int)
columnResized(column, old_size, new_size, manual=False)

Resizes any cells that need to be resized when a column size is changed

Parameters
  • column (int) – the column number that changed

  • old_size (int) – the old size of the column

  • new_size (int) – the new size of the column

  • manual (bool) – True if this a manual resize being called by a script. If True, this forces the method to execute even if AutoResizing has been set to false.

columnSpan(self, row: int, column: int) int
columnViewportPosition(self, column: int) int
columnWidth(self, column: int) int
columnsInserted(index, start, end)

Slot that receives a signal when columns are inserted in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the columns inserted

  • end (int) – The ending index of the columns inserted (inclusive)

columnsMoved(index1, start, end, index2, place)

Slot that receives a signal when columns are moved in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index1 (QModelIndex) – unused

  • start (int) – The starting index of the columns moved

  • end (int) – The ending index of the columns moved (inclusive)

  • index2 (QModelIndex) – unused

  • place (int) – The new starting index of the moved columns

columnsRemoved(index, start, end)

Slot that receives a signal when columns are removed in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the columns removed

  • end (int) – The ending index of the columns removed (inclusive)

commitData(self, editor: QWidget)
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, a0: QContextMenuEvent)
contextMenuPolicy(self) Qt.ContextMenuPolicy
copyImageToClipboard()

Copy an image of the table to the clipboard

cornerWidget(self) QWidget
create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(window: QWindow, parent: typing.Optional[QWidget] = None, flags: Qt.WindowType = Qt.WindowFlags()) QWidget
currentChanged(self, current: QModelIndex, previous: QModelIndex)
currentIndex(self) QModelIndex
cursor(self) QCursor
customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)
dataChanged(self, topLeft: QModelIndex, bottomRight: QModelIndex, roles: Iterable[int] = [])
defaultDropAction(self) Qt.DropAction
deleteLater(self)
depth(self) int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

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

devType(self) int
devicePixelRatio(self) float
devicePixelRatioF(self) float
devicePixelRatioFScale() float
dirtyRegionOffset(self) QPoint
disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
doubleClicked

doubleClicked(self, index: QModelIndex) [signal]

dragDropMode(self) QAbstractItemView.DragDropMode
dragDropOverwriteMode(self) bool
dragEnabled(self) bool
dragEnterEvent(self, e: QDragEnterEvent)
dragLeaveEvent(self, e: QDragLeaveEvent)
dragMoveEvent(self, e: QDragMoveEvent)
drawFrame(self, a0: QPainter)
dropEvent(self, e: QDropEvent)
dropIndicatorPosition(self) QAbstractItemView.DropIndicatorPosition
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
edit(self, index: QModelIndex)
edit(self, index: QModelIndex, trigger: QAbstractItemView.EditTrigger, event: QEvent) bool
editTriggers(self) QAbstractItemView.EditTrigger
editorDestroyed(self, editor: QObject)
effectiveWinId(self) PyQt6.sip.voidptr
ensurePolished(self)
enterEvent(self, event: QEnterEvent)
entered

entered(self, index: QModelIndex) [signal]

event(self, event: QEvent) bool
eventFilter(self, object: QObject, event: QEvent) bool
executeDelayedItemsLayout(self)
find(a0: PyQt6.sip.voidptr) QWidget
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
fitCellsToData(include_column_header=False)

Resizes rows and columns to fit the data they contain using the sizeHint from the delegate

Parameters

include_column_header (bool) – True if the column header should be included when figuring the column width, False if not

fitColumnsToData(include_header=False)

Resizes all the columns to fit the data they contain using the sizeHint from the delegate.

Parameters

include_header (bool) – True if the header should be included in the calculation of column width, False if not

fitRowToData(row)

Resizes row to the largest sizeHint of any of its cells. Uses the sizeHint of the delegate.

Parameters

row (int) – the row of interest

fitRowsToData()

Resizes all the rows to fit the data they contain using the sizeHint from the delegate.

fitToColumns()

Fits the viewport to exactly show all the columns

fitToRows()

Fits the viewport to exactly show all the rows

fixSize(manual=False)

Resize everything as the user and program desires

Parameters

manual (bool) – True if this a manual resize being called by a script. If True, this forces the method to execute even if AutoResizing has been set to false.

focusInEvent(self, e: QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, e: QFocusEvent)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget
focusWidget(self) QWidget
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameRect(self) QRect
frameShadow(self) QFrame.Shadow
frameShape(self) QFrame.Shape
frameSize(self) QSize
frameStyle(self) int
frameWidth(self) int
geometry(self) QRect
grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) QPixmap
grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, a0: Union[QCursor, Qt.CursorShape]) None
grabShortcut(self, key: Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect
graphicsProxyWidget(self) QGraphicsProxyWidget
gridStyle(self) Qt.PenStyle
hasAutoScroll(self) bool
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
height(self) int
heightForWidth(self, a0: int) int
heightMM(self) int
hide(self)
hideColumn(self, column: int)
hideEvent(self, a0: QHideEvent)
hideRow(self, row: int)
horizontalHeader(self) QHeaderView
horizontalOffset(self) int
horizontalScrollBar(self) QScrollBar
horizontalScrollBarPolicy(self) Qt.ScrollBarPolicy
horizontalScrollMode(self) QAbstractItemView.ScrollMode
horizontalScrollbarAction(self, action: int)
horizontalScrollbarValueChanged(self, value: int)
iconSize(self) QSize
iconSizeChanged

iconSizeChanged(self, size: QSize) [signal]

indexAt(self, p: QPoint) QModelIndex
indexWidget(self, index: QModelIndex) QWidget
inherits(self, classname: str) bool
initPainter(self, painter: QPainter)
initStyleOption(self, option: QStyleOptionFrame)
initViewItemOption(self, option: QStyleOptionViewItem)
initiateCellSizes(rows=True, columns=True)

Sets all the cells to their intial default size

Parameters
  • rows (bool) – whether to set the rows to their default height

  • columns (bool) – whether to set the columns to their default width

inputMethodEvent(self, event: QInputMethodEvent)
inputMethodHints(self) Qt.InputMethodHint
inputMethodQuery(self, query: Qt.InputMethodQuery) Any
insertAction(self, before: QAction, action: QAction)
insertActions(self, before: QAction, actions: Iterable[QAction])
installEventFilter(self, a0: QObject)
isActiveWindow(self) bool
isActivelyScrolling()
isAncestorOf(self, child: QWidget) bool
isColumnGanged(column)

Returns True if column is ganged, False if not

Parameters

column (int) – the column to check for ganging

isColumnHidden(self, column: int) bool
isCornerButtonEnabled(self) bool
isEnabled(self) bool
isEnabledTo(self, a0: QWidget) bool
isFullScreen(self) bool
isHidden(self) bool
isIndexHidden(self, index: QModelIndex) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isPersistentEditorOpen(self, index: QModelIndex) bool
isRightToLeft(self) bool
isRowGanged(row)

Returns True if row is ganged, False if not

Parameters

row (int) – the row to check for ganging

isRowHidden(self, row: int) bool
isScrolling()
isSignalConnected(self, signal: QMetaMethod) bool
isSortingEnabled(self) bool
isVisible(self) bool
isVisibleTo(self, a0: QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
itemDelegate(self) QAbstractItemDelegate
itemDelegateForColumn(self, column: int) QAbstractItemDelegate
itemDelegateForIndex(self, index: QModelIndex) QAbstractItemDelegate
itemDelegateForRow(self, row: int) QAbstractItemDelegate
keyPressEvent(event)
Parameters

event (QKeyEvent) – The keypress event

Currently only does anything for Ctrl-C (copy to clipboard)

keyReleaseEvent(self, a0: QKeyEvent)
keyboardGrabber() QWidget
keyboardSearch(self, search: str)
killTimer(self, id: int)
layout(self) QLayout
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, a0: QEvent)
lineWidth(self) int
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self)
mapFrom(self, a0: QWidget, a1: QPoint) QPoint
mapFrom(self, a0: QWidget, a1: QPointF) QPointF
mapFromGlobal(self, a0: QPoint) QPoint
mapFromGlobal(self, a0: QPointF) QPointF
mapFromParent(self, a0: QPoint) QPoint
mapFromParent(self, a0: QPointF) QPointF
mapTo(self, a0: QWidget, a1: QPoint) QPoint
mapTo(self, a0: QWidget, a1: QPointF) QPointF
mapToGlobal(self, a0: QPoint) QPoint
mapToGlobal(self, a0: QPointF) QPointF
mapToParent(self, a0: QPoint) QPoint
mapToParent(self, a0: QPointF) QPointF
mask(self) QRegion
maximumHeight(self) int
maximumSize(self) QSize
maximumViewportSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject
metric(self, a0: QPaintDevice.PaintDeviceMetric) int
midLineWidth(self) int
minimumHeight(self) int
minimumSize(self) QSize
minimumSizeHint(self) QSize
minimumWidth(self) int
model(self) QAbstractItemModel
mouseDoubleClickEvent(self, e: QMouseEvent)
mouseGrabber() QWidget
mouseMoveEvent(self, e: QMouseEvent)
mousePressEvent(self, e: QMouseEvent)
mouseReleaseEvent(self, e: QMouseEvent)
move(self, a0: QPoint)
move(self, ax: int, ay: int) None
moveCursor(self, cursorAction: QAbstractItemView.CursorAction, modifiers: Qt.KeyboardModifier) QModelIndex
moveEvent(self, a0: QMoveEvent)
moveToThread(self, thread: QThread)
nativeEvent(self, eventType: QByteArray, message: PyQt6.sip.voidptr) Tuple[bool, PyQt6.sip.voidptr]
nativeParentWidget(self) QWidget
nextInFocusChain(self) QWidget
normalGeometry(self) QRect
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

openPersistentEditor(self, index: QModelIndex)
overrideWindowFlags(self, type: Qt.WindowType)
overrideWindowState(self, state: Qt.WindowState)
paintEngine(self) QPaintEngine
paintEvent(self, e: QPaintEvent)
paintingActive(self) bool
palette(self) QPalette
parent(self) QObject
parentWidget(self) QWidget
physicalDpiX(self) int
physicalDpiY(self) int
pos(self) QPoint
pressed

pressed(self, index: QModelIndex) [signal]

previousInFocusChain(self) QWidget
property(self, name: str) Any
pyqtConfigure(...)

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

raise_(self)
reEnableColumnResize()
receivers(self, signal: PYQT_SIGNAL) int
rect(self) QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id: int)
removeAction(self, action: QAction)
removeEventFilter(self, a0: QObject)
render(self, target: QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))
render(self, painter: QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) None
repaint(self)
repaint(self, x: int, y: int, w: int, h: int) None
repaint(self, a0: QRect) None
repaint(self, a0: QRegion) None
reset(self)
resetHorizontalScrollMode(self)
resetVerticalScrollMode(self)
resize(self, a0: QSize)
resize(self, w: int, h: int) None
resizeColumnToContents(self, column: int)
resizeColumnsToContents()

Resizes all the columns according to all the resize properties

resizeRowToContents(self, row: int)
restoreGeometry(self, geometry: QByteArray) bool
rootIndex(self) QModelIndex
rowAt(self, y: int) int
rowCountChanged(old_count, new_count)

Called when a row is added or deleted, and sets the rows to their initial size.

Parameters
  • old_count (int) – the old number of rows

  • new_count (int) – the num number of rows

rowHeight(self, row: int) int
rowMoved(self, row: int, oldIndex: int, newIndex: int)
rowResized(row, old_size, new_size, manual=False)

Resizes any cells that need to be resized when a row size is changed

Parameters
  • row (int) – the row number that changed

  • old_size (int) – the old size of the row

  • new_size (int) – the new size of the row

  • manual (bool) – True if this a manual resize being called by a script. If True, this forces the method to execute even if AutoResizing has been set to false.

rowSpan(self, row: int, column: int) int
rowViewportPosition(self, row: int) int
rowsAboutToBeRemoved(self, parent: QModelIndex, start: int, end: int)
rowsInserted(index, start, end)

Slot that receives a signal when rows are inserted in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the rows inserted

  • end (int) – The ending index of the rows inserted (inclusive)

rowsMoved(index1, start, end, index2, place)

Slot that receives a signal when rows are moved in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index1 (QModelIndex) – unused

  • start (int) – The starting index of the rows moved

  • end (int) – The ending index of the rows moved (inclusive)

  • index2 (QModelIndex) – unused

  • place (int) – The new starting index of the moved rows

rowsRemoved(index, start, end)

Slot that receives a signal when rows are removed in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the rows removed

  • end (int) – The ending index of the rows removed (inclusive)

saveGeometry(self) QByteArray
scheduleDelayedItemsLayout(self)
screen(self) QScreen
scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) None
scrollBarChanged(orientation)

A scrollbar has changed appearance, make sure we have the proper size

scrollBarWidgets(self, alignment: Qt.AlignmentFlag) List[QWidget]
scrollContentsBy(self, dx: int, dy: int)
scrollDirtyRegion(self, dx: int, dy: int)
scrollTo(self, index: QModelIndex, hint: QAbstractItemView.ScrollHint = QAbstractItemView.EnsureVisible)
scrollToBottom(self)
scrollToTop(self)
selectAll(self)
selectColumn(self, column: int)
selectRow(self, row: int)
selectedIndexes(self) List[QModelIndex]
selectionBehavior(self) QAbstractItemView.SelectionBehavior
selectionChanged(self, selected: QItemSelection, deselected: QItemSelection)
selectionCommand(self, index: QModelIndex, event: typing.Optional[QEvent] = None) QItemSelectionModel.SelectionFlag
selectionMode(self) QAbstractItemView.SelectionMode
selectionModel(self) QItemSelectionModel
sender(self) QObject
senderSignalIndex(self) int
setAcceptDrops(self, on: bool)
setAccessibleDescription(self, description: str)
setAccessibleName(self, name: str)
setAlternatingRowColors(self, enable: bool)
setAspectRatioPolicy(fixed, resize=True, policy_check=True)

Sets whether the cell aspect ratio is locked or not

Parameters
  • fixed (bool) – If True, cell aspect ratio is locked. If False, it is not

  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, enabled: bool)
setAutoScroll(self, enable: bool)
setAutoScrollMargin(self, margin: int)
setAutoSizing(state)

Turn the auto resizing of rows and column on or off. Normally this should be on (default), however, if multiple changes will be made and no resizing needs to be done until all changes are complete, then setting AutoSizing to False will save considerable time for large tables. Be sure to setAutoSizing(True) when finished so the table can adjust to the changes made.

Parameters

state (bool) – True if rows and columns should be resized automatically in response to table changes, False if not

setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) None
setColumnHidden(self, column: int, hide: bool)
setColumnIsGanged(column, is_ganged)

Sets a flag on column to indicate whether its size is ganged with other columns or not. Note that this has no effect if columns are not already ganged. This function should not be called if universal_column_gang_setting was set to True.

Parameters
  • column (int) – the column number this applies to

  • is_ganged (bool) – True if the column should be ganged, False if not

setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) None
setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)
setCornerButtonEnabled(self, enable: bool)
setCornerWidget(self, widget: QWidget)
setCurrentIndex(self, index: QModelIndex)
setCursor(self, a0: Union[QCursor, Qt.CursorShape])
setDefaultDropAction(self, dropAction: Qt.DropAction)
setDelegate(delegate)

Set the delegate for this table

Parameters

delegate (StructureDataViewerDelegate) – delegate that draws the data for this table

setDirtyRegion(self, region: QRegion)
setDisabled(self, a0: bool)
setDragDropMode(self, behavior: QAbstractItemView.DragDropMode)
setDragDropOverwriteMode(self, overwrite: bool)
setDragEnabled(self, enable: bool)
setDropIndicatorShown(self, enable: bool)
setEditTriggers(self, triggers: QAbstractItemView.EditTrigger)
setEnabled(self, a0: bool)
setFillPolicy(fill, resize=True, policy_check=True, enforce_scroll_bars=True)

Sets whether columns or rows should fill the viewport or not

Parameters
  • fill ("rows", "columns", "both" or "none") – The specified table feature will expand or contract to exactly fit within the table’s viewport. “both” means both rows and columns will expand, and “none” means neither will. fill cannot be “both” if aspect_ratio is True. Setting a feature to fill will turn off the corresponding scrollbar.

  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

  • enforce_scroll_bars (bool) – Whether to enforce the default scrollbar policy for fill settings

setFitViewPolicy(fit_view, resize=True, policy_check=True, enforce_scroll_bars=True)

Sets whether the viewport should be resized to the rows/columns or not

Parameters

fit_view ("rows", "columns", "both" or "none") – the table features that determine the size of the table’s viewport (the part visible to the user).

When this is turned on for a feature, the visible part of the table resizes dynamically to exactly fit that feature. For instance, if fit_view=’rows’, the visible part of the table will resize to exactly fit all the rows any time the size of a row changes.

  • “none” - neither rows nor columns determine the viewport size

  • “rows” - rows determine the viewport height

  • “columns” - columns determine the viewport width

  • “both” - both rows and columns determine the viewport size

Note - a feature that has fill turned on cannot have viewport_fit turned on. fill uses the size of the viewport to determine the size of the cells, while fit_view uses the sie of the cells to determine the size of the viewport.

Note 2 - Setting a feature to fit_view will turn off the corresponding scrollbar.

Note 3 - User resizing of rows with both gang and fit_view=’rows’ or ‘both’ tends to be a bit wonky because the amount the row resizes depends on the placement of the mouse relative to the table, and the table moves as it resizes to the rows, so you tend to get very large changes rapidly.

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

  • enforce_scroll_bars (bool) – Whether to enforce the default scrollbar policy for fit view settings

setFixedHeight(self, h: int)
setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) None
setFocus(self)
setFocus(self, reason: Qt.FocusReason) None
setFocusPolicy(self, policy: Qt.FocusPolicy)
setFocusProxy(self, a0: QWidget)
setFont(self, a0: QFont)
setForegroundRole(self, a0: QPalette.ColorRole)
setFrameRect(self, a0: QRect)
setFrameShadow(self, a0: QFrame.Shadow)
setFrameShape(self, a0: QFrame.Shape)
setFrameStyle(self, a0: int)
setGangPolicy(gang, resize=True, policy_check=True)

Sets whether the rows or columns are ganged or not

Parameters

gang ("rows", "columns", "both" or "none") – Controls whether rows and/or columns can be independently resized.

  • “none”: rows and columns can be independently resized

  • “rows”: rows are ganged so that changing the size of one row will change all the rows

  • “columns”: columns are ganged so that changing the size of one column will change all the columns

  • “both” - both rows and columns are ganged (default)

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies. Not used for this routine, but kept for consistency with other sizing policy routines

setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
setGraphicsEffect(self, effect: QGraphicsEffect)
setGridStyle(self, style: Qt.PenStyle)
setHidden(self, hidden: bool)
setHorizontalHeader(self, header: QHeaderView)
setHorizontalScrollBar(self, scrollbar: QScrollBar)
setHorizontalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setHorizontalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setIconSize(self, size: QSize)
setIndexWidget(self, index: QModelIndex, widget: QWidget)
setInputMethodHints(self, hints: Qt.InputMethodHint)
setItemDelegate(delegate)

Set the delegate for this table

Parameters

delegate (StructureDataViewerDelegate) – delegate that draws the data for this table

setItemDelegateForColumn(self, column: int, delegate: QAbstractItemDelegate)
setItemDelegateForRow(self, row: int, delegate: QAbstractItemDelegate)
setLayout(self, a0: QLayout)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLineWidth(self, a0: int)
setLocale(self, locale: QLocale)
setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) None
setMaximumHeight(self, maxh: int)
setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) None
setMaximumWidth(self, maxw: int)
setMidLineWidth(self, a0: int)
setMinimumHeight(self, minh: int)
setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) None
setMinimumWidth(self, minw: int)
setModel(self, model: QAbstractItemModel)
setMouseTracking(self, enable: bool)
setObjectName(self, name: str)
setPalette(self, a0: QPalette)
setParent(self, parent: QWidget)
setParent(self, parent: QWidget, f: Qt.WindowType) None
setProperty(self, name: str, value: Any) bool
setResizablePolicy(resizable, resize=True, policy_check=True)

Sets whether the rows/columns can be resized by the user

Parameters

resizable ("rows", "columns", "both" or "none") – the table features that can be resized by the user.

  • “none” - neither rows nor columns can be resized by the user

  • “rows” - rows can be resized by the user

  • “columns” - columns can be resized by the user

  • “both” - both rows and columns can be resized by the user (default)

Note - a feature that has fill turned on cannot be resized by the user, and if fill is turned on and aspect_ratio is True, neither rows nor columns can be resized by the user.

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

setRootIndex(self, index: QModelIndex)
setRowHeight(self, row: int, height: int)
setRowHidden(self, row: int, hide: bool)
setRowIsGanged(row, is_ganged)

Sets a flag on row to indicate whether its size is ganged with other rows or not. Note that this has no effect if rows are not already ganged. This function should not be called if universal_row_gang_settings was set to True.

Parameters
  • row (int) – the row number this applies to

  • is_ganged (bool) – True if the row should be ganged, False if not

setScreen(self, a0: QScreen)
setSelection(self, rect: QRect, command: QItemSelectionModel.SelectionFlag)
setSelectionBehavior(self, behavior: QAbstractItemView.SelectionBehavior)
setSelectionMode(self, mode: QAbstractItemView.SelectionMode)
setSelectionModel(self, selectionModel: QItemSelectionModel)
setShortcutAutoRepeat(self, id: int, enabled: bool = True)
setShortcutEnabled(self, id: int, enabled: bool = True)
setShowGrid(self, show: bool)
setSizeAdjustPolicy(self, policy: QAbstractScrollArea.SizeAdjustPolicy)
setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) None
setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
setSortingEnabled(sorting)

Sets sorting enabled

Parameters

sorting (bool) – If True, sorting is enabled

setSpan(self, row: int, column: int, rowSpan: int, columnSpan: int)
setState(self, state: QAbstractItemView.State)
setStatusTip(self, a0: str)
setStyle(self, a0: QStyle)
setStyleSheet(self, styleSheet: str)
setTabKeyNavigation(self, enable: bool)
setTabOrder(a0: QWidget, a1: QWidget)
setTabletTracking(self, enable: bool)
setTextElideMode(self, mode: Qt.TextElideMode)
setToolTip(self, a0: str)
setToolTipDuration(self, msec: int)
setToolTipSize(width, height)
Parameters
  • width (int) – width in pixels of tooltip

  • height (int) – height in pixels of tooltip

setUpdatesEnabled(self, enable: bool)
setVerticalHeader(self, header: QHeaderView)
setVerticalScrollBar(self, scrollbar: QScrollBar)
setVerticalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setVerticalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setViewport(self, widget: QWidget)
setViewportMargins(self, left: int, top: int, right: int, bottom: int)
setViewportMargins(self, margins: QMargins) None
setVisible(self, visible: bool)
setWhatsThis(self, a0: str)
setWindowFilePath(self, filePath: str)
setWindowFlag(self, a0: Qt.WindowType, on: bool = True)
setWindowFlags(self, type: Qt.WindowType)
setWindowIcon(self, icon: QIcon)
setWindowIconText(self, a0: str)
setWindowModality(self, windowModality: Qt.WindowModality)
setWindowModified(self, a0: bool)
setWindowOpacity(self, level: float)
setWindowRole(self, a0: str)
setWindowState(self, state: Qt.WindowState)
setWindowTitle(self, a0: str)
setWordWrap(self, on: bool)
setupViewport(self, viewport: QWidget)
sharedPainter(self) QPainter
show(self)
showColumn(self, column: int)
showDropIndicator(self) bool
showEvent(self, a0: QShowEvent)
showFullScreen(self)
showGrid(self) bool
showMaximized(self)
showMinimized(self)
showNormal(self)
showRow(self, row: int)
signalsBlocked(self) bool
size(self) QSize
sizeAdjustPolicy(self) QAbstractScrollArea.SizeAdjustPolicy
sizeHint(self) QSize
sizeHintForColumn(column)

This method gives the size hints for columns - its existance means that the resizeColumnsToContents() method uses this hint rather than hints from the delegate.

Parameters

column (int) – the column we want a size hint for

Return type

int

Returns

the size hint for column

sizeHintForIndex(self, index: QModelIndex) QSize
sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
sortByColumn(self, column: int, order: Qt.SortOrder)
stackUnder(self, a0: QWidget)
startDrag(self, supportedActions: Qt.DropAction)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
state(self) QAbstractItemView.State
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
statusTip(self) str
style(self) QStyle
styleSheet(self) str
tabKeyNavigation(self) bool
tabletEvent(self, a0: QTabletEvent)
testAttribute(self, attribute: Qt.WidgetAttribute) bool
textElideMode(self) Qt.TextElideMode
thread(self) QThread
timerEvent(self, event: QTimerEvent)
toolTip(self) str
toolTipDuration(self) int
totalColumnWidth()

The sum of the widths of all the columns

Return type

int

Returns

the sum of all the column widths

totalRowHeight()

The sum of the heights of all the rows

Return type

int

Returns

the sum of all the row heights

tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
underMouse(self) bool
ungrabGesture(self, type: Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, index: QModelIndex) None
updateEditorData(self)
updateEditorGeometries(self)
updateGeometries(self)
updateGeometry(self)
updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)
updatesEnabled(self) bool
verticalHeader(self) QHeaderView
verticalOffset(self) int
verticalScrollBar(self) QScrollBar
verticalScrollBarPolicy(self) Qt.ScrollBarPolicy
verticalScrollMode(self) QAbstractItemView.ScrollMode
verticalScrollbarAction(self, action: int)
verticalScrollbarValueChanged(self, value: int)
viewport(self) QWidget
viewportEntered

viewportEntered(self) [signal]

viewportEvent(self, e: QEvent) bool
viewportMargins(self) QMargins
viewportSizeHint(self) QSize
visibleRegion(self) QRegion
visualRect(self, index: QModelIndex) QRect
visualRegionForSelection(self, selection: QItemSelection) QRegion
whatsThis(self) str
wheelEvent(self, a0: QWheelEvent)
width(self) int
widthMM(self) int
winId(self) PyQt6.sip.voidptr
window(self) QWidget
windowFilePath(self) str
windowFlags(self) Qt.WindowType
windowHandle(self) QWindow
windowIcon(self) QIcon
windowIconChanged

windowIconChanged(self, icon: QIcon) [signal]

windowIconText(self) str
windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowState
windowTitle(self) str
windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) Qt.WindowType
wordWrap(self) bool
x(self) int
y(self) int
auto_size

Whether the table should automatically resize in response to changes

class schrodinger.ui.qt.table.VSubDataViewerTable(model, master_table, **kwarg)

Bases: schrodinger.ui.qt.table.DataViewerTable

__init__(model, master_table, **kwarg)

Sub-table for a vertically stacked table.

Parameters

master_table (DataViewerTable) – the table that controls this one (the upper table in a vertically stacked pair of tables).

All other parameters are documented in DataViewerTable class.

initiateCellSizes(rows=True, columns=True)

Sets all the cells to their intial default size

Parameters
  • rows (bool) – whether to set the rows to their default height

  • columns (bool) – whether to set the columns to their default width

columnsInserted(index, start, end)

Slot that receives a signal when columns are inserted in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the columns inserted

  • end (int) – The ending index of the columns inserted (inclusive)

columnsRemoved(index, start, end)

Slot that receives a signal when columns are removed in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the columns removed

  • end (int) – The ending index of the columns removed (inclusive)

columnCountChanged(old_count, new_count)

Called when a column is added or deleted, and sets the columns to their initial size.

Parameters
  • old_count (int) – the old number of columns

  • new_count (int) – the num number of columns

rowResized(row, old_size, new_size)

Resizes any cells that need to be resized when a row size is changed

Parameters
  • row (int) – the row number that changed

  • old_size (int) – the old size of the row

  • new_size (int) – the new size of the row

columnResized(column, old_size, new_size)

Doesn’t do anything - let the master table take care of this

Parameters
  • column (int) – the column number that changed

  • old_size (int) – the old size of the column

  • new_size (int) – the new size of the column

fitToRows()

Fits the viewport to exactly show all the rows - master table does this

fitToColumns()

Fits the viewport to exactly show all the columns - master table does this

scrollBarChanged(orientation)

A scrollbar has changed appearance, make sure we have the proper size

fixSize()

Resize everything as the user and program desires

fitCellsToData()

Resizes rows and columns to fit the data they contain using the sizeHint from the delegate

fitRowsToData()

Resizes all the rows to fit the data they contain using the sizeHint from the delegate.

fitRowToData(row)

Resizes row to the largest sizeHint of any of its cells. Uses the sizeHint of the delegate.

Parameters

row (int) – the row of interest

fitColumnsToData()

Resizes all the columns to fit the data they contain using the sizeHint from the delegate. Master table does this.

fitColumnToData(column)

Resizes column to the largest sizeHint of any of its cells. Uses the sizeHint of the delegate. Master table does this.

Parameters

column (int) – the column of interest

resizeRowsToContents()

Resizes all the rows according to all the resize properties

resizeColumnsToContents()

Resizes all the columns according to all the resize properties. Master table does this.

resizeEvent(event)

Called when the viewport changes size. Changes the size of any cells that need to be changed in response to this - typically because fill has been set on rows or columns.

Parameters

event (QEvent) – the event that occured

sizeHintForColumn(column)

This method gives the size hints for columns - its existance means that the resizeColumnsToContents() method uses this hint rather than hints from the delegate.

Parameters

column (int) – the column we want a size hint for

Return type

int

Returns

the size hint for column

sizeHintForRow(row)

This method gives the size hints for rows - its existance means that the resizeRowsToContents() method uses this hint rather than hints from the delegate.

Parameters

row (int) – the row we want a size hint for

Return type

int

Returns

the size hint for row

AboveItem = 1
AdjustIgnored = 0
AdjustToContents = 2
AdjustToContentsOnFirstShow = 1
AllEditTriggers = 31
AnimatingState = 6
AnyKeyPressed = 16
BelowItem = 2
Box = 1
CollapsingState = 5
ContiguousSelection = 4
CurrentChanged = 1
class CursorAction(value)

Bases: enum.Enum

An enumeration.

MoveUp = 0
MoveDown = 1
MoveLeft = 2
MoveRight = 3
MoveHome = 4
MoveEnd = 5
MovePageUp = 6
MovePageDown = 7
MoveNext = 8
MovePrevious = 9
DoubleClicked = 2
DragDrop = 3
class DragDropMode(value)

Bases: enum.Enum

An enumeration.

NoDragDrop = 0
DragOnly = 1
DropOnly = 2
DragDrop = 3
InternalMove = 4
DragOnly = 1
DragSelectingState = 2
DraggingState = 1
DrawChildren = 2
DrawWindowBackground = 1
class DropIndicatorPosition(value)

Bases: enum.Enum

An enumeration.

OnItem = 0
AboveItem = 1
BelowItem = 2
OnViewport = 3
DropOnly = 2
EditKeyPressed = 8
class EditTrigger(value)

Bases: enum.Flag

An enumeration.

NoEditTriggers = 0
CurrentChanged = 1
DoubleClicked = 2
SelectedClicked = 4
EditKeyPressed = 8
AnyKeyPressed = 16
AllEditTriggers = 31
EditingState = 3
EnsureVisible = 0
ExpandingState = 4
ExtendedSelection = 3
HLine = 4
IgnoreMask = 4
InternalMove = 4
MoveDown = 1
MoveEnd = 5
MoveHome = 4
MoveLeft = 2
MoveNext = 8
MovePageDown = 7
MovePageUp = 6
MovePrevious = 9
MoveRight = 3
MoveUp = 0
MultiSelection = 2
NoDragDrop = 0
NoEditTriggers = 0
NoFrame = 0
NoSelection = 0
NoState = 0
OnItem = 0
OnViewport = 3
class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1
PdmHeight = 2
PdmWidthMM = 3
PdmHeightMM = 4
PdmNumColors = 5
PdmDepth = 6
PdmDpiX = 7
PdmDpiY = 8
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
Panel = 2
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
Plain = 16
PositionAtBottom = 2
PositionAtCenter = 3
PositionAtTop = 1
Raised = 32
class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1
DrawChildren = 2
IgnoreMask = 4
class ScrollHint(value)

Bases: enum.Enum

An enumeration.

EnsureVisible = 0
PositionAtTop = 1
PositionAtBottom = 2
PositionAtCenter = 3
class ScrollMode(value)

Bases: enum.Enum

An enumeration.

ScrollPerItem = 0
ScrollPerPixel = 1
ScrollPerItem = 0
ScrollPerPixel = 1
SelectColumns = 2
SelectItems = 0
SelectRows = 1
SelectedClicked = 4
class SelectionBehavior(value)

Bases: enum.Enum

An enumeration.

SelectItems = 0
SelectRows = 1
SelectColumns = 2
class SelectionMode(value)

Bases: enum.Enum

An enumeration.

NoSelection = 0
SingleSelection = 1
MultiSelection = 2
ExtendedSelection = 3
ContiguousSelection = 4
class Shadow(value)

Bases: enum.IntEnum

An enumeration.

Plain = 16
Raised = 32
Sunken = 48
Shadow_Mask = 240
class Shape(value)

Bases: enum.IntEnum

An enumeration.

NoFrame = 0
Box = 1
Panel = 2
WinPanel = 3
HLine = 4
VLine = 5
StyledPanel = 6
Shape_Mask = 15
SingleSelection = 1
class SizeAdjustPolicy(value)

Bases: enum.Enum

An enumeration.

AdjustIgnored = 0
AdjustToContentsOnFirstShow = 1
AdjustToContents = 2
class State(value)

Bases: enum.Enum

An enumeration.

NoState = 0
DraggingState = 1
DragSelectingState = 2
EditingState = 3
ExpandingState = 4
CollapsingState = 5
AnimatingState = 6
class StyleMask(value)

Bases: enum.Enum

An enumeration.

Shadow_Mask = 240
Shape_Mask = 15
StyledPanel = 6
Sunken = 48
VLine = 5
WinPanel = 3
acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, a0: QActionEvent)
actions(self) List[QAction]
activateWindow(self)
activated

activated(self, index: QModelIndex) [signal]

addAction(self, action: QAction)
addActions(self, actions: Iterable[QAction])
addScrollBarWidget(self, widget: QWidget, alignment: Qt.AlignmentFlag)
adjustSize(self)
alternatingRowColors(self) bool
autoFillBackground(self) bool
autoScrollMargin(self) int
averageGangedColumnWidth()

This routine has been changed to return the MOST COMMON non-zero width of all the ganged columns

Return type

int

Returns

the most common integer average column width, or the default width if there are no non-zero ganged columns

averageGangedRowHeight()

This routine has been changed to return the MOST COMMON non-zero height of all the ganged rows

Return type

int

Returns

the most common integer average row height, or the default height if there are no non-zero ganged rows

backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, b: bool) bool
changeEvent(self, a0: QEvent)
checkSizingPolicies()

Raises a ValueError if we have conflicting sizing policies

childAt(self, p: QPoint) QWidget
childAt(self, ax: int, ay: int) QWidget
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
clearSelection(self)
clearSpans(self)
clicked

clicked(self, index: QModelIndex) [signal]

close(self) bool
closeEditor(self, editor: QWidget, hint: QAbstractItemDelegate.EndEditHint)
closeEvent(self, a0: QCloseEvent)
closePersistentEditor(self, index: QModelIndex)
colorCount(self) int
columnAt(self, x: int) int
columnMoved(self, column: int, oldIndex: int, newIndex: int)
columnSpan(self, row: int, column: int) int
columnViewportPosition(self, column: int) int
columnWidth(self, column: int) int
columnsMoved(index1, start, end, index2, place)

Slot that receives a signal when columns are moved in the model. Make sure our column_is_ganged list stays current.

Parameters
  • index1 (QModelIndex) – unused

  • start (int) – The starting index of the columns moved

  • end (int) – The ending index of the columns moved (inclusive)

  • index2 (QModelIndex) – unused

  • place (int) – The new starting index of the moved columns

commitData(self, editor: QWidget)
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, a0: QContextMenuEvent)
contextMenuPolicy(self) Qt.ContextMenuPolicy
copyImageToClipboard()

Copy an image of the table to the clipboard

cornerWidget(self) QWidget
create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(window: QWindow, parent: typing.Optional[QWidget] = None, flags: Qt.WindowType = Qt.WindowFlags()) QWidget
currentChanged(self, current: QModelIndex, previous: QModelIndex)
currentIndex(self) QModelIndex
cursor(self) QCursor
customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)
dataChanged(self, topLeft: QModelIndex, bottomRight: QModelIndex, roles: Iterable[int] = [])
defaultDropAction(self) Qt.DropAction
deleteLater(self)
depth(self) int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

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

devType(self) int
devicePixelRatio(self) float
devicePixelRatioF(self) float
devicePixelRatioFScale() float
dirtyRegionOffset(self) QPoint
disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
doubleClicked

doubleClicked(self, index: QModelIndex) [signal]

dragDropMode(self) QAbstractItemView.DragDropMode
dragDropOverwriteMode(self) bool
dragEnabled(self) bool
dragEnterEvent(self, e: QDragEnterEvent)
dragLeaveEvent(self, e: QDragLeaveEvent)
dragMoveEvent(self, e: QDragMoveEvent)
drawFrame(self, a0: QPainter)
dropEvent(self, e: QDropEvent)
dropIndicatorPosition(self) QAbstractItemView.DropIndicatorPosition
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
edit(self, index: QModelIndex)
edit(self, index: QModelIndex, trigger: QAbstractItemView.EditTrigger, event: QEvent) bool
editTriggers(self) QAbstractItemView.EditTrigger
editorDestroyed(self, editor: QObject)
effectiveWinId(self) PyQt6.sip.voidptr
enforceScrollBarPolicies()

Sets the scrollbar policies as required by the sizing policies

ensurePolished(self)
enterEvent(self, event: QEnterEvent)
entered

entered(self, index: QModelIndex) [signal]

event(self, event: QEvent) bool
eventFilter(self, object: QObject, event: QEvent) bool
executeDelayedItemsLayout(self)
find(a0: PyQt6.sip.voidptr) QWidget
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
focusInEvent(self, e: QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, e: QFocusEvent)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget
focusWidget(self) QWidget
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameRect(self) QRect
frameShadow(self) QFrame.Shadow
frameShape(self) QFrame.Shape
frameSize(self) QSize
frameStyle(self) int
frameWidth(self) int
geometry(self) QRect
grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) QPixmap
grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, a0: Union[QCursor, Qt.CursorShape]) None
grabShortcut(self, key: Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect
graphicsProxyWidget(self) QGraphicsProxyWidget
gridStyle(self) Qt.PenStyle
hasAutoScroll(self) bool
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
headerClicked(col)
height(self) int
heightForWidth(self, a0: int) int
heightMM(self) int
hide(self)
hideColumn(self, column: int)
hideEvent(self, a0: QHideEvent)
hideRow(self, row: int)
horizontalHeader(self) QHeaderView
horizontalOffset(self) int
horizontalScrollBar(self) QScrollBar
horizontalScrollBarPolicy(self) Qt.ScrollBarPolicy
horizontalScrollMode(self) QAbstractItemView.ScrollMode
horizontalScrollbarAction(self, action: int)
horizontalScrollbarValueChanged(self, value: int)
iconSize(self) QSize
iconSizeChanged

iconSizeChanged(self, size: QSize) [signal]

indexAt(self, p: QPoint) QModelIndex
indexWidget(self, index: QModelIndex) QWidget
inherits(self, classname: str) bool
initPainter(self, painter: QPainter)
initStyleOption(self, option: QStyleOptionFrame)
initViewItemOption(self, option: QStyleOptionViewItem)
inputMethodEvent(self, event: QInputMethodEvent)
inputMethodHints(self) Qt.InputMethodHint
inputMethodQuery(self, query: Qt.InputMethodQuery) Any
insertAction(self, before: QAction, action: QAction)
insertActions(self, before: QAction, actions: Iterable[QAction])
installEventFilter(self, a0: QObject)
isActiveWindow(self) bool
isActivelyScrolling()
isAncestorOf(self, child: QWidget) bool
isColumnGanged(column)

Returns True if column is ganged, False if not

Parameters

column (int) – the column to check for ganging

isColumnHidden(self, column: int) bool
isCornerButtonEnabled(self) bool
isEnabled(self) bool
isEnabledTo(self, a0: QWidget) bool
isFullScreen(self) bool
isHidden(self) bool
isIndexHidden(self, index: QModelIndex) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isPersistentEditorOpen(self, index: QModelIndex) bool
isRightToLeft(self) bool
isRowGanged(row)

Returns True if row is ganged, False if not

Parameters

row (int) – the row to check for ganging

isRowHidden(self, row: int) bool
isScrolling()
isSignalConnected(self, signal: QMetaMethod) bool
isSortingEnabled(self) bool
isVisible(self) bool
isVisibleTo(self, a0: QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
itemDelegate(self) QAbstractItemDelegate
itemDelegateForColumn(self, column: int) QAbstractItemDelegate
itemDelegateForIndex(self, index: QModelIndex) QAbstractItemDelegate
itemDelegateForRow(self, row: int) QAbstractItemDelegate
keyPressEvent(event)
Parameters

event (QKeyEvent) – The keypress event

Currently only does anything for Ctrl-C (copy to clipboard)

keyReleaseEvent(self, a0: QKeyEvent)
keyboardGrabber() QWidget
keyboardSearch(self, search: str)
killTimer(self, id: int)
layout(self) QLayout
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, a0: QEvent)
lineWidth(self) int
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self)
mapFrom(self, a0: QWidget, a1: QPoint) QPoint
mapFrom(self, a0: QWidget, a1: QPointF) QPointF
mapFromGlobal(self, a0: QPoint) QPoint
mapFromGlobal(self, a0: QPointF) QPointF
mapFromParent(self, a0: QPoint) QPoint
mapFromParent(self, a0: QPointF) QPointF
mapTo(self, a0: QWidget, a1: QPoint) QPoint
mapTo(self, a0: QWidget, a1: QPointF) QPointF
mapToGlobal(self, a0: QPoint) QPoint
mapToGlobal(self, a0: QPointF) QPointF
mapToParent(self, a0: QPoint) QPoint
mapToParent(self, a0: QPointF) QPointF
mask(self) QRegion
maximumHeight(self) int
maximumSize(self) QSize
maximumViewportSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject
metric(self, a0: QPaintDevice.PaintDeviceMetric) int
midLineWidth(self) int
minimumHeight(self) int
minimumSize(self) QSize
minimumSizeHint(self) QSize
minimumWidth(self) int
model(self) QAbstractItemModel
mouseDoubleClickEvent(self, e: QMouseEvent)
mouseGrabber() QWidget
mouseMoveEvent(self, e: QMouseEvent)
mousePressEvent(self, e: QMouseEvent)
mouseReleaseEvent(self, e: QMouseEvent)
move(self, a0: QPoint)
move(self, ax: int, ay: int) None
moveCursor(self, cursorAction: QAbstractItemView.CursorAction, modifiers: Qt.KeyboardModifier) QModelIndex
moveEvent(self, a0: QMoveEvent)
moveToThread(self, thread: QThread)
nativeEvent(self, eventType: QByteArray, message: PyQt6.sip.voidptr) Tuple[bool, PyQt6.sip.voidptr]
nativeParentWidget(self) QWidget
nextInFocusChain(self) QWidget
normalGeometry(self) QRect
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

openPersistentEditor(self, index: QModelIndex)
overrideWindowFlags(self, type: Qt.WindowType)
overrideWindowState(self, state: Qt.WindowState)
paintEngine(self) QPaintEngine
paintEvent(self, e: QPaintEvent)
paintingActive(self) bool
palette(self) QPalette
parent(self) QObject
parentWidget(self) QWidget
physicalDpiX(self) int
physicalDpiY(self) int
pos(self) QPoint
pressed

pressed(self, index: QModelIndex) [signal]

previousInFocusChain(self) QWidget
property(self, name: str) Any
pyqtConfigure(...)

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

raise_(self)
reEnableColumnResize()
receivers(self, signal: PYQT_SIGNAL) int
rect(self) QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id: int)
removeAction(self, action: QAction)
removeEventFilter(self, a0: QObject)
render(self, target: QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))
render(self, painter: QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) None
repaint(self)
repaint(self, x: int, y: int, w: int, h: int) None
repaint(self, a0: QRect) None
repaint(self, a0: QRegion) None
reset(self)
resetHorizontalScrollMode(self)
resetVerticalScrollMode(self)
resize(self, a0: QSize)
resize(self, w: int, h: int) None
resizeColumnToContents(self, column: int)
resizeRowToContents(self, row: int)
restoreGeometry(self, geometry: QByteArray) bool
rootIndex(self) QModelIndex
rowAt(self, y: int) int
rowCountChanged(old_count, new_count)

Called when a row is added or deleted, and sets the rows to their initial size.

Parameters
  • old_count (int) – the old number of rows

  • new_count (int) – the num number of rows

rowHeight(self, row: int) int
rowMoved(self, row: int, oldIndex: int, newIndex: int)
rowSpan(self, row: int, column: int) int
rowViewportPosition(self, row: int) int
rowsAboutToBeRemoved(self, parent: QModelIndex, start: int, end: int)
rowsInserted(index, start, end)

Slot that receives a signal when rows are inserted in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the rows inserted

  • end (int) – The ending index of the rows inserted (inclusive)

rowsMoved(index1, start, end, index2, place)

Slot that receives a signal when rows are moved in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index1 (QModelIndex) – unused

  • start (int) – The starting index of the rows moved

  • end (int) – The ending index of the rows moved (inclusive)

  • index2 (QModelIndex) – unused

  • place (int) – The new starting index of the moved rows

rowsRemoved(index, start, end)

Slot that receives a signal when rows are removed in the model. Make sure our row_is_ganged list stays current.

Parameters
  • index (QModelIndex) – unused

  • start (int) – The starting index of the rows removed

  • end (int) – The ending index of the rows removed (inclusive)

saveGeometry(self) QByteArray
scheduleDelayedItemsLayout(self)
screen(self) QScreen
scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) None
scrollBarWidgets(self, alignment: Qt.AlignmentFlag) List[QWidget]
scrollContentsBy(self, dx: int, dy: int)
scrollDirtyRegion(self, dx: int, dy: int)
scrollTo(self, index: QModelIndex, hint: QAbstractItemView.ScrollHint = QAbstractItemView.EnsureVisible)
scrollToBottom(self)
scrollToTop(self)
selectAll(self)
selectColumn(self, column: int)
selectRow(self, row: int)
selectedIndexes(self) List[QModelIndex]
selectionBehavior(self) QAbstractItemView.SelectionBehavior
selectionChanged(self, selected: QItemSelection, deselected: QItemSelection)
selectionCommand(self, index: QModelIndex, event: typing.Optional[QEvent] = None) QItemSelectionModel.SelectionFlag
selectionMode(self) QAbstractItemView.SelectionMode
selectionModel(self) QItemSelectionModel
sender(self) QObject
senderSignalIndex(self) int
setAcceptDrops(self, on: bool)
setAccessibleDescription(self, description: str)
setAccessibleName(self, name: str)
setAlternatingRowColors(self, enable: bool)
setAspectRatioPolicy(fixed, resize=True, policy_check=True)

Sets whether the cell aspect ratio is locked or not

Parameters
  • fixed (bool) – If True, cell aspect ratio is locked. If False, it is not

  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, enabled: bool)
setAutoScroll(self, enable: bool)
setAutoScrollMargin(self, margin: int)
setAutoSizing(state)

Turn the auto resizing of rows and column on or off. Normally this should be on (default), however, if multiple changes will be made and no resizing needs to be done until all changes are complete, then setting AutoSizing to False will save considerable time for large tables. Be sure to setAutoSizing(True) when finished so the table can adjust to the changes made.

Parameters

state (bool) – True if rows and columns should be resized automatically in response to table changes, False if not

setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) None
setColumnHidden(self, column: int, hide: bool)
setColumnIsGanged(column, is_ganged)

Sets a flag on column to indicate whether its size is ganged with other columns or not. Note that this has no effect if columns are not already ganged. This function should not be called if universal_column_gang_setting was set to True.

Parameters
  • column (int) – the column number this applies to

  • is_ganged (bool) – True if the column should be ganged, False if not

setColumnWidth(self, column: int, width: int)
setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) None
setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)
setCornerButtonEnabled(self, enable: bool)
setCornerWidget(self, widget: QWidget)
setCurrentIndex(self, index: QModelIndex)
setCursor(self, a0: Union[QCursor, Qt.CursorShape])
setDefaultDropAction(self, dropAction: Qt.DropAction)
setDelegate(delegate)

Set the delegate for this table

Parameters

delegate (StructureDataViewerDelegate) – delegate that draws the data for this table

setDirtyRegion(self, region: QRegion)
setDisabled(self, a0: bool)
setDragDropMode(self, behavior: QAbstractItemView.DragDropMode)
setDragDropOverwriteMode(self, overwrite: bool)
setDragEnabled(self, enable: bool)
setDropIndicatorShown(self, enable: bool)
setEditTriggers(self, triggers: QAbstractItemView.EditTrigger)
setEnabled(self, a0: bool)
setFillPolicy(fill, resize=True, policy_check=True, enforce_scroll_bars=True)

Sets whether columns or rows should fill the viewport or not

Parameters
  • fill ("rows", "columns", "both" or "none") – The specified table feature will expand or contract to exactly fit within the table’s viewport. “both” means both rows and columns will expand, and “none” means neither will. fill cannot be “both” if aspect_ratio is True. Setting a feature to fill will turn off the corresponding scrollbar.

  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

  • enforce_scroll_bars (bool) – Whether to enforce the default scrollbar policy for fill settings

setFitViewPolicy(fit_view, resize=True, policy_check=True, enforce_scroll_bars=True)

Sets whether the viewport should be resized to the rows/columns or not

Parameters

fit_view ("rows", "columns", "both" or "none") – the table features that determine the size of the table’s viewport (the part visible to the user).

When this is turned on for a feature, the visible part of the table resizes dynamically to exactly fit that feature. For instance, if fit_view=’rows’, the visible part of the table will resize to exactly fit all the rows any time the size of a row changes.

  • “none” - neither rows nor columns determine the viewport size

  • “rows” - rows determine the viewport height

  • “columns” - columns determine the viewport width

  • “both” - both rows and columns determine the viewport size

Note - a feature that has fill turned on cannot have viewport_fit turned on. fill uses the size of the viewport to determine the size of the cells, while fit_view uses the sie of the cells to determine the size of the viewport.

Note 2 - Setting a feature to fit_view will turn off the corresponding scrollbar.

Note 3 - User resizing of rows with both gang and fit_view=’rows’ or ‘both’ tends to be a bit wonky because the amount the row resizes depends on the placement of the mouse relative to the table, and the table moves as it resizes to the rows, so you tend to get very large changes rapidly.

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

  • enforce_scroll_bars (bool) – Whether to enforce the default scrollbar policy for fit view settings

setFixedHeight(self, h: int)
setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int)
setFocus(self)
setFocus(self, reason: Qt.FocusReason) None
setFocusPolicy(self, policy: Qt.FocusPolicy)
setFocusProxy(self, a0: QWidget)
setFont(self, a0: QFont)
setForegroundRole(self, a0: QPalette.ColorRole)
setFrameRect(self, a0: QRect)
setFrameShadow(self, a0: QFrame.Shadow)
setFrameShape(self, a0: QFrame.Shape)
setFrameStyle(self, a0: int)
setGangPolicy(gang, resize=True, policy_check=True)

Sets whether the rows or columns are ganged or not

Parameters

gang ("rows", "columns", "both" or "none") – Controls whether rows and/or columns can be independently resized.

  • “none”: rows and columns can be independently resized

  • “rows”: rows are ganged so that changing the size of one row will change all the rows

  • “columns”: columns are ganged so that changing the size of one column will change all the columns

  • “both” - both rows and columns are ganged (default)

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies. Not used for this routine, but kept for consistency with other sizing policy routines

setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
setGraphicsEffect(self, effect: QGraphicsEffect)
setGridStyle(self, style: Qt.PenStyle)
setHidden(self, hidden: bool)
setHorizontalHeader(self, header: QHeaderView)
setHorizontalScrollBar(self, scrollbar: QScrollBar)
setHorizontalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setHorizontalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setIconSize(self, size: QSize)
setIndexWidget(self, index: QModelIndex, widget: QWidget)
setInputMethodHints(self, hints: Qt.InputMethodHint)
setItemDelegate(delegate)

Set the delegate for this table

Parameters

delegate (StructureDataViewerDelegate) – delegate that draws the data for this table

setItemDelegateForColumn(self, column: int, delegate: QAbstractItemDelegate)
setItemDelegateForRow(self, row: int, delegate: QAbstractItemDelegate)
setLayout(self, a0: QLayout)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLineWidth(self, a0: int)
setLocale(self, locale: QLocale)
setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) None
setMaximumHeight(self, maxh: int)
setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) None
setMaximumWidth(self, maxw: int)
setMidLineWidth(self, a0: int)
setMinimumHeight(self, minh: int)
setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) None
setMinimumWidth(self, minw: int)
setModel(self, model: QAbstractItemModel)
setMouseTracking(self, enable: bool)
setObjectName(self, name: str)
setPalette(self, a0: QPalette)
setParent(self, parent: QWidget)
setParent(self, parent: QWidget, f: Qt.WindowType) None
setProperty(self, name: str, value: Any) bool
setResizablePolicy(resizable, resize=True, policy_check=True)

Sets whether the rows/columns can be resized by the user

Parameters

resizable ("rows", "columns", "both" or "none") – the table features that can be resized by the user.

  • “none” - neither rows nor columns can be resized by the user

  • “rows” - rows can be resized by the user

  • “columns” - columns can be resized by the user

  • “both” - both rows and columns can be resized by the user (default)

Note - a feature that has fill turned on cannot be resized by the user, and if fill is turned on and aspect_ratio is True, neither rows nor columns can be resized by the user.

Parameters
  • resize (bool) – Whether to resize the table

  • policy_check (bool) – Whether to check for conflicting sizing policies.

setRootIndex(self, index: QModelIndex)
setRowHeight(self, row: int, height: int)
setRowHidden(self, row: int, hide: bool)
setRowIsGanged(row, is_ganged)

Sets a flag on row to indicate whether its size is ganged with other rows or not. Note that this has no effect if rows are not already ganged. This function should not be called if universal_row_gang_settings was set to True.

Parameters
  • row (int) – the row number this applies to

  • is_ganged (bool) – True if the row should be ganged, False if not

setScreen(self, a0: QScreen)
setSelection(self, rect: QRect, command: QItemSelectionModel.SelectionFlag)
setSelectionBehavior(self, behavior: QAbstractItemView.SelectionBehavior)
setSelectionMode(self, mode: QAbstractItemView.SelectionMode)
setSelectionModel(self, selectionModel: QItemSelectionModel)
setShortcutAutoRepeat(self, id: int, enabled: bool = True)
setShortcutEnabled(self, id: int, enabled: bool = True)
setShowGrid(self, show: bool)
setSizeAdjustPolicy(self, policy: QAbstractScrollArea.SizeAdjustPolicy)
setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) None
setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
setSortingEnabled(sorting)

Sets sorting enabled

Parameters

sorting (bool) – If True, sorting is enabled

setSpan(self, row: int, column: int, rowSpan: int, columnSpan: int)
setState(self, state: QAbstractItemView.State)
setStatusTip(self, a0: str)
setStyle(self, a0: QStyle)
setStyleSheet(self, styleSheet: str)
setTabKeyNavigation(self, enable: bool)
setTabOrder(a0: QWidget, a1: QWidget)
setTabletTracking(self, enable: bool)
setTextElideMode(self, mode: Qt.TextElideMode)
setToolTip(self, a0: str)
setToolTipDuration(self, msec: int)
setToolTipSize(width, height)
Parameters
  • width (int) – width in pixels of tooltip

  • height (int) – height in pixels of tooltip

setUpdatesEnabled(self, enable: bool)
setVerticalHeader(self, header: QHeaderView)
setVerticalScrollBar(self, scrollbar: QScrollBar)
setVerticalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setVerticalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setViewport(self, widget: QWidget)
setViewportMargins(self, left: int, top: int, right: int, bottom: int)
setViewportMargins(self, margins: QMargins) None
setVisible(self, visible: bool)
setWhatsThis(self, a0: str)
setWindowFilePath(self, filePath: str)
setWindowFlag(self, a0: Qt.WindowType, on: bool = True)
setWindowFlags(self, type: Qt.WindowType)
setWindowIcon(self, icon: QIcon)
setWindowIconText(self, a0: str)
setWindowModality(self, windowModality: Qt.WindowModality)
setWindowModified(self, a0: bool)
setWindowOpacity(self, level: float)
setWindowRole(self, a0: str)
setWindowState(self, state: Qt.WindowState)
setWindowTitle(self, a0: str)
setWordWrap(self, on: bool)
setupViewport(self, viewport: QWidget)
sharedPainter(self) QPainter
show(self)
showColumn(self, column: int)
showDropIndicator(self) bool
showEvent(self, a0: QShowEvent)
showFullScreen(self)
showGrid(self) bool
showMaximized(self)
showMinimized(self)
showNormal(self)
showRow(self, row: int)
signalsBlocked(self) bool
size(self) QSize
sizeAdjustPolicy(self) QAbstractScrollArea.SizeAdjustPolicy
sizeHint(self) QSize
sizeHintForIndex(self, index: QModelIndex) QSize
sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
sortByColumn(self, column: int, order: Qt.SortOrder)
stackUnder(self, a0: QWidget)
startDrag(self, supportedActions: Qt.DropAction)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
state(self) QAbstractItemView.State
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
statusTip(self) str
style(self) QStyle
styleSheet(self) str
tabKeyNavigation(self) bool
tabletEvent(self, a0: QTabletEvent)
testAttribute(self, attribute: Qt.WidgetAttribute) bool
textElideMode(self) Qt.TextElideMode
thread(self) QThread
timerEvent(self, event: QTimerEvent)
toolTip(self) str
toolTipDuration(self) int
totalColumnWidth()

The sum of the widths of all the columns

Return type

int

Returns

the sum of all the column widths

totalRowHeight()

The sum of the heights of all the rows

Return type

int

Returns

the sum of all the row heights

tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
underMouse(self) bool
ungrabGesture(self, type: Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, index: QModelIndex) None
updateEditorData(self)
updateEditorGeometries(self)
updateGeometries(self)
updateGeometry(self)
updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)
updatesEnabled(self) bool
verticalHeader(self) QHeaderView
verticalOffset(self) int
verticalScrollBar(self) QScrollBar
verticalScrollBarPolicy(self) Qt.ScrollBarPolicy
verticalScrollMode(self) QAbstractItemView.ScrollMode
verticalScrollbarAction(self, action: int)
verticalScrollbarValueChanged(self, value: int)
viewport(self) QWidget
viewportEntered

viewportEntered(self) [signal]

viewportEvent(self, e: QEvent) bool
viewportMargins(self) QMargins
viewportSizeHint(self) QSize
visibleRegion(self) QRegion
visualRect(self, index: QModelIndex) QRect
visualRegionForSelection(self, selection: QItemSelection) QRegion
whatsThis(self) str
wheelEvent(self, a0: QWheelEvent)
width(self) int
widthMM(self) int
winId(self) PyQt6.sip.voidptr
window(self) QWidget
windowFilePath(self) str
windowFlags(self) Qt.WindowType
windowHandle(self) QWindow
windowIcon(self) QIcon
windowIconChanged

windowIconChanged(self, icon: QIcon) [signal]

windowIconText(self) str
windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowState
windowTitle(self) str
windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) Qt.WindowType
wordWrap(self) bool
x(self) int
y(self) int
auto_size

Whether the table should automatically resize in response to changes

class schrodinger.ui.qt.table.ExportableProxyModel

Bases: PyQt6.QtCore.QSortFilterProxyModel

A proxy model that allows data to be exported to a CSV file

exportToCsv(filename, role=ItemDataRole.DisplayRole, header_role=ItemDataRole.DisplayRole, unicode_output=False)

Export the contents of the model to a CSV file.

Parameters
  • filename (str) – The filename to write the CSV file to

  • role (int) – The data role to export for the table contents

  • header_role – The data role to export for the table headers

  • header_role – int

  • unicode_output (bool) – If True, Unicode characters are allowed. The CSV file will contain a tag (UTF-8 BOM) that allows Excel and LibreOffice to recognize the file as Unicode. (This tag will be added regardless of whether the output contains any Unicode characters.) If False, the CSV file will not contain the tag and Unicode characters will lead to an exception.

getRowData(role=ItemDataRole.DisplayRole, header_role=ItemDataRole.DisplayRole)

Extract row data from table model.

Parameters
  • role (int) – The data role to export for the table contents

  • header_role – The data role to export for the table headers

  • header_role – int

Returns

a list of row data, where the first item in the list contains the headers

Return type

list[list[object]]

class CheckIndexOption(value)

Bases: enum.Flag

An enumeration.

NoOption = 0
IndexIsValid = 1
DoNotUseParent = 2
ParentIsInvalid = 4
HorizontalSortHint = 2
class LayoutChangeHint(value)

Bases: enum.Enum

An enumeration.

NoLayoutChangeHint = 0
VerticalSortHint = 1
HorizontalSortHint = 2
NoLayoutChangeHint = 0
VerticalSortHint = 1
__init__(*args, **kwargs)
autoAcceptChildRows(self) bool
autoAcceptChildRowsChanged

autoAcceptChildRowsChanged(self, autoAcceptChildRows: bool) [signal]

beginInsertColumns(self, parent: QModelIndex, first: int, last: int)
beginInsertRows(self, parent: QModelIndex, first: int, last: int)
beginMoveColumns(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationColumn: int) bool
beginMoveRows(self, sourceParent: QModelIndex, sourceFirst: int, sourceLast: int, destinationParent: QModelIndex, destinationRow: int) bool
beginRemoveColumns(self, parent: QModelIndex, first: int, last: int)
beginRemoveRows(self, parent: QModelIndex, first: int, last: int)
beginResetModel(self)
blockSignals(self, b: bool) bool
buddy(self, index: QModelIndex) QModelIndex
canDropMimeData(self, data: QMimeData, action: Qt.DropAction, row: int, column: int, parent: QModelIndex) bool
canFetchMore(self, parent: QModelIndex) bool
changePersistentIndex(self, from_: QModelIndex, to: QModelIndex)
changePersistentIndexList(self, from_: Iterable[QModelIndex], to: Iterable[QModelIndex])
checkIndex(self, index: QModelIndex, options: QAbstractItemModel.CheckIndexOption = QAbstractItemModel.CheckIndexOption.NoOption) bool
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
clearItemData(self, index: QModelIndex) bool
columnCount(self, parent: QModelIndex = QModelIndex()) int
columnsAboutToBeInserted

columnsAboutToBeInserted(self, parent: QModelIndex, first: int, last: int) [signal]

columnsAboutToBeMoved

columnsAboutToBeMoved(self, sourceParent: QModelIndex, sourceStart: int, sourceEnd: int, destinationParent: QModelIndex, destinationColumn: int) [signal]

columnsAboutToBeRemoved

columnsAboutToBeRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

columnsInserted

columnsInserted(self, parent: QModelIndex, first: int, last: int) [signal]

columnsMoved

columnsMoved(self, parent: QModelIndex, start: int, end: int, destination: QModelIndex, column: int) [signal]

columnsRemoved

columnsRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

connectNotify(self, signal: QMetaMethod)
createIndex(self, row: int, column: int, object: object = 0) QModelIndex
customEvent(self, a0: QEvent)
data(self, index: QModelIndex, role: int = Qt.DisplayRole) Any
dataChanged

dataChanged(self, topLeft: QModelIndex, bottomRight: QModelIndex, roles: Iterable[int] = []) [signal]

decodeData(self, row: int, column: int, parent: QModelIndex, stream: QDataStream) bool
deleteLater(self)
destroyed

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

disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
dropMimeData(self, data: QMimeData, action: Qt.DropAction, row: int, column: int, parent: QModelIndex) bool
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
dynamicSortFilter(self) bool
dynamicSortFilterChanged

dynamicSortFilterChanged(self, dynamicSortFilter: bool) [signal]

encodeData(self, indexes: Iterable[QModelIndex], stream: QDataStream)
endInsertColumns(self)
endInsertRows(self)
endMoveColumns(self)
endMoveRows(self)
endRemoveColumns(self)
endRemoveRows(self)
endResetModel(self)
event(self, a0: QEvent) bool
eventFilter(self, a0: QObject, a1: QEvent) bool
fetchMore(self, parent: QModelIndex)
filterAcceptsColumn(self, source_column: int, source_parent: QModelIndex) bool
filterAcceptsRow(self, source_row: int, source_parent: QModelIndex) bool
filterCaseSensitivity(self) Qt.CaseSensitivity
filterCaseSensitivityChanged

filterCaseSensitivityChanged(self, filterCaseSensitivity: Qt.CaseSensitivity) [signal]

filterKeyColumn(self) int
filterRegularExpression(self) QRegularExpression
filterRole(self) int
filterRoleChanged

filterRoleChanged(self, filterRole: int) [signal]

findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
flags(self, index: QModelIndex) Qt.ItemFlag
hasChildren(self, parent: QModelIndex = QModelIndex()) bool
hasIndex(self, row: int, column: int, parent: QModelIndex = QModelIndex()) bool
headerData(self, section: int, orientation: Qt.Orientation, role: int = Qt.DisplayRole) Any
headerDataChanged

headerDataChanged(self, orientation: Qt.Orientation, first: int, last: int) [signal]

index(self, row: int, column: int, parent: QModelIndex = QModelIndex()) QModelIndex
inherits(self, classname: str) bool
insertColumn(self, column: int, parent: QModelIndex = QModelIndex()) bool
insertColumns(self, column: int, count: int, parent: QModelIndex = QModelIndex()) bool
insertRow(self, row: int, parent: QModelIndex = QModelIndex()) bool
insertRows(self, row: int, count: int, parent: QModelIndex = QModelIndex()) bool
installEventFilter(self, a0: QObject)
invalidate(self)
invalidateColumnsFilter(self)
invalidateFilter(self)
invalidateRowsFilter(self)
isRecursiveFilteringEnabled(self) bool
isSignalConnected(self, signal: QMetaMethod) bool
isSortLocaleAware(self) bool
isWidgetType(self) bool
isWindowType(self) bool
itemData(self, index: QModelIndex) Dict[int, Any]
killTimer(self, id: int)
layoutAboutToBeChanged

layoutAboutToBeChanged(self, parents: Iterable[QPersistentModelIndex] = [], hint: QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]

layoutChanged

layoutChanged(self, parents: Iterable[QPersistentModelIndex] = [], hint: QAbstractItemModel.LayoutChangeHint = QAbstractItemModel.NoLayoutChangeHint) [signal]

lessThan(self, left: QModelIndex, right: QModelIndex) bool
mapFromSource(self, sourceIndex: QModelIndex) QModelIndex
mapSelectionFromSource(self, sourceSelection: QItemSelection) QItemSelection
mapSelectionToSource(self, proxySelection: QItemSelection) QItemSelection
mapToSource(self, proxyIndex: QModelIndex) QModelIndex
match(self, start: QModelIndex, role: int, value: Any, hits: int = 1, flags: Qt.MatchFlag = Qt.MatchFlags(Qt.MatchStartsWith | Qt.MatchWrap)) List[QModelIndex]
metaObject(self) QMetaObject
mimeData(self, indexes: Iterable[QModelIndex]) QMimeData
mimeTypes(self) List[str]
modelAboutToBeReset

modelAboutToBeReset(self) [signal]

modelReset

modelReset(self) [signal]

moveColumn(self, sourceParent: QModelIndex, sourceColumn: int, destinationParent: QModelIndex, destinationChild: int) bool
moveColumns(self, sourceParent: QModelIndex, sourceColumn: int, count: int, destinationParent: QModelIndex, destinationChild: int) bool
moveRow(self, sourceParent: QModelIndex, sourceRow: int, destinationParent: QModelIndex, destinationChild: int) bool
moveRows(self, sourceParent: QModelIndex, sourceRow: int, count: int, destinationParent: QModelIndex, destinationChild: int) bool
moveToThread(self, thread: QThread)
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

parent(self, child: QModelIndex) QModelIndex
parent(self) QObject
persistentIndexList(self) List[QModelIndex]
property(self, name: str) Any
pyqtConfigure(...)

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

receivers(self, signal: PYQT_SIGNAL) int
recursiveFilteringEnabledChanged

recursiveFilteringEnabledChanged(self, recursiveFilteringEnabled: bool) [signal]

removeColumn(self, column: int, parent: QModelIndex = QModelIndex()) bool
removeColumns(self, column: int, count: int, parent: QModelIndex = QModelIndex()) bool
removeEventFilter(self, a0: QObject)
removeRow(self, row: int, parent: QModelIndex = QModelIndex()) bool
removeRows(self, row: int, count: int, parent: QModelIndex = QModelIndex()) bool
resetInternalData(self)
revert(self)
roleNames(self) Dict[int, QByteArray]
rowCount(self, parent: QModelIndex = QModelIndex()) int
rowsAboutToBeInserted

rowsAboutToBeInserted(self, parent: QModelIndex, first: int, last: int) [signal]

rowsAboutToBeMoved

rowsAboutToBeMoved(self, sourceParent: QModelIndex, sourceStart: int, sourceEnd: int, destinationParent: QModelIndex, destinationRow: int) [signal]

rowsAboutToBeRemoved

rowsAboutToBeRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

rowsInserted

rowsInserted(self, parent: QModelIndex, first: int, last: int) [signal]

rowsMoved

rowsMoved(self, parent: QModelIndex, start: int, end: int, destination: QModelIndex, row: int) [signal]

rowsRemoved

rowsRemoved(self, parent: QModelIndex, first: int, last: int) [signal]

sender(self) QObject
senderSignalIndex(self) int
setAutoAcceptChildRows(self, accept: bool)
setData(self, index: QModelIndex, value: Any, role: int = Qt.EditRole) bool
setDynamicSortFilter(self, enable: bool)
setFilterCaseSensitivity(self, cs: Qt.CaseSensitivity)
setFilterFixedString(self, pattern: str)
setFilterKeyColumn(self, column: int)
setFilterRegularExpression(self, regularExpression: QRegularExpression)
setFilterRegularExpression(self, pattern: str) None
setFilterRole(self, role: int)
setFilterWildcard(self, pattern: str)
setHeaderData(self, section: int, orientation: Qt.Orientation, value: Any, role: int = Qt.EditRole) bool
setItemData(self, index: QModelIndex, roles: Dict[int, Any]) bool
setObjectName(self, name: str)
setParent(self, a0: QObject)
setProperty(self, name: str, value: Any) bool
setRecursiveFilteringEnabled(self, recursive: bool)
setSortCaseSensitivity(self, cs: Qt.CaseSensitivity)
setSortLocaleAware(self, on: bool)
setSortRole(self, role: int)
setSourceModel(self, sourceModel: QAbstractItemModel)
sibling(self, row: int, column: int, idx: QModelIndex) QModelIndex
signalsBlocked(self) bool
sort(self, column: int, order: Qt.SortOrder = Qt.AscendingOrder)
sortCaseSensitivity(self) Qt.CaseSensitivity
sortCaseSensitivityChanged

sortCaseSensitivityChanged(self, sortCaseSensitivity: Qt.CaseSensitivity) [signal]

sortColumn(self) int
sortLocaleAwareChanged

sortLocaleAwareChanged(self, sortLocaleAware: bool) [signal]

sortOrder(self) Qt.SortOrder
sortRole(self) int
sortRoleChanged

sortRoleChanged(self, sortRole: int) [signal]

sourceModel(self) QAbstractItemModel
sourceModelChanged

sourceModelChanged(self) [signal]

span(self, index: QModelIndex) QSize
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
submit(self) bool
supportedDragActions(self) Qt.DropAction
supportedDropActions(self) Qt.DropAction
thread(self) QThread
timerEvent(self, a0: QTimerEvent)
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
schrodinger.ui.qt.table.get_row_data(model, role=ItemDataRole.DisplayRole, header_role=ItemDataRole.DisplayRole)

Extract row data from table model.

Parameters
  • model (QtCore.QAbstractItemModel) – a table model or proxy

  • role (int) – The data role to export for the table contents

  • header_role – The data role to export for the table headers

  • header_role – int

Returns

a list of lists, where each list represents the row of a table

Return type

list[list[object]]

schrodinger.ui.qt.table.write_row_data(file_path, rows, unicode_output=False)

Write row data to a CSV file.

Parameters
  • file_path (str) – the path for the .csv file

  • rows (list[list[object]]) – a list of row data lists, where the first element of the list should contain the headers

  • unicode_output (bool) – If True, Unicode characters are allowed. The CSV file will contain a tag (UTF-8 BOM) that allows Excel and LibreOffice to recognize the file as Unicode. (This tag will be added regardless of whether the output contains any Unicode characters.) If False, the CSV file will not contain the tag and Unicode characters will lead to an exception.

schrodinger.ui.qt.table.export_to_csv(model, filename, role=ItemDataRole.DisplayRole, header_role=ItemDataRole.DisplayRole, unicode_output=False)

Export the contents of the specified model to a CSV file

Parameters
  • model (PyQt5.QtCore.QAbstractItemModel) – The model (or proxy model) to export

  • filename (str) – The filename to write the CSV file to

  • role (int) – The data role to export for the table contents

  • header_role – The data role to export for the table headers

  • header_role – int

  • unicode_output (bool) – If True, Unicode characters are allowed. The CSV file will contain a tag (UTF-8 BOM) that allows Excel and LibreOffice to recognize the file as Unicode. (This tag will be added regardless of whether the output contains any Unicode characters.) If False, the CSV file will not contain the tag and Unicode characters will lead to an exception.

schrodinger.ui.qt.table.export_to_csv_with_dialog(model, parent, caption='Export', dialog_id=None, role=ItemDataRole.DisplayRole, header_role=ItemDataRole.DisplayRole, unicode_output=False)

Open a dialog prompting the user for a CSV export file and then export the contents of the specified model to the selected file.

Parameters
  • model (PyQt5.QtCore.QAbstractItemModel) – The model (or proxy model) to export

  • parent (PyQt5.QtWidgets.QWidget) – The parent widget of the export dialog

  • caption (str) – The title of the export dialog

  • dialog_id (str, int, or float) – The id for the filedialog. Dialogs with the same identifier will remember the last directory chosen by the user with any dialog of the same id and open in that directory.

  • role (int) – The data role to export for the table contents

  • header_role – The data role to export for the table headers

  • header_role – int

  • unicode_output (bool) – If True, Unicode characters are allowed. The CSV file will contain a tag (UTF-8 BOM) that allows Excel and LibreOffice to recognize the file as Unicode. (This tag will be added regardless of whether the output contains any Unicode characters.) If False, the CSV file will not contain the tag and Unicode characters will lead to an exception.

class schrodinger.ui.qt.table.PerColumnSortableTableView(parent=None)

Bases: PyQt6.QtWidgets.QTableView

A table view that prevents sorting on certain columns. Subclasses should override UNSORTABLE_COLS.

Variables

UNSORTABLE_COLS (set) – A set of columns to be made unsortable. This variable should be overridden in subclasses.

UNSORTABLE_COLS = {}
__init__(parent=None)
AboveItem = 1
AdjustIgnored = 0
AdjustToContents = 2
AdjustToContentsOnFirstShow = 1
AllEditTriggers = 31
AnimatingState = 6
AnyKeyPressed = 16
BelowItem = 2
Box = 1
CollapsingState = 5
ContiguousSelection = 4
CurrentChanged = 1
class CursorAction(value)

Bases: enum.Enum

An enumeration.

MoveUp = 0
MoveDown = 1
MoveLeft = 2
MoveRight = 3
MoveHome = 4
MoveEnd = 5
MovePageUp = 6
MovePageDown = 7
MoveNext = 8
MovePrevious = 9
DoubleClicked = 2
DragDrop = 3
class DragDropMode(value)

Bases: enum.Enum

An enumeration.

NoDragDrop = 0
DragOnly = 1
DropOnly = 2
DragDrop = 3
InternalMove = 4
DragOnly = 1
DragSelectingState = 2
DraggingState = 1
DrawChildren = 2
DrawWindowBackground = 1
class DropIndicatorPosition(value)

Bases: enum.Enum

An enumeration.

OnItem = 0
AboveItem = 1
BelowItem = 2
OnViewport = 3
DropOnly = 2
EditKeyPressed = 8
class EditTrigger(value)

Bases: enum.Flag

An enumeration.

NoEditTriggers = 0
CurrentChanged = 1
DoubleClicked = 2
SelectedClicked = 4
EditKeyPressed = 8
AnyKeyPressed = 16
AllEditTriggers = 31
EditingState = 3
EnsureVisible = 0
ExpandingState = 4
ExtendedSelection = 3
HLine = 4
IgnoreMask = 4
InternalMove = 4
MoveDown = 1
MoveEnd = 5
MoveHome = 4
MoveLeft = 2
MoveNext = 8
MovePageDown = 7
MovePageUp = 6
MovePrevious = 9
MoveRight = 3
MoveUp = 0
MultiSelection = 2
NoDragDrop = 0
NoEditTriggers = 0
NoFrame = 0
NoSelection = 0
NoState = 0
OnItem = 0
OnViewport = 3
class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1
PdmHeight = 2
PdmWidthMM = 3
PdmHeightMM = 4
PdmNumColors = 5
PdmDepth = 6
PdmDpiX = 7
PdmDpiY = 8
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
Panel = 2
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
Plain = 16
PositionAtBottom = 2
PositionAtCenter = 3
PositionAtTop = 1
Raised = 32
class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1
DrawChildren = 2
IgnoreMask = 4
class ScrollHint(value)

Bases: enum.Enum

An enumeration.

EnsureVisible = 0
PositionAtTop = 1
PositionAtBottom = 2
PositionAtCenter = 3
class ScrollMode(value)

Bases: enum.Enum

An enumeration.

ScrollPerItem = 0
ScrollPerPixel = 1
ScrollPerItem = 0
ScrollPerPixel = 1
SelectColumns = 2
SelectItems = 0
SelectRows = 1
SelectedClicked = 4
class SelectionBehavior(value)

Bases: enum.Enum

An enumeration.

SelectItems = 0
SelectRows = 1
SelectColumns = 2
class SelectionMode(value)

Bases: enum.Enum

An enumeration.

NoSelection = 0
SingleSelection = 1
MultiSelection = 2
ExtendedSelection = 3
ContiguousSelection = 4
class Shadow(value)

Bases: enum.IntEnum

An enumeration.

Plain = 16
Raised = 32
Sunken = 48
Shadow_Mask = 240
class Shape(value)

Bases: enum.IntEnum

An enumeration.

NoFrame = 0
Box = 1
Panel = 2
WinPanel = 3
HLine = 4
VLine = 5
StyledPanel = 6
Shape_Mask = 15
SingleSelection = 1
class SizeAdjustPolicy(value)

Bases: enum.Enum

An enumeration.

AdjustIgnored = 0
AdjustToContentsOnFirstShow = 1
AdjustToContents = 2
class State(value)

Bases: enum.Enum

An enumeration.

NoState = 0
DraggingState = 1
DragSelectingState = 2
EditingState = 3
ExpandingState = 4
CollapsingState = 5
AnimatingState = 6
class StyleMask(value)

Bases: enum.Enum

An enumeration.

Shadow_Mask = 240
Shape_Mask = 15
StyledPanel = 6
Sunken = 48
VLine = 5
WinPanel = 3
acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, a0: QActionEvent)
actions(self) List[QAction]
activateWindow(self)
activated

activated(self, index: QModelIndex) [signal]

addAction(self, action: QAction)
addActions(self, actions: Iterable[QAction])
addScrollBarWidget(self, widget: QWidget, alignment: Qt.AlignmentFlag)
adjustSize(self)
alternatingRowColors(self) bool
autoFillBackground(self) bool
autoScrollMargin(self) int
backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, b: bool) bool
changeEvent(self, a0: QEvent)
childAt(self, p: QPoint) QWidget
childAt(self, ax: int, ay: int) QWidget
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
clearSelection(self)
clearSpans(self)
clicked

clicked(self, index: QModelIndex) [signal]

close(self) bool
closeEditor(self, editor: QWidget, hint: QAbstractItemDelegate.EndEditHint)
closeEvent(self, a0: QCloseEvent)
closePersistentEditor(self, index: QModelIndex)
colorCount(self) int
columnAt(self, x: int) int
columnCountChanged(self, oldCount: int, newCount: int)
columnMoved(self, column: int, oldIndex: int, newIndex: int)
columnResized(self, column: int, oldWidth: int, newWidth: int)
columnSpan(self, row: int, column: int) int
columnViewportPosition(self, column: int) int
columnWidth(self, column: int) int
commitData(self, editor: QWidget)
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, a0: QContextMenuEvent)
contextMenuPolicy(self) Qt.ContextMenuPolicy
cornerWidget(self) QWidget
create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(window: QWindow, parent: typing.Optional[QWidget] = None, flags: Qt.WindowType = Qt.WindowFlags()) QWidget
currentChanged(self, current: QModelIndex, previous: QModelIndex)
currentIndex(self) QModelIndex
cursor(self) QCursor
customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)
dataChanged(self, topLeft: QModelIndex, bottomRight: QModelIndex, roles: Iterable[int] = [])
defaultDropAction(self) Qt.DropAction
deleteLater(self)
depth(self) int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

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

devType(self) int
devicePixelRatio(self) float
devicePixelRatioF(self) float
devicePixelRatioFScale() float
dirtyRegionOffset(self) QPoint
disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
doubleClicked

doubleClicked(self, index: QModelIndex) [signal]

dragDropMode(self) QAbstractItemView.DragDropMode
dragDropOverwriteMode(self) bool
dragEnabled(self) bool
dragEnterEvent(self, e: QDragEnterEvent)
dragLeaveEvent(self, e: QDragLeaveEvent)
dragMoveEvent(self, e: QDragMoveEvent)
drawFrame(self, a0: QPainter)
dropEvent(self, e: QDropEvent)
dropIndicatorPosition(self) QAbstractItemView.DropIndicatorPosition
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
edit(self, index: QModelIndex)
edit(self, index: QModelIndex, trigger: QAbstractItemView.EditTrigger, event: QEvent) bool
editTriggers(self) QAbstractItemView.EditTrigger
editorDestroyed(self, editor: QObject)
effectiveWinId(self) PyQt6.sip.voidptr
ensurePolished(self)
enterEvent(self, event: QEnterEvent)
entered

entered(self, index: QModelIndex) [signal]

event(self, event: QEvent) bool
eventFilter(self, object: QObject, event: QEvent) bool
executeDelayedItemsLayout(self)
find(a0: PyQt6.sip.voidptr) QWidget
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
focusInEvent(self, e: QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, e: QFocusEvent)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget
focusWidget(self) QWidget
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameRect(self) QRect
frameShadow(self) QFrame.Shadow
frameShape(self) QFrame.Shape
frameSize(self) QSize
frameStyle(self) int
frameWidth(self) int
geometry(self) QRect
grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) QPixmap
grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, a0: Union[QCursor, Qt.CursorShape]) None
grabShortcut(self, key: Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect
graphicsProxyWidget(self) QGraphicsProxyWidget
gridStyle(self) Qt.PenStyle
hasAutoScroll(self) bool
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
height(self) int
heightForWidth(self, a0: int) int
heightMM(self) int
hide(self)
hideColumn(self, column: int)
hideEvent(self, a0: QHideEvent)
hideRow(self, row: int)
horizontalHeader(self) QHeaderView
horizontalOffset(self) int
horizontalScrollBar(self) QScrollBar
horizontalScrollBarPolicy(self) Qt.ScrollBarPolicy
horizontalScrollMode(self) QAbstractItemView.ScrollMode
horizontalScrollbarAction(self, action: int)
horizontalScrollbarValueChanged(self, value: int)
iconSize(self) QSize
iconSizeChanged

iconSizeChanged(self, size: QSize) [signal]

indexAt(self, p: QPoint) QModelIndex
indexWidget(self, index: QModelIndex) QWidget
inherits(self, classname: str) bool
initPainter(self, painter: QPainter)
initStyleOption(self, option: QStyleOptionFrame)
initViewItemOption(self, option: QStyleOptionViewItem)
inputMethodEvent(self, event: QInputMethodEvent)
inputMethodHints(self) Qt.InputMethodHint
inputMethodQuery(self, query: Qt.InputMethodQuery) Any
insertAction(self, before: QAction, action: QAction)
insertActions(self, before: QAction, actions: Iterable[QAction])
installEventFilter(self, a0: QObject)
isActiveWindow(self) bool
isAncestorOf(self, child: QWidget) bool
isColumnHidden(self, column: int) bool
isCornerButtonEnabled(self) bool
isEnabled(self) bool
isEnabledTo(self, a0: QWidget) bool
isFullScreen(self) bool
isHidden(self) bool
isIndexHidden(self, index: QModelIndex) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isPersistentEditorOpen(self, index: QModelIndex) bool
isRightToLeft(self) bool
isRowHidden(self, row: int) bool
isSignalConnected(self, signal: QMetaMethod) bool
isSortingEnabled(self) bool
isVisible(self) bool
isVisibleTo(self, a0: QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
itemDelegate(self) QAbstractItemDelegate
itemDelegateForColumn(self, column: int) QAbstractItemDelegate
itemDelegateForIndex(self, index: QModelIndex) QAbstractItemDelegate
itemDelegateForRow(self, row: int) QAbstractItemDelegate
keyPressEvent(self, e: QKeyEvent)
keyReleaseEvent(self, a0: QKeyEvent)
keyboardGrabber() QWidget
keyboardSearch(self, search: str)
killTimer(self, id: int)
layout(self) QLayout
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, a0: QEvent)
lineWidth(self) int
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
lower(self)
mapFrom(self, a0: QWidget, a1: QPoint) QPoint
mapFrom(self, a0: QWidget, a1: QPointF) QPointF
mapFromGlobal(self, a0: QPoint) QPoint
mapFromGlobal(self, a0: QPointF) QPointF
mapFromParent(self, a0: QPoint) QPoint
mapFromParent(self, a0: QPointF) QPointF
mapTo(self, a0: QWidget, a1: QPoint) QPoint
mapTo(self, a0: QWidget, a1: QPointF) QPointF
mapToGlobal(self, a0: QPoint) QPoint
mapToGlobal(self, a0: QPointF) QPointF
mapToParent(self, a0: QPoint) QPoint
mapToParent(self, a0: QPointF) QPointF
mask(self) QRegion
maximumHeight(self) int
maximumSize(self) QSize
maximumViewportSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject
metric(self, a0: QPaintDevice.PaintDeviceMetric) int
midLineWidth(self) int
minimumHeight(self) int
minimumSize(self) QSize
minimumSizeHint(self) QSize
minimumWidth(self) int
model(self) QAbstractItemModel
mouseDoubleClickEvent(self, e: QMouseEvent)
mouseGrabber() QWidget
mouseMoveEvent(self, e: QMouseEvent)
mousePressEvent(self, e: QMouseEvent)
mouseReleaseEvent(self, e: QMouseEvent)
move(self, a0: QPoint)
move(self, ax: int, ay: int) None
moveCursor(self, cursorAction: QAbstractItemView.CursorAction, modifiers: Qt.KeyboardModifier) QModelIndex
moveEvent(self, a0: QMoveEvent)
moveToThread(self, thread: QThread)
nativeEvent(self, eventType: QByteArray, message: PyQt6.sip.voidptr) Tuple[bool, PyQt6.sip.voidptr]
nativeParentWidget(self) QWidget
nextInFocusChain(self) QWidget
normalGeometry(self) QRect
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

openPersistentEditor(self, index: QModelIndex)
overrideWindowFlags(self, type: Qt.WindowType)
overrideWindowState(self, state: Qt.WindowState)
paintEngine(self) QPaintEngine
paintEvent(self, e: QPaintEvent)
paintingActive(self) bool
palette(self) QPalette
parent(self) QObject
parentWidget(self) QWidget
physicalDpiX(self) int
physicalDpiY(self) int
pos(self) QPoint
pressed

pressed(self, index: QModelIndex) [signal]

previousInFocusChain(self) QWidget
property(self, name: str) Any
pyqtConfigure(...)

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

raise_(self)
receivers(self, signal: PYQT_SIGNAL) int
rect(self) QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id: int)
removeAction(self, action: QAction)
removeEventFilter(self, a0: QObject)
render(self, target: QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))
render(self, painter: QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) None
repaint(self)
repaint(self, x: int, y: int, w: int, h: int) None
repaint(self, a0: QRect) None
repaint(self, a0: QRegion) None
reset(self)
resetHorizontalScrollMode(self)
resetVerticalScrollMode(self)
resize(self, a0: QSize)
resize(self, w: int, h: int) None
resizeColumnToContents(self, column: int)
resizeColumnsToContents(self)
resizeEvent(self, e: QResizeEvent)
resizeRowToContents(self, row: int)
resizeRowsToContents(self)
restoreGeometry(self, geometry: QByteArray) bool
rootIndex(self) QModelIndex
rowAt(self, y: int) int
rowCountChanged(self, oldCount: int, newCount: int)
rowHeight(self, row: int) int
rowMoved(self, row: int, oldIndex: int, newIndex: int)
rowResized(self, row: int, oldHeight: int, newHeight: int)
rowSpan(self, row: int, column: int) int
rowViewportPosition(self, row: int) int
rowsAboutToBeRemoved(self, parent: QModelIndex, start: int, end: int)
rowsInserted(self, parent: QModelIndex, start: int, end: int)
saveGeometry(self) QByteArray
scheduleDelayedItemsLayout(self)
screen(self) QScreen
scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) None
scrollBarWidgets(self, alignment: Qt.AlignmentFlag) List[QWidget]
scrollContentsBy(self, dx: int, dy: int)
scrollDirtyRegion(self, dx: int, dy: int)
scrollTo(self, index: QModelIndex, hint: QAbstractItemView.ScrollHint = QAbstractItemView.EnsureVisible)
scrollToBottom(self)
scrollToTop(self)
selectAll(self)
selectColumn(self, column: int)
selectRow(self, row: int)
selectedIndexes(self) List[QModelIndex]
selectionBehavior(self) QAbstractItemView.SelectionBehavior
selectionChanged(self, selected: QItemSelection, deselected: QItemSelection)
selectionCommand(self, index: QModelIndex, event: typing.Optional[QEvent] = None) QItemSelectionModel.SelectionFlag
selectionMode(self) QAbstractItemView.SelectionMode
selectionModel(self) QItemSelectionModel
sender(self) QObject
senderSignalIndex(self) int
setAcceptDrops(self, on: bool)
setAccessibleDescription(self, description: str)
setAccessibleName(self, name: str)
setAlternatingRowColors(self, enable: bool)
setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, enabled: bool)
setAutoScroll(self, enable: bool)
setAutoScrollMargin(self, margin: int)
setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) None
setColumnHidden(self, column: int, hide: bool)
setColumnWidth(self, column: int, width: int)
setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) None
setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)
setCornerButtonEnabled(self, enable: bool)
setCornerWidget(self, widget: QWidget)
setCurrentIndex(self, index: QModelIndex)
setCursor(self, a0: Union[QCursor, Qt.CursorShape])
setDefaultDropAction(self, dropAction: Qt.DropAction)
setDirtyRegion(self, region: QRegion)
setDisabled(self, a0: bool)
setDragDropMode(self, behavior: QAbstractItemView.DragDropMode)
setDragDropOverwriteMode(self, overwrite: bool)
setDragEnabled(self, enable: bool)
setDropIndicatorShown(self, enable: bool)
setEditTriggers(self, triggers: QAbstractItemView.EditTrigger)
setEnabled(self, a0: bool)
setFixedHeight(self, h: int)
setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int)
setFocus(self)
setFocus(self, reason: Qt.FocusReason) None
setFocusPolicy(self, policy: Qt.FocusPolicy)
setFocusProxy(self, a0: QWidget)
setFont(self, a0: QFont)
setForegroundRole(self, a0: QPalette.ColorRole)
setFrameRect(self, a0: QRect)
setFrameShadow(self, a0: QFrame.Shadow)
setFrameShape(self, a0: QFrame.Shape)
setFrameStyle(self, a0: int)
setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
setGraphicsEffect(self, effect: QGraphicsEffect)
setGridStyle(self, style: Qt.PenStyle)
setHidden(self, hidden: bool)
setHorizontalHeader(self, header: QHeaderView)
setHorizontalScrollBar(self, scrollbar: QScrollBar)
setHorizontalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setHorizontalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setIconSize(self, size: QSize)
setIndexWidget(self, index: QModelIndex, widget: QWidget)
setInputMethodHints(self, hints: Qt.InputMethodHint)
setItemDelegate(self, delegate: QAbstractItemDelegate)
setItemDelegateForColumn(self, column: int, delegate: QAbstractItemDelegate)
setItemDelegateForRow(self, row: int, delegate: QAbstractItemDelegate)
setLayout(self, a0: QLayout)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLineWidth(self, a0: int)
setLocale(self, locale: QLocale)
setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) None
setMaximumHeight(self, maxh: int)
setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) None
setMaximumWidth(self, maxw: int)
setMidLineWidth(self, a0: int)
setMinimumHeight(self, minh: int)
setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) None
setMinimumWidth(self, minw: int)
setModel(self, model: QAbstractItemModel)
setMouseTracking(self, enable: bool)
setObjectName(self, name: str)
setPalette(self, a0: QPalette)
setParent(self, parent: QWidget)
setParent(self, parent: QWidget, f: Qt.WindowType) None
setProperty(self, name: str, value: Any) bool
setRootIndex(self, index: QModelIndex)
setRowHeight(self, row: int, height: int)
setRowHidden(self, row: int, hide: bool)
setScreen(self, a0: QScreen)
setSelection(self, rect: QRect, command: QItemSelectionModel.SelectionFlag)
setSelectionBehavior(self, behavior: QAbstractItemView.SelectionBehavior)
setSelectionMode(self, mode: QAbstractItemView.SelectionMode)
setSelectionModel(self, selectionModel: QItemSelectionModel)
setShortcutAutoRepeat(self, id: int, enabled: bool = True)
setShortcutEnabled(self, id: int, enabled: bool = True)
setShowGrid(self, show: bool)
setSizeAdjustPolicy(self, policy: QAbstractScrollArea.SizeAdjustPolicy)
setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) None
setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
setSortingEnabled(self, enable: bool)
setSpan(self, row: int, column: int, rowSpan: int, columnSpan: int)
setState(self, state: QAbstractItemView.State)
setStatusTip(self, a0: str)
setStyle(self, a0: QStyle)
setStyleSheet(self, styleSheet: str)
setTabKeyNavigation(self, enable: bool)
setTabOrder(a0: QWidget, a1: QWidget)
setTabletTracking(self, enable: bool)
setTextElideMode(self, mode: Qt.TextElideMode)
setToolTip(self, a0: str)
setToolTipDuration(self, msec: int)
setUpdatesEnabled(self, enable: bool)
setVerticalHeader(self, header: QHeaderView)
setVerticalScrollBar(self, scrollbar: QScrollBar)
setVerticalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setVerticalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setViewport(self, widget: QWidget)
setViewportMargins(self, left: int, top: int, right: int, bottom: int)
setViewportMargins(self, margins: QMargins) None
setVisible(self, visible: bool)
setWhatsThis(self, a0: str)
setWindowFilePath(self, filePath: str)
setWindowFlag(self, a0: Qt.WindowType, on: bool = True)
setWindowFlags(self, type: Qt.WindowType)
setWindowIcon(self, icon: QIcon)
setWindowIconText(self, a0: str)
setWindowModality(self, windowModality: Qt.WindowModality)
setWindowModified(self, a0: bool)
setWindowOpacity(self, level: float)
setWindowRole(self, a0: str)
setWindowState(self, state: Qt.WindowState)
setWindowTitle(self, a0: str)
setWordWrap(self, on: bool)
setupViewport(self, viewport: QWidget)
sharedPainter(self) QPainter
show(self)
showColumn(self, column: int)
showDropIndicator(self) bool
showEvent(self, a0: QShowEvent)
showFullScreen(self)
showGrid(self) bool
showMaximized(self)
showMinimized(self)
showNormal(self)
showRow(self, row: int)
signalsBlocked(self) bool
size(self) QSize
sizeAdjustPolicy(self) QAbstractScrollArea.SizeAdjustPolicy
sizeHint(self) QSize
sizeHintForColumn(self, column: int) int
sizeHintForIndex(self, index: QModelIndex) QSize
sizeHintForRow(self, row: int) int
sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
sortByColumn(self, column: int, order: Qt.SortOrder)
stackUnder(self, a0: QWidget)
startDrag(self, supportedActions: Qt.DropAction)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
state(self) QAbstractItemView.State
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
statusTip(self) str
style(self) QStyle
styleSheet(self) str
tabKeyNavigation(self) bool
tabletEvent(self, a0: QTabletEvent)
testAttribute(self, attribute: Qt.WidgetAttribute) bool
textElideMode(self) Qt.TextElideMode
thread(self) QThread
timerEvent(self, event: QTimerEvent)
toolTip(self) str
toolTipDuration(self) int
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
underMouse(self) bool
ungrabGesture(self, type: Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, index: QModelIndex) None
updateEditorData(self)
updateEditorGeometries(self)
updateGeometries(self)
updateGeometry(self)
updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)
updatesEnabled(self) bool
verticalHeader(self) QHeaderView
verticalOffset(self) int
verticalScrollBar(self) QScrollBar
verticalScrollBarPolicy(self) Qt.ScrollBarPolicy
verticalScrollMode(self) QAbstractItemView.ScrollMode
verticalScrollbarAction(self, action: int)
verticalScrollbarValueChanged(self, value: int)
viewport(self) QWidget
viewportEntered

viewportEntered(self) [signal]

viewportEvent(self, e: QEvent) bool
viewportMargins(self) QMargins
viewportSizeHint(self) QSize
visibleRegion(self) QRegion
visualRect(self, index: QModelIndex) QRect
visualRegionForSelection(self, selection: QItemSelection) QRegion
whatsThis(self) str
wheelEvent(self, a0: QWheelEvent)
width(self) int
widthMM(self) int
winId(self) PyQt6.sip.voidptr
window(self) QWidget
windowFilePath(self) str
windowFlags(self) Qt.WindowType
windowHandle(self) QWindow
windowIcon(self) QIcon
windowIconChanged

windowIconChanged(self, icon: QIcon) [signal]

windowIconText(self) str
windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowState
windowTitle(self) str
windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) Qt.WindowType
wordWrap(self) bool
x(self) int
y(self) int
class schrodinger.ui.qt.table.PerColumnSortableHeaderView(unclickable_cols, parent=None)

Bases: PyQt6.QtWidgets.QHeaderView

A horizontal table header that ignores clicks on certain columns, which prevents sorting on these columns.

AboveItem = 1
AdjustIgnored = 0
AdjustToContents = 2
AdjustToContentsOnFirstShow = 1
AllEditTriggers = 31
AnimatingState = 6
AnyKeyPressed = 16
BelowItem = 2
Box = 1
CollapsingState = 5
ContiguousSelection = 4
CurrentChanged = 1
class CursorAction(value)

Bases: enum.Enum

An enumeration.

MoveUp = 0
MoveDown = 1
MoveLeft = 2
MoveRight = 3
MoveHome = 4
MoveEnd = 5
MovePageUp = 6
MovePageDown = 7
MoveNext = 8
MovePrevious = 9
Custom = 2
DoubleClicked = 2
DragDrop = 3
class DragDropMode(value)

Bases: enum.Enum

An enumeration.

NoDragDrop = 0
DragOnly = 1
DropOnly = 2
DragDrop = 3
InternalMove = 4
DragOnly = 1
DragSelectingState = 2
DraggingState = 1
DrawChildren = 2
DrawWindowBackground = 1
class DropIndicatorPosition(value)

Bases: enum.Enum

An enumeration.

OnItem = 0
AboveItem = 1
BelowItem = 2
OnViewport = 3
DropOnly = 2
EditKeyPressed = 8
class EditTrigger(value)

Bases: enum.Flag

An enumeration.

NoEditTriggers = 0
CurrentChanged = 1
DoubleClicked = 2
SelectedClicked = 4
EditKeyPressed = 8
AnyKeyPressed = 16
AllEditTriggers = 31
EditingState = 3
EnsureVisible = 0
ExpandingState = 4
ExtendedSelection = 3
Fixed = 2
HLine = 4
IgnoreMask = 4
Interactive = 0
InternalMove = 4
MoveDown = 1
MoveEnd = 5
MoveHome = 4
MoveLeft = 2
MoveNext = 8
MovePageDown = 7
MovePageUp = 6
MovePrevious = 9
MoveRight = 3
MoveUp = 0
MultiSelection = 2
NoDragDrop = 0
NoEditTriggers = 0
NoFrame = 0
NoSelection = 0
NoState = 0
OnItem = 0
OnViewport = 3
class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1
PdmHeight = 2
PdmWidthMM = 3
PdmHeightMM = 4
PdmNumColors = 5
PdmDepth = 6
PdmDpiX = 7
PdmDpiY = 8
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
Panel = 2
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
Plain = 16
PositionAtBottom = 2
PositionAtCenter = 3
PositionAtTop = 1
Raised = 32
class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1
DrawChildren = 2
IgnoreMask = 4
class ResizeMode(value)

Bases: enum.Enum

An enumeration.

Interactive = 0
Fixed = 2
Stretch = 1
ResizeToContents = 3
Custom = 2
ResizeToContents = 3
class ScrollHint(value)

Bases: enum.Enum

An enumeration.

EnsureVisible = 0
PositionAtTop = 1
PositionAtBottom = 2
PositionAtCenter = 3
class ScrollMode(value)

Bases: enum.Enum

An enumeration.

ScrollPerItem = 0
ScrollPerPixel = 1
ScrollPerItem = 0
ScrollPerPixel = 1
SelectColumns = 2
SelectItems = 0
SelectRows = 1
SelectedClicked = 4
class SelectionBehavior(value)

Bases: enum.Enum

An enumeration.

SelectItems = 0
SelectRows = 1
SelectColumns = 2
class SelectionMode(value)

Bases: enum.Enum

An enumeration.

NoSelection = 0
SingleSelection = 1
MultiSelection = 2
ExtendedSelection = 3
ContiguousSelection = 4
class Shadow(value)

Bases: enum.IntEnum

An enumeration.

Plain = 16
Raised = 32
Sunken = 48
Shadow_Mask = 240
class Shape(value)

Bases: enum.IntEnum

An enumeration.

NoFrame = 0
Box = 1
Panel = 2
WinPanel = 3
HLine = 4
VLine = 5
StyledPanel = 6
Shape_Mask = 15
SingleSelection = 1
class SizeAdjustPolicy(value)

Bases: enum.Enum

An enumeration.

AdjustIgnored = 0
AdjustToContentsOnFirstShow = 1
AdjustToContents = 2
class State(value)

Bases: enum.Enum

An enumeration.

NoState = 0
DraggingState = 1
DragSelectingState = 2
EditingState = 3
ExpandingState = 4
CollapsingState = 5
AnimatingState = 6
Stretch = 1
class StyleMask(value)

Bases: enum.Enum

An enumeration.

Shadow_Mask = 240
Shape_Mask = 15
StyledPanel = 6
Sunken = 48
VLine = 5
WinPanel = 3
__len__()

Return len(self).

acceptDrops(self) bool
accessibleDescription(self) str
accessibleName(self) str
actionEvent(self, a0: QActionEvent)
actions(self) List[QAction]
activateWindow(self)
activated

activated(self, index: QModelIndex) [signal]

addAction(self, action: QAction)
addActions(self, actions: Iterable[QAction])
addScrollBarWidget(self, widget: QWidget, alignment: Qt.AlignmentFlag)
adjustSize(self)
alternatingRowColors(self) bool
autoFillBackground(self) bool
autoScrollMargin(self) int
backgroundRole(self) QPalette.ColorRole
baseSize(self) QSize
blockSignals(self, b: bool) bool
cascadingSectionResizes(self) bool
changeEvent(self, a0: QEvent)
childAt(self, p: QPoint) QWidget
childAt(self, ax: int, ay: int) QWidget
childEvent(self, a0: QChildEvent)
children(self) List[QObject]
childrenRect(self) QRect
childrenRegion(self) QRegion
clearFocus(self)
clearMask(self)
clearSelection(self)
clicked

clicked(self, index: QModelIndex) [signal]

close(self) bool
closeEditor(self, editor: QWidget, hint: QAbstractItemDelegate.EndEditHint)
closeEvent(self, a0: QCloseEvent)
closePersistentEditor(self, index: QModelIndex)
colorCount(self) int
commitData(self, editor: QWidget)
connectNotify(self, signal: QMetaMethod)
contentsMargins(self) QMargins
contentsRect(self) QRect
contextMenuEvent(self, a0: QContextMenuEvent)
contextMenuPolicy(self) Qt.ContextMenuPolicy
cornerWidget(self) QWidget
count(self) int
create(self, window: PyQt6.sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
createWindowContainer(window: QWindow, parent: typing.Optional[QWidget] = None, flags: Qt.WindowType = Qt.WindowFlags()) QWidget
currentChanged(self, current: QModelIndex, old: QModelIndex)
currentIndex(self) QModelIndex
cursor(self) QCursor
customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)
dataChanged(self, topLeft: QModelIndex, bottomRight: QModelIndex, roles: Iterable[int] = [])
defaultAlignment(self) Qt.AlignmentFlag
defaultDropAction(self) Qt.DropAction
defaultSectionSize(self) int
deleteLater(self)
depth(self) int
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
destroyed

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

devType(self) int
devicePixelRatio(self) float
devicePixelRatioF(self) float
devicePixelRatioFScale() float
dirtyRegionOffset(self) QPoint
disconnect(a0: QMetaObject.Connection) bool
disconnect(self) None
disconnectNotify(self, signal: QMetaMethod)
doubleClicked

doubleClicked(self, index: QModelIndex) [signal]

dragDropMode(self) QAbstractItemView.DragDropMode
dragDropOverwriteMode(self) bool
dragEnabled(self) bool
dragEnterEvent(self, e: QDragEnterEvent)
dragLeaveEvent(self, e: QDragLeaveEvent)
dragMoveEvent(self, e: QDragMoveEvent)
drawFrame(self, a0: QPainter)
dropEvent(self, e: QDropEvent)
dropIndicatorPosition(self) QAbstractItemView.DropIndicatorPosition
dumpObjectInfo(self)
dumpObjectTree(self)
dynamicPropertyNames(self) List[QByteArray]
edit(self, index: QModelIndex)
edit(self, index: QModelIndex, trigger: QAbstractItemView.EditTrigger, event: QEvent) bool
editTriggers(self) QAbstractItemView.EditTrigger
editorDestroyed(self, editor: QObject)
effectiveWinId(self) PyQt6.sip.voidptr
ensurePolished(self)
enterEvent(self, event: QEnterEvent)
entered

entered(self, index: QModelIndex) [signal]

event(self, e: QEvent) bool
eventFilter(self, object: QObject, event: QEvent) bool
executeDelayedItemsLayout(self)
find(a0: PyQt6.sip.voidptr) QWidget
findChild(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChild(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) QObject
findChildren(self, type: type, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, name: str = '', options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, type: type, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
findChildren(self, types: Tuple, re: QRegularExpression, options: Qt.FindChildOption = Qt.FindChildrenRecursively) List[QObject]
focusInEvent(self, e: QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, next: bool) bool
focusOutEvent(self, e: QFocusEvent)
focusPolicy(self) Qt.FocusPolicy
focusPreviousChild(self) bool
focusProxy(self) QWidget
focusWidget(self) QWidget
font(self) QFont
fontInfo(self) QFontInfo
fontMetrics(self) QFontMetrics
foregroundRole(self) QPalette.ColorRole
frameGeometry(self) QRect
frameRect(self) QRect
frameShadow(self) QFrame.Shadow
frameShape(self) QFrame.Shape
frameSize(self) QSize
frameStyle(self) int
frameWidth(self) int
geometriesChanged

geometriesChanged(self) [signal]

geometry(self) QRect
grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(- 1, - 1))) QPixmap
grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlag = Qt.GestureFlags())
grabKeyboard(self)
grabMouse(self)
grabMouse(self, a0: Union[QCursor, Qt.CursorShape]) None
grabShortcut(self, key: Union[QKeySequence, QKeySequence.StandardKey, str, int], context: Qt.ShortcutContext = Qt.WindowShortcut) int
graphicsEffect(self) QGraphicsEffect
graphicsProxyWidget(self) QGraphicsProxyWidget
hasAutoScroll(self) bool
hasFocus(self) bool
hasHeightForWidth(self) bool
hasMouseTracking(self) bool
hasTabletTracking(self) bool
headerDataChanged(self, orientation: Qt.Orientation, logicalFirst: int, logicalLast: int)
height(self) int
heightForWidth(self, a0: int) int
heightMM(self) int
hiddenSectionCount(self) int
hide(self)
hideEvent(self, a0: QHideEvent)
hideSection(self, alogicalIndex: int)
highlightSections(self) bool
horizontalOffset(self) int
horizontalScrollBar(self) QScrollBar
horizontalScrollBarPolicy(self) Qt.ScrollBarPolicy
horizontalScrollMode(self) QAbstractItemView.ScrollMode
horizontalScrollbarAction(self, action: int)
horizontalScrollbarValueChanged(self, value: int)
iconSize(self) QSize
iconSizeChanged

iconSizeChanged(self, size: QSize) [signal]

indexAt(self, p: QPoint) QModelIndex
indexWidget(self, index: QModelIndex) QWidget
inherits(self, classname: str) bool
initPainter(self, painter: QPainter)
initStyleOption(self, option: QStyleOptionHeader)
initStyleOptionForIndex(self, option: QStyleOptionHeader, logicalIndex: int)
initViewItemOption(self, option: QStyleOptionViewItem)
initialize(self)
initializeSections(self)
initializeSections(self, start: int, end: int) None
inputMethodEvent(self, event: QInputMethodEvent)
inputMethodHints(self) Qt.InputMethodHint
inputMethodQuery(self, query: Qt.InputMethodQuery) Any
insertAction(self, before: QAction, action: QAction)
insertActions(self, before: QAction, actions: Iterable[QAction])
installEventFilter(self, a0: QObject)
isActiveWindow(self) bool
isAncestorOf(self, child: QWidget) bool
isEnabled(self) bool
isEnabledTo(self, a0: QWidget) bool
isFirstSectionMovable(self) bool
isFullScreen(self) bool
isHidden(self) bool
isIndexHidden(self, index: QModelIndex) bool
isLeftToRight(self) bool
isMaximized(self) bool
isMinimized(self) bool
isModal(self) bool
isPersistentEditorOpen(self, index: QModelIndex) bool
isRightToLeft(self) bool
isSectionHidden(self, logicalIndex: int) bool
isSignalConnected(self, signal: QMetaMethod) bool
isSortIndicatorClearable(self) bool
isSortIndicatorShown(self) bool
isVisible(self) bool
isVisibleTo(self, a0: QWidget) bool
isWidgetType(self) bool
isWindow(self) bool
isWindowModified(self) bool
isWindowType(self) bool
itemDelegate(self) QAbstractItemDelegate
itemDelegateForColumn(self, column: int) QAbstractItemDelegate
itemDelegateForIndex(self, index: QModelIndex) QAbstractItemDelegate
itemDelegateForRow(self, row: int) QAbstractItemDelegate
keyPressEvent(self, e: QKeyEvent)
keyReleaseEvent(self, a0: QKeyEvent)
keyboardGrabber() QWidget
keyboardSearch(self, search: str)
killTimer(self, id: int)
layout(self) QLayout
layoutDirection(self) Qt.LayoutDirection
leaveEvent(self, a0: QEvent)
length(self) int
lineWidth(self) int
locale(self) QLocale
logicalDpiX(self) int
logicalDpiY(self) int
logicalIndex(self, visualIndex: int) int
logicalIndexAt(self, position: int) int
logicalIndexAt(self, ax: int, ay: int) int
logicalIndexAt(self, apos: QPoint) int
lower(self)
mapFrom(self, a0: QWidget, a1: QPoint) QPoint
mapFrom(self, a0: QWidget, a1: QPointF) QPointF
mapFromGlobal(self, a0: QPoint) QPoint
mapFromGlobal(self, a0: QPointF) QPointF
mapFromParent(self, a0: QPoint) QPoint
mapFromParent(self, a0: QPointF) QPointF
mapTo(self, a0: QWidget, a1: QPoint) QPoint
mapTo(self, a0: QWidget, a1: QPointF) QPointF
mapToGlobal(self, a0: QPoint) QPoint
mapToGlobal(self, a0: QPointF) QPointF
mapToParent(self, a0: QPoint) QPoint
mapToParent(self, a0: QPointF) QPointF
mask(self) QRegion
maximumHeight(self) int
maximumSectionSize(self) int
maximumSize(self) QSize
maximumViewportSize(self) QSize
maximumWidth(self) int
metaObject(self) QMetaObject
metric(self, a0: QPaintDevice.PaintDeviceMetric) int
midLineWidth(self) int
minimumHeight(self) int
minimumSectionSize(self) int
minimumSize(self) QSize
minimumSizeHint(self) QSize
minimumWidth(self) int
model(self) QAbstractItemModel
mouseDoubleClickEvent(self, e: QMouseEvent)
mouseGrabber() QWidget
mouseMoveEvent(self, e: QMouseEvent)
move(self, a0: QPoint)
move(self, ax: int, ay: int) None
moveCursor(self, a0: QAbstractItemView.CursorAction, a1: Qt.KeyboardModifier) QModelIndex
moveEvent(self, a0: QMoveEvent)
moveSection(self, from_: int, to: int)
moveToThread(self, thread: QThread)
nativeEvent(self, eventType: QByteArray, message: PyQt6.sip.voidptr) Tuple[bool, PyQt6.sip.voidptr]
nativeParentWidget(self) QWidget
nextInFocusChain(self) QWidget
normalGeometry(self) QRect
objectName(self) str
objectNameChanged

objectNameChanged(self, objectName: str) [signal]

offset(self) int
openPersistentEditor(self, index: QModelIndex)
orientation(self) Qt.Orientation
overrideWindowFlags(self, type: Qt.WindowType)
overrideWindowState(self, state: Qt.WindowState)
paintEngine(self) QPaintEngine
paintEvent(self, e: QPaintEvent)
paintSection(self, painter: QPainter, rect: QRect, logicalIndex: int)
paintingActive(self) bool
palette(self) QPalette
parent(self) QObject
parentWidget(self) QWidget
physicalDpiX(self) int
physicalDpiY(self) int
pos(self) QPoint
pressed

pressed(self, index: QModelIndex) [signal]

previousInFocusChain(self) QWidget
property(self, name: str) Any
pyqtConfigure(...)

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

raise_(self)
receivers(self, signal: PYQT_SIGNAL) int
rect(self) QRect
releaseKeyboard(self)
releaseMouse(self)
releaseShortcut(self, id: int)
removeAction(self, action: QAction)
removeEventFilter(self, a0: QObject)
render(self, target: QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren))
render(self, painter: QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground | QWidget.DrawChildren)) None
repaint(self)
repaint(self, x: int, y: int, w: int, h: int) None
repaint(self, a0: QRect) None
repaint(self, a0: QRegion) None
reset(self)
resetDefaultSectionSize(self)
resetHorizontalScrollMode(self)
resetVerticalScrollMode(self)
resize(self, a0: QSize)
resize(self, w: int, h: int) None
resizeContentsPrecision(self) int
resizeEvent(self, e: QResizeEvent)
resizeSection(self, logicalIndex: int, size: int)
resizeSections(self)
resizeSections(self, mode: QHeaderView.ResizeMode) None
restoreGeometry(self, geometry: QByteArray) bool
restoreState(self, state: QByteArray) bool
rootIndex(self) QModelIndex
rowsAboutToBeRemoved(self, parent: QModelIndex, start: int, end: int)
rowsInserted(self, parent: QModelIndex, start: int, end: int)
saveGeometry(self) QByteArray
saveState(self) QByteArray
scheduleDelayedItemsLayout(self)
screen(self) QScreen
scroll(self, dx: int, dy: int)
scroll(self, dx: int, dy: int, a2: QRect) None
scrollBarWidgets(self, alignment: Qt.AlignmentFlag) List[QWidget]
scrollContentsBy(self, dx: int, dy: int)
scrollDirtyRegion(self, dx: int, dy: int)
scrollTo(self, index: QModelIndex, hint: QAbstractItemView.ScrollHint)
scrollToBottom(self)
scrollToTop(self)
sectionClicked

sectionClicked(self, logicalIndex: int) [signal]

sectionCountChanged

sectionCountChanged(self, oldCount: int, newCount: int) [signal]

sectionDoubleClicked

sectionDoubleClicked(self, logicalIndex: int) [signal]

sectionEntered

sectionEntered(self, logicalIndex: int) [signal]

sectionHandleDoubleClicked

sectionHandleDoubleClicked(self, logicalIndex: int) [signal]

sectionMoved

sectionMoved(self, logicalIndex: int, oldVisualIndex: int, newVisualIndex: int) [signal]

sectionPosition(self, logicalIndex: int) int
sectionPressed

sectionPressed(self, logicalIndex: int) [signal]

sectionResizeMode(self, logicalIndex: int) QHeaderView.ResizeMode
sectionResized

sectionResized(self, logicalIndex: int, oldSize: int, newSize: int) [signal]

sectionSize(self, logicalIndex: int) int
sectionSizeFromContents(self, logicalIndex: int) QSize
sectionSizeHint(self, logicalIndex: int) int
sectionViewportPosition(self, logicalIndex: int) int
sectionsAboutToBeRemoved(self, parent: QModelIndex, logicalFirst: int, logicalLast: int)
sectionsClickable(self) bool
sectionsHidden(self) bool
sectionsInserted(self, parent: QModelIndex, logicalFirst: int, logicalLast: int)
sectionsMovable(self) bool
sectionsMoved(self) bool
selectAll(self)
selectedIndexes(self) List[QModelIndex]
selectionBehavior(self) QAbstractItemView.SelectionBehavior
selectionChanged(self, selected: QItemSelection, deselected: QItemSelection)
selectionCommand(self, index: QModelIndex, event: typing.Optional[QEvent] = None) QItemSelectionModel.SelectionFlag
selectionMode(self) QAbstractItemView.SelectionMode
selectionModel(self) QItemSelectionModel
sender(self) QObject
senderSignalIndex(self) int
setAcceptDrops(self, on: bool)
setAccessibleDescription(self, description: str)
setAccessibleName(self, name: str)
setAlternatingRowColors(self, enable: bool)
setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, enabled: bool)
setAutoScroll(self, enable: bool)
setAutoScrollMargin(self, margin: int)
setBackgroundRole(self, a0: QPalette.ColorRole)
setBaseSize(self, basew: int, baseh: int)
setBaseSize(self, s: QSize) None
setCascadingSectionResizes(self, enable: bool)
setContentsMargins(self, left: int, top: int, right: int, bottom: int)
setContentsMargins(self, margins: QMargins) None
setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)
setCornerWidget(self, widget: QWidget)
setCurrentIndex(self, index: QModelIndex)
setCursor(self, a0: Union[QCursor, Qt.CursorShape])
setDefaultAlignment(self, alignment: Qt.AlignmentFlag)
setDefaultDropAction(self, dropAction: Qt.DropAction)
setDefaultSectionSize(self, size: int)
setDirtyRegion(self, region: QRegion)
setDisabled(self, a0: bool)
setDragDropMode(self, behavior: QAbstractItemView.DragDropMode)
setDragDropOverwriteMode(self, overwrite: bool)
setDragEnabled(self, enable: bool)
setDropIndicatorShown(self, enable: bool)
setEditTriggers(self, triggers: QAbstractItemView.EditTrigger)
setEnabled(self, a0: bool)
setFirstSectionMovable(self, movable: bool)
setFixedHeight(self, h: int)
setFixedSize(self, a0: QSize)
setFixedSize(self, w: int, h: int) None
setFixedWidth(self, w: int)
setFocus(self)
setFocus(self, reason: Qt.FocusReason) None
setFocusPolicy(self, policy: Qt.FocusPolicy)
setFocusProxy(self, a0: QWidget)
setFont(self, a0: QFont)
setForegroundRole(self, a0: QPalette.ColorRole)
setFrameRect(self, a0: QRect)
setFrameShadow(self, a0: QFrame.Shadow)
setFrameShape(self, a0: QFrame.Shape)
setFrameStyle(self, a0: int)
setGeometry(self, a0: QRect)
setGeometry(self, ax: int, ay: int, aw: int, ah: int) None
setGraphicsEffect(self, effect: QGraphicsEffect)
setHidden(self, hidden: bool)
setHighlightSections(self, highlight: bool)
setHorizontalScrollBar(self, scrollbar: QScrollBar)
setHorizontalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setHorizontalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setIconSize(self, size: QSize)
setIndexWidget(self, index: QModelIndex, widget: QWidget)
setInputMethodHints(self, hints: Qt.InputMethodHint)
setItemDelegate(self, delegate: QAbstractItemDelegate)
setItemDelegateForColumn(self, column: int, delegate: QAbstractItemDelegate)
setItemDelegateForRow(self, row: int, delegate: QAbstractItemDelegate)
setLayout(self, a0: QLayout)
setLayoutDirection(self, direction: Qt.LayoutDirection)
setLineWidth(self, a0: int)
setLocale(self, locale: QLocale)
setMask(self, a0: QBitmap)
setMask(self, a0: QRegion) None
setMaximumHeight(self, maxh: int)
setMaximumSectionSize(self, size: int)
setMaximumSize(self, maxw: int, maxh: int)
setMaximumSize(self, s: QSize) None
setMaximumWidth(self, maxw: int)
setMidLineWidth(self, a0: int)
setMinimumHeight(self, minh: int)
setMinimumSectionSize(self, size: int)
setMinimumSize(self, minw: int, minh: int)
setMinimumSize(self, s: QSize) None
setMinimumWidth(self, minw: int)
setModel(self, model: QAbstractItemModel)
setMouseTracking(self, enable: bool)
setObjectName(self, name: str)
setOffset(self, offset: int)
setOffsetToLastSection(self)
setOffsetToSectionPosition(self, visualIndex: int)
setPalette(self, a0: QPalette)
setParent(self, parent: QWidget)
setParent(self, parent: QWidget, f: Qt.WindowType) None
setProperty(self, name: str, value: Any) bool
setResizeContentsPrecision(self, precision: int)
setRootIndex(self, index: QModelIndex)
setScreen(self, a0: QScreen)
setSectionHidden(self, logicalIndex: int, hide: bool)
setSectionResizeMode(self, logicalIndex: int, mode: QHeaderView.ResizeMode)
setSectionResizeMode(self, mode: QHeaderView.ResizeMode) None
setSectionsClickable(self, clickable: bool)
setSectionsMovable(self, movable: bool)
setSelection(self, rect: QRect, flags: QItemSelectionModel.SelectionFlag)
setSelectionBehavior(self, behavior: QAbstractItemView.SelectionBehavior)
setSelectionMode(self, mode: QAbstractItemView.SelectionMode)
setSelectionModel(self, selectionModel: QItemSelectionModel)
setShortcutAutoRepeat(self, id: int, enabled: bool = True)
setShortcutEnabled(self, id: int, enabled: bool = True)
setSizeAdjustPolicy(self, policy: QAbstractScrollArea.SizeAdjustPolicy)
setSizeIncrement(self, w: int, h: int)
setSizeIncrement(self, s: QSize) None
setSizePolicy(self, a0: QSizePolicy)
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) None
setSortIndicator(self, logicalIndex: int, order: Qt.SortOrder)
setSortIndicatorClearable(self, clearable: bool)
setSortIndicatorShown(self, show: bool)
setState(self, state: QAbstractItemView.State)
setStatusTip(self, a0: str)
setStretchLastSection(self, stretch: bool)
setStyle(self, a0: QStyle)
setStyleSheet(self, styleSheet: str)
setTabKeyNavigation(self, enable: bool)
setTabOrder(a0: QWidget, a1: QWidget)
setTabletTracking(self, enable: bool)
setTextElideMode(self, mode: Qt.TextElideMode)
setToolTip(self, a0: str)
setToolTipDuration(self, msec: int)
setUpdatesEnabled(self, enable: bool)
setVerticalScrollBar(self, scrollbar: QScrollBar)
setVerticalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)
setVerticalScrollMode(self, mode: QAbstractItemView.ScrollMode)
setViewport(self, widget: QWidget)
setViewportMargins(self, left: int, top: int, right: int, bottom: int)
setViewportMargins(self, margins: QMargins) None
setVisible(self, v: bool)
setWhatsThis(self, a0: str)
setWindowFilePath(self, filePath: str)
setWindowFlag(self, a0: Qt.WindowType, on: bool = True)
setWindowFlags(self, type: Qt.WindowType)
setWindowIcon(self, icon: QIcon)
setWindowIconText(self, a0: str)
setWindowModality(self, windowModality: Qt.WindowModality)
setWindowModified(self, a0: bool)
setWindowOpacity(self, level: float)
setWindowRole(self, a0: str)
setWindowState(self, state: Qt.WindowState)
setWindowTitle(self, a0: str)
setupViewport(self, viewport: QWidget)
sharedPainter(self) QPainter
show(self)
showDropIndicator(self) bool
showEvent(self, a0: QShowEvent)
showFullScreen(self)
showMaximized(self)
showMinimized(self)
showNormal(self)
showSection(self, alogicalIndex: int)
signalsBlocked(self) bool
size(self) QSize
sizeAdjustPolicy(self) QAbstractScrollArea.SizeAdjustPolicy
sizeHint(self) QSize
sizeHintForColumn(self, column: int) int
sizeHintForIndex(self, index: QModelIndex) QSize
sizeHintForRow(self, row: int) int
sizeIncrement(self) QSize
sizePolicy(self) QSizePolicy
sortIndicatorChanged

sortIndicatorChanged(self, logicalIndex: int, order: Qt.SortOrder) [signal]

sortIndicatorClearableChanged

sortIndicatorClearableChanged(self, clearable: bool) [signal]

sortIndicatorOrder(self) Qt.SortOrder
sortIndicatorSection(self) int
stackUnder(self, a0: QWidget)
startDrag(self, supportedActions: Qt.DropAction)
startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) int
state(self) QAbstractItemView.State
staticMetaObject = <PyQt6.QtCore.QMetaObject object>
statusTip(self) str
stretchLastSection(self) bool
stretchSectionCount(self) int
style(self) QStyle
styleSheet(self) str
swapSections(self, first: int, second: int)
tabKeyNavigation(self) bool
tabletEvent(self, a0: QTabletEvent)
testAttribute(self, attribute: Qt.WidgetAttribute) bool
textElideMode(self) Qt.TextElideMode
thread(self) QThread
timerEvent(self, e: QTimerEvent)
toolTip(self) str
toolTipDuration(self) int
tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) str
underMouse(self) bool
ungrabGesture(self, type: Qt.GestureType)
unsetCursor(self)
unsetLayoutDirection(self)
unsetLocale(self)
update(self)
update(self, index: QModelIndex) None
updateEditorData(self)
updateEditorGeometries(self)
updateGeometries(self)
updateGeometry(self)
updateMicroFocus(self, query: Qt.InputMethodQuery = Qt.ImQueryAll)
updateSection(self, logicalIndex: int)
updatesEnabled(self) bool
verticalOffset(self) int
verticalScrollBar(self) QScrollBar
verticalScrollBarPolicy(self) Qt.ScrollBarPolicy
verticalScrollMode(self) QAbstractItemView.ScrollMode
verticalScrollbarAction(self, action: int)
verticalScrollbarValueChanged(self, value: int)
viewport(self) QWidget
viewportEntered

viewportEntered(self) [signal]

viewportEvent(self, e: QEvent) bool
viewportMargins(self) QMargins
viewportSizeHint(self) QSize
visibleRegion(self) QRegion
visualIndex(self, logicalIndex: int) int
visualIndexAt(self, position: int) int
visualRect(self, index: QModelIndex) QRect
visualRegionForSelection(self, selection: QItemSelection) QRegion
whatsThis(self) str
wheelEvent(self, a0: QWheelEvent)
width(self) int
widthMM(self) int
winId(self) PyQt6.sip.voidptr
window(self) QWidget
windowFilePath(self) str
windowFlags(self) Qt.WindowType
windowHandle(self) QWindow
windowIcon(self) QIcon
windowIconChanged

windowIconChanged(self, icon: QIcon) [signal]

windowIconText(self) str
windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) Qt.WindowModality
windowOpacity(self) float
windowRole(self) str
windowState(self) Qt.WindowState
windowTitle(self) str
windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) Qt.WindowType
x(self) int
y(self) int
__init__(unclickable_cols, parent=None)
mousePressEvent(event)

If the user has pressed on an unsortable column, then make the header non-clickable so the table won’t be sorted and won’t have a new sort indicator drawn. If the user pressed on any other column, then make the header clickable so things behave normally.

Parameters

event (QtGui.QMouseEvent) – The mouse press event

mouseReleaseEvent(event)

Make the header clickable after processing the mouse release. This ensures that column headers will always respond properly to hovering, even if the user just clicked on an unclickable column.

Parameters

event (QtGui.QMouseEvent) – The mouse release event