The select-file Reference Manual

This is the select-file Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Jul 15 06:28:28 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 select-file

Select File dialog for McCLIM

Author

John Carroll <>

License

MIT

Version

1.0.0

Dependencies
  • cl-fad (system).
  • mcclim (system).
Source

select-file.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 select-file/select-file.asd

Source

select-file.asd.

Parent Component

select-file (system).

ASDF Systems

select-file.


3.1.2 select-file/sources/package.lisp

Source

select-file.asd.

Parent Component

select-file (system).

Packages

select-file.


3.1.3 select-file/sources/select-file.lisp

Dependency

sources/package.lisp (file).

Source

select-file.asd.

Parent Component

select-file (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 select-file

Source

sources/package.lisp.

Nickname

sf

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: select-file (&rest args &key frame-name title prompt directory dialog-type show-hidden-p ok-label &allow-other-keys)
Package

select-file.

Source

sources/select-file.lisp.


5.1.2 Generic functions

Generic Function: list-devices (frame)

Returns a list of pathnames, each of which is the root of a currently mounted file system - either local or via a network.

Package

select-file.

Source

sources/select-file.lisp.

Methods
Method: list-devices ((frame file-selector))
Generic Function: list-directory (frame dir &optional show-hidden-p)

Returns a list of pathnames, the first being the parent directory of dir (or NIL if dir is the root of a file system) and the rest being the contents of dir. The show-hidden-p argument is passed through from the top-level call, intended to control whether file names starting with a period should be filtered out or not.

Package

select-file.

Source

sources/select-file.lisp.

Methods
Method: list-directory ((frame file-selector) dir &optional show-hidden-p)
Generic Function: list-places (frame)

Returns a list of pathnames, each of which is a regularly-used directory in which the user might want to select files.

Package

select-file.

Source

sources/select-file.lisp.

Methods
Method: list-places ((frame file-selector))

5.1.3 Standalone methods

Method: allocate-space :after ((pane files-dirs-application-pane) width height)
Package

clim.

Source

sources/select-file.lisp.

Method: find-frame-type ((frame file-selector))
Package

clim-extensions.

Source

sources/select-file.lisp.

Method: run-frame-top-level :before ((frame file-selector) &key &allow-other-keys)
Package

clim.

Source

sources/select-file.lisp.

Method: update-instance-for-redefined-class :after ((instance file-selector) as ds pl &rest initargs)
Source

sources/select-file.lisp.


5.1.4 Classes

Class: file-selector
Package

select-file.

Source

sources/select-file.lisp.

Direct superclasses

standard-application-frame.

Direct methods
Direct Default Initargs
InitargValue
:name(quote file-selector)
:pretty-namefile-selector
:command-table(find-command-table (quote file-selector))
:disabled-commands(quote nil)
:menu-bar(quote nil)
:pointer-documentation(quote nil)
:current-layout(quote default)
:layouts(quote ((default (spacing (thickness 15) (vertically (y-spacing 15) (horizontally (x-spacing 10 equalize-height t) (1/4 (outlining (thickness 1 background +outline-gray+) (scrolling (scroll-bar vertical scroll-bars vertical) places-devices-pane))) (3/4 (outlining (thickness 1 background +outline-gray+) (scrolling (scroll-bar vertical scroll-bars vertical) files-dirs-pane)))) (horizontally nil show-hidden-files-check-box fill) (horizontally (x-spacing 10 align-y center equalize-height nil) prompt-pane (outlining (thickness 1 background +outline-gray+) (outlining (thickness 3 background +white+) selection-pane))) (horizontally nil (make-pane (quote grid-pane) contents (list (list (horizontally nil ok-button 5) (horizontally nil 5 cancel-button)))) fill))))))
:resize-frame(quote nil)
:top-level-lambda(lambda (frame-arg0) (default-frame-top-level frame-arg0))
:panes-constructor(lambda (fm frame) (or (frame-panes-for-layout frame) (setf (frame-panes-for-layout frame) (with-look-and-feel-realization (fm frame) (list (cons (quote selection-pane) (coerce-pane-name (make-pane (quote text-field) foreground +black+ background +white+ editable-p (if (member (file-selector-dialog-type *application-frame*) (quote (open directory))) nil t) value (namestring (file-selector-directory *application-frame*)) value-changed-callback (function (lambda (gadget new-value) (declare (ignore gadget)) (with-application-frame (frame) (update-ok-button frame new-value)))) max-width +fill+) (quote selection-pane))) (cons (quote places-devices-pane) (coerce-pane-name (make-pane (quote application-pane) foreground +black+ background +white+ text-cursor nil max-width 150 display-time nil display-function (function display-places-devices)) (quote places-devices-pane))) (cons (quote files-dirs-pane) (coerce-pane-name (make-pane (quote files-dirs-application-pane) foreground +black+ background +white+ text-cursor nil display-time nil display-function (function display-files-dirs)) (quote files-dirs-pane))) (cons (quote prompt-pane) (coerce-pane-name (make-pane (quote label-pane) label (file-selector-prompt *application-frame*) max-width (quote (relative 0))) (quote prompt-pane))) (cons (quote show-hidden-files-check-box) (coerce-pane-name (make-pane (quote toggle-button) label show hidden files indicator-type some-of value (file-selector-show-hidden-p *application-frame*) value-changed-callback (quote show-hidden-files-callback)) (quote show-hidden-files-check-box))) (cons (quote ok-button) (coerce-pane-name (make-pane (quote push-button) label (concatenate (quote string) (file-selector-ok-label *application-frame*) ) align-x center y-spacing 4 show-as-default-p t activate-callback (function ok-callback)) (quote ok-button))) (cons (quote cancel-button) (coerce-pane-name (make-pane (quote push-button) label *cancel-button-string* align-x center y-spacing 4 activate-callback (function close-callback)) (quote cancel-button))))))))
:layout-constructor(lambda (fm frame) (disown-frame-panes fm frame) (let ((named-panes (frame-panes-for-layout frame))) (let ((selection-pane (assoc-value named-panes (quote selection-pane) test (function eq))) (places-devices-pane (assoc-value named-panes (quote places-devices-pane) test (function eq))) (files-dirs-pane (assoc-value named-panes (quote files-dirs-pane) test (function eq))) (prompt-pane (assoc-value named-panes (quote prompt-pane) test (function eq))) (show-hidden-files-check-box (assoc-value named-panes (quote show-hidden-files-check-box) test (function eq))) (ok-button (assoc-value named-panes (quote ok-button) test (function eq))) (cancel-button (assoc-value named-panes (quote cancel-button) test (function eq)))) (setf (frame-panes frame) (ecase (frame-current-layout frame) (default (spacing (thickness 15) (vertically (y-spacing 15) (horizontally (x-spacing 10 equalize-height t) (1/4 (outlining (thickness 1 background +outline-gray+) (scrolling (scroll-bar vertical scroll-bars vertical) places-devices-pane))) (3/4 (outlining (thickness 1 background +outline-gray+) (scrolling (scroll-bar vertical scroll-bars vertical) files-dirs-pane)))) (horizontally nil show-hidden-files-check-box fill) (horizontally (x-spacing 10 align-y center equalize-height nil) prompt-pane (outlining (thickness 1 background +outline-gray+) (outlining (thickness 3 background +white+) selection-pane))) (horizontally nil (make-pane (quote grid-pane) contents (list (list (horizontally nil ok-button 5) (horizontally nil 5 cancel-button)))) fill)))))))) (adopt-frame-panes fm frame (frame-current-layout frame)) (update-frame-pane-lists frame))
:left100
:top100
:width600
:height400
Direct slots
Slot: prompt
Initargs

:prompt

Readers

file-selector-prompt.

Writers

This slot is read-only.

Slot: directory
Package

common-lisp.

Initform

""

Initargs

:directory

Readers

file-selector-directory.

Writers

This slot is read-only.

Slot: dialog-type
Initargs

:dialog-type

Readers

file-selector-dialog-type.

Writers

This slot is read-only.

Slot: show-hidden-p
Initargs

:show-hidden-p

Readers

file-selector-show-hidden-p.

Writers

(setf file-selector-show-hidden-p).

Slot: ok-label
Initargs

:ok-label

Readers

file-selector-ok-label.

Writers

This slot is read-only.

Slot: files-dirs
Readers

file-selector-files-dirs.

Writers

(setf file-selector-files-dirs).

Slot: last-margin
Readers

file-selector-last-margin.

Writers

(setf file-selector-last-margin).

Slot: last-ncolumns
Initform

0

Readers

file-selector-last-ncolumns.

Writers

(setf file-selector-last-ncolumns).

Slot: result
Readers

file-selector-result.

Writers

(setf file-selector-result).


5.2 Internals


5.2.1 Special variables

Special Variable: *cancel-button-string*
Package

select-file.

Source

sources/select-file.lisp.

Special Variable: +device-icon+
Package

select-file.

Source

sources/select-file.lisp.

Special Variable: +document-icon+
Package

select-file.

Source

sources/select-file.lisp.

Special Variable: +folder-icon+
Package

select-file.

Source

sources/select-file.lisp.

Special Variable: +outline-gray+
Package

select-file.

Source

sources/select-file.lisp.

Special Variable: +text-gray+
Package

select-file.

Source

sources/select-file.lisp.

Special Variable: +up-folder-icon+
Package

select-file.

Source

sources/select-file.lisp.


5.2.2 Macros

Macro: define-file-selector-command (name-and-options arguments &rest body)
Package

select-file.

Source

sources/select-file.lisp.


5.2.3 Ordinary functions

Function: close-callback (button)
Package

select-file.

Source

sources/select-file.lisp.

Function: com-resize-panes (frame)
Package

select-file.

Source

sources/select-file.lisp.

Function: com-resize-panes%parser (argument-parser0 delimiter-parser1 stream2)
Package

select-file.

Source

sources/select-file.lisp.

Function: com-select-file-dir (data)
Package

select-file.

Source

sources/select-file.lisp.

Function: com-select-file-dir%parser (argument-parser0 delimiter-parser1 stream2)
Package

select-file.

Source

sources/select-file.lisp.

Function: com-select-place-device-namestring (data)
Package

select-file.

Source

sources/select-file.lisp.

Function: com-select-place-device-namestring%parser (argument-parser0 delimiter-parser1 stream2)
Package

select-file.

Source

sources/select-file.lisp.

Function: display-files-dirs (frame stream &optional lazyp)
Package

select-file.

Source

sources/select-file.lisp.

Function: display-fs-items (items stream presentation-type ncolumns &optional col-width)
Package

select-file.

Source

sources/select-file.lisp.

Function: display-places-devices (frame stream)
Package

select-file.

Source

sources/select-file.lisp.

Function: draw-heading (stream text)
Package

select-file.

Source

sources/select-file.lisp.

Function: draw-namestring (stream pattern text)
Package

select-file.

Source

sources/select-file.lisp.

Function: ensure-valid-directory (x)
Package

select-file.

Source

sources/select-file.lisp.

Function: file-dir-namestring (x &optional homedir-tilde-p)
Package

select-file.

Source

sources/select-file.lisp.

Function: ok-callback (button)
Package

select-file.

Source

sources/select-file.lisp.

Function: pathname-directory-pathname (p)
Package

select-file.

Source

sources/select-file.lisp.

Function: pathname-parent-directory (p)
Package

select-file.

Source

sources/select-file.lisp.

Function: pathname-root-p (p)
Package

select-file.

Source

sources/select-file.lisp.

Function: place-device-namestring (x)
Package

select-file.

Source

sources/select-file.lisp.

Function: select-file-dir (data &optional relist-if-file-p)
Package

select-file.

Source

sources/select-file.lisp.

Function: show-hidden-files-callback (checkbox value)
Package

select-file.

Source

sources/select-file.lisp.

Function: update-ok-button (frame new-value)
Package

select-file.

Source

sources/select-file.lisp.


5.2.4 Generic functions

Generic Reader: file-selector-dialog-type (object)
Package

select-file.

Methods
Reader Method: file-selector-dialog-type ((file-selector file-selector))

automatically generated reader method

Source

sources/select-file.lisp.

Target Slot

dialog-type.

Generic Reader: file-selector-directory (object)
Package

select-file.

Methods
Reader Method: file-selector-directory ((file-selector file-selector))

automatically generated reader method

Source

sources/select-file.lisp.

Target Slot

directory.

Generic Reader: file-selector-files-dirs (object)
Package

select-file.

Methods
Reader Method: file-selector-files-dirs ((file-selector file-selector))

automatically generated reader method

Source

sources/select-file.lisp.

Target Slot

files-dirs.

Generic Writer: (setf file-selector-files-dirs) (object)
Package

select-file.

Methods
Writer Method: (setf file-selector-files-dirs) ((file-selector file-selector))

automatically generated writer method

Source

sources/select-file.lisp.

Target Slot

files-dirs.

Generic Reader: file-selector-last-margin (object)
Package

select-file.

Methods
Reader Method: file-selector-last-margin ((file-selector file-selector))

automatically generated reader method

Source

sources/select-file.lisp.

Target Slot

last-margin.

Generic Writer: (setf file-selector-last-margin) (object)
Package

select-file.

Methods
Writer Method: (setf file-selector-last-margin) ((file-selector file-selector))

automatically generated writer method

Source

sources/select-file.lisp.

Target Slot

last-margin.

Generic Reader: file-selector-last-ncolumns (object)
Package

select-file.

Methods
Reader Method: file-selector-last-ncolumns ((file-selector file-selector))

automatically generated reader method

Source

sources/select-file.lisp.

Target Slot

last-ncolumns.

Generic Writer: (setf file-selector-last-ncolumns) (object)
Package

select-file.

Methods
Writer Method: (setf file-selector-last-ncolumns) ((file-selector file-selector))

automatically generated writer method

Source

sources/select-file.lisp.

Target Slot

last-ncolumns.

Generic Reader: file-selector-ok-label (object)
Package

select-file.

Methods
Reader Method: file-selector-ok-label ((file-selector file-selector))

automatically generated reader method

Source

sources/select-file.lisp.

Target Slot

ok-label.

Generic Reader: file-selector-prompt (object)
Package

select-file.

Methods
Reader Method: file-selector-prompt ((file-selector file-selector))

automatically generated reader method

Source

sources/select-file.lisp.

Target Slot

prompt.

Generic Reader: file-selector-result (object)
Package

select-file.

Methods
Reader Method: file-selector-result ((file-selector file-selector))

automatically generated reader method

Source

sources/select-file.lisp.

Target Slot

result.

Generic Writer: (setf file-selector-result) (object)
Package

select-file.

Methods
Writer Method: (setf file-selector-result) ((file-selector file-selector))

automatically generated writer method

Source

sources/select-file.lisp.

Target Slot

result.

Generic Reader: file-selector-show-hidden-p (object)
Package

select-file.

Methods
Reader Method: file-selector-show-hidden-p ((file-selector file-selector))

automatically generated reader method

Source

sources/select-file.lisp.

Target Slot

show-hidden-p.

Generic Writer: (setf file-selector-show-hidden-p) (object)
Package

select-file.

Methods
Writer Method: (setf file-selector-show-hidden-p) ((file-selector file-selector))

automatically generated writer method

Source

sources/select-file.lisp.

Target Slot

show-hidden-p.


5.2.5 Standalone methods

Method: reinitialize-panes-and-layouts ((frame file-selector))
Package

clim-internals.

Source

sources/select-file.lisp.


5.2.6 Classes

Class: files-dirs-application-pane
Package

select-file.

Source

sources/select-file.lisp.

Direct superclasses

application-pane.

Direct methods

allocate-space.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   L   M   O   P   R   S   U  
Index Entry  Section

(
(setf file-selector-files-dirs): Private generic functions
(setf file-selector-files-dirs): Private generic functions
(setf file-selector-last-margin): Private generic functions
(setf file-selector-last-margin): Private generic functions
(setf file-selector-last-ncolumns): Private generic functions
(setf file-selector-last-ncolumns): Private generic functions
(setf file-selector-result): Private generic functions
(setf file-selector-result): Private generic functions
(setf file-selector-show-hidden-p): Private generic functions
(setf file-selector-show-hidden-p): Private generic functions

A
allocate-space: Public standalone methods

C
close-callback: Private ordinary functions
com-resize-panes: Private ordinary functions
com-resize-panes%parser: Private ordinary functions
com-select-file-dir: Private ordinary functions
com-select-file-dir%parser: Private ordinary functions
com-select-place-device-namestring: Private ordinary functions
com-select-place-device-namestring%parser: Private ordinary functions

D
define-file-selector-command: Private macros
display-files-dirs: Private ordinary functions
display-fs-items: Private ordinary functions
display-places-devices: Private ordinary functions
draw-heading: Private ordinary functions
draw-namestring: Private ordinary functions

E
ensure-valid-directory: Private ordinary functions

F
file-dir-namestring: Private ordinary functions
file-selector-dialog-type: Private generic functions
file-selector-dialog-type: Private generic functions
file-selector-directory: Private generic functions
file-selector-directory: Private generic functions
file-selector-files-dirs: Private generic functions
file-selector-files-dirs: Private generic functions
file-selector-last-margin: Private generic functions
file-selector-last-margin: Private generic functions
file-selector-last-ncolumns: Private generic functions
file-selector-last-ncolumns: Private generic functions
file-selector-ok-label: Private generic functions
file-selector-ok-label: Private generic functions
file-selector-prompt: Private generic functions
file-selector-prompt: Private generic functions
file-selector-result: Private generic functions
file-selector-result: Private generic functions
file-selector-show-hidden-p: Private generic functions
file-selector-show-hidden-p: Private generic functions
find-frame-type: Public standalone methods
Function, close-callback: Private ordinary functions
Function, com-resize-panes: Private ordinary functions
Function, com-resize-panes%parser: Private ordinary functions
Function, com-select-file-dir: Private ordinary functions
Function, com-select-file-dir%parser: Private ordinary functions
Function, com-select-place-device-namestring: Private ordinary functions
Function, com-select-place-device-namestring%parser: Private ordinary functions
Function, display-files-dirs: Private ordinary functions
Function, display-fs-items: Private ordinary functions
Function, display-places-devices: Private ordinary functions
Function, draw-heading: Private ordinary functions
Function, draw-namestring: Private ordinary functions
Function, ensure-valid-directory: Private ordinary functions
Function, file-dir-namestring: Private ordinary functions
Function, ok-callback: Private ordinary functions
Function, pathname-directory-pathname: Private ordinary functions
Function, pathname-parent-directory: Private ordinary functions
Function, pathname-root-p: Private ordinary functions
Function, place-device-namestring: Private ordinary functions
Function, select-file: Public ordinary functions
Function, select-file-dir: Private ordinary functions
Function, show-hidden-files-callback: Private ordinary functions
Function, update-ok-button: Private ordinary functions

G
Generic Function, (setf file-selector-files-dirs): Private generic functions
Generic Function, (setf file-selector-last-margin): Private generic functions
Generic Function, (setf file-selector-last-ncolumns): Private generic functions
Generic Function, (setf file-selector-result): Private generic functions
Generic Function, (setf file-selector-show-hidden-p): Private generic functions
Generic Function, file-selector-dialog-type: Private generic functions
Generic Function, file-selector-directory: Private generic functions
Generic Function, file-selector-files-dirs: Private generic functions
Generic Function, file-selector-last-margin: Private generic functions
Generic Function, file-selector-last-ncolumns: Private generic functions
Generic Function, file-selector-ok-label: Private generic functions
Generic Function, file-selector-prompt: Private generic functions
Generic Function, file-selector-result: Private generic functions
Generic Function, file-selector-show-hidden-p: Private generic functions
Generic Function, list-devices: Public generic functions
Generic Function, list-directory: Public generic functions
Generic Function, list-places: Public generic functions

L
list-devices: Public generic functions
list-devices: Public generic functions
list-directory: Public generic functions
list-directory: Public generic functions
list-places: Public generic functions
list-places: Public generic functions

M
Macro, define-file-selector-command: Private macros
Method, (setf file-selector-files-dirs): Private generic functions
Method, (setf file-selector-last-margin): Private generic functions
Method, (setf file-selector-last-ncolumns): Private generic functions
Method, (setf file-selector-result): Private generic functions
Method, (setf file-selector-show-hidden-p): Private generic functions
Method, allocate-space: Public standalone methods
Method, file-selector-dialog-type: Private generic functions
Method, file-selector-directory: Private generic functions
Method, file-selector-files-dirs: Private generic functions
Method, file-selector-last-margin: Private generic functions
Method, file-selector-last-ncolumns: Private generic functions
Method, file-selector-ok-label: Private generic functions
Method, file-selector-prompt: Private generic functions
Method, file-selector-result: Private generic functions
Method, file-selector-show-hidden-p: Private generic functions
Method, find-frame-type: Public standalone methods
Method, list-devices: Public generic functions
Method, list-directory: Public generic functions
Method, list-places: Public generic functions
Method, reinitialize-panes-and-layouts: Private standalone methods
Method, run-frame-top-level: Public standalone methods
Method, update-instance-for-redefined-class: Public standalone methods

O
ok-callback: Private ordinary functions

P
pathname-directory-pathname: Private ordinary functions
pathname-parent-directory: Private ordinary functions
pathname-root-p: Private ordinary functions
place-device-namestring: Private ordinary functions

R
reinitialize-panes-and-layouts: Private standalone methods
run-frame-top-level: Public standalone methods

S
select-file: Public ordinary functions
select-file-dir: Private ordinary functions
show-hidden-files-callback: Private ordinary functions

U
update-instance-for-redefined-class: Public standalone methods
update-ok-button: Private ordinary functions


A.3 Variables