# module FileDialogs

This module defines functions that present dialog boxes for requesting new and existing files and directories according to platform conventions.

## Parameters

The following parameters are used by these functions:

prompt
  A prompt string to be displayed. It is up to the platform exactly where and how the prompt is shown, and it may not be shown at all in some cases. If omitted, a suitable default is used depending on the type of request.
default_dir
  A FileRef or DirRef specifying the initial directory to be browsed. If omitted, a platform-dependent default is used (usually the last directory visited in the application by a file dialog).
default_name
  For functions that request a new object name, the initial value entered into the name area of the dialog. If omitted, the name area is initially empty.
file_type, file_types
  A FileType or list of FileTypes specifying acceptable file types.

## Functions

`request_old_file(``prompt` `=` None`,` `default_dir` `=` None`,` `file_types` `=` `None)
`
  Prompts the user to select an existing file. If any file_types are supplied, the user is only allowed to select a file matching one of the specified types.
  Returns a FileRef, or `None` if the user cancelled.

`request_old_files(``prompt` `=` None`,` `default_dir` `=` None`,` `file_types` `=` `None``)
`
  Prompts the user to select a set of existing files. If any file_types are supplied, the user is only allowed to select files matching one of the specified types.
  Returns a list of FileRefs, or `None` if the user cancelled.

`request_new_file(``prompt` `=` None`,` `default_dir` `=` None`,` `default_name` `=` `None,` `file_type` `=` `None)
`
  Prompts the user to supply a name and location for a new file. If file_type is specified, it should represent the type if file which is to be created; some platforms use this to restrict the list of existing files displayed, and to determine the suffix of the returned filename.
  Returns a FileRef, or `None` if the user cancelled.

`request_old_directory(``prompt` `=` None`,` `default_dir` `=` None`)`
  Prompts the user to select an existing directory.
  Returns a FileRef, or `None` if the user cancelled.

`request_old_directories(``prompt` `=` None`,` `default_dir` `=` None`)`
  Prompts the user to select a set of existing directories.
  Returns a list of FileRefs, or `None` if the user cancelled.

`request_new_directory(``prompt` `=` None`,` `default_dir` `=` None`,` `default_name` `=` None`)
`
  Prompts the user to supply a name and location for a new directory.
  Returns a FileRef, or `None` if the user cancelled.

---