.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Widgets::Menu 3pm"
.TH Widgets::Menu 3pm "2002-11-14" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Curses::Widgets::Menu \- Menu Widgets
.SH "MODULE VERSION"
.IX Header "MODULE VERSION"
\&\f(CW$Id:\fR Menu.pm,v 1.103 2002/11/14 01:26:34 corliss Exp corliss $
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Curses::Widgets::Menu;
\&
\&  $menu = Curses::Widgets::Menu\->new({
\&    COLUMNS     => 10,
\&    INPUTFUNC   => \e&scankey,
\&    FOREGROUND  => undef,
\&    BACKGROUND  => \*(Aqblack\*(Aq,
\&    FOCUSSWITCH => "\et",
\&    X           => 1,
\&    Y           => 1,
\&    MENUS       => {
\&      MENUORDER => [qw(File)],
\&      File => {
\&        ITEMORDER => [qw(Save Quit)],
\&        Save      => \e&Save,
\&        Quit      => \e&Quit,
\&      },
\&    CURSORPOS   => \*(AqFile\*(Aq,
\&    BORDER      => 1,
\&    });
\&
\&  $menu\->draw($mwh, 1);
\&  $menu\->execute;
\&
\&  See the Curses::Widgets pod for other methods.
.Ve
.SH "REQUIREMENTS"
.IX Header "REQUIREMENTS"
.IP "Curses" 4
.IX Item "Curses"
.PD 0
.IP "Curses::Widgets" 4
.IX Item "Curses::Widgets"
.IP "Curses::Widgets::ListBox" 4
.IX Item "Curses::Widgets::ListBox"
.PD
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Curses::Widgets::Menu provides simplified \s-1OO\s0 access to menus.  Each item in a
menu can be tied to a subroutine reference which is called when selected.
.SH "METHODS"
.IX Header "METHODS"
.SS "new (inherited from Curses::Widgets)"
.IX Subsection "new (inherited from Curses::Widgets)"
.Vb 10
\&  $menu = Curses::Widgets::Menu\->new({
\&    INPUTFUNC   => \e&scankey,
\&    FOREGROUND  => undef,
\&    BACKGROUND  => \*(Aqblack\*(Aq,
\&    FOCUSSWITCH => "\et",
\&    MENUS       => {
\&      MENUORDER => [qw(File)],
\&      File      => {
\&        ITEMORDER => [qw(Save Quit)],
\&        Save      => \e&Save,
\&        Quit      => \e&Quit,
\&      },
\&    CURSORPOS   => \*(AqFile\*(Aq,
\&    BORDER      => 1,
\&    });
.Ve
.PP
The new method instantiates a new Menu object.  The only mandatory
key/value pairs in the configuration hash are \fBX\fR and \fBY\fR.  All others
have the following defaults:
.PP
.Vb 9
\&  Key           Default  Description
\&  ============================================================
\&  INPUTFUNC   \e&scankey  Function to use to scan for keystrokes
\&  FOREGROUND      undef  Default foreground colour
\&  BACKGROUND    \*(Aqblack\*(Aq  Default background colour
\&  FOCUSSWITCH      "\et"  Characters which signify end of input
\&  MENUS              {}  Menu structure
\&  CURSORPOS          \*(Aq\*(Aq  Current position of the cursor
\&  BORDER              0  Avoid window borders
.Ve
.PP
The \fB\s-1MENUS\s0\fR option is a hash of hashes, with each hash a separate menu, and
the constituent hashes being a Entry/Function pairs.  Each hash requires a
special key/value pair that determines the order of the items when displayed.
Each item is separated by two spaces.
.SS "draw"
.IX Subsection "draw"
.Vb 1
\&  $menu\->draw($mwh, 1);
.Ve
.PP
The draw method renders the menu in its current state.  This
requires a valid handle to a curses window in which it will render
itself.  The optional second argument, if true, will cause the selection
cursor to be rendered as well.
.SS "popup"
.IX Subsection "popup"
.Vb 1
\&  $menu\->popup;
.Ve
.PP
This method causes the menu to be displayed.  Since, theoretically, the menu 
should never be seen unless it's being actively used, we will always assume 
that we need to draw a cursor on the list as well.
.SS "execute"
.IX Subsection "execute"
.Vb 1
\&  $menu\->execute;
.Ve
.PP
This method acts like the standard Curses::Widgets method of the same name,
with the exception being that selection of any menu item will also cause it to
exit (having already called the associated item subroutine).
.SH "HISTORY"
.IX Header "HISTORY"
.IP "2002/10/17 \*(-- First implementation" 4
.IX Item "2002/10/17 First implementation"
.SH "AUTHOR/COPYRIGHT"
.IX Header "AUTHOR/COPYRIGHT"
(c) 2001 Arthur Corliss (corliss@digitalmages.com)