schrodinger.application.bioluminate.propfilter module

This contains a QDialog class that allows the user to define criteria to filter properties by.

It also contains classes that hold the criteria and determine if properties match the criteria.

Copyright Schrodinger, LLC. All rights reserved.

class schrodinger.application.bioluminate.propfilter.StringDatabaseCriterion(dataname, username, criteria, joiner='')

Bases: object

Holds a criterion for a string property and determines whether a database object or structure meets that criterion

__init__(dataname, username, criteria, joiner='')

Create a StringDatabaseCriterion object

Parameters

• dataname (str) – The internal name of the property this criterion checks. The dataname is of the form x_y_z.

• username (str) – The name the user sees for this property

• criteria (list of tuple) – List of one or two criterion. Each criterion is a tuple consisting of (operator, value). operator is some relationship defined by the constants in this module, and value is the target value. For instance, in property > 5, ‘>’ is the operator and 5 is the value.

Operator constants are:

• EQUALS

• NOT_EQUALS

• CONTAINS

• STARTSWITH

• ENDSWITH

• NOT_CONTAINS

• EXISTS

• NOT_EXISTS

• SELECT

• GREATEREQUAL

• LESSEREQUAL

• GREATER

• LESSER

• IS_TRUE

• IS_FALSE

For the SELECT operator, value can be a list of values. A property that matches any one of those values exactly matches the criterion.

Parameters

joiner (str) – If two criteria are provided, joiner is the boolean that connects them - either AND or OR. Default is the empty string, which means that only the first criterion in the criteria list will be examined.

checkForMatch(obj_val, operator, goal, isCaseSensitive=False)

Check to see if a value matches this criterion. Returns True if::

“obj_val operator goal” (“Schrodinger contains odin” returns True)

Parameters

• obj_val (str) – The value being checked

• operator (str) – An operator as defined in the __init__ method criteria paramater.

• goal (str or list) – The value to compare against, or in the case of the SELECT operator, goal is a list of str

Return type

bool

Returns

True if “obj_val operator goal” is True, False if not

Raises

ValueError – if operator is not recognized

matches(dbobj=None, struct=None, stem='bioluminate', isCaseSensitive=False)

Checks to see if a schrodinger.application.prime.packages.PrimeStructureDatabase.PrimeStructureDBEntry database object or a schrodinger.structure.Structure object matches this Criterion.

Parameters

• dbobj (schrodinger.application.prime.package.PrimeStructureDatabase.PrimeStructureDBEntry) – The database object to check for a match. Only dbobj or struct should be provided, but not both. If both are provided, the struct object is checked and the dbobj is ignored.

• struct (schrodinger.structure.Structure) – The Structure object to check for a match. Only dbobj or struct should be provided, but not both. If both are provided, the struct object is checked and the dbobj is ignored.

• stem (str) – If given, this value will be inserted at the beginning of the second part of the Criterion property name when checking a struct object. Property x_y_z will become x_stemy_z. Default is ‘bioluminate’. This is done because the database removes stem from property names when storing data.

Return type

bool

Returns

True if the provided object passes this Criterion, False if not.

class schrodinger.application.bioluminate.propfilter.NumericalDatabaseCriterion(dataname, username, criteria, joiner='')

Bases: schrodinger.application.bioluminate.propfilter.StringDatabaseCriterion

checkForMatch(obj_val, operator, goal, isCaseSensitive=None)

Check to see if a value matches this criterion. Returns True if::

“obj_val operator goal” (“20 >= 10” returns True)

Parameters

• obj_val (int or float) – The value being checked

• operator (int or float) – An operator as defined in the __init__ method of the StringDatabaseCriterion class criteria paramater.

• goal (int, float or list) – The value to compare against, or in the case of the SELECT operator, goal is a list of int or float

• isCaseSensitive – ignored (added for compatibility with base class)

Return type

bool

Returns

True if “obj_val operator goal” is True, False if not

Raises

ValueError – if operator is not recognized

__init__(dataname, username, criteria, joiner='')

Create a StringDatabaseCriterion object

Parameters

• dataname (str) – The internal name of the property this criterion checks. The dataname is of the form x_y_z.

• username (str) – The name the user sees for this property

• criteria (list of tuple) – List of one or two criterion. Each criterion is a tuple consisting of (operator, value). operator is some relationship defined by the constants in this module, and value is the target value. For instance, in property > 5, ‘>’ is the operator and 5 is the value.

Operator constants are:

• EQUALS

• NOT_EQUALS

• CONTAINS

• STARTSWITH

• ENDSWITH

• NOT_CONTAINS

• EXISTS

• NOT_EXISTS

• SELECT

• GREATEREQUAL

• LESSEREQUAL

• GREATER

• LESSER

• IS_TRUE

• IS_FALSE

For the SELECT operator, value can be a list of values. A property that matches any one of those values exactly matches the criterion.

Parameters

joiner (str) – If two criteria are provided, joiner is the boolean that connects them - either AND or OR. Default is the empty string, which means that only the first criterion in the criteria list will be examined.

matches(dbobj=None, struct=None, stem='bioluminate', isCaseSensitive=False)

Checks to see if a schrodinger.application.prime.packages.PrimeStructureDatabase.PrimeStructureDBEntry database object or a schrodinger.structure.Structure object matches this Criterion.

Parameters

• dbobj (schrodinger.application.prime.package.PrimeStructureDatabase.PrimeStructureDBEntry) – The database object to check for a match. Only dbobj or struct should be provided, but not both. If both are provided, the struct object is checked and the dbobj is ignored.

• struct (schrodinger.structure.Structure) – The Structure object to check for a match. Only dbobj or struct should be provided, but not both. If both are provided, the struct object is checked and the dbobj is ignored.

• stem (str) – If given, this value will be inserted at the beginning of the second part of the Criterion property name when checking a struct object. Property x_y_z will become x_stemy_z. Default is ‘bioluminate’. This is done because the database removes stem from property names when storing data.

Return type

bool

Returns

True if the provided object passes this Criterion, False if not.

class schrodinger.application.bioluminate.propfilter.BooleanDatabaseCriterion(dataname, username, criteria, joiner='')

Bases: schrodinger.application.bioluminate.propfilter.StringDatabaseCriterion

checkForMatch(obj_val, operator, goal=None, isCaseSensitive=None)

Check to see if a value matches this criterion. Returns True if::

“obj_val operator” (“Schrodinger is True” returns True)

Parameters

• obj_val (int or float) – The value being checked

• operator (int or float) – An operator as defined in the __init__ method of the StringDatabaseCriterion class criteria paramater.

• goal – Not used, none of the Boolean operators requires a value to compare against.

• isCaseSensitive – ignored (added for compatibility with base class)

Return type

bool

Returns

True if “obj_val operator” is True, False if not

Raises

ValueError – if operator is not recognized

__init__(dataname, username, criteria, joiner='')

Create a StringDatabaseCriterion object

Parameters

• dataname (str) – The internal name of the property this criterion checks. The dataname is of the form x_y_z.

• username (str) – The name the user sees for this property

• criteria (list of tuple) – List of one or two criterion. Each criterion is a tuple consisting of (operator, value). operator is some relationship defined by the constants in this module, and value is the target value. For instance, in property > 5, ‘>’ is the operator and 5 is the value.

Operator constants are:

• EQUALS

• NOT_EQUALS

• CONTAINS

• STARTSWITH

• ENDSWITH

• NOT_CONTAINS

• EXISTS

• NOT_EXISTS

• SELECT

• GREATEREQUAL

• LESSEREQUAL

• GREATER

• LESSER

• IS_TRUE

• IS_FALSE

For the SELECT operator, value can be a list of values. A property that matches any one of those values exactly matches the criterion.

Parameters

joiner (str) – If two criteria are provided, joiner is the boolean that connects them - either AND or OR. Default is the empty string, which means that only the first criterion in the criteria list will be examined.

matches(dbobj=None, struct=None, stem='bioluminate', isCaseSensitive=False)

Checks to see if a schrodinger.application.prime.packages.PrimeStructureDatabase.PrimeStructureDBEntry database object or a schrodinger.structure.Structure object matches this Criterion.

Parameters

• dbobj (schrodinger.application.prime.package.PrimeStructureDatabase.PrimeStructureDBEntry) – The database object to check for a match. Only dbobj or struct should be provided, but not both. If both are provided, the struct object is checked and the dbobj is ignored.

• struct (schrodinger.structure.Structure) – The Structure object to check for a match. Only dbobj or struct should be provided, but not both. If both are provided, the struct object is checked and the dbobj is ignored.

• stem (str) – If given, this value will be inserted at the beginning of the second part of the Criterion property name when checking a struct object. Property x_y_z will become x_stemy_z. Default is ‘bioluminate’. This is done because the database removes stem from property names when storing data.

Return type

bool

Returns

True if the provided object passes this Criterion, False if not.

class schrodinger.application.bioluminate.propfilter.CriteriaListModel

Bases: PyQt5.QtCore.QAbstractListModel

Class for storing the criteria list information.

__init__()

Initialize self. See help(type(self)) for accurate signature.

rowCount(parent=<PyQt5.QtCore.QModelIndex object>)

Returns number of rows

clear()

addLine(line, linetype=None)

data(index, role=0)

Given a cell index, returns the data that should be displayed in that cell (text or check button state). Used by the view.

flags(index)

Returns flags for the specified cell. Whether selectable or not.

class CheckIndexOption(value)

Bases: enum.IntEnum

An enumeration.

DoNotUseParent = 2

IndexIsValid = 1

NoOption = 0

ParentIsInvalid = 4

class CheckIndexOptions

Bases: sip.simplewrapper

QAbstractItemModel.CheckIndexOptions(Union[QAbstractItemModel.CheckIndexOptions, QAbstractItemModel.CheckIndexOption]) QAbstractItemModel.CheckIndexOptions(QAbstractItemModel.CheckIndexOptions)

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

HorizontalSortHint = 2

class LayoutChangeHint

Bases: int

NoLayoutChangeHint = 0

VerticalSortHint = 1

CriteriaListModel.beginInsertColumns(self, QModelIndex, int, int)

CriteriaListModel.beginInsertRows(self, QModelIndex, int, int)

CriteriaListModel.beginMoveColumns(self, QModelIndex, int, int, QModelIndex, int) -> bool

CriteriaListModel.beginMoveRows(self, QModelIndex, int, int, QModelIndex, int) -> bool

CriteriaListModel.beginRemoveColumns(self, QModelIndex, int, int)

CriteriaListModel.beginRemoveRows(self, QModelIndex, int, int)

beginResetModel(self)

blockSignals(self, bool) → bool

buddy(self, QModelIndex) → QModelIndex

canDropMimeData(self, QMimeData, Qt.DropAction, int, int, QModelIndex) → bool

canFetchMore(self, QModelIndex) → bool

CriteriaListModel.changePersistentIndex(self, QModelIndex, QModelIndex)

changePersistentIndexList(self, Iterable[QModelIndex], Iterable[QModelIndex])

checkIndex(self, QModelIndex, options: Union[QAbstractItemModel.CheckIndexOptions, QAbstractItemModel.CheckIndexOption] = QAbstractItemModel.CheckIndexOption.NoOption) → bool

childEvent(self, QChildEvent)

children(self) → List[QObject]

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

columnsAboutToBeInserted

columnsAboutToBeInserted(self, QModelIndex, int, int) [signal]

columnsAboutToBeMoved

columnsAboutToBeMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]

columnsAboutToBeRemoved

columnsAboutToBeRemoved(self, QModelIndex, int, int) [signal]

columnsInserted

columnsInserted(self, QModelIndex, int, int) [signal]

columnsMoved

columnsMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]

columnsRemoved

columnsRemoved(self, QModelIndex, int, int) [signal]

connectNotify(self, QMetaMethod)

CriteriaListModel.createIndex(self, int, int, object: object = 0) -> QModelIndex

customEvent(self, QEvent)

dataChanged

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

CriteriaListModel.decodeData(self, int, int, QModelIndex, QDataStream) -> bool

deleteLater(self)

destroyed

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

disconnect(self)

disconnectNotify(self, QMetaMethod)

dropMimeData(self, QMimeData, Qt.DropAction, int, int, QModelIndex) → bool

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

encodeData(self, Iterable[QModelIndex], QDataStream)

endInsertColumns(self)

endInsertRows(self)

endMoveColumns(self)

endMoveRows(self)

endRemoveColumns(self)

endRemoveRows(self)

endResetModel(self)

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

fetchMore(self, QModelIndex)

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

findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject

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

findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]

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

CriteriaListModel.hasIndex(self, int, int, parent: QModelIndex = QModelIndex()) -> bool

headerData(self, int, Qt.Orientation, role: int = Qt.DisplayRole) → Any

headerDataChanged

headerDataChanged(self, Qt.Orientation, int, int) [signal]

index(self, int, column: int = 0, parent: QModelIndex = QModelIndex()) → QModelIndex

inherits(self, str) → bool

insertColumn(self, int, parent: QModelIndex = QModelIndex()) → bool

CriteriaListModel.insertColumns(self, int, int, parent: QModelIndex = QModelIndex()) -> bool

insertRow(self, int, parent: QModelIndex = QModelIndex()) → bool

CriteriaListModel.insertRows(self, int, int, parent: QModelIndex = QModelIndex()) -> bool

installEventFilter(self, QObject)

isSignalConnected(self, QMetaMethod) → bool

isWidgetType(self) → bool

isWindowType(self) → bool

itemData(self, QModelIndex) → Dict[int, Any]

killTimer(self, 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, QModelIndex, int, Any, hits: int = 1, flags: Union[Qt.MatchFlags, Qt.MatchFlag] = Qt.MatchStartsWith | Qt.MatchWrap) → List[QModelIndex]

metaObject(self) → QMetaObject

mimeData(self, Iterable[QModelIndex]) → QMimeData

mimeTypes(self) → List[str]

modelAboutToBeReset

modelAboutToBeReset(self) [signal]

modelReset

modelReset(self) [signal]

CriteriaListModel.moveColumn(self, QModelIndex, int, QModelIndex, int) -> bool

CriteriaListModel.moveColumns(self, QModelIndex, int, int, QModelIndex, int) -> bool

CriteriaListModel.moveRow(self, QModelIndex, int, QModelIndex, int) -> bool

CriteriaListModel.moveRows(self, QModelIndex, int, int, QModelIndex, int) -> bool

moveToThread(self, QThread)

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

parent(self) → QObject

persistentIndexList(self) → List[QModelIndex]

property(self, str) → Any

pyqtConfigure(...)

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

receivers(self, PYQT_SIGNAL) → int

removeColumn(self, int, parent: QModelIndex = QModelIndex()) → bool

CriteriaListModel.removeColumns(self, int, int, parent: QModelIndex = QModelIndex()) -> bool

removeEventFilter(self, QObject)

removeRow(self, int, parent: QModelIndex = QModelIndex()) → bool

CriteriaListModel.removeRows(self, int, int, parent: QModelIndex = QModelIndex()) -> bool

resetInternalData(self)

revert(self)

roleNames(self) → Dict[int, QByteArray]

rowsAboutToBeInserted

rowsAboutToBeInserted(self, QModelIndex, int, int) [signal]

rowsAboutToBeMoved

rowsAboutToBeMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]

rowsAboutToBeRemoved

rowsAboutToBeRemoved(self, QModelIndex, int, int) [signal]

rowsInserted

rowsInserted(self, QModelIndex, int, int) [signal]

rowsMoved

rowsMoved(self, QModelIndex, int, int, QModelIndex, int) [signal]

rowsRemoved

rowsRemoved(self, QModelIndex, int, int) [signal]

sender(self) → QObject

senderSignalIndex(self) → int

setData(self, QModelIndex, Any, role: int = Qt.EditRole) → bool

setHeaderData(self, int, Qt.Orientation, Any, role: int = Qt.EditRole) → bool

setItemData(self, QModelIndex, Dict[int, Any]) → bool

setObjectName(self, str)

setParent(self, QObject)

setProperty(self, str, Any) → bool

CriteriaListModel.sibling(self, int, int, QModelIndex) -> QModelIndex

signalsBlocked(self) → bool

sort(self, int, order: Qt.SortOrder = Qt.AscendingOrder)

span(self, QModelIndex) → QSize

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

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

submit(self) → bool

supportedDragActions(self) → Qt.DropActions

supportedDropActions(self) → Qt.DropActions

thread(self) → QThread

timerEvent(self, QTimerEvent)

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

class schrodinger.application.bioluminate.propfilter.SelectingFilteredListWidget(label=None, filterlabel='Filter:', filter='within', filterside='bottom', case=False, **kwargs)

Bases: schrodinger.ui.qt.swidgets.SFilteredListWidget

A QListWidget that contains a edit to allow the user to filter the contents of the widget. If a filter is being applied, all the matching contents are selected.

filterList(filtervalue)

Modified from the parent class to select all the objects in the ListWidget that match the filter.

Parameters

filtervalue (str) – The value used to filter the ListWidget

AboveItem = 1

Adjust = 1

AdjustIgnored = 0

AdjustToContents = 2

AdjustToContentsOnFirstShow = 1

AllEditTriggers = 31

AnimatingState = 6

AnyKeyPressed = 16

Batched = 1

BelowItem = 2

Box = 1

CollapsingState = 5

ContiguousSelection = 4

CurrentChanged = 1

class CursorAction

Bases: int

DoubleClicked = 2

DragDrop = 3

class DragDropMode

Bases: int

DragOnly = 1

DragSelectingState = 2

DraggingState = 1

DrawChildren = 2

DrawWindowBackground = 1

class DropIndicatorPosition

Bases: int

DropOnly = 2

EditKeyPressed = 8

class EditTrigger

Bases: int

class EditTriggers

Bases: sip.simplewrapper

QAbstractItemView.EditTriggers(Union[QAbstractItemView.EditTriggers, QAbstractItemView.EditTrigger]) QAbstractItemView.EditTriggers(QAbstractItemView.EditTriggers)

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

EditingState = 3

EnsureVisible = 0

ExpandingState = 4

ExtendedSelection = 3

Fixed = 0

class Flow

Bases: int

Free = 1

HLine = 4

IconMode = 1

IgnoreMask = 4

InternalMove = 4

class LayoutMode

Bases: int

LeftToRight = 0

ListMode = 0

MoveDown = 1

MoveEnd = 5

MoveHome = 4

MoveLeft = 2

MoveNext = 8

MovePageDown = 7

MovePageUp = 6

MovePrevious = 9

MoveRight = 3

MoveUp = 0

class Movement

Bases: int

MultiSelection = 2

NoDragDrop = 0

NoEditTriggers = 0

NoFrame = 0

NoSelection = 0

NoState = 0

OnItem = 0

OnViewport = 3

class PaintDeviceMetric

Bases: int

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

Bases: int

class RenderFlags

Bases: sip.simplewrapper

QWidget.RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) QWidget.RenderFlags(QWidget.RenderFlags)

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

class ResizeMode

Bases: int

class ScrollHint

Bases: int

class ScrollMode

Bases: int

ScrollPerItem = 0

ScrollPerPixel = 1

SelectColumns = 2

SelectItems = 0

SelectRows = 1

SelectedClicked = 4

class SelectionBehavior

Bases: int

class SelectionMode

Bases: int

class Shadow

Bases: int

Shadow_Mask = 240

class Shape

Bases: int

Shape_Mask = 15

SinglePass = 0

SingleSelection = 1

class SizeAdjustPolicy

Bases: int

Snap = 2

class State

Bases: int

Static = 0

class StyleMask

Bases: int

StyledPanel = 6

Sunken = 48

TopToBottom = 1

VLine = 5

class ViewMode

Bases: int

WinPanel = 3

__init__(label=None, filterlabel='Filter:', filter='within', filterside='bottom', case=False, **kwargs)

See the SListWidget documentation for additional keyword parameters.

Parameters

• label (str) – the text that will appear directly above the list widget

• filterlabel (str) – the label above the filter line edit.

• filter (str) – One of ‘within’, ‘start’, ‘end’. If within (default), the filter will find any item that has the filter text anywhere within its text. ‘start’ will only check if the item text starts with the filter ext, ‘end’ will only check if the item text ends with.

• filterside (str) – One of ‘top’ or ‘bottom’ (default) - the location of the filter edit relative to the list widget

• case (bool) – True if filter is case sensitive, False if not

__len__()

Return len(self).

acceptDrops(self) → bool

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

activated

activated(self, QModelIndex) [signal]

addAction(self, QAction)

addActions(self, Iterable[QAction])

addItem(text)

Add an item to the ListWidget.

Parameters

text (str or QListWidgetItem) – The text of the item to be created and added, or a QListWidget item to be added

addItems(alist)

Add a list of items to the ListWidget.

Parameters

alist (list) – list of strings to be added to the ListWidget

addScrollBarWidget(self, QWidget, Union[Qt.Alignment, Qt.AlignmentFlag])

adjustSize(self)

allItems()

Return all the items in the list widget in order.

Return type

list

Returns

list of all QListWidgetItems in the list widget in order

allItemsIter(role=256)

Return a generator over text and data of the list widget, inspired by .items() method of dict.

Parameters

role (int) – User role to pass do .data function

Return type

generator(tuple(str, type))

Returns

Generator over tupple of text and data of the list widget

allText()

Return the list of all text values.

Return type

list

Returns

List of strings

alternatingRowColors(self) → bool

autoFillBackground(self) → bool

autoScrollMargin(self) → int

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

batchSize(self) → int

blockSignals(self, bool) → bool

changeEvent(self, QEvent)

childAt(self, QPoint) → QWidget

childAt(self, int, int) -> QWidget

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clear()

Removes all items from the ListWidget

clearFocus(self)

clearMask(self)

clearPropertyFlags(self)

clearSelection(self)

clicked

clicked(self, QModelIndex) [signal]

close(self) → bool

closeEditor(self, QWidget, QAbstractItemDelegate.EndEditHint)

closeEvent(self, QCloseEvent)

closePersistentEditor(self, QListWidgetItem)

colorCount(self) → int

commitData(self, QWidget)

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

cornerWidget(self) → QWidget

count(self) → int

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

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

SelectingFilteredListWidget.currentChanged(self, QModelIndex, QModelIndex)

currentIndex(self) → QModelIndex

currentItem(self) → QListWidgetItem

currentItemChanged

currentItemChanged(self, QListWidgetItem, QListWidgetItem) [signal]

currentRow(self) → int

currentRowChanged

currentRowChanged(self, int) [signal]

currentTextChanged

currentTextChanged(self, str) [signal]

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)

SelectingFilteredListWidget.dataChanged(self, QModelIndex, 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: QObject = None) [signal]

devType(self) → int

devicePixelRatio(self) → int

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

dirtyRegionOffset(self) → QPoint

disconnect(self)

disconnectNotify(self, QMetaMethod)

doubleClicked

doubleClicked(self, QModelIndex) [signal]

dragDropMode(self) → QAbstractItemView.DragDropMode

dragDropOverwriteMode(self) → bool

dragEnabled(self) → bool

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

drawFrame(self, QPainter)

dropEvent(self, QDropEvent)

dropIndicatorPosition(self) → QAbstractItemView.DropIndicatorPosition

dropMimeData(self, int, QMimeData, Qt.DropAction) → bool

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

edit(self, QModelIndex)

edit(self, QModelIndex, QAbstractItemView.EditTrigger, QEvent) -> bool

editItem(item)

Not implemented - editing the item text will cause self._value_list and self._case_list to become obsolete.

editTriggers(self) → QAbstractItemView.EditTriggers

editorDestroyed(self, QObject)

effectiveWinId(self) → sip.voidptr

endFilter(text, filtertext)

Checks whether text ends with filtertext

Parameters

• text (str) – the text to check

• filtertext (str) – will check if text ends with filtertext.

Return type

bool

Returns

True if text ends with filtertext, False if not

ensurePolished(self)

enterEvent(self, QEvent)

entered

entered(self, QModelIndex) [signal]

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

executeDelayedItemsLayout(self)

find(sip.voidptr) → QWidget

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

findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject

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

findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]

findItems(self, str, Union[Qt.MatchFlags, Qt.MatchFlag]) → List[QListWidgetItem]

flow(self) → QListView.Flow

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

frameGeometry(self) → QRect

frameRect(self) → QRect

frameShadow(self) → QFrame.Shadow

frameShape(self) → QFrame.Shape

frameSize(self) → QSize

frameStyle(self) → int

frameWidth(self) → int

geometry(self) → QRect

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

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

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

grabKeyboard(self)

grabMouse(self)

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

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

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

gridSize(self) → QSize

hasAutoScroll(self) → bool

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, int) → int

heightMM(self) → int

hide(self)

hideEvent(self, QHideEvent)

horizontalOffset(self) → int

horizontalScrollBar(self) → QScrollBar

horizontalScrollBarPolicy(self) → Qt.ScrollBarPolicy

horizontalScrollMode(self) → QAbstractItemView.ScrollMode

horizontalScrollbarAction(self, int)

horizontalScrollbarValueChanged(self, int)

iconSize(self) → QSize

iconSizeChanged

iconSizeChanged(self, QSize) [signal]

indexAt(self, QPoint) → QModelIndex

indexFromItem(self, QListWidgetItem) → QModelIndex

indexWidget(self, QModelIndex) → QWidget

indexesMoved

indexesMoved(self, Iterable[QModelIndex]) [signal]

inherits(self, str) → bool

initPainter(self, QPainter)

initStyleOption(self, QStyleOptionFrame)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHints

inputMethodQuery(self, Qt.InputMethodQuery) → Any

SelectingFilteredListWidget.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

insertItem(index, text)

Add an item to the ListWidget.

Parameters

• index (int) – The index to insert this item at

• text (str or QListWidgetItem) – The text of the item to be created and added, or a QListWidget item to be added

insertItems(index, alist)

Add a list of items to the ListWidget.

Parameters

• index (int) – The index to insert this item at

• alist (list) – list of strings to be added to the ListWidget

installEventFilter(self, QObject)

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isIndexHidden(self, QModelIndex) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isPersistentEditorOpen(self, QListWidgetItem) → bool

isRightToLeft(self) → bool

isRowHidden(self, int) → bool

isSelectionRectVisible(self) → bool

isSignalConnected(self, QMetaMethod) → bool

isSortingEnabled(self) → bool

isVisible(self) → bool

isVisibleTo(self, QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

isWrapping(self) → bool

item(self, int) → QListWidgetItem

itemActivated

itemActivated(self, QListWidgetItem) [signal]

itemAlignment(self) → Qt.Alignment

itemAt(self, QPoint) → QListWidgetItem

itemAt(self, int, int) -> QListWidgetItem

itemChanged

itemChanged(self, QListWidgetItem) [signal]

itemClicked

itemClicked(self, QListWidgetItem) [signal]

itemDelegate(self) → QAbstractItemDelegate

itemDelegate(self, QModelIndex) -> QAbstractItemDelegate

itemDelegateForColumn(self, int) → QAbstractItemDelegate

itemDelegateForRow(self, int) → QAbstractItemDelegate

itemDoubleClicked

itemDoubleClicked(self, QListWidgetItem) [signal]

itemEntered

itemEntered(self, QListWidgetItem) [signal]

itemFromIndex(self, QModelIndex) → QListWidgetItem

itemPressed

itemPressed(self, QListWidgetItem) [signal]

itemSelectionChanged

itemSelectionChanged(self) [signal]

itemWidget(self, QListWidgetItem) → QWidget

items(self, QMimeData) → List[QListWidgetItem]

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber() → QWidget

keyboardSearch(self, str)

killTimer(self, int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

layoutMode(self) → QListView.LayoutMode

leaveEvent(self, QEvent)

lineWidth(self) → int

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFromGlobal(self, QPoint) → QPoint

mapFromParent(self, QPoint) → QPoint

mapTo(self, QWidget, QPoint) → QPoint

mapToGlobal(self, QPoint) → QPoint

mapToParent(self, QPoint) → QPoint

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumViewportSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

midLineWidth(self) → int

mimeData(self, Iterable[QListWidgetItem]) → QMimeData

mimeTypes(self) → List[str]

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

model(self) → QAbstractItemModel

modelColumn(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

move(self, int, int)

moveCursor(self, QAbstractItemView.CursorAction, Union[Qt.KeyboardModifiers, Qt.KeyboardModifier]) → QModelIndex

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

movement(self) → QListView.Movement

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

nativeParentWidget(self) → QWidget

newItem(text, index=None)

Adds a new string to _value_list and _case_list. Adds it lowercase if we do case insensitive filtering to save time during the actual filter process.

Does not add the item to the ListWidget (though item will be added the next time filtering is done)

Parameters

• text (str) – The text give to the item

• index (int) – The index to insert this item at

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

openPersistentEditor(self, QListWidgetItem)

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

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

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

pos(self) → QPoint

pressed

pressed(self, QModelIndex) [signal]

previousInFocusChain(self) → QWidget

property(self, str) → Any

pyqtConfigure(...)

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

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

rectForIndex(self, QModelIndex) → QRect

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

removeItem(item)

Removes and returns the given item

Parameters

item (QListWidgetItem or 0) – The item to be removed from the list widget or 0 if it is not found in the list widget

removeItemByText(text)

Removes and returns the item with the given text

Parameters

text (str) – the text of the item to be removed

Return type

QListWidgetItem or None

Returns

The removed item, or None if an item with the given text is not found.

removeItemWidget(self, QListWidgetItem)

removeSelectedItems()

Removes selected items.

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

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

repaint(self)

repaint(self, int, int, int, int) repaint(self, QRect) repaint(self, QRegion)

reset(self)

resetHorizontalScrollMode(self)

resetVerticalScrollMode(self)

resize(self, QSize)

resize(self, int, int)

resizeEvent(self, QResizeEvent)

resizeMode(self) → QListView.ResizeMode

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

rootIndex(self) → QModelIndex

row(self, QListWidgetItem) → int

rowByText(text, match=0)

Returns the row that a given text is in.

Parameters

• text (str) – The text to find

• match (Qt.MatchFlag) – Type of match to search for - default is exact

Return type

int or False

Returns

Row that holds matched text (can be 0), if text is not matched, returns False

SelectingFilteredListWidget.rowsAboutToBeRemoved(self, QModelIndex, int, int)

SelectingFilteredListWidget.rowsInserted(self, QModelIndex, int, int)

saveGeometry(self) → QByteArray

scheduleDelayedItemsLayout(self)

SelectingFilteredListWidget.scroll(self, int, int)

scroll(self, int, int, QRect)

scrollBarWidgets(self, Union[Qt.Alignment, Qt.AlignmentFlag]) → List[QWidget]

SelectingFilteredListWidget.scrollContentsBy(self, int, int)

SelectingFilteredListWidget.scrollDirtyRegion(self, int, int)

scrollTo(self, QModelIndex, hint: QAbstractItemView.ScrollHint = QAbstractItemView.EnsureVisible)

scrollToBottom(self)

scrollToItem(self, QListWidgetItem, hint: QAbstractItemView.ScrollHint = QAbstractItemView.EnsureVisible)

scrollToTop(self)

selectAll(self)

selectedIndexes(self) → List[QModelIndex]

selectedItems(self) → List[QListWidgetItem]

selectedText()

Return the list of selected text values.

Return type

list

Returns

List of strings, each member is the text of a selected item

selectionBehavior(self) → QAbstractItemView.SelectionBehavior

SelectingFilteredListWidget.selectionChanged(self, QItemSelection, QItemSelection)

selectionCommand(self, QModelIndex, event: QEvent = None) → QItemSelectionModel.SelectionFlags

selectionMode(self) → QAbstractItemView.SelectionMode

selectionModel(self) → QItemSelectionModel

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

setAlternatingRowColors(self, bool)

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

setAutoFillBackground(self, bool)

setAutoScroll(self, bool)

setAutoScrollMargin(self, int)

setBackgroundRole(self, QPalette.ColorRole)

SelectingFilteredListWidget.setBaseSize(self, int, int)

setBaseSize(self, QSize)

setBatchSize(self, int)

SelectingFilteredListWidget.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins)

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

setCornerWidget(self, QWidget)

setCurrentIndex(self, QModelIndex)

setCurrentItem(self, QListWidgetItem)

setCurrentItem(self, QListWidgetItem, Union[QItemSelectionModel.SelectionFlags, QItemSelectionModel.SelectionFlag])

setCurrentRow(self, int)

setCurrentRow(self, int, Union[QItemSelectionModel.SelectionFlags, QItemSelectionModel.SelectionFlag])

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

setDefaultDropAction(self, Qt.DropAction)

setDirtyRegion(self, QRegion)

setDisabled(self, bool)

setDragDropMode(self, QAbstractItemView.DragDropMode)

setDragDropOverwriteMode(self, bool)

setDragEnabled(self, bool)

setDropIndicatorShown(self, bool)

setEditTriggers(self, Union[QAbstractItemView.EditTriggers, QAbstractItemView.EditTrigger])

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

setFixedSize(self, int, int)

setFixedWidth(self, int)

setFlow(self, QListView.Flow)

setFocus(self)

setFocus(self, Qt.FocusReason)

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setFrameRect(self, QRect)

setFrameShadow(self, QFrame.Shadow)

setFrameShape(self, QFrame.Shape)

setFrameStyle(self, int)

setGeometry(self, QRect)

setGeometry(self, int, int, int, int)

setGraphicsEffect(self, QGraphicsEffect)

setGridSize(self, QSize)

setHidden(self, bool)

setHorizontalScrollBar(self, QScrollBar)

setHorizontalScrollBarPolicy(self, Qt.ScrollBarPolicy)

setHorizontalScrollMode(self, QAbstractItemView.ScrollMode)

setIconSize(self, QSize)

setIndexWidget(self, QModelIndex, QWidget)

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

setItemAlignment(self, Union[Qt.Alignment, Qt.AlignmentFlag])

setItemDelegate(self, QAbstractItemDelegate)

setItemDelegateForColumn(self, int, QAbstractItemDelegate)

setItemDelegateForRow(self, int, QAbstractItemDelegate)

setItemWidget(self, QListWidgetItem, QWidget)

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLayoutMode(self, QListView.LayoutMode)

setLineWidth(self, int)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion)

setMaximumHeight(self, int)

SelectingFilteredListWidget.setMaximumSize(self, int, int)

setMaximumSize(self, QSize)

setMaximumWidth(self, int)

setMidLineWidth(self, int)

setMinimumHeight(self, int)

SelectingFilteredListWidget.setMinimumSize(self, int, int)

setMinimumSize(self, QSize)

setMinimumWidth(self, int)

setModel(self, QAbstractItemModel)

setModelColumn(self, int)

setMouseTracking(self, bool)

setMovement(self, QListView.Movement)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

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

setPositionForIndex(self, QPoint, QModelIndex)

setProperty(self, str, Any) → bool

setResizeMode(self, QListView.ResizeMode)

setRootIndex(self, QModelIndex)

setRowHidden(self, int, bool)

setSelection(self, QRect, Union[QItemSelectionModel.SelectionFlags, QItemSelectionModel.SelectionFlag])

setSelectionBehavior(self, QAbstractItemView.SelectionBehavior)

setSelectionMode(self, QAbstractItemView.SelectionMode)

setSelectionModel(self, QItemSelectionModel)

setSelectionRectVisible(self, bool)

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

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

setSizeAdjustPolicy(self, QAbstractScrollArea.SizeAdjustPolicy)

SelectingFilteredListWidget.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize)

setSizePolicy(self, QSizePolicy)

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

setSortingEnabled(self, bool)

setSpacing(self, int)

setState(self, QAbstractItemView.State)

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

setTabKeyNavigation(self, bool)

SelectingFilteredListWidget.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setTextElideMode(self, Qt.TextElideMode)

setTextSelected(text, selected=True)

Selects the item with the given text

Parameters

• text (str) – the text of the item to be selected

• selected (bool) – True if the item should be selected, False if it should be deselected.

Return type

bool

Returns

True if an item with the given text is found, False if not

setToolTip(self, str)

setToolTipDuration(self, int)

setUniformItemSizes(self, bool)

setUpdatesEnabled(self, bool)

setVerticalScrollBar(self, QScrollBar)

setVerticalScrollBarPolicy(self, Qt.ScrollBarPolicy)

setVerticalScrollMode(self, QAbstractItemView.ScrollMode)

setViewMode(self, QListView.ViewMode)

setViewport(self, QWidget)

SelectingFilteredListWidget.setViewportMargins(self, int, int, int, int)

setViewportMargins(self, QMargins)

setVisible(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

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

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

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

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

setWindowTitle(self, str)

setWordWrap(self, bool)

setWrapping(self, bool)

setupViewport(self, QWidget)

sharedPainter(self) → QPainter

show(self)

showDropIndicator(self) → bool

showEvent(self, QShowEvent)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeAdjustPolicy(self) → QAbstractScrollArea.SizeAdjustPolicy

sizeHint(self) → QSize

sizeHintForColumn(self, int) → int

sizeHintForIndex(self, QModelIndex) → QSize

sizeHintForRow(self, int) → int

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

sortItems(self, order: Qt.SortOrder = Qt.AscendingOrder)

spacing(self) → int

stackUnder(self, QWidget)

startDrag(self, Union[Qt.DropActions, Qt.DropAction])

startFilter(text, filtertext)

Checks whether text starts with filtertext

Parameters

• text (str) – the text to check

• filtertext (str) – will check if text starts with filtertext.

Return type

bool

Returns

True if text starts with filtertext, False if not

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

state(self) → QAbstractItemView.State

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

supportedDropActions(self) → Qt.DropActions

tabKeyNavigation(self) → bool

tabletEvent(self, QTabletEvent)

takeItem(row)

Removes an item from the ListWidget

Parameters

row (int) – the row number to remove

Return type

QListWidgetItem or 0

Returns

The removed item, or 0 if an item with the given text is not found.

testAttribute(self, Qt.WidgetAttribute) → bool

textElideMode(self) → Qt.TextElideMode

thread(self) → QThread

timerEvent(self, QTimerEvent)

toolTip(self) → str

toolTipDuration(self) → int

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

trueIndexByText(text)

Returns the index of text in the the overall list of items, not just those currently displayed in the ListWidget.

Parameters

text (str) – the text to search for

Return type

int or None

Returns

The index of the text in the overall list of items, or None if text is not found

underMouse(self) → bool

ungrabGesture(self, Qt.GestureType)

uniformItemSizes(self) → bool

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QModelIndex)

updateEditorData(self)

updateEditorGeometries(self)

updateGeometries(self)

updateGeometry(self)

updateMicroFocus(self)

updatesEnabled(self) → bool

verticalOffset(self) → int

verticalScrollBar(self) → QScrollBar

verticalScrollBarPolicy(self) → Qt.ScrollBarPolicy

verticalScrollMode(self) → QAbstractItemView.ScrollMode

verticalScrollbarAction(self, int)

verticalScrollbarValueChanged(self, int)

viewMode(self) → QListView.ViewMode

viewOptions(self) → QStyleOptionViewItem

viewport(self) → QWidget

viewportEntered

viewportEntered(self) [signal]

viewportEvent(self, QEvent) → bool

viewportMargins(self) → QMargins

viewportSizeHint(self) → QSize

visibleRegion(self) → QRegion

visualItemRect(self, QListWidgetItem) → QRect

visualRect(self, QModelIndex) → QRect

visualRegionForSelection(self, QItemSelection) → QRegion

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowFlags

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowStates

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

withinFilter(text, filtertext)

Checks whether filtertext is contained within text - case insensitive

Parameters

• text (str) – the text to check

• filtertext (str) – will check for the existance of this text within text.

Return type

bool

Returns

True if filtertext is found within text, False if not

wordWrap(self) → bool

x(self) → int

y(self) → int

class schrodinger.application.bioluminate.propfilter.PropertySelectorWithRanges(master, *args, **kwargs)

Bases: schrodinger.ui.qt.propertyselector.PropertySelector

A PropertySelector class that appends ranges to the names of numeric properties.

__init__(master, *args, **kwargs)

Create a PropertySelectorWithRanges instance.

Parameters

master (object with getPropertyMinMax method) – The master panel that supplies the min and max values of numerical properties for the range display

checkUserNames()

Assigns PropertyName.user_name attributes, for all members in self.proplist. The user_names are unique within the PropertySelector instance.

The user_name strings are typically just the PropertyName.userName(), but may be modified with a numerical suffix to make them unique, or decorated with the family name (which does not garuntee uniqeness, but may make the items easier for the end user to visually group).

addToAuxListbox()

Adds items selected in self.listbox to self.aux_listbox.

alphabetizeNames(is_toggled)

Alternate order the displayed list items, either alphabetically or in the native order depending on the value of self.alpha_toggle.

Parameters

is_toggled (bool) – whether to alphabetize the property names

createFamilies()

Create a dictionary of families. PropertyName.family keys for a list of PropertyNames in that family.

delFromAuxListbox()

Removes selected item from self.aux_listbox.

deselectAll()

Clear property selection

displayProperties(display_list, selected_list=None)

Adjust the display state and selection states to specified lists of PropertyName objects. Use only when selection or display state changes. Use setProperties() to use different properties.

display_list (list)

A list of PropertyName objects to display.

selected_list (list)

A list of PropertyName objects to select.

filterProperties(props)

Limit the specified list items to those items that match the self.filter_field filter regex and family option menu.

filteringChanged(ignored)

Called when value of the family pull-down menu is changed.

getAuxListboxSelection()

getListboxSelection()

getSelected()

Return a list of selected PropertyName objects.

moveAuxSelectedDown()

Reorders the displayed list items in self.aux_listbox such that the selected item moves down one rung in the listbox.

moveAuxSelectedUp()

Reorders the displayed list items in self.aux_listbox such that the selected item moves up one rung in the listbox.

selectAll()

Select all properties in the listbox.

setEnabled(enabled)

Enable/disable the PropertySelector widget

setProperties(proplist, selected_indexes=None)

Set the listbox items to the structure.PropertyName.user_name attributes for the PropertyName instances in proplist.

Parameters

• proplist (list of str (data names) or structure.PropertyName.) – A list of properties to show.

• selected_indexes (list of int) – List of indexes of <proplist> that should be initially selected.

setupUi(Form)

showAuxProperties(proplist, selected_indexes=None)

Display the auxilary listbox items to the structure.PropertyName.user_name attributes for the PropertyName instances in proplist.

proplist (list)

List of structure.PropertyName instances.

selected_indexes (list)

List of indexes of <proplist> that should be selected.

sortAlphabetically(proplist)

sortByInitialOrder(proplist)

updateButtonStates()

Enable or disable buttons as needed. Called when selection in the tables changes.

class schrodinger.application.bioluminate.propfilter.ValueSelectionDialog(parent, values, propmenu, value_edit)

Bases: PyQt5.QtWidgets.QDialog

A SFilteredListWidget that allows the user to select certain values of a property for the criterion.

__init__(parent, values, propmenu, value_edit)

Create a ValueSelectionDialog instance

Parameters

• parent (QWidget with setSelectedValues method) – The parent widget of this dialog. The accept method of this dialog calls the setSelectedValues method of the parent with the list of selected text in the QListWidget

• values (list) – List of values to display in the QListWidget

• propmenu (QComboBox or object with setCurrentIndex method) – The cancel method of this dialog sets propmenu.setCurrentIndex(0)

• value_edit – value_edit is passed to parent.setSelectedValues in the accept method of the dialog

accept()

Actions when the user presses the accept button. Calls parent.setSelectedValues(values, value_edit) where values is a list of selected values and value_edit is passed to the __init__ method

reject()

Actions when the user presses the cancel button. Calls propmenu.setCurrentIndex(0) on the propmenu passed to the __init__ function.

Accepted = 1

class DialogCode

Bases: int

DrawChildren = 2

DrawWindowBackground = 1

IgnoreMask = 4

class PaintDeviceMetric

Bases: int

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

Rejected = 0

class RenderFlag

Bases: int

class RenderFlags

Bases: sip.simplewrapper

QWidget.RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) QWidget.RenderFlags(QWidget.RenderFlags)

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

acceptDrops(self) → bool

accepted

accepted(self) [signal]

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

adjustSize(self)

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, bool) → bool

changeEvent(self, QEvent)

childAt(self, QPoint) → QWidget

childAt(self, int, int) -> QWidget

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(self, QCloseEvent)

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

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

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

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)

deleteLater(self)

depth(self) → int

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

destroyed

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

devType(self) → int

devicePixelRatio(self) → int

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(self)

disconnectNotify(self, QMetaMethod)

done(self, int)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → sip.voidptr

ensurePolished(self)

enterEvent(self, QEvent)

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

exec(self) → int

exec_(self) → int

find(sip.voidptr) → QWidget

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

findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject

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

findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]

finished

finished(self, int) [signal]

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

frameGeometry(self) → QRect

frameSize(self) → QSize

geometry(self) → QRect

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

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

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

grabKeyboard(self)

grabMouse(self)

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

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

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, int) → int

heightMM(self) → int

hide(self)

hideEvent(self, QHideEvent)

inherits(self, str) → bool

initPainter(self, QPainter)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHints

inputMethodQuery(self, Qt.InputMethodQuery) → Any

ValueSelectionDialog.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

installEventFilter(self, QObject)

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, QMetaMethod) → bool

isSizeGripEnabled(self) → bool

isVisible(self) → bool

isVisibleTo(self, QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, QEvent)

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFromGlobal(self, QPoint) → QPoint

mapFromParent(self, QPoint) → QPoint

mapTo(self, QWidget, QPoint) → QPoint

mapToGlobal(self, QPoint) → QPoint

mapToParent(self, QPoint) → QPoint

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

move(self, int, int)

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

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

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

open(self)

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

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

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

pos(self) → QPoint

previousInFocusChain(self) → QWidget

property(self, str) → Any

pyqtConfigure(...)

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

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

rejected

rejected(self) [signal]

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

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

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

repaint(self)

repaint(self, int, int, int, int) repaint(self, QRect) repaint(self, QRegion)

resize(self, QSize)

resize(self, int, int)

resizeEvent(self, QResizeEvent)

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

result(self) → int

saveGeometry(self) → QByteArray

ValueSelectionDialog.scroll(self, int, int)

scroll(self, int, int, QRect)

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

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

setAutoFillBackground(self, bool)

setBackgroundRole(self, QPalette.ColorRole)

ValueSelectionDialog.setBaseSize(self, int, int)

setBaseSize(self, QSize)

ValueSelectionDialog.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins)

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

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

setDisabled(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

setFixedSize(self, int, int)

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason)

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setGeometry(self, QRect)

setGeometry(self, int, int, int, int)

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

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

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion)

setMaximumHeight(self, int)

ValueSelectionDialog.setMaximumSize(self, int, int)

setMaximumSize(self, QSize)

setMaximumWidth(self, int)

setMinimumHeight(self, int)

ValueSelectionDialog.setMinimumSize(self, int, int)

setMinimumSize(self, QSize)

setMinimumWidth(self, int)

setModal(self, bool)

setMouseTracking(self, bool)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

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

setProperty(self, str, Any) → bool

setResult(self, int)

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

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

setSizeGripEnabled(self, bool)

ValueSelectionDialog.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize)

setSizePolicy(self, QSizePolicy)

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

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

ValueSelectionDialog.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

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

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

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

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

setWindowTitle(self, str)

sharedPainter(self) → QPainter

show(self)

showEvent(self, QShowEvent)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

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

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, QTimerEvent)

toolTip(self) → str

toolTipDuration(self) → int

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

underMouse(self) → bool

ungrabGesture(self, Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QRect) update(self, QRegion) update(self, int, int, int, int)

updateGeometry(self)

updateMicroFocus(self)

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowFlags

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowStates

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class schrodinger.application.bioluminate.propfilter.PropFilterDialog(parent, criteria=None, databases=None)

Bases: PyQt5.QtWidgets.QDialog

Panel to allow the user to define criteria for filtering property values

__init__(parent, criteria=None, databases=None)

Create a PropFilterDialog instance

Parameters

• parent (QWidget or object with setCriteria method) – The accept method of this dialog calls the setCriteria method of the parent with a list of StringDatabaseCriterion, NumericalDatabaseCriterion and BooleanDatabaseCriterion objects defined by the user

• criteria (list) – A list of existing StringDatabaseCriterion, NumericalDatabaseCriterion and BooleanDatabaseCriterion objects that will display and can be deleted in this panel

• database (schrodinger.application.prime.packages.PrimeStructureDatabase.PrimeStructureDB) – The database to open during panel creation. If no database is provided, either a database will have to be provided with the loadDatabase method or properties passed in via the setProperties method before displaying the panel.

getCumulativeMatches()

accept()

Add the selected criteria to the parent - calls parent.setCriteria() with a list of StringDatabaseCriterion, NumericalDatabaseCriterion and BooleanDatabaseCriterion objects

filterSelectionChanged(selected=None, deselected=None)

Enables or disables the Delete button as appropriate depending on the selection in the Criteria display area

Parameters

• selected – Unused

• deselected – Unused

selectProperty()

Populate the property name edit with the property name of the property the user just selected.

joinerChanged(result)

Enable/disable the second criteria widgets as appropriate for the joiner (“”, AND, OR) that the user just selected.

Parameters

result (str) – The current value selected in the joiner combobox

updateText()

Rewrite the text in the criteria text box

loadDatabases(databases)

Load in the data from the database - populates the upper text box with property names. Adds Misc, Light, or Heavy to property names so the user can filter them by class.

Parameters

database (schrodinger.application.prime.packages.PrimeStructureDatabase.PrimeStructureDB) – The database to load data from

convertToClassToken(s)

This function converts given string to one of class tokens (either ‘Light’, ‘Heavy’ or ‘Misc’). Valid ‘light’ and ‘heavy’ strings are defined in light and heavy variables respectively.

Parameters

s (str) – property class string

Returns

class token

Return type

str

findCommonDatanames(databases)

This function find column names that are present in all databases.

Parameters

databases (list) – List of the databases to load data from.

Returns

list of common column names

Return type

list

addCriterion()

Adds a criterion when the user hits the Add button

operator1Changed(result)

Disable/enable the value edit as appropriate for the selected operator. Opens a ValueSelectionDialog if the operator is SELECT.

Parameters

result (str) – The current value in the 1st operator combobox

operater2Changed(result)

Disable/enable the value edit as appropriate for the selected operator. Opens a ValueSelectionDialog if the operator is SELECT.

Parameters

result (str) – The current value in the 2nd operator combobox

letUserSelectValues(propmenu, value_edit)

Open a ValueSelectionDialog to allow the user to select values of the property that will match the criterion.

Parameters

• propmenu (QComboBox or object with setCurrentIndex method) – The cancel method of the dialog sets propmenu.setCurrentIndex(0)

• value_edit – value_edit is passed to setSelectedValues in the accept method of the dialog

setSelectedValues(values, value_edit)

Called by ValueSelectionDialog to set the text in the proper value_edit to the values the user selected.

Parameters

• values (list) – list of values selected by the user

• value_edit (QLineEdit) – The edit that values should be placed in

checkPropertyType(prop)

Callback for modifications to the property QLineEdit. Adjust the operator list and value validator according to the property type entered.

Parameters

prop (str) – The current value of the property QLineEdit

deleteEntry()

Delete the selected criterion or pattern

setDefaults(criteria=None)

Set the panel defaults

Parameters

criteria (list) – Pre-existing StringDatabaseCriterion, NumericalDatabaseCriterion and BooleanDatabaseCriterion objects that should be added the criterion area

setProperties(property_names)

Set the list of properties the user can choose from.

Parameters

property_names (list of schrodinger.structure.PropertyName) – Each item of the list is a schrodinger.structure.PropertyName object for a property that the user can select from

warning(text)

Pop up a warning dialog

Parameters

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

Accepted = 1

class DialogCode

Bases: int

DrawChildren = 2

DrawWindowBackground = 1

IgnoreMask = 4

class PaintDeviceMetric

Bases: int

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

Rejected = 0

class RenderFlag

Bases: int

class RenderFlags

Bases: sip.simplewrapper

QWidget.RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) QWidget.RenderFlags(QWidget.RenderFlags)

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

acceptDrops(self) → bool

accepted

accepted(self) [signal]

accessibleDescription(self) → str

accessibleName(self) → str

actionEvent(self, QActionEvent)

actions(self) → List[QAction]

activateWindow(self)

addAction(self, QAction)

addActions(self, Iterable[QAction])

adjustSize(self)

autoFillBackground(self) → bool

backgroundRole(self) → QPalette.ColorRole

baseSize(self) → QSize

blockSignals(self, bool) → bool

changeEvent(self, QEvent)

childAt(self, QPoint) → QWidget

childAt(self, int, int) -> QWidget

childEvent(self, QChildEvent)

children(self) → List[QObject]

childrenRect(self) → QRect

childrenRegion(self) → QRegion

clearFocus(self)

clearMask(self)

close(self) → bool

closeEvent(self, QCloseEvent)

colorCount(self) → int

connectNotify(self, QMetaMethod)

contentsMargins(self) → QMargins

contentsRect(self) → QRect

contextMenuEvent(self, QContextMenuEvent)

contextMenuPolicy(self) → Qt.ContextMenuPolicy

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

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

cursor(self) → QCursor

customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)

deleteLater(self)

depth(self) → int

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

destroyed

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

devType(self) → int

devicePixelRatio(self) → int

devicePixelRatioF(self) → float

devicePixelRatioFScale() → float

disconnect(self)

disconnectNotify(self, QMetaMethod)

done(self, int)

dragEnterEvent(self, QDragEnterEvent)

dragLeaveEvent(self, QDragLeaveEvent)

dragMoveEvent(self, QDragMoveEvent)

dropEvent(self, QDropEvent)

dumpObjectInfo(self)

dumpObjectTree(self)

dynamicPropertyNames(self) → List[QByteArray]

effectiveWinId(self) → sip.voidptr

ensurePolished(self)

enterEvent(self, QEvent)

event(self, QEvent) → bool

eventFilter(self, QObject, QEvent) → bool

exec(self) → int

exec_(self) → int

find(sip.voidptr) → QWidget

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

findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject

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

findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegExp, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, type, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject] findChildren(self, Tuple, QRegularExpression, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]

finished

finished(self, int) [signal]

focusInEvent(self, QFocusEvent)

focusNextChild(self) → bool

focusNextPrevChild(self, bool) → bool

focusOutEvent(self, QFocusEvent)

focusPolicy(self) → Qt.FocusPolicy

focusPreviousChild(self) → bool

focusProxy(self) → QWidget

focusWidget(self) → QWidget

font(self) → QFont

fontInfo(self) → QFontInfo

fontMetrics(self) → QFontMetrics

foregroundRole(self) → QPalette.ColorRole

frameGeometry(self) → QRect

frameSize(self) → QSize

geometry(self) → QRect

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

getPropertyMinMax(property)

Get the min and max values of property from the database.

Parameters

property (str) – The name of a database property to get the min and max of

Return type

list

Returns

[min, max] of property. Returns [None, None] if the database is not defined.

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

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

grabKeyboard(self)

grabMouse(self)

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

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

graphicsEffect(self) → QGraphicsEffect

graphicsProxyWidget(self) → QGraphicsProxyWidget

hasFocus(self) → bool

hasHeightForWidth(self) → bool

hasMouseTracking(self) → bool

hasTabletTracking(self) → bool

height(self) → int

heightForWidth(self, int) → int

heightMM(self) → int

hide(self)

hideEvent(self, QHideEvent)

inherits(self, str) → bool

initPainter(self, QPainter)

inputMethodEvent(self, QInputMethodEvent)

inputMethodHints(self) → Qt.InputMethodHints

inputMethodQuery(self, Qt.InputMethodQuery) → Any

PropFilterDialog.insertAction(self, QAction, QAction)

insertActions(self, QAction, Iterable[QAction])

installEventFilter(self, QObject)

isActiveWindow(self) → bool

isAncestorOf(self, QWidget) → bool

isEnabled(self) → bool

isEnabledTo(self, QWidget) → bool

isFullScreen(self) → bool

isHidden(self) → bool

isLeftToRight(self) → bool

isMaximized(self) → bool

isMinimized(self) → bool

isModal(self) → bool

isRightToLeft(self) → bool

isSignalConnected(self, QMetaMethod) → bool

isSizeGripEnabled(self) → bool

isVisible(self) → bool

isVisibleTo(self, QWidget) → bool

isWidgetType(self) → bool

isWindow(self) → bool

isWindowModified(self) → bool

isWindowType(self) → bool

keyPressEvent(self, QKeyEvent)

keyReleaseEvent(self, QKeyEvent)

keyboardGrabber() → QWidget

killTimer(self, int)

layout(self) → QLayout

layoutDirection(self) → Qt.LayoutDirection

leaveEvent(self, QEvent)

locale(self) → QLocale

logicalDpiX(self) → int

logicalDpiY(self) → int

lower(self)

mapFrom(self, QWidget, QPoint) → QPoint

mapFromGlobal(self, QPoint) → QPoint

mapFromParent(self, QPoint) → QPoint

mapTo(self, QWidget, QPoint) → QPoint

mapToGlobal(self, QPoint) → QPoint

mapToParent(self, QPoint) → QPoint

mask(self) → QRegion

maximumHeight(self) → int

maximumSize(self) → QSize

maximumWidth(self) → int

metaObject(self) → QMetaObject

metric(self, QPaintDevice.PaintDeviceMetric) → int

minimumHeight(self) → int

minimumSize(self) → QSize

minimumSizeHint(self) → QSize

minimumWidth(self) → int

mouseDoubleClickEvent(self, QMouseEvent)

mouseGrabber() → QWidget

mouseMoveEvent(self, QMouseEvent)

mousePressEvent(self, QMouseEvent)

mouseReleaseEvent(self, QMouseEvent)

move(self, QPoint)

move(self, int, int)

moveEvent(self, QMoveEvent)

moveToThread(self, QThread)

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

nativeParentWidget(self) → QWidget

nextInFocusChain(self) → QWidget

normalGeometry(self) → QRect

objectName(self) → str

objectNameChanged

objectNameChanged(self, str) [signal]

open(self)

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

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

paintEngine(self) → QPaintEngine

paintEvent(self, QPaintEvent)

paintingActive(self) → bool

palette(self) → QPalette

parent(self) → QObject

parentWidget(self) → QWidget

physicalDpiX(self) → int

physicalDpiY(self) → int

pos(self) → QPoint

previousInFocusChain(self) → QWidget

property(self, str) → Any

pyqtConfigure(...)

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

raise_(self)

receivers(self, PYQT_SIGNAL) → int

rect(self) → QRect

reject(self)

rejected

rejected(self) [signal]

releaseKeyboard(self)

releaseMouse(self)

releaseShortcut(self, int)

removeAction(self, QAction)

removeEventFilter(self, QObject)

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

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

repaint(self)

repaint(self, int, int, int, int) repaint(self, QRect) repaint(self, QRegion)

resize(self, QSize)

resize(self, int, int)

resizeEvent(self, QResizeEvent)

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

result(self) → int

saveGeometry(self) → QByteArray

PropFilterDialog.scroll(self, int, int)

scroll(self, int, int, QRect)

sender(self) → QObject

senderSignalIndex(self) → int

setAcceptDrops(self, bool)

setAccessibleDescription(self, str)

setAccessibleName(self, str)

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

setAutoFillBackground(self, bool)

setBackgroundRole(self, QPalette.ColorRole)

PropFilterDialog.setBaseSize(self, int, int)

setBaseSize(self, QSize)

PropFilterDialog.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins)

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

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

setDisabled(self, bool)

setEnabled(self, bool)

setFixedHeight(self, int)

setFixedSize(self, QSize)

setFixedSize(self, int, int)

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason)

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setGeometry(self, QRect)

setGeometry(self, int, int, int, int)

setGraphicsEffect(self, QGraphicsEffect)

setHidden(self, bool)

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

setLayout(self, QLayout)

setLayoutDirection(self, Qt.LayoutDirection)

setLocale(self, QLocale)

setMask(self, QBitmap)

setMask(self, QRegion)

setMaximumHeight(self, int)

PropFilterDialog.setMaximumSize(self, int, int)

setMaximumSize(self, QSize)

setMaximumWidth(self, int)

setMinimumHeight(self, int)

PropFilterDialog.setMinimumSize(self, int, int)

setMinimumSize(self, QSize)

setMinimumWidth(self, int)

setModal(self, bool)

setMouseTracking(self, bool)

setObjectName(self, str)

setPalette(self, QPalette)

setParent(self, QWidget)

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

setProperty(self, str, Any) → bool

setResult(self, int)

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

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

setSizeGripEnabled(self, bool)

PropFilterDialog.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize)

setSizePolicy(self, QSizePolicy)

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

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

PropFilterDialog.setTabOrder(QWidget, QWidget)

setTabletTracking(self, bool)

setToolTip(self, str)

setToolTipDuration(self, int)

setUpdatesEnabled(self, bool)

setVisible(self, bool)

setWhatsThis(self, str)

setWindowFilePath(self, str)

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

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

setWindowIcon(self, QIcon)

setWindowIconText(self, str)

setWindowModality(self, Qt.WindowModality)

setWindowModified(self, bool)

setWindowOpacity(self, float)

setWindowRole(self, str)

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

setWindowTitle(self, str)

sharedPainter(self) → QPainter

show(self)

showEvent(self, QShowEvent)

showFullScreen(self)

showMaximized(self)

showMinimized(self)

showNormal(self)

signalsBlocked(self) → bool

size(self) → QSize

sizeHint(self) → QSize

sizeIncrement(self) → QSize

sizePolicy(self) → QSizePolicy

stackUnder(self, QWidget)

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

staticMetaObject = <PyQt5.QtCore.QMetaObject object>

statusTip(self) → str

style(self) → QStyle

styleSheet(self) → str

tabletEvent(self, QTabletEvent)

testAttribute(self, Qt.WidgetAttribute) → bool

thread(self) → QThread

timerEvent(self, QTimerEvent)

toolTip(self) → str

toolTipDuration(self) → int

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

underMouse(self) → bool

ungrabGesture(self, Qt.GestureType)

unsetCursor(self)

unsetLayoutDirection(self)

unsetLocale(self)

update(self)

update(self, QRect) update(self, QRegion) update(self, int, int, int, int)

updateGeometry(self)

updateMicroFocus(self)

updatesEnabled(self) → bool

visibleRegion(self) → QRegion

whatsThis(self) → str

wheelEvent(self, QWheelEvent)

width(self) → int

widthMM(self) → int

winId(self) → sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowFlags

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowStates

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int