The trivial-clipboard Reference Manual

This is the trivial-clipboard Reference Manual, version 0.0.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:09:41 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-clipboard

trivial-clipboard let access system clipboard.

Author

SANO Masatoshi

License

MIT

Version

0.0.0.0

Dependency

uiop (system).

Source

trivial-clipboard.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 trivial-clipboard/src

Source

trivial-clipboard.asd.

Parent Component

trivial-clipboard (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 trivial-clipboard/trivial-clipboard.asd

Source

trivial-clipboard.asd.

Parent Component

trivial-clipboard (system).

ASDF Systems

trivial-clipboard.


4.1.2 trivial-clipboard/src/package.lisp

Source

trivial-clipboard.asd.

Parent Component

src (module).

Packages

trivial-clipboard.


4.1.3 trivial-clipboard/src/conditions.lisp

Source

trivial-clipboard.asd.

Parent Component

src (module).

Internals

4.1.4 trivial-clipboard/src/text.lisp

Source

trivial-clipboard.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 trivial-clipboard

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Ordinary functions

Function: text (&optional data)

If DATA is STRING, it is set to the clipboard. An ERROR is signalled if the copy failed.

If DATA is NIL, TEXT returns the STRING from the clipboard. If the copy failed, it returns NIL instead.

Package

trivial-clipboard.

Source

text.lisp.


6.1.2 Generic functions

Generic Function: content (&key &allow-other-keys)

A generic function to get the contents of the clipboard.

Returns strings by default.

:around methods and primary method re-definitions can override return value to some structured data.

Package

trivial-clipboard.

Source

text.lisp.

Methods
Method: content (&key &allow-other-keys)
Generic Function: (setf content) (&key &allow-other-keys)

A generic function to set the contents of the clipboard to NEW-VALUE.

Default method only specializes on string, but callers can define more
methods specializing on specific data types to put into clipboard.

Example: support numbers, converting them to strings

(defmethod (setf trivial-clipboard:content) ((value number) &key &allow-other-keys) (setf (trivial-clipboard:content) (princ-to-string value)))

Package

trivial-clipboard.

Source

text.lisp.

Methods
Method: (setf content) (&key &allow-other-keys)

6.2 Internals


6.2.1 Special variables

Special Variable: *clipboard-commands*

A list, each element being of the form (clipboard-method predicate copy-command paste-command).

Package

trivial-clipboard.

Source

text.lisp.


6.2.2 Ordinary functions

Function: clipboard-programs (fn)
Package

trivial-clipboard.

Source

text.lisp.

Function: copy (text)
Package

trivial-clipboard.

Source

text.lisp.

Function: executable-find (command)

Search for COMMAND in the PATH and return the absolute file name. Return nil if COMMAND is not found anywhere.

Package

trivial-clipboard.

Source

text.lisp.

Function: find-command (fn)
Package

trivial-clipboard.

Source

text.lisp.

Function: find-copy-command ()
Package

trivial-clipboard.

Source

text.lisp.

Function: find-paste-command ()
Package

trivial-clipboard.

Source

text.lisp.

Function: get-copy-command (elt)
Package

trivial-clipboard.

Source

text.lisp.

Function: get-paste-command (elt)
Package

trivial-clipboard.

Source

text.lisp.

Function: paste ()
Package

trivial-clipboard.

Source

text.lisp.

Function: wayland-session-p ()
Package

trivial-clipboard.

Source

text.lisp.

Function: x-session-p ()
Package

trivial-clipboard.

Source

text.lisp.


6.2.3 Generic functions

Generic Reader: not-installed-programs (condition)
Package

trivial-clipboard.

Methods
Reader Method: not-installed-programs ((condition not-installed))
Source

conditions.lisp.

Target Slot

programs.


6.2.4 Conditions

Condition: not-installed
Package

trivial-clipboard.

Source

conditions.lisp.

Direct superclasses

trivial-clipboard-error.

Direct methods

not-installed-programs.

Direct slots
Slot: programs
Initargs

:programs

Readers

not-installed-programs.

Writers

This slot is read-only.

Condition: trivial-clipboard-error
Package

trivial-clipboard.

Source

conditions.lisp.

Direct superclasses

simple-error.

Direct subclasses

not-installed.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   E   F   G   M   N   P   T   W   X  
Index Entry  Section

(
(setf content): Public generic functions
(setf content): Public generic functions

C
clipboard-programs: Private ordinary functions
content: Public generic functions
content: Public generic functions
copy: Private ordinary functions

E
executable-find: Private ordinary functions

F
find-command: Private ordinary functions
find-copy-command: Private ordinary functions
find-paste-command: Private ordinary functions
Function, clipboard-programs: Private ordinary functions
Function, copy: Private ordinary functions
Function, executable-find: Private ordinary functions
Function, find-command: Private ordinary functions
Function, find-copy-command: Private ordinary functions
Function, find-paste-command: Private ordinary functions
Function, get-copy-command: Private ordinary functions
Function, get-paste-command: Private ordinary functions
Function, paste: Private ordinary functions
Function, text: Public ordinary functions
Function, wayland-session-p: Private ordinary functions
Function, x-session-p: Private ordinary functions

G
Generic Function, (setf content): Public generic functions
Generic Function, content: Public generic functions
Generic Function, not-installed-programs: Private generic functions
get-copy-command: Private ordinary functions
get-paste-command: Private ordinary functions

M
Method, (setf content): Public generic functions
Method, content: Public generic functions
Method, not-installed-programs: Private generic functions

N
not-installed-programs: Private generic functions
not-installed-programs: Private generic functions

P
paste: Private ordinary functions

T
text: Public ordinary functions

W
wayland-session-p: Private ordinary functions

X
x-session-p: Private ordinary functions