Trees       Indices       Help   
2016-3 Schrodinger Python API
Package schrodinger :: Package ui :: Package qt :: Module filedialog :: Class FileDialog
[hide private]
[frames] | no frames]

Class FileDialog

       object --+                        
                |                        
sip.simplewrapper --+                    
                    |                    
          sip.wrapper --+                
                        |                
     PyQt4.QtCore.QObject --+            
                            |            
           object --+       |            
                    |       |            
    sip.simplewrapper --+   |            
                        |   |            
 PyQt4.QtGui.QPaintDevice --+            
                            |            
          PyQt4.QtGui.QWidget --+        
                                |        
              PyQt4.QtGui.QDialog --+    
                                    |    
              PyQt4.QtGui.QFileDialog --+
                                        |
                                       FileDialog
Known Subclasses:

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.

Nested Classes [hide private]

Inherited from PyQt4.QtGui.QFileDialog: AcceptMode, DialogLabel, FileMode, Option, Options, ViewMode

Inherited from PyQt4.QtGui.QDialog: DialogCode

Inherited from PyQt4.QtGui.QWidget: RenderFlag, RenderFlags

Inherited from PyQt4.QtGui.QPaintDevice: PaintDeviceMetric

Instance Methods [hide private]
 
__init__(self, parent=None, caption='', directory='', filter='All Files (*)', custom_sidebar=True, sidebar_links=None)
x.__init__(...) initializes x; see help(type(x)) for signature
 
exec_(self)
Makes sure this dialog is on top of other windows when it pops up.

Inherited from PyQt4.QtGui.QFileDialog: accept, acceptMode, changeEvent, confirmOverwrite, currentChanged, defaultSuffix, directory, directoryEntered, done, fileMode, fileSelected, filesSelected, filter, filterSelected, filters, getOpenFileNameAndFilter, getOpenFileNamesAndFilter, getSaveFileNameAndFilter, history, iconProvider, isNameFilterDetailsVisible, isReadOnly, itemDelegate, labelText, nameFilters, open, options, proxyModel, resolveSymlinks, restoreState, saveState, selectFile, selectFilter, selectNameFilter, selectedFiles, selectedFilter, selectedNameFilter, setAcceptMode, setConfirmOverwrite, setDefaultSuffix, setDirectory, setFileMode, setFilter, setFilters, setHistory, setIconProvider, setItemDelegate, setLabelText, setNameFilter, setNameFilterDetailsVisible, setNameFilters, setOption, setOptions, setProxyModel, setReadOnly, setResolveSymlinks, setSidebarUrls, setViewMode, setVisible, sidebarUrls, testOption, viewMode

Inherited from PyQt4.QtGui.QDialog: accepted, closeEvent, contextMenuEvent, eventFilter, extension, finished, isSizeGripEnabled, keyPressEvent, minimumSizeHint, orientation, reject, rejected, resizeEvent, result, setExtension, setModal, setOrientation, setResult, setSizeGripEnabled, showEvent, showExtension, sizeHint

Inherited from PyQt4.QtGui.QWidget: acceptDrops, accessibleDescription, accessibleName, actionEvent, actions, activateWindow, addAction, addActions, adjustSize, autoFillBackground, backgroundRole, baseSize, childAt, childrenRect, childrenRegion, clearFocus, clearMask, close, contentsMargins, contentsRect, contextMenuPolicy, create, cursor, customContextMenuRequested, destroy, devType, dragEnterEvent, dragLeaveEvent, dragMoveEvent, dropEvent, effectiveWinId, enabledChange, ensurePolished, enterEvent, event, find, focusInEvent, focusNextChild, focusNextPrevChild, focusOutEvent, focusPolicy, focusPreviousChild, focusProxy, focusWidget, font, fontChange, fontInfo, fontMetrics, foregroundRole, frameGeometry, frameSize, geometry, getContentsMargins, grabGesture, grabKeyboard, grabMouse, grabShortcut, graphicsEffect, graphicsProxyWidget, handle, hasFocus, hasMouseTracking, height, heightForWidth, hide, hideEvent, inputContext, inputMethodEvent, inputMethodHints, inputMethodQuery, insertAction, insertActions, isActiveWindow, isAncestorOf, isEnabled, isEnabledTo, isEnabledToTLW, isFullScreen, isHidden, isLeftToRight, isMaximized, isMinimized, isModal, isRightToLeft, isTopLevel, isVisible, isVisibleTo, isWindow, isWindowModified, keyReleaseEvent, keyboardGrabber, languageChange, layout, layoutDirection, leaveEvent, locale, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, mask, maximumHeight, maximumSize, maximumWidth, metric, minimumHeight, minimumSize, minimumWidth, mouseDoubleClickEvent, mouseGrabber, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, move, moveEvent, nativeParentWidget, nextInFocusChain, normalGeometry, overrideWindowFlags, overrideWindowState, paintEngine, paintEvent, palette, paletteChange, parentWidget, pos, previousInFocusChain, raise_, rect, releaseKeyboard, releaseMouse, releaseShortcut, removeAction, render, repaint, resetInputContext, resize, restoreGeometry, saveGeometry, scroll, setAcceptDrops, setAccessibleDescription, setAccessibleName, setAttribute, setAutoFillBackground, setBackgroundRole, setBaseSize, setContentsMargins, setContextMenuPolicy, setCursor, setDisabled, setEnabled, setFixedHeight, setFixedSize, setFixedWidth, setFocus, setFocusPolicy, setFocusProxy, setFont, setForegroundRole, setGeometry, setGraphicsEffect, setHidden, setInputContext, setInputMethodHints, setLayout, setLayoutDirection, setLocale, setMask, setMaximumHeight, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumWidth, setMouseTracking, setPalette, setParent, setShortcutAutoRepeat, setShortcutEnabled, setShown, setSizeIncrement, setSizePolicy, setStatusTip, setStyle, setStyleSheet, setTabOrder, setToolTip, setUpdatesEnabled, setWhatsThis, setWindowFilePath, setWindowFlags, setWindowIcon, setWindowIconText, setWindowModality, setWindowModified, setWindowOpacity, setWindowRole, setWindowState, setWindowTitle, show, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeIncrement, sizePolicy, stackUnder, statusTip, style, styleSheet, tabletEvent, testAttribute, toolTip, topLevelWidget, underMouse, ungrabGesture, unsetCursor, unsetLayoutDirection, unsetLocale, update, updateGeometry, updateMicroFocus, updatesEnabled, visibleRegion, whatsThis, wheelEvent, width, winId, window, windowActivationChange, windowFilePath, windowFlags, windowIcon, windowIconText, windowModality, windowOpacity, windowRole, windowState, windowTitle, windowType, x, x11Info, x11PictureHandle, y

Inherited from PyQt4.QtCore.QObject: __getattr__, blockSignals, childEvent, children, connect, connectNotify, customEvent, deleteLater, destroyed, disconnect, disconnectNotify, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, emit, findChild, findChildren, inherits, installEventFilter, isWidgetType, killTimer, metaObject, moveToThread, objectName, parent, property, pyqtConfigure, receivers, removeEventFilter, sender, senderSignalIndex, setObjectName, setProperty, signalsBlocked, startTimer, thread, timerEvent, tr, trUtf8

Inherited from PyQt4.QtGui.QPaintDevice: colorCount, depth, heightMM, logicalDpiX, logicalDpiY, numColors, paintingActive, physicalDpiX, physicalDpiY, widthMM

Inherited from sip.simplewrapper: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]
str or None
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
str or None
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
list of str or None
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
str or None
getOpenFileName(parent='', caption='Open File', dir=None, filter='All Files (*)', **kwargs)
Convenience function that returns a single filename as selected by the user
Class Variables [hide private]

Inherited from PyQt4.QtGui.QFileDialog: Accept, AcceptOpen, AcceptSave, AnyFile, Detail, Directory, DirectoryOnly, DontConfirmOverwrite, DontResolveSymlinks, DontUseNativeDialog, DontUseSheet, ExistingFile, ExistingFiles, FileName, FileType, HideNameFilterDetails, List, LookIn, ReadOnly, Reject, ShowDirsOnly

Inherited from PyQt4.QtGui.QDialog: Accepted, Rejected

Inherited from PyQt4.QtGui.QWidget: DrawChildren, DrawWindowBackground, IgnoreMask

Inherited from PyQt4.QtCore.QObject: staticMetaObject

Inherited from PyQt4.QtGui.QPaintDevice: PdmDepth, PdmDpiX, PdmDpiY, PdmHeight, PdmHeightMM, PdmNumColors, PdmPhysicalDpiX, PdmPhysicalDpiY, PdmWidth, PdmWidthMM

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

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

 

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.
Returns: str or None
full pathname of the file selected by the user, or None if Cancel was pressed
Overrides: PyQt4.QtGui.QFileDialog.getExistingDirectory

getSaveFileName(parent='', caption='Save File', dir=None, filter='All Files (*)', accept_label='Save', accept_mode=1, file_mode=0, **kwargs)
Static Method

 

Convenience function that returns a filename as selected by the user

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

Returns: str or None
full pathname of the file selected by the user, or None if Cancel was pressed
Overrides: PyQt4.QtGui.QFileDialog.getSaveFileName

getOpenFileNames(parent='', caption='Open Files', dir=None, filter='All Files (*)', accept_label='Open', file_mode=3, **kwargs)
Static Method

 

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.

Returns: list of str or None
list of full file pathnames selected by the user, or None if Cancel was pressed.
Overrides: PyQt4.QtGui.QFileDialog.getOpenFileNames

getOpenFileName(parent='', caption='Open File', dir=None, filter='All Files (*)', **kwargs)
Static Method

 

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.

Returns: str or None
full pathname of the file selected by the user, or None if Cancel was pressed
Overrides: PyQt4.QtGui.QFileDialog.getOpenFileName

__init__(self, parent=None, caption='', directory='', filter='All Files (*)', custom_sidebar=True, sidebar_links=None)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

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)". examples:
    • "image files (*.png *.jpg *.bmp)"
    • "images (*.png *.xpm *.jpg);;text files (*.txt);;all files (*)"

    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.
Overrides: object.__init__

exec_(self)

 

Makes sure this dialog is on top of other windows when it pops up. This is a particular problem on Mac OS.

Overrides: PyQt4.QtGui.QDialog.exec_

   Trees       Indices       Help   
2016-3 Schrodinger Python API
Generated by Epydoc 3.0.1 on Wed Aug 3 08:00:02 2016 http://epydoc.sourceforge.net