[Prev] [Next]

KeyCombo

Name

Synopsis

  (KeyCap | KeyCombo | KeySym | MouseButton)+

Attributes

This element has common and Role attributes.

Name	Value(s)	Type	Default Value
Action	(Click |Double-Click |Press |Seq |Simul |Other)	#IMPLIED
MoreInfo	(RefEntry|None)		None
OtherAction	CDATA	#IMPLIED

Tag Minimization

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

Description

An instruction for or description of pressing or clicking a combination of keys, mouse buttons, pedals, or other pressable input devices to get a certain software effect. It has common, Action, OtherAction, and MoreInfo attributes.

Parents

These elements contain KeyCombo: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, 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, and entry.

Children

KeyCombo contains these elements: KeyCap, KeyCombo, KeySym, and MouseButton.

In some contexts, some of these elements may be invalid due to exclusions in parent elements.

Attributes

Action

Action indicates the type of key combination. The default is unspecified if there is only one child element, Simul if there is more than one. If the value given is Other, the value of the OtherAction attribute should be used.

OtherAction

OtherAction indicates a user-defined key combination type

MoreInfo

Indicates whether the element's content has an associated RefEntry.

Examples

<SCREEN>
<KEYCOMBO><KEYCAP>Alt</KEYCAP><KEYCAP>Enter</KEYCAP></KEYCOMBO>
<INTERFACE>Backup Type:</INTERFACE> <!--random text in Backup window-->
<INTERFACE>Backup T<ACCEL>y</ACCEL>pe:</INTERFACE>
<MOUSEBUTTON>M1</MOUSEBUTTON> <!--conventional names for unlabeled buttons-->
<MOUSEBUTTON>MB1</MOUSEBUTTON>
<MOUSEBUTTON>Left</MOUSEBUTTON>
<GUIICON><INLINEGRAPHIC ENTITYREF="mimeface"></INLINEGRAPHIC>
</GUIICON> <!--in mail program-->
<GUILABEL>File Manager</GUILABEL> <!--window title bar text-->
<GUIMENU>Tools</GUIMENU>
<GUIMENU>Too<ACCEL>l</ACCEL>s</GUIMENU>
<GUIMENUITEM>Save As...</GUIMENUITEM>
<GUIMENUITEM>Save <ACCEL>A</ACCEL>s...</GUIMENUITEM>
<GUISUBMENU>Davenport</GUISUBMENU> <!--folders and mailboxes in mail program-->
<MENUCHOICE>
<GUIMENU>Mailbox</GUIMENU>
<GUISUBMENU>Davenport</GUISUBMENU>
<GUIMENUITEM>New...</GUIMENUITEM>
</MENUCHOICE>
<!--menu item is shown like this:   "Expand _A_ll      Ctrl+*"      -->
<MENUCHOICE>
<SHORTCUT><KEYCAP>Ctrl</KEYCAP><KEYCAP>*</KEYCAP></SHORTCUT>
<GUIMENU>Tree</GUIMENU>  <!--or <ACCEL>T</ACCEL>ree-->
<GUIMENUitem>Expand All</GUIMENUitem> <!--or Expand <ACCEL>A</ACCEL>ll-->
</MENUCHOICE>
<GUIBUTTON>OK</GUIBUTTON>
<GUIBUTTON><ACCEL>O</ACCEL>K</GUIBUTTON>
</SCREEN>

[Prev] KeyCode
[Next] KeySym
[Reference Home] [Davenport Group Home]