schrodinger.application.phase.featureselector module

Widget for letting the user show/hide or enable/disable features in a hypothesis. All features are shown in a grid, and each has a checkbox next to it.

class schrodinger.application.phase.featureselector.FeatureSelector(parent=None)

Bases: PyQt6.QtWidgets.QScrollArea

This frame contains widgets for selecting one or more features in a hypothesis (e.g. A1, A2, H1, etc.). The editor has a checkbox for each feature. This frame is intended to be embedded in a layout.

selectionChanged

__init__(parent=None)

reset()

Unchecks all available checkboxes.

clear()

Remove all checkboxes from the features layout.

setFeatures(feature_names)

Initialize the editor with checkbox for each specified feature.

getFeatureCheckbox(feature_name)

Return the checkbox for the feature.

Parameters

feature_name (str) – The name of the feature (e.g. “A2”)

setSelectedFeatures(features)

Parameters

features (set of str) – The features to select/check.

Checks the checkboxes corresponding to the given set of feature, and unchecks the other checkboxes.

getSelectedFeatures()

Return a set of selected features (their names).

AdjustIgnored = 0

AdjustToContents = 2

AdjustToContentsOnFirstShow = 1

Box = 1

DrawChildren = 2

DrawWindowBackground = 1

HLine = 4

IgnoreMask = 4

NoFrame = 0

class PaintDeviceMetric(value)

Bases: enum.Enum

An enumeration.

PdmWidth = 1

PdmHeight = 2

PdmWidthMM = 3

PdmHeightMM = 4

PdmNumColors = 5

PdmDepth = 6

PdmDpiX = 7

PdmDpiY = 8

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

Panel = 2

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

Plain = 16

Raised = 32

class RenderFlag(value)

Bases: enum.Flag

An enumeration.

DrawWindowBackground = 1

DrawChildren = 2

IgnoreMask = 4

class Shadow(value)

Bases: enum.IntEnum

An enumeration.

Plain = 16

Raised = 32

Sunken = 48

Shadow_Mask = 240

class Shape(value)

Bases: enum.IntEnum

An enumeration.

NoFrame = 0

Box = 1

Panel = 2

WinPanel = 3

HLine = 4

VLine = 5

StyledPanel = 6

Shape_Mask = 15

class SizeAdjustPolicy(value)

Bases: enum.Enum

An enumeration.

AdjustIgnored = 0

AdjustToContentsOnFirstShow = 1

AdjustToContents = 2

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)

addAction(self, action: QAction)

addActions(self, actions: Iterable[QAction])

addScrollBarWidget(self, widget: QWidget, alignment: Qt.AlignmentFlag)

adjustSize(self)

alignment(self) → Qt.AlignmentFlag

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, b: bool) → bool

changeEvent(self, a0: QEvent)

childAt(self, p: QPoint) → QWidget

childAt(self, ax: int, ay: int) → QWidget

childEvent(self, a0: QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(self, a0: QCloseEvent)

colorCount(self) → int

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

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, pos: QPoint) [signal]

customEvent(self, a0: QEvent)

deleteLater(self)

depth(self) → int

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

destroyed

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

devType(self) → int

devicePixelRatio(self) → float

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(a0: QMetaObject.Connection) → bool

disconnect(self) → None

disconnectNotify(self, signal: QMetaMethod)

dragEnterEvent(self, a0: QDragEnterEvent)

dragLeaveEvent(self, a0: QDragLeaveEvent)

dragMoveEvent(self, a0: QDragMoveEvent)

drawFrame(self, a0: QPainter)

dropEvent(self, a0: QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → PyQt6.sip.voidptr

ensurePolished(self)

ensureVisible(self, x: int, y: int, xMargin: int = 50, yMargin: int = 50)

ensureWidgetVisible(self, childWidget: QWidget, xMargin: int = 50, yMargin: int = 50)

enterEvent(self, event: QEnterEvent)

event(self, a0: QEvent) → bool

eventFilter(self, a0: QObject, a1: QEvent) → bool

find(a0: PyQt6.sip.voidptr) → QWidget

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

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

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

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

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

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

focusInEvent(self, a0: QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, next: bool) → bool

focusOutEvent(self, a0: QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

frameGeometry(self) → QRect

frameRect(self) → QRect

frameShadow(self) → QFrame.Shadow

frameShape(self) → QFrame.Shape

frameSize(self) → QSize

frameStyle(self) → int

frameWidth(self) → int

geometry(self) → QRect

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

height(self) → int

heightForWidth(self, a0: int) → int

heightMM(self) → int

hide(self)

hideEvent(self, a0: QHideEvent)

horizontalScrollBar(self) → QScrollBar

horizontalScrollBarPolicy(self) → Qt.ScrollBarPolicy

inherits(self, classname: str) → bool

initPainter(self, painter: QPainter)

initStyleOption(self, option: QStyleOptionFrame)

inputMethodEvent(self, a0: QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHint

inputMethodQuery(self, a0: Qt.InputMethodQuery) → Any

insertAction(self, before: QAction, action: QAction)

insertActions(self, before: QAction, actions: Iterable[QAction])

installEventFilter(self, a0: QObject)

isActiveWindow(self) → bool

isAncestorOf(self, child: QWidget) → bool

isEnabled(self) → bool

isEnabledTo(self, a0: QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, signal: QMetaMethod) → bool

isVisible(self) → bool

isVisibleTo(self, a0: QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyPressEvent(self, a0: QKeyEvent)

keyReleaseEvent(self, a0: QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, id: int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, a0: QEvent)

lineWidth(self) → int

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, a0: QWidget, a1: QPoint) → QPoint

mapFrom(self, a0: QWidget, a1: QPointF) → QPointF

mapFromGlobal(self, a0: QPoint) → QPoint

mapFromGlobal(self, a0: QPointF) → QPointF

mapFromParent(self, a0: QPoint) → QPoint

mapFromParent(self, a0: QPointF) → QPointF

mapTo(self, a0: QWidget, a1: QPoint) → QPoint

mapTo(self, a0: QWidget, a1: QPointF) → QPointF

mapToGlobal(self, a0: QPoint) → QPoint

mapToGlobal(self, a0: QPointF) → QPointF

mapToParent(self, a0: QPoint) → QPoint

mapToParent(self, a0: QPointF) → QPointF

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

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

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]

overrideWindowFlags(self, type: Qt.WindowType)

overrideWindowState(self, state: Qt.WindowState)

paintEngine(self) → QPaintEngine

paintEvent(self, a0: QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

pos(self) → QPoint

previousInFocusChain(self) → QWidget

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

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

scrollBarWidgets(self, alignment: Qt.AlignmentFlag) → List[QWidget]

scrollContentsBy(self, dx: int, dy: int)

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, on: bool)

setAccessibleDescription(self, description: str)

setAccessibleName(self, name: str)

setAlignment(self, a0: Qt.AlignmentFlag)

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)

setCornerWidget(self, widget: QWidget)

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)

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)

setHorizontalScrollBar(self, scrollbar: QScrollBar)

setHorizontalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)

setInputMethodHints(self, hints: Qt.InputMethodHint)

setLayout(self, a0: QLayout)

setLayoutDirection(self, direction: Qt.LayoutDirection)

setLineWidth(self, a0: int)

setLocale(self, locale: QLocale)

setMask(self, a0: QBitmap)

setMask(self, a0: QRegion) → None

setMaximumHeight(self, maxh: int)

setMaximumSize(self, maxw: int, maxh: int)

setMaximumSize(self, s: QSize) → None

setMaximumWidth(self, maxw: int)

setMidLineWidth(self, a0: int)

setMinimumHeight(self, minh: int)

setMinimumSize(self, minw: int, minh: int)

setMinimumSize(self, s: QSize) → None

setMinimumWidth(self, minw: int)

setMouseTracking(self, enable: bool)

setObjectName(self, name: str)

setPalette(self, a0: QPalette)

setParent(self, parent: QWidget)

setParent(self, parent: QWidget, f: Qt.WindowType) → None

setProperty(self, name: str, value: Any) → bool

setScreen(self, a0: QScreen)

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

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

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

setStatusTip(self, a0: str)

setStyle(self, a0: QStyle)

setStyleSheet(self, styleSheet: str)

setTabOrder(a0: QWidget, a1: QWidget)

setTabletTracking(self, enable: bool)

setToolTip(self, a0: str)

setToolTipDuration(self, msec: int)

setUpdatesEnabled(self, enable: bool)

setVerticalScrollBar(self, scrollbar: QScrollBar)

setVerticalScrollBarPolicy(self, a0: Qt.ScrollBarPolicy)

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)

setWidget(self, w: QWidget)

setWidgetResizable(self, resizable: bool)

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)

showEvent(self, a0: QShowEvent)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeAdjustPolicy(self) → QAbstractScrollArea.SizeAdjustPolicy

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, a0: QWidget)

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

staticMetaObject = <PyQt6.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, a0: QTabletEvent)

takeWidget(self) → QWidget

testAttribute(self, attribute: Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, a0: QTimerEvent)

toolTip(self) → str

toolTipDuration(self) → int

tr(sourceText: str, disambiguation: typing.Optional[str] = None, n: int = - 1) → str

underMouse(self) → bool

ungrabGesture(self, type: Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, a0: QRect) → None

update(self, a0: QRegion) → None

update(self, ax: int, ay: int, aw: int, ah: int) → None

updateGeometry(self)

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

updatesEnabled(self) → bool

verticalScrollBar(self) → QScrollBar

verticalScrollBarPolicy(self) → Qt.ScrollBarPolicy

viewport(self) → QWidget

viewportEvent(self, a0: QEvent) → bool

viewportMargins(self) → QMargins

viewportSizeHint(self) → QSize

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, a0: QWheelEvent)

widget(self) → QWidget

widgetResizable(self) → bool

width(self) → int

widthMM(self) → int

winId(self) → PyQt6.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowType

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, icon: QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, iconText: str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowState

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, title: str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class schrodinger.application.phase.featureselector.FeatureRow(hypo_eid, hypo_name, feature_name, is_xvol, use_feature)

Bases: object

Data class that contains information about single feature in a hypothesis. This can be a regular feature or excluded volume.

__init__(hypo_eid, hypo_name, feature_name, is_xvol, use_feature)

Initialize feature data.

Parameters

• hypo_eid (int) – hypothesis entry id

• hypo_name (str) – hypothesis name. For custom features hypothesis name should be set to None!

• is_xvol (bool) – True if this is excluded volume and False otherwise

• feature_name (str) – feature name (empty string in case of excluded volume)

• use_feature (bool) – indicates whether checkbox for this feature is toggled on or off

class schrodinger.application.phase.featureselector.FeatureModel(parent=None)

Bases: schrodinger.ui.qt.table_helper.RowBasedTableModel

Features model.

Column

alias of <unknown>.FeatureColumns

ROW_CLASS

alias of schrodinger.application.phase.featureselector.FeatureRow

CUSTOM_HYPO_TEXT = 'Custom'

XVOL_TEXT = 'XVols'

featureToggled

getSelectedFeatures(include_pt_feats, include_custom_feats)

Returns dictionary of checked feature names. It is keyed on hypothesis entry ids and contains feature names for each hypothesis.

Parameters

• include_pt_feats (bool) – indicates that selected features that came from PT hypotheses should be included

• include_custom_feats (bool) – indicates that selected features that were manually added by the user should be included

Returns

dictionary of checked feature names

Return type

dict

getSelectedExcludedVolumes()

Returns list of hypothesis entry ids which have excluded volumes checked.

Returns

list of hypothesis entry ids, which have have excluded volumes checked

Return type

list

toggleSelection(hypo_eid, feature_name)

Flips use_feature flag for a given feature.

Parameters

• hypo_eid (int) – feature’s hypothesis entry id

• feature_name (str) – feature name

clearSelection()

Toggles of ‘use’ check boxes for all features.

selectedFeaturesCount()

Returns total number of selected features (excluding volumes).

getLastCustomFeatureNum()

Finds all ‘custom’ features and returns last feature number. For example, if custom features are [‘A1’, ‘D11’, ‘R5’] last custom feature number will be 11.

updateFeatureNames(marker_features)

This function updates feature names in the model so that they are consistent with markers feature names. This is needed when user changes feature type using edit feature dialog. In this case only a single feature row needs to be modified.

Parameters

marker_features – dictionary of feature marker names keyed on hypothesis entry ids.

CHECKABLE_COLS = ()

COLUMN = None

class CheckIndexOption(value)

Bases: enum.Flag

An enumeration.

NoOption = 0

IndexIsValid = 1

DoNotUseParent = 2

ParentIsInvalid = 4

EDITABLE_COLS = <object object>

HorizontalSortHint = 2

class LayoutChangeHint(value)

Bases: enum.Enum

An enumeration.

NoLayoutChangeHint = 0

VerticalSortHint = 1

HorizontalSortHint = 2

NO_DATA_CHANGED = <object object>

NoLayoutChangeHint = 0

ROW_LIST_OFFSET = 0

SHOW_ROW_NUMBERS = False

UNEDITABLE_COLS = <object object>

VerticalSortHint = 1

__init__(parent=None)

af2SettingsGetValue()

This function adds support for the settings mixin. It allows to save table cell values in case this table is included in the settings panel. Returns list of rows if table model is of RowBasedTableModel class type.

Returns

list of rows in tbe table’s model.

Return type

list or None

af2SettingsSetValue(value)

This function adds support for the settings mixin. It allows to set table cell values when this table is included in the settings panel.

Parameters

value (list) – settings value, which is a list of row data here.

appendRow(*args, **kwargs)

Add a row to the table. All arguments are passed to ROW_CLASS initialization.

Returns

The row number of the new row

Return type

int

appendRowObject(row)

Add a row to the table.

Parameters

row (ROW_CLASS) – Row object to add to the table.

Returns

The row number of the new row

Return type

int

appendRowObjects(rows)

Add rows to the table.

Parameters

rows (ROW_CLASS) – Row objects to add to the table.

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

columnChanged(col_number)

Call this method when a specific column object has been modified. Will cause the view to redraw that column.

Parameters

col_number (int) – 0-indexed column number in the model.

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(index, role=ItemDataRole.DisplayRole)

Provide data for the specified index and role. Classes should not redefine this method. Instead, new methods should be created and decorated with data_method.

See Qt documentation for an explanation of arguments and return value

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

See Qt documentation for an method documentation.

formatFloat(value, role, digits, fmt='')

Format floating point values for display or sorting. If role is Qt.DisplayRole, then value will be returned as a string with the specified formatting. All other role values are assumed to be a sorting role and value will be returned unchanged.

Parameters

• value (float) – The floating point value to format

• role (int) – The Qt data role

• digits (int) – The number of digits to include after the decimal point for Qt.DisplayRole

• fmt (str) – Additional floating point formatting options

Returns

The formatted or unmodified value

Return type

str or float

hasChildren(self, parent: QModelIndex = QModelIndex()) → bool

hasIndex(self, row: int, column: int, parent: QModelIndex = QModelIndex()) → bool

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

Provide column headers, and optionally column tooltips and row numbers.

See Qt documentation for an explanation of arguments and return value

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)

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]

loadData(rows)

Load data into the table and replace all existing data.

Parameters

rows (list) – A list of ROW_CLASS objects

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]

modelResetContext()

A context manager for resetting the model. See model_reset_method for a decorator version of this.

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

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

removeRowsByIndices(indices)

Remove all rows from the model specified by the given QModelIndex items.

removeRowsByRowNumbers(rows)

Remove the given rows from the model, specified by row number, 0-indexed.

replaceRows(new_rows)

Replace the contents of the model with the contents of the given list. The change will be presented to the view as a series of row insertions and deletions rather than as a model reset. This allows the view to properly update table selections and scroll bar position. This method may only be used if:

• the ROW_CLASS objects can be compared using < and ==

• the contents of the model (i.e. self._rows) are sorted in ascending order

• the contents of new_rows are sorted in ascending order

This method is primarily intended for use when the table contains rows based on project table rows. On every project change, the project table can be reread and used to generate new_list and this method can then properly update the model.

Parameters

new_rows (list) – A list of ROW_CLASS objects

reset()

Remove all data from the model

resetInternalData(self)

revert(self)

roleNames(self) → Dict[int, QByteArray]

rowChanged(row_number)

Call this method when a specific row object has been modified. Will cause the view to redraw that row.

Parameters

row_number (int) – 0-indexed row number in the model. Corresponds to the index in the “.rows” iterator.

rowCount(self, parent: QModelIndex = QModelIndex()) → int

property rows

Iterate over all rows in the model. If any data is changed, call rowChanged() method with the row’s 0-indexed number to update the view.

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(index, value, role=ItemDataRole.EditRole)

Set data for the specified index and role. Whenever possible, sub- classes should redefine _setData rather than this method.

See Qt documentation for an explanation of arguments and return value.

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