DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

MouseButton

Name

MouseButton -- The conventional name of a mouse button

Synopsis

Mixed Content Model

MouseButton ::=
((#PCDATA|Replaceable|InlineGraphic|InlineMediaObject|IndexTerm)+)

Attributes

Common attributes

Name

Type

Default

MoreInfo

Enumeration:

None
RefEntry

"None"

Tag Minimization

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

Parameter Entities

%cptr.char.mix;%ndxterm.char.mix;%para.char.mix;
%programlisting.content;%refinline.char.mix;%refname.char.mix;
%screen.content;%tbl.entry.mdl;%tech.char.class;
%title.char.mix;

Description

The MouseButton element identifies the conventional name of a mouse button. Because mouse buttons are not physically labelled, the name is just that, a convention. Adding explicit markup for the naming of mouse buttons allow easier translation from one convention to another and might allow an online system to adapt to right- or left-handed usage.

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.

Parents

These elements contain MouseButton: 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 MouseButton: IndexTerm, InlineGraphic, InlineMediaObject, Replaceable.

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

In some contexts, the following elements are excluded: IndexTerm.

Attributes

MoreInfo

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

See Also

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

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
Select a region of text by dragging the mouse pointer with the
<mousebutton>left</mousebutton> mouse button depressed.  Copy the
selected text to a new location by placing the mouse pointer at the
desired position and pressing the <mousebutton>middle</mousebutton>
button.
</para>

Select a region of text by dragging the mouse pointer with the left mouse button depressed. Copy the selected text to a new location by placing the mouse pointer at the desired position and pressing the middle button.

For additional examples, see also KeyCombo.

PrevHomeNext
ModeSpecUpMsg

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.