keycode

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

Synopsis

keycode ::=

Zero or more of:
- text
- replaceable
- Graphic inlines
  inlinemediaobject
- Indexing inlines
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
- Linking inlines
  anchor
  biblioref
  link
  olink
  xref
- Ubiquitous inlines
  abbrev
  acronym
  alt
  anchor
  annotation
  biblioref
  coref
  date
  emphasis (db._emphasis)
  firstterm (db._firstterm)
  footnote
  footnoteref
  foreignphrase (db._foreignphrase)
  glossterm (db._glossterm)
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
  inlinemediaobject
  link
  olink
  phrase (db._phrase)
  quote (db._quote)
  remark
  subscript
  superscript
  trademark
  wordasword
  xref

Attributes

Description

The keycode identifies a numeric value (e.g., scan code) associated with a key on a computer keyboard. This is distinct from any text (keycap) that might be printed on the key or any symbolic name (keysym) that might exist for the key.

Processing expectations

Formatted inline.

Parents

This element occurs in 52 elements.

Children

This element contains 29 elements.

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.


keycap		keycombo