keycombo
keycombo — A combination of input actions.
Synopsis
keycombo ::=
- One or more of:
Attributes
Common attributes and common linking attributes.
Additional attributes:
- Exactly one of:
- action (enumeration)
- “click”
- “double-click”
- “press”
- “seq”
- “simul”
- Each of:
- action (enumeration)
- “other”
- otheraction
- action (enumeration)
- action (enumeration)
Required attributes are shown in bold.
Description
For actions that require multiple keystrokes, mouse actions, or
other physical input selections, the keycombo
element
provides a wrapper for the entire set of events.
Processing expectations
Formatted inline.
Attributes
Common attributes and common linking attributes.
- any attribute
Any attribute in any other explicit namespace
- action
Identifies the nature of the action taken. If
keycombo
contains more than one element,simul
is the default, otherwise there is no default.Enumerated values: “click” A (single) mouse click.
“double-click” A double mouse click.
“press” A mouse or key press.
“seq” Sequential clicks or presses.
“simul” Simultaneous clicks or presses.
- otheraction
Identifies the non-standard action in some unspecified way.
Parents
These elements contain keycombo
: bridgehead
, caption
(db.html.caption), citation
, citetitle
, classsynopsisinfo
, contrib
, emphasis
(db.emphasis), entry
, enumitemdescription
, firstterm
(db.firstterm), funcsynopsisinfo
, glosssee
, glossseealso
, glossterm
(db.glossterm), keycombo
, link
, literallayout
, member
, meta
(db.meta.content), olink
, orgdiv
, para
, phrase
(db.phrase), primary
, primaryie
, programlisting
, quote
(db.quote), refdescriptor
, refentrytitle
, refname
, refpurpose
, remark
, screen
, secondary
, secondaryie
, see
, seealso
, seealsoie
, seeie
, seg
, segtitle
, shortcut
, simpara
, subtitle
, synopsis
, synopsisinfo
, td
, term
, termdef
, tertiary
, tertiaryie
, th
, title
, titleabbrev
, tocentry
, userinput
.
Children
The following elements occur in keycombo
: keycap
, keycombo
, keysym
, mousebutton
.
See Also
Related elements: accel
, guibutton
, guiicon
, guilabel
, guimenu
, guimenuitem
, guisubmenu
, keycap
, keycode
, keysym
, menuchoice
, mousebutton
, shortcut
.
Examples
1 |<article xmlns='http://docbook.org/ns/docbook'>
|<title>Example keycombo</title>
||
<para>To move a highlighted region, use
5 |<keycombo action='simul'>
|<keycap>Shift</keycap>
|<mousebutton>Button1</mousebutton>
|</keycombo>
|and drag the text to the new location.
10 |</para>
||
</article>
To move a highlighted region, use Shift and drag the text to the new location.