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

The cl-xkb Reference Manual

This is the cl-xkb Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 04:32:30 2025 GMT+0.

Next: Systems, Previous: The cl-xkb Reference Manual, Up: The cl-xkb Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-xkb Reference Manual [Contents][Index]

2 Systems

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

cl-xkb

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

2.1 `cl-xkb`

Common Lisp wrapper for libxkb

Author

Malcolm Still

Home Page

https://github.com/malcolmstill/cl-xkb

Source Control

(GIT https://github.com/malcolmstill/cl-xkb.git)

Bug Tracker

https://github.com/malcolmstill/cl-xkb/issues

License

BSD 3-Clause

Dependency

cffi (system).

Source

cl-xkb.asd.

Child Components

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

Next: Packages, Previous: Systems, Up: The cl-xkb Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: cl-xkb/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-xkb/cl-xkb.asd`

Source: cl-xkb.asd.
Parent Component: cl-xkb (system).
ASDF Systems: cl-xkb.

Next: cl-xkb/cl-xkb.lisp, Previous: cl-xkb/cl-xkb.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-xkb/package.lisp`

Source: cl-xkb.asd.
Parent Component: cl-xkb (system).
Packages: xkb.

Previous: cl-xkb/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `cl-xkb/cl-xkb.lisp`

Dependency

package.lisp (file).

Source

cl-xkb.asd.

Parent Component

cl-xkb (system).

Public Interface

+xkb-keycode-invalid+ (constant).
+xkb-keycode-max+ (constant).
+xkb-keymap-use-original-format+ (constant).
+xkb-layout-invalid+ (constant).
+xkb-led-invalid+ (constant).
+xkb-level-invalid+ (constant).
+xkb-mod-invalid+ (constant).
new-keymap-from-names (function).
tolower (function).
toupper (function).
xkb-compose-state-feed (function).
xkb-compose-state-get-compose-table (function).
xkb-compose-state-get-one-sym (function).
xkb-compose-state-get-status (function).
xkb-compose-state-get-utf8 (function).
xkb-compose-state-new (function).
xkb-compose-state-ref (function).
xkb-compose-state-reset (function).
xkb-compose-state-unref (function).
xkb-compose-table-new-from-buffer (function).
xkb-compose-table-new-from-file (function).
xkb-compose-table-new-from-locale (function).
xkb-compose-table-ref (function).
xkb-compose-table-unref (function).
xkb-context-get-log-level (function).
xkb-context-get-log-verbosity (function).
xkb-context-get-user-data (function).
xkb-context-include-path-append (function).
xkb-context-include-path-append-default (function).
xkb-context-include-path-clear (function).
xkb-context-include-path-get (function).
xkb-context-include-path-reset-defaults (function).
xkb-context-log-level (function).
(setf xkb-context-log-level) (function).
xkb-context-log-verbosity (function).
(setf xkb-context-log-verbosity) (function).
xkb-context-new (function).
xkb-context-num-include-paths (function).
xkb-context-ref (function).
xkb-context-set-log-fn (function).
xkb-context-set-log-level (function).
xkb-context-set-log-verbosity (function).
xkb-context-set-user-data (function).
xkb-context-unref (function).
xkb-context-user-data (function).
(setf xkb-context-user-data) (function).
xkb-keycode-is-legal-ext-p (function).
xkb-keycode-is-legal-x11-p (function).
xkb-keymap-key-by-name (function).
xkb-keymap-key-for-each (function).
xkb-keymap-key-get-mods-for-level (function).
xkb-keymap-key-get-name (function).
xkb-keymap-key-get-syms-by-level (function).
xkb-keymap-key-repeats (function).
xkb-keymap-layout-get-index (function).
xkb-keymap-layout-get-name (function).
xkb-keymap-led-get-index (function).
xkb-keymap-led-get-name (function).
xkb-keymap-max-keycode (function).
xkb-keymap-min-keycode (function).
xkb-keymap-mod-get-index (function).
xkb-keymap-mod-get-name (function).
xkb-keymap-new-from-buffer (function).
xkb-keymap-new-from-file (function).
xkb-keymap-new-from-names (function).
xkb-keymap-new-from-string (function).
xkb-keymap-num-layouts (function).
xkb-keymap-num-leds (function).
xkb-keymap-num-levels-for-key (function).
xkb-keymap-num-mods (function).
xkb-keymap-ref (function).
xkb-keymap-unref (function).
xkb-keysym-from-name (function).
xkb-keysym-get-name (function).
xkb-keysym-to-lower (function).
xkb-keysym-to-upper (function).
xkb-keysym-to-utf32 (function).
xkb-keysym-to-utf8 (function).
xkb-state-get-keymap (function).
xkb-state-key-get-consumed-mods (function).
xkb-state-key-get-consumed-mods2 (function).
xkb-state-key-get-layout (function).
xkb-state-key-get-level (function).
xkb-state-key-get-one-sym (function).
xkb-state-key-get-syms (function).
xkb-state-key-get-utf32 (function).
xkb-state-key-get-utf8 (function).
xkb-state-layout-index-is-active (function).
xkb-state-layout-name-is-active (function).
xkb-state-led-index-is-active (function).
xkb-state-led-name-is-active (function).
xkb-state-mod-index-is-active (function).
xkb-state-mod-index-is-consumed (function).
xkb-state-mod-index-is-consumed2 (function).
xkb-state-mod-indices-are-active (macro).
xkb-state-mod-mask-remove-consumed (function).
xkb-state-mod-name-is-active (function).
xkb-state-mod-names-are-active (macro).
xkb-state-new (function).
xkb-state-ref (function).
xkb-state-serialize-layout (function).
xkb-state-serialize-mods (function).
xkb-state-unref (function).
xkb-state-update-key (function).
xkb-state-update-mask (function).
xkb-utf32-to-keysym (function).

Internals

%define-accessor (macro).
%define-ref-and-unref (macro).
%define-utf8-string-reader (macro).
%definline (macro).
%xkb-compose-state-get-utf8 (function).
%xkb-keysym-get-name (function).
%xkb-keysym-to-utf8 (function).
%xkb-state-key-get-utf8 (function).
no-default-includes (constant).
no-environment-names (constant).
xkb-rule-names-tclass (class).

Next: Definitions, Previous: Files, Up: The cl-xkb Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

xkb

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

4.1 `xkb`

Source

package.lisp.

Use List

cffi.
common-lisp.

Public Interface

+xkb-keycode-invalid+ (constant).
+xkb-keycode-max+ (constant).
+xkb-keymap-use-original-format+ (constant).
+xkb-layout-invalid+ (constant).
+xkb-led-invalid+ (constant).
+xkb-level-invalid+ (constant).
+xkb-mod-invalid+ (constant).
new-keymap-from-names (function).
tolower (function).
toupper (function).
xkb-compose-state-feed (function).
xkb-compose-state-get-compose-table (function).
xkb-compose-state-get-one-sym (function).
xkb-compose-state-get-status (function).
xkb-compose-state-get-utf8 (function).
xkb-compose-state-new (function).
xkb-compose-state-ref (function).
xkb-compose-state-reset (function).
xkb-compose-state-unref (function).
xkb-compose-table-new-from-buffer (function).
xkb-compose-table-new-from-file (function).
xkb-compose-table-new-from-locale (function).
xkb-compose-table-ref (function).
xkb-compose-table-unref (function).
xkb-context-get-log-level (function).
xkb-context-get-log-verbosity (function).
xkb-context-get-user-data (function).
xkb-context-include-path-append (function).
xkb-context-include-path-append-default (function).
xkb-context-include-path-clear (function).
xkb-context-include-path-get (function).
xkb-context-include-path-reset-defaults (function).
xkb-context-log-level (function).
(setf xkb-context-log-level) (function).
xkb-context-log-verbosity (function).
(setf xkb-context-log-verbosity) (function).
xkb-context-new (function).
xkb-context-num-include-paths (function).
xkb-context-ref (function).
xkb-context-set-log-fn (function).
xkb-context-set-log-level (function).
xkb-context-set-log-verbosity (function).
xkb-context-set-user-data (function).
xkb-context-unref (function).
xkb-context-user-data (function).
(setf xkb-context-user-data) (function).
xkb-keycode-is-legal-ext-p (function).
xkb-keycode-is-legal-x11-p (function).
xkb-keymap-key-by-name (function).
xkb-keymap-key-for-each (function).
xkb-keymap-key-get-mods-for-level (function).
xkb-keymap-key-get-name (function).
xkb-keymap-key-get-syms-by-level (function).
xkb-keymap-key-repeats (function).
xkb-keymap-layout-get-index (function).
xkb-keymap-layout-get-name (function).
xkb-keymap-led-get-index (function).
xkb-keymap-led-get-name (function).
xkb-keymap-max-keycode (function).
xkb-keymap-min-keycode (function).
xkb-keymap-mod-get-index (function).
xkb-keymap-mod-get-name (function).
xkb-keymap-new-from-buffer (function).
xkb-keymap-new-from-file (function).
xkb-keymap-new-from-names (function).
xkb-keymap-new-from-string (function).
xkb-keymap-num-layouts (function).
xkb-keymap-num-leds (function).
xkb-keymap-num-levels-for-key (function).
xkb-keymap-num-mods (function).
xkb-keymap-ref (function).
xkb-keymap-unref (function).
xkb-keysym-from-name (function).
xkb-keysym-get-name (function).
xkb-keysym-to-lower (function).
xkb-keysym-to-upper (function).
xkb-keysym-to-utf32 (function).
xkb-keysym-to-utf8 (function).
xkb-state-get-keymap (function).
xkb-state-key-get-consumed-mods (function).
xkb-state-key-get-consumed-mods2 (function).
xkb-state-key-get-layout (function).
xkb-state-key-get-level (function).
xkb-state-key-get-one-sym (function).
xkb-state-key-get-syms (function).
xkb-state-key-get-utf32 (function).
xkb-state-key-get-utf8 (function).
xkb-state-layout-index-is-active (function).
xkb-state-layout-name-is-active (function).
xkb-state-led-index-is-active (function).
xkb-state-led-name-is-active (function).
xkb-state-mod-index-is-active (function).
xkb-state-mod-index-is-consumed (function).
xkb-state-mod-index-is-consumed2 (function).
xkb-state-mod-indices-are-active (macro).
xkb-state-mod-mask-remove-consumed (function).
xkb-state-mod-name-is-active (function).
xkb-state-mod-names-are-active (macro).
xkb-state-new (function).
xkb-state-ref (function).
xkb-state-serialize-layout (function).
xkb-state-serialize-mods (function).
xkb-state-unref (function).
xkb-state-update-key (function).
xkb-state-update-mask (function).
xkb-utf32-to-keysym (function).

Internals

%define-accessor (macro).
%define-ref-and-unref (macro).
%define-utf8-string-reader (macro).
%definline (macro).
%xkb-compose-state-get-utf8 (function).
%xkb-keysym-get-name (function).
%xkb-keysym-to-utf8 (function).
%xkb-state-key-get-utf8 (function).
no-default-includes (constant).
no-environment-names (constant).
xkb-rule-names-tclass (class).

Next: Indexes, Previous: Packages, Up: The cl-xkb Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Constants
Macros
Ordinary functions

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Constants

Constant: +xkb-keycode-invalid+ ¶

Package: xkb.
Source: cl-xkb.lisp.

Constant: +xkb-keycode-max+ ¶

Package: xkb.
Source: cl-xkb.lisp.

Constant: +xkb-keymap-use-original-format+ ¶

Package: xkb.
Source: cl-xkb.lisp.

Constant: +xkb-layout-invalid+ ¶

Package: xkb.
Source: cl-xkb.lisp.

Constant: +xkb-led-invalid+ ¶

Package: xkb.
Source: cl-xkb.lisp.

Constant: +xkb-level-invalid+ ¶

Package: xkb.
Source: cl-xkb.lisp.

Constant: +xkb-mod-invalid+ ¶

Package: xkb.
Source: cl-xkb.lisp.

Next: Ordinary functions, Previous: Constants, Up: Public Interface [Contents][Index]

5.1.2 Macros

Macro: xkb-state-mod-indices-are-active (state type match &rest varargs0) ¶

Package: xkb.
Source: cl-xkb.lisp.

Macro: xkb-state-mod-names-are-active (state type match &rest varargs0) ¶

Package: xkb.
Source: cl-xkb.lisp.

Previous: Macros, Up: Public Interface [Contents][Index]

5.1.3 Ordinary functions

Function: new-keymap-from-names (ctx rules model layout variant options) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: tolower (c) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: toupper (c) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-state-feed (state keysym) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-state-get-compose-table (state) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-state-get-one-sym (state) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-state-get-status (state) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-state-get-utf8 (state) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-state-new (table flags) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-state-ref (state) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-state-reset (state) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-state-unref (state) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-table-new-from-buffer (context buffer length locale format flags) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-table-new-from-file (context file locale format flags) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-table-new-from-locale (context locale flags) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-table-ref (table) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-compose-table-unref (table) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-get-log-level (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-get-log-verbosity (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-get-user-data (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-include-path-append (context path) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-include-path-append-default (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-include-path-clear (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-include-path-get (context index) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-include-path-reset-defaults (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-log-level (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: (setf xkb-context-log-level) (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-log-verbosity (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: (setf xkb-context-log-verbosity) (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-new (flags) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-num-include-paths (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-ref (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-set-log-fn (context log-fn) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-set-log-level (context level) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-set-log-verbosity (context verbosity) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-set-user-data (context user-data) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-unref (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-context-user-data (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: (setf xkb-context-user-data) (context) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keycode-is-legal-ext-p (key) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keycode-is-legal-x11-p (key) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-key-by-name (keymap name) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-key-for-each (keymap iter data) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-key-get-mods-for-level (keymap key layout level masks-out masks-size) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-key-get-name (keymap key) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-key-get-syms-by-level (keymap key layout level syms-out) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-key-repeats (keymap key) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-layout-get-index (keymap name) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-layout-get-name (keymap idx) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-led-get-index (keymap name) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-led-get-name (keymap idx) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-max-keycode (keymap) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-min-keycode (keymap) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-mod-get-index (keymap name) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-mod-get-name (keymap idx) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-new-from-buffer (context buffer length format flags) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-new-from-file (context file format flags) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-new-from-names (context names flags) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-new-from-string (context string format flags) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-num-layouts (keymap) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-num-leds (keymap) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-num-levels-for-key (keymap key layout) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-num-mods (keymap) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-ref (keymap) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keymap-unref (keymap) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keysym-from-name (name flags) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keysym-get-name (keysym) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keysym-to-lower (ks) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keysym-to-upper (ks) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keysym-to-utf32 (keysym) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-keysym-to-utf8 (keysym) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-get-keymap (state) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-key-get-consumed-mods (state key) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-key-get-consumed-mods2 (staet key mode) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-key-get-layout (state key) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-key-get-level (state key layout) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-key-get-one-sym (state key) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-key-get-syms (state key syms-out) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-key-get-utf32 (state key) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-key-get-utf8 (state key) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-layout-index-is-active (state idx type) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-layout-name-is-active (state name type) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-led-index-is-active (state idx) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-led-name-is-active (state name) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-mod-index-is-active (state idx type) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-mod-index-is-consumed (state key idx) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-mod-index-is-consumed2 (state key idx mode) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-mod-mask-remove-consumed (state key mask) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-mod-name-is-active (state name type) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-new (keymap) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-ref (state) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-serialize-layout (state components) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-serialize-mods (state components) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-unref (state) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-update-key (state key direction) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-state-update-mask (state depressed-mods latched-mods locked-mods depressed-layout latched-layout locked-layout) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: xkb-utf32-to-keysym (ucs) ¶

Package: xkb.
Source: cl-xkb.lisp.

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

5.2 Internals

Constants
Macros
Ordinary functions
Classes

Next: Macros, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Constants

Constant: no-default-includes ¶

Package: xkb.
Source: cl-xkb.lisp.

Constant: no-environment-names ¶

Package: xkb.
Source: cl-xkb.lisp.

Next: Ordinary functions, Previous: Constants, Up: Internals [Contents][Index]

5.2.2 Macros

Macro: %define-accessor (name reader-name writer-name (&rest args)) ¶

Package: xkb.
Source: cl-xkb.lisp.

Macro: %define-ref-and-unref (prefix param-name) ¶

Package: xkb.
Source: cl-xkb.lisp.

Macro: %define-utf8-string-reader (name reader-name (&rest args)) ¶

Package: xkb.
Source: cl-xkb.lisp.

Macro: %definline (name lambda-list &body body) ¶

Package: xkb.
Source: cl-xkb.lisp.

Next: Classes, Previous: Macros, Up: Internals [Contents][Index]

5.2.3 Ordinary functions

Function: %xkb-compose-state-get-utf8 (state buffer size) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: %xkb-keysym-get-name (keysym buffer size) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: %xkb-keysym-to-utf8 (keysym buffer size) ¶

Package: xkb.
Source: cl-xkb.lisp.

Function: %xkb-state-key-get-utf8 (state key buffer size) ¶

Package: xkb.
Source: cl-xkb.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.4 Classes

Class: xkb-rule-names-tclass ¶

Package

xkb.

Source

cl-xkb.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Previous: Definitions, Up: The cl-xkb Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	% ( F M N T X

	Index Entry	Section

%
	`%define-accessor`:	Private macros
	`%define-ref-and-unref`:	Private macros
	`%define-utf8-string-reader`:	Private macros
	`%definline`:	Private macros
	`%xkb-compose-state-get-utf8`:	Private ordinary functions
	`%xkb-keysym-get-name`:	Private ordinary functions
	`%xkb-keysym-to-utf8`:	Private ordinary functions
	`%xkb-state-key-get-utf8`:	Private ordinary functions

(
	`(setf xkb-context-log-level)`:	Public ordinary functions
	`(setf xkb-context-log-verbosity)`:	Public ordinary functions
	`(setf xkb-context-user-data)`:	Public ordinary functions

F
	`Function, %xkb-compose-state-get-utf8`:	Private ordinary functions
	`Function, %xkb-keysym-get-name`:	Private ordinary functions
	`Function, %xkb-keysym-to-utf8`:	Private ordinary functions
	`Function, %xkb-state-key-get-utf8`:	Private ordinary functions
	`Function, (setf xkb-context-log-level)`:	Public ordinary functions
	`Function, (setf xkb-context-log-verbosity)`:	Public ordinary functions
	`Function, (setf xkb-context-user-data)`:	Public ordinary functions
	`Function, new-keymap-from-names`:	Public ordinary functions
	`Function, tolower`:	Public ordinary functions
	`Function, toupper`:	Public ordinary functions
	`Function, xkb-compose-state-feed`:	Public ordinary functions
	`Function, xkb-compose-state-get-compose-table`:	Public ordinary functions
	`Function, xkb-compose-state-get-one-sym`:	Public ordinary functions
	`Function, xkb-compose-state-get-status`:	Public ordinary functions
	`Function, xkb-compose-state-get-utf8`:	Public ordinary functions
	`Function, xkb-compose-state-new`:	Public ordinary functions
	`Function, xkb-compose-state-ref`:	Public ordinary functions
	`Function, xkb-compose-state-reset`:	Public ordinary functions
	`Function, xkb-compose-state-unref`:	Public ordinary functions
	`Function, xkb-compose-table-new-from-buffer`:	Public ordinary functions
	`Function, xkb-compose-table-new-from-file`:	Public ordinary functions
	`Function, xkb-compose-table-new-from-locale`:	Public ordinary functions
	`Function, xkb-compose-table-ref`:	Public ordinary functions
	`Function, xkb-compose-table-unref`:	Public ordinary functions
	`Function, xkb-context-get-log-level`:	Public ordinary functions
	`Function, xkb-context-get-log-verbosity`:	Public ordinary functions
	`Function, xkb-context-get-user-data`:	Public ordinary functions
	`Function, xkb-context-include-path-append`:	Public ordinary functions
	`Function, xkb-context-include-path-append-default`:	Public ordinary functions
	`Function, xkb-context-include-path-clear`:	Public ordinary functions
	`Function, xkb-context-include-path-get`:	Public ordinary functions
	`Function, xkb-context-include-path-reset-defaults`:	Public ordinary functions
	`Function, xkb-context-log-level`:	Public ordinary functions
	`Function, xkb-context-log-verbosity`:	Public ordinary functions
	`Function, xkb-context-new`:	Public ordinary functions
	`Function, xkb-context-num-include-paths`:	Public ordinary functions
	`Function, xkb-context-ref`:	Public ordinary functions
	`Function, xkb-context-set-log-fn`:	Public ordinary functions
	`Function, xkb-context-set-log-level`:	Public ordinary functions
	`Function, xkb-context-set-log-verbosity`:	Public ordinary functions
	`Function, xkb-context-set-user-data`:	Public ordinary functions
	`Function, xkb-context-unref`:	Public ordinary functions
	`Function, xkb-context-user-data`:	Public ordinary functions
	`Function, xkb-keycode-is-legal-ext-p`:	Public ordinary functions
	`Function, xkb-keycode-is-legal-x11-p`:	Public ordinary functions
	`Function, xkb-keymap-key-by-name`:	Public ordinary functions
	`Function, xkb-keymap-key-for-each`:	Public ordinary functions
	`Function, xkb-keymap-key-get-mods-for-level`:	Public ordinary functions
	`Function, xkb-keymap-key-get-name`:	Public ordinary functions
	`Function, xkb-keymap-key-get-syms-by-level`:	Public ordinary functions
	`Function, xkb-keymap-key-repeats`:	Public ordinary functions
	`Function, xkb-keymap-layout-get-index`:	Public ordinary functions
	`Function, xkb-keymap-layout-get-name`:	Public ordinary functions
	`Function, xkb-keymap-led-get-index`:	Public ordinary functions
	`Function, xkb-keymap-led-get-name`:	Public ordinary functions
	`Function, xkb-keymap-max-keycode`:	Public ordinary functions
	`Function, xkb-keymap-min-keycode`:	Public ordinary functions
	`Function, xkb-keymap-mod-get-index`:	Public ordinary functions
	`Function, xkb-keymap-mod-get-name`:	Public ordinary functions
	`Function, xkb-keymap-new-from-buffer`:	Public ordinary functions
	`Function, xkb-keymap-new-from-file`:	Public ordinary functions
	`Function, xkb-keymap-new-from-names`:	Public ordinary functions
	`Function, xkb-keymap-new-from-string`:	Public ordinary functions
	`Function, xkb-keymap-num-layouts`:	Public ordinary functions
	`Function, xkb-keymap-num-leds`:	Public ordinary functions
	`Function, xkb-keymap-num-levels-for-key`:	Public ordinary functions
	`Function, xkb-keymap-num-mods`:	Public ordinary functions
	`Function, xkb-keymap-ref`:	Public ordinary functions
	`Function, xkb-keymap-unref`:	Public ordinary functions
	`Function, xkb-keysym-from-name`:	Public ordinary functions
	`Function, xkb-keysym-get-name`:	Public ordinary functions
	`Function, xkb-keysym-to-lower`:	Public ordinary functions
	`Function, xkb-keysym-to-upper`:	Public ordinary functions
	`Function, xkb-keysym-to-utf32`:	Public ordinary functions
	`Function, xkb-keysym-to-utf8`:	Public ordinary functions
	`Function, xkb-state-get-keymap`:	Public ordinary functions
	`Function, xkb-state-key-get-consumed-mods`:	Public ordinary functions
	`Function, xkb-state-key-get-consumed-mods2`:	Public ordinary functions
	`Function, xkb-state-key-get-layout`:	Public ordinary functions
	`Function, xkb-state-key-get-level`:	Public ordinary functions
	`Function, xkb-state-key-get-one-sym`:	Public ordinary functions
	`Function, xkb-state-key-get-syms`:	Public ordinary functions
	`Function, xkb-state-key-get-utf32`:	Public ordinary functions
	`Function, xkb-state-key-get-utf8`:	Public ordinary functions
	`Function, xkb-state-layout-index-is-active`:	Public ordinary functions
	`Function, xkb-state-layout-name-is-active`:	Public ordinary functions
	`Function, xkb-state-led-index-is-active`:	Public ordinary functions
	`Function, xkb-state-led-name-is-active`:	Public ordinary functions
	`Function, xkb-state-mod-index-is-active`:	Public ordinary functions
	`Function, xkb-state-mod-index-is-consumed`:	Public ordinary functions
	`Function, xkb-state-mod-index-is-consumed2`:	Public ordinary functions
	`Function, xkb-state-mod-mask-remove-consumed`:	Public ordinary functions
	`Function, xkb-state-mod-name-is-active`:	Public ordinary functions
	`Function, xkb-state-new`:	Public ordinary functions
	`Function, xkb-state-ref`:	Public ordinary functions
	`Function, xkb-state-serialize-layout`:	Public ordinary functions
	`Function, xkb-state-serialize-mods`:	Public ordinary functions
	`Function, xkb-state-unref`:	Public ordinary functions
	`Function, xkb-state-update-key`:	Public ordinary functions
	`Function, xkb-state-update-mask`:	Public ordinary functions
	`Function, xkb-utf32-to-keysym`:	Public ordinary functions

M
	`Macro, %define-accessor`:	Private macros
	`Macro, %define-ref-and-unref`:	Private macros
	`Macro, %define-utf8-string-reader`:	Private macros
	`Macro, %definline`:	Private macros
	`Macro, xkb-state-mod-indices-are-active`:	Public macros
	`Macro, xkb-state-mod-names-are-active`:	Public macros

N
	`new-keymap-from-names`:	Public ordinary functions

T
	`tolower`:	Public ordinary functions
	`toupper`:	Public ordinary functions

X
	`xkb-compose-state-feed`:	Public ordinary functions
	`xkb-compose-state-get-compose-table`:	Public ordinary functions
	`xkb-compose-state-get-one-sym`:	Public ordinary functions
	`xkb-compose-state-get-status`:	Public ordinary functions
	`xkb-compose-state-get-utf8`:	Public ordinary functions
	`xkb-compose-state-new`:	Public ordinary functions
	`xkb-compose-state-ref`:	Public ordinary functions
	`xkb-compose-state-reset`:	Public ordinary functions
	`xkb-compose-state-unref`:	Public ordinary functions
	`xkb-compose-table-new-from-buffer`:	Public ordinary functions
	`xkb-compose-table-new-from-file`:	Public ordinary functions
	`xkb-compose-table-new-from-locale`:	Public ordinary functions
	`xkb-compose-table-ref`:	Public ordinary functions
	`xkb-compose-table-unref`:	Public ordinary functions
	`xkb-context-get-log-level`:	Public ordinary functions
	`xkb-context-get-log-verbosity`:	Public ordinary functions
	`xkb-context-get-user-data`:	Public ordinary functions
	`xkb-context-include-path-append`:	Public ordinary functions
	`xkb-context-include-path-append-default`:	Public ordinary functions
	`xkb-context-include-path-clear`:	Public ordinary functions
	`xkb-context-include-path-get`:	Public ordinary functions
	`xkb-context-include-path-reset-defaults`:	Public ordinary functions
	`xkb-context-log-level`:	Public ordinary functions
	`xkb-context-log-verbosity`:	Public ordinary functions
	`xkb-context-new`:	Public ordinary functions
	`xkb-context-num-include-paths`:	Public ordinary functions
	`xkb-context-ref`:	Public ordinary functions
	`xkb-context-set-log-fn`:	Public ordinary functions
	`xkb-context-set-log-level`:	Public ordinary functions
	`xkb-context-set-log-verbosity`:	Public ordinary functions
	`xkb-context-set-user-data`:	Public ordinary functions
	`xkb-context-unref`:	Public ordinary functions
	`xkb-context-user-data`:	Public ordinary functions
	`xkb-keycode-is-legal-ext-p`:	Public ordinary functions
	`xkb-keycode-is-legal-x11-p`:	Public ordinary functions
	`xkb-keymap-key-by-name`:	Public ordinary functions
	`xkb-keymap-key-for-each`:	Public ordinary functions
	`xkb-keymap-key-get-mods-for-level`:	Public ordinary functions
	`xkb-keymap-key-get-name`:	Public ordinary functions
	`xkb-keymap-key-get-syms-by-level`:	Public ordinary functions
	`xkb-keymap-key-repeats`:	Public ordinary functions
	`xkb-keymap-layout-get-index`:	Public ordinary functions
	`xkb-keymap-layout-get-name`:	Public ordinary functions
	`xkb-keymap-led-get-index`:	Public ordinary functions
	`xkb-keymap-led-get-name`:	Public ordinary functions
	`xkb-keymap-max-keycode`:	Public ordinary functions
	`xkb-keymap-min-keycode`:	Public ordinary functions
	`xkb-keymap-mod-get-index`:	Public ordinary functions
	`xkb-keymap-mod-get-name`:	Public ordinary functions
	`xkb-keymap-new-from-buffer`:	Public ordinary functions
	`xkb-keymap-new-from-file`:	Public ordinary functions
	`xkb-keymap-new-from-names`:	Public ordinary functions
	`xkb-keymap-new-from-string`:	Public ordinary functions
	`xkb-keymap-num-layouts`:	Public ordinary functions
	`xkb-keymap-num-leds`:	Public ordinary functions
	`xkb-keymap-num-levels-for-key`:	Public ordinary functions
	`xkb-keymap-num-mods`:	Public ordinary functions
	`xkb-keymap-ref`:	Public ordinary functions
	`xkb-keymap-unref`:	Public ordinary functions
	`xkb-keysym-from-name`:	Public ordinary functions
	`xkb-keysym-get-name`:	Public ordinary functions
	`xkb-keysym-to-lower`:	Public ordinary functions
	`xkb-keysym-to-upper`:	Public ordinary functions
	`xkb-keysym-to-utf32`:	Public ordinary functions
	`xkb-keysym-to-utf8`:	Public ordinary functions
	`xkb-state-get-keymap`:	Public ordinary functions
	`xkb-state-key-get-consumed-mods`:	Public ordinary functions
	`xkb-state-key-get-consumed-mods2`:	Public ordinary functions
	`xkb-state-key-get-layout`:	Public ordinary functions
	`xkb-state-key-get-level`:	Public ordinary functions
	`xkb-state-key-get-one-sym`:	Public ordinary functions
	`xkb-state-key-get-syms`:	Public ordinary functions
	`xkb-state-key-get-utf32`:	Public ordinary functions
	`xkb-state-key-get-utf8`:	Public ordinary functions
	`xkb-state-layout-index-is-active`:	Public ordinary functions
	`xkb-state-layout-name-is-active`:	Public ordinary functions
	`xkb-state-led-index-is-active`:	Public ordinary functions
	`xkb-state-led-name-is-active`:	Public ordinary functions
	`xkb-state-mod-index-is-active`:	Public ordinary functions
	`xkb-state-mod-index-is-consumed`:	Public ordinary functions
	`xkb-state-mod-index-is-consumed2`:	Public ordinary functions
	`xkb-state-mod-indices-are-active`:	Public macros
	`xkb-state-mod-mask-remove-consumed`:	Public ordinary functions
	`xkb-state-mod-name-is-active`:	Public ordinary functions
	`xkb-state-mod-names-are-active`:	Public macros
	`xkb-state-new`:	Public ordinary functions
	`xkb-state-ref`:	Public ordinary functions
	`xkb-state-serialize-layout`:	Public ordinary functions
	`xkb-state-serialize-mods`:	Public ordinary functions
	`xkb-state-unref`:	Public ordinary functions
	`xkb-state-update-key`:	Public ordinary functions
	`xkb-state-update-mask`:	Public ordinary functions
	`xkb-utf32-to-keysym`:	Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	+ C N

	Index Entry	Section

+
	`+xkb-keycode-invalid+`:	Public constants
	`+xkb-keycode-max+`:	Public constants
	`+xkb-keymap-use-original-format+`:	Public constants
	`+xkb-layout-invalid+`:	Public constants
	`+xkb-led-invalid+`:	Public constants
	`+xkb-level-invalid+`:	Public constants
	`+xkb-mod-invalid+`:	Public constants

C
	`Constant, +xkb-keycode-invalid+`:	Public constants
	`Constant, +xkb-keycode-max+`:	Public constants
	`Constant, +xkb-keymap-use-original-format+`:	Public constants
	`Constant, +xkb-layout-invalid+`:	Public constants
	`Constant, +xkb-led-invalid+`:	Public constants
	`Constant, +xkb-level-invalid+`:	Public constants
	`Constant, +xkb-mod-invalid+`:	Public constants
	`Constant, no-default-includes`:	Private constants
	`Constant, no-environment-names`:	Private constants

N
	`no-default-includes`:	Private constants
	`no-environment-names`:	Private constants

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

A.4 Data types

Jump to:	C F P S X

	Index Entry	Section

C
	`cl-xkb`:	The cl-xkb system
	`cl-xkb.asd`:	The cl-xkb/cl-xkb․asd file
	`cl-xkb.lisp`:	The cl-xkb/cl-xkb․lisp file
	`Class, xkb-rule-names-tclass`:	Private classes

F
	`File, cl-xkb.asd`:	The cl-xkb/cl-xkb․asd file
	`File, cl-xkb.lisp`:	The cl-xkb/cl-xkb․lisp file
	`File, package.lisp`:	The cl-xkb/package․lisp file

P
	`Package, xkb`:	The xkb package
	`package.lisp`:	The cl-xkb/package․lisp file

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

X
	`xkb`:	The xkb package
	`xkb-rule-names-tclass`:	Private classes

The cl-xkb Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-xkb

3 Files

3.1 Lisp

3.1.1 cl-xkb/cl-xkb.asd

3.1.2 cl-xkb/package.lisp

3.1.3 cl-xkb/cl-xkb.lisp

4 Packages

4.1 xkb

5 Definitions

5.1 Public Interface

5.1.1 Constants

5.1.2 Macros

5.1.3 Ordinary functions

5.2 Internals

5.2.1 Constants

5.2.2 Macros

5.2.3 Ordinary functions

5.2.4 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-xkb`

3.1.1 `cl-xkb/cl-xkb.asd`

3.1.2 `cl-xkb/package.lisp`

3.1.3 `cl-xkb/cl-xkb.lisp`

4.1 `xkb`