ask-user-for-new-pathname

Function

Package: common-graphics

Arguments: prompt &key initial-name initial-directory stream allowed-types multiple-p change-current-directory-p warn-if-exists-p share-aware-p default-extension

This function provides the service of prompting for one or more new pathnames. It displays a file choice dialog which can be used to specify the directory component. Typing the new name into the File field specifies the filename.

If multiple-p is nil (the default), returns the pathname of the selected file, or nil if none was chosen. If multiple-p is true, returns a list of pathnames of the selected files (even if only one is selected) or nil if none is selected. prompt should be a string explaining what is to be done with the selected file (e.g. "Select new filename for file").

The arguments are:

initial-name: the filename shown initially for selection. It can be any relative filename with respect to the initial directory (the value of :host). If nil or "" (the empty string), the initial name will appear as the currently allowed type, such as "*.cl". The default is "".
initial-directory: the initial directory from which to select the file or from which to change directory. If this value is unsupplied, the default depends on the value of the context-sensitive-default-path configuration property, but is in most cases the most recent value is used. The value of *default-pathname-defaults* is used initially. In earlier releases, this argument was called host. host is still accepted in place of initial-directory. Do not specify both.
allowed-types: a filter of file types, specified as a list of conses, where the car is a descriptive string (e.g. "Lisp files") and the cdr is a string designating the file and type (e.g. "*.cl"). The first selection in the list will be the types of files that first appear, since only files with the currently-selected extension are displayed. The default value shows the format of the value and is:'(("Lisp files" . "*.cl") ("All files" . "*.*"))
change-current-directory-p: a Boolean which, if true, changes the Microsoft Windows current directory to be the final selected directory when you exit or cancel the dialog. If nil, the current directory is left unchanged. Default is nil.
multiple-p: a Boolean which, if true, allows the user to name more than one file; the list of selected pathname strings is returned. If nil, only one file may be selected and the returned value is a pathname string or nil, if the user cancels the dialog. The default is nil.
It is not clear how useful this option is but we include it because the operating system allows it. Users have to type the filenames into a dialog. Multiple filenames must be enclosed in double quotes and be space delimited ("foo.cl" "c:\tmp\bar.fasl").
Note: there is a buffer that holds the chosen pathnames. An error will be signaled if the buffer is too small to hold the multiple chosen pathnames. (Since the user must type in the filenames, we suspect this will not be a problem for this function. The default buffer is sufficient to hold 12 pathnames of maximum length, that is about 3000 characters.) The size of the buffer can be increased. See file-selection-buffer-size.
share-aware-p: a Boolean which controls whether a file that is currently opened by another application can be selected. If nil (the default), the file cannot be selected. If true, the file can be selected.
stream: specifies the parent window for the dialog that pops up. Defaults to the value returned by (cg::selected-window-or-screen).
warn-if-exists-p: a Boolean which, if true, pops up a warning dialog if the user selects a file that already exists. If nil, returns the existing filename string without complaint. Default is t.
default-extension: the value should be either nil or a string that names a default pathname extension. This value is used only if the end user has selected an allowed type such as "All Files (*.*)" on the file selection dialog that does not specify a particular type, and they type in a filename with no extension. In that case, the pathname returned by this function will have default-extension as its pathname-type. An exception is that if default-extension is the null string, it will result in a pathname whose type is nil rather than the null string, just as if default-extension were nil.

This function uses the standard Common Dialog supplied by Windows for file selection. Internal Allegro CL file selection dialogs use this function. See ask-user-for-existing-pathname and ask-user-for-directory. See also file-selection-buffer-size.

Common Graphics and IDE documentation is described in About Common Graphics and IDE documentation in cgide.htm.

The documentation is described in introduction.htm and the index is in index.htm.

Created 2000.10.5.