The cl-xkb Reference Manual

Table of Contents

The cl-xkb Reference Manual

This is the cl-xkb Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:29:52 2021 GMT+0.

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)

2 Systems

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

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

• package.lisp (file)
• cl-xkb.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-xkb.asd

Location

cl-xkb.asd

Systems

cl-xkb (system)

3.1.2 cl-xkb/package.lisp

Parent

cl-xkb (system)

Location

package.lisp

Packages

xkb

3.1.3 cl-xkb/cl-xkb.lisp

Dependency

package.lisp (file)

Parent

cl-xkb (system)

Location

cl-xkb.lisp

Exported Definitions

• get-keysym-character (function)
• get-keysym-from-name (function)
• get-keysym-name (function)
• new-keymap-from-names (function)
• tolower (function)
• toupper (function)
• xkb-context-new (function)
• xkb-keymap-get-as-string (function)
• xkb-keymap-key-by-name (function)
• xkb-keymap-max-keycode (function)
• xkb-keymap-min-keycode (function)
• xkb-keymap-new-from-names (function)
• xkb-state-key-get-one-sym (function)
• xkb-state-mod-name-is-active (function)
• xkb-state-new (function)
• xkb-state-serialize-layout (function)
• xkb-state-serialize-mods (function)
• xkb-state-unref (function)
• xkb-state-update-key (function)

Internal Definitions

• xkb-keysym-from-name (function)
• xkb-keysym-get-name (function)
• xkb-keysym-to-utf8 (function)
• xkb-rule-names-tclass (class)

4 Packages

Packages are listed by definition order.

4.1 xkb

Source

package.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• get-keysym-character (function)
• get-keysym-from-name (function)
• get-keysym-name (function)
• new-keymap-from-names (function)
• tolower (function)
• toupper (function)
• xkb-context-new (function)
• xkb-keymap-get-as-string (function)
• xkb-keymap-key-by-name (function)
• xkb-keymap-max-keycode (function)
• xkb-keymap-min-keycode (function)
• xkb-keymap-new-from-names (function)
• xkb-state-key-get-one-sym (function)
• xkb-state-mod-name-is-active (function)
• xkb-state-new (function)
• xkb-state-serialize-layout (function)
• xkb-state-serialize-mods (function)
• xkb-state-unref (function)
• xkb-state-update-key (function)

Internal Definitions

• xkb-keysym-from-name (function)
• xkb-keysym-get-name (function)
• xkb-keysym-to-utf8 (function)
• xkb-rule-names-tclass (class)

5 Definitions

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

5.1 Exported definitions

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)

5.2 Internal definitions

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)

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)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types