The cl-libinput Reference Manual

This is the cl-libinput Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 05:08:41 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-libinput

Common Lisp wrapper for libinput

Author

Malcolm Still <>

License

BSD 3-Clause

Dependencies
  • cffi (system).
  • osicat (system).
Source

cl-libinput.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 cl-libinput/cl-libinput.asd

Source

cl-libinput.asd.

Parent Component

cl-libinput (system).

ASDF Systems

cl-libinput.


3.1.2 cl-libinput/package.lisp

Source

cl-libinput.asd.

Parent Component

cl-libinput (system).

Packages

libinput.


3.1.3 cl-libinput/cl-libinput.lisp

Dependency

package.lisp (file).

Source

cl-libinput.asd.

Parent Component

cl-libinput (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 libinput

Source

package.lisp.

Use List
  • cffi.
  • 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 Special variables

Special Variable: device-added
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: device-cap-gesture
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: device-cap-keyboard
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: device-cap-pointer
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: device-cap-tablet-pad
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: device-cap-tablet-tool
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: device-cap-touch
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: device-removed
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: gesture-pinch-begin
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: gesture-pinch-end
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: gesture-pinch-update
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: gesture-swipe-begin
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: gesture-swipe-end
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: gesture-swipe-update
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: keyboard-key
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: none
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: pointer-axis
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: pointer-button
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: pointer-motion
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: pointer-motion-absolute
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: tablet-pad-ring
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: tablet-pad-strip
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: tablet-tool-axis
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: tablet-tool-button
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: tablet-tool-proximity
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: tablet-tool-tip
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: touch-cancel
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: touch-down
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: touch-frame
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: touch-motion
Package

libinput.

Source

cl-libinput.lisp.

Special Variable: touch-up
Package

libinput.

Source

cl-libinput.lisp.


5.1.2 Macros

Macro: with-keyboard-key ((event time key state) &body body)
Package

libinput.

Source

cl-libinput.lisp.

Macro: with-pointer-button ((event time button state) &body body)
Package

libinput.

Source

cl-libinput.lisp.

Macro: with-pointer-motion ((event time dx dy) &body body)
Package

libinput.

Source

cl-libinput.lisp.


5.1.3 Ordinary functions

Function: device-has-capability (device capability)
Package

libinput.

Source

cl-libinput.lisp.

Function: device-ref (device)
Package

libinput.

Source

cl-libinput.lisp.

Function: device-unref (device)
Package

libinput.

Source

cl-libinput.lisp.

Function: dispatch (context)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-destroy (event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-get-keyboard-event (event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-get-pointer-event (event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-get-type (event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-keyboard-get-key (keyboard-event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-keyboard-get-key-state (keyboard-event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-keyboard-get-time (keyboard-event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-pointer-get-button (pointer-event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-pointer-get-button-state (pointer-event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-pointer-get-dx (pointer-event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-pointer-get-dy (pointer-event)
Package

libinput.

Source

cl-libinput.lisp.

Function: event-pointer-get-time (pointer-event)
Package

libinput.

Source

cl-libinput.lisp.

Function: get-event (context)
Package

libinput.

Source

cl-libinput.lisp.

Function: get-fd (context)
Package

libinput.

Source

cl-libinput.lisp.

Function: make-libinput-interface ()
Package

libinput.

Source

cl-libinput.lisp.

Function: path-add-device (context path)
Package

libinput.

Source

cl-libinput.lisp.

Function: path-create-context (interface user-date)
Package

libinput.

Source

cl-libinput.lisp.

Function: path-remove-device (device)
Package

libinput.

Source

cl-libinput.lisp.

Function: unref (context)
Package

libinput.

Source

cl-libinput.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: tablet-pad-button
Package

libinput.

Source

cl-libinput.lisp.


5.2.2 Classes

Class: libinput-interface-tclass
Package

libinput.

Source

cl-libinput.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   D   E   F   G   M   P   U   W  
Index Entry  Section

D
device-has-capability: Public ordinary functions
device-ref: Public ordinary functions
device-unref: Public ordinary functions
dispatch: Public ordinary functions

E
event-destroy: Public ordinary functions
event-get-keyboard-event: Public ordinary functions
event-get-pointer-event: Public ordinary functions
event-get-type: Public ordinary functions
event-keyboard-get-key: Public ordinary functions
event-keyboard-get-key-state: Public ordinary functions
event-keyboard-get-time: Public ordinary functions
event-pointer-get-button: Public ordinary functions
event-pointer-get-button-state: Public ordinary functions
event-pointer-get-dx: Public ordinary functions
event-pointer-get-dy: Public ordinary functions
event-pointer-get-time: Public ordinary functions

F
Function, device-has-capability: Public ordinary functions
Function, device-ref: Public ordinary functions
Function, device-unref: Public ordinary functions
Function, dispatch: Public ordinary functions
Function, event-destroy: Public ordinary functions
Function, event-get-keyboard-event: Public ordinary functions
Function, event-get-pointer-event: Public ordinary functions
Function, event-get-type: Public ordinary functions
Function, event-keyboard-get-key: Public ordinary functions
Function, event-keyboard-get-key-state: Public ordinary functions
Function, event-keyboard-get-time: Public ordinary functions
Function, event-pointer-get-button: Public ordinary functions
Function, event-pointer-get-button-state: Public ordinary functions
Function, event-pointer-get-dx: Public ordinary functions
Function, event-pointer-get-dy: Public ordinary functions
Function, event-pointer-get-time: Public ordinary functions
Function, get-event: Public ordinary functions
Function, get-fd: Public ordinary functions
Function, make-libinput-interface: Public ordinary functions
Function, path-add-device: Public ordinary functions
Function, path-create-context: Public ordinary functions
Function, path-remove-device: Public ordinary functions
Function, unref: Public ordinary functions

G
get-event: Public ordinary functions
get-fd: Public ordinary functions

M
Macro, with-keyboard-key: Public macros
Macro, with-pointer-button: Public macros
Macro, with-pointer-motion: Public macros
make-libinput-interface: Public ordinary functions

P
path-add-device: Public ordinary functions
path-create-context: Public ordinary functions
path-remove-device: Public ordinary functions

U
unref: Public ordinary functions

W
with-keyboard-key: Public macros
with-pointer-button: Public macros
with-pointer-motion: Public macros


A.3 Variables

Jump to:   D   G   K   N   P   S   T  
Index Entry  Section

D
device-added: Public special variables
device-cap-gesture: Public special variables
device-cap-keyboard: Public special variables
device-cap-pointer: Public special variables
device-cap-tablet-pad: Public special variables
device-cap-tablet-tool: Public special variables
device-cap-touch: Public special variables
device-removed: Public special variables

G
gesture-pinch-begin: Public special variables
gesture-pinch-end: Public special variables
gesture-pinch-update: Public special variables
gesture-swipe-begin: Public special variables
gesture-swipe-end: Public special variables
gesture-swipe-update: Public special variables

K
keyboard-key: Public special variables

N
none: Public special variables

P
pointer-axis: Public special variables
pointer-button: Public special variables
pointer-motion: Public special variables
pointer-motion-absolute: Public special variables

S
Special Variable, device-added: Public special variables
Special Variable, device-cap-gesture: Public special variables
Special Variable, device-cap-keyboard: Public special variables
Special Variable, device-cap-pointer: Public special variables
Special Variable, device-cap-tablet-pad: Public special variables
Special Variable, device-cap-tablet-tool: Public special variables
Special Variable, device-cap-touch: Public special variables
Special Variable, device-removed: Public special variables
Special Variable, gesture-pinch-begin: Public special variables
Special Variable, gesture-pinch-end: Public special variables
Special Variable, gesture-pinch-update: Public special variables
Special Variable, gesture-swipe-begin: Public special variables
Special Variable, gesture-swipe-end: Public special variables
Special Variable, gesture-swipe-update: Public special variables
Special Variable, keyboard-key: Public special variables
Special Variable, none: Public special variables
Special Variable, pointer-axis: Public special variables
Special Variable, pointer-button: Public special variables
Special Variable, pointer-motion: Public special variables
Special Variable, pointer-motion-absolute: Public special variables
Special Variable, tablet-pad-button: Private special variables
Special Variable, tablet-pad-ring: Public special variables
Special Variable, tablet-pad-strip: Public special variables
Special Variable, tablet-tool-axis: Public special variables
Special Variable, tablet-tool-button: Public special variables
Special Variable, tablet-tool-proximity: Public special variables
Special Variable, tablet-tool-tip: Public special variables
Special Variable, touch-cancel: Public special variables
Special Variable, touch-down: Public special variables
Special Variable, touch-frame: Public special variables
Special Variable, touch-motion: Public special variables
Special Variable, touch-up: Public special variables

T
tablet-pad-button: Private special variables
tablet-pad-ring: Public special variables
tablet-pad-strip: Public special variables
tablet-tool-axis: Public special variables
tablet-tool-button: Public special variables
tablet-tool-proximity: Public special variables
tablet-tool-tip: Public special variables
touch-cancel: Public special variables
touch-down: Public special variables
touch-frame: Public special variables
touch-motion: Public special variables
touch-up: Public special variables