schrodinger.application.jaguar.gui.filedialog module

Custom file dialogs for the Jaguar GUIs

class schrodinger.application.jaguar.gui.filedialog.FileDialogWithExtraCombo(parent, caption, lbl_text, combo_items)

Bases: schrodinger.ui.qt.filedialog.FileDialog

A Qt file dialog with an extra combo box about the filename text edit

__init__(parent, caption, lbl_text, combo_items)

Create a new file dialog with the specified label text and combo box items.

Parameters

• parent (PyQt5.QtWidgets.QWidget) – The Qt parent widget

• caption (str) – The title of the dialog

• lbl_text (str) – The label text to display next to the extra combo box

• combo_items (tuple) – A list of strings to add to the combo box

selectedOption()

Return the currently selected index for the extra combo box

Returns

The currently selected index for the extra combo box

Return type

int

Accept = 3

class AcceptMode

Bases: int

AcceptOpen = 0

AcceptSave = 1

Accepted = 1

AnyFile = 0

Detail = 0

class DialogCode

Bases: int

class DialogLabel

Bases: int

Directory = 2

DirectoryOnly = 4

DontConfirmOverwrite = 4

DontResolveSymlinks = 2

DontUseCustomDirectoryIcons = 128

DontUseNativeDialog = 16

DontUseSheet = 8

DrawChildren = 2

DrawWindowBackground = 1

ExistingFile = 1

ExistingFiles = 3

class FileMode

Bases: int

FileName = 1

FileType = 2

HideNameFilterDetails = 64

IgnoreMask = 4

List = 1

LookIn = 0

class Option

Bases: int

class Options

class Options(Union[QFileDialog.Options, QFileDialog.Option]) → None

class Options(QFileDialog.Options) → None

Bases: sip.simplewrapper

__init__(*args, **kwargs)

class PaintDeviceMetric

Bases: int

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

ReadOnly = 32

Reject = 4

Rejected = 0

class RenderFlag

Bases: int

class RenderFlags

class RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) → None

class RenderFlags(QWidget.RenderFlags) → None

Bases: sip.simplewrapper

__init__(*args, **kwargs)

ShowDirsOnly = 1

class ViewMode

Bases: int

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

FileDialogWithExtraCombo.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: PyQt5.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(QMetaObject.Connection) → bool

disconnect(self) → None

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) → PyQt5.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(PyQt5.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=2, *, show_dirs_only=True, **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).

• show_dirs_only (bool) – Whether we should show only directories in the file dialog. If False, both files and directories will be shown.

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: QUrl = QUrl(), filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]

getOpenFileUrls(parent: QWidget = None, caption: str = '', directory: QUrl = QUrl(), 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: QUrl = QUrl(), 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]) → None

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

FileDialogWithExtraCombo.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)

FileDialogWithExtraCombo.move(self, int, int) -> None

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) → None

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.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))

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

repaint(self)

FileDialogWithExtraCombo.repaint(self, int, int, int, int) -> None

repaint(self, QRect) → None

repaint(self, QRegion) → None

resize(self, QSize)

FileDialogWithExtraCombo.resize(self, int, int) -> None

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

FileDialogWithExtraCombo.scroll(self, int, int)

FileDialogWithExtraCombo.scroll(self, int, int, QRect) -> None

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)

FileDialogWithExtraCombo.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

FileDialogWithExtraCombo.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins) → None

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

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

setDefaultSuffix(self, str)

setDirectory(self, str)

setDirectory(self, QDir) → None

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)

FileDialogWithExtraCombo.setFixedSize(self, int, int) -> None

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason) → None

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setGeometry(self, QRect)

FileDialogWithExtraCombo.setGeometry(self, int, int, int, int) -> None

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) → None

setMaximumHeight(self, int)

FileDialogWithExtraCombo.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMimeTypeFilters(self, Iterable[str])

setMinimumHeight(self, int)

FileDialogWithExtraCombo.setMinimumSize(self, int, int)

setMinimumSize(self, QSize) → None

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]) → None

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)

FileDialogWithExtraCombo.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize) → None

setSizePolicy(self, QSizePolicy)

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

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

setSupportedSchemes(self, Iterable[str])

FileDialogWithExtraCombo.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) → None

update(self, QRegion) → None

FileDialogWithExtraCombo.update(self, int, int, int, int) -> None

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) → PyQt5.sip.voidptr

window(self) → QWidget

windowFilePath(self) → str

windowFlags(self) → Qt.WindowFlags

windowHandle(self) → QWindow

windowIcon(self) → QIcon

windowIconChanged

windowIconChanged(self, QIcon) [signal]

windowIconText(self) → str

windowIconTextChanged

windowIconTextChanged(self, str) [signal]

windowModality(self) → Qt.WindowModality

windowOpacity(self) → float

windowRole(self) → str

windowState(self) → Qt.WindowStates

windowTitle(self) → str

windowTitleChanged

windowTitleChanged(self, str) [signal]

windowType(self) → Qt.WindowType

x(self) → int

y(self) → int

class schrodinger.application.jaguar.gui.filedialog.ReadFileDialog(parent, allowed_options=None)

Bases: schrodinger.application.jaguar.gui.filedialog.FileDialogWithExtraCombo

An Open dialog both with an extra combo box to specify what should be read from the specified file.

Variables

• GEOM_AND_SETTINGS (int) – The index of the “Geometry and settings” option, as returned by selectedOption().

• GEOM_ONLY (int) – The index of the “Geometry only” option, as returned by selectedOption().

• SETTINGS_ONLY (int) – The index of the “Settings only” option, as returned by selectedOption().

GEOM_AND_SETTINGS = 0

GEOM_ONLY = 1

SETTINGS_ONLY = 2

OPTION_TEXT = {0: 'Geometry and settings', 1: 'Geometry only', 2: 'Settings only'}

__init__(parent, allowed_options=None)

Create a new file dialog with the specified label text and combo box items.

Parameters

• parent (PyQt5.QtWidgets.QWidget) – The Qt parent widget

• caption (str) – The title of the dialog

• lbl_text (str) – The label text to display next to the extra combo box

• combo_items (tuple) – A list of strings to add to the combo box

Accept = 3

class AcceptMode

Bases: int

AcceptOpen = 0

AcceptSave = 1

Accepted = 1

AnyFile = 0

Detail = 0

class DialogCode

Bases: int

class DialogLabel

Bases: int

Directory = 2

DirectoryOnly = 4

DontConfirmOverwrite = 4

DontResolveSymlinks = 2

DontUseCustomDirectoryIcons = 128

DontUseNativeDialog = 16

DontUseSheet = 8

DrawChildren = 2

DrawWindowBackground = 1

ExistingFile = 1

ExistingFiles = 3

class FileMode

Bases: int

FileName = 1

FileType = 2

HideNameFilterDetails = 64

IgnoreMask = 4

List = 1

LookIn = 0

class Option

Bases: int

class Options

class Options(Union[QFileDialog.Options, QFileDialog.Option]) → None

class Options(QFileDialog.Options) → None

Bases: sip.simplewrapper

__init__(*args, **kwargs)

class PaintDeviceMetric

Bases: int

PdmDepth = 6

PdmDevicePixelRatio = 11

PdmDevicePixelRatioScaled = 12

PdmDpiX = 7

PdmDpiY = 8

PdmHeight = 2

PdmHeightMM = 4

PdmNumColors = 5

PdmPhysicalDpiX = 9

PdmPhysicalDpiY = 10

PdmWidth = 1

PdmWidthMM = 3

ReadOnly = 32

Reject = 4

Rejected = 0

class RenderFlag

Bases: int

class RenderFlags

class RenderFlags(Union[QWidget.RenderFlags, QWidget.RenderFlag]) → None

class RenderFlags(QWidget.RenderFlags) → None

Bases: sip.simplewrapper

__init__(*args, **kwargs)

ShowDirsOnly = 1

class ViewMode

Bases: int

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

ReadFileDialog.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: PyQt5.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(QMetaObject.Connection) → bool

disconnect(self) → None

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) → PyQt5.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(PyQt5.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=2, *, show_dirs_only=True, **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).

• show_dirs_only (bool) – Whether we should show only directories in the file dialog. If False, both files and directories will be shown.

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: QUrl = QUrl(), filter: str = '', initialFilter: str = '', options: Union[QFileDialog.Options, QFileDialog.Option] = 0, supportedSchemes: Iterable[str] = []) → Tuple[QUrl, str]

getOpenFileUrls(parent: QWidget = None, caption: str = '', directory: QUrl = QUrl(), 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: QUrl = QUrl(), 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]) → None

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

ReadFileDialog.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)

ReadFileDialog.move(self, int, int) -> None

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) → None

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.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))

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

repaint(self)

ReadFileDialog.repaint(self, int, int, int, int) -> None

repaint(self, QRect) → None

repaint(self, QRegion) → None

resize(self, QSize)

ReadFileDialog.resize(self, int, int) -> None

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

ReadFileDialog.scroll(self, int, int)

ReadFileDialog.scroll(self, int, int, QRect) -> None

selectFile(self, str)

selectMimeTypeFilter(self, str)

selectNameFilter(self, str)

selectUrl(self, QUrl)

selectedFiles(self) → List[str]

selectedMimeTypeFilter(self) → str

selectedNameFilter(self) → str

selectedOption()

Return the currently selected index for the extra combo box

Returns

The currently selected index for the extra combo box

Return type

int

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)

ReadFileDialog.setBaseSize(self, int, int)

setBaseSize(self, QSize) → None

ReadFileDialog.setContentsMargins(self, int, int, int, int)

setContentsMargins(self, QMargins) → None

setContextMenuPolicy(self, Qt.ContextMenuPolicy)

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

setDefaultSuffix(self, str)

setDirectory(self, str)

setDirectory(self, QDir) → None

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)

ReadFileDialog.setFixedSize(self, int, int) -> None

setFixedWidth(self, int)

setFocus(self)

setFocus(self, Qt.FocusReason) → None

setFocusPolicy(self, Qt.FocusPolicy)

setFocusProxy(self, QWidget)

setFont(self, QFont)

setForegroundRole(self, QPalette.ColorRole)

setGeometry(self, QRect)

ReadFileDialog.setGeometry(self, int, int, int, int) -> None

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) → None

setMaximumHeight(self, int)

ReadFileDialog.setMaximumSize(self, int, int)

setMaximumSize(self, QSize) → None

setMaximumWidth(self, int)

setMimeTypeFilters(self, Iterable[str])

setMinimumHeight(self, int)

ReadFileDialog.setMinimumSize(self, int, int)

setMinimumSize(self, QSize) → None

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]) → None

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)

ReadFileDialog.setSizeIncrement(self, int, int)

setSizeIncrement(self, QSize) → None

setSizePolicy(self, QSizePolicy)

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

setStatusTip(self, str)

setStyle(self, QStyle)

setStyleSheet(self, str)

setSupportedSchemes(self, Iterable[str])

ReadFileDialog.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) → None

update(self, QRegion) → None

ReadFileDialog.update(self, int, int, int, int) -> None

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) → PyQt5.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