.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Widgets::ListBox::MultiColumn 3pm"
.TH Widgets::ListBox::MultiColumn 3pm "2022-06-12" "perl v5.34.0" "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::ListBox::MultiColumn \- Multi\-Column List Box Widgets
.SH "MODULE VERSION"
.IX Header "MODULE VERSION"
\&\f(CW$Id:\fR MultiColumn.pm,v 0.1 2002/11/14 01:28:49 corliss Exp corliss $
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Curses::Widgets::ListBox::MultiColumn;
\&
\&  $lb = Curses::Widgets::ListBox::MultiColumn\->new({
\&    COLUMNS     => [0, 5, 10, 3, 3],
\&    LISTITEMS   => [@list],
\&    });
\&
\&  $lb\->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"
.IP "Curses::Widgets::ListBox" 4
.IX Item "Curses::Widgets::ListBox"
.PD
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Curses::Widgets::ListBox::MultiColumn is an extension of the standard
Curses::Widgets::ListBox that allows a list of columns, with each column a
specified width.
.SH "METHODS"
.IX Header "METHODS"
.SS "new (inherited from Curses::Widgets)"
.IX Subsection "new (inherited from Curses::Widgets)"
.Vb 8
\&  $tm = Curses::Widgets::ListBox\->new({
\&    COLUMNS     => [0, 5, 10, 3, 3],
\&    LISTITEMS   => [@list],
\&    HEADERS     => [@headers],
\&    HEADERCOLFG => \*(Aqwhite\*(Aq,
\&    HEADERCOLBG => \*(Aqgreen\*(Aq,
\&    BIGHEADER   => 1,
\&    });
.Ve
.PP
All of the same key values apply here as they do for the parent class
Curses::Widgets::ListBox.  In addition, the following new keys are defined:
.PP
.Vb 9
\&  Key           Default   Description
\&  ============================================================
\&  COLUMNS            []   Column widths
\&  LISTITEMS          []   List of list values
\&  HEADERS            []   Column header labels
\&  HEADERFGCOL     undef   Header foreground colour
\&  HEADERBGCOL     undef   Header background colour
\&  BIGHEADER           0   Use more graphics for the header
\&  KEYINDX             0   Index of key column
.Ve
.PP
If headers are defined but one or both of the header colours are not, then
they will default to the widget fore and background.
.PP
\&\fB\s-1NOTE\s0\fR:  Headers take up more lines in addition to the border (one line for
the normal, small header, two lines for the larger).  You need to take that
into account when setting the geometry.  If no labels are passed in the
\&\s-1HEADERS\s0 array, no space will be used for the headers.
.PP
The \fB\s-1KEYINDX\s0\fR value is currently only used to match keystrokes against for
quick navigation.
.SS "draw"
.IX Subsection "draw"
.Vb 1
\&  $lb\->draw($mwh, 1);
.Ve
.PP
The draw method renders the list box 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 field's
text cursor to be rendered as well.
.SH "HISTORY"
.IX Header "HISTORY"
.IP "1999/12/29 \*(-- Original list box widget in functional model" 4
.IX Item "1999/12/29 Original list box 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)