.\" 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::ButtonSet 3pm"
.TH Widgets::ButtonSet 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::ButtonSet \- Button Set Widgets
.SH "MODULE VERSION"
.IX Header "MODULE VERSION"
\&\f(CW$Id:\fR ButtonSet.pm,v 1.103 2002/11/03 23:31:26 corliss Exp corliss $
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Curses::Widgets::ButtonSet;
\&
\&  $btns = Curses::Widgets::ButtonSet\->({
\&    LENGTH      => 10,
\&    VALUE       => 0,
\&    INPUTFUNC   => \e&scankey,
\&    FOREGROUND  => \*(Aqwhite\*(Aq,
\&    BACKGROUND  => \*(Aqblack\*(Aq,
\&    BORDER      => 1,
\&    BORDERCOL   => \*(Aqred\*(Aq,
\&    FOCUSSWITCH => "\et\en",
\&    HORIZONTAL  => 1,
\&    PADDING     => 1,
\&    X           => 1,
\&    Y           => 1,
\&    LABELS      => [qw(OK CANCEL)],
\&    });
\&
\&  $btns\->draw($mwh, 1);
\&
\&  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"
.PD
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Curses::Widgets::ButtonSet provides simplified \s-1OO\s0 access to Curses-based
button sets.  Each object maintains it's own state information.
.SH "METHODS"
.IX Header "METHODS"
.SS "new (inherited from Curses::Widgets)"
.IX Subsection "new (inherited from Curses::Widgets)"
.Vb 10
\&  $btns = Curses::Widgets::ButtonSet\->({
\&    LENGTH      => 10,
\&    VALUE       => 0,
\&    INPUTFUNC   => \e&scankey,
\&    FOREGROUND  => \*(Aqwhite\*(Aq,
\&    BACKGROUND  => \*(Aqblack\*(Aq,
\&    BORDER      => 1,
\&    BORDERCOL   => \*(Aqred\*(Aq,
\&    FOCUSSWITCH => "\et\en",
\&    HORIZONTAL  => 1,
\&    PADDING     => 1,
\&    X           => 1,
\&    Y           => 1,
\&    LABELS      => [qw(OK CANCEL)],
\&    });
.Ve
.PP
The new method instantiates a new ButtonSet object.  The only mandatory
key/value pairs in the configuration hash are \fBX\fR, \fBY\fR, and \fB\s-1LABELS\s0\fR.  All
others have the following defaults:
.PP
.Vb 12
\&  Key         Default    Description
\&  ============================================================
\&  LENGTH             10  Number of columns for each button label
\&  VALUE               0  Button selected (0\-based indexing)
\&  INPUTFUNC   \e&scankey  Function to use to scan for keystrokes
\&  FOREGROUND      undef  Default foreground colour
\&  BACKGROUND      undef  Default blackground colour
\&  BORDER              1  Display border around the set
\&  BORDERCOL       undef  Foreground colour for border
\&  FOCUSSWITCH    "\et\en"  Characters which signify end of input
\&  HORIZONTAL          1  Horizontal orientation for set
\&  PADDING             1  Number of spaces between buttons
.Ve
.PP
The last option, \fB\s-1PADDING\s0\fR, is only applicable to horizontal sets without
borders.
.SS "draw"
.IX Subsection "draw"
.Vb 1
\&  $btns\->draw($mwh, 1);
.Ve
.PP
The draw method renders the button set 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 set's
selected button to be rendered in standout mode (inverse video).
.SH "HISTORY"
.IX Header "HISTORY"
.IP "1999/12/29 \*(-- Original button set widget in functional model" 4
.IX Item "1999/12/29 Original button set widget in functional model"
.PD 0
.IP "2001/07/05 \*(-- First incarnation in \s-1OO\s0 architecture" 4
.IX Item "2001/07/05 First incarnation in OO architecture"
.PD
.SH "AUTHOR/COPYRIGHT"
.IX Header "AUTHOR/COPYRIGHT"
(c) 2001 Arthur Corliss (corliss@digitalmages.com)