Module filedialog

Convenience function that creates a highly customizable file dialog

@type parent: qwidget
@param parent: the widget over which this dialog should be shown.

@type caption: str
@param caption: the name that appears in the titlebar of this dialog.  

@type dir: str
@param dir: the initial directory displayed in this dialog

@type filter: str
@param filter: 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 (*)"

@type selectedFilter: str
@param selectedFilter: the filter used by default.  if not specified, the
first filter in the filters string is used.

@type options: qfiledialog.option enum
@param options: see the qfiledialog.option and qfiledialog.setoptions 
documentation

@type default_suffix: str
@param default_suffix: the suffix applied to a filename if the user does
supply one.  the suffix will have a leading '.' appended to it.

@type default_filename: str
@param default_filename: A default base filename to use to save files in
save dialogs. By default, the filename field of the dialog is blank.

@type accept_label: str
@param accept_label: the text on the 'accept' button

@type accept_mode: qfiledialog.acceptmode
@param accept_mode: whether the dialog is in open or save mode.  see the
pyqt documentation for qfiledialog.acceptmode (currently acceptopen and 
acceptsave are the two options)

@type file_mode: qfiledialog.filemode
@param file_mode: what the user can select.  see the pyqt documentation for 
qfiledialog.filemode (currently anyfile, existingfile, directory and 
existingfiles are the options)

@type confirm: bool
@param confirm: true if a confirmation dialog should be used if the user
selects an existing file, false if not

@type custom_sidebar: bool
@param custom_sidebar: True if the Schrodinger sidebar should be used,
False if the default PyQt sidebar should be used.

@type sidebar_links: dict
@param sidebar_links: 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.

@type id: str, int or float
@param id: 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.

@rtype: list or None
@return: 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.

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: str

Filter string

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

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

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)

Returns: str or None

The path to the project if the user selects one, or None if the user cancels the dialog

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)

Returns: str or None

The path to the project if the user selects one, or None if the user cancels the dialog

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

Returns: str or None

The last directory opened by a dialog with the given id value, or None if no entry exists for the id value.

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

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.

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

See base_file_dialog for documentation.

Returns: str or None

Full pathname of the WaterMap file selected by the user or None if cancel was pressed.

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

Returns: dict

dictionary of attached drives. Keys are text names of the drive, values are tuples of (path, text name).

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.

Returns: bool

True if path points to a Phase database, False if not

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

Returns: bool

True if path points to a project, False if not

MAESTRO_FILTER

Value:

'Maestro files (*.bld *.cms *.cms.gz *.cmsgz *.mae *.mae.gz *.maegz)'

MAESTRO_SD_FILTER

Value:

'All supported files (*.bld *.cms *.cms.gz *.cmsgz *.mae *.mae.gz *.ma egz *.sd *.sdf *.mol *.sdf.gz *.sdfgz *.sd.gz *.mol.gz);;Maestro files (*.bld *.cms *.cms.gz *.cmsgz *.mae *.mae.gz *.maegz);;SD files (*.sd *.sdf *.mol *.sdf.gz *.sdfgz *.sd.gz *.mol.gz)'

PDB_FILTER

Value:

'PDB files (*.pdb *.ent *.pdb.gz *.pdbgz *.ent.gz *.entgz)'

SD_FILTER

Value:

'SD files (*.sd *.sdf *.mol *.sdf.gz *.sdfgz *.sd.gz *.mol.gz)'