DocBook 5: The Definitive Guide

Name

keycode — The internal, frequently numeric, identifier for a key on a keyboard

Synopsis

keycode ::= (text | phrase ^db._phrase | replaceable | Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*

Attribute synopsis

Common attributes and common linking attributes.

Description

The keycode identifies the numeric value associated with a key on a computer keyboard. This is distinct from any scan code that it may generate (keycode), or any symbolic name (keysym) that might exist for the key.

Processing expectations

Formatted inline.

See Also

accel, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, keycap, keycombo, keysym, menuchoice, mousebutton, shortcut

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example keycode</title>

<para>The <keycap>F1</keycap> key on an IBM PC keyboard generates the
scan code <keycode>0x3B</keycode> when pressed.  This value
is defined as <keysym>KEY_F1</keysym> in 
<filename class="headerfile">keyboard.h</filename>.
</para>

</article>

The F1 key on an IBM PC keyboard generates the scan code 0x3B when pressed. This value is defined as KEY_F1 in keyboard.h.