DocBook 5: The Definitive Guide

Name

KeyCombo -- A combination of input actions

Synopsis

Content Model

KeyCombo ::= ((KeyCap|KeyCombo|KeySym|MouseButton)+)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

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. The MoreInfo attribute can help generate a link or query to retrieve additional information.

Parents

These elements contain KeyCombo: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, entry, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Interface, InterfaceDefinition, KeyCap, KeyCombo, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Member, MsgAud, OLink, Option, Optional, Para, Parameter, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Property, Quote, RefDescriptor, RefEntryTitle, RefName, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, Shortcut, SimPara, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput.

Children

The following elements occur in KeyCombo: KeyCap, KeyCombo, KeySym, MouseButton.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

Attributes

Action

Action identifies the nature of the action taken. If KeyCombo contains more than one action element, Simul is the default value for Action, otherwise there is no default.

If Other is specified, OtherAction should be used to identify the nature of the action.

MoreInfo

If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Keycombo.

OtherAction

OtherAction should be used when Action is set to Other. It identifes the nature of the action in some application-specific way.

See Also

Accel, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, KeyCap, KeyCode, KeySym, MenuChoice, MouseButton, Shortcut

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <para> To move a highlighted region, use <keycombo action=simul> <keycap>Shift</keycap> <mousebutton>Button1</mousebutton> </keycombo> and drag the text to the new location. </para>

To move a highlighted region, use Shift+Button1 and drag the text to the new location.

For additional examples, see also GUIMenu, GUIMenuItem, MenuChoice, Shortcut.

Back to: DocBook: The Definitive Guide