keycap
keycap — The text printed on a key on a keyboard.
Synopsis
- Zero or more of:
- text
phrase(db._phrase)replaceable- Graphic inlines
![[-]](figs/web/nav/down.gif)
- Indexing inlines
- Linking inlines
- Ubiquitous inlines
altanchorannotationbibliorefindexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkremarksubscriptsuperscriptxref
Attributes
Common attributes and common linking attributes.
Additional attributes:
- Exactly one of:
- function (enumeration)
- “alt”
- “backspace”
- “command”
- “control”
- “delete”
- “down”
- “end”
- “enter”
- “escape”
- “home”
- “insert”
- “left”
- “meta”
- “option”
- “pagedown”
- “pageup”
- “right”
- “shift”
- “space”
- “tab”
- “up”
- Each of:
- function (enumeration)
- “other”
- otherfunction
- function (enumeration)
- function (enumeration)
Required attributes are shown in bold.
Description
The keycap identifies the text printed on a
physical 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.
Attributes
Common attributes and common linking attributes.
- function
Identifies the function key
Enumerated values: “alt” The "Alt" key
“backspace” The "Backspace" key
“command” The "Command" key
“control” The "Control" key
“delete” The "Delete" key
“down” The down arrow
“end” The "End" key
“enter” The "Enter" or "Return" key
“escape” The "Escape" key
“home” The "Home" key
“insert” The "Insert" key
“left” The left arrow
“meta” The "Meta" key
“option” The "Option" key
“pagedown” The page down key
“pageup” The page up key
“right” The right arrow
“shift” The "Shift" key
“space” The spacebar
“tab” The "Tab" key
“up” The up arrow
- function
Identifies the function key
Enumerated values: “other” Indicates a non-standard function key
- otherfunction
Specifies a keyword that identifies the non-standard key
Parents ![[+]](figs/web/nav/right.gif)
Children
See Also
accel, guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, keycode, keycombo, keysym, menuchoice, mousebutton, shortcut
Examples
1 <article xmlns='http://docbook.org/ns/docbook'> 2 <title>Example keycap</title> 4 <para>The <keycap>F1</keycap> key on an IBM PC keyboard generates the scan code <keycode>0x3B</keycode> when pressed. This value 6 is defined as <keysym>KEY_F1</keysym> in <filename class="headerfile">keyboard.h</filename>. 8 </para> 10 </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.