menuchoice
Prev | DocBook Element Reference | Next

This is an alpha version of this book.

# menuchoice

## Name

menuchoice — A selection or series of selections from a menu

##

# Synopsis

### Content Model

    menuchoice ::=
    (shortcut?,
     (guibutton|guiicon|guilabel|guimenu|guimenuitem|guisubmenu|
      interface)+)

### Attributes

Common attributes

Name | Type | Default
moreinfo | Enumeration:
none
refentry
| "none"

### Parameter Entities

The following parameter entities contain menuchoice:

Parameter Entities
`%cptr.char.mix;` | `%ndxterm.char.mix;` | `%para.char.mix;`
`%refinline.char.mix;` | `%refname.char.mix;` | `%tbl.entry.mdl;`
`%tech.char.class;` | `%title.char.mix;` |

## Description

In applications that present graphical user interfaces, it is often necessary to select an item, or a series of items, from a menu in order to accomplish some action. The `MenuChoice` element provides a wrapper to contain the complete combination of selections.

### Processing expectations

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

`MenuChoice` may generate arrows or other punctuation between multiple GUI elements. The `ShortCut` may be suppressed, or sometimes it is presented in parentheses after the rest of the items.

### Parents

These elements contain menuchoice: `application`, `attribution`, `bibliomisc`, `bridgehead`, `citation`, `citetitle`, `classsynopsisinfo`, `command`, `computeroutput`, `emphasis`, `entry`, `foreignphrase`, `funcparams`, `funcsynopsisinfo`, `function`, `glosssee`, `glossseealso`, `glossterm`, `lineannotation`, `link`, `literal`, `literallayout`, `lotentry`, `member`, `msgaud`, `olink`, `optional`, `para`, `phrase`, `primary`, `primaryie`, `productname`, `programlisting`, `quote`, `refdescriptor`, `refentrytitle`, `refname`, `refpurpose`, `remark`, `screen`, `screeninfo`, `secondary`, `secondaryie`, `see`, `seealso`, `seealsoie`, `seeie`, `seg`, `segtitle`, `simpara`, `subtitle`, `synopsis`, `term`, `tertiary`, `tertiaryie`, `title`, `titleabbrev`, `tocback`, `tocentry`, `tocfront`, `trademark`, `ulink`, `userinput`.

### Children

The following elements occur in menuchoice: `guibutton`, `guiicon`, `guilabel`, `guimenu`, `guimenuitem`, `guisubmenu`, `interface`, `shortcut`.

## Attributes

moreinfo

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

## See Also

`accel`, `guibutton`, `guiicon`, `guilabel`, `guimenu`, `guimenuitem`, `guisubmenu`, `keycap`, `keycode`, `keycombo`, `keysym`, `mousebutton`, `shortcut`.

## Examples

    <!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
              "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    <para>
    You can exit from GNU Emacs with
    <menuchoice>
      <shortcut>
        <keycombo><keysym>C-x</keysym><keysym>C-c</keysym></keycombo>
      </shortcut>
      <guimenu>Files</guimenu>
      <guimenuitem>Exit Emacs</guimenuitem>
    </menuchoice>.
    </para>

You can exit from GNU Emacs with Files->Exit Emacs (C-x-C-c).

Compare this example with the similar example in `GUIMenu`. Here the `KeyCombo` and `MenuChoice` elements are required to process thier content in some intelligent way in order to produce useful output.

For additional examples, see also `shortcut` .

Prev | Home | Next
member | Up | methodname

Copyright © 1999, 2000, 2001 O'Reilly & Associates, Inc.