The cl-xkb Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-xkb Reference Manual

This is the cl-xkb Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:37:09 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-xkb

cl-xkb is a Common Lisp wrapper for libxkbcommon. libxkbcommon is library for handling keyboard descriptions and their state.

Status

cl-xkb is being developed primarily in support of ulubis and is therefor feature incomplete. Pull requests adding more of the API are more than welcome.

Requiremnts

cl-xkb requires libxkbcommon and cffi. It is likely that libxkbcommon already exists on your Linux installation if it is recent.

Installation

CL-USER> (ql:quickload :cl-xkb)

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 cl-xkb

Author

Malcolm Still

License

BSD 3-Clause

Description

Common Lisp wrapper for libxkb

Dependency

cffi

Source

cl-xkb.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-xkb.asd

Location

cl-xkb.asd

Systems

cl-xkb (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-xkb/package.lisp

Parent

cl-xkb (system)

Location

package.lisp

Packages

xkb


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-xkb/cl-xkb.lisp

Dependency

package.lisp (file)

Parent

cl-xkb (system)

Location

cl-xkb.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 xkb

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: get-keysym-character KEYSYM
Package

xkb

Source

cl-xkb.lisp (file)

Function: get-keysym-from-name NAME &key CASE-INSENSITIVE
Package

xkb

Source

cl-xkb.lisp (file)

Function: get-keysym-name KEYSYM
Package

xkb

Source

cl-xkb.lisp (file)

Function: new-keymap-from-names CTX RULES MODEL LAYOUT VARIANT OPTIONS
Package

xkb

Source

cl-xkb.lisp (file)

Function: tolower C
Package

xkb

Source

cl-xkb.lisp (file)

Function: toupper C
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-context-new FLAGS
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-keymap-get-as-string KEYMAP FORMAT
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-keymap-key-by-name KEYMAP NAME
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-keymap-max-keycode KEYMAP
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-keymap-min-keycode KEYMAP
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-keymap-new-from-names CONTEXT NAMES FLAGS
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-state-key-get-one-sym STATE KEYCODE
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-state-mod-name-is-active STATE MODIFIER TYPE
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-state-new KEYMAP
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-state-serialize-layout STATE COMPONENTS
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-state-serialize-mods STATE COMPONENTS
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-state-unref STATE
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-state-update-key STATE KEY DIRECTION
Package

xkb

Source

cl-xkb.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: xkb-keysym-from-name NAME FLAGS
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-keysym-get-name KEYSYM BUFFER SIZE
Package

xkb

Source

cl-xkb.lisp (file)

Function: xkb-keysym-to-utf8 KEYSYM BUFFER SIZE
Package

xkb

Source

cl-xkb.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Classes

Class: xkb-rule-names-tclass ()
Package

xkb

Source

cl-xkb.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-xkb.asd: The cl-xkb<dot>asd file
cl-xkb/cl-xkb.lisp: The cl-xkb/cl-xkb<dot>lisp file
cl-xkb/package.lisp: The cl-xkb/package<dot>lisp file

F
File, Lisp, cl-xkb.asd: The cl-xkb<dot>asd file
File, Lisp, cl-xkb/cl-xkb.lisp: The cl-xkb/cl-xkb<dot>lisp file
File, Lisp, cl-xkb/package.lisp: The cl-xkb/package<dot>lisp file

L
Lisp File, cl-xkb.asd: The cl-xkb<dot>asd file
Lisp File, cl-xkb/cl-xkb.lisp: The cl-xkb/cl-xkb<dot>lisp file
Lisp File, cl-xkb/package.lisp: The cl-xkb/package<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   F   G   N   T   X  
Index Entry  Section

F
Function, get-keysym-character: Exported functions
Function, get-keysym-from-name: Exported functions
Function, get-keysym-name: Exported functions
Function, new-keymap-from-names: Exported functions
Function, tolower: Exported functions
Function, toupper: Exported functions
Function, xkb-context-new: Exported functions
Function, xkb-keymap-get-as-string: Exported functions
Function, xkb-keymap-key-by-name: Exported functions
Function, xkb-keymap-max-keycode: Exported functions
Function, xkb-keymap-min-keycode: Exported functions
Function, xkb-keymap-new-from-names: Exported functions
Function, xkb-keysym-from-name: Internal functions
Function, xkb-keysym-get-name: Internal functions
Function, xkb-keysym-to-utf8: Internal functions
Function, xkb-state-key-get-one-sym: Exported functions
Function, xkb-state-mod-name-is-active: Exported functions
Function, xkb-state-new: Exported functions
Function, xkb-state-serialize-layout: Exported functions
Function, xkb-state-serialize-mods: Exported functions
Function, xkb-state-unref: Exported functions
Function, xkb-state-update-key: Exported functions

G
get-keysym-character: Exported functions
get-keysym-from-name: Exported functions
get-keysym-name: Exported functions

N
new-keymap-from-names: Exported functions

T
tolower: Exported functions
toupper: Exported functions

X
xkb-context-new: Exported functions
xkb-keymap-get-as-string: Exported functions
xkb-keymap-key-by-name: Exported functions
xkb-keymap-max-keycode: Exported functions
xkb-keymap-min-keycode: Exported functions
xkb-keymap-new-from-names: Exported functions
xkb-keysym-from-name: Internal functions
xkb-keysym-get-name: Internal functions
xkb-keysym-to-utf8: Internal functions
xkb-state-key-get-one-sym: Exported functions
xkb-state-mod-name-is-active: Exported functions
xkb-state-new: Exported functions
xkb-state-serialize-layout: Exported functions
xkb-state-serialize-mods: Exported functions
xkb-state-unref: Exported functions
xkb-state-update-key: Exported functions

Jump to:   F   G   N   T   X  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S   X  
Index Entry  Section

C
cl-xkb: The cl-xkb system
Class, xkb-rule-names-tclass: Internal classes

P
Package, xkb: The xkb package

S
System, cl-xkb: The cl-xkb system

X
xkb: The xkb package
xkb-rule-names-tclass: Internal classes

Jump to:   C   P   S   X