.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "Form::Control::checkboxes 3pm"
.TH Form::Control::checkboxes 3pm "2020-11-09" "perl v5.32.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"
Embperl::Form::Control::checkboxes \- A multiple checkbox control inside an Embperl Form
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&  {
\&  type    => \*(Aqcheckboxes\*(Aq,
\&  text    => \*(Aqblabla\*(Aq,
\&  name    => \*(Aqfoo\*(Aq,
\&  values  => [1,2,3],
\&  options => [\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq, \*(Aqnone\*(Aq],
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Used to create an checkboxes control inside an Embperl Form.
See Embperl::Form on how to specify parameters.
.SS "\s-1PARAMETER\s0"
.IX Subsection "PARAMETER"
\fItype\fR
.IX Subsection "type"
.PP
Needs to be 'checkboxes'
.PP
\fIname\fR
.IX Subsection "name"
.PP
Specifies the name of the checkboxes control
.PP
\fItext\fR
.IX Subsection "text"
.PP
Will be used as label for the checkboxes control
.PP
\fIvalues\fR
.IX Subsection "values"
.PP
Gives the values as an array ref of the checkboxes control.
.PP
\fIoptions\fR
.IX Subsection "options"
.PP
Gives the options as an array ref that should be displayed to the user.
If no options are given, the values from values are used.
.PP
\fIvert\fR
.IX Subsection "vert"
.PP
If specified arranges the checkboxes button vertically. The number given specifies
the number of <br>'s used the separate the checkboxes buttons.
.PP
\fItab\fR
.IX Subsection "tab"
.PP
if specified arranges the checkboxes in a table. The number given 
specifies the number of columns in one table row.
.PP
\fIaddtop\fR
.IX Subsection "addtop"
.PP
Array ref which contains items that should be added at the left or top
of the checkboxes buttons. Each item consists of an array ref with two
entries, the first is the value and the second is the option
that is displayed on the page. If the second is missing the
value (first entry)is displayed. Example:
.PP
.Vb 1
\&    addtop => [ [1 => \*(Aqfirst item\*(Aq], [2 => \*(Aqsecond item\*(Aq]]
.Ve
.PP
\fIaddbottom\fR
.IX Subsection "addbottom"
.PP
Array ref which contains items that should be added at the right or bottom
of the checkboxes buttons. Each item consists of an array ref with two
entries, the first is the value and the second is the option
that is displayed on the page. If the second is missing the
value (first entry)is displayed. Example:
.PP
.Vb 1
\&    addbottom => [ [9999 => \*(Aqlast item\*(Aq], [9999 => \*(Aqvery last item\*(Aq]]
.Ve
.PP
\fIfilter\fR
.IX Subsection "filter"
.PP
If given, only items where the value matches the regex given in
\&\f(CW\*(C`filter\*(C'\fR are displayed.
.SH "Author"
.IX Header "Author"
G. Richter (richter at embperl dot org)
.SH "See Also"
.IX Header "See Also"
\&\fBperl\fR\|(1), Embperl, Embperl::Form