Reference. Reference for the DocBook DTD

[Prev] [Next]


Interface

Name

Interface---Element of a graphical user interface

Synopsis

Content Model
  (#PCDATA | Link | OLink | ULink | Action | Application
  | ClassName | Command | ComputerOutput | Database | Email
  | EnVar | ErrorCode | ErrorName | ErrorType | Filename
  | Function | GUIButton | GUIIcon | GUILabel | GUIMenu
  | GUIMenuItem | GUISubmenu | Hardware | Interface
  | InterfaceDefinition | KeyCap | KeyCode | KeyCombo
  | KeySym | Literal | Markup | MediaLabel | MenuChoice
  | MouseButton | MsgText | Option | Optional | Parameter
  | Prompt | Property | Replaceable | ReturnValue | SGMLTag
  | StructField | StructName | Symbol | SystemItem | Token
  | Type | UserInput | Anchor | Comment | Subscript
  | Superscript | InlineGraphic
  | Accel)+

Attributes

This element has common and Role attributes.

Name Value(s) Type Default Value
Class (Button |Icon |Menu |MenuItem) #IMPLIED  
MoreInfo (RefEntry|None)   None

Tag Minimization

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

Description

Element of a graphical user interface. It may contain members of cptr.char.mix, and has common, Class, and MoreInfo attributes.

Parents

These elements contain Interface: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Interface, InterfaceDefinition, KeyCap, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Member, MenuChoice, 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, SimPara, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput, and entry.

Children

Interface contains these elements: Accel, Action, Anchor, Application, ClassName, Command, Comment, ComputerOutput, Database, Email, EnVar, ErrorCode, ErrorName, ErrorType, Filename, Function, GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware, InlineGraphic, Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Link, Literal, Markup, MediaLabel, MenuChoice, MouseButton, MsgText, OLink, Option, Optional, #PCDATA, Parameter, Prompt, Property, Replaceable, ReturnValue, SGMLTag, StructField, StructName, Subscript, Superscript, Symbol, SystemItem, Token, Type, ULink, and UserInput.

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

Attributes

Class

Class indicates the type of the Interface; there is no default.

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] InlineGraphic
[Next] InterfaceDefinition
[Reference Home] [Davenport Group Home]