schrodinger.ui.qt.filedialog module

Schrodinger version of the QFileDialog class of the QtGui module.

Defines a FileDialog class that mimics the Maestro’s file dialogs.

Copyright Schrodinger, LLC. All rights reserved.

schrodinger.ui.qt.filedialog.use_native_file_dialog()
schrodinger.ui.qt.filedialog.filter_string_from_formats(formats=['maestro'])

Create a Qt file dialog filter string from a list of structure formats.

Parameters:formats (list of str) – List of formats, see schrodinger.utils.fileutils module for available format string constants.
Returns:Filter string
Return type:str
class schrodinger.ui.qt.filedialog.CustomSideBarMixin

Bases: object

__init__

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

schrodinger.ui.qt.filedialog.get_existing_directory(parent='', caption='Choose Directory', dir=None, accept_label='Choose', file_mode=4, **kwargs)

Convenience function that returns a directory name as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Parameters:file_mode (QFileDialog.FileMode) – What the user can select. See the PyQt documentation for QFileDialog.FileMode (currently AnyFile, ExistingFile, Directory and ExistingFiles are the options). Note that despite what the PyQt documentation states, it appears that QFileDialog.DirectoryOnly is needed to only display directores - it is not sufficient to use QFileDialog.Directory and setOptions(ShowDirsOnly). Use QFileDialog.Directory to have the dialog also show the files in each directory.
Return type:str or None
Returns:full pathname of the file selected by the user, or None if Cancel was pressed
schrodinger.ui.qt.filedialog.get_save_file_name(parent='', caption='Save File', dir=None, filter='All Files (*)', accept_label='Save', accept_mode=1, file_mode=0, **kwargs)

Convenience function that returns a filename as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Return type:str or None
Returns:full pathname of the file selected by the user, or None if Cancel was pressed
schrodinger.ui.qt.filedialog.get_open_file_names(parent='', caption='Open Files', dir=None, filter='All Files (*)', accept_label='Open', file_mode=3, **kwargs)

Convenience function that returns a list of filenames as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Return type:list of str or None
Returns:list of full file pathnames selected by the user, or None if Cancel was pressed.
schrodinger.ui.qt.filedialog.get_open_file_name(parent='', caption='Open File', dir=None, filter='All Files (*)', **kwargs)

Convenience function that returns a single filename as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Return type:str or None
Returns:full pathname of the file selected by the user, or None if Cancel was pressed
schrodinger.ui.qt.filedialog.get_open_wm_file_name(parent='', dir=None, **kwargs)

Convenience function that returns a single WaterMap file as selected by the user.

See base_file_dialog for documentation.

Returns:Full pathname of the WaterMap file selected by the user or None if cancel was pressed.
Return type:str or None
schrodinger.ui.qt.filedialog.get_last_selected_directory(idval)

Return the last directory selected by a user in a dialog with the given id value. If there is no entry for the given id value, None is returned.

Parameters:idval (str, int or float) – The value passed to a filedialog using the id keyword argument
Return type:str or None
Returns:The last directory opened by a dialog with the given id value, or None if no entry exists for the id value.
schrodinger.ui.qt.filedialog.base_file_dialog(parent='', caption='Open File', dir=None, filter='All Files (*)', selectedFilter=None, options=None, default_suffix=None, default_filename=None, accept_label='Open', accept_mode=0, file_mode=1, confirm=True, custom_sidebar=True, sidebar_links=None, id=None)

Convenience function that creates a highly customizable file dialog

Parameters:
  • parent (qwidget) – the widget over which this dialog should be shown.
  • caption (str) – the name that appears in the titlebar of this dialog.
  • dir (str) – the initial directory displayed in this dialog
  • filter (str) – the list of filters that can be applied to this directory. the format is "Filetype1 (*.ex1);;Filetype2 (*.ex2 *.ex3)".
  • selectedFilter (str) – the filter used by default. if not specified, the first filter in the filters string is used.
  • options (qfiledialog.option enum) – see the qfiledialog.option and qfiledialog.setoptions documentation
  • default_suffix (str) – the suffix applied to a filename if the user does supply one. the suffix will have a leading ‘.’ appended to it.
  • default_filename (str) – A default base filename to use to save files in save dialogs. By default, the filename field of the dialog is blank.
  • accept_label (str) – the text on the ‘accept’ button
  • accept_mode (qfiledialog.acceptmode) – whether the dialog is in open or save mode. see the pyqt documentation for qfiledialog.acceptmode (currently acceptopen and acceptsave are the two options)
  • file_mode (qfiledialog.filemode) – what the user can select. see the pyqt documentation for qfiledialog.filemode (currently anyfile, existingfile, directory and existingfiles are the options)
  • confirm (bool) – true if a confirmation dialog should be used if the user selects an existing file, false if not
  • custom_sidebar (bool) – True if the Schrodinger sidebar should be used, False if the default PyQt sidebar should be used.
  • sidebar_links (dict) – Used to create extra links in the left-hand sidebar of the dialog. The keys of the dictionary are a unique identifier for each link (note that ‘home’ and ‘working’ are already used), and the values are tuples of the form (path, name) where path and name are str, path indicates the path the sidebar link points to, and name is the name displayed for the link.
  • id (str, int or float) – The identifier used for this dialog. Dialogs with the same identifier will remember the last directory chosen by the user with any dialog of the same id and open in that directory. The dir keyword parameter can be used to override the initial directory the dialog opens in, but the chosen directory will still be stored for the next time a dialog with the same identifier opens. The default (no id given) is to not remember the chosen directory. Additionally, the id is used to keep track of recent places for the given file dialog.
Return type:

list or None

Returns:

list of full file pathnames selected by the user, or none if cancel was pressed. Note that all pathnames are strings, and have been converted to platform-consistent pathnames via os.path.normpath.

schrodinger.ui.qt.filedialog.fix_splitter(dialog)

Alters the splitter between the file pane and the directory pane so that both sides are visible. Because Qt saves the state of the dialog, if the users moves the splitter all the way to one side or the other, all future dialogs will show up that way, and it can be very confusing if the file side isn’t shown.

Parameters:dialog (QtWidgets.QFileDialog) – The dialog to check & fix if necessary
class schrodinger.ui.qt.filedialog.FileDialog(parent=None, caption='', directory='', filter='All Files (*)', custom_sidebar=True, sidebar_links=None)

Bases: PyQt5.QtWidgets.QFileDialog, schrodinger.ui.qt.filedialog.CustomSideBarMixin

File browser dialog with custom sidebar.

This class name was changed from QFileDialog to FileDialog because PyQt on the Mac OS uses Mac native dialogs instead of the class object if the class name is QFileDialog.

static getExistingDirectory(parent='', caption='Choose Directory', dir=None, accept_label='Choose', file_mode=4, **kwargs)

Convenience function that returns a directory name as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Parameters:file_mode (QFileDialog.FileMode) – What the user can select. See the PyQt documentation for QFileDialog.FileMode (currently AnyFile, ExistingFile, Directory and ExistingFiles are the options). Note that despite what the PyQt documentation states, it appears that QFileDialog.DirectoryOnly is needed to only display directores - it is not sufficient to use QFileDialog.Directory and setOptions(ShowDirsOnly). Use QFileDialog.Directory to have the dialog also show the files in each directory.
Return type:str or None
Returns:full pathname of the file selected by the user, or None if Cancel was pressed
static getSaveFileName(parent='', caption='Save File', dir=None, filter='All Files (*)', accept_label='Save', accept_mode=1, file_mode=0, **kwargs)

Convenience function that returns a filename as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Return type:str or None
Returns:full pathname of the file selected by the user, or None if Cancel was pressed
static getOpenFileNames(parent='', caption='Open Files', dir=None, filter='All Files (*)', accept_label='Open', file_mode=3, **kwargs)

Convenience function that returns a list of filenames as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Return type:list of str or None
Returns:list of full file pathnames selected by the user, or None if Cancel was pressed.
static getOpenFileName(parent='', caption='Open File', dir=None, filter='All Files (*)', **kwargs)

Convenience function that returns a single filename as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Return type:str or None
Returns:full pathname of the file selected by the user, or None if Cancel was pressed
__init__(parent=None, caption='', directory='', filter='All Files (*)', custom_sidebar=True, sidebar_links=None)
Parameters:
  • parent (qwidget) – the widget over which this dialog should be shown. If not given, the Dialog will be placed by PyQt.
  • caption (str) – the name that appears in the titlebar of this dialog. If not given the title will be the default PyQt caption.
  • directory (str) – the initial directory displayed in this dialog, default is the current directory.
  • filter (str) – the list of filters that can be applied to this directory the format is "Filetype1 (*.ex1);;Filetype2 (*.ex2 *.ex3)". Default is all files.
  • custom_sidebar (bool) – True if the Schrodinger sidebar should be used, False if the default PyQt sidebar should be used.
  • sidebar_links (dict) – Use to create extra links in the left-hand sidebar of the dialog. the keys of the dictionary are a unique identifier for each link (note that ‘home’ and ‘working’ are already used), and the values are tuples of the form (path, name) where path and name are str, path indicates the path the sidebar link points to, and name is the name displayed for the link.
exec_()

In Python3, exec is no longer a reserved word, so PyQt now provides exec wrappings of Qt exec methods. Preserving exec_ for backwards compatibility.

exec(self) → int
Accept = 3
class AcceptMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x14654f8>
AcceptOpen = 0
AcceptSave = 1
Accepted = 1
AnyFile = 0
Detail = 0
class DialogCode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1461798>
class DialogLabel

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x14658a8>
Directory = 2
DirectoryOnly = 4
DontConfirmOverwrite = 4
DontUseCustomDirectoryIcons = 128
DontUseNativeDialog = 16
DontUseSheet = 8
DrawChildren = 2
DrawWindowBackground = 1
ExistingFile = 1
ExistingFiles = 3
class FileMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1465c58>
FileName = 1
FileType = 2
HideNameFilterDetails = 64
IgnoreMask = 4
List = 1
LookIn = 0
class Option

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1466008>
class Options

Bases: sip.simplewrapper

QFileDialog.Options(Union[QFileDialog.Options, QFileDialog.Option]) QFileDialog.Options(QFileDialog.Options)

__init__

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

class PaintDeviceMetric

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1409398>
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
ReadOnly = 32
Reject = 4
Rejected = 0
class RenderFlag

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1750518>
class RenderFlags

Bases: sip.simplewrapper

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

__init__

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

ShowDirsOnly = 1
class ViewMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1466be8>
accept(self)
acceptDrops(self) → bool
acceptMode(self) → QFileDialog.AcceptMode
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
currentChanged

currentChanged(self, str) [signal]

currentUrlChanged

currentUrlChanged(self, QUrl) [signal]

cursor(self) → QCursor
customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)
defaultSuffix(self) → str
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
directory(self) → QDir
directoryEntered

directoryEntered(self, str) [signal]

directoryUrl(self) → QUrl
directoryUrlEntered

directoryUrlEntered(self, QUrl) [signal]

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
fileMode(self) → QFileDialog.FileMode
fileSelected

fileSelected(self, str) [signal]

filesSelected

filesSelected(self, Iterable[str]) [signal]

filter(self) → QDir.Filters
filterSelected

filterSelected(self, str) [signal]

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

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

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

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

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]
getExistingDirectoryUrl(parent: QWidget = None, caption: str = '', directory: QUrl = QUrl(), options: Union[QFileDialog.Options, QFileDialog.Option] = QFileDialog.ShowDirsOnly, supportedSchemes: Iterable[str] = []) → QUrl
getOpenFileUrl(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]
getOpenFileUrls(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[List[QUrl], str]
getSaveFileUrl(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]
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)
history(self) → List[str]
iconProvider(self) → QFileIconProvider
inherits(self, str) → bool
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
inputMethodHints(self) → Qt.InputMethodHints
inputMethodQuery(self, Qt.InputMethodQuery) → Any
insertAction(self, QAction, QAction)
insertActions(self, QAction, Iterable[QAction])
installEventFilter(self, QObject)
isActiveWindow(self) → bool
isAncestorOf(self, QWidget) → bool
isEnabled(self) → bool
isEnabledTo(self, QWidget) → bool
isFullScreen(self) → bool
isHidden(self) → bool
isLeftToRight(self) → bool
isMaximized(self) → bool
isMinimized(self) → bool
isModal(self) → bool
isRightToLeft(self) → bool
isSignalConnected(self, QMetaMethod) → bool
isSizeGripEnabled(self) → bool
isVisible(self) → bool
isVisibleTo(self, QWidget) → bool
isWidgetType(self) → bool
isWindow(self) → bool
isWindowModified(self) → bool
isWindowType(self) → bool
itemDelegate(self) → QAbstractItemDelegate
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
keyboardGrabber() → QWidget
killTimer(self, int)
labelText(self, QFileDialog.DialogLabel) → str
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
mimeTypeFilters(self) → List[str]
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)
nameFilters(self) → List[str]
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)

open(self, PYQT_SLOT)

options(self) → QFileDialog.Options
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
proxyModel(self) → QAbstractProxyModel
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
restoreState(self, Union[QByteArray, bytes, bytearray]) → bool
result(self) → int
saveGeometry(self) → QByteArray
saveState(self) → QByteArray
scroll(self, int, int)

scroll(self, int, int, QRect)

selectFile(self, str)
selectMimeTypeFilter(self, str)
selectNameFilter(self, str)
selectUrl(self, QUrl)
selectedFiles(self) → List[str]
selectedMimeTypeFilter(self) → str
selectedNameFilter(self) → str
selectedUrls(self) → List[QUrl]
sender(self) → QObject
senderSignalIndex(self) → int
setAcceptDrops(self, bool)
setAcceptMode(self, QFileDialog.AcceptMode)
setAccessibleDescription(self, str)
setAccessibleName(self, str)
setAttribute(self, Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, bool)
setBackgroundRole(self, QPalette.ColorRole)
setBaseSize(self, int, int)

setBaseSize(self, QSize)

setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins)

setContextMenuPolicy(self, Qt.ContextMenuPolicy)
setCursor(self, Union[QCursor, Qt.CursorShape])
setDefaultSuffix(self, str)
setDirectory(self, str)

setDirectory(self, QDir)

setDirectoryUrl(self, QUrl)
setDisabled(self, bool)
setEnabled(self, bool)
setFileMode(self, QFileDialog.FileMode)
setFilter(self, Union[QDir.Filters, QDir.Filter])
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)
setHistory(self, Iterable[str])
setIconProvider(self, QFileIconProvider)
setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])
setItemDelegate(self, QAbstractItemDelegate)
setLabelText(self, QFileDialog.DialogLabel, str)
setLayout(self, QLayout)
setLayoutDirection(self, Qt.LayoutDirection)
setLocale(self, QLocale)
setMask(self, QBitmap)

setMask(self, QRegion)

setMaximumHeight(self, int)
setMaximumSize(self, int, int)

setMaximumSize(self, QSize)

setMaximumWidth(self, int)
setMimeTypeFilters(self, Iterable[str])
setMinimumHeight(self, int)
setMinimumSize(self, int, int)

setMinimumSize(self, QSize)

setMinimumWidth(self, int)
setModal(self, bool)
setMouseTracking(self, bool)
setNameFilter(self, str)
setNameFilters(self, Iterable[str])
setObjectName(self, str)
setOption(self, QFileDialog.Option, on: bool = True)
setOptions(self, Union[QFileDialog.Options, QFileDialog.Option])
setPalette(self, QPalette)
setParent(self, QWidget)

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

setProperty(self, str, Any) → bool
setProxyModel(self, QAbstractProxyModel)
setResult(self, int)
setShortcutAutoRepeat(self, int, enabled: bool = True)
setShortcutEnabled(self, int, enabled: bool = True)
setSidebarUrls(self, Iterable[QUrl])
setSizeGripEnabled(self, bool)
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)
setSupportedSchemes(self, Iterable[str])
setTabOrder(QWidget, QWidget)
setTabletTracking(self, bool)
setToolTip(self, str)
setToolTipDuration(self, int)
setUpdatesEnabled(self, bool)
setViewMode(self, QFileDialog.ViewMode)
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)
sidebarUrls(self) → List[QUrl]
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
supportedSchemes(self) → List[str]
tabletEvent(self, QTabletEvent)
testAttribute(self, Qt.WidgetAttribute) → bool
testOption(self, QFileDialog.Option) → 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
urlSelected

urlSelected(self, QUrl) [signal]

urlsSelected

urlsSelected(self, Iterable[QUrl]) [signal]

viewMode(self) → QFileDialog.ViewMode
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
schrodinger.ui.qt.filedialog.QFileDialog

alias of schrodinger.ui.qt.filedialog.FileDialog

class schrodinger.ui.qt.filedialog.CustomFileDialog(*args, num_free_rows=1, **kwargs)

Bases: schrodinger.ui.qt.filedialog.FileDialog

A File Dialog that has all contents below the file view (File name and File type fields) shifted down a row so that custom controls can be placed.

__init__(*args, num_free_rows=1, **kwargs)
Parameters:
  • parent (qwidget) – the widget over which this dialog should be shown. If not given, the Dialog will be placed by PyQt.
  • caption (str) – the name that appears in the titlebar of this dialog. If not given the title will be the default PyQt caption.
  • directory (str) – the initial directory displayed in this dialog, default is the current directory.
  • filter (str) – the list of filters that can be applied to this directory the format is "Filetype1 (*.ex1);;Filetype2 (*.ex2 *.ex3)". Default is all files.
  • custom_sidebar (bool) – True if the Schrodinger sidebar should be used, False if the default PyQt sidebar should be used.
  • sidebar_links (dict) – Use to create extra links in the left-hand sidebar of the dialog. the keys of the dictionary are a unique identifier for each link (note that ‘home’ and ‘working’ are already used), and the values are tuples of the form (path, name) where path and name are str, path indicates the path the sidebar link points to, and name is the name displayed for the link.
Accept = 3
class AcceptMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x14654f8>
AcceptOpen = 0
AcceptSave = 1
Accepted = 1
AnyFile = 0
Detail = 0
class DialogCode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1461798>
class DialogLabel

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x14658a8>
Directory = 2
DirectoryOnly = 4
DontConfirmOverwrite = 4
DontUseCustomDirectoryIcons = 128
DontUseNativeDialog = 16
DontUseSheet = 8
DrawChildren = 2
DrawWindowBackground = 1
ExistingFile = 1
ExistingFiles = 3
class FileMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1465c58>
FileName = 1
FileType = 2
HideNameFilterDetails = 64
IgnoreMask = 4
List = 1
LookIn = 0
class Option

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1466008>
class Options

Bases: sip.simplewrapper

QFileDialog.Options(Union[QFileDialog.Options, QFileDialog.Option]) QFileDialog.Options(QFileDialog.Options)

__init__

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

class PaintDeviceMetric

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1409398>
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
ReadOnly = 32
Reject = 4
Rejected = 0
class RenderFlag

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1750518>
class RenderFlags

Bases: sip.simplewrapper

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

__init__

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

ShowDirsOnly = 1
class ViewMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1466be8>
accept(self)
acceptDrops(self) → bool
acceptMode(self) → QFileDialog.AcceptMode
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
currentChanged

currentChanged(self, str) [signal]

currentUrlChanged

currentUrlChanged(self, QUrl) [signal]

cursor(self) → QCursor
customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)
defaultSuffix(self) → str
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
directory(self) → QDir
directoryEntered

directoryEntered(self, str) [signal]

directoryUrl(self) → QUrl
directoryUrlEntered

directoryUrlEntered(self, QUrl) [signal]

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

In Python3, exec is no longer a reserved word, so PyQt now provides exec wrappings of Qt exec methods. Preserving exec_ for backwards compatibility.

fileMode(self) → QFileDialog.FileMode
fileSelected

fileSelected(self, str) [signal]

filesSelected

filesSelected(self, Iterable[str]) [signal]

filter(self) → QDir.Filters
filterSelected

filterSelected(self, str) [signal]

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

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

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

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

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]
static getExistingDirectory(parent='', caption='Choose Directory', dir=None, accept_label='Choose', file_mode=4, **kwargs)

Convenience function that returns a directory name as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Parameters:file_mode (QFileDialog.FileMode) – What the user can select. See the PyQt documentation for QFileDialog.FileMode (currently AnyFile, ExistingFile, Directory and ExistingFiles are the options). Note that despite what the PyQt documentation states, it appears that QFileDialog.DirectoryOnly is needed to only display directores - it is not sufficient to use QFileDialog.Directory and setOptions(ShowDirsOnly). Use QFileDialog.Directory to have the dialog also show the files in each directory.
Return type:str or None
Returns:full pathname of the file selected by the user, or None if Cancel was pressed
getExistingDirectoryUrl(parent: QWidget = None, caption: str = '', directory: QUrl = QUrl(), options: Union[QFileDialog.Options, QFileDialog.Option] = QFileDialog.ShowDirsOnly, supportedSchemes: Iterable[str] = []) → QUrl
static getOpenFileName(parent='', caption='Open File', dir=None, filter='All Files (*)', **kwargs)

Convenience function that returns a single filename as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Return type:str or None
Returns:full pathname of the file selected by the user, or None if Cancel was pressed
static getOpenFileNames(parent='', caption='Open Files', dir=None, filter='All Files (*)', accept_label='Open', file_mode=3, **kwargs)

Convenience function that returns a list of filenames as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Return type:list of str or None
Returns:list of full file pathnames selected by the user, or None if Cancel was pressed.
getOpenFileUrl(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]
getOpenFileUrls(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[List[QUrl], str]
static getSaveFileName(parent='', caption='Save File', dir=None, filter='All Files (*)', accept_label='Save', accept_mode=1, file_mode=0, **kwargs)

Convenience function that returns a filename as selected by the user

The base class base_file_dialog documents the keyword arguments for this class.

Return type:str or None
Returns:full pathname of the file selected by the user, or None if Cancel was pressed
getSaveFileUrl(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]
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)
history(self) → List[str]
iconProvider(self) → QFileIconProvider
inherits(self, str) → bool
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
inputMethodHints(self) → Qt.InputMethodHints
inputMethodQuery(self, Qt.InputMethodQuery) → Any
insertAction(self, QAction, QAction)
insertActions(self, QAction, Iterable[QAction])
installEventFilter(self, QObject)
isActiveWindow(self) → bool
isAncestorOf(self, QWidget) → bool
isEnabled(self) → bool
isEnabledTo(self, QWidget) → bool
isFullScreen(self) → bool
isHidden(self) → bool
isLeftToRight(self) → bool
isMaximized(self) → bool
isMinimized(self) → bool
isModal(self) → bool
isRightToLeft(self) → bool
isSignalConnected(self, QMetaMethod) → bool
isSizeGripEnabled(self) → bool
isVisible(self) → bool
isVisibleTo(self, QWidget) → bool
isWidgetType(self) → bool
isWindow(self) → bool
isWindowModified(self) → bool
isWindowType(self) → bool
itemDelegate(self) → QAbstractItemDelegate
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
keyboardGrabber() → QWidget
killTimer(self, int)
labelText(self, QFileDialog.DialogLabel) → str
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
mimeTypeFilters(self) → List[str]
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)
nameFilters(self) → List[str]
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)

open(self, PYQT_SLOT)

options(self) → QFileDialog.Options
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
proxyModel(self) → QAbstractProxyModel
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
restoreState(self, Union[QByteArray, bytes, bytearray]) → bool
result(self) → int
saveGeometry(self) → QByteArray
saveState(self) → QByteArray
scroll(self, int, int)

scroll(self, int, int, QRect)

selectFile(self, str)
selectMimeTypeFilter(self, str)
selectNameFilter(self, str)
selectUrl(self, QUrl)
selectedFiles(self) → List[str]
selectedMimeTypeFilter(self) → str
selectedNameFilter(self) → str
selectedUrls(self) → List[QUrl]
sender(self) → QObject
senderSignalIndex(self) → int
setAcceptDrops(self, bool)
setAcceptMode(self, QFileDialog.AcceptMode)
setAccessibleDescription(self, str)
setAccessibleName(self, str)
setAttribute(self, Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, bool)
setBackgroundRole(self, QPalette.ColorRole)
setBaseSize(self, int, int)

setBaseSize(self, QSize)

setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins)

setContextMenuPolicy(self, Qt.ContextMenuPolicy)
setCursor(self, Union[QCursor, Qt.CursorShape])
setDefaultSuffix(self, str)
setDirectory(self, str)

setDirectory(self, QDir)

setDirectoryUrl(self, QUrl)
setDisabled(self, bool)
setEnabled(self, bool)
setFileMode(self, QFileDialog.FileMode)
setFilter(self, Union[QDir.Filters, QDir.Filter])
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)
setHistory(self, Iterable[str])
setIconProvider(self, QFileIconProvider)
setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])
setItemDelegate(self, QAbstractItemDelegate)
setLabelText(self, QFileDialog.DialogLabel, str)
setLayout(self, QLayout)
setLayoutDirection(self, Qt.LayoutDirection)
setLocale(self, QLocale)
setMask(self, QBitmap)

setMask(self, QRegion)

setMaximumHeight(self, int)
setMaximumSize(self, int, int)

setMaximumSize(self, QSize)

setMaximumWidth(self, int)
setMimeTypeFilters(self, Iterable[str])
setMinimumHeight(self, int)
setMinimumSize(self, int, int)

setMinimumSize(self, QSize)

setMinimumWidth(self, int)
setModal(self, bool)
setMouseTracking(self, bool)
setNameFilter(self, str)
setNameFilters(self, Iterable[str])
setObjectName(self, str)
setOption(self, QFileDialog.Option, on: bool = True)
setOptions(self, Union[QFileDialog.Options, QFileDialog.Option])
setPalette(self, QPalette)
setParent(self, QWidget)

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

setProperty(self, str, Any) → bool
setProxyModel(self, QAbstractProxyModel)
setResult(self, int)
setShortcutAutoRepeat(self, int, enabled: bool = True)
setShortcutEnabled(self, int, enabled: bool = True)
setSidebarUrls(self, Iterable[QUrl])
setSizeGripEnabled(self, bool)
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)
setSupportedSchemes(self, Iterable[str])
setTabOrder(QWidget, QWidget)
setTabletTracking(self, bool)
setToolTip(self, str)
setToolTipDuration(self, int)
setUpdatesEnabled(self, bool)
setViewMode(self, QFileDialog.ViewMode)
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)
sidebarUrls(self) → List[QUrl]
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
supportedSchemes(self) → List[str]
tabletEvent(self, QTabletEvent)
testAttribute(self, Qt.WidgetAttribute) → bool
testOption(self, QFileDialog.Option) → 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
urlSelected

urlSelected(self, QUrl) [signal]

urlsSelected

urlsSelected(self, Iterable[QUrl]) [signal]

viewMode(self) → QFileDialog.ViewMode
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
Return type:dict
Returns:dictionary of attached drives. Keys are text names of the drive, values are tuples of (path, text name).
schrodinger.ui.qt.filedialog.has_project_ending(path)

Detect whether path ends in one of the recognized valid endings that indicate a project

Parameters:path (str) – Path to a file or directory that should be checked to see if it is a project
Return type:bool
Returns:True if path points to a project, False if not
class schrodinger.ui.qt.filedialog.OpenDirAsFileDialog(parent=None, caption='Open Project', directory='.', accept='Open', filter='Projects (*.prj *.prjzip *.prj.zip)', label='Project:')

Bases: PyQt5.QtWidgets.QFileDialog, schrodinger.ui.qt.filedialog.CustomSideBarMixin

A file dialog tailored to allow the user to “open” directories such as projects or phase databases as if they were files.

Differences from a typical Open File Dialog:

  • Allows the user to choose files or directories of the proper type just as if they were a file.
  • Directories and files of the proper type are noted with custom icons and file types.

The dialog should first be created, then the getFilename method called.

dialog = OpenDirAsFileDialog()
project_path = dialog.getFilename()
if project_path:
    Do stuff

Because QFileDialogs normally cannot handle accepting either a directory OR a file, this uses a few tricks noted throughout the code to make the process of selecting either a special directory or a zip file invisible to the user.

This is the parent class and should be subclassed for use. The setMyIconProvider and setExtensionChecker methods need to be overwritten for this class to be used.

__init__(parent=None, caption='Open Project', directory='.', accept='Open', filter='Projects (*.prj *.prjzip *.prj.zip)', label='Project:')

Create a OpenDirAsFileDialog instance

Parameters:
  • parent (QWidget) – The parent widget for this dialog
  • caption (str) – The caption for this dialog
  • directory (str) – The directory this dialog starts in
  • accept (str) – The text that appears on the Open/Accept/Choose button that the user clicks to select a file and close the dialog
  • filter (str) – The file name filter used by the dialog
  • label (str) – The label in front of the selected file name edit
setMyIconProvider()

Should be overwritten in subclasses to set a custom icon provider inherited from QtWidgets.QFileIconProvider.

setExtensionChecker()

Should be overwritten in subclasses to set a callable function that takes a path as input and returns True if that path is one of the “special” directories/files that this dialog treats as a “file”.

getFilename()

Open the dialog, allow the user to choose a special directory/file, and return the path to that directory/file.

accept()

Overwrites the QFileDialog accept method to also accept directories if they are a special directory. Normally, accept would only accept files.

Accept = 3
class AcceptMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x14654f8>
AcceptOpen = 0
AcceptSave = 1
Accepted = 1
AnyFile = 0
Detail = 0
class DialogCode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1461798>
class DialogLabel

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x14658a8>
Directory = 2
DirectoryOnly = 4
DontConfirmOverwrite = 4
DontUseCustomDirectoryIcons = 128
DontUseNativeDialog = 16
DontUseSheet = 8
DrawChildren = 2
DrawWindowBackground = 1
ExistingFile = 1
ExistingFiles = 3
class FileMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1465c58>
FileName = 1
FileType = 2
HideNameFilterDetails = 64
IgnoreMask = 4
List = 1
LookIn = 0
class Option

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1466008>
class Options

Bases: sip.simplewrapper

QFileDialog.Options(Union[QFileDialog.Options, QFileDialog.Option]) QFileDialog.Options(QFileDialog.Options)

__init__

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

class PaintDeviceMetric

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1409398>
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
ReadOnly = 32
Reject = 4
Rejected = 0
class RenderFlag

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1750518>
class RenderFlags

Bases: sip.simplewrapper

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

__init__

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

ShowDirsOnly = 1
class ViewMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1466be8>
acceptDrops(self) → bool
acceptMode(self) → QFileDialog.AcceptMode
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
currentChanged

currentChanged(self, str) [signal]

currentUrlChanged

currentUrlChanged(self, QUrl) [signal]

cursor(self) → QCursor
customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)
defaultSuffix(self) → str
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
directory(self) → QDir
directoryEntered

directoryEntered(self, str) [signal]

directoryUrl(self) → QUrl
directoryUrlEntered

directoryUrlEntered(self, QUrl) [signal]

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
fileMode(self) → QFileDialog.FileMode
fileSelected

fileSelected(self, str) [signal]

filesSelected

filesSelected(self, Iterable[str]) [signal]

filter(self) → QDir.Filters
filterSelected

filterSelected(self, str) [signal]

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

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

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

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

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]
getExistingDirectory(parent: QWidget = None, caption: str = '', directory: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = QFileDialog.ShowDirsOnly) → str
getExistingDirectoryUrl(parent: QWidget = None, caption: str = '', directory: QUrl = QUrl(), options: Union[QFileDialog.Options, QFileDialog.Option] = QFileDialog.ShowDirsOnly, supportedSchemes: Iterable[str] = []) → QUrl
getOpenFileName(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0) → Tuple[str, str]
getOpenFileNames(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0) → Tuple[List[str], str]
getOpenFileUrl(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]
getOpenFileUrls(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[List[QUrl], str]
getSaveFileName(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0) → Tuple[str, str]
getSaveFileUrl(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]
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)
history(self) → List[str]
iconProvider(self) → QFileIconProvider
inherits(self, str) → bool
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
inputMethodHints(self) → Qt.InputMethodHints
inputMethodQuery(self, Qt.InputMethodQuery) → Any
insertAction(self, QAction, QAction)
insertActions(self, QAction, Iterable[QAction])
installEventFilter(self, QObject)
isActiveWindow(self) → bool
isAncestorOf(self, QWidget) → bool
isEnabled(self) → bool
isEnabledTo(self, QWidget) → bool
isFullScreen(self) → bool
isHidden(self) → bool
isLeftToRight(self) → bool
isMaximized(self) → bool
isMinimized(self) → bool
isModal(self) → bool
isRightToLeft(self) → bool
isSignalConnected(self, QMetaMethod) → bool
isSizeGripEnabled(self) → bool
isVisible(self) → bool
isVisibleTo(self, QWidget) → bool
isWidgetType(self) → bool
isWindow(self) → bool
isWindowModified(self) → bool
isWindowType(self) → bool
itemDelegate(self) → QAbstractItemDelegate
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
keyboardGrabber() → QWidget
killTimer(self, int)
labelText(self, QFileDialog.DialogLabel) → str
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
mimeTypeFilters(self) → List[str]
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)
nameFilters(self) → List[str]
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)

open(self, PYQT_SLOT)

options(self) → QFileDialog.Options
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
proxyModel(self) → QAbstractProxyModel
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
restoreState(self, Union[QByteArray, bytes, bytearray]) → bool
result(self) → int
saveGeometry(self) → QByteArray
saveState(self) → QByteArray
scroll(self, int, int)

scroll(self, int, int, QRect)

selectFile(self, str)
selectMimeTypeFilter(self, str)
selectNameFilter(self, str)
selectUrl(self, QUrl)
selectedFiles(self) → List[str]
selectedMimeTypeFilter(self) → str
selectedNameFilter(self) → str
selectedUrls(self) → List[QUrl]
sender(self) → QObject
senderSignalIndex(self) → int
setAcceptDrops(self, bool)
setAcceptMode(self, QFileDialog.AcceptMode)
setAccessibleDescription(self, str)
setAccessibleName(self, str)
setAttribute(self, Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, bool)
setBackgroundRole(self, QPalette.ColorRole)
setBaseSize(self, int, int)

setBaseSize(self, QSize)

setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins)

setContextMenuPolicy(self, Qt.ContextMenuPolicy)
setCursor(self, Union[QCursor, Qt.CursorShape])
setDefaultSuffix(self, str)
setDirectory(self, str)

setDirectory(self, QDir)

setDirectoryUrl(self, QUrl)
setDisabled(self, bool)
setEnabled(self, bool)
setFileMode(self, QFileDialog.FileMode)
setFilter(self, Union[QDir.Filters, QDir.Filter])
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)
setHistory(self, Iterable[str])
setIconProvider(self, QFileIconProvider)
setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])
setItemDelegate(self, QAbstractItemDelegate)
setLabelText(self, QFileDialog.DialogLabel, str)
setLayout(self, QLayout)
setLayoutDirection(self, Qt.LayoutDirection)
setLocale(self, QLocale)
setMask(self, QBitmap)

setMask(self, QRegion)

setMaximumHeight(self, int)
setMaximumSize(self, int, int)

setMaximumSize(self, QSize)

setMaximumWidth(self, int)
setMimeTypeFilters(self, Iterable[str])
setMinimumHeight(self, int)
setMinimumSize(self, int, int)

setMinimumSize(self, QSize)

setMinimumWidth(self, int)
setModal(self, bool)
setMouseTracking(self, bool)
setNameFilter(self, str)
setNameFilters(self, Iterable[str])
setObjectName(self, str)
setOption(self, QFileDialog.Option, on: bool = True)
setOptions(self, Union[QFileDialog.Options, QFileDialog.Option])
setPalette(self, QPalette)
setParent(self, QWidget)

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

setProperty(self, str, Any) → bool
setProxyModel(self, QAbstractProxyModel)
setResult(self, int)
setShortcutAutoRepeat(self, int, enabled: bool = True)
setShortcutEnabled(self, int, enabled: bool = True)
setSidebarUrls(self, Iterable[QUrl])
setSizeGripEnabled(self, bool)
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)
setSupportedSchemes(self, Iterable[str])
setTabOrder(QWidget, QWidget)
setTabletTracking(self, bool)
setToolTip(self, str)
setToolTipDuration(self, int)
setUpdatesEnabled(self, bool)
setViewMode(self, QFileDialog.ViewMode)
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)
sidebarUrls(self) → List[QUrl]
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
supportedSchemes(self) → List[str]
tabletEvent(self, QTabletEvent)
testAttribute(self, Qt.WidgetAttribute) → bool
testOption(self, QFileDialog.Option) → 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
urlSelected

urlSelected(self, QUrl) [signal]

urlsSelected

urlsSelected(self, Iterable[QUrl]) [signal]

viewMode(self) → QFileDialog.ViewMode
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.ui.qt.filedialog.ProjectOpenDialog(parent=None, caption='Open Project', directory='.', accept='Open', filter='Projects (*.prj *.prjzip *.prj.zip)')

Bases: schrodinger.ui.qt.filedialog.OpenDirAsFileDialog

A file dialog tailored to opening Projects.

Differences from a typical Open File Dialog:

  • Allows the user to choose projects that are either directories or zipped project archive files just as if the project was a file.
  • Projects are noted with project icons and the file type “project” whether they are directories or files.

The dialog should first be created, then the getFilename method called.

dialog = ProjectOpenDialog()
project_path = dialog.getFilename()
if project_path:
    Do stuff

Because QFileDialogs normally cannot handle accepting either a directory OR a file, this uses a few tricks noted throughout the code to make the process of selecting either a project directory or a zip file invisible to the user.

__init__(parent=None, caption='Open Project', directory='.', accept='Open', filter='Projects (*.prj *.prjzip *.prj.zip)')

Create a ProjectOpenDialog instance

Parameters:
  • parent (QWidget) – The parent widget for this dialog
  • caption (str) – The caption for this dialog
  • directory (str) – The directory this dialog starts in
  • accept (str) – The text that appears on the Open/Accept/Choose button that the user clicks to select a file and close the dialog
  • filter (str) – The file name filter used by the dialog
setMyIconProvider()

Sets the IconProvider to a custom class that provides project icons

setExtensionChecker()

Set a callable function that takes a path as input and returns True if that path is one of the “special” directories/files that this dialog treats as a “file”.

Accept = 3
class AcceptMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x14654f8>
AcceptOpen = 0
AcceptSave = 1
Accepted = 1
AnyFile = 0
Detail = 0
class DialogCode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1461798>
class DialogLabel

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x14658a8>
Directory = 2
DirectoryOnly = 4
DontConfirmOverwrite = 4
DontUseCustomDirectoryIcons = 128
DontUseNativeDialog = 16
DontUseSheet = 8
DrawChildren = 2
DrawWindowBackground = 1
ExistingFile = 1
ExistingFiles = 3
class FileMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1465c58>
FileName = 1
FileType = 2
HideNameFilterDetails = 64
IgnoreMask = 4
List = 1
LookIn = 0
class Option

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1466008>
class Options

Bases: sip.simplewrapper

QFileDialog.Options(Union[QFileDialog.Options, QFileDialog.Option]) QFileDialog.Options(QFileDialog.Options)

__init__

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

class PaintDeviceMetric

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1409398>
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
ReadOnly = 32
Reject = 4
Rejected = 0
class RenderFlag

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1750518>
class RenderFlags

Bases: sip.simplewrapper

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

__init__

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

ShowDirsOnly = 1
class ViewMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1466be8>
accept()

Overwrites the QFileDialog accept method to also accept directories if they are a special directory. Normally, accept would only accept files.

acceptDrops(self) → bool
acceptMode(self) → QFileDialog.AcceptMode
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
currentChanged

currentChanged(self, str) [signal]

currentUrlChanged

currentUrlChanged(self, QUrl) [signal]

cursor(self) → QCursor
customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)
defaultSuffix(self) → str
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
directory(self) → QDir
directoryEntered

directoryEntered(self, str) [signal]

directoryUrl(self) → QUrl
directoryUrlEntered

directoryUrlEntered(self, QUrl) [signal]

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
fileMode(self) → QFileDialog.FileMode
fileSelected

fileSelected(self, str) [signal]

filesSelected

filesSelected(self, Iterable[str]) [signal]

filter(self) → QDir.Filters
filterSelected

filterSelected(self, str) [signal]

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

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

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

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

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]
getExistingDirectory(parent: QWidget = None, caption: str = '', directory: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = QFileDialog.ShowDirsOnly) → str
getExistingDirectoryUrl(parent: QWidget = None, caption: str = '', directory: QUrl = QUrl(), options: Union[QFileDialog.Options, QFileDialog.Option] = QFileDialog.ShowDirsOnly, supportedSchemes: Iterable[str] = []) → QUrl
getFilename()

Open the dialog, allow the user to choose a special directory/file, and return the path to that directory/file.

getOpenFileName(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0) → Tuple[str, str]
getOpenFileNames(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0) → Tuple[List[str], str]
getOpenFileUrl(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]
getOpenFileUrls(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[List[QUrl], str]
getSaveFileName(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0) → Tuple[str, str]
getSaveFileUrl(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]
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)
history(self) → List[str]
iconProvider(self) → QFileIconProvider
inherits(self, str) → bool
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
inputMethodHints(self) → Qt.InputMethodHints
inputMethodQuery(self, Qt.InputMethodQuery) → Any
insertAction(self, QAction, QAction)
insertActions(self, QAction, Iterable[QAction])
installEventFilter(self, QObject)
isActiveWindow(self) → bool
isAncestorOf(self, QWidget) → bool
isEnabled(self) → bool
isEnabledTo(self, QWidget) → bool
isFullScreen(self) → bool
isHidden(self) → bool
isLeftToRight(self) → bool
isMaximized(self) → bool
isMinimized(self) → bool
isModal(self) → bool
isRightToLeft(self) → bool
isSignalConnected(self, QMetaMethod) → bool
isSizeGripEnabled(self) → bool
isVisible(self) → bool
isVisibleTo(self, QWidget) → bool
isWidgetType(self) → bool
isWindow(self) → bool
isWindowModified(self) → bool
isWindowType(self) → bool
itemDelegate(self) → QAbstractItemDelegate
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
keyboardGrabber() → QWidget
killTimer(self, int)
labelText(self, QFileDialog.DialogLabel) → str
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
mimeTypeFilters(self) → List[str]
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)
nameFilters(self) → List[str]
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)

open(self, PYQT_SLOT)

options(self) → QFileDialog.Options
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
proxyModel(self) → QAbstractProxyModel
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
restoreState(self, Union[QByteArray, bytes, bytearray]) → bool
result(self) → int
saveGeometry(self) → QByteArray
saveState(self) → QByteArray
scroll(self, int, int)

scroll(self, int, int, QRect)

selectFile(self, str)
selectMimeTypeFilter(self, str)
selectNameFilter(self, str)
selectUrl(self, QUrl)
selectedFiles(self) → List[str]
selectedMimeTypeFilter(self) → str
selectedNameFilter(self) → str
selectedUrls(self) → List[QUrl]
sender(self) → QObject
senderSignalIndex(self) → int
setAcceptDrops(self, bool)
setAcceptMode(self, QFileDialog.AcceptMode)
setAccessibleDescription(self, str)
setAccessibleName(self, str)
setAttribute(self, Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, bool)
setBackgroundRole(self, QPalette.ColorRole)
setBaseSize(self, int, int)

setBaseSize(self, QSize)

setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins)

setContextMenuPolicy(self, Qt.ContextMenuPolicy)
setCursor(self, Union[QCursor, Qt.CursorShape])
setDefaultSuffix(self, str)
setDirectory(self, str)

setDirectory(self, QDir)

setDirectoryUrl(self, QUrl)
setDisabled(self, bool)
setEnabled(self, bool)
setFileMode(self, QFileDialog.FileMode)
setFilter(self, Union[QDir.Filters, QDir.Filter])
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)
setHistory(self, Iterable[str])
setIconProvider(self, QFileIconProvider)
setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])
setItemDelegate(self, QAbstractItemDelegate)
setLabelText(self, QFileDialog.DialogLabel, str)
setLayout(self, QLayout)
setLayoutDirection(self, Qt.LayoutDirection)
setLocale(self, QLocale)
setMask(self, QBitmap)

setMask(self, QRegion)

setMaximumHeight(self, int)
setMaximumSize(self, int, int)

setMaximumSize(self, QSize)

setMaximumWidth(self, int)
setMimeTypeFilters(self, Iterable[str])
setMinimumHeight(self, int)
setMinimumSize(self, int, int)

setMinimumSize(self, QSize)

setMinimumWidth(self, int)
setModal(self, bool)
setMouseTracking(self, bool)
setNameFilter(self, str)
setNameFilters(self, Iterable[str])
setObjectName(self, str)
setOption(self, QFileDialog.Option, on: bool = True)
setOptions(self, Union[QFileDialog.Options, QFileDialog.Option])
setPalette(self, QPalette)
setParent(self, QWidget)

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

setProperty(self, str, Any) → bool
setProxyModel(self, QAbstractProxyModel)
setResult(self, int)
setShortcutAutoRepeat(self, int, enabled: bool = True)
setShortcutEnabled(self, int, enabled: bool = True)
setSidebarUrls(self, Iterable[QUrl])
setSizeGripEnabled(self, bool)
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)
setSupportedSchemes(self, Iterable[str])
setTabOrder(QWidget, QWidget)
setTabletTracking(self, bool)
setToolTip(self, str)
setToolTipDuration(self, int)
setUpdatesEnabled(self, bool)
setViewMode(self, QFileDialog.ViewMode)
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)
sidebarUrls(self) → List[QUrl]
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
supportedSchemes(self) → List[str]
tabletEvent(self, QTabletEvent)
testAttribute(self, Qt.WidgetAttribute) → bool
testOption(self, QFileDialog.Option) → 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
urlSelected

urlSelected(self, QUrl) [signal]

urlsSelected

urlsSelected(self, Iterable[QUrl]) [signal]

viewMode(self) → QFileDialog.ViewMode
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
schrodinger.ui.qt.filedialog.get_existing_project_name(*args, **kwargs)

Convenience function to open a Open Project dialog and return the path the user selects.

Parameters are passed to and documented in the ProjectOpenDialog class.

Parameters:id (str, int or float) – The identifier used for this dialog. Dialogs with the same identifier will remember the last directory chosen by the user with any dialog of the same id and open in that directory. The dir keyword parameter can be used to override the initial directory the dialog opens in, but the chosen directory will still be stored for the next time a dialog with the same identifier opens. The default (no id given) is to not remember the chosen directory.
Return type:str or None
Returns:The path to the project if the user selects one, or None if the user cancels the dialog
schrodinger.ui.qt.filedialog.has_phasedb_ending(path)

Detect whether path ends in one of the recognized valid endings that indicate a Phase database.

Parameters:path (str) – Path to a file or directory that should be checked to see if it is a Phase database.
Return type:bool
Returns:True if path points to a Phase database, False if not
class schrodinger.ui.qt.filedialog.PhaseDatabaseIconProvider

Bases: PyQt5.QtWidgets.QFileIconProvider

Class to ensure that projects get the proper icon in the file open dialog, and also are labeled as type “Project”

__init__()

Create a PhaseDatabaseIconProvider instance

icon(arg)

Return the proper icon for the file/directory that arg points to.

This will be the default icon except if arg points to a Phase database, in which case it will be a custom icon.

Parameters:arg (QFileInfo) – Information for the current file/directory. This is used to determine what type of icon should be displayed for the file.
Return type:QIcon
Returns:The proper icon for arg’s file/directory.
isPhaseDatabase(info)

Determine if info points to a Phase database.

Parameters:info (QFileInfo) – Information for the current file/directory
Return type:bool
Returns:True if info points to a project, False if not
type(arg)

Return the proper type for the file/directory that arg points to.

This will be the default type except if arg points to a Phase database, in which case it will be ‘Phase Database’

Parameters:arg (QFileInfo) – Information for the current file/directory. This is used to determine what type should be displayed for the file.
Return type:str
Returns:The proper type for arg’s file/directory.
Computer = 0
Desktop = 1
DontUseCustomDirectoryIcons = 1
Drive = 4
File = 6
Folder = 5
class IconType

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1467368>
Network = 3
class Option

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1467718>
class Options

Bases: sip.simplewrapper

QFileIconProvider.Options(Union[QFileIconProvider.Options, QFileIconProvider.Option]) QFileIconProvider.Options(QFileIconProvider.Options)

__init__

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

Trashcan = 2
options(self) → QFileIconProvider.Options
setOptions(self, Union[QFileIconProvider.Options, QFileIconProvider.Option])
class schrodinger.ui.qt.filedialog.PhaseDatabaseOpenDialog(parent=None, caption='Open Phase database', directory='.', accept='Open', filter='Phase Databases (*_phasedb *.phdb)')

Bases: schrodinger.ui.qt.filedialog.OpenDirAsFileDialog

A file dialog tailored to opening Phase databases.

Differences from a typical Open File Dialog:

  • Allows the user to choose databases that are files (_phasedb) or directories (.phdb), as if it is a file.
  • Phase databases are noted with a custom icon, and file type “Phase Database”, whether they are directories or files.

The dialog should first be created, then the getFilename method called.

dialog = PhaseDatabaseOpenDialog()
database_path = dialog.getFilename()
if database_path:
    Do stuff

Because QFileDialogs normally cannot handle accepting either a directory OR a file, this uses a few tricks noted throughout the code to make the process of selecting a database directory or file invisible to the user.

__init__(parent=None, caption='Open Phase database', directory='.', accept='Open', filter='Phase Databases (*_phasedb *.phdb)')

Create a PhaseDatabaseOpenDialog instance

Parameters:
  • parent (QWidget) – The parent widget for this dialog
  • caption (str) – The caption for this dialog
  • directory (str) – The directory this dialog starts in
  • accept (str) – The text that appears on the Open/Accept/Choose button that the user clicks to select a file and close the dialog
  • filter (str) – The file name filter used by the dialog
setMyIconProvider()

Sets the IconProvider to a custom class that provides project icons

setExtensionChecker()

Set a callable function that takes a path as input and returns True if that path is one of the “special” directories/files that this dialog treats as a “file”.

Accept = 3
class AcceptMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x14654f8>
AcceptOpen = 0
AcceptSave = 1
Accepted = 1
AnyFile = 0
Detail = 0
class DialogCode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1461798>
class DialogLabel

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x14658a8>
Directory = 2
DirectoryOnly = 4
DontConfirmOverwrite = 4
DontUseCustomDirectoryIcons = 128
DontUseNativeDialog = 16
DontUseSheet = 8
DrawChildren = 2
DrawWindowBackground = 1
ExistingFile = 1
ExistingFiles = 3
class FileMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1465c58>
FileName = 1
FileType = 2
HideNameFilterDetails = 64
IgnoreMask = 4
List = 1
LookIn = 0
class Option

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1466008>
class Options

Bases: sip.simplewrapper

QFileDialog.Options(Union[QFileDialog.Options, QFileDialog.Option]) QFileDialog.Options(QFileDialog.Options)

__init__

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

class PaintDeviceMetric

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1409398>
PdmDepth = 6
PdmDevicePixelRatio = 11
PdmDevicePixelRatioScaled = 12
PdmDpiX = 7
PdmDpiY = 8
PdmHeight = 2
PdmHeightMM = 4
PdmNumColors = 5
PdmPhysicalDpiX = 9
PdmPhysicalDpiY = 10
PdmWidth = 1
PdmWidthMM = 3
ReadOnly = 32
Reject = 4
Rejected = 0
class RenderFlag

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1750518>
class RenderFlags

Bases: sip.simplewrapper

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

__init__

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

ShowDirsOnly = 1
class ViewMode

Bases: int

__init__ = <method-wrapper '__init__' of sip.enumtype object at 0x1466be8>
accept()

Overwrites the QFileDialog accept method to also accept directories if they are a special directory. Normally, accept would only accept files.

acceptDrops(self) → bool
acceptMode(self) → QFileDialog.AcceptMode
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
currentChanged

currentChanged(self, str) [signal]

currentUrlChanged

currentUrlChanged(self, QUrl) [signal]

cursor(self) → QCursor
customContextMenuRequested

customContextMenuRequested(self, QPoint) [signal]

customEvent(self, QEvent)
defaultSuffix(self) → str
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
directory(self) → QDir
directoryEntered

directoryEntered(self, str) [signal]

directoryUrl(self) → QUrl
directoryUrlEntered

directoryUrlEntered(self, QUrl) [signal]

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
fileMode(self) → QFileDialog.FileMode
fileSelected

fileSelected(self, str) [signal]

filesSelected

filesSelected(self, Iterable[str]) [signal]

filter(self) → QDir.Filters
filterSelected

filterSelected(self, str) [signal]

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

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

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

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

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]
getExistingDirectory(parent: QWidget = None, caption: str = '', directory: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = QFileDialog.ShowDirsOnly) → str
getExistingDirectoryUrl(parent: QWidget = None, caption: str = '', directory: QUrl = QUrl(), options: Union[QFileDialog.Options, QFileDialog.Option] = QFileDialog.ShowDirsOnly, supportedSchemes: Iterable[str] = []) → QUrl
getFilename()

Open the dialog, allow the user to choose a special directory/file, and return the path to that directory/file.

getOpenFileName(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0) → Tuple[str, str]
getOpenFileNames(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0) → Tuple[List[str], str]
getOpenFileUrl(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]
getOpenFileUrls(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[List[QUrl], str]
getSaveFileName(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0) → Tuple[str, str]
getSaveFileUrl(parent: QWidget = None, caption: str = '', directory: str = '', filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]
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)
history(self) → List[str]
iconProvider(self) → QFileIconProvider
inherits(self, str) → bool
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
inputMethodHints(self) → Qt.InputMethodHints
inputMethodQuery(self, Qt.InputMethodQuery) → Any
insertAction(self, QAction, QAction)
insertActions(self, QAction, Iterable[QAction])
installEventFilter(self, QObject)
isActiveWindow(self) → bool
isAncestorOf(self, QWidget) → bool
isEnabled(self) → bool
isEnabledTo(self, QWidget) → bool
isFullScreen(self) → bool
isHidden(self) → bool
isLeftToRight(self) → bool
isMaximized(self) → bool
isMinimized(self) → bool
isModal(self) → bool
isRightToLeft(self) → bool
isSignalConnected(self, QMetaMethod) → bool
isSizeGripEnabled(self) → bool
isVisible(self) → bool
isVisibleTo(self, QWidget) → bool
isWidgetType(self) → bool
isWindow(self) → bool
isWindowModified(self) → bool
isWindowType(self) → bool
itemDelegate(self) → QAbstractItemDelegate
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
keyboardGrabber() → QWidget
killTimer(self, int)
labelText(self, QFileDialog.DialogLabel) → str
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
mimeTypeFilters(self) → List[str]
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)
nameFilters(self) → List[str]
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)

open(self, PYQT_SLOT)

options(self) → QFileDialog.Options
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
proxyModel(self) → QAbstractProxyModel
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
restoreState(self, Union[QByteArray, bytes, bytearray]) → bool
result(self) → int
saveGeometry(self) → QByteArray
saveState(self) → QByteArray
scroll(self, int, int)

scroll(self, int, int, QRect)

selectFile(self, str)
selectMimeTypeFilter(self, str)
selectNameFilter(self, str)
selectUrl(self, QUrl)
selectedFiles(self) → List[str]
selectedMimeTypeFilter(self) → str
selectedNameFilter(self) → str
selectedUrls(self) → List[QUrl]
sender(self) → QObject
senderSignalIndex(self) → int
setAcceptDrops(self, bool)
setAcceptMode(self, QFileDialog.AcceptMode)
setAccessibleDescription(self, str)
setAccessibleName(self, str)
setAttribute(self, Qt.WidgetAttribute, on: bool = True)
setAutoFillBackground(self, bool)
setBackgroundRole(self, QPalette.ColorRole)
setBaseSize(self, int, int)

setBaseSize(self, QSize)

setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins)

setContextMenuPolicy(self, Qt.ContextMenuPolicy)
setCursor(self, Union[QCursor, Qt.CursorShape])
setDefaultSuffix(self, str)
setDirectory(self, str)

setDirectory(self, QDir)

setDirectoryUrl(self, QUrl)
setDisabled(self, bool)
setEnabled(self, bool)
setFileMode(self, QFileDialog.FileMode)
setFilter(self, Union[QDir.Filters, QDir.Filter])
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)
setHistory(self, Iterable[str])
setIconProvider(self, QFileIconProvider)
setInputMethodHints(self, Union[Qt.InputMethodHints, Qt.InputMethodHint])
setItemDelegate(self, QAbstractItemDelegate)
setLabelText(self, QFileDialog.DialogLabel, str)
setLayout(self, QLayout)
setLayoutDirection(self, Qt.LayoutDirection)
setLocale(self, QLocale)
setMask(self, QBitmap)

setMask(self, QRegion)

setMaximumHeight(self, int)
setMaximumSize(self, int, int)

setMaximumSize(self, QSize)

setMaximumWidth(self, int)
setMimeTypeFilters(self, Iterable[str])
setMinimumHeight(self, int)
setMinimumSize(self, int, int)

setMinimumSize(self, QSize)

setMinimumWidth(self, int)
setModal(self, bool)
setMouseTracking(self, bool)
setNameFilter(self, str)
setNameFilters(self, Iterable[str])
setObjectName(self, str)
setOption(self, QFileDialog.Option, on: bool = True)
setOptions(self, Union[QFileDialog.Options, QFileDialog.Option])
setPalette(self, QPalette)
setParent(self, QWidget)

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

setProperty(self, str, Any) → bool
setProxyModel(self, QAbstractProxyModel)
setResult(self, int)
setShortcutAutoRepeat(self, int, enabled: bool = True)
setShortcutEnabled(self, int, enabled: bool = True)
setSidebarUrls(self, Iterable[QUrl])
setSizeGripEnabled(self, bool)
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)
setSupportedSchemes(self, Iterable[str])
setTabOrder(QWidget, QWidget)
setTabletTracking(self, bool)
setToolTip(self, str)
setToolTipDuration(self, int)
setUpdatesEnabled(self, bool)
setViewMode(self, QFileDialog.ViewMode)
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)
sidebarUrls(self) → List[QUrl]
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
supportedSchemes(self) → List[str]
tabletEvent(self, QTabletEvent)
testAttribute(self, Qt.WidgetAttribute) → bool
testOption(self, QFileDialog.Option) → 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
urlSelected

urlSelected(self, QUrl) [signal]

urlsSelected

urlsSelected(self, Iterable[QUrl]) [signal]

viewMode(self) → QFileDialog.ViewMode
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
schrodinger.ui.qt.filedialog.get_existing_phase_database(*args, **kwargs)

Convenience function to open an Open Project dialog and return the path the user selects.

All parameters are passed to and documented in the PhaseDatabaseOpenDialog class.

Parameters:id (str, int or float) – The identifier used for this dialog. Dialogs with the same identifier will remember the last directory chosen by the user with any dialog of the same id and open in that directory. The dir keyword parameter can be used to override the initial directory the dialog opens in, but the chosen directory will still be stored for the next time a dialog with the same identifier opens. The default (no id given) is to not remember the chosen directory.
Return type:str or None
Returns:The path to the project if the user selects one, or None if the user cancels the dialog