This is the file-select Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:25:01 2024 GMT+0.
file-select/file-select.asdfile-select/package.lispfile-select/protocol.lispfile-select/gtk.lispfile-select/zenity.lispfile-select/kdialog.lispfile-select/macos.lispfile-select/win32.lispfile-select/defaults.lispfile-select/documentation.lispThe main system appears first, followed by any subsystem dependency.
file-selectA library to invoke the native file selection dialogs to open or save files.
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/shinmera/file-select.git)
zlib
1.0.0
trivial-features (system).
cffi (system).
float-features (system).
trivial-main-thread (system)., for feature :darwin
com-on (system)., for feature :windows
documentation-utils (system).
package.lisp (file).
protocol.lisp (file).
gtk.lisp (file).
zenity.lisp (file).
kdialog.lisp (file).
macos.lisp (file).
win32.lisp (file).
defaults.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
file-select/file-select.asdfile-select/package.lispfile-select/protocol.lispfile-select/gtk.lispfile-select/zenity.lispfile-select/kdialog.lispfile-select/macos.lispfile-select/win32.lispfile-select/defaults.lispfile-select/documentation.lispfile-select/protocol.lisppackage.lisp (file).
file-select (system).
*default-backend* (special variable).
backend (class).
existing (function).
existing-with (generic function).
file-select-error (condition).
finalize (generic function).
native-namestring (function).
new (function).
new-with (generic function).
parse-native-namestring (function).
*backend-cache* (special variable).
default-backend (function).
get-backend (function).
file-select/gtk.lisp:linux
protocol.lisp (file).
file-select (system).
existing-with (method).
finalize (method).
gtk (class).
initialize-instance (method).
new-with (method).
add-filter (function).
add-pattern (function).
closure (reader method).
(setf closure) (writer method).
dialog-run (function).
dostrey (function).
g-application-run (function).
g-free (function).
g-get-path (function).
g-signal-connect (function).
g-slist (class).
g-slist-data (function).
(setf g-slist-data) (function).
g-slist-free (function).
g-slist-next (function).
(setf g-slist-next) (function).
g-unref (function).
get-filename (function).
get-filenames (function).
get-files (function).
new-application (function).
new-file-chooser (function).
new-filter (function).
set-current-folder (function).
set-filename (function).
set-name (function).
set-select-multiple (function).
show (function).
show* (function).
file-select/zenity.lisp:linux
gtk.lisp (file).
protocol.lisp (file).
file-select (system).
existing-with (method).
finalize (method).
new-with (method).
zenity (function).
zenity (class).
program-name (reader method).
(setf program-name) (writer method).
zenity* (function).
file-select/kdialog.lisp:linux
zenity.lisp (file).
gtk.lisp (file).
protocol.lisp (file).
file-select (system).
existing-with (method).
finalize (method).
kdialog (function).
kdialog (class).
new-with (method).
kdialog* (function).
file-select/macos.lisp:darwin
kdialog.lisp (file).
zenity.lisp (file).
gtk.lisp (file).
protocol.lisp (file).
file-select (system).
file-select/win32.lisp:windows
macos.lisp (file).
kdialog.lisp (file).
zenity.lisp (file).
gtk.lisp (file).
protocol.lisp (file).
file-select (system).
file-select/defaults.lispwin32.lisp (file).
macos.lisp (file).
kdialog.lisp (file).
zenity.lisp (file).
gtk.lisp (file).
protocol.lisp (file).
file-select (system).
determine-default-backend (function).
no-backend-found (condition).
find-in-path (function).
split (function).
file-select/documentation.lispdefaults.lisp (file).
file-select (system).
Packages are listed by definition order.
org.shirakumo.file-selectorg.shirakumo.file-select.kdialogorg.shirakumo.file-select.gtkorg.shirakumo.file-select.win32org.shirakumo.file-select.zenityorg.shirakumo.file-select.macosorg.shirakumo.file-selectcommon-lisp.
*default-backend* (special variable).
backend (class).
determine-default-backend (function).
existing (function).
existing-with (generic function).
file-select-error (condition).
finalize (generic function).
native-namestring (function).
new (function).
new-with (generic function).
no-backend-found (condition).
parse-native-namestring (function).
*backend-cache* (special variable).
default-backend (function).
find-in-path (function).
get-backend (function).
split (function).
org.shirakumo.file-select.kdialogcommon-lisp.
org.shirakumo.file-select.
kdialog* (function).
org.shirakumo.file-select.gtkcommon-lisp.
org.shirakumo.file-select.
gtk (class).
add-filter (function).
add-pattern (function).
closure (generic reader).
(setf closure) (generic writer).
dialog-run (function).
dostrey (function).
g-application-run (function).
g-free (function).
g-get-path (function).
g-signal-connect (function).
g-slist (class).
g-slist-data (function).
(setf g-slist-data) (function).
g-slist-free (function).
g-slist-next (function).
(setf g-slist-next) (function).
g-unref (function).
get-filename (function).
get-filenames (function).
get-files (function).
new-application (function).
new-file-chooser (function).
new-filter (function).
set-current-folder (function).
set-filename (function).
set-name (function).
set-select-multiple (function).
show (function).
show* (function).
org.shirakumo.file-select.zenitycommon-lisp.
org.shirakumo.file-select.
program-name (generic reader).
(setf program-name) (generic writer).
zenity* (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Holds the name of the default file selection backend to use.
This should be a value suitable for the first argument of NEW-WITH and
EXISTING-WITH.
On first call of NEW or EXISTING, if this variable is still unbound,
it is set to the value of DETERMINE-DEFAULT-BACKEND.
See NEW
See EXISTING
See DETERMINE-DEFAULT-BACKEND
Attempt to determine the proper backend to use for the current system.
This will return the name of the class to use for the backend, or
signal an error of type NO-BACKEND-FOUND if no usable backend could be
found at all.
More specifically, the following detection heuristic is used:
- On WIN32, the WIN32 backend is used.
- On DARWIN, the MACOS backend is used.
- If a "zenity" binary is found in one of the PATH directories, the
ZENITY backend is used.
- If the gtk3 shared library file can be loaded, the GTK backend is
used.
- Otherwise NO-BACKEND-FOUND is signalled.
See NO-BACKEND-FOUND
Select an existing file.
This will open an "open file" dialog.
Returns two values:
- The selected file as a pathname, or as a list if multiple.
- Whether the user completed the operation successfully
If no BACKEND is specified, *DEFAULT-BACKEND* is used.
TITLE may be a string to designate the file dialog window title.
DEFAULT should be a pathname pointing to a default file or directory
that the dialog should present on opening.
FILTER can be one of the following:
:DIRECTORY — Only allow selecting directories.
STRING — Shorthand for (("" TYPE))
((NAME TYPE)*) — Restrict the file selection to the specified
types. NAME should be a human-readable
description, and TYPE should be a PATHNAME-TYPE
to allow for selection.
MULTIPLE designates whether multiple files can be selected. In that
case, the first return value is always a list.
A backend may support additional arguments.
See EXISTING-WITH
See *DEFAULT-BACKEND*
Select a new file.
This will open a "save file" dialog.
Returns two values:
- The selected file as a pathname, if any
- Whether the user completed the operation successfully
If no BACKEND is specified, *DEFAULT-BACKEND* is used.
TITLE may be a string to designate the file dialog window title.
DEFAULT should be a pathname pointing to a default file or directory
that the dialog should present on opening.
FILTER can be one of the following:
:DIRECTORY — Only allow selecting directories.
STRING — Shorthand for (("" TYPE))
((NAME TYPE)*) — Restrict the file selection to the specified
types. NAME should be a human-readable
description, and TYPE should be a PATHNAME-TYPE
to allow for selection.
A backend may support additional arguments.
See NEW-WITH
See *DEFAULT-BACKEND*
Open an "open file" dialog with the specified backend.
The implementation must adhere to the protocol specified in EXISTING.
See EXISTING
See BACKEND
class) &rest args &key title) ¶symbol) &rest args) ¶Finalize the backend and free any resources it might have allocated.
This will NOT close any foreign libraries it might have opened.
After calling FINALIZE on a backend, the backend instance is
invalidated and may not be used again.
See BACKEND
Open a "save file" dialog with the specified backend.
The implementation must adhere to the protocol specified in NEW.
see NEW
See BACKEND
class) &rest args &key title) ¶symbol) &rest args) ¶Superclass for any kind of error signalled during the file selection.
Typically a subclass of this error is signalled depending on the backend used. This kind of error should only every be signalled if critical problems occur that prevent the backend from operating correctly.
error.
Error signalled when no backend could be found.
This usually means that no implementation for file selection is
available. It could mean that auto-detection failed, in which case
*DEFAULT-BACKEND* should be manually set to the proper value.
See *DEFAULT-BACKEND*
See DETERMINE-DEFAULT-BACKEND
Superclass for all file selection backend implementations.
The user should not create instances of this class, or any of its
subclasses. The system will automatically construct singleton
instances of the class when used with NEW-WITH and EXISTING-WITH.
When creating a subclass, you may use INITIALIZE-INSTANCE to perform one-time setup, such as loading and initialising foreign libraries.
In order to uninitialize the libraries, you should implement a
FINALIZE method.
The user may call FINALIZE on a backend instance or name. The instance
will be invalidated afterwards, and a repeat call on NEW-WITH or
EXISTING-WITH with the backend name will create a new instance.
See FINALIZE
See NEW-WITH
See EXISTING-WITH
Implementation using the GTK3 framework.
Note that this will create and destroy a new GTK application on every
use, and requires the GTK3 libraries to be present.
See BACKEND
Implementation using the Zenity GTK dialog utility.
This is preferable over the native GTK backend as it does not require loading the foreign libraries or constructing a GTK application in-process. UIOP:RUN-PROGRAM is used to launch the Zenity process.
See BACKEND
"zenity"
:program-name
foreign-struct-type.
translatable-foreign-type.
| Jump to: | (
A C D E F G I K M N P S Z |
|---|
| Jump to: | (
A C D E F G I K M N P S Z |
|---|
| Jump to: | *
C P S |
|---|
| Jump to: | *
C P S |
|---|
| Jump to: | B C D F G K M N O P S W Z |
|---|
| Jump to: | B C D F G K M N O P S W Z |
|---|