| Allegro CL version 8.2 Object described on page has changed in 8.2. 8.1 version |
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 (buffer-size (file-selection-buffer-size (configuration *system*)))
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:
nil
or "" (the empty string), the
initial name will appear as the currently allowed type, such as
"*.cl". The default is "". A non-nil
value may be either a namestring or a pathname object.
*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.
*system*
.
(("Text Files" . "*.txt")("Pixmap
Files" . "*.bmp;*.jpg;*.jpeg"))
would initially display all
files whose type is "txt", and also allow the user to select the
second choice to instead display all files of the types "bmp", "jpg",
and "jpeg". (Users can always type in some other file if desired.)
The default value of this argument is (("All files"
. "*.*"))
to display all files. (In releases prior to 7.0,
the default was the value of the variable
cg:*edit-allowed-types*
. That variable is no
longer supported and the default is now built in.)
nil
, the current directory is left
unchanged. Default is nil
. This argument has
no effect on GTK. See GTK note below.
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").
nil
(the default), the file
cannot be selected. If true, the file can be selected. This argument
has no effect on GTK. See GTK note below.
nil
, returns the existing filename
string without complaint. Default is t.
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
.
(file-selection-buffer-size (configuration
*system*))
(see file-selection-buffer-size, configuration, and *system*
). The default should always be
sufficient when asking for new pathnames, where the filenames must be
typed in.
This function uses the standard Common Dialog supplied by the platform's underlying windowing system 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.
The arguments change-current-directory-p and share-aware-p have no effect on GTK because the underlying native GTK file selection dialog does not support such options.
Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
The object described on this page has been modified in the 8.2 release; see the Release Notes.
Created 2016.6.21.
| Allegro CL version 8.2 Object described on page has changed in 8.2. 8.1 version |